IAVIFile

COM

IID00020020-0000-0000-c000-000000000046継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IAVIFile インターフェイスは、ファイルおよびファイルヘッダーのオープンと操作、ならびにストリームインターフェイスの作成と取得をサポートします。以下のカスタムメソッドに加えて、IUnknown::QueryInterface、IUnknown::AddRef、IUnknown::Release を使用します。

メソッド 7

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

vtbl 3 HRESULT Info(AVIFILEINFOW* pfi, INT lSize)

Info メソッドは、AVI ファイルに関する情報を返します。アプリケーションが AVIFileInfo 関数を使用したときに呼び出されます。

pfi

AVIFILEINFOW*

out

AVIFILEINFO 構造体へのポインター。このメソッドは、ファイルに関する情報をこの構造体に格納します。

lSize

INT

pfi で指定されたバッファーのサイズ (バイト単位)。

- pf

ファイルのインターフェイスへのポインター。

戻り値

OLE で定義された HRESULT を返します。

解説(Remarks)

割り当てられたバッファーが構造体に対して小さすぎる場合、このメソッドは AVIERR_BUFFERTOOSMALL を返して呼び出しを失敗させる必要があります。それ以外の場合は、構造体を格納してそのサイズを返します。

C++ で記述されたハンドラーの場合、Info の構文は次のとおりです。


HRESULT Info(AVIFILEINFO *pfi, LONG lSize)

vtbl 4 HRESULT GetStream(IAVIStream** ppStream, DWORD fccType, INT lParam)

GetStream メソッドは、ファイル内のストリームにアクセスしてストリームを開きます。アプリケーションが AVIFileGetStream 関数を使用したときに呼び出されます。

ppStream

IAVIStream**

out

ストリームのインターフェイスへのポインターを受け取るバッファーへのポインター。

fccType

DWORD

検索するストリームの種類を示す 4 文字コード。

lParam

INT

ストリーム番号。

- pf

ファイルのインターフェイスへのポインター。

戻り値

OLE で定義された HRESULT を返します。

解説(Remarks)

通常は、IAVIFile::Open メソッドを使用してあらかじめすべてのストリームオブジェクトを作成しておくと、このメソッドを実装しやすくなります。その場合、このメソッドは指定されたストリームのインターフェイスにアクセスするだけで済みます。

このメソッドを使用する際は、ストリームの AddRef メソッドが管理する参照カウントをインクリメントすることを忘れないでください。

C++ で記述されたハンドラーの場合、GetStream の構文は次のとおりです。


HRESULT GetStream(PAVISTREAM *ppStream, 
    DWORD fccType, LONG lParam);

vtbl 5 HRESULT CreateStream(IAVIStream** ppStream, AVISTREAMINFOW* psi)

CreateStream メソッドは、書き込み用のストリームを作成します。アプリケーションが AVIFileCreateStream 関数を使用したときに呼び出されます。

ppStream	IAVIStream**	out	新しいストリームのインターフェイスへのポインターを受け取るバッファーへのポインター。
psi	AVISTREAMINFOW*	in	作成するストリームを定義する AVISTREAMINFO 構造体へのポインター。

戻り値

OLE で定義された HRESULT を返します。

解説(Remarks)

C++ で記述されたハンドラーの場合、CreateStream の構文は次のとおりです。


HRESULT CreateStream(PAVISTREAM *ppstream, 
    AVISTREAMINFO *psi);

vtbl 6 HRESULT WriteData(DWORD ckid, void* lpData, INT cbData)

WriteData メソッドは、ファイルヘッダーを書き込みます。アプリケーションが AVIFileWriteData 関数を使用したときに呼び出されます。

ckid	DWORD	in	チャンク ID。
lpData	void*	in	データの書き込み元となるメモリを指定するポインター。
cbData	INT	in	書き込むバイト数を指定する LONG 値。

戻り値

OLE で定義された HRESULT を返します。

解説(Remarks)

C++ で記述されたハンドラーの場合、WriteData の構文は次のとおりです。


HRESULT WriteData(DWORD fcc, LPVOID lpBuffer, LONG cbBuffer);

vtbl 7 HRESULT ReadData(DWORD ckid, void* lpData, INT* lpcbData)

ReadData メソッドは、ファイルヘッダーを読み取ります。アプリケーションが AVIFileReadData 関数を使用したときに呼び出されます。

ckid	DWORD	in	チャンク識別子。
lpData	void*	out	データの読み取り先となるメモリを指定するポインター。
lpcbData	INT*	inout	読み取られたバイト数を格納する LONG へのポインター。

戻り値

OLE で定義された HRESULT を返します。

解説(Remarks)

C++ で記述されたハンドラーの場合、ReadData の構文は次のとおりです。


HRESULT ReadData(DWORD fcc, LPVOID lp, LONG *lpcb);

vtbl 8 HRESULT EndRecord()

EndRecord メソッドは、密にインターリーブされた AVI ファイル (音声と映像のインターリーブ係数が 1 対 1 のファイル) に "REC" チャンクを書き込みます。アプリケーションが AVIFileEndRecord 関数を使用したときに呼び出されます。

戻り値

OLE で定義された HRESULT を返します。

解説(Remarks)

このファイルハンドラーメソッドは通常使用されません。

C++ で記述されたハンドラーの場合、EndRecord の構文は次のとおりです。


HRESULT EndRecord(VOID);

vtbl 9 HRESULT DeleteStream(DWORD fccType, INT lParam)

fccType	DWORD	in	削除するストリーム種別を示すFOURCC。
lParam	INT	in	同種ストリーム内の0始まりインデックス。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IAVIFile "{00020020-0000-0000-C000-000000000046}"
#usecom global IAVIFile IID_IAVIFile "{}"
#comfunc global IAVIFile_Info          3 var,int
#comfunc global IAVIFile_GetStream     4 sptr,int,int
#comfunc global IAVIFile_CreateStream  5 sptr,var
#comfunc global IAVIFile_WriteData     6 int,sptr,int
#comfunc global IAVIFile_ReadData      7 int,sptr,var
#comfunc global IAVIFile_EndRecord     8
#comfunc global IAVIFile_DeleteStream  9 int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IAVIFile "{00020020-0000-0000-C000-000000000046}"
#usecom global IAVIFile IID_IAVIFile "{}"
#comfunc global IAVIFile_Info          3 sptr,int
#comfunc global IAVIFile_GetStream     4 sptr,int,int
#comfunc global IAVIFile_CreateStream  5 sptr,sptr
#comfunc global IAVIFile_WriteData     6 int,sptr,int
#comfunc global IAVIFile_ReadData      7 int,sptr,sptr
#comfunc global IAVIFile_EndRecord     8
#comfunc global IAVIFile_DeleteStream  9 int,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。