Win32 API 日本語リファレンス
ホームMedia.Audio › midiStreamOpen

midiStreamOpen

関数
MIDIストリーム出力デバイスを開く。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD midiStreamOpen(
    HMIDISTRM* phms,
    DWORD* puDeviceID,
    DWORD cMidi,
    UINT_PTR dwCallback,   // optional
    UINT_PTR dwInstance,   // optional
    DWORD fdwOpen
);

パラメーター

名前方向説明
phmsHMIDISTRM*out関数が戻るときにストリームハンドルを格納する変数へのポインターです。
puDeviceIDDWORD*inoutデバイス識別子へのポインターです。デバイスはストリームのために開かれ、ストリームが閉じられるときに再び閉じられます。
cMidiDWORDin予約済みです。1 を指定する必要があります。
dwCallbackUINT_PTRinoptionalMIDI 再生中に呼び出され、再生の進行に関連するメッセージを処理する、コールバック関数へのポインター、イベントハンドル、スレッド識別子、またはウィンドウもしくはスレッドのハンドルです。コールバック機構が不要な場合は、このパラメーターに NULL を指定します。
dwInstanceUINT_PTRinoptionalアプリケーション固有のインスタンスデータで、コールバック関数が呼び出されるたびにアプリケーションへ返されます。
fdwOpenDWORDin

デバイスを開く際のコールバックフラグです。次のコールバックフラグのいずれかを指定する必要があります。

意味
CALLBACK_EVENT dwCallback パラメーターはイベントハンドルです。このコールバック機構は出力専用です。
CALLBACK_FUNCTION dwCallback パラメーターはコールバックプロシージャのアドレスです。コールバックのシグネチャについては、MidiOutProc を参照してください。
CALLBACK_NULL コールバック機構はありません。これが既定の設定です。
CALLBACK_THREAD dwCallback パラメーターはスレッド識別子です。
CALLBACK_WINDOW dwCallback パラメーターはウィンドウハンドルです。

戻り値の型: DWORD

公式ドキュメント

midiStreamOpen 関数は、出力用の MIDI ストリームを開きます。既定では、デバイスは一時停止モードで開かれます。この関数で取得したストリームハンドルは、それ以降のストリームへのすべての参照で使用する必要があります。

戻り値

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

戻り値 説明
MMSYSERR_BADDEVICEID
指定されたデバイス識別子が範囲外です。
MMSYSERR_INVALPARAM
指定されたハンドルまたはフラグのパラメーターが無効です。
MMSYSERR_NOMEM
システムがメモリの割り当てまたはロックを行えません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD midiStreamOpen(
    HMIDISTRM* phms,
    DWORD* puDeviceID,
    DWORD cMidi,
    UINT_PTR dwCallback,   // optional
    UINT_PTR dwInstance,   // optional
    DWORD fdwOpen
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint midiStreamOpen(
    IntPtr phms,   // HMIDISTRM* out
    ref uint puDeviceID,   // DWORD* in/out
    uint cMidi,   // DWORD
    UIntPtr dwCallback,   // UINT_PTR optional
    UIntPtr dwInstance,   // UINT_PTR optional
    uint fdwOpen   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function midiStreamOpen(
    phms As IntPtr,   ' HMIDISTRM* out
    ByRef puDeviceID As UInteger,   ' DWORD* in/out
    cMidi As UInteger,   ' DWORD
    dwCallback As UIntPtr,   ' UINT_PTR optional
    dwInstance As UIntPtr,   ' UINT_PTR optional
    fdwOpen As UInteger   ' DWORD
) As UInteger
End Function
' phms : HMIDISTRM* out
' puDeviceID : DWORD* in/out
' cMidi : DWORD
' dwCallback : UINT_PTR optional
' dwInstance : UINT_PTR optional
' fdwOpen : DWORD
Declare PtrSafe Function midiStreamOpen Lib "winmm" ( _
    ByVal phms As LongPtr, _
    ByRef puDeviceID As Long, _
    ByVal cMidi As Long, _
    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

midiStreamOpen = ctypes.windll.winmm.midiStreamOpen
midiStreamOpen.restype = wintypes.DWORD
midiStreamOpen.argtypes = [
    ctypes.c_void_p,  # phms : HMIDISTRM* out
    ctypes.POINTER(wintypes.DWORD),  # puDeviceID : DWORD* in/out
    wintypes.DWORD,  # cMidi : DWORD
    ctypes.c_size_t,  # dwCallback : UINT_PTR optional
    ctypes.c_size_t,  # dwInstance : UINT_PTR optional
    wintypes.DWORD,  # fdwOpen : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
midiStreamOpen = Fiddle::Function.new(
  lib['midiStreamOpen'],
  [
    Fiddle::TYPE_VOIDP,  # phms : HMIDISTRM* out
    Fiddle::TYPE_VOIDP,  # puDeviceID : DWORD* in/out
    -Fiddle::TYPE_INT,  # cMidi : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwCallback : UINT_PTR optional
    Fiddle::TYPE_UINTPTR_T,  # dwInstance : UINT_PTR optional
    -Fiddle::TYPE_INT,  # fdwOpen : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn midiStreamOpen(
        phms: *mut *mut core::ffi::c_void,  // HMIDISTRM* out
        puDeviceID: *mut u32,  // DWORD* in/out
        cMidi: u32,  // DWORD
        dwCallback: usize,  // UINT_PTR optional
        dwInstance: usize,  // UINT_PTR optional
        fdwOpen: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint midiStreamOpen(IntPtr phms, ref uint puDeviceID, uint cMidi, UIntPtr dwCallback, UIntPtr dwInstance, uint fdwOpen);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_midiStreamOpen' -Namespace Win32 -PassThru
# $api::midiStreamOpen(phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen)
#uselib "WINMM.dll"
#func global midiStreamOpen "midiStreamOpen" sptr, sptr, sptr, sptr, sptr, sptr
; midiStreamOpen phms, varptr(puDeviceID), cMidi, dwCallback, dwInstance, fdwOpen   ; 戻り値は stat
; phms : HMIDISTRM* out -> "sptr"
; puDeviceID : DWORD* in/out -> "sptr"
; cMidi : DWORD -> "sptr"
; dwCallback : UINT_PTR optional -> "sptr"
; dwInstance : UINT_PTR optional -> "sptr"
; fdwOpen : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINMM.dll"
#cfunc global midiStreamOpen "midiStreamOpen" sptr, var, int, sptr, sptr, int
; res = midiStreamOpen(phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen)
; phms : HMIDISTRM* out -> "sptr"
; puDeviceID : DWORD* in/out -> "var"
; cMidi : DWORD -> "int"
; dwCallback : UINT_PTR optional -> "sptr"
; dwInstance : UINT_PTR optional -> "sptr"
; fdwOpen : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD midiStreamOpen(HMIDISTRM* phms, DWORD* puDeviceID, DWORD cMidi, UINT_PTR dwCallback, UINT_PTR dwInstance, DWORD fdwOpen)
#uselib "WINMM.dll"
#cfunc global midiStreamOpen "midiStreamOpen" intptr, var, int, intptr, intptr, int
; res = midiStreamOpen(phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen)
; phms : HMIDISTRM* out -> "intptr"
; puDeviceID : DWORD* in/out -> "var"
; cMidi : DWORD -> "int"
; dwCallback : UINT_PTR optional -> "intptr"
; dwInstance : UINT_PTR optional -> "intptr"
; fdwOpen : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmidiStreamOpen = winmm.NewProc("midiStreamOpen")
)

// phms (HMIDISTRM* out), puDeviceID (DWORD* in/out), cMidi (DWORD), dwCallback (UINT_PTR optional), dwInstance (UINT_PTR optional), fdwOpen (DWORD)
r1, _, err := procmidiStreamOpen.Call(
	uintptr(phms),
	uintptr(puDeviceID),
	uintptr(cMidi),
	uintptr(dwCallback),
	uintptr(dwInstance),
	uintptr(fdwOpen),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function midiStreamOpen(
  phms: Pointer;   // HMIDISTRM* out
  puDeviceID: Pointer;   // DWORD* in/out
  cMidi: DWORD;   // DWORD
  dwCallback: NativeUInt;   // UINT_PTR optional
  dwInstance: NativeUInt;   // UINT_PTR optional
  fdwOpen: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'midiStreamOpen';
result := DllCall("WINMM\midiStreamOpen"
    , "Ptr", phms   ; HMIDISTRM* out
    , "Ptr", puDeviceID   ; DWORD* in/out
    , "UInt", cMidi   ; DWORD
    , "UPtr", dwCallback   ; UINT_PTR optional
    , "UPtr", dwInstance   ; UINT_PTR optional
    , "UInt", fdwOpen   ; DWORD
    , "UInt")   ; return: DWORD
●midiStreamOpen(phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen) = DLL("WINMM.dll", "dword midiStreamOpen(void*, void*, dword, int, int, dword)")
# 呼び出し: midiStreamOpen(phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen)
# phms : HMIDISTRM* out -> "void*"
# puDeviceID : DWORD* in/out -> "void*"
# cMidi : DWORD -> "dword"
# dwCallback : UINT_PTR optional -> "int"
# dwInstance : UINT_PTR optional -> "int"
# fdwOpen : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winmm" fn midiStreamOpen(
    phms: ?*anyopaque, // HMIDISTRM* out
    puDeviceID: [*c]u32, // DWORD* in/out
    cMidi: u32, // DWORD
    dwCallback: usize, // UINT_PTR optional
    dwInstance: usize, // UINT_PTR optional
    fdwOpen: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc midiStreamOpen(
    phms: pointer,  # HMIDISTRM* out
    puDeviceID: ptr uint32,  # DWORD* in/out
    cMidi: uint32,  # DWORD
    dwCallback: uint,  # UINT_PTR optional
    dwInstance: uint,  # UINT_PTR optional
    fdwOpen: uint32  # DWORD
): uint32 {.importc: "midiStreamOpen", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint midiStreamOpen(
    void* phms,   // HMIDISTRM* out
    uint* puDeviceID,   // DWORD* in/out
    uint cMidi,   // DWORD
    size_t dwCallback,   // UINT_PTR optional
    size_t dwInstance,   // UINT_PTR optional
    uint fdwOpen   // DWORD
);
ccall((:midiStreamOpen, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt32}, UInt32, Csize_t, Csize_t, UInt32),
      phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen)
# phms : HMIDISTRM* out -> Ptr{Cvoid}
# puDeviceID : DWORD* in/out -> Ptr{UInt32}
# cMidi : DWORD -> UInt32
# dwCallback : UINT_PTR optional -> Csize_t
# dwInstance : UINT_PTR optional -> Csize_t
# fdwOpen : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t midiStreamOpen(
    void* phms,
    uint32_t* puDeviceID,
    uint32_t cMidi,
    uintptr_t dwCallback,
    uintptr_t dwInstance,
    uint32_t fdwOpen);
]]
local winmm = ffi.load("winmm")
-- winmm.midiStreamOpen(phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen)
-- phms : HMIDISTRM* out
-- puDeviceID : DWORD* in/out
-- cMidi : DWORD
-- dwCallback : UINT_PTR optional
-- dwInstance : UINT_PTR optional
-- fdwOpen : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const midiStreamOpen = lib.func('__stdcall', 'midiStreamOpen', 'uint32_t', ['void *', 'uint32_t *', 'uint32_t', 'uintptr_t', 'uintptr_t', 'uint32_t']);
// midiStreamOpen(phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen)
// phms : HMIDISTRM* out -> 'void *'
// puDeviceID : DWORD* in/out -> 'uint32_t *'
// cMidi : DWORD -> 'uint32_t'
// dwCallback : UINT_PTR optional -> 'uintptr_t'
// dwInstance : UINT_PTR optional -> 'uintptr_t'
// fdwOpen : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  midiStreamOpen: { parameters: ["pointer", "pointer", "u32", "usize", "usize", "u32"], result: "u32" },
});
// lib.symbols.midiStreamOpen(phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen)
// phms : HMIDISTRM* out -> "pointer"
// puDeviceID : DWORD* in/out -> "pointer"
// cMidi : DWORD -> "u32"
// dwCallback : UINT_PTR optional -> "usize"
// dwInstance : UINT_PTR optional -> "usize"
// fdwOpen : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t midiStreamOpen(
    void* phms,
    uint32_t* puDeviceID,
    uint32_t cMidi,
    size_t dwCallback,
    size_t dwInstance,
    uint32_t fdwOpen);
C, "WINMM.dll");
// $ffi->midiStreamOpen(phms, puDeviceID, cMidi, dwCallback, dwInstance, fdwOpen);
// phms : HMIDISTRM* out
// puDeviceID : DWORD* in/out
// cMidi : DWORD
// dwCallback : UINT_PTR optional
// dwInstance : UINT_PTR optional
// fdwOpen : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Winmm extends StdCallLibrary {
    Winmm INSTANCE = Native.load("winmm", Winmm.class);
    int midiStreamOpen(
        Pointer phms,   // HMIDISTRM* out
        IntByReference puDeviceID,   // DWORD* in/out
        int cMidi,   // DWORD
        long dwCallback,   // UINT_PTR optional
        long dwInstance,   // UINT_PTR optional
        int fdwOpen   // DWORD
    );
}
@[Link("winmm")]
lib LibWINMM
  fun midiStreamOpen = midiStreamOpen(
    phms : Void*,   # HMIDISTRM* out
    puDeviceID : UInt32*,   # DWORD* in/out
    cMidi : UInt32,   # DWORD
    dwCallback : LibC::SizeT,   # UINT_PTR optional
    dwInstance : LibC::SizeT,   # UINT_PTR optional
    fdwOpen : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef midiStreamOpenNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Uint32, UintPtr, UintPtr, Uint32);
typedef midiStreamOpenDart = int Function(Pointer<Void>, Pointer<Uint32>, int, int, int, int);
final midiStreamOpen = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<midiStreamOpenNative, midiStreamOpenDart>('midiStreamOpen');
// phms : HMIDISTRM* out -> Pointer<Void>
// puDeviceID : DWORD* in/out -> Pointer<Uint32>
// cMidi : DWORD -> Uint32
// dwCallback : UINT_PTR optional -> UintPtr
// dwInstance : UINT_PTR optional -> UintPtr
// fdwOpen : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function midiStreamOpen(
  phms: Pointer;   // HMIDISTRM* out
  puDeviceID: Pointer;   // DWORD* in/out
  cMidi: DWORD;   // DWORD
  dwCallback: NativeUInt;   // UINT_PTR optional
  dwInstance: NativeUInt;   // UINT_PTR optional
  fdwOpen: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'midiStreamOpen';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "midiStreamOpen"
  c_midiStreamOpen :: Ptr () -> Ptr Word32 -> Word32 -> CUIntPtr -> CUIntPtr -> Word32 -> IO Word32
-- phms : HMIDISTRM* out -> Ptr ()
-- puDeviceID : DWORD* in/out -> Ptr Word32
-- cMidi : DWORD -> Word32
-- dwCallback : UINT_PTR optional -> CUIntPtr
-- dwInstance : UINT_PTR optional -> CUIntPtr
-- fdwOpen : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let midistreamopen =
  foreign "midiStreamOpen"
    ((ptr void) @-> (ptr uint32_t) @-> uint32_t @-> size_t @-> size_t @-> uint32_t @-> returning uint32_t)
(* phms : HMIDISTRM* out -> (ptr void) *)
(* puDeviceID : DWORD* in/out -> (ptr uint32_t) *)
(* cMidi : DWORD -> uint32_t *)
(* dwCallback : UINT_PTR optional -> size_t *)
(* dwInstance : UINT_PTR optional -> size_t *)
(* fdwOpen : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("midiStreamOpen" midi-stream-open :convention :stdcall) :uint32
  (phms :pointer)   ; HMIDISTRM* out
  (pu-device-id :pointer)   ; DWORD* in/out
  (c-midi :uint32)   ; DWORD
  (dw-callback :uint64)   ; UINT_PTR optional
  (dw-instance :uint64)   ; UINT_PTR optional
  (fdw-open :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $midiStreamOpen = Win32::API::More->new('WINMM',
    'DWORD midiStreamOpen(HANDLE phms, LPVOID puDeviceID, DWORD cMidi, WPARAM dwCallback, WPARAM dwInstance, DWORD fdwOpen)');
# my $ret = $midiStreamOpen->Call($phms, $puDeviceID, $cMidi, $dwCallback, $dwInstance, $fdwOpen);
# phms : HMIDISTRM* out -> HANDLE
# puDeviceID : DWORD* in/out -> LPVOID
# cMidi : DWORD -> DWORD
# dwCallback : UINT_PTR optional -> WPARAM
# dwInstance : UINT_PTR optional -> WPARAM
# fdwOpen : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。