IMFASFIndexer

Systems Format (ASF) ファイル内のインデックスを操作するためのメソッドを提供します。

インデクサーオブジェクトを使用すると、既存の ASF インデックスの読み取りや、新しいインデックスの書き込みを行えます。インデックスオブジェクトには、読み取りモードと書き込みモードという相互排他的な 2 つのモードがあります。モードを設定するには SetFlags を呼び出します。

インデクサーオブジェクトを構成するには、次のメソッドを使用します (両モード共通):

• Initialize
• SetFlags
• SetIndexByteStreams

• GetFlags
• GetIndexByteStreamCount
• GetIndexPosition
• GetIndexStatus
• GetSeekPositionForValue

• CommitIndex
• GenerateIndexEntries
• GetCompletedIndex
• GetIndexWriteSpace
• SetIndexStatus

インデクサーのオプションを設定します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

IMFASFIndexer::SetFlags は IMFASFIndexer::Initialize より前に呼び出す必要があります。Initialize の後に SetFlags を呼び出そうとすると、結果として MF_E_INVALIDREQUEST が返されます。

選択されているインデクサーオプションを示すフラグを取得します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

IMFASFIndexer::Initialize でインデクサーオブジェクトを初期化する前に、このメソッドを呼び出す必要があります。

インデクサーオブジェクトを初期化します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

インデクサーは、コンテンツのインデックスを正しく書き込みまたは読み取りするために、ContentInfo オブジェクト内のデータを調べる必要があります。インデクサーはコンテンツ情報を変更せず、また IMFASFContentInfo インターフェイスへの参照を保持しません。

ASF ヘッダーでは、最大データパケットサイズが最小データパケットサイズと等しくなければなりません。そうでない場合、このメソッドは MF_E_UNEXPECTED を返します。

コンテンツの先頭からのインデックスオブジェクトのオフセットを取得します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

インデックスは、このメソッドで取得したオフセットからファイルの末尾まで続きます。

このメソッドを呼び出す前に、IMFASFIndexer::Initialize を呼び出してインデクサーをセットアップする必要があります。

IMFASFIndexer::GetCompletedIndex を複数回呼び出してインデックスを取得する場合、個々のインデックス部分の位置は、インデックスオフセットにインデックス内でのその部分のオフセットを加えた値と等しくなります。

インデックス対象のバイトストリームを追加します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

読み取りシナリオでは、インデクサーオブジェクトが使用するバイトストリームは 1 つのみである必要があります。インデックス生成シナリオでは、生成する必要があるインデックスオブジェクトの数によって異なります。

インデクサーオブジェクトが使用しているバイトストリームの数を取得します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

指定したストリームおよびインデックスの種類について、インデックス設定を取得します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

既存の ASF インデックスを読み取るには、このメソッドを呼び出す前に IMFASFIndexer::SetIndexByteStreams を呼び出します。

ストリームのインデックスが存在し、pcbIndexDescriptor に渡された値が pbIndexDescriptor バッファーに必要なサイズより小さい場合、このメソッドは MF_E_BUFFERTOOSMALL を返します。必要なバッファーサイズは pcbIndexDescriptor パラメーターで返されます。

指定したストリームのインデックスが存在しない場合、このメソッドは pfIsIndexed パラメーターに FALSE を返します。

ストリームのインデックスを構成します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

IMFASFIndexer::GenerateIndexEntries を呼び出す前に、SetIndexStatus の呼び出しをすべて行う必要があります。

インデクサーオブジェクトは、既定では各ストリームに対して時間ベースのインデックスを作成するように構成されています。既定の設定を上書きする場合にのみ、このメソッドを呼び出してください。

このメソッドはインデックス読み取りシナリオでは使用できません。インデックスを書き込む場合にのみ使用できます。

目的のシーク時刻を指定すると、クライアントがデータの読み取りを開始すべきオフセットを取得します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

ファイルの ASF パケットを受け取り、それらに対するインデックスエントリを作成します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

ASF インデクサーは、ファイルのインデックスを内部で作成します。インデクサーに送信されたすべてのデータパケットに対する完成したインデックスを取得するには、IMFASFIndexer::CommitIndex でインデックスをコミットし、次に IMFASFIndexer::GetCompletedIndex を呼び出してインデックスエントリをメディアバッファーに書き込みます。インデックスを保持できる十分な大きさのバッファーを割り当てられるようにインデックスのサイズを判断するには、IMFASFIndexer::GetIndexWriteSpace を呼び出します。

このメソッドがインデックスエントリを作成すると、それらは IMFASFIndexer::GetSeekPositionForValue によって直ちに使用可能になります。

pIASFPacketSample で指定するメディアサンプルは、単一の ASF パケットを含むバッファーを保持していなければなりません。IMFASFMultiplexer::GetNextPacket メソッドを呼び出して、ASF マルチプレクサーからサンプルを取得します。

このメソッドはインデックスの読み取り中には使用できず、インデックスの書き込み時にのみ使用できます。

ASF コンテンツに関連付けられた ContentInfo オブジェクトに、新しいインデックスに関する情報を追加します。後でインデクサーがインデックスを読み取れるようにするため、インデックスをコンテンツにコピーする前にこのメソッドを呼び出す必要があります。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

インデックスが正しく機能するためには、IMFASFIndexer::GenerateIndexEntries メソッドを使用してファイル内のすべての ASF パケットをインデクサーに渡した後に、このメソッドを呼び出す必要があります。このメソッドを呼び出した後は、GetCompletedIndex を呼び出してインデックスを取得し、ファイル内の適切な場所に書き込む必要があります。最後に、ASF ContentInfo オブジェクトの IMFASFContentInfo::GenerateHeader メソッドを呼び出して、新しい ASF ヘッダーを生成する必要があります。

アプリケーションは、新しいインデックスを書き込む場合にのみ CommitIndex メソッドを使用しなければなりません。そうでない場合、CommitIndex は結果として MF_E_INVALIDREQUEST を返すことがあります。たとえば、アプリケーションがインデクサーオブジェクトに MFASF_INDEXER_WRITE_NEW_INDEX 以外のフラグを設定している場合、MF_E_INVALIDREQUEST が返されます。また、以前の CommitIndex 呼び出しでインデックスエントリがすでにコミットされている場合にも、CommitIndex は MFASF_INDEXER_WRITE_NEW_INDEX を返すことがあります。

このメソッドはインデックス読み取りシナリオでは使用できません。インデックスを書き込む場合にのみ使用できます。

完成したインデックスを格納するために必要なバッファーのサイズ (バイト単位) を取得します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

このメソッドを使用してインデックスのサイズを取得し、それを保持できる十分な大きさのバッファーを割り当てます。

IMFASFIndexer::GetIndexWriteSpace を呼び出す前に、IMFASFIndexer::CommitIndex の呼び出しによってインデックスをコミットする必要があります。GetIndexWriteSpace を呼び出す前にインデックスがコミットされていない場合、結果として MF_E_INDEX_NOT_COMMITTED が返されます。

完成したインデックスをメディアバッファーに書き込むには、IMFASFIndexer::GetCompletedIndex を呼び出します。

このメソッドは読み取りシナリオでは使用できません。インデックスを書き込む場合にのみ使用できます。

ASF インデクサーオブジェクトから、完成したインデックスを取得します。

このメソッドは HRESULT を返します。指定できる値には、次の表に示すものが含まれますが、これらに限定されません。

このメソッドはバッファーを可能な限り使用し、バッファーの長さを適切に更新します。

pIIndexBuffer がバッファー全体を格納できるほど大きい場合、cbOffsetWithinIndex は 0 にし、呼び出しは 1 回だけ行えば済みます。それ以外の場合、連続するバッファー間にギャップがあってはなりません。

ユーザーはこのデータを、ASF データオブジェクトの末尾から cbOffsetFromIndexStart バイト後の位置でコンテンツに書き込む必要があります。ASF インデックスの開始位置を判断するには、IMFASFIndexer::GetIndexPosition を呼び出します。

この呼び出しは、IMFASFIndexer::CommitIndex が呼び出されていない限り成功しません。GetCompletedIndex を呼び出した後、呼び出し元は IMFASFContentInfo::GenerateHeader を呼び出し、既存の ASF ヘッダーを新しいヘッダーで上書きする必要があります。そうしないと、ASF ヘッダーがコンテンツと一致せず、ファイルが正しく再生される保証はありません。

このメソッドはインデックス読み取りシナリオでは使用できません。インデックスを書き込む場合にのみ使用できます。

例

次の例は、完全な ASF インデックスをバイトストリームに書き込む方法を示します。

HRESULT WriteASFIndex(IMFASFIndexer *pIndex,IMFByteStream *pStream)
{
    const DWORD cbChunkSize = 4096;

    IMFMediaBuffer *pBuffer = NULL;

    QWORD cbIndex = 0;
    DWORD cbIndexWritten = 0;

    HRESULT hr = pIndex->GetIndexWriteSpace(&cbIndex);
    if (FAILED(hr))
    {
        goto done;
    }

    hr = MFCreateMemoryBuffer(cbChunkSize, &pBuffer);
    if (FAILED(hr))
    {
        goto done;
    }

    while (cbIndexWritten < cbIndex)
    {
        BYTE *pData = NULL;
        DWORD cbData = 0;
        DWORD cbWritten = 0;

        hr = pIndex->GetCompletedIndex(pBuffer, cbIndexWritten);
        if (FAILED(hr))
        {
            goto done;
        }

        hr = pBuffer->Lock(&pData, NULL, &cbData);
        if (FAILED(hr))
        {
            goto done;
        }

        hr = pStream->Write(pData, cbData, &cbWritten);

        (void)pBuffer->Unlock();

        if (FAILED(hr))
        {
            goto done;
        }

        cbIndexWritten += cbData;
    }

done:
    SafeRelease(&pBuffer);
    return hr;
};