|
@@ -1,7 +1,7 @@
|
|
|
#+build windows
|
|
|
|
|
|
/* NOTES:
|
|
|
- 1. Definition of terms:
|
|
|
+ 1. Definition of terms:
|
|
|
LFE: Low Frequency Effect -- always omnidirectional.
|
|
|
LPF: Low Pass Filter, divided into two classifications:
|
|
|
Direct -- Applied to the direct signal path,
|
|
@@ -9,7 +9,7 @@
|
|
|
Reverb -- Applied to the reverb signal path,
|
|
|
used for occlusion effects only.
|
|
|
|
|
|
- 2. Volume level is expressed as a linear amplitude scaler:
|
|
|
+ 2. Volume level is expressed as a linear amplitude scaler:
|
|
|
1.0f represents no attenuation applied to the original signal,
|
|
|
0.5f denotes an attenuation of 6dB, and 0.0f results in silence.
|
|
|
Amplification (volume > 1.0f) is also allowed, and is not clamped.
|
|
@@ -17,7 +17,7 @@
|
|
|
LPF values range from 1.0f representing all frequencies pass through,
|
|
|
to 0.0f which results in silence as all frequencies are filtered out.
|
|
|
|
|
|
- 3. X3DAudio uses a left-handed Cartesian coordinate system with values
|
|
|
+ 3. X3DAudio uses a left-handed Cartesian coordinate system with values
|
|
|
on the x-axis increasing from left to right, on the y-axis from
|
|
|
bottom to top, and on the z-axis from near to far.
|
|
|
Azimuths are measured clockwise from a given reference direction.
|
|
@@ -29,7 +29,7 @@
|
|
|
Metric constants are supplied only as a convenience.
|
|
|
Distance is calculated using the Euclidean norm formula.
|
|
|
|
|
|
- 4. Only real values are permissible with functions using 32-bit
|
|
|
+ 4. Only real values are permissible with functions using 32-bit
|
|
|
float parameters -- NAN and infinite values are not accepted.
|
|
|
All computation occurs in 32-bit precision mode. */
|
|
|
|
|
@@ -100,7 +100,7 @@ CALCULATE_FLAG :: enum u32 {
|
|
|
}
|
|
|
|
|
|
//--------------<D-A-T-A---T-Y-P-E-S>---------------------------------------//
|
|
|
-VECTOR :: distinct [3]f32 // float 3D vector
|
|
|
+VECTOR :: [3]f32 // float 3D vector
|
|
|
|
|
|
// instance handle of precalculated constants
|
|
|
HANDLE :: distinct [HANDLE_BYTESIZE]byte
|
|
@@ -123,22 +123,22 @@ DISTANCE_CURVE_POINT :: struct #packed {
|
|
|
// pPoints[k-1].DSPSetting + ((pPoints[k].DSPSetting-pPoints[k-1].DSPSetting) / (pPoints[k].Distance-pPoints[k-1].Distance)) * (pPoints[k].Distance-pPoints[k-1].Distance) != NAN or infinite values
|
|
|
// For all points in the distance curve where 1 <= k < PointCount.
|
|
|
DISTANCE_CURVE :: struct #packed {
|
|
|
- pPoints: [^]DISTANCE_CURVE_POINT, // distance curve point array, must have at least PointCount elements with no duplicates and be sorted in ascending order with respect to Distance
|
|
|
- PointCount: u32, // number of distance curve points, must be >= 2 as all distance curves must have at least two endpoints, defining DSP settings at 0.0f and 1.0f normalized distance
|
|
|
+ pPoints: [^]DISTANCE_CURVE_POINT `fmt:"v,PointCount"`, // distance curve point array, must have at least PointCount elements with no duplicates and be sorted in ascending order with respect to Distance
|
|
|
+ PointCount: u32, // number of distance curve points, must be >= 2 as all distance curves must have at least two endpoints, defining DSP settings at 0.0f and 1.0f normalized distance
|
|
|
}
|
|
|
Default_LinearCurvePoints := [2]DISTANCE_CURVE_POINT{{0.0, 1.0}, {1.0, 0.0}}
|
|
|
Default_LinearCurve := DISTANCE_CURVE{&Default_LinearCurvePoints[0], 2}
|
|
|
|
|
|
CONE :: struct #packed {
|
|
|
- InnerAngle: f32, // inner cone angle in radians, must be within [0.0f, TAU]
|
|
|
- OuterAngle: f32, // outer cone angle in radians, must be within [InnerAngle, TAU]
|
|
|
-
|
|
|
- InnerVolume: f32, // volume level scaler on/within inner cone, used only for matrix calculations, must be within [0.0f, 2.0f] when used
|
|
|
- OuterVolume: f32, // volume level scaler on/beyond outer cone, used only for matrix calculations, must be within [0.0f, 2.0f] when used
|
|
|
- InnerLPF: f32, // LPF (both direct and reverb paths) coefficient subtrahend on/within inner cone, used only for LPF (both direct and reverb paths) calculations, must be within [0.0f, 1.0f] when used
|
|
|
- OuterLPF: f32, // LPF (both direct and reverb paths) coefficient subtrahend on/beyond outer cone, used only for LPF (both direct and reverb paths) calculations, must be within [0.0f, 1.0f] when used
|
|
|
- InnerReverb: f32, // reverb send level scaler on/within inner cone, used only for reverb calculations, must be within [0.0f, 2.0f] when used
|
|
|
- OuterReverb: f32, // reverb send level scaler on/beyond outer cone, used only for reverb calculations, must be within [0.0f, 2.0f] when used
|
|
|
+ InnerAngle: f32, // inner cone angle in radians, must be within [0.0f, TAU]
|
|
|
+ OuterAngle: f32, // outer cone angle in radians, must be within [InnerAngle, TAU]
|
|
|
+
|
|
|
+ InnerVolume: f32, // volume level scaler on/within inner cone, used only for matrix calculations, must be within [0.0f, 2.0f] when used
|
|
|
+ OuterVolume: f32, // volume level scaler on/beyond outer cone, used only for matrix calculations, must be within [0.0f, 2.0f] when used
|
|
|
+ InnerLPF: f32, // LPF (both direct and reverb paths) coefficient subtrahend on/within inner cone, used only for LPF (both direct and reverb paths) calculations, must be within [0.0f, 1.0f] when used
|
|
|
+ OuterLPF: f32, // LPF (both direct and reverb paths) coefficient subtrahend on/beyond outer cone, used only for LPF (both direct and reverb paths) calculations, must be within [0.0f, 1.0f] when used
|
|
|
+ InnerReverb: f32, // reverb send level scaler on/within inner cone, used only for reverb calculations, must be within [0.0f, 2.0f] when used
|
|
|
+ OuterReverb: f32, // reverb send level scaler on/beyond outer cone, used only for reverb calculations, must be within [0.0f, 2.0f] when used
|
|
|
}
|
|
|
Default_DirectionalCone := CONE{math.PI / 2, math.PI, 1.0, 0.708, 0.0, 0.25, 0.708, 1.0}
|
|
|
|
|
@@ -147,13 +147,13 @@ Default_DirectionalCone := CONE{math.PI / 2, math.PI, 1.0, 0.708, 0.0, 0.25, 0.7
|
|
|
//
|
|
|
// The cone is directed by the listener's front orientation.
|
|
|
LISTENER :: struct #packed {
|
|
|
- OrientFront: VECTOR, // orientation of front direction, used only for matrix and delay calculations or listeners with cones for matrix, LPF (both direct and reverb paths), and reverb calculations, must be normalized when used
|
|
|
- OrientTop: VECTOR, // orientation of top direction, used only for matrix and delay calculations, must be orthonormal with OrientFront when used
|
|
|
+ OrientFront: VECTOR, // orientation of front direction, used only for matrix and delay calculations or listeners with cones for matrix, LPF (both direct and reverb paths), and reverb calculations, must be normalized when used
|
|
|
+ OrientTop: VECTOR, // orientation of top direction, used only for matrix and delay calculations, must be orthonormal with OrientFront when used
|
|
|
|
|
|
- Position: VECTOR, // position in user-defined world units, does not affect Velocity
|
|
|
- Velocity: VECTOR, // velocity vector in user-defined world units/second, used only for doppler calculations, does not affect Position
|
|
|
+ Position: VECTOR, // position in user-defined world units, does not affect Velocity
|
|
|
+ Velocity: VECTOR, // velocity vector in user-defined world units/second, used only for doppler calculations, does not affect Position
|
|
|
|
|
|
- pCone: ^CONE, // sound cone, used only for matrix, LPF (both direct and reverb paths), and reverb calculations, NULL specifies omnidirectionality
|
|
|
+ pCone: ^CONE, // sound cone, used only for matrix, LPF (both direct and reverb paths), and reverb calculations, NULL specifies omnidirectionality
|
|
|
}
|
|
|
|
|
|
// Emitter:
|
|
@@ -187,9 +187,9 @@ EMITTER :: struct #packed {
|
|
|
InnerRadius: f32, // inner radius, must be within [0.0f, max(f32)]
|
|
|
InnerRadiusAngle: f32, // inner radius angle, must be within [0.0f, PI/4.0)
|
|
|
|
|
|
- ChannelCount: u32, // number of sound channels, must be > 0
|
|
|
- ChannelRadius: f32, // channel radius, used only with multi-channel emitters for matrix calculations, must be >= 0.0f when used
|
|
|
- pChannelAzimuths: [^]f32, // channel azimuth array, used only with multi-channel emitters for matrix calculations, contains positions of each channel expressed in radians along the channel radius with respect to the front orientation vector in the plane orthogonal to the top orientation vector, or TAU to specify an LFE channel, must have at least ChannelCount elements, all within [0.0f, TAU] when used
|
|
|
+ ChannelCount: u32, // number of sound channels, must be > 0
|
|
|
+ ChannelRadius: f32, // channel radius, used only with multi-channel emitters for matrix calculations, must be >= 0.0f when used
|
|
|
+ pChannelAzimuths: [^]f32 `fmt:"v,ChannelCount"`, // channel azimuth array, used only with multi-channel emitters for matrix calculations, contains positions of each channel expressed in radians along the channel radius with respect to the front orientation vector in the plane orthogonal to the top orientation vector, or TAU to specify an LFE channel, must have at least ChannelCount elements, all within [0.0f, TAU] when used
|
|
|
|
|
|
pVolumeCurve: ^DISTANCE_CURVE, // volume level distance curve, used only for matrix calculations, NULL specifies a default curve that conforms to the inverse square law, calculated in user-defined world units with distances <= CurveDistanceScaler clamped to no attenuation
|
|
|
pLFECurve: ^DISTANCE_CURVE, // LFE level distance curve, used only for matrix calculations, NULL specifies a default curve that conforms to the inverse square law, calculated in user-defined world units with distances <= CurveDistanceScaler clamped to no attenuation
|