Ereignisablaufverfolgung in DirectShow
[Das dieser Seite zugeordnete Feature DirectShow ist ein Legacyfeature. Es wurde durch MediaPlayer, IMFMediaEngine und Audio/Video Capture in Media Foundation ersetzt. Diese Features wurden für Windows 10 und Windows 11 optimiert. Microsoft empfiehlt dringend, dass neuer Code nach Möglichkeit MediaPlayer, IMFMediaEngine und Audio/Video Capture in Media Foundation anstelle von DirectShow verwendet. Microsoft schlägt vor, vorhandenen Code, der die Legacy-APIs verwendet, um nach Möglichkeit die neuen APIs zu verwenden.]
DirectShow unterstützt die Ereignisablaufverfolgung für Windows (ETW), die zum Erstellen von Ereignisprotokollen für die Instrumentierung oder das Debuggen verwendet werden kann. Weitere Informationen zu ETW finden Sie in der Dokumentation zum Windows SDK. Um ETW-Ereignisse in einer DirectShow-Anwendung zu nutzen, müssen Sie die Ablaufverfolgung aktivieren und dann die Ablaufverfolgungsereignisse verarbeiten. Führen Sie die folgenden Schritte aus:
Festlegen der erforderlichen Registrierungsschlüssel
Um die Ablaufverfolgung auf dem Computer des Benutzers zu aktivieren, legen Sie zunächst die folgenden Registrierungsschlüssel fest:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\DirectX
GlitchInstrumentation = 0x00000001 (REG_DWORD)
HKEY_LOCAL_MACHINE\SOFTWARE\DEBUG\Quartz.dll
PERFLOG = 0x00000001 (REG_DWORD)
Diese Schlüssel gelten für Release- und Debugbinärdateien.
Aktivieren der Ablaufverfolgung in Ihrer Anwendung
Führen Sie zum Aktivieren der Ablaufverfolgung in Ihrer Anwendung die folgenden Schritte aus:
- Rufen Sie StartTrace auf, um eine neue Ablaufverfolgungssitzung zu starten.
- Rufen Sie EnableTrace auf, um die Ablaufverfolgung zu aktivieren. Die Anbieter-GUID für DirectShow ist GUID_DSHOW_CTL.
- Bevor die Anwendung beendet wird, rufen Sie StopTrace auf, um die Ablaufverfolgungssitzung zu schließen.
Verarbeiten der Ereignisse
Führen Sie zum Verarbeiten der Ereignisse die folgenden Schritte aus:
- Rufen Sie OpenTrace auf, um die Ablaufverfolgung für die Verarbeitung zu öffnen.
- Rufen Sie ProcessTrace auf, um die Ereignisse zu verarbeiten.
- Verwenden Sie im ProcessTrace-Rückruf die Ereignis-GUID, um den Ereignistyp zu suchen. Die Ereignis-GUID gibt die Struktur an, die für die Ereignisdaten verwendet wird. Siehe Ablaufverfolgungsereignis-GUIDs.
- Rufen Sie CloseTrace auf, um das Ablaufverfolgungshandle zu schließen.
Beispielcode
Der folgende Code zeigt eine Hilfsklasse, die die Ablaufverfolgung aktiviert. Dieser Code zeigt, wie Ereignisse in eine Protokolldatei geschrieben werden, die nach Abschluss der Sitzung verarbeitet werden kann. Sie können Ereignisse auch in Echtzeit verarbeiten. Weitere Informationen finden Sie in der ETW-Dokumentation im Windows SDK.
#include <wmistr.h>
#include <evntrace.h>
#include <perfstruct.h>
// Event classes. These are defined in dxmperf.h.
#ifndef DXMPERF_VIDEOREND
#define DXMPERF_VIDEOREND 0x00000001
#endif
#ifndef AUDIOBREAK_BIT
#define AUDIOBREAK_BIT 0x00000010
#endif
// This structure extends the EVENT_TRACE_PROPERTIES by adding fields
// for the name of the WMI session name and the log file.
struct PERFMON_LOGGERINFO
{
EVENT_TRACE_PROPERTIES TraceProperties;
WCHAR wcSessionName[ MAX_PATH ]; // Session name.
WCHAR wcLogFileName[ MAX_PATH ]; // Log file.
};
// Helper class for DirectShow event tracing.
class CTrace
{
public:
CTrace() : m_SessionLogger((TRACEHANDLE) INVALID_HANDLE_VALUE)
{
ZeroMemory(&m_LogInfo, sizeof(&m_LogInfo));
}
// Start: Starts a trace session.
HRESULT Start(WCHAR *wszLogFile)
{
const WCHAR* wszSessionName = L"PerfMon_DirectShow";
HRESULT hr = S_OK;
ULONG result;
ZeroMemory(&m_LogInfo, sizeof(m_LogInfo));
EVENT_TRACE_PROPERTIES& prop = m_LogInfo.TraceProperties;
prop.Wnode.BufferSize = sizeof(m_LogInfo); // Size of the structure.
prop.Wnode.Flags = WNODE_FLAG_TRACED_GUID; // Must be this value.
// Use the QPC (high resolution timer).
prop.Wnode.ClientContext = 1;
prop.Wnode.Guid = GUID_DSHOW_CTL; // Event provider GUID.
prop.LogFileMode =
EVENT_TRACE_FILE_MODE_CIRCULAR | EVENT_TRACE_USE_PAGED_MEMORY;
prop.EnableFlags =
EVENT_TRACE_FLAG_PROCESS; // Process events.
// Set the offset from the start of the structure to the log file name.
prop.LogFileNameOffset =
sizeof(m_LogInfo.TraceProperties) + sizeof(m_LogInfo.wcSessionName);
// Set the offset from the start of the structure to the session name.
prop.LoggerNameOffset = sizeof(m_LogInfo.TraceProperties);
// Copy the names into the structure.
StringCchCopy(m_LogInfo.wcSessionName, MAX_PATH, wszSessionName);
StringCchCopy(m_LogInfo.wcLogFileName, MAX_PATH, wszLogFile);
// Start the trace.
result = StartTrace(
&m_SessionLogger,
m_LogInfo.wcSessionName,
&m_LogInfo.TraceProperties
);
if (result == ERROR_SUCCESS)
{
result = EnableTrace(
TRUE, // Enable.
AUDIOBREAK_BIT | DXMPERF_VIDEOREND, // Event classes.
TRACE_LEVEL_VERBOSE, // Trace level.
&GUID_DSHOW_CTL, // Event provider.
m_SessionLogger // Session handle.
);
}
if (result != ERROR_SUCCESS)
{
hr = __HRESULT_FROM_WIN32(result);
}
return hr;
}
HRESULT Stop()
{
HRESULT hr = S_OK;
// Stop the trace.
if (m_SessionLogger != (TRACEHANDLE)INVALID_HANDLE_VALUE)
{
LONG result = 0;
result = EnableTrace(FALSE, 0, 0, &GUID_DSHOW_CTL, m_SessionLogger);
if (result == ERROR_SUCCESS)
{
result = StopTrace(
m_SessionLogger,
m_LogInfo.wcSessionName,
&m_LogInfo.TraceProperties);
}
m_SessionLogger = (TRACEHANDLE)INVALID_HANDLE_VALUE;
if (result != ERROR_SUCCESS)
{
hr = __HRESULT_FROM_WIN32(result);
}
}
return hr;
}
protected:
TRACEHANDLE m_SessionLogger;
PERFMON_LOGGERINFO m_LogInfo;
};
Der folgende Code zeigt, wie das Ereignisprotokoll verarbeitet wird:
// Callback for event processing.
VOID WINAPI EventCallback(PEVENT_TRACE pEvent)
{
PERFINFO_DSHOW_STREAMTRACE *pStreamTrace = NULL;
PERFINFO_DSHOW_AVREND *pVideoRender = NULL;
PERFINFO_DSHOW_AUDIOBREAK *pAudioBreak = NULL;
if (pEvent->Header.Guid == GUID_STREAMTRACE)
{
pStreamTrace = (PPERFINFO_DSHOW_STREAMTRACE)pEvent->MofData;
switch (pStreamTrace->id)
{
// TODO: Handle the event.
}
}
else if(pEvent->Header.Guid == GUID_VIDEOREND)
{
pVideoRender = (PPERFINFO_DSHOW_AVREND)pEvent->MofData;
// TODO: Handle the event.
}
else if(pEvent->Header.Guid == GUID_AUDIOBREAK)
{
pAudioBreak = (PPERFINFO_DSHOW_AUDIOBREAK)pEvent->MofData;
// TODO: Handle the event.
}
}
void ProcessTraceEvents(WCHAR *wszLogFile)
{
ULONG result = 0;
EVENT_TRACE_LOGFILE logfile;
ZeroMemory(&logfile, sizeof(logfile));
logfile.LogFileName = wszLogFile;
logfile.EventCallback = EventCallback;
TRACEHANDLE handle = OpenTrace(&logfile);
if (handle != (TRACEHANDLE)INVALID_HANDLE_VALUE)
{
result = ProcessTrace(&handle, 1, NULL, NULL);
CloseTrace(handle);
}
}
Zugehörige Themen