AVIStreamRead

関数

AVIストリームからサンプルデータを読み込む。

DLLAVIFIL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// AVIFIL32.dll
#include <windows.h>

HRESULT AVIStreamRead(
    IAVIStream* pavi,
    INT lStart,
    INT lSamples,
    void* lpBuffer,   // optional
    INT cbBuffer,
    INT* plBytes,   // optional
    INT* plSamples   // optional
);

パラメーター

名前	型	方向	説明
pavi	IAVIStream*	in	オープンされているストリームへのハンドル。
lStart	INT	in	読み取る最初のサンプル。
lSamples	INT	in	読み取るサンプル数。AVISTREAMREAD_CONVENIENT を指定して、読み取るサンプル数をストリームハンドラーに決定させることもできます。
lpBuffer	void*	outoptional	データを格納するバッファーへのポインター。
cbBuffer	INT	in	lpBuffer が指すバッファーのサイズ (バイト単位)。
plBytes	INT*	outoptional	lpBuffer が参照するバッファーに書き込まれたデータのバイト数を受け取るバッファーへのポインター。この値は NULL にすることができます。
plSamples	INT*	outoptional	lpBuffer が参照するバッファーに書き込まれたサンプル数を受け取るバッファーへのポインター。この値は NULL にすることができます。

戻り値の型: HRESULT

公式ドキュメント

AVIStreamRead 関数は、ストリームの種類に応じて、ストリームからオーディオ、ビデオ、またはその他のデータを読み取ります。

戻り値

成功した場合は 0 を返し、それ以外の場合はエラーを返します。考えられるエラー値には次のものがあります。

戻り値	説明
AVIERR_BUFFERTOOSMALL	バッファーサイズ cbBuffer が、データ 1 サンプル分よりも小さい値でした。
AVIERR_MEMORY	読み取り操作を完了するのに十分なメモリがありませんでした。
AVIERR_FILEREAD	ファイルの読み取り中にディスクエラーが発生しました。

解説(Remarks)

lpBuffer が NULL の場合、この関数はデータを読み取らず、読み取られるデータのサイズに関する情報を返します。

引数 pavi は、IAVIStream インターフェイスへのポインターです。

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

各言語での呼び出し定義

// AVIFIL32.dll
#include <windows.h>

HRESULT AVIStreamRead(
    IAVIStream* pavi,
    INT lStart,
    INT lSamples,
    void* lpBuffer,   // optional
    INT cbBuffer,
    INT* plBytes,   // optional
    INT* plSamples   // optional
);

[DllImport("AVIFIL32.dll", ExactSpelling = true)]
static extern int AVIStreamRead(
    IntPtr pavi,   // IAVIStream*
    int lStart,   // INT
    int lSamples,   // INT
    IntPtr lpBuffer,   // void* optional, out
    int cbBuffer,   // INT
    IntPtr plBytes,   // INT* optional, out
    IntPtr plSamples   // INT* optional, out
);

<DllImport("AVIFIL32.dll", ExactSpelling:=True)>
Public Shared Function AVIStreamRead(
    pavi As IntPtr,   ' IAVIStream*
    lStart As Integer,   ' INT
    lSamples As Integer,   ' INT
    lpBuffer As IntPtr,   ' void* optional, out
    cbBuffer As Integer,   ' INT
    plBytes As IntPtr,   ' INT* optional, out
    plSamples As IntPtr   ' INT* optional, out
) As Integer
End Function

' pavi : IAVIStream*
' lStart : INT
' lSamples : INT
' lpBuffer : void* optional, out
' cbBuffer : INT
' plBytes : INT* optional, out
' plSamples : INT* optional, out
Declare PtrSafe Function AVIStreamRead Lib "avifil32" ( _
    ByVal pavi As LongPtr, _
    ByVal lStart As Long, _
    ByVal lSamples As Long, _
    ByVal lpBuffer As LongPtr, _
    ByVal cbBuffer As Long, _
    ByVal plBytes As LongPtr, _
    ByVal plSamples As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AVIStreamRead = ctypes.windll.avifil32.AVIStreamRead
AVIStreamRead.restype = ctypes.c_int
AVIStreamRead.argtypes = [
    ctypes.c_void_p,  # pavi : IAVIStream*
    ctypes.c_int,  # lStart : INT
    ctypes.c_int,  # lSamples : INT
    ctypes.POINTER(None),  # lpBuffer : void* optional, out
    ctypes.c_int,  # cbBuffer : INT
    ctypes.POINTER(ctypes.c_int),  # plBytes : INT* optional, out
    ctypes.POINTER(ctypes.c_int),  # plSamples : INT* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVIFIL32.dll')
AVIStreamRead = Fiddle::Function.new(
  lib['AVIStreamRead'],
  [
    Fiddle::TYPE_VOIDP,  # pavi : IAVIStream*
    Fiddle::TYPE_INT,  # lStart : INT
    Fiddle::TYPE_INT,  # lSamples : INT
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* optional, out
    Fiddle::TYPE_INT,  # cbBuffer : INT
    Fiddle::TYPE_VOIDP,  # plBytes : INT* optional, out
    Fiddle::TYPE_VOIDP,  # plSamples : INT* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "avifil32")]
extern "system" {
    fn AVIStreamRead(
        pavi: *mut core::ffi::c_void,  // IAVIStream*
        lStart: i32,  // INT
        lSamples: i32,  // INT
        lpBuffer: *mut (),  // void* optional, out
        cbBuffer: i32,  // INT
        plBytes: *mut i32,  // INT* optional, out
        plSamples: *mut i32  // INT* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("AVIFIL32.dll")]
public static extern int AVIStreamRead(IntPtr pavi, int lStart, int lSamples, IntPtr lpBuffer, int cbBuffer, IntPtr plBytes, IntPtr plSamples);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVIFIL32_AVIStreamRead' -Namespace Win32 -PassThru
# $api::AVIStreamRead(pavi, lStart, lSamples, lpBuffer, cbBuffer, plBytes, plSamples)

#uselib "AVIFIL32.dll"
#func global AVIStreamRead "AVIStreamRead" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; AVIStreamRead pavi, lStart, lSamples, lpBuffer, cbBuffer, varptr(plBytes), varptr(plSamples)   ; 戻り値は stat
; pavi : IAVIStream* -> "sptr"
; lStart : INT -> "sptr"
; lSamples : INT -> "sptr"
; lpBuffer : void* optional, out -> "sptr"
; cbBuffer : INT -> "sptr"
; plBytes : INT* optional, out -> "sptr"
; plSamples : INT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "AVIFIL32.dll"
#cfunc global AVIStreamRead "AVIStreamRead" sptr, int, int, sptr, int, var, var
; res = AVIStreamRead(pavi, lStart, lSamples, lpBuffer, cbBuffer, plBytes, plSamples)
; pavi : IAVIStream* -> "sptr"
; lStart : INT -> "int"
; lSamples : INT -> "int"
; lpBuffer : void* optional, out -> "sptr"
; cbBuffer : INT -> "int"
; plBytes : INT* optional, out -> "var"
; plSamples : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "AVIFIL32.dll"
#cfunc global AVIStreamRead "AVIStreamRead" sptr, int, int, sptr, int, sptr, sptr
; res = AVIStreamRead(pavi, lStart, lSamples, lpBuffer, cbBuffer, varptr(plBytes), varptr(plSamples))
; pavi : IAVIStream* -> "sptr"
; lStart : INT -> "int"
; lSamples : INT -> "int"
; lpBuffer : void* optional, out -> "sptr"
; cbBuffer : INT -> "int"
; plBytes : INT* optional, out -> "sptr"
; plSamples : INT* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。