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

waveOutGetPitch

関数
波形出力デバイスの現在のピッチ設定を取得する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD waveOutGetPitch(
    HWAVEOUT hwo,
    DWORD* pdwPitch
);

パラメーター

名前方向説明
hwoHWAVEOUTin波形オーディオ出力デバイスのハンドル。
pdwPitchDWORD*out

現在のピッチ倍率設定を格納する変数へのポインター。ピッチ倍率は、元のオーサリング設定からの現在のピッチの変化を示します。ピッチ倍率は正の値でなければなりません。

ピッチ倍率は固定小数点値として指定されます。変数の上位ワードには数値の符号付き整数部分が、下位ワードには小数部分が格納されます。下位ワードの値 0x8000 は 1/2 を、0x4000 は 1/4 を表します。たとえば、値 0x00010000 は倍率 1.0(ピッチ変化なし)を指定し、値 0x000F8000 は倍率 15.5 を指定します。

戻り値の型: DWORD

公式ドキュメント

waveOutGetPitch 関数は、指定された波形オーディオ出力デバイスの現在のピッチ設定を取得します。

戻り値

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

戻り値 説明
MMSYSERR_INVALHANDLE
指定されたデバイスハンドルが無効です。
MMSYSERR_NODRIVER
デバイスドライバーが存在しません。
MMSYSERR_NOMEM
メモリの割り当てまたはロックができません。
MMSYSERR_NOTSUPPORTED
関数がサポートされていません。

解説(Remarks)

ピッチを変更しても、再生レート、サンプルレート、再生時間は変化しません。すべてのデバイスがピッチ変更をサポートしているわけではありません。デバイスがピッチ制御をサポートしているかどうかを判断するには、WAVECAPS_PITCH フラグを使用して、WAVEOUTCAPS 構造体(waveOutGetDevCaps 関数によって設定される)の 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 waveOutGetPitch(
    HWAVEOUT hwo,
    DWORD* pdwPitch
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint waveOutGetPitch(
    IntPtr hwo,   // HWAVEOUT
    out uint pdwPitch   // DWORD* out
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function waveOutGetPitch(
    hwo As IntPtr,   ' HWAVEOUT
    <Out> ByRef pdwPitch As UInteger   ' DWORD* out
) As UInteger
End Function
' hwo : HWAVEOUT
' pdwPitch : DWORD* out
Declare PtrSafe Function waveOutGetPitch Lib "winmm" ( _
    ByVal hwo As LongPtr, _
    ByRef pdwPitch As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

waveOutGetPitch = ctypes.windll.winmm.waveOutGetPitch
waveOutGetPitch.restype = wintypes.DWORD
waveOutGetPitch.argtypes = [
    wintypes.HANDLE,  # hwo : HWAVEOUT
    ctypes.POINTER(wintypes.DWORD),  # pdwPitch : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procwaveOutGetPitch = winmm.NewProc("waveOutGetPitch")
)

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

extern "winmm" fn waveOutGetPitch(
    hwo: ?*anyopaque, // HWAVEOUT
    pdwPitch: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc waveOutGetPitch(
    hwo: pointer,  # HWAVEOUT
    pdwPitch: ptr uint32  # DWORD* out
): uint32 {.importc: "waveOutGetPitch", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint waveOutGetPitch(
    void* hwo,   // HWAVEOUT
    uint* pdwPitch   // DWORD* out
);
ccall((:waveOutGetPitch, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt32}),
      hwo, pdwPitch)
# hwo : HWAVEOUT -> Ptr{Cvoid}
# pdwPitch : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t waveOutGetPitch(
    void* hwo,
    uint32_t* pdwPitch);
]]
local winmm = ffi.load("winmm")
-- winmm.waveOutGetPitch(hwo, pdwPitch)
-- hwo : HWAVEOUT
-- pdwPitch : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const waveOutGetPitch = lib.func('__stdcall', 'waveOutGetPitch', 'uint32_t', ['void *', 'uint32_t *']);
// waveOutGetPitch(hwo, pdwPitch)
// hwo : HWAVEOUT -> 'void *'
// pdwPitch : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  waveOutGetPitch: { parameters: ["pointer", "pointer"], result: "u32" },
});
// lib.symbols.waveOutGetPitch(hwo, pdwPitch)
// hwo : HWAVEOUT -> "pointer"
// pdwPitch : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t waveOutGetPitch(
    void* hwo,
    uint32_t* pdwPitch);
C, "WINMM.dll");
// $ffi->waveOutGetPitch(hwo, pdwPitch);
// hwo : HWAVEOUT
// pdwPitch : DWORD* out
// 構造体/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 waveOutGetPitch(
        Pointer hwo,   // HWAVEOUT
        IntByReference pdwPitch   // DWORD* out
    );
}
@[Link("winmm")]
lib LibWINMM
  fun waveOutGetPitch = waveOutGetPitch(
    hwo : Void*,   # HWAVEOUT
    pdwPitch : UInt32*   # DWORD* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef waveOutGetPitchNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>);
typedef waveOutGetPitchDart = int Function(Pointer<Void>, Pointer<Uint32>);
final waveOutGetPitch = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<waveOutGetPitchNative, waveOutGetPitchDart>('waveOutGetPitch');
// hwo : HWAVEOUT -> Pointer<Void>
// pdwPitch : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function waveOutGetPitch(
  hwo: THandle;   // HWAVEOUT
  pdwPitch: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'WINMM.dll' name 'waveOutGetPitch';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "waveOutGetPitch"
  c_waveOutGetPitch :: Ptr () -> Ptr Word32 -> IO Word32
-- hwo : HWAVEOUT -> Ptr ()
-- pdwPitch : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let waveoutgetpitch =
  foreign "waveOutGetPitch"
    ((ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* hwo : HWAVEOUT -> (ptr void) *)
(* pdwPitch : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("waveOutGetPitch" wave-out-get-pitch :convention :stdcall) :uint32
  (hwo :pointer)   ; HWAVEOUT
  (pdw-pitch :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $waveOutGetPitch = Win32::API::More->new('WINMM',
    'DWORD waveOutGetPitch(HANDLE hwo, LPVOID pdwPitch)');
# my $ret = $waveOutGetPitch->Call($hwo, $pdwPitch);
# hwo : HWAVEOUT -> HANDLE
# pdwPitch : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。