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

waveOutSetPitch

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

シグネチャ

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

DWORD waveOutSetPitch(
    HWAVEOUT hwo,
    DWORD dwPitch
);

パラメーター

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

新しいピッチ倍率の設定値。この設定は、元のオーサリング設定からの現在のピッチ変化を示します。ピッチ倍率は正の値でなければなりません。

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

戻り値の型: DWORD

公式ドキュメント

waveOutSetPitch 関数は、指定した波形オーディオ出力デバイスのピッチを設定します。

戻り値

成功した場合は 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 waveOutSetPitch(
    HWAVEOUT hwo,
    DWORD dwPitch
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint waveOutSetPitch(
    IntPtr hwo,   // HWAVEOUT
    uint dwPitch   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function waveOutSetPitch(
    hwo As IntPtr,   ' HWAVEOUT
    dwPitch As UInteger   ' DWORD
) As UInteger
End Function
' hwo : HWAVEOUT
' dwPitch : DWORD
Declare PtrSafe Function waveOutSetPitch Lib "winmm" ( _
    ByVal hwo As LongPtr, _
    ByVal dwPitch As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

waveOutSetPitch = ctypes.windll.winmm.waveOutSetPitch
waveOutSetPitch.restype = wintypes.DWORD
waveOutSetPitch.argtypes = [
    wintypes.HANDLE,  # hwo : HWAVEOUT
    wintypes.DWORD,  # dwPitch : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
waveOutSetPitch = Fiddle::Function.new(
  lib['waveOutSetPitch'],
  [
    Fiddle::TYPE_VOIDP,  # hwo : HWAVEOUT
    -Fiddle::TYPE_INT,  # dwPitch : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn waveOutSetPitch(
        hwo: *mut core::ffi::c_void,  // HWAVEOUT
        dwPitch: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint waveOutSetPitch(IntPtr hwo, uint dwPitch);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_waveOutSetPitch' -Namespace Win32 -PassThru
# $api::waveOutSetPitch(hwo, dwPitch)
#uselib "WINMM.dll"
#func global waveOutSetPitch "waveOutSetPitch" sptr, sptr
; waveOutSetPitch hwo, dwPitch   ; 戻り値は stat
; hwo : HWAVEOUT -> "sptr"
; dwPitch : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINMM.dll"
#cfunc global waveOutSetPitch "waveOutSetPitch" sptr, int
; res = waveOutSetPitch(hwo, dwPitch)
; hwo : HWAVEOUT -> "sptr"
; dwPitch : DWORD -> "int"
; DWORD waveOutSetPitch(HWAVEOUT hwo, DWORD dwPitch)
#uselib "WINMM.dll"
#cfunc global waveOutSetPitch "waveOutSetPitch" intptr, int
; res = waveOutSetPitch(hwo, dwPitch)
; hwo : HWAVEOUT -> "intptr"
; dwPitch : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procwaveOutSetPitch = winmm.NewProc("waveOutSetPitch")
)

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

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

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

let waveoutsetpitch =
  foreign "waveOutSetPitch"
    ((ptr void) @-> uint32_t @-> returning uint32_t)
(* hwo : HWAVEOUT -> (ptr void) *)
(* dwPitch : 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 ("waveOutSetPitch" wave-out-set-pitch :convention :stdcall) :uint32
  (hwo :pointer)   ; HWAVEOUT
  (dw-pitch :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $waveOutSetPitch = Win32::API::More->new('WINMM',
    'DWORD waveOutSetPitch(HANDLE hwo, DWORD dwPitch)');
# my $ret = $waveOutSetPitch->Call($hwo, $dwPitch);
# hwo : HWAVEOUT -> HANDLE
# dwPitch : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。