IBaseFilter
COM公式ドキュメント
IBaseFilter インターフェイスは、DirectShow フィルターの主要なインターフェイスです。
メソッド 5
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
EnumPins メソッドは、このフィルターのピンを列挙します。
| ppEnum | IEnumPins** | out | IEnumPins インターフェイスへのポインターを受け取る変数のアドレスです。 |
戻り値
HRESULT 値を返します。取り得る値には次のものがあります。
| 戻り値 | 説明 |
|---|---|
| 成功 | |
| メモリが不足しています | |
| NULL ポインター引数 |
解説(Remarks)
このメソッドは、IEnumPins インターフェイスをサポートする列挙子を返します。これは標準の COM 列挙子と同様に動作します。詳細については、Enumerating Pins を参照してください。
メソッドが成功すると、IEnumPins インターフェイスには未解放の参照カウントが残ります。使用が終わったら、必ずインターフェイスを解放してください。
FindPin メソッドは、指定した識別子を持つピンを取得します。
| Id | LPWSTR | in | ピンを識別する定数ワイド文字列へのポインターです。ピンの識別子を取得するには、IPin::QueryId メソッドを呼び出します。 |
| ppPin | IPin** | out | ピンの IPin インターフェイスへのポインターを受け取る変数のアドレスです。メソッドが失敗した場合、*ppPin は NULL に設定されます。 |
戻り値
HRESULT 値を返します。取り得る値には次のものがあります。
| 戻り値 | 説明 |
|---|---|
| 成功。 | |
| NULL ポインター引数。 | |
| この識別子を持つピンが見つかりませんでした。 |
解説(Remarks)
このメソッドはグラフの永続化をサポートします。ピンの状態を保存するには IPin::QueryId メソッドを使用し、状態を復元するにはこのメソッドを使用します。ピンの識別子文字列はフィルターの実装によって定義されます。識別子はフィルター内で一意でなければなりません。
メソッドが成功すると、返される IPin インターフェイスには未解放の参照カウントが残ります。使用が終わったら、必ずインターフェイスを解放してください。
QueryFilterInfo メソッドは、フィルターに関する情報を取得します。
| pInfo | FILTER_INFO* | out | FILTER_INFO 構造体へのポインターです。 |
戻り値
解説(Remarks)
このメソッドは、FILTER_INFO 構造体にフィルター情報を格納します。戻り時に FILTER_INFO 構造体の pGraph メンバーが NULL 以外の場合、IFilterGraph インターフェイスには未解放の参照カウントが残ります。使用が終わったら、必ずインターフェイスを解放してください。
JoinFilterGraph メソッドは、フィルターがフィルターグラフに参加した、またはフィルターグラフから離脱したことをフィルターに通知します。
| pGraph | IFilterGraph* | inoptional | フィルターグラフマネージャーの IFilterGraph インターフェイスへのポインターです。フィルターがグラフから離脱する場合は NULL を指定します。 |
| pName | LPWSTR | inoptional | フィルターの名前を指定するワイド文字列へのポインターです。 |
戻り値
成功した場合は S_OK を返します。それ以外の場合は、エラーの原因を示す HRESULT 値を返します。
解説(Remarks)
フィルターグラフマネージャーは、フィルターをフィルターグラフに追加するときに、自身へのポインターを指定してこのメソッドを呼び出します。pName パラメーターを通じて、このフィルターインスタンスの名前を割り当てます。この名前は、IBaseFilter::QueryFilterInfo メソッドを呼び出すことで取得できます。
フィルターグラフマネージャーは、フィルターをグラフから削除するときに、NULL ポインターを指定してこのメソッドを呼び出します。
アプリケーションがこのメソッドを呼び出してはなりません。グラフにフィルターを追加するには、フィルターグラフマネージャーの IFilterGraph::AddFilter メソッドを呼び出します。
フィルター開発者へ: フィルターは IFilterGraph インターフェイスポインターを保持し、それに対して他のフィルターグラフマネージャーインターフェイスを問い合わせることができます。ただし、フィルターグラフマネージャーに対する参照カウントを保持してはなりません。フィルターグラフマネージャーはフィルターに対する参照カウントを保持しているため、参照カウントを保持すると循環参照が発生します。循環参照はインターフェイスが正しく解放されるのを妨げ、デッドロックにつながるおそれがあります。IFilterGraph インターフェイスは、フィルターグラフマネージャーが値 NULL を指定して再度このメソッドを呼び出すまで有効であることが保証されています。このメソッドの実装については、CBaseFilter::JoinFilterGraph メソッドを参照してください。
QueryVendorInfo メソッドは、ベンダー情報を含む文字列を取得します。
| pVendorInfo | LPWSTR* | out | ベンダー情報を含むワイド文字列へのポインターを受け取る変数のアドレスです。 |
戻り値
HRESULT 値を返します。取り得る値には次のものがあります。
| 戻り値 | 説明 |
|---|---|
| 成功。 | |
| メソッドはサポートされていません。 | |
| NULL ポインター引数。 |
解説(Remarks)
このメソッドは省略可能です。フィルターがこれをサポートする必要はありません。
メソッドがサポートされている場合、CoTaskMemAlloc 関数を使用して文字列用のメモリを割り当てます。メモリを解放するには CoTaskMemFree 関数を呼び出します。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IBaseFilter "{56A86895-0AD4-11CE-B03A-0020AF0BA770}" #usecom global IBaseFilter IID_IBaseFilter "{}" #comfunc global IBaseFilter_EnumPins 10 sptr #comfunc global IBaseFilter_FindPin 11 wstr,sptr #comfunc global IBaseFilter_QueryFilterInfo 12 var #comfunc global IBaseFilter_JoinFilterGraph 13 sptr,wstr #comfunc global IBaseFilter_QueryVendorInfo 14 var ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IBaseFilter "{56A86895-0AD4-11CE-B03A-0020AF0BA770}" #usecom global IBaseFilter IID_IBaseFilter "{}" #comfunc global IBaseFilter_EnumPins 10 sptr #comfunc global IBaseFilter_FindPin 11 wstr,sptr #comfunc global IBaseFilter_QueryFilterInfo 12 sptr #comfunc global IBaseFilter_JoinFilterGraph 13 sptr,wstr #comfunc global IBaseFilter_QueryVendorInfo 14 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。