source.h File Reference
Contains the ISource interface, as well as several 'define's that specify the limits of parameters that can be passed to the source. More...
#include <nel/misc/types_nl.h>#include <nel/misc/vector.h>#include "sound_driver.h"
Go to the source code of this file.
Classes | |
| class | NLSOUND::ISource |
| Sound source interface (implemented in sound driver dynamic library). More... | |
Namespaces | |
| namespace | NLSOUND |
This namespace contains the sound classes. | |
Defines | |
| #define | NLSOUND_MIN_GAIN 0.0f |
| The minimum allowed gain is specified as 0.0f. | |
| #define | NLSOUND_MAX_GAIN 1.0f |
| The maximum allowed gain is specified as 1.0f. | |
| #define | NLSOUND_MIN_PITCH 0.0f |
| The minimum allowed pitch is specified as 0.0f. | |
| #define | NLSOUND_MAX_PITCH 8.0f |
| The maximum allowed pitch is specified as 8.0f. | |
| #define | NLSOUND_DEFAULT_GAIN 1.0f |
| The default gain is specified as 1.0f, which is the full volume. | |
| #define | NLSOUND_DEFAULT_PITCH 1.0f |
| The default pitch is specified as 1.0. | |
| #define | NLSOUND_DEFAULT_DIRECT_GAIN 1.0f |
| The default direct gain is specified as 1.0f. | |
| #define | NLSOUND_DEFAULT_EFFECT_GAIN 1.0f |
| The default effect gain is specified as 1.0f. | |
| #define | NLSOUND_DEFAULT_FILTER_PASS_HF 5000.0f |
| The default filter cutoff high frequency is specified as 5000.0f. | |
| #define | NLSOUND_DEFAULT_FILTER_PASS_LF 250.0f |
| The default filter cutoff low frequency is specified as 250.0f. | |
| #define | NLSOUND_DEFAULT_FILTER_PASS_GAIN 1.0f |
| The default filter pass gain is specified as 1.0f. | |
Detailed Description
Contains the ISource interface, as well as several 'define's that specify the limits of parameters that can be passed to the source.
Interface for physical sound sources
- Date:
- 2001-2009
Definition in file source.h.
Define Documentation
| #define NLSOUND_DEFAULT_DIRECT_GAIN 1.0f |
The default direct gain is specified as 1.0f.
This is the default volume for the direct dry output channel. Default direct gain.
Definition at line 92 of file source.h.
Referenced by NLSOUND::CSourceAL::CSourceAL(), NLSOUND::CSourceFMod::getDirectGain(), and NLSOUND::CSourceDSound::getDirectGain().
| #define NLSOUND_DEFAULT_EFFECT_GAIN 1.0f |
The default effect gain is specified as 1.0f.
This is the default volume for the effect output channel. Default effect gain.
Definition at line 98 of file source.h.
Referenced by NLSOUND::CSourceAL::CSourceAL(), NLSOUND::CSourceFMod::getEffectGain(), and NLSOUND::CSourceDSound::getEffectGain().
| #define NLSOUND_DEFAULT_FILTER_PASS_GAIN 1.0f |
The default filter pass gain is specified as 1.0f.
Using this value, the sound that is outside the cutoff frequencies passes without attenuation, so that essentially the resulting output is not filtered at all. Default filter pass gain.
Definition at line 119 of file source.h.
Referenced by NLSOUND::CSourceAL::CSourceAL(), NLSOUND::CSourceFMod::getDirectFilter(), NLSOUND::CSourceDSound::getDirectFilter(), NLSOUND::CSourceFMod::getEffectFilter(), and NLSOUND::CSourceDSound::getEffectFilter().
| #define NLSOUND_DEFAULT_FILTER_PASS_HF 5000.0f |
The default filter cutoff high frequency is specified as 5000.0f.
Under OpenAL EFX this is always the reference high frequency. Default filter cutoff high frequency.
Definition at line 105 of file source.h.
Referenced by NLSOUND::CSourceAL::getDirectFilter(), NLSOUND::CSourceFMod::getDirectFilter(), NLSOUND::CSourceDSound::getDirectFilter(), NLSOUND::CSourceAL::getEffectFilter(), NLSOUND::CSourceFMod::getEffectFilter(), and NLSOUND::CSourceDSound::getEffectFilter().
| #define NLSOUND_DEFAULT_FILTER_PASS_LF 250.0f |
The default filter cutoff low frequency is specified as 250.0f.
Under OpenAL EFX this is always the reference low frequency. Default filter cutoff low frequency.
Definition at line 111 of file source.h.
Referenced by NLSOUND::CSourceAL::getDirectFilter(), NLSOUND::CSourceFMod::getDirectFilter(), NLSOUND::CSourceDSound::getDirectFilter(), NLSOUND::CSourceAL::getEffectFilter(), NLSOUND::CSourceFMod::getEffectFilter(), and NLSOUND::CSourceDSound::getEffectFilter().
| #define NLSOUND_DEFAULT_GAIN 1.0f |
| #define NLSOUND_DEFAULT_PITCH 1.0f |
| #define NLSOUND_MAX_GAIN 1.0f |
The maximum allowed gain is specified as 1.0f.
OpenAL implementations may or may not clamp the gain to a maximum of 1.0f, so this maximum is forced on all implementations. If you pass a value outside the minimum and maximum bounds, it will automatically be clamped between them. Maximum allowed gain (volume).
Definition at line 52 of file source.h.
Referenced by NLSOUND::CSourceXAudio2::setDirectFilterPassGain(), NLSOUND::CSourceAL::setDirectFilterPassGain(), NLSOUND::CSourceXAudio2::setDirectGain(), NLSOUND::CSourceAL::setDirectGain(), NLSOUND::CSourceXAudio2::setEffectFilterPassGain(), NLSOUND::CSourceAL::setEffectFilterPassGain(), NLSOUND::CSourceXAudio2::setEffectGain(), NLSOUND::CSourceAL::setEffectGain(), NLSOUND::CSourceXAudio2::setGain(), and NLSOUND::CSourceAL::setGain().
| #define NLSOUND_MAX_PITCH 8.0f |
The maximum allowed pitch is specified as 8.0f.
Tests indicate that with OpenAL the pitch can be set to 8.0f, and with FMod to somewhere around 9.0f. The XAudio2 implementation uses this value directly to configure the maximum pitch, which can technically be as high as XAUDIO2_MAX_FREQ_RATIO which is 1024.0f. If you pass a value outside the minimum and maximum bounds, it will automatically be clamped between them. Maximum allowed pitch.
Definition at line 71 of file source.h.
Referenced by NLSOUND::CSoundDriverXAudio2::createSourceVoice(), NLSOUND::CSourceXAudio2::setPitch(), and NLSOUND::CSourceAL::setPitch().
| #define NLSOUND_MIN_GAIN 0.0f |
The minimum allowed gain is specified as 0.0f.
Inverting the wave by specifying a negative gain is not allowed. Minimum allowed gain (volume).
Definition at line 43 of file source.h.
Referenced by NLSOUND::CSourceXAudio2::setDirectFilterPassGain(), NLSOUND::CSourceAL::setDirectFilterPassGain(), NLSOUND::CSourceXAudio2::setDirectGain(), NLSOUND::CSourceAL::setDirectGain(), NLSOUND::CSourceXAudio2::setEffectFilterPassGain(), NLSOUND::CSourceAL::setEffectFilterPassGain(), NLSOUND::CSourceXAudio2::setEffectGain(), NLSOUND::CSourceAL::setEffectGain(), NLSOUND::CSourceXAudio2::setGain(), and NLSOUND::CSourceAL::setGain().
| #define NLSOUND_MIN_PITCH 0.0f |
The minimum allowed pitch is specified as 0.0f.
Going backwards in time by specifying a negative pitch is illegal. Setting the pitch to 0.0f is the same as pausing the source. Minimum allowed pitch.
Definition at line 60 of file source.h.
Referenced by NLSOUND::CSourceXAudio2::setPitch(), and NLSOUND::CSourceAL::setPitch().
