Win32 API 日本語リファレンス
ホームMedia.DirectShow › IAMDroppedFrames

IAMDroppedFrames

COM
IIDc6e13344-30ac-11d0-a18c-00a0c9118956継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IAMDroppedFrames インターフェイスは、ドロップされたフレーム数や配信されたフレーム数など、ビデオキャプチャフィルターからパフォーマンス情報を取得します。アプリケーションはこのインターフェイスを使用して、実行時にキャプチャのパフォーマンスを判断できます。

解説(Remarks)

このインターフェイスを公開する一部のフィルターは、GetDroppedInfo メソッドや GetAverageFrameSize メソッドを実装していません。

Windows Driver Model (WDM) デバイスの場合、WDM ドライバーが PROPSETID_VIDCAP_DROPPEDFRAMES プロパティセットをサポートしていれば、WDM Video Capture Filter がこのインターフェイスを自動的に公開します。詳細については、Windows Driver Kit (WDK) のドキュメントを参照してください。

ドロップされたフレーム数はキャプチャドライバーによって報告されます。この情報は特定のメディアサンプルと直接対応しているわけではないため、フレーム単位では正確ではありませんが、時間の経過に対しては正確であるはずです。

メソッド 4

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetNumDropped(INT* plDropped)

GetNumDropped メソッドは、フィルターがストリーミングを開始してからドロップしたフレームの総数を取得します。

plDroppedINT*outドロップされたフレーム数を受け取る変数へのポインター。

戻り値

HRESULT 値を返します。取り得る値には次のものがあります。

戻り値 説明
S_OK
成功。
E_POINTER
NULL ポインター引数。

解説(Remarks)

フィルターは、停止状態から一時停止状態へ遷移するときにカウントをゼロにリセットします。

アプリケーションが IAMStreamControl インターフェイスを使用してピンを制御している場合、ピンがオフの間もドライバーはドロップされたフレームおよびドロップされなかったフレームのカウントを継続することがあります。正確なカウントを得るには、ピンをオンにしたときに一度このメソッドを呼び出し、ピンをオフにしたときにもう一度呼び出します。その差がドロップされたフレームの総数です。(開始時刻が IAMStreamControl::StartAt の呼び出しよりも後になる場合、アプリケーションは EC_STREAM_CONTROL_STARTED イベントをリッスンする必要があります。)これらの注意事項は、アプリケーションが ICaptureGraphBuilder2::ControlStream メソッドを使用する場合にも適用されます。

vtbl 4 HRESULT GetNumNotDropped(INT* plNotDropped)

GetNumNotDropped メソッドは、フィルターがストリーミングを開始してから配信したフレームの総数を取得します。

plNotDroppedINT*out配信されたフレーム数を受け取る変数へのポインター。

戻り値

HRESULT 値を返します。取り得る値には次のものがあります。

戻り値 説明
S_OK
成功。
E_POINTER
NULL ポインター引数。

解説(Remarks)

フィルターは、停止状態から一時停止状態へ遷移するときにカウントをゼロにリセットします。

アプリケーションが IAMStreamControl インターフェイスを使用してピンを制御している場合、ピンがオフの間もドライバーはドロップされたフレームおよびドロップされなかったフレームのカウントを継続することがあります。正確なカウントを得るには、ピンをオンにしたときに一度このメソッドを呼び出し、ピンをオフにしたときにもう一度呼び出します。その差がドロップされたフレームの総数です。(開始時刻が IAMStreamControl::StartAt の呼び出しよりも後になる場合、アプリケーションは EC_STREAM_CONTROL_STARTED イベントをリッスンする必要があります。)これらの注意事項は、アプリケーションが ICaptureGraphBuilder2::ControlStream メソッドを使用する場合にも適用されます。

vtbl 5 HRESULT GetDroppedInfo(INT lSize, INT* plArray, INT* plNumCopied)

GetDroppedInfo メソッドは、ドロップされたフレーム番号の配列を取得します。

lSizeINTin配列のサイズを指定します。
plArrayINT*out呼び出し元が確保した、サイズ lSize の配列へのポインター。このメソッドは、ドロップされた最初の lSize 個のフレーム番号を配列に格納します(格納数はデバイスに依存する最大値までに制限されます)。
plNumCopiedINT*outplArray に返された項目数を受け取る変数へのポインター。この数は lSize の値より小さくなることがあります。

戻り値

HRESULT 値を返します。取り得る値には次のものがあります。

戻り値 説明
S_OK
成功。
E_INVALIDARG
無効な引数。lSize パラメーターはゼロより大きくなければなりません。
E_NOTIMPL
実装されていません。
E_POINTER
NULL ポインター引数。
E_PROP_ID_UNSUPPORTED
このデバイスではサポートされていません。
vtbl 6 HRESULT GetAverageFrameSize(INT* plAverageSize)

GetAverageFrameSize メソッドは、フィルターがキャプチャしたフレームの平均サイズを取得します。

plAverageSizeINT*outフィルターがストリーミングを開始してからの平均フレームサイズ(バイト単位)を受け取る変数へのポインター。

戻り値

HRESULT 値を返します。取り得る値には次のものがあります。

戻り値 説明
S_OK
成功。
E_NOTIMPL
実装されていません。
E_POINTER
NULL ポインター引数。

解説(Remarks)

デバイスが値を報告しない場合、このメソッドは成功しても plAverageSize パラメーターにゼロを返すことがあります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_IAMDroppedFrames "{C6E13344-30AC-11D0-A18C-00A0C9118956}"
#usecom global IAMDroppedFrames IID_IAMDroppedFrames "{}"
#comfunc global IAMDroppedFrames_GetNumDropped        3 var
#comfunc global IAMDroppedFrames_GetNumNotDropped     4 var
#comfunc global IAMDroppedFrames_GetDroppedInfo       5 int,var,var
#comfunc global IAMDroppedFrames_GetAverageFrameSize  6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。