ホーム › Media.Audio.XAudio2 › XAUDIO2_FILTER_PARAMETERS

XAUDIO2_FILTER_PARAMETERS

構造体

サイズx64: 12 バイト / x86: 12 バイトパッキング1

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド	型	サイズ	x64	x86	説明
Type	XAUDIO2_FILTER_TYPE	4	+0	+0	XAUDIO2_FILTER_TYPE です。
Frequency	FLOAT	4	+4	+4	フィルターのラジアン周波数で、(2 * sin(pi * (目的のフィルターカットオフ周波数) / sampleRate)) として計算されます。この周波数は 0 以上 XAUDIO2_MAX_FILTER_FREQUENCY 以下でなければなりません。許容される最大周波数は、ソースサウンドのサンプルレートを 6 で除算した値であり、これは最大のフィルターラジアン周波数である 1 に対応します。たとえば、サウンドのサンプルレートが 48000 で、目的のカットオフ周波数がそのサンプルレートで許容される最大値である 8000 の場合、Frequency の値は 1 になります。 XAUDIO2_HELPER_FUNCTIONS が定義されている場合、XAudio2.h には、ヘルツとラジアン周波数を相互に変換するためのヘルパー関数 XAudio2RadiansToCutoffFrequency および XAudio2CutoffFrequencyToRadians が含まれます。また、XAUDIO2_HELPER_FUNCTIONS を定義すると、LowPassOnePoleFilter および HighPassOnePoleFilter で使用するのに適した 1 極係数 (one-pole coefficient) とヘルツとを相互に変換するための XAudio2CutoffFrequencyToOnePoleCoefficient も含まれます。
OneOverQ	FLOAT	4	+8	+8	Q 値の逆数です。Frequency を超える周波数がどれだけ速く減衰するかを制御します。値が大きいほど減衰が速くなり、値が小さいほど減衰は緩やかになります。0 より大きく、XAUDIO2_MAX_FILTER_ONEOVERQ 以下でなければなりません。

公式ドキュメント

ソースボイスのフィルターパラメーターを定義します。

解説(Remarks)

XAUDIO2_FILTER_PARAMETERS に次の値を設定すると、音響的にはフィルターを完全にバイパスした場合と同等になります。

XAUDIO2_FILTER_PARAMETERS FilterParams;
FilterParams.Frequency = 1.0f;    
FilterParams.OneOverQ = 1.0f;
FilterParams.Type = LowPassFilter;

次の式は、XAUDIO2_FILTER_PARAMETERS のメンバーとボイスごとのフィルターとの関係を示しています。

Yl( n ) = F1 yb( n ) + yl( n - 1 )
Yb( n ) = F1 yh( n ) + yb( n - 1 )
Yh( n ) = x( n ) - yl( n ) - OneOverQ(yb( n - 1 )
Yn( n ) = Yl(n) + Yh(n)

ここで、各記号の意味は次のとおりです。

Yl = lowpass output
Yb = bandpass output
Yh = highpass output
Yn = notch output
F1 = XAUDIO2_FILTER_PARAMETERS.Frequency
OneOverQ = XAUDIO2_FILTER_PARAMETERS.OneOverQ

プラットフォーム要件

Windows 10 (XAudio2.9); Windows 8、Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

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

各言語での定義

#include <windows.h>

// XAUDIO2_FILTER_PARAMETERS  (x64 12 / x86 12 バイト)
#pragma pack(push, 1)
typedef struct XAUDIO2_FILTER_PARAMETERS {
    XAUDIO2_FILTER_TYPE Type;
    FLOAT Frequency;
    FLOAT OneOverQ;
} XAUDIO2_FILTER_PARAMETERS;
#pragma pack(pop)

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct XAUDIO2_FILTER_PARAMETERS
{
    public int Type;
    public float Frequency;
    public float OneOverQ;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure XAUDIO2_FILTER_PARAMETERS
    Public Type As Integer
    Public Frequency As Single
    Public OneOverQ As Single
End Structure

import ctypes
from ctypes import wintypes

class XAUDIO2_FILTER_PARAMETERS(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("Type", ctypes.c_int),
        ("Frequency", ctypes.c_float),
        ("OneOverQ", ctypes.c_float),
    ]

#[repr(C, packed(1))]
pub struct XAUDIO2_FILTER_PARAMETERS {
    pub Type: i32,
    pub Frequency: f32,
    pub OneOverQ: f32,
}

import "golang.org/x/sys/windows"

type XAUDIO2_FILTER_PARAMETERS struct {
	Type int32
	Frequency float32
	OneOverQ float32
}

type
  XAUDIO2_FILTER_PARAMETERS = packed record
    Type: Integer;
    Frequency: Single;
    OneOverQ: Single;
  end;

const XAUDIO2_FILTER_PARAMETERS = extern struct {
    Type: i32,
    Frequency: f32,
    OneOverQ: f32,
};

type
  XAUDIO2_FILTER_PARAMETERS {.packed.} = object
    Type: int32
    Frequency: float32
    OneOverQ: float32

align(1)
struct XAUDIO2_FILTER_PARAMETERS
{
    int Type;
    float Frequency;
    float OneOverQ;
}

HSP用定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; XAUDIO2_FILTER_PARAMETERS サイズ: 12 バイト(x64)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; Type : XAUDIO2_FILTER_TYPE (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Frequency : FLOAT (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; OneOverQ : FLOAT (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global XAUDIO2_FILTER_PARAMETERS, pack=1
    #field int Type
    #field float Frequency
    #field float OneOverQ
#endstruct

stdim st, XAUDIO2_FILTER_PARAMETERS        ; NSTRUCT 変数を確保
st->Type = 100
mes "Type=" + st->Type