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

midiOutCachePatches

関数
MIDI出力デバイスに指定パッチをキャッシュする。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD midiOutCachePatches(
    HMIDIOUT hmo,
    DWORD uBank,
    WORD* pwpa,
    DWORD fuCache
);

パラメーター

名前方向説明
hmoHMIDIOUTinオープン済みの MIDI 出力デバイスへのハンドル。このデバイスは内部 MIDI シンセサイザーである必要があります。このパラメーターには、HMIDIOUT にキャストした MIDI ストリームのハンドルを指定することもできます。
uBankDWORDin使用するパッチのバンク。既定のパッチバンクをキャッシュするには、このパラメーターをゼロに設定します。
pwpaWORD*inキャッシュまたはキャッシュ解除するパッチを示す PATCHARRAY 配列へのポインター。
fuCacheDWORDin

キャッシュ操作のオプション。次のいずれかのフラグを指定できます。

意味
MIDI_CACHE_ALL 指定したすべてのパッチをキャッシュします。すべてをキャッシュできない場合は、いずれもキャッシュせず、PATCHARRAY 配列をクリアして MMSYSERR_NOMEM を返します。
MIDI_CACHE_BESTFIT 指定したすべてのパッチをキャッシュします。すべてをキャッシュできない場合は、可能な限り多くのパッチをキャッシュし、どのパッチがキャッシュされたかを反映するように PATCHARRAY 配列を変更して、MMSYSERR_NOMEM を返します。
MIDI_CACHE_QUERY 現在どのパッチがキャッシュされているかを示すように PATCHARRAY 配列を変更します。
MIDI_UNCACHE 指定したパッチのキャッシュを解除し、PATCHARRAY 配列をクリアします。

戻り値の型: DWORD

公式ドキュメント

midiOutCachePatches 関数は、内部 MIDI シンセサイザーデバイスに対して、指定した一連のパッチを事前に読み込んでキャッシュするよう要求します。

戻り値

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

戻り値 説明
MMSYSERR_INVALFLAG
wFlags で指定されたフラグが無効です。
MMSYSERR_INVALHANDLE
指定されたデバイスハンドルが無効です。
MMSYSERR_INVALPARAM
lpPatchArray が指す配列が無効です。
MMSYSERR_NOMEM
デバイスに、要求されたすべてのパッチをキャッシュするだけの十分なメモリがありません。
MMSYSERR_NOTSUPPORTED
指定されたデバイスはパッチのキャッシュをサポートしていません。

解説(Remarks)

一部のシンセサイザーは、すべてのパッチを同時に読み込んだ状態に保つことができず、MIDI プログラムチェンジメッセージを受信したときにディスクからデータを読み込む必要があります。パッチをキャッシュすることで、指定したパッチが即座に利用可能になります。

PATCHARRAY 配列の各要素は 128 個のパッチのうちの 1 つを表し、その特定のパッチを使用する 16 個の MIDI チャネルそれぞれに対応するビットが設定されます。最下位ビットが物理チャネル 0 を、最上位ビットが物理チャネル 15 (0x0F) を表します。たとえば、パッチ 0 が物理チャネル 0 と 8 で使用される場合、要素 0 は 0x0101 に設定されます。

この関数は内部 MIDI シンセサイザーデバイスにのみ適用されます。すべての内部シンセサイザーがパッチのキャッシュをサポートしているわけではありません。デバイスがパッチのキャッシュをサポートしているかどうかを確認するには、MIDICAPS_CACHE フラグを使用して、midiOutGetDevCaps 関数によって設定される MIDIOUTCAPS 構造体の dwSupport メンバーをテストします。

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

各言語での呼び出し定義

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

DWORD midiOutCachePatches(
    HMIDIOUT hmo,
    DWORD uBank,
    WORD* pwpa,
    DWORD fuCache
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint midiOutCachePatches(
    IntPtr hmo,   // HMIDIOUT
    uint uBank,   // DWORD
    ref ushort pwpa,   // WORD*
    uint fuCache   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function midiOutCachePatches(
    hmo As IntPtr,   ' HMIDIOUT
    uBank As UInteger,   ' DWORD
    ByRef pwpa As UShort,   ' WORD*
    fuCache As UInteger   ' DWORD
) As UInteger
End Function
' hmo : HMIDIOUT
' uBank : DWORD
' pwpa : WORD*
' fuCache : DWORD
Declare PtrSafe Function midiOutCachePatches Lib "winmm" ( _
    ByVal hmo As LongPtr, _
    ByVal uBank As Long, _
    ByRef pwpa As Integer, _
    ByVal fuCache As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

midiOutCachePatches = ctypes.windll.winmm.midiOutCachePatches
midiOutCachePatches.restype = wintypes.DWORD
midiOutCachePatches.argtypes = [
    wintypes.HANDLE,  # hmo : HMIDIOUT
    wintypes.DWORD,  # uBank : DWORD
    ctypes.POINTER(ctypes.c_ushort),  # pwpa : WORD*
    wintypes.DWORD,  # fuCache : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmidiOutCachePatches = winmm.NewProc("midiOutCachePatches")
)

// hmo (HMIDIOUT), uBank (DWORD), pwpa (WORD*), fuCache (DWORD)
r1, _, err := procmidiOutCachePatches.Call(
	uintptr(hmo),
	uintptr(uBank),
	uintptr(pwpa),
	uintptr(fuCache),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function midiOutCachePatches(
  hmo: THandle;   // HMIDIOUT
  uBank: DWORD;   // DWORD
  pwpa: Pointer;   // WORD*
  fuCache: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'midiOutCachePatches';
result := DllCall("WINMM\midiOutCachePatches"
    , "Ptr", hmo   ; HMIDIOUT
    , "UInt", uBank   ; DWORD
    , "Ptr", pwpa   ; WORD*
    , "UInt", fuCache   ; DWORD
    , "UInt")   ; return: DWORD
●midiOutCachePatches(hmo, uBank, pwpa, fuCache) = DLL("WINMM.dll", "dword midiOutCachePatches(void*, dword, void*, dword)")
# 呼び出し: midiOutCachePatches(hmo, uBank, pwpa, fuCache)
# hmo : HMIDIOUT -> "void*"
# uBank : DWORD -> "dword"
# pwpa : WORD* -> "void*"
# fuCache : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winmm" fn midiOutCachePatches(
    hmo: ?*anyopaque, // HMIDIOUT
    uBank: u32, // DWORD
    pwpa: [*c]u16, // WORD*
    fuCache: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc midiOutCachePatches(
    hmo: pointer,  # HMIDIOUT
    uBank: uint32,  # DWORD
    pwpa: ptr uint16,  # WORD*
    fuCache: uint32  # DWORD
): uint32 {.importc: "midiOutCachePatches", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint midiOutCachePatches(
    void* hmo,   // HMIDIOUT
    uint uBank,   // DWORD
    ushort* pwpa,   // WORD*
    uint fuCache   // DWORD
);
ccall((:midiOutCachePatches, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, Ptr{UInt16}, UInt32),
      hmo, uBank, pwpa, fuCache)
# hmo : HMIDIOUT -> Ptr{Cvoid}
# uBank : DWORD -> UInt32
# pwpa : WORD* -> Ptr{UInt16}
# fuCache : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t midiOutCachePatches(
    void* hmo,
    uint32_t uBank,
    uint16_t* pwpa,
    uint32_t fuCache);
]]
local winmm = ffi.load("winmm")
-- winmm.midiOutCachePatches(hmo, uBank, pwpa, fuCache)
-- hmo : HMIDIOUT
-- uBank : DWORD
-- pwpa : WORD*
-- fuCache : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const midiOutCachePatches = lib.func('__stdcall', 'midiOutCachePatches', 'uint32_t', ['void *', 'uint32_t', 'uint16_t *', 'uint32_t']);
// midiOutCachePatches(hmo, uBank, pwpa, fuCache)
// hmo : HMIDIOUT -> 'void *'
// uBank : DWORD -> 'uint32_t'
// pwpa : WORD* -> 'uint16_t *'
// fuCache : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  midiOutCachePatches: { parameters: ["pointer", "u32", "pointer", "u32"], result: "u32" },
});
// lib.symbols.midiOutCachePatches(hmo, uBank, pwpa, fuCache)
// hmo : HMIDIOUT -> "pointer"
// uBank : DWORD -> "u32"
// pwpa : WORD* -> "pointer"
// fuCache : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t midiOutCachePatches(
    void* hmo,
    uint32_t uBank,
    uint16_t* pwpa,
    uint32_t fuCache);
C, "WINMM.dll");
// $ffi->midiOutCachePatches(hmo, uBank, pwpa, fuCache);
// hmo : HMIDIOUT
// uBank : DWORD
// pwpa : WORD*
// fuCache : 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 midiOutCachePatches(
        Pointer hmo,   // HMIDIOUT
        int uBank,   // DWORD
        ShortByReference pwpa,   // WORD*
        int fuCache   // DWORD
    );
}
@[Link("winmm")]
lib LibWINMM
  fun midiOutCachePatches = midiOutCachePatches(
    hmo : Void*,   # HMIDIOUT
    uBank : UInt32,   # DWORD
    pwpa : UInt16*,   # WORD*
    fuCache : 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 midiOutCachePatchesNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Uint16>, Uint32);
typedef midiOutCachePatchesDart = int Function(Pointer<Void>, int, Pointer<Uint16>, int);
final midiOutCachePatches = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<midiOutCachePatchesNative, midiOutCachePatchesDart>('midiOutCachePatches');
// hmo : HMIDIOUT -> Pointer<Void>
// uBank : DWORD -> Uint32
// pwpa : WORD* -> Pointer<Uint16>
// fuCache : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function midiOutCachePatches(
  hmo: THandle;   // HMIDIOUT
  uBank: DWORD;   // DWORD
  pwpa: Pointer;   // WORD*
  fuCache: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'midiOutCachePatches';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "midiOutCachePatches"
  c_midiOutCachePatches :: Ptr () -> Word32 -> Ptr Word16 -> Word32 -> IO Word32
-- hmo : HMIDIOUT -> Ptr ()
-- uBank : DWORD -> Word32
-- pwpa : WORD* -> Ptr Word16
-- fuCache : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let midioutcachepatches =
  foreign "midiOutCachePatches"
    ((ptr void) @-> uint32_t @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* hmo : HMIDIOUT -> (ptr void) *)
(* uBank : DWORD -> uint32_t *)
(* pwpa : WORD* -> (ptr uint16_t) *)
(* fuCache : 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 ("midiOutCachePatches" midi-out-cache-patches :convention :stdcall) :uint32
  (hmo :pointer)   ; HMIDIOUT
  (u-bank :uint32)   ; DWORD
  (pwpa :pointer)   ; WORD*
  (fu-cache :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $midiOutCachePatches = Win32::API::More->new('WINMM',
    'DWORD midiOutCachePatches(HANDLE hmo, DWORD uBank, LPVOID pwpa, DWORD fuCache)');
# my $ret = $midiOutCachePatches->Call($hmo, $uBank, $pwpa, $fuCache);
# hmo : HMIDIOUT -> HANDLE
# uBank : DWORD -> DWORD
# pwpa : WORD* -> LPVOID
# fuCache : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。