IGraphBuilder
COM公式ドキュメント
このインターフェイスは、アプリケーションがフィルターグラフを構築できるようにするメソッドを提供します。
メソッド 7
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
Connect メソッドは、必要に応じて中間フィルターを使用して 2 つのピンを接続します。
| ppinOut | IPin* | in | 出力ピンの IPin インターフェイスへのポインター。 |
| ppinIn | IPin* | in | 入力ピンの IPin インターフェイスへのポインター。 |
戻り値
HRESULT を返します。取り得る値には次のものがあります。
| Return code | Description |
|---|---|
| 成功しました。 | |
| 部分的な成功。このピンからのストリームの一部がサポートされていない形式を使用しています。 | |
| 操作が中止されました。 | |
| NULL ポインター引数です。 | |
| 接続を確立するための中間フィルターの組み合わせが見つかりませんでした。 | |
| フィルターの少なくとも 1 つがフィルターグラフに含まれていません。 |
解説(Remarks)
このメソッドは、必要に応じて中間フィルターを追加しながら、2 つのピンを直接または間接的に接続します。まず直接接続を試みます。それが失敗した場合、フィルターグラフに既に存在し、未接続の入力ピンを持つフィルターの使用を試みます。(これらは任意の順序で列挙されます。) それも失敗した場合は、レジストリ内のフィルターを検索し、メリット値の順に試行します。詳細については、Intelligent Connect を参照してください。
接続処理の間、Filter Graph Manager は、ピン名がチルダ (~) で始まる場合、中間フィルター上のそのピンを無視します。詳細については、PIN_INFO を参照してください。
Render メソッドは、指定した出力ピンからのデータをレンダリングするフィルターグラフを構築します。
| ppinOut | IPin* | in | 出力ピンの IPin インターフェイスへのポインター。 |
戻り値
HRESULT を返します。取り得る値には次のものがあります。
| Return code | Description |
|---|---|
| 成功しました。 | |
| 部分的な成功。オーディオはレンダリングされませんでした。 | |
| 成功しました。Filter Graph Manager は重複を避けるためにフィルター名を変更しました。 | |
| 部分的な成功。このムービー内のストリームの一部がサポートされていない形式です。 | |
| 部分的な成功。ビデオはレンダリングされませんでした。 | |
| 操作が中止されました。 | |
| メモリが不足しています。 | |
| NULL ポインター引数です。 | |
| 接続を確立するための中間フィルターの組み合わせが見つかりませんでした。 | |
| ストリームをレンダリングするためのフィルターの組み合わせが見つかりませんでした。 | |
| これらのピンの間に共通のメディアタイプがありません。 | |
| このピンが属するフィルターがフィルターグラフに含まれていません。 |
解説(Remarks)
このメソッドは、必要に応じてグラフに新しいフィルターを追加しながら、指定した出力ピンからのデータをレンダリングします。フィルターは IGraphBuilder::Connect メソッドと同じ順序で試行されます。詳細については、Intelligent Connect を参照してください。
接続処理の間、Filter Graph Manager は、ピン名がチルダ (~) で始まる場合、中間フィルター上のそのピンを無視します。詳細については、PIN_INFO を参照してください。
RenderFile メソッドは、指定したファイルをレンダリングするフィルターグラフを構築します。(IGraphBuilder.RenderFile)
| lpcwstrFile | LPWSTR | in | メディアファイルの名前を含むワイド文字列を指定します。 |
| lpcwstrPlayList | LPWSTR | inoptional | 予約済み。NULL にする必要があります。 |
戻り値
HRESULT を返します。取り得る値には次のものがあります。
| Return code | Description |
|---|---|
| 成功しました。 | |
| 部分的な成功。オーディオはレンダリングされませんでした。 | |
| 成功しました。Filter Graph Manager は重複を避けるためにフィルター名を変更しました。 | |
| このムービー内のストリームの一部がサポートされていない形式です。 | |
| 部分的な成功。このムービー内のストリームの一部がサポートされていない形式です。 | |
| 操作が中止されました。 | |
| 失敗しました。 | |
| 引数が無効です。 | |
| メモリが不足しています。 | |
| NULL ポインター引数です。 | |
| 接続を確立するための中間フィルターの組み合わせが見つかりませんでした。 | |
| このファイルのソースフィルターを読み込めませんでした。 | |
| ストリームをレンダリングするためのフィルターの組み合わせが見つかりませんでした。 | |
| ファイル形式が無効です。 | |
| オブジェクトまたは名前が見つかりませんでした。 | |
| このファイルのメディアタイプが認識されません。 | |
| ファイルを再生できません。この形式はサポートされていません。 |
解説(Remarks)
lpwstrFile パラメーターがメディアファイルを指定している場合、このメソッドは既定の再生用のフィルターグラフを構築します。まず、IGraphBuilder::AddSourceFilter メソッドと同じ処理を使用して、そのファイルを読み取ることができるソースフィルターを追加します。次に、必要に応じて中間フィルターを追加しながら、ソースフィルターの出力ピンをレンダリングします。フィルターは IGraphBuilder::Connect メソッドと同じ順序で試行します。
接続処理の間、Filter Graph Manager は、ピン名がチルダ (~) で始まる場合、中間フィルター上のそのピンを無視します。詳細については、PIN_INFO を参照してください。
RenderFile メソッドはグラフからフィルターを削除しないことに注意してください。RenderFile を 2 回呼び出すと、2 回目の呼び出しは単にグラフにさらにフィルターを追加します。グラフを実行すると、両方のソースが同時に再生されます。
例
次の例では、既定の再生用に AVI ファイルをレンダリングします。
| C++ |
|---|
hr = pGraph->RenderFile(L"C:\\Media\\Example.avi", 0); |
| C++ |
|---|
hr = pGraph->RenderFile(L"http://example.microsoft.com/Example.avi", 0); |
AddSourceFilter メソッドは、指定したファイルのソースフィルターをフィルターグラフに追加します。
| lpcwstrFileName | LPWSTR | in | 読み込むファイルの名前を指定します。 |
| lpcwstrFilterName | LPWSTR | inoptional | ソースフィルターの名前を指定します。 |
| ppFilter | IBaseFilter** | out | フィルターの IBaseFilter インターフェイスへのポインターを受け取ります。呼び出し側はインターフェイスを解放する必要があります。 |
戻り値
HRESULT を返します。取り得る値には次のものがあります。
| Return code | Description |
|---|---|
| 成功しました。 | |
| ソースフィルターが IFileSourceFilter インターフェイスをサポートしていません。 | |
| メモリが不足しています。 | |
| NULL ポインター引数です。 | |
| このファイルのソースフィルターを読み込めませんでした。 | |
| ファイルまたはオブジェクトが見つかりませんでした。 | |
| このファイルのメディアタイプが認識されませんでした。 |
解説(Remarks)
このメソッドは、指定したファイルを読み取ることができるインストール済みのフィルターを検索します。見つかった場合、メソッドはそれをフィルターグラフに追加し、そのフィルターの IBaseFilter インターフェイスへのポインターを返します。ファイルのメディアタイプと圧縮方式を判別するために、Filter Graph Manager は、記事 Registering a Custom File Type に記載されているように、ファイルの先頭の数バイトを読み取り、特定のバイトパターンを探します。
フィルターグラフの残りの部分を構築するのは、アプリケーションの責任です。そのためには、IBaseFilter::EnumPins を呼び出してソースフィルターの出力ピンを列挙します。その後、IGraphBuilder::Connect メソッドまたは IGraphBuilder::Render メソッドのいずれかを使用します。
メソッドが成功した場合、IBaseFilter インターフェイスには未解放の参照カウントが残ります。呼び出し側はインターフェイスを解放する必要があります。
ファイルを既定の再生用にレンダリングするには、IGraphBuilder::RenderFile メソッドを使用します。
Filter Graph Manager は、フィルターがグラフから削除されるか、Filter Graph Manager が解放されるまで、そのフィルターの参照カウントを保持します。
SetLogFile メソッドは、操作の実行を試みる際に行われるアクションをログに記録するためのファイルを設定します。
| hFile | UINT_PTR | in | ログファイルへのハンドル。 |
戻り値
S_OK を返します。
解説(Remarks)
このメソッドはデバッグで使用するためのものであり、フィルターグラフの自動構築に失敗した原因を特定するのに役立つことを意図しています。
hFile パラメーターは、開かれているファイルハンドルである必要があります。ファイルを開くこと、およびログ記録の完了時にそれを閉じることは、アプリケーションの責任です。ファイルハンドルを閉じる前に、NULL のファイルハンドルを指定して SetLogFile を呼び出してください。これにより、ファイルを閉じた後にコンポーネントがそのファイルハンドルを使用しようとしないことが保証されます。
Abort メソッドは、Filter Graph Manager に対して、現在のタスクをできるだけ早く停止するよう要求します。
戻り値
S_OK を返します。
ShouldOperationContinue メソッドは、現在の操作を続行すべきかどうかを問い合わせます。
戻り値
HRESULT を返します。取り得る値には次のものがあります。
| Return code | Description |
|---|---|
| 現在の操作を続行すべきです。 | |
| 現在の操作を続行すべきではありません。 | |
| 予期しないエラーです。 |
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IGraphBuilder "{56A868A9-0AD4-11CE-B03A-0020AF0BA770}"
#usecom global IGraphBuilder IID_IGraphBuilder "{}"
#comfunc global IGraphBuilder_Connect 11 sptr,sptr
#comfunc global IGraphBuilder_Render 12 sptr
#comfunc global IGraphBuilder_RenderFile 13 wstr,wstr
#comfunc global IGraphBuilder_AddSourceFilter 14 wstr,wstr,sptr
#comfunc global IGraphBuilder_SetLogFile 15 sptr
#comfunc global IGraphBuilder_Abort 16
#comfunc global IGraphBuilder_ShouldOperationContinue 17
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。