HVR::ReverbSoundEffect Class Reference

The ReverbSoundEffect node generates a reverberation effect on a VRSound node. More...

Inheritance diagram for HVR::ReverbSoundEffect:

Classes
struct	Updater

Public Member Functions
	ReverbSoundEffect (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< Updater > _updater=0, H3D::Inst< H3D::SFFloat > _modalDensity=0, H3D::Inst< H3D::SFFloat > _diffusion=0, H3D::Inst< H3D::SFFloat > _gain=0, H3D::Inst< H3D::SFFloat > _highFrequencyGain=0, H3D::Inst< H3D::SFFloat > _decayTime=0, H3D::Inst< H3D::SFFloat > _decayHighFrequencyRatio=0, H3D::Inst< H3D::SFFloat > _reflectionsGain=0, H3D::Inst< H3D::SFFloat > _reflectionsDelay=0, H3D::Inst< H3D::SFFloat > _lateReverbGain=0, H3D::Inst< H3D::SFFloat > _lateReverbDelay=0, H3D::Inst< H3D::SFFloat > _roomRolloffFactor=0, H3D::Inst< H3D::SFFloat > _airAbsorptionHighFrequencyGain=0, H3D::Inst< H3D::SFBool > _decayHighFrequencyLimit=0, H3D::Inst< H3D::SFString > _parametersPreset=0)
Public Member Functions inherited from HVR::HVRSoundEffectNode
	HVRSoundEffectNode (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< SFSoundFilter > _soundFilter=0)
virtual std::string	defaultXMLContainerField ()
void	addSource (ALuint source_id)
	Add an OpenAL source id to use this effect. More...
void	removeSource (ALuint source_id)
	Remove a previously added OpenAL source id from this effect. More...

Public Attributes
std::auto_ptr< H3D::SFFloat >	modalDensity
	(0.0–1.0) (1.0) Reverb Modal Density controls the coloration of the late reverb. More...
std::auto_ptr< H3D::SFFloat >	diffusion
	(0.0–1.0) (1.0) The Reverb Diffusion property controls the echo density in the reverberation decay. More...
std::auto_ptr< H3D::SFFloat >	gain
	(0.0–1.0) (0.32) The Reverb Gain property is the master volume control for the reflected sound (both early reflections and reverberation) that the reverb effect adds to all sound sources. More...
std::auto_ptr< H3D::SFFloat >	highFrequencyGain
	(0.0–1.0) (0.89) The Reverb Gain HF property further tweaks reflected sound by attenuating it at high frequencies. More...
std::auto_ptr< H3D::SFFloat >	decayTime
	(0.1–20.0) (1.49) The Decay Time property sets the reverberation decay time. More...
std::auto_ptr< H3D::SFFloat >	decayHighFrequencyRatio
	(0.1–2.0) (0.83) The Decay HF Ratio property sets the spectral quality of the Decay Time parameter. More...
std::auto_ptr< H3D::SFFloat >	reflectionsGain
	(0.0–3.16) (0.05) The Reflections Gain property controls the overall amount of initial reflections relative to the Gain property. More...
std::auto_ptr< H3D::SFFloat >	reflectionsDelay
	(0.0–0.3) (0.007) The Reflections Delay property is the amount of delay, in seconds, between the arrival time of the direct path from the source to the first reflection from the source. More...
std::auto_ptr< H3D::SFFloat >	lateReverbGain
	(0.0–10.0) (1.26) The Late Reverb Gain property controls the overall amount of later reverberation relative to the Gain property. More...
std::auto_ptr< H3D::SFFloat >	lateReverbDelay
	(0.0–0.1) (0.011) The Late Reverb Delay property defines the begin time, in seconds, of the late reverberation relative to the time of the initial reflection (the first of the early reflections). More...
std::auto_ptr< H3D::SFFloat >	roomRolloffFactor
	(0.0–10.0) (0.0) The Room Rolloff Factor property is one of two methods available to attenuate the reflected sound (containing both reflections and reverberation) according to source-listener distance. More...
std::auto_ptr< H3D::SFFloat >	airAbsorptionHighFrequencyGain
	(0.892–1.0) (0.994) The Air Absorption Gain HF property controls the distance-dependent attenuation at high frequencies caused by the propagation medium. More...
std::auto_ptr< H3D::SFBool >	decayHighFrequencyLimit
	(True) 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 HF. More...
std::auto_ptr< H3D::SFString >	parametersPreset
	("NONE") When this parameter is set to "NONE" each parameter of the effect is controlled by their respective fields. More...
Public Attributes inherited from HVR::HVRSoundEffectNode
std::auto_ptr< SFSoundFilter >	soundFilter
	(Null) This is a HVRSoundFilterNode that, if set, will filter the sound played through this effect node. More...

Static Public Attributes
static H3D::H3DNodeDatabase	database
Static Public Attributes inherited from HVR::HVRSoundEffectNode
static H3D::H3DNodeDatabase	database

Protected Member Functions
void	updateParameters (float modalDensity, float diffusion, float gain, float highFrequencyGain, float decayTime, float decayHighFrequencyRatio, float reflectionsGain, float reflectionsDelay, float lateReverbGain, float lateReverbDelay, float roomRolloffFactor, float airAbsorptionHighFrequencyGain, bool decayHighFrequencyLimit)
Protected Member Functions inherited from HVR::HVRSoundEffectNode
void	pushParameterChanges ()

Protected Attributes
struct HVR_API	Updater
std::auto_ptr< Updater >	updater
Protected Attributes inherited from HVR::HVRSoundEffectNode
std::map< ALuint, ALuint >	effectslot_per_source
	Associated OpenAL identifiers. More...
ALuint	effect_id
	Associated OpenAL effect identifier. More...

Detailed Description

The ReverbSoundEffect node generates a reverberation effect on a VRSound node.

The effect can be controlled through a set of parameters or by choosing a preset.

This node is a part of a sound node structure based on the OpenAL/EFX standards. It supports sound spatialization, sound effects and filtering.

Member Data Documentation

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::airAbsorptionHighFrequencyGain

(0.892–1.0) (0.994) The Air Absorption Gain HF property controls the distance-dependent attenuation at high frequencies caused by the propagation medium.

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).

std::auto_ptr<H3D::SFBool> HVR::ReverbSoundEffect::decayHighFrequencyLimit

(True) 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 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 AL_FALSE, high-frequency decay time isn’t automatically limited.

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::decayHighFrequencyRatio

(0.1–2.0) (0.83) The Decay HF Ratio property sets the spectral quality of the Decay Time parameter.

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.

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::decayTime

(0.1–20.0) (1.49) The Decay Time property sets the reverberation decay time.

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

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::diffusion

(0.0–1.0) (1.0) The Reverb Diffusion property controls the echo density in the reverberation decay.

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.

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::gain

(0.0–1.0) (0.32) The Reverb Gain property is the master volume control for the reflected sound (both early reflections and reverberation) that the reverb effect adds to all sound sources.

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 (0 dB) (the maximum amount) to 0.0 (-100 dB) (no reflected sound at all).

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::highFrequencyGain

(0.0–1.0) (0.89) The Reverb Gain HF property further tweaks reflected sound by attenuating it at high frequencies.

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 (0 dB) (no filter) to 0.0 (-100 dB) (virtually no reflected sound).

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::lateReverbDelay

(0.0–0.1) (0.011) The Late Reverb Delay property defines the begin time, in seconds, of the late reverberation relative to the time of the initial reflection (the first of the early reflections).

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

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::lateReverbGain

(0.0–10.0) (1.26) The Late Reverb Gain property controls the overall amount of later reverberation relative to the Gain property.

(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). Note that Late Reverb Gain and Decay Time are independent properties: If you adjust Decay Time without changing Late Reverb Gain, the total intensity (the averaged square of the amplitude) of the late reverberation remains constant.

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::modalDensity

(0.0–1.0) (1.0) Reverb Modal Density controls the coloration of the late reverb.

Lowering the value adds more coloration to the late reverb.

std::auto_ptr<H3D::SFString> HVR::ReverbSoundEffect::parametersPreset

("NONE") When this parameter is set to "NONE" each parameter of the effect is controlled by their respective fields.

Otherwise the name specified is used to look up the parameters from a library of presets. Accepted values are (case sensitive):

NONE, GENERIC, PADDEDCELL, ROOM, BATHROOM, LIVINGROOM, STONEROOM, AUDITORIUM, CONCERTHALL, CAVE, ARENA, HANGAR, CARPETEDHALLWAY, HALLWAY, STONECORRIDOR, ALLEY, FOREST, CITY, MOUNTAINS, QUARRY, PLAIN, PARKINGLOT, SEWERPIPE, UNDERWATER, DRUGGED, DIZZY, PSYCHOTIC, CASTLE_SMALLROOM, CASTLE_SHORTPASSAGE, CASTLE_MEDIUMROOM, CASTLE_LARGEROOM, CASTLE_LONGPASSAGE, CASTLE_HALL, CASTLE_CUPBOARD, CASTLE_COURTYARD, CASTLE_ALCOVE, FACTORY_SMALLROOM, FACTORY_SHORTPASSAGE, FACTORY_MEDIUMROOM, FACTORY_LARGEROOM, FACTORY_LONGPASSAGE, FACTORY_HALL, FACTORY_CUPBOARD, FACTORY_COURTYARD, FACTORY_ALCOVE, ICEPALACE_SMALLROOM, ICEPALACE_SHORTPASSAGE, ICEPALACE_MEDIUMROOM, ICEPALACE_LARGEROOM, ICEPALACE_LONGPASSAGE, ICEPALACE_HALL, ICEPALACE_CUPBOARD, ICEPALACE_COURTYARD, ICEPALACE_ALCOVE, SPACESTATION_SMALLROOM, SPACESTATION_SHORTPASSAGE, SPACESTATION_MEDIUMROOM, SPACESTATION_LARGEROOM, SPACESTATION_LONGPASSAGE, SPACESTATION_HALL, SPACESTATION_CUPBOARD, SPACESTATION_ALCOVE, WOODEN_SMALLROOM, WOODEN_SHORTPASSAGE, WOODEN_MEDIUMROOM, WOODEN_LARGEROOM, WOODEN_LONGPASSAGE, WOODEN_HALL, WOODEN_CUPBOARD, WOODEN_COURTYARD, WOODEN_ALCOVE, SPORT_EMPTYSTADIUM, SPORT_SQUASHCOURT, SPORT_SMALLSWIMMINGPOOL, SPORT_LARGESWIMMINGPOOL, SPORT_GYMNASIUM, SPORT_FULLSTADIUM, SPORT_STADIUMTANNOY, PREFAB_WORKSHOP, PREFAB_SCHOOLROOM, PREFAB_PRACTISEROOM, PREFAB_OUTHOUSE, PREFAB_CARAVAN, DOME_TOMB, PIPE_SMALL, DOME_SAINTPAULS, PIPE_LONGTHIN, PIPE_LARGE, PIPE_RESONANT, OUTDOORS_BACKYARD, OUTDOORS_ROLLINGPLAINS, OUTDOORS_DEEPCANYON, OUTDOORS_CREEK, OUTDOORS_VALLEY, MOOD_HEAVEN, MOOD_HELL, MOOD_MEMORY, DRIVING_COMMENTATOR, DRIVING_PITGARAGE, DRIVING_INCAR_RACER, DRIVING_INCAR_SPORTS, DRIVING_INCAR_LUXURY, DRIVING_FULLGRANDSTAND, DRIVING_EMPTYGRANDSTAND, DRIVING_TUNNEL, CITY_STREETS, CITY_SUBWAY, CITY_MUSEUM, CITY_LIBRARY, CITY_UNDERPASS, CITY_ABANDONED, DUSTYROOM, CHAPEL, SMALLWATERROOM

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::reflectionsDelay

(0.0–0.3) (0.007) The Reflections Delay property is the amount of delay, in seconds, between the arrival time of the direct path from the source to the first reflection from the source.

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.

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::reflectionsGain

(0.0–3.16) (0.05) The Reflections Gain property controls the overall amount of initial reflections relative to the Gain property.

(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.

You can increase the amount of initial reflections to simulate a more narrow space or closer walls, especially effective if you associate the initial reflections increase with a reduction in reflections delays by lowering the value of the Reflection Delay property. To simulate open or semi-open environments, you can maintain the amount of early reflections while reducing the value of the Late Reverb Gain property, which controls later reflections.

std::auto_ptr<H3D::SFFloat> HVR::ReverbSoundEffect::roomRolloffFactor

(0.0–10.0) (0.0) The Room Rolloff Factor property is one of two methods available to attenuate the reflected sound (containing both reflections and reverberation) according to source-listener distance.

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. (Note that this isn’t the case if the source property flag AL_AUXILIARY_SEND_FILTER_GAIN_AUTO is set to AL_FALSE) You can use Room Rolloff Factor as an option to automatic control so you can exaggerate or replace the default automatically-controlled rolloff.