Difference between revisions of "Documentation/Engine/Sound"

From SCS Modding Wiki
Jump to navigation Jump to search
(Sound definition)
(Sound documentation)
 
(40 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=== WARNING ! ===
+
__TOC__
'''The sound system and current pages are in 'work in progress' state.'''
 
We continuously update content of the site and the audio data structures.
 
  
=== FMOD® ===
+
 
 +
{{Note|'''The sound system and current pages are in 'work in progress' state. We will continuously update content of the site and the audio data structures.'''}}
 +
 
 +
== FMOD® ==
  
 
The FMOD® system is now (from 1.37 version) used as a core sound engine in the game.<br>
 
The FMOD® system is now (from 1.37 version) used as a core sound engine in the game.<br>
The FMOD® Studio 2.00.07 version is currently in use.<br>
+
The FMOD® Studio 2.01.05 version is currently in use (from 1.39 version).
  
''See FMOD documentation (www.fmod.com) to better understand of the sound system.''
+
''See FMOD documentation ([http://www.fmod.com www.fmod.com]) to better understand of the sound system.''
  
=== Sound and Sound Bank(s) ===
+
== Sound and Sound Bank(s) ==
  
Each sound is represented by the sound '''Event'''. An Event is an instanceable sound unit of the FMOD Studio project.<br>
+
Each sound is represented by the sound '''Event'''. An Event is an instanceable sound unit of the FMOD Studio project. All sounds/events are provided by sound banks. The final sound banks are builded by FMOD Studio.<br>
All sounds/events are provided by sound banks. The final sound banks are builded by FMOD Studio.
 
  
=== Master Bank ===
+
FMOD Studio builds the "[bank name].bank" file for each bank in the sound project. It is collection of the Events and Parameters used for the sound playing in the game.
 +
 
 +
== Master Bank ==
 +
 
 +
Master Bank is primary sound bank of the sound system. There are no Events in the bank.
  
Master Bank is primary sound bank of the sound system.<br>
 
There are not any Events in the bank.<br>
 
<br>
 
 
'''The Master Bank defines:'''
 
'''The Master Bank defines:'''
  
* The sound buses<br>Events in FMOD Studio do not exist in a vacuum. Their output is routed into the project mixer.<br>The Events have to be routed to the some bus registered at the Master Bank.<br>User can set the sound volume and mute state in the application settings for each bus which is used as a routing target for sound events.<br><br>
+
* The sound buses<br>Events in FMOD Studio do not exist in a vacuum. Their output is routed into the project mixer. The Events have to be routed to one of the buses registered in the Master Bank. Users can set the sound volume and mute state in the application settings for each bus which is used as a routing target for sound events.
* Mixer and Routing<br>The project mixer consists of a number of interconnected buses. Connection between the audio buses describe the sound event flow through the sound system.<br><br>
+
* Mixer and Routing<br>The project mixer consists of a number of interconnected buses. Connection between the audio buses describe the sound event flow through the sound system.
* Global Parameters<br>An event contains and is primarily composed of tracks and parameters.<br>Some parameters are defined in the master. This parameters are global and can be used for Automation and Modulation of events across all banks.<br>
+
* Global Parameters<br>An event contains and is primarily composed of tracks and parameters. Some parameters are defined in the master. This parameters are global and can be used for Automation and Modulation of events across all banks.
<br>
+
 
The Master Bank is a fundamental building block of the sound system.<br>
+
The Master Bank is a fundamental building block of the sound system so: '''Never change the Master Bank!'''
'''Never change the Master Bank!'''<br>Only if you absolutely sure what you are doing and you are rewriting all the sounds of the game you can change it.
+
 
 +
Only if you absolutely sure what you are doing and you are rewriting all the sounds of the game you can change it.
 +
 
 +
== Sound definition ==
 +
 
 +
A common sound in game is the '''Event''' in the FMOD Studio project. Each object (bank, bus, event, parameter, etc.) used by FMOD system has unique identifier - '''GUID'''.<br>
 +
(''GUID is something like this: {1315eda7-1829-4dd8-9d1a-176f65637ab2}'')
 +
 
 +
The sound system use GUIDs internally for the processing objects. It's very important. If you delete object in the sound project (bus, event, etc.) and create new object even with the same name it will be different object because the object has a different GUID.
  
=== Sound definition ===
 
A common sound in game is the '''Event''' in the FMOD Studio project.<br>
 
Each object (bank, bus, event, parameter, etc.) used by FMOD system has unique identifier - '''GUID'''.<br>
 
(''GUID is something like this: {1315eda7-1829-4dd8-9d1a-176f65637ab2}'')<br>
 
<br>
 
The sound system use GUIDs internally for the processing objects.<br>
 
It's very important. If you delete object in the sound project (bus, event, etc.) and create new object even with the same name it will be different object because the object has a different GUID.<br>
 
<br>
 
 
FMOD Studio exports GUIDs to the txt file.
 
FMOD Studio exports GUIDs to the txt file.
 
# Use FMOD Studio menu command: File / Export GUIDs...
 
# Use FMOD Studio menu command: File / Export GUIDs...
 
# There is new file GUIDS.txt in the "build" subfolder of the project main folder.
 
# There is new file GUIDS.txt in the "build" subfolder of the project main folder.
# The file has to be renamed to "[bank filename].guids" and has to be placed next to "bank" file.
+
# The file has to be renamed to "[bank filename].guids" and has to be placed next to "bank" file. It's a "dictionary" between names of the objects in the bank and their GUIDs.
 +
 
 +
The game uses two ways to define usage of sound object:
 +
# Direct 'sound id':<br>"Sound id" is string in format "[bank filename]#[event name]". Where [bank filename] is file of the bank relative to the game "base" folder and [event name] is name of the event in the FMOD Studio project.<br>Example: ''"/sound/ui/ui.bank#click"''
 +
# Sound reference file:<br>Sound reference file is used as link for the sound specification. It uses simple path to the soundref file (e.g. ''"/sound/ui/ui_click.soundref"'').
 +
 
 +
== Sound reference file ==
 +
 
 +
We prefer and we recommended to use sound reference file.
 +
* There are more possibilities to configure sound.
 +
* It is easier to change / modding individual sounds.
 +
 
 +
 
 +
'''Sound reference file structure:'''
 +
 
 +
Soundref file is text file (with UTF-8 encoding).
 +
* It contents 'sound id' on the separate line with following format: source="[bank filename]#[event name]".
 +
* There is possibility in the file to change 3D placement of the sound relative to the default position. Format is the separate line: "position_offset=-left/+right;-down/+up;-front/+back" (in meters).
 +
<br>Example of content of the file ''"ui_click.soundref": source="/sound/ui/ui.bank#click"''
 +
 
 +
== Sound documentation ==
 +
 
 +
* [[Documentation/Engine/Sound/Mixer|Audio buses, routing and mixer]]
 +
* (WIP) Global parameters
 +
* [[Documentation/Engine/Sound/TruckEngine|Sounds - Truck Engine]]
 +
* [[Documentation/Engine/Sound/TruckTransmission|Sounds - Truck Transmission and Retarder]]
 +
* [[Documentation/Engine/Sound/TruckChassis|Sounds - Truck Chassis]]
 +
* [[Documentation/Engine/Sound/TruckCabin|Sounds - Truck Cabin (horns and noises)]]
 +
* [[Documentation/Engine/Sound/TruckCabinFiltering|Sounds - Truck Cabin Filtering (in/out, windows)]]
 +
* [[Documentation/Engine/Sound/TruckRemote|Sounds - Remote Truck (multiplayer)]]
 +
* (WIP) Sounds - Truck Interior
 +
* (WIP) Sounds - Tires
 +
* (WIP) Sounds - Collisions
 +
* (WIP) Sounds - Traffic
 +
* [[Documentation/Engine/Sound/SoundWorld|Sounds - World]]
 +
* (WIP) Sounds - Game UI and Music
 +
* [[Documentation/Engine/Sound/Modding|Modding sounds]]
 +
* [[Documentation/Engine/Sound/Downloads|Downloads (templates, samples)]]

Latest revision as of 07:34, 14 December 2021


Note: The sound system and current pages are in 'work in progress' state. We will continuously update content of the site and the audio data structures.

FMOD®

The FMOD® system is now (from 1.37 version) used as a core sound engine in the game.
The FMOD® Studio 2.01.05 version is currently in use (from 1.39 version).

See FMOD documentation (www.fmod.com) to better understand of the sound system.

Sound and Sound Bank(s)

Each sound is represented by the sound Event. An Event is an instanceable sound unit of the FMOD Studio project. All sounds/events are provided by sound banks. The final sound banks are builded by FMOD Studio.

FMOD Studio builds the "[bank name].bank" file for each bank in the sound project. It is collection of the Events and Parameters used for the sound playing in the game.

Master Bank

Master Bank is primary sound bank of the sound system. There are no Events in the bank.

The Master Bank defines:

  • The sound buses
    Events in FMOD Studio do not exist in a vacuum. Their output is routed into the project mixer. The Events have to be routed to one of the buses registered in the Master Bank. Users can set the sound volume and mute state in the application settings for each bus which is used as a routing target for sound events.
  • Mixer and Routing
    The project mixer consists of a number of interconnected buses. Connection between the audio buses describe the sound event flow through the sound system.
  • Global Parameters
    An event contains and is primarily composed of tracks and parameters. Some parameters are defined in the master. This parameters are global and can be used for Automation and Modulation of events across all banks.

The Master Bank is a fundamental building block of the sound system so: Never change the Master Bank!

Only if you absolutely sure what you are doing and you are rewriting all the sounds of the game you can change it.

Sound definition

A common sound in game is the Event in the FMOD Studio project. Each object (bank, bus, event, parameter, etc.) used by FMOD system has unique identifier - GUID.
(GUID is something like this: {1315eda7-1829-4dd8-9d1a-176f65637ab2})

The sound system use GUIDs internally for the processing objects. It's very important. If you delete object in the sound project (bus, event, etc.) and create new object even with the same name it will be different object because the object has a different GUID.

FMOD Studio exports GUIDs to the txt file.

  1. Use FMOD Studio menu command: File / Export GUIDs...
  2. There is new file GUIDS.txt in the "build" subfolder of the project main folder.
  3. The file has to be renamed to "[bank filename].guids" and has to be placed next to "bank" file. It's a "dictionary" between names of the objects in the bank and their GUIDs.

The game uses two ways to define usage of sound object:

  1. Direct 'sound id':
    "Sound id" is string in format "[bank filename]#[event name]". Where [bank filename] is file of the bank relative to the game "base" folder and [event name] is name of the event in the FMOD Studio project.
    Example: "/sound/ui/ui.bank#click"
  2. Sound reference file:
    Sound reference file is used as link for the sound specification. It uses simple path to the soundref file (e.g. "/sound/ui/ui_click.soundref").

Sound reference file

We prefer and we recommended to use sound reference file.

  • There are more possibilities to configure sound.
  • It is easier to change / modding individual sounds.


Sound reference file structure:

Soundref file is text file (with UTF-8 encoding).

  • It contents 'sound id' on the separate line with following format: source="[bank filename]#[event name]".
  • There is possibility in the file to change 3D placement of the sound relative to the default position. Format is the separate line: "position_offset=-left/+right;-down/+up;-front/+back" (in meters).


Example of content of the file "ui_click.soundref": source="/sound/ui/ui.bank#click"

Sound documentation