This is a struct containing all the parameters needed to describe a Reverb effect. More...

#include <effectparameters.h>

Public Member Functions
	ReverbParameters (Real density=1.0f, Real diffusion=1.0f, Real gain=0.32f, Real gainHF=0.89f, Real decayTime=1.49f, Real decayHFRatio=0.83f, Real reflectionsGain=0.05f, Real reflectionsDelay=0.007f, Real lateReverbGain=1.26f, Real lateReverbDelay=0.011f, Real airAbsorptionGainHF=0.994f, Real roomRolloffFactor=0.0f, bool decayHFLimit=true)
	Struct constructor. More...

Public Attributes
Real	AirAbsorptionGainHF
	The Air Absorption Gain HF property controls the distance-dependent attenuation at high frequencies caused by the propagation medium. More...

bool	DecayHFLimit
	Whether or not to limit high-frequency decay. More...

Real	DecayHFRatio
	The Decay HF Ratio property sets the spectral quality of the Decay Time parameter. More...

Real	DecayTime
	The Decay Time property sets the reverberation decay time. More...

Real	Density
	Reverb Modal Density controls the coloration of the late reverb. More...

Real	Diffusion
	The Reverb Diffusion property controls the echo density in the reverberation decay. More...

Real	Gain
	The Reverb Gain property is the master volume control for the reflected sound that the reverb effect adds to all sound sources. More...

Real	GainHF
	The Reverb Gain HF property further tweaks reflected sound by attenuating it at high frequencies. More...

Real	LateReverbDelay
	The Late Reverb Delay property defines the begin time of the late reverberation relative to the time of the initial reflection. More...

Real	LateReverbGain
	The Late Reverb Gain property controls the overall amount of later reverberation relative to the Gain property. More...

Real	ReflectionsDelay
	The Reflections Delay property is the amount of delay between the arrival time of the direct path from the source to the first reflection from the source. More...

Real	ReflectionsGain
	The Reflections Gain property controls the overall amount of initial reflections relative to the Gain property. More...

Real	RoomRolloffFactor
	The Room Rolloff Factor property is one of two methods available to attenuate the reflected sound according to source-listener distance. More...

Detailed Description

This is a struct containing all the parameters needed to describe a Reverb effect.

This is similar in purpose to the EAXReverbParameters struct, but has fewer parameters/features enabling it to run on more limited hardware. Using this may be a good fallback option for audio reverb effects.

Definition at line 253 of file effectparameters.h.

Constructor & Destructor Documentation

Mezzanine::Audio::ReverbParameters::ReverbParameters	(	Real	density = `1.0f`,
		Real	diffusion = `1.0f`,
		Real	gain = `0.32f`,
		Real	gainHF = `0.89f`,
		Real	decayTime = `1.49f`,
		Real	decayHFRatio = `0.83f`,
		Real	reflectionsGain = `0.05f`,
		Real	reflectionsDelay = `0.007f`,
		Real	lateReverbGain = `1.26f`,
		Real	lateReverbDelay = `0.011f`,
		Real	airAbsorptionGainHF = `0.994f`,
		Real	roomRolloffFactor = `0.0f`,
		bool	decayHFLimit = `true`
	)

inline

Struct constructor.

Parameters

density@copybrief	ReverbParameters::Density
diffusion@copybrief	ReverbParameters::Diffusion
gain@copybrief	ReverbParameters::Gain
gainHF@copybrief	ReverbParameters::GainHF
decayTime@copybrief	ReverbParameters::DecayTime
decayHFRatio@copybrief	ReverbParameters::DecayHFRatio
reflectionsGain@copybrief	ReverbParameters::ReflectionsGain
reflectionsDelay@copybrief	ReverbParameters::ReflectionsDelay
lateReverbGain@copybrief	ReverbParameters::LateReverbGain
lateReverbDelay@copybrief	ReverbParameters::LateReverbDelay
airAbsorptionGainHF@copybrief	ReverbParameters::AirAbsorptionGainHF
roomRolloffFactor@copybrief	ReverbParameters::RoomRolloffFactor
decayHFLimit@copybrief	ReverbParameters::DecayHFLimit

Definition at line 336 of file effectparameters.h.

Member Data Documentation

Real Mezzanine::Audio::ReverbParameters::AirAbsorptionGainHF

The Air Absorption Gain HF property controls the distance-dependent attenuation at high frequencies caused by the propagation medium.

Remarks: It applies to reflected sound only. You can use Air Absorption Gain HF to simulate sound transmission through foggy air, dry air, smoky atmosphere, and so on. The default value is 0.994 (-0.05 dB) per meter, which roughly corresponds to typical condition of atmospheric humidity, temperature, and so on. Lowering the value simulates a more absorbent medium (more humidity in the air, for example); raising the value simulates a less absorbent medium (dry desert air, for example).

Range: 0.892 to 1.0

Definition at line 305 of file effectparameters.h.

bool Mezzanine::Audio::ReverbParameters::DecayHFLimit

Whether or not to limit high-frequency decay.

Remarks: When this flag is set, the high-frequency decay time automatically stays below a limit value that's derived from the setting of the property Air Absorption Gain HF. This limit applies regardless of the setting of the property Decay HF Ratio, and the limit doesn't affect the value of Decay HF Ratio. This limit, when on, maintains a natural sounding reverberation decay by allowing you to increase the value of Decay Time without the risk of getting an unnaturally long decay time at high frequencies. If this flag is set to false, high-frequency decay time isn't automatically limited.

Definition at line 320 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::DecayHFRatio

The Decay HF Ratio property sets the spectral quality of the Decay Time parameter.

Remarks: It is the ratio of high-frequency decay time relative to the time set by Decay Time. The Decay HF Ratio value 1.0 is neutral: the decay time is equal for all frequencies. As Decay HF Ratio increases above 1.0, the high-frequency decay time increases so it's longer than the decay time at low frequencies. You hear a more brilliant reverberation with a longer decay at high frequencies. As the Decay HF Ratio value decreases below 1.0, the high-frequency decay time decreases so it's shorter than the decay time of the low frequencies. You hear a more natural reverberation.

Range: 0.1 to 2.0

Definition at line 282 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::DecayTime

The Decay Time property sets the reverberation decay time.

Remarks: It ranges from 0.1 (typically a small room with very dead surfaces) to 20.0 (typically a large room with very live surfaces).

Range: 0.1 to 20.0

Definition at line 275 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::Density

Reverb Modal Density controls the coloration of the late reverb.

Remarks: Lowering the value adds more coloration to the late reverb.

Range: 0.0 to 1.0

Definition at line 257 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::Diffusion

The Reverb Diffusion property controls the echo density in the reverberation decay.

Remarks: It's set by default to 1.0, which provides the highest density. Reducing diffusion gives the reverberation a more "grainy" character that is especially noticeable with percussive sound sources. If you set a diffusion value of 0.0, the later reverberation sounds like a succession of distinct echoes.

Range: 0.0 to 1.0

Definition at line 262 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::Gain

The Reverb Gain property is the master volume control for the reflected sound that the reverb effect adds to all sound sources.

Remarks: It sets the maximum amount of reflections and reverberation added to the final sound mix. The value of the Reverb Gain property ranges from 1.0 (0db) (the maximum amount) to 0.0 (-100db) (no reflected sound at all).

Range: 0.0 to 1.0

Definition at line 266 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::GainHF

The Reverb Gain HF property further tweaks reflected sound by attenuating it at high frequencies.

Remarks: It controls a low-pass filter that applies globally to the reflected sound of all sound sources feeding the particular instance of the reverb effect. The value of the Reverb Gain HF property ranges from 1.0 (0db) (no filter) to 0.0 (-100db) (virtually no reflected sound).

Range: 0.0 to 1.0

Definition at line 271 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::LateReverbDelay

The Late Reverb Delay property defines the begin time of the late reverberation relative to the time of the initial reflection.

Remarks: It ranges from 0 to 100 milliseconds. Reducing or increasing Late Reverb Delay is useful for simulating a smaller or larger room.

Range: 0.0 to 0.1

Definition at line 299 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::LateReverbGain

The Late Reverb Gain property controls the overall amount of later reverberation relative to the Gain property.

Remarks: The Gain property sets the overall amount of both initial reflections and later reverberation. The value of Late Reverb Gain ranges from a maximum of 10.0 (+20 dB) to a minimum of 0.0 (-100 dB) (no late reverberation at all).

Range: 0.0 to 10.0

Definition at line 295 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::ReflectionsDelay

The Reflections Delay property is the amount of delay between the arrival time of the direct path from the source to the first reflection from the source.

Remarks: It ranges from 0 to 300 milliseconds. You can reduce or increase Reflections Delay to simulate closer or more distant reflective surfaces and therefore control the perceived size of the room.

Range: 0.0 to 0.3

Definition at line 291 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::ReflectionsGain

The Reflections Gain property controls the overall amount of initial reflections relative to the Gain property.

Remarks: The Gain property sets the overall amount of reflected sound: both initial reflections and later reverberation. The value of Reflections Gain ranges from a maximum of 3.16 (+10 dB) to a minimum of 0.0 (-100 dB) (no initial reflections at all), and is corrected by the value of the Gain property. The Reflections Gain property does not affect the subsequent reverberation decay.

Range: 0.0 to 3.16

Definition at line 287 of file effectparameters.h.

Real Mezzanine::Audio::ReverbParameters::RoomRolloffFactor

The Room Rolloff Factor property is one of two methods available to attenuate the reflected sound according to source-listener distance.

Remarks: It's defined the same way as OpenAL's Rolloff Factor, but operates on reverb sound instead of direct-path sound. Setting the Room Rolloff Factor value to 1.0 specifies that the reflected sound will decay by 6 dB every time the distance doubles. Any value other than 1.0 is equivalent to a scaling factor applied to the quantity specified by ((Source listener distance) - (Reference Distance)). Reference Distance is an OpenAL source parameter that specifies the inner border for distance rolloff effects: if the source comes closer to the listener than the reference distance, the direct-path sound isn't increased as the source comes closer to the listener, and neither is the reflected sound.

The default value of Room Rolloff Factor is 0.0 because, by default, the Effects Extension reverb effect naturally manages the reflected sound level automatically for each sound source to simulate the natural rolloff of reflected sound vs. distance in typical rooms.

Range: 0.0 to 10.0

Definition at line 314 of file effectparameters.h.

The documentation for this struct was generated from the following file:

/home/sqeaky/Code/Mezzanine/Mezzanine/src/Audio/effectparameters.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation