waveOutOpen

関数

再生用の波形オーディオ出力デバイスを開く。

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

シグネチャ

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

DWORD waveOutOpen(
    HWAVEOUT* phwo,   // optional
    DWORD uDeviceID,
    WAVEFORMATEX* pwfx,
    UINT_PTR dwCallback,   // optional
    UINT_PTR dwInstance,   // optional
    MIDI_WAVE_OPEN_TYPE fdwOpen
);

パラメーター

名前

型

方向

説明

phwo

HWAVEOUT*

outoptional

開いた波形音声出力デバイスを識別するハンドルを受け取るバッファーへのポインター。他の波形音声出力関数を呼び出す際に、このハンドルでデバイスを識別します。fdwOpen に WAVE_FORMAT_QUERY フラグを指定する場合、このパラメーターは NULL でもかまいません。

uDeviceID

DWORD

開く波形音声出力デバイスの識別子。デバイス識別子、または開いている波形音声入力デバイスのハンドルを指定できます。デバイス識別子の代わりに、次のフラグを使用することもできます。

値	意味
WAVE_MAPPER	指定した形式を再生できる波形音声出力デバイスを関数が選択します。

pwfx

WAVEFORMATEX*

デバイスへ送信する波形音声データの形式を示す WAVEFORMATEX 構造体へのポインター。この構造体は waveOutOpen に渡した直後に解放してかまいません。

dwCallback

UINT_PTR

inoptional

コールバックのしくみを指定します。値は次のいずれかでなければなりません。

コールバック関数へのポインター。関数のシグネチャについては waveOutProc を参照してください。
ウィンドウへのハンドル。
スレッド識別子。
イベントへのハンドル。
NULL 値。

dwCallback パラメーターの解釈方法は fdwOpen パラメーターで指定します。詳細については「解説」を参照してください。

dwInstance

UINT_PTR

inoptional

コールバックのしくみに渡されるユーザーインスタンスデータ。このパラメーターは、ウィンドウコールバックのしくみでは使用されません。

fdwOpen

MIDI_WAVE_OPEN_TYPE

デバイスを開くためのフラグ。次の値が定義されています。

値	意味
CALLBACK_EVENT	dwCallback パラメーターはイベントハンドルです。
CALLBACK_FUNCTION	dwCallback パラメーターはコールバックプロシージャのアドレスです。
CALLBACK_NULL	コールバックのしくみを使用しません。これが既定の設定です。
CALLBACK_THREAD	dwCallback パラメーターはスレッド識別子です。
CALLBACK_WINDOW	dwCallback パラメーターはウィンドウハンドルです。
WAVE_ALLOWSYNC	このフラグを指定すると、同期型の波形音声デバイスを開くことができます。同期型ドライバーを開く際にこのフラグを指定しないと、デバイスのオープンに失敗します。
WAVE_MAPPED_DEFAULT_COMMUNICATION_DEVICE	このフラグを指定し、かつ uDeviceID パラメーターが WAVE_MAPPER の場合、関数は既定の通信デバイスを開きます。このフラグは uDeviceID が WAVE_MAPPER と等しい場合にのみ適用されます。注意 Windows 7 が必要です。
WAVE_FORMAT_DIRECT	このフラグを指定すると、ACM ドライバーは音声データの変換を行いません。
WAVE_FORMAT_QUERY	このフラグを指定すると、waveOutOpen はデバイスが指定した形式をサポートするかどうかを照会しますが、デバイスは実際には開かれません。
WAVE_MAPPED	このフラグを指定すると、uDeviceID パラメーターは wave マッパーによってマップされる波形音声デバイスを指定します。

戻り値の型: DWORD

公式ドキュメント

waveOutOpen 関数は、指定した波形音声出力デバイスを再生用に開きます。

戻り値

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

戻り値	説明
MMSYSERR_ALLOCATED	指定したリソースは既に割り当てられています。
MMSYSERR_BADDEVICEID	指定したデバイス識別子が範囲外です。
MMSYSERR_NODRIVER	デバイスドライバーが存在しません。
MMSYSERR_NOMEM	メモリの割り当てまたはロックができません。
WAVERR_BADFORMAT	サポートされていない波形音声形式で開こうとしました。
WAVERR_SYNC	デバイスは同期型ですが、waveOutOpen が WAVE_ALLOWSYNC フラグを使用せずに呼び出されました。

解説(Remarks)

システムに存在する波形音声出力デバイスの数を確認するには、waveOutGetNumDevs 関数を使用します。uDeviceID パラメーターに指定する値がデバイス識別子の場合、その値は 0 から、存在するデバイス数より 1 小さい値までの範囲を取ります。WAVE_MAPPER 定数もデバイス識別子として使用できます。

pwfx が指す構造体は、特定のデータ形式に固有の型情報を含むように拡張できます。たとえば PCM データの場合、1 サンプルあたりのビット数を指定するために追加の UINT が付加されます。この場合は PCMWAVEFORMAT 構造体を使用します。他のすべての波形音声形式では、WAVEFORMATEX 構造体を使用して追加データの長さを指定します。

ウィンドウまたはスレッドでコールバック情報を受け取るようにした場合、波形音声出力の進行状況を示すために次のメッセージがウィンドウプロシージャ関数へ送られます。MM_WOM_OPEN、MM_WOM_CLOSE、MM_WOM_DONE です。

コールバックのしくみ

dwCallback および fdwOpen パラメーターは、波形音声出力の進行状況をアプリケーションへ通知する方法を指定します。

fdwOpen に CALLBACK_FUNCTION フラグが含まれる場合、dwCallback はコールバック関数へのポインターです。関数のシグネチャについては waveOutProc を参照してください。コールバックの uMsg パラメーターは音声出力の進行状況を示します。

fdwOpen に CALLBACK_WINDOW フラグが含まれる場合、dwCallback はウィンドウへのハンドルです。ウィンドウは進行状況を示す次のメッセージを受け取ります。

fdwOpen に CALLBACK_THREAD フラグが含まれる場合、dwCallback はスレッド識別子です。スレッドは、上記の CALLBACK_WINDOW に挙げたメッセージを受け取ります。

fdwOpen に CALLBACK_EVENT フラグが含まれる場合、dwCallback はイベントへのハンドルです。波形バッファーの状態が変化するたびにイベントがシグナル状態になります。アプリケーションは WaitForSingleObject または WaitForMultipleObjects を使用してイベントを待機できます。イベントがシグナル状態になったとき、WAVEHDR 構造体の dwFlags メンバーを調べることで、波形バッファーの現在の状態を取得できます。(waveOutPrepareHeader を参照してください。)

fdwOpen に CALLBACK_NULL フラグが含まれる場合、dwCallback は NULL でなければなりません。この場合、コールバックのしくみは使用されません。

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

各言語での呼び出し定義

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

DWORD waveOutOpen(
    HWAVEOUT* phwo,   // optional
    DWORD uDeviceID,
    WAVEFORMATEX* pwfx,
    UINT_PTR dwCallback,   // optional
    UINT_PTR dwInstance,   // optional
    MIDI_WAVE_OPEN_TYPE fdwOpen
);

[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint waveOutOpen(
    IntPtr phwo,   // HWAVEOUT* optional, out
    uint uDeviceID,   // DWORD
    IntPtr pwfx,   // WAVEFORMATEX*
    UIntPtr dwCallback,   // UINT_PTR optional
    UIntPtr dwInstance,   // UINT_PTR optional
    uint fdwOpen   // MIDI_WAVE_OPEN_TYPE
);

<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function waveOutOpen(
    phwo As IntPtr,   ' HWAVEOUT* optional, out
    uDeviceID As UInteger,   ' DWORD
    pwfx As IntPtr,   ' WAVEFORMATEX*
    dwCallback As UIntPtr,   ' UINT_PTR optional
    dwInstance As UIntPtr,   ' UINT_PTR optional
    fdwOpen As UInteger   ' MIDI_WAVE_OPEN_TYPE
) As UInteger
End Function

' phwo : HWAVEOUT* optional, out
' uDeviceID : DWORD
' pwfx : WAVEFORMATEX*
' dwCallback : UINT_PTR optional
' dwInstance : UINT_PTR optional
' fdwOpen : MIDI_WAVE_OPEN_TYPE
Declare PtrSafe Function waveOutOpen Lib "winmm" ( _
    ByVal phwo As LongPtr, _
    ByVal uDeviceID As Long, _
    ByVal pwfx As LongPtr, _
    ByVal dwCallback As LongPtr, _
    ByVal dwInstance As LongPtr, _
    ByVal fdwOpen As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

waveOutOpen = ctypes.windll.winmm.waveOutOpen
waveOutOpen.restype = wintypes.DWORD
waveOutOpen.argtypes = [
    ctypes.c_void_p,  # phwo : HWAVEOUT* optional, out
    wintypes.DWORD,  # uDeviceID : DWORD
    ctypes.c_void_p,  # pwfx : WAVEFORMATEX*
    ctypes.c_size_t,  # dwCallback : UINT_PTR optional
    ctypes.c_size_t,  # dwInstance : UINT_PTR optional
    wintypes.DWORD,  # fdwOpen : MIDI_WAVE_OPEN_TYPE
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
waveOutOpen = Fiddle::Function.new(
  lib['waveOutOpen'],
  [
    Fiddle::TYPE_VOIDP,  # phwo : HWAVEOUT* optional, out
    -Fiddle::TYPE_INT,  # uDeviceID : DWORD
    Fiddle::TYPE_VOIDP,  # pwfx : WAVEFORMATEX*
    Fiddle::TYPE_UINTPTR_T,  # dwCallback : UINT_PTR optional
    Fiddle::TYPE_UINTPTR_T,  # dwInstance : UINT_PTR optional
    -Fiddle::TYPE_INT,  # fdwOpen : MIDI_WAVE_OPEN_TYPE
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn waveOutOpen(
        phwo: *mut *mut core::ffi::c_void,  // HWAVEOUT* optional, out
        uDeviceID: u32,  // DWORD
        pwfx: *mut WAVEFORMATEX,  // WAVEFORMATEX*
        dwCallback: usize,  // UINT_PTR optional
        dwInstance: usize,  // UINT_PTR optional
        fdwOpen: u32  // MIDI_WAVE_OPEN_TYPE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll")]
public static extern uint waveOutOpen(IntPtr phwo, uint uDeviceID, IntPtr pwfx, UIntPtr dwCallback, UIntPtr dwInstance, uint fdwOpen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_waveOutOpen' -Namespace Win32 -PassThru
# $api::waveOutOpen(phwo, uDeviceID, pwfx, dwCallback, dwInstance, fdwOpen)

#uselib "WINMM.dll"
#func global waveOutOpen "waveOutOpen" sptr, sptr, sptr, sptr, sptr, sptr
; waveOutOpen phwo, uDeviceID, varptr(pwfx), dwCallback, dwInstance, fdwOpen   ; 戻り値は stat
; phwo : HWAVEOUT* optional, out -> "sptr"
; uDeviceID : DWORD -> "sptr"
; pwfx : WAVEFORMATEX* -> "sptr"
; dwCallback : UINT_PTR optional -> "sptr"
; dwInstance : UINT_PTR optional -> "sptr"
; fdwOpen : MIDI_WAVE_OPEN_TYPE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINMM.dll"
#cfunc global waveOutOpen "waveOutOpen" sptr, int, var, sptr, sptr, int
; res = waveOutOpen(phwo, uDeviceID, pwfx, dwCallback, dwInstance, fdwOpen)
; phwo : HWAVEOUT* optional, out -> "sptr"
; uDeviceID : DWORD -> "int"
; pwfx : WAVEFORMATEX* -> "var"
; dwCallback : UINT_PTR optional -> "sptr"
; dwInstance : UINT_PTR optional -> "sptr"
; fdwOpen : MIDI_WAVE_OPEN_TYPE -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINMM.dll"
#cfunc global waveOutOpen "waveOutOpen" sptr, int, sptr, sptr, sptr, int
; res = waveOutOpen(phwo, uDeviceID, varptr(pwfx), dwCallback, dwInstance, fdwOpen)
; phwo : HWAVEOUT* optional, out -> "sptr"
; uDeviceID : DWORD -> "int"
; pwfx : WAVEFORMATEX* -> "sptr"
; dwCallback : UINT_PTR optional -> "sptr"
; dwInstance : UINT_PTR optional -> "sptr"
; fdwOpen : MIDI_WAVE_OPEN_TYPE -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。