Difference between revisions of "Documentation/Engine/Sound/Mixer"

From SCS Modding Wiki
Jump to navigation Jump to search
(Audio buses, routing and mixer)
m (Voiceover bus appears to now be for Convoy mode CB radio?)
 
(12 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
=== Audio buses, routing and mixer ===
 
=== Audio buses, routing and mixer ===
  
The definition of the sound buses and their routing is very important part of the Master Bank.
+
The definition of the sound buses and their routing is a very important part of the Master Bank.
  
* Bus<br>
+
* Master Bus<Br>The master bus creates the final submix of all buses routed to it before outputting audio to the speaker channels.<br>All buses, return buses, and events not assigned to a group are routed into the master bus.
* Routing<br>
+
* Bus<br>The bus is an object which helps to collect specific sounds to groups and centrally control their volume or mute state.<br>Any sound event in the game should be assigned to the corresponding prepared audio bus.
 +
* Routing<br>Routing the events and buses by the mixer helps to control specific sounds in groups and applying effects (as a reverb) for the whole group of the sounds together.
  
 
Current table describes mixer principles in our Master Bank:
 
Current table describes mixer principles in our Master Bank:
Line 11: Line 12:
 
! Bus !! Routing to... !! Using for sounds... !! Remark
 
! Bus !! Routing to... !! Using for sounds... !! Remark
 
|-
 
|-
| master ||  || Example || Example
+
| master ||  || ''- none -'' || Target for the central mixing of all other audio buses.<br>"Master" volume and mute state (from application settings) is applied to the bus.
 
|-
 
|-
| <--- cabin || ''master'' || ''- none -'' || Example
+
| <--- cabin || ''master'' || ''- none -'' ||  
 
|-
 
|-
| .....<--- interior || ''cabin'' || Individual truck interior sounds as for example: air warning, blinkers, sticks, park brake, wipers, windows... || Example
+
| .....<--- interior || ''cabin'' || Individual truck interior sounds as for example:<br>air warning, blinkers, sticks, park brake, wipers, windows, seat noise... ||  
 
|-
 
|-
| .....<--- window_left || ''cabin'' || ''- none -'' || Example
+
| .....<--- window_left || ''cabin'' || ''- none -'' ||  
 
|-
 
|-
| .....<--- window_right || ''cabin'' || ''- none -'' || Example
+
| .....<--- window_right || ''cabin'' || ''- none -'' ||  
 
|-
 
|-
| <--- exterior || ''master'' || Example || Example
+
| .....<--- window_out || ''cabin'' || ''- none -'' ||  
 
|-
 
|-
| .....<--- traffic || ''exterior'' || Example || Example
+
| <--- outside || ''master'' || ''- none -'' || The bus should not contents any sounds. It is only technically group to collect all sounds from the outer world.
 
|-
 
|-
| .....<--- trailer || ''exterior'' || Example || Example
+
| ...<--- exterior || ''outside'' || ''- none -'' || The bus should not contents any sounds. It is only technically group to collect all exterior sounds.
 
|-
 
|-
| .....<--- truck_effects || ''exterior'' || Example || Example
+
| .....<--- traffic || ''exterior'' || Sounds of the traffic system. ||  
 
|-
 
|-
| .....<--- truck_engine || ''exterior'' || Example || Example
+
| .....<--- trailer || ''exterior'' || Player's trailer sounds. ||  
 
|-
 
|-
| .....<--- truck_exhaust || ''exterior'' || Example || Example
+
| .....<--- truck_effects || ''exterior'' || Player's truck effects<br>(air cutoff, air gear, hook, horns, reverse, ...). ||  
 
|-
 
|-
| .....<--- truck_noise || ''exterior'' || Example || Example
+
| .....<--- truck_engine || ''exterior'' || Player's truck engine.<br>([[Documentation/Engine/Sound/TruckEngine|see: Sounds - Truck Engine]]) ||  
 
|-
 
|-
| .....<--- world || ''exterior'' || Example || Example
+
| .....<--- truck_exhaust || ''exterior'' || Player's truck exhaust.<br>([[Documentation/Engine/Sound/TruckEngine|see: Sounds - Truck Engine]]) ||  
 
|-
 
|-
| <--- game || ''master'' || Example || Example
+
| .....<--- truck_turbo || ''exterior'' || Player's truck turbo.<br>([[Documentation/Engine/Sound/TruckEngine|see: Sounds - Truck Engine]]) ||  
 
|-
 
|-
| .....<--- music || ''game'' || Example || Example
+
| .....<--- truck_noise || ''exterior'' || Player's truck noise<br>(aero noise, suspension noise, ...). ||  
 
|-
 
|-
| .....<--- navigation || ''game'' || Example || Example
+
| .....<--- world || ''exterior'' || Prefab sounds, sounds of animations...||  
 
|-
 
|-
| .....<--- ui || ''game'' || Example || Example
+
| ...<--- unprocessed || ''outside'' || ''- none -'' || The bus should not contents any sounds. It is only technically group to collect all exterior sounds which are not affected by sound processing (like reverb).
 
|-
 
|-
| .....<--- ui_music || ''game'' || Example || Example
+
| .....<--- ambient || ''unprocessed'' || Ambient and environmental sounds and effects. ||  
 
|-
 
|-
| .....<--- voiceover || ''game'' || Example || Example
+
| <--- game || ''master'' || ''- none -'' ||  
 
|-
 
|-
| <--- radio || ''master'' || Example || Example
+
| .....<--- music || ''game'' || In-game music (as a 'hurry up' melody). ||
 +
|-
 +
| .....<--- navigation || ''game'' || Voice navigation output. ||
 +
|-
 +
| .....<--- ui || ''game'' || Sounds of the user interface<br>(click, mail, reward, camera, ...). ||
 +
|-
 +
| .....<--- ui_music || ''game'' || Music for UI (menu, garage, service, ...).  ||
 +
|-
 +
| .....<--- voiceover || ''game'' || Reserved for the future use. ||
 +
|-
 +
| <--- radio || ''master'' || Output for the in-game radio (user music) player. ||  
 
|}
 
|}

Latest revision as of 01:38, 11 January 2023

Audio buses, routing and mixer

The definition of the sound buses and their routing is a very important part of the Master Bank.

  • Master Bus
    The master bus creates the final submix of all buses routed to it before outputting audio to the speaker channels.
    All buses, return buses, and events not assigned to a group are routed into the master bus.
  • Bus
    The bus is an object which helps to collect specific sounds to groups and centrally control their volume or mute state.
    Any sound event in the game should be assigned to the corresponding prepared audio bus.
  • Routing
    Routing the events and buses by the mixer helps to control specific sounds in groups and applying effects (as a reverb) for the whole group of the sounds together.

Current table describes mixer principles in our Master Bank:

Bus Routing to... Using for sounds... Remark
master - none - Target for the central mixing of all other audio buses.
"Master" volume and mute state (from application settings) is applied to the bus.
<--- cabin master - none -
.....<--- interior cabin Individual truck interior sounds as for example:
air warning, blinkers, sticks, park brake, wipers, windows, seat noise...
.....<--- window_left cabin - none -
.....<--- window_right cabin - none -
.....<--- window_out cabin - none -
<--- outside master - none - The bus should not contents any sounds. It is only technically group to collect all sounds from the outer world.
...<--- exterior outside - none - The bus should not contents any sounds. It is only technically group to collect all exterior sounds.
.....<--- traffic exterior Sounds of the traffic system.
.....<--- trailer exterior Player's trailer sounds.
.....<--- truck_effects exterior Player's truck effects
(air cutoff, air gear, hook, horns, reverse, ...).
.....<--- truck_engine exterior Player's truck engine.
(see: Sounds - Truck Engine)
.....<--- truck_exhaust exterior Player's truck exhaust.
(see: Sounds - Truck Engine)
.....<--- truck_turbo exterior Player's truck turbo.
(see: Sounds - Truck Engine)
.....<--- truck_noise exterior Player's truck noise
(aero noise, suspension noise, ...).
.....<--- world exterior Prefab sounds, sounds of animations...
...<--- unprocessed outside - none - The bus should not contents any sounds. It is only technically group to collect all exterior sounds which are not affected by sound processing (like reverb).
.....<--- ambient unprocessed Ambient and environmental sounds and effects.
<--- game master - none -
.....<--- music game In-game music (as a 'hurry up' melody).
.....<--- navigation game Voice navigation output.
.....<--- ui game Sounds of the user interface
(click, mail, reward, camera, ...).
.....<--- ui_music game Music for UI (menu, garage, service, ...).
.....<--- voiceover game Reserved for the future use.
<--- radio master Output for the in-game radio (user music) player.