acmFormatEnumA

関数

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

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

シグネチャ

// MSACM32.dll  (ANSI / -A)
#include <windows.h>

DWORD acmFormatEnumA(
    HACMDRIVER had,
    ACMFORMATDETAILSA* pafd,
    ACMFORMATENUMCBA fnCallback,
    UINT_PTR dwInstance,
    DWORD fdwEnum
);

パラメーター

名前

型

方向

説明

had

HACMDRIVER

waveform-audio 形式の詳細を照会する ACM ドライバーへのハンドル。このパラメーターが NULL の場合、ACM は最初に見つかった適切な ACM ドライバーの詳細を使用します。

pafd

ACMFORMATDETAILSA*

inout

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

構造体の fdwSupport メンバーはゼロに初期化されている必要があります。

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

fnCallback

ACMFORMATENUMCBA

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

dwInstance

UINT_PTR

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

fdwEnum

DWORD

指定された形式タグに対して形式を列挙する際のフラグ。次の値が定義されています。

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

値	意味
ACM_FORMATENUMF_CONVERT
ACM_FORMATENUMF_HARDWARE	インストールされている 1 つ以上の waveform-audio デバイスでネイティブの入力形式または出力形式としてサポートされている形式のみを列挙します。このフラグは、アプリケーションがインストール済みの waveform-audio デバイスにネイティブな形式のみを選択する手段を提供します。このフラグは、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 関数は、ACM ドライバーから指定された形式タグに対して利用可能な waveform-audio 形式を列挙します。この関数は、形式タグに適合する形式がなくなるか、コールバック関数が FALSE を返すまで列挙を続けます。(acmFormatEnumA)

戻り値

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

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

解説(Remarks)

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

例

次の例は、WAVE_FORMAT_MPEGLAYER3 形式タグを持つ形式を列挙する方法を示しています。


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 ヘッダーは、acmFormatEnum を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// MSACM32.dll  (ANSI / -A)
#include <windows.h>

DWORD acmFormatEnumA(
    HACMDRIVER had,
    ACMFORMATDETAILSA* pafd,
    ACMFORMATENUMCBA fnCallback,
    UINT_PTR dwInstance,
    DWORD fdwEnum
);

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

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

' had : HACMDRIVER
' pafd : ACMFORMATDETAILSA* in/out
' fnCallback : ACMFORMATENUMCBA
' dwInstance : UINT_PTR
' fdwEnum : DWORD
Declare PtrSafe Function acmFormatEnumA Lib "msacm32" ( _
    ByVal had As LongPtr, _
    ByVal pafd As LongPtr, _
    ByVal fnCallback As LongPtr, _
    ByVal dwInstance As LongPtr, _
    ByVal fdwEnum As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSACM32.dll')
acmFormatEnumA = Fiddle::Function.new(
  lib['acmFormatEnumA'],
  [
    Fiddle::TYPE_VOIDP,  # had : HACMDRIVER
    Fiddle::TYPE_VOIDP,  # pafd : ACMFORMATDETAILSA* in/out
    Fiddle::TYPE_VOIDP,  # fnCallback : ACMFORMATENUMCBA
    Fiddle::TYPE_UINTPTR_T,  # dwInstance : UINT_PTR
    -Fiddle::TYPE_INT,  # fdwEnum : DWORD
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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