This document describes the format of sound configuration files, which determine the sounds to use for each aircraft, or other simulated object.
The sound.cfg file is located in an aircraft’s Sound folder, and defines the sounds to use for that aircraft (such as the sound of the engine at various speeds, the sound of the landing gear going down, and so on). This file also specifies attributes for each sound that determine exactly how the sound is played.
Many aircraft sounds in are composed of multiple .wav files (called a sound list) that are linked to one another, processed in sequence, and then played as a group. These sounds are updated by the simulator’s sound engine every time the screen refreshes (once every frame).
As you read this section, you should look at actual sound.cfg files to become more familiar with the structure and syntax of them. They can be found in the Sound subfolders of the aircraft containers, and viewed using any text editor. To hear any particular component of a sound in its pure form (unaffected by the attributes in the sound.cfg file), just play the .wav file referenced in the sound.cfg (.wav files are located in either the Sound folder in an aircraft’s container, or in the root Sound folder).
Property |
Description |
Examples |
product_code | This parameter should always be set to: FSIM | Mooney Bravo( product_code=FSIM ) |
alias | A sound folder path, relative to the root folder. If an alias is entered, do not enter any more information into the sound configuration file - all the sounds from the aliased folder will be used. |
The engine numbers reference the engine positions in the [generalenginedata] section of the aircraft configuration file, except that in this sound file engines are numbered 1 to N, whereas in the aircraft configuration file they are numbered from 0 to N-1. This means that eng1_combusion, for example, references engine.0 in the aircraft configuration file, eng2_combustion references engine.1, and so on. The aircraft configuration file gives the position of the engine relative to the datum reference position for the aircraft, and this position will be the source of the engine noise.
Property |
Description |
Examples |
number_of_engines | How many engines the aircraft has. Maximum of 4. |
Mooney Bravo( number_of_engines=1 ) |
eng1_combustion to eng4_combustion |
Points to the first sound in a sound list of engine 1 combustion sounds. |
Mooney Bravo( eng1_combustion=COMBUSTION.1.00 ) |
eng1_starter to eng4_starter |
Points to the first sound in a sound list of engine 1 starter sounds. |
Mooney Bravo( eng1_starter=starter ) |
eng1_combustion_start to eng4_combustion_start |
Points to the first sound in a sound list of engine 1 combustion start sounds. |
Mooney Bravo( eng1_combustion_start=combstart ) |
eng1_shutdown to eng4_shutdown |
Points to the first sound in a sound list of engine 1 shutdown sounds. |
Mooney Bravo( eng1_shutdown=shutdown ) |
eng1_jet_whine to eng4_jet_whine |
Points to the first sound in a sound list of engine 1 jet whine sounds. Applies to Jets and Turboprops only. |
|
eng1_non_combustion to eng4_non_combustion |
Points to the first sound in a sound list of engine 1 non-combustion sounds (the isolated sounds of the engines moving parts). |
Mooney Bravo( eng1_non_combustion=NON_COMBUSTION.1.00 ) |
eng1_prop to eng4_prop |
Points to the first sound in a sound list of engine 1 prop sounds. Applies to Turboprops and Piston aircraft only. |
beech_baron_58( eng1_prop=PROP.1.00 ) beech_baron_58( eng2_prop=PROP.2.00 ) |
eng1_prop_strike to eng4_prop_strike |
Points to the first sound in a sound list of engine prop strike sounds. Applies to Turboprops and Piston aircraft only. |
|
eng1_rotor to eng4_rotor |
Points to the first sound in a sound list of rotor sounds. Applies to Helicopters only. |
Robinson R22( eng1_rotor=ROTOR.1.00 ) |
All sound lists [starter], [xstarter], [shutdown], [combstart], [combusion.1.00] and so on, all define one sound and have the following format.
Property |
Description |
Examples |
filename | Specifies the name of the .wav file to play. The .wav extension should not be specified. The Sound folder in the specific aircraft container is searched first, and then, if the file isn't found, the root Sound folder is searched. Note: [CRASH_SOUND]and [SPLASH_SOUND]filename parameters have comma separated filenames (e.g. filename=encrash1,encrash2). In these instances, the simulator code will randomly choose to play one of the listed .wav files. |
DeHavilland_Beaver_DHC2( filename=xdeBev_starter ) |
flags |
Flags have different functions when associated with different sounds: For all sounds: 0 = no flag 1 = disable sound For [combustion] sounds: 2 = damaged 4 = boost (not supported) 8 = jet engine rumble sound For [prop] sounds 2 = max prop pitch 4 = min prop pitch 8 = min reverse prop pitch |
Mooney Bravo( flags=0 ) |
viewpoint |
Determines when the sound is audible, one of: 1 = internal cockpit views 2 = external spot and tower views |
Mooney Bravo( viewpoint=1 ) |
rparams | Defines the sounds pitch envelope. Represents the sound's relative pitch (and, invariably, the playback speed) as a function of a generic value that can range from 0.0 to 1.0. Each pair of values specified in rparams represents a single point; you can use up to 2 points to describe the pitch envelope. The format and behavior of rparams is similar to vparams, except that the second value of each point represents a pitch scaler. A value of 1.0 specifies that the sound file is played at unity pitch. A value of 2.0 specifies that the file is played an octave higher and twice as fast. |
beech_baron_58( rparams=0.000000,0.977000,1.000000,1.682000 ) Beech_King_Air_350( rparams=0.000000,0.989000,0.998000,1.761000 ) |
vparams | Defines the sounds amplitude envelope. Represents the sounds volume as a function. Each pair of values specified in vparams represents a single point, you can use up to eight points to describe the amplitude envelope. The first number in the pair is a generic value that can range from 0.0 to 1.0 the second number specifies the volume. The units for volume are linear, with a value of 50 meaning -3dB attenuation, and 0 meaning silence. |
beech_baron_58( vparams=0.000000,49.000000,0.002000,49.600000,0.171000,50.400000,
0.236000,9.600000,0.264000,0.000000,1.000000,0.000000,1.000000,0.000000,1.000000,0.000000 ) Beech_King_Air_350( vparams=0.000000,49.000000,0.002000,49.600000,0.169000,55.200000, 0.241000,16.000000,0.380000,0.000000,1.000000,0.000000,1.000000,0.000000,1.000000,0.000000 ) |
maximum_volume | Specifies the highest possible volume--the sound never exceeds the volume specified. (Volume is specified in 1/100dB units, with a value of 10,000 being the maximum possible volume.). | Mooney_Bravo( maximum_volume=9000 ) |
minimum_volume | This parameter sets the point to which a sound can attenuate if there are no vparams. This is a legacy setting, but is easier to configure than sounds with vparams and rparams. Sounds configured this way are not 3D sounds and do not recognize the viewpoint parameter. | Mooney Bravo( minimum_volume=6000 ) |
insideconeangle | Inside sound cone angle in degrees. |
Maule_M7_260C( InsideConeAngle=180 ) Maule_M7_260C_Ski( InsideConeAngle=120 ) |
outsideconeangle | Outside sound cone angle in degrees. |
DeHavilland_Beaver_DHC2( OutsideConeAngle=270 ) Maule_M7_260C( OutsideConeAngle=260 ) |
conepitch | The pitch, in degrees, of the sound cone. |
Maule_M7_260C( ConePitch=-40.000004 ) Maule_M7_260C_Ski( ConePitch=-40.000000 ) |
coneheading | Direction of sound cone in degrees. Zero is facing forward. |
DeHavilland_Beaver_DHC2( ConeHeading=0 ) Maule_M7_260C( ConeHeading=179.999985 ) |
outsideconevolume | Maximum volume outside of sound cone. |
DeHavilland_Beaver_DHC2( OutsideConeVolume=9000 ) Maule_M7_260C( OutsideConeVolume=9450 ) |
full_scale_distance | The distance, in meters, away from the sound source, when the sound starts to attenuate. |
Maule_M7_260C( full_scale_distance=70 ) |
panning | Determines where the sound is placed in the stereo field: 0 = center -10,000 = full left 10,000 = full right |
|
link | References the next sound in a sound list (by section heading name). Some sounds are made up of several .wav files, and each .wav file has its own section in the .cfg file. | Mooney Bravo( link=shutdown.1 ) |
Property |
Description |
Examples |
filename | Specifies the name of the .wav file to play. The .wav extension should not be specified. The Sound folder in the specific aircraft container is searched first, and then, if the file isn't found, the root Sound folder is searched. |
beech_baron_58( filename=c4wind4.wav ) Beech_King_Air_350( filename=c4wind4 ) |
minimum_volume | Specifies the lowest possible volume--if the sound drops
below the minimum volume specified, it will not be heard. Volume
is specified in 1/100dB units, with a value of 10,000 being the maximum
possible volume. If the aircrafts speed is between minimum speed and maximum speed, playback volume is interpolated. |
Mooney Bravo( minimum_volume=6000 ) |
maximum_volume | Specifies the highest possible volume--the sound never exceeds the volume specified. (Volume is specified in 1/100dB units, with a value of 10,000 being the maximum possible volume.). |
Mooney Bravo( maximum_volume=9000 ) |
minimum_rate | Specifies the minimum rate at which the sound is played. If the aircrafts speed is between minimum_speed and maximum_speed, the playback rate is interpolated between the minimum_rate and maximum_rate values. |
Mooney Bravo( minimum_rate=0.60 ) |
maximum_rate | Specifies the maximum rate at which the sound is played. If the aircrafts speed is between minimum_speed and maximum_speed, the playback rate is interpolated between the minimum_rate and maximum_rate values. |
Mooney Bravo( maximum_rate=1.00 ) |
minimum_speed | Specifies the minimum speed (in KTAS) used by the _volume and _rate parameters. |
Mooney Bravo( minimum_speed=10.0 ) |
maximum_speed | Specifies the speed (in KTAS) above which the sound has constant volume and pitch. Specified in KTAS units. |
Mooney Bravo( maximum_speed=120.0 ) |
viewpoint |
Determines when the sound is audible, one of: 1 = internal cockpit views 2 = external spot and tower views |
|
rparams | See description of rparams for [soundlist.n] | |
vparams | See description of vparams for [soundlist.n] | |
link | References the next sound in a sound list (by section heading name). Some ground sounds are made up of several .wav files, and each .wav file has its own section in the .cfg file. |
Ground sounds include:
[CENTER_TOUCHDOWN]
[AUX_TOUCHDOWN]
[LEFT_TOUCHDOWN]
[RIGHT_TOUCHDOWN]
[FUSELAGE_SCRAPE]
[LEFT_WING_SCRAPE]
[RIGHT_WING_SCRAPE]
[AUX1_SCRAPE]
[AUX2_SCRAPE]
[XTAIL_SCRAPE]
[GROUND_ROLL]
Some ground sounds consist of multiple sets of .wav files (sound
lists), and each set corresponds to a unique combination of surface
types. Each ground sound can be volume- and pitch-modulated with
airspeed.
Property |
Description |
Examples |
filename | Specifies the name of the .wav file to play. The .wav extension should not be specified. The Sound folder in the specific aircraft container is searched first, and then, if the file isn't found, the root Sound folder is searched. If filename parameters have comma separated filenames then the simulator code will randomly choose to play one of the listed .wav files. |
Mooney Bravo( filename=tail_skid ) |
flags | Flags have different functions when associated with different sounds. For all sounds 0 = no flag 1 = disable sound For ground sounds By flagging a sound for a particular ground surface type, you tell the simulation to play that sound when the aircraft comes into contact with that surfaces type or types. Ground sound flags include: 2 = concrete 4 = soft, bumpy ground (landable) 8 = water 16 = very bumpy grass & mud (crashable) 32 = asphalt 64 = short grass 128 = long grass 256 = hard turf 512 = snow 1024 = ice 2048 = urban 4096 = forest 8192 = dirt runway 16384 = coral runway 32768 = gravel runway 65536 = oil treated (tar&chip) runway 131072 = steel mats (steel mesh) temporary runway Note that these values are powers of 2 so that they represent bits. For instance, the [GROUND_ROLL] section of the 182S sound.cfg file has the line flags=125218 This is 11110100100100010 in binary, and maps to concrete+asphalt+hard turf, etc. |
Mooney Bravo( flags=512 ) |
minimum_speed | Specifies the minimum speed (in KTAS) used by the _volume and _rate parameters. | Mooney Bravo( minimum_speed=1 ) |
maximum_speed | Specifies the speed (in KTAS) above which the sound has constant volume and pitch. Specified in KTAS units. |
Mooney Bravo( maximum_speed=55 ) |
minimum_volume | Specifies the lowest possible volume--if the sound drops below the minimum volume specified, it will not be heard. (Volume is specified in 1/100dB units, with a value of 10,000 being the maximum possible volume.). |
Bombardier_CRJ_700( minimum_volume=6500 ) |
maximum_volume | Specifies the highest possible volume--the sound never exceeds the volume specified. (Volume is specified in 1/100dB units, with a value of 10,000 being the maximum possible volume.). |
Bombardier_CRJ_700( maximum_volume=10000 ) Mooney_Bravo( maximum_volume=9300 ) |
minimum_rate | Specifies the minimum rate at which the sound is played. If the aircrafts speed is between minimum_speed and maximum_speed, the playback rate is interpolated between the minimum_rate and maximum_rate values. | Mooney Bravo( minimum_rate=0.80 ) |
maximum_rate | Specifies the maximum rate at which the sound is played. If the aircrafts speed is between minimum_speed and maximum_speed, the playback rate is interpolated between the minimum_rate and maximum_rate values. |
Mooney Bravo( maximum_rate=1.60 ) Bombardier_CRJ_700( maximum_rate=1.0 ) |
panning | Determines where the sound is placed in the stereo field: 0 = center -10,000 = full left 10,000 = full right |
|
initial_volume | Specifies the volume at which the sound starts. (Volume is specified in 1/100dB units, with a value of 10,000 being the maximum possible volume.). | |
viewpoint | Determines when the sound is audible, one of: 1 = internal cockpit views 2 = external spot and tower views |
|
link | References the next sound in a sound list (by section heading name). Some ground sounds are made up of several .wav files, and each .wav file has its own section in the .cfg file. |
Mooney Bravo( link=GROUND_ROLL2 ) |
Other sounds used by aircraft include:
[GEAR_UP_WARNING_SOUND]
[STALL_WARNING]
[OVERSPEED_WARNING_SOUND]
[GLIDESLOPE_WARNING_SOUND]
[AP_DISENGAGE_SOUND]
[GEAR_DOWN]
[GEAR_UP]
[FLAPS]
[CRASH_SOUND]
[SPLASH_SOUND]
[EXIT_OPEN]
[EXIT_CLOSED]
[NO_SMOKING_ALERT]
[SEATBELTS_ALERT]
[GYRO_SOUND]
[FUEL_PUMP]
[AMPHIB_GEAR_UP_WARNING_SOUND]
[AMPHIB_GEAR_DOWN_WARNING_SOUND]
[CLUTCH]
[HORN]
[LAUNCHBAR_EXTEND]
[LAUNCHBAR_RETRACT]
[WING_UNFOLD.0]
[WING_UNFOLD.1]
[WING_FOLD.0]
[WING_FOLD.1]
[TAILHOOK_EXTEND]
[TAILHOOK_RETRACT]
[CARRIER_TRAP]
[BLAST_SHIELD_UP.0]
[BLAST_SHIELD_UP.1]
[BLAST_SHIELD_DOWN.0]
[BLAST_SHIELD_DOWN.1]
[CATAPULT_LAUNCH.0]
[CATAPULT_LAUNCH.1]
For the wing fold and unfold sounds, the .0 and .1 extensions refer to left and right. For the blast shields and catapults, the extensions differentiate between each blast shield or catapult, even though they may well all use the same sound files. These sound sections take the following parameters:
Property |
Description |
Examples |
filename | Specifies the name of the .wav file to play. The .wav extension should not be specified.
The Sound folder in the specific aircraft container is searched first, and then, if the file isn't found,
the root Sound folder is searched. Note that
[CRASH_SOUND] and [SPLASH_SOUND] filename parameters have comma
separated filenames and the sound played will be randomly chosen from
the listed files. Some miscellaneous sound sections consist of no more than the filename entry. |
beech_baron_58( filename=pcrash3,cncrash1,cncrash2 ) Bombardier_CRJ_700( filename=bncrash1,bncrash2 ) |
flags |
Flags have different functions when associated with different sounds. 0 = no flag 1 = disable sound |
beech_baron_58( flags=1 ) |
minimum_volume | Specifies the lowest possible volume--if the sound drops below the minimum volume specified, it will not be heard. (Volume is specified in 1/100dB units, with a value of 10,000 being the maximum possible volume.). | Bombardier_CRJ_700( minimum_volume=10000 ) |
maximum_volume | Specifies the highest possible volume--the sound never exceeds the volume specified. (Volume is specified in 1/100dB units, with a value of 10,000 being the maximum possible volume.). | Bombardier_CRJ_700( maximum_volume=9000 ) |
initial_volume | Specifies the volume at which the sound starts. (Volume is specified in 1/100dB units, with a value of 10,000 being the maximum possible volume.). |
Bombardier_CRJ_700( initial_volume=8700 ) |
link | References the next sound in a sound list (by section heading name). Some sounds are made up of several .wav files, and each .wav file has its own section in the .cfg file. | Grumman_Goose_G21A( link=GROUND_ROLL2 ) |