acmStreamConvert

関数

準備済みヘッダーを用いてACMストリームのデータ変換を実行する。

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

シグネチャ

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

DWORD acmStreamConvert(
    HACMSTREAM has,
    ACMSTREAMHEADER* pash,
    DWORD fdwConvert
);

パラメーター

名前

型

方向

説明

has

HACMSTREAM

開かれている変換ストリームのハンドル。

pash

ACMSTREAMHEADER*

inout

変換のソースバッファーとデスティネーションバッファーを記述するストリームヘッダーへのポインター。このヘッダーは、事前に acmStreamPrepareHeader 関数を使用して準備されている必要があります。

fdwConvert

DWORD

変換を実行するためのフラグ。次の値が定義されています。

値	意味
ACM_STREAMCONVERTF_BLOCKALIGN	ブロックの整数個分のみが変換されます。変換されたデータはブロック境界で終了します。アプリケーションは、ブロック境界に整列したデスティネーションに変換するのに十分なソースデータがなくなるまで、ストリーム上のすべての変換に対してこのフラグを使用してください。この場合、最後の変換ではこのフラグを指定せずに実行してください。
ACM_STREAMCONVERTF_END	ACM 変換ストリームが保留中のインスタンスデータの返却を開始します。たとえば、変換ストリームがエコーフィルター操作の終端などのインスタンスデータを保持している場合、このフラグにより、ストリームは残りのデータを任意のソースデータとともに返し始めます。このフラグは ACM_STREAMCONVERTF_START フラグと併せて指定できます。
ACM_STREAMCONVERTF_START	ACM 変換ストリームがそのインスタンスデータを再初期化します。たとえば、変換ストリームがデルタ情報や予測子情報などのインスタンスデータを保持している場合、このフラグによりストリームは開始時の既定値に復元されます。このフラグは ACM_STREAMCONVERTF_END フラグと併せて指定できます。

戻り値の型: DWORD

公式ドキュメント

acmStreamConvert 関数は、指定された変換ストリームに対して変換を実行するよう ACM に要求します。変換は、ストリームを開いた方法に応じて、同期または非同期になります。

戻り値

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

戻り値	説明
ACMERR_BUSY	pash で指定されたストリームヘッダーは現在使用中であり、再利用できません。
ACMERR_UNPREPARED	pash で指定されたストリームヘッダーは、現在 acmStreamPrepareHeader 関数によって準備されていません。
MMSYSERR_INVALFLAG	少なくとも 1 つのフラグが無効です。
MMSYSERR_INVALHANDLE	指定されたハンドルが無効です。
MMSYSERR_INVALPARAM	少なくとも 1 つのパラメーターが無効です。

解説(Remarks)

ソースバッファーとデスティネーションバッファーを acmStreamConvert に渡す前に、acmStreamPrepareHeader 関数を使用してそれらを準備する必要があります。

非同期変換要求が ACM またはドライバーによって正常にキューに登録され、後でその変換が不可能であると判明した場合、ACMSTREAMHEADER 構造体は、cbDstLengthUsed メンバーが 0 に設定された状態で、アプリケーションのコールバック関数にポストバックされます。

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

各言語での呼び出し定義

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

DWORD acmStreamConvert(
    HACMSTREAM has,
    ACMSTREAMHEADER* pash,
    DWORD fdwConvert
);

[DllImport("MSACM32.dll", ExactSpelling = true)]
static extern uint acmStreamConvert(
    IntPtr has,   // HACMSTREAM
    IntPtr pash,   // ACMSTREAMHEADER* in/out
    uint fdwConvert   // DWORD
);

<DllImport("MSACM32.dll", ExactSpelling:=True)>
Public Shared Function acmStreamConvert(
    has As IntPtr,   ' HACMSTREAM
    pash As IntPtr,   ' ACMSTREAMHEADER* in/out
    fdwConvert As UInteger   ' DWORD
) As UInteger
End Function

' has : HACMSTREAM
' pash : ACMSTREAMHEADER* in/out
' fdwConvert : DWORD
Declare PtrSafe Function acmStreamConvert Lib "msacm32" ( _
    ByVal has As LongPtr, _
    ByVal pash As LongPtr, _
    ByVal fdwConvert As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

acmStreamConvert = ctypes.windll.msacm32.acmStreamConvert
acmStreamConvert.restype = wintypes.DWORD
acmStreamConvert.argtypes = [
    wintypes.HANDLE,  # has : HACMSTREAM
    ctypes.c_void_p,  # pash : ACMSTREAMHEADER* in/out
    wintypes.DWORD,  # fdwConvert : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSACM32.dll')
acmStreamConvert = Fiddle::Function.new(
  lib['acmStreamConvert'],
  [
    Fiddle::TYPE_VOIDP,  # has : HACMSTREAM
    Fiddle::TYPE_VOIDP,  # pash : ACMSTREAMHEADER* in/out
    -Fiddle::TYPE_INT,  # fdwConvert : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msacm32")]
extern "system" {
    fn acmStreamConvert(
        has: *mut core::ffi::c_void,  // HACMSTREAM
        pash: *mut ACMSTREAMHEADER,  // ACMSTREAMHEADER* in/out
        fdwConvert: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MSACM32.dll")]
public static extern uint acmStreamConvert(IntPtr has, IntPtr pash, uint fdwConvert);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSACM32_acmStreamConvert' -Namespace Win32 -PassThru
# $api::acmStreamConvert(has, pash, fdwConvert)

#uselib "MSACM32.dll"
#func global acmStreamConvert "acmStreamConvert" sptr, sptr, sptr
; acmStreamConvert has, varptr(pash), fdwConvert   ; 戻り値は stat
; has : HACMSTREAM -> "sptr"
; pash : ACMSTREAMHEADER* in/out -> "sptr"
; fdwConvert : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MSACM32.dll"
#cfunc global acmStreamConvert "acmStreamConvert" sptr, var, int
; res = acmStreamConvert(has, pash, fdwConvert)
; has : HACMSTREAM -> "sptr"
; pash : ACMSTREAMHEADER* in/out -> "var"
; fdwConvert : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MSACM32.dll"
#cfunc global acmStreamConvert "acmStreamConvert" sptr, sptr, int
; res = acmStreamConvert(has, varptr(pash), fdwConvert)
; has : HACMSTREAM -> "sptr"
; pash : ACMSTREAMHEADER* in/out -> "sptr"
; fdwConvert : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。