acmFormatEnumW

関数

利用可能な波形フォーマットを列挙しコールバックへ通知する。Unicode版。

DLLMSACM32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// MSACM32.dll  (Unicode / -W)
#include <windows.h>

DWORD acmFormatEnumW(
    HACMDRIVER had,
    tACMFORMATDETAILSW* pafd,
    ACMFORMATENUMCBW fnCallback,
    UINT_PTR dwInstance,
    DWORD fdwEnum
);

パラメーター

名前

型

方向

説明

had

HACMDRIVER

波形オーディオフォーマットの詳細を照会する対象の ACM ドライバーへのハンドル。このパラメーターが NULL の場合、ACM は最初の適切な ACM ドライバーの詳細を使用します。

pafd

tACMFORMATDETAILSW*

inout

fnCallback 関数に渡されるフォーマット詳細を格納する ACMFORMATDETAILS 構造体へのポインター。この構造体は、ACMFORMATDETAILS 構造体の cbStruct、pwfx、cbwfx の各メンバーを初期化しておく必要があります。dwFormatTag メンバーも、WAVE_FORMAT_UNKNOWN または有効な format tag のいずれかに初期化しておく必要があります。

構造体の fdwSupport メンバーはゼロに初期化しておく必要があります。

pwfx バッファーに必要なサイズを求めるには、ACM_METRIC_MAX_SIZE_FORMAT フラグを指定して acmMetrics を呼び出します。

fnCallback

ACMFORMATENUMCBW

アプリケーション定義のコールバック関数のアドレス。acmFormatEnumCallback を参照してください。このパラメーターを NULL にすることはできません。

dwInstance

UINT_PTR

ACM フォーマット詳細とともにコールバック関数に渡される、64 ビット (DWORD_PTR) または 32 ビット (DWORD) のアプリケーション定義の値。

fdwEnum

DWORD

指定された format tag のフォーマットを列挙するためのフラグ。次の値が定義されています。

[ACMFORMATDETAILS](./nf-msacm-acmformatdetails.md) 構造体の pwfx メンバーが指す WAVEFORMATEX 構造体が有効です。列挙子は、指定された pwfx フォーマットから変換可能な変換先フォーマットのみを列挙します。このフラグを使用する場合、WAVEFORMATEX 構造体の wFormatTag メンバーを WAVE_FORMAT_UNKNOWN にすることはできません。 [ACMFORMATDETAILS](./nf-msacm-acmformatdetails.md) 構造体の pwfx メンバーが指す WAVEFORMATEX 構造体の nChannels メンバーが有効です。列挙子は、この属性に適合するフォーマットのみを列挙します。 [ACMFORMATDETAILS](./nf-msacm-acmformatdetails.md) 構造体の pwfx メンバーが指す WAVEFORMATEX 構造体が有効です。列挙子は、指定された pwfx フォーマットに対して提案されるすべての変換先フォーマットを列挙します。このメカニズムは、acmFormatSuggest 関数の代わりに使用でき、アプリケーションが変換に最適な提案フォーマットを選択できるようにします。dwFormatIndex メンバーは、戻り時に常にゼロに設定されます。このフラグを使用する場合、WAVEFORMATEX 構造体の wFormatTag メンバーを WAVE_FORMAT_UNKNOWN にすることはできません。

値	意味
ACM_FORMATENUMF_CONVERT
ACM_FORMATENUMF_HARDWARE	列挙子は、インストールされている 1 つ以上の波形オーディオデバイスでネイティブの入力または出力フォーマットとしてサポートされるフォーマットのみを列挙します。このフラグは、アプリケーションがインストールされた波形オーディオデバイスにネイティブなフォーマットのみを選択する手段を提供します。このフラグは、ACM_FORMATENUMF_INPUT および ACM_FORMATENUMF_OUTPUT フラグの一方または両方とともに使用する必要があります。ACM_FORMATENUMF_INPUT と ACM_FORMATENUMF_OUTPUT の両方を指定すると、入力または出力のために開くことができるフォーマットのみが列挙されます。これは、このフラグが指定されているかどうかにかかわらず当てはまります。
ACM_FORMATENUMF_INPUT	列挙子は、入力 (録音) でサポートされるフォーマットのみを列挙します。
ACM_FORMATENUMF_NCHANNELS
ACM_FORMATENUMF_NSAMPLESPERSEC	ACMFORMATDETAILS 構造体の pwfx メンバーが指す WAVEFORMATEX 構造体の nSamplesPerSec メンバーが有効です。列挙子は、この属性に適合するフォーマットのみを列挙します。
ACM_FORMATENUMF_OUTPUT	列挙子は、出力 (再生) でサポートされるフォーマットのみを列挙します。
ACM_FORMATENUMF_SUGGEST
ACM_FORMATENUMF_WBITSPERSAMPLE	ACMFORMATDETAILS 構造体の pwfx メンバーが指す WAVEFORMATEX 構造体の wBitsPerSample メンバーが有効です。列挙子は、この属性に適合するフォーマットのみを列挙します。
ACM_FORMATENUMF_WFORMATTAG	ACMFORMATDETAILS 構造体の pwfx メンバーが指す WAVEFORMATEX 構造体の wFormatTag メンバーが有効です。列挙子は、この属性に適合するフォーマットのみを列挙します。ACMFORMATDETAILS 構造体の dwFormatTag メンバーは、wFormatTag メンバーと等しくなければなりません。この場合、wFormatTag の値を WAVE_FORMAT_UNKNOWN にすることはできません。

戻り値の型: DWORD

公式ドキュメント

acmFormatEnum (Unicode) 関数は、ACM ドライバーから指定された format tag に対して利用可能な waveform-audio フォーマットを列挙します。この関数は、その format tag に対して適切なフォーマットがなくなるか、またはコールバック関数が FALSE を返すまで列挙を続けます。(acmFormatEnumW)

戻り値

成功した場合はゼロを、それ以外の場合はエラーを返します。返される可能性のあるエラー値には次のものがあります。

戻り値	説明
ACMERR_NOTPOSSIBLE	フォーマットの詳細を返すことができません。
MMSYSERR_INVALFLAG	少なくとも 1 つのフラグが無効です。
MMSYSERR_INVALHANDLE	指定されたハンドルが無効です。
MMSYSERR_INVALPARAM	少なくとも 1 つのパラメーターが無効です。

解説(Remarks)

適切な ACM ドライバーがインストールされていない場合、この関数は MMSYSERR_NOERROR (ゼロ) を返します。また、コールバック関数は呼び出されません。

例

次の例は、WAVE_FORMAT_MPEGLAYER3 format tag を持つフォーマットを列挙する方法を示しています。


MMRESULT EnumerateMP3Codecs()
{
    DWORD cbMaxSize = 0;
    MMRESULT result = MMSYSERR_NOERROR;
    ACMFORMATDETAILS acmFormatDetails;

    // Buffer to hold the format information.
    BYTE *pFormat = NULL;   // Caller allocated.

    // Find the largest format buffer needed.
    result = acmMetrics(NULL, ACM_METRIC_MAX_SIZE_FORMAT, &cbMaxSize);
    if (result != MMSYSERR_NOERROR)
    {
        return result;
    }

    // Allocate the format buffer.
    pFormat = new BYTE[cbMaxSize];
    if (pFormat == NULL)
    {
        return MMSYSERR_NOMEM;
    }

    ZeroMemory(pFormat, cbMaxSize);

    // Ask for WAVE_FORMAT_MPEGLAYER3 formats.
    WAVEFORMATEX* pWaveFormat = (WAVEFORMATEX*)pFormat;
    pWaveFormat->wFormatTag = WAVE_FORMAT_MPEGLAYER3;

    // Set up the acmFormatDetails structure.
    ZeroMemory(&acmFormatDetails, sizeof(acmFormatDetails));
    acmFormatDetails.cbStruct = sizeof(ACMFORMATDETAILS);
    acmFormatDetails.pwfx = pWaveFormat; 
    acmFormatDetails.cbwfx = cbMaxSize;

    // For the ACM_FORMATENUMF_WFORMATTAG request, the format
    // tag in acmFormatDetails must match the format tag in
    // the pFormat buffer.
    acmFormatDetails.dwFormatTag = WAVE_FORMAT_MPEGLAYER3;

    result = acmFormatEnum(NULL, &acmFormatDetails, acmFormatEnumCallback,
        0, ACM_FORMATENUMF_WFORMATTAG);

    delete [] pFormat;

    return result;
}

次の例は、上記の例のコールバック関数を示しています。コールバック関数は、一致するフォーマットごとに 1 回ずつ、またはコールバックが FALSE を返すまで呼び出されます。


BOOL CALLBACK acmFormatEnumCallback(
  HACMDRIVERID       hadid,      
  LPACMFORMATDETAILS pafd,       
  DWORD_PTR          dwInstance, 
  DWORD              fdwSupport  
)
{
    BOOL bContinue = TRUE;
    MPEGLAYER3WAVEFORMAT *pMP3WaveFormat = NULL;

    if (pafd->pwfx->wFormatTag == WAVE_FORMAT_MPEGLAYER3)
    {
        pMP3WaveFormat = (MPEGLAYER3WAVEFORMAT*)pafd->pwfx;

        // TODO: Examine the format. 

        // To halt the enumeration, set bContinue to FALSE.
    }


    return bContinue;
}

メモ

msacm.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして acmFormatEnum を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// MSACM32.dll  (Unicode / -W)
#include <windows.h>

DWORD acmFormatEnumW(
    HACMDRIVER had,
    tACMFORMATDETAILSW* pafd,
    ACMFORMATENUMCBW fnCallback,
    UINT_PTR dwInstance,
    DWORD fdwEnum
);

[DllImport("MSACM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint acmFormatEnumW(
    IntPtr had,   // HACMDRIVER
    IntPtr pafd,   // tACMFORMATDETAILSW* in/out
    IntPtr fnCallback,   // ACMFORMATENUMCBW
    UIntPtr dwInstance,   // UINT_PTR
    uint fdwEnum   // DWORD
);

<DllImport("MSACM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function acmFormatEnumW(
    had As IntPtr,   ' HACMDRIVER
    pafd As IntPtr,   ' tACMFORMATDETAILSW* in/out
    fnCallback As IntPtr,   ' ACMFORMATENUMCBW
    dwInstance As UIntPtr,   ' UINT_PTR
    fdwEnum As UInteger   ' DWORD
) As UInteger
End Function

' had : HACMDRIVER
' pafd : tACMFORMATDETAILSW* in/out
' fnCallback : ACMFORMATENUMCBW
' dwInstance : UINT_PTR
' fdwEnum : DWORD
Declare PtrSafe Function acmFormatEnumW Lib "msacm32" ( _
    ByVal had As LongPtr, _
    ByVal pafd As LongPtr, _
    ByVal fnCallback As LongPtr, _
    ByVal dwInstance As LongPtr, _
    ByVal fdwEnum As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

acmFormatEnumW = ctypes.windll.msacm32.acmFormatEnumW
acmFormatEnumW.restype = wintypes.DWORD
acmFormatEnumW.argtypes = [
    wintypes.HANDLE,  # had : HACMDRIVER
    ctypes.c_void_p,  # pafd : tACMFORMATDETAILSW* in/out
    ctypes.c_void_p,  # fnCallback : ACMFORMATENUMCBW
    ctypes.c_size_t,  # dwInstance : UINT_PTR
    wintypes.DWORD,  # fdwEnum : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSACM32.dll')
acmFormatEnumW = Fiddle::Function.new(
  lib['acmFormatEnumW'],
  [
    Fiddle::TYPE_VOIDP,  # had : HACMDRIVER
    Fiddle::TYPE_VOIDP,  # pafd : tACMFORMATDETAILSW* in/out
    Fiddle::TYPE_VOIDP,  # fnCallback : ACMFORMATENUMCBW
    Fiddle::TYPE_UINTPTR_T,  # dwInstance : UINT_PTR
    -Fiddle::TYPE_INT,  # fdwEnum : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msacm32")]
extern "system" {
    fn acmFormatEnumW(
        had: *mut core::ffi::c_void,  // HACMDRIVER
        pafd: *mut tACMFORMATDETAILSW,  // tACMFORMATDETAILSW* in/out
        fnCallback: *const core::ffi::c_void,  // ACMFORMATENUMCBW
        dwInstance: usize,  // UINT_PTR
        fdwEnum: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MSACM32.dll", CharSet = CharSet.Unicode)]
public static extern uint acmFormatEnumW(IntPtr had, IntPtr pafd, IntPtr fnCallback, UIntPtr dwInstance, uint fdwEnum);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSACM32_acmFormatEnumW' -Namespace Win32 -PassThru
# $api::acmFormatEnumW(had, pafd, fnCallback, dwInstance, fdwEnum)

#uselib "MSACM32.dll"
#func global acmFormatEnumW "acmFormatEnumW" wptr, wptr, wptr, wptr, wptr
; acmFormatEnumW had, varptr(pafd), fnCallback, dwInstance, fdwEnum   ; 戻り値は stat
; had : HACMDRIVER -> "wptr"
; pafd : tACMFORMATDETAILSW* in/out -> "wptr"
; fnCallback : ACMFORMATENUMCBW -> "wptr"
; dwInstance : UINT_PTR -> "wptr"
; fdwEnum : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MSACM32.dll"
#cfunc global acmFormatEnumW "acmFormatEnumW" sptr, var, sptr, sptr, int
; res = acmFormatEnumW(had, pafd, fnCallback, dwInstance, fdwEnum)
; had : HACMDRIVER -> "sptr"
; pafd : tACMFORMATDETAILSW* in/out -> "var"
; fnCallback : ACMFORMATENUMCBW -> "sptr"
; dwInstance : UINT_PTR -> "sptr"
; fdwEnum : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MSACM32.dll"
#cfunc global acmFormatEnumW "acmFormatEnumW" sptr, sptr, sptr, sptr, int
; res = acmFormatEnumW(had, varptr(pafd), fnCallback, dwInstance, fdwEnum)
; had : HACMDRIVER -> "sptr"
; pafd : tACMFORMATDETAILSW* in/out -> "sptr"
; fnCallback : ACMFORMATENUMCBW -> "sptr"
; dwInstance : UINT_PTR -> "sptr"
; fdwEnum : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。