Added audio level options, muted interior sound on external view

Author: dariowouters

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.39.6
+ - Added rudimentary audio level customization
+ - Fixed interior sounds being played when on an exterior view
+
 ## 1.39.5
  - Added support for more interior events:
     - interior/stick_hazard_warning

README.md

@@ -5,7 +5,7 @@
 A telemetry plugin for ATS/ETS2 that includes an FMOD instance so that you can use FMOD sound mods.
 
 This is pretty useless in singleplayer because you could just load the mod directly in the game.<br>
-But I'm mostly playing TruckersMP, where fmod is still kinda broken and also doesn't support sound mods, which are much better than the base game sounds.
+But since I'm mostly playing TruckersMP, where sound mods are not supported (which are much better than the base game sounds).
 
 So this is something I kinda quickly put together after the broken sounds in 1.37 TruckersMP, and then didn't really update it once it worked except for making it compatible with the newer versions, so it is pretty basic.
 
@@ -15,10 +15,10 @@ I'm not that great at c(++) and reverse engineering so it might just stay this w
 
 # Some limitations/issues
 - Will keep playing sound even when alt-tabbed
-- Sound level/direction does not change with the camera, the sound is always as if you are in the truck looking forward.
+- Sound level/direction does not change with the camera, the sound is always as if you are in the truck looking forward, with the exception of interior sounds not being played when on an exterior camera.
 - You will need to mute or lower some of the in-game audio channels for your truck (or you will hear double audio), but this will also mute all truck sounds from other players
 - Can (and most probably will) break and (possibly) crash you game with every (major) game update because it needs to read some values directly from memory, and this structure can change with updates
-- No volume control (not sure how to add this except for adding imgui or something like it)
+- Only very basic volume control (might look into something better/easier in the future)
 - Probably some more that I forgot
 
 # How to use
@@ -30,14 +30,15 @@ Here's the correct folder structure:
 ```python
 <game_install_location>/bin/win_x64/
 │   eurotrucks2.exe # or amtrucks.exe for ATS
-│   ... # removed to keep this list smaller
+│   ... # hidden to keep this list smaller
 │
 └───plugins # create if not exists
     │   ts-fmod-plugin.dll # copy from release
     │
     └───ts-fmod-plugin # copy from release
             master.bank # copy from specific game folder in release
-            selected.bank.txt # edit text in file with sound mod filename you want
+            selected.bank.txt # copy from release | edit text in file with sound mod filename you want
+            sound_levels.txt # copy from release | edit the sound levels to you liking
             the_sound_mod_you_want_to_use.bank # example of sound mod
             the_sound_mod_you_want_to_use.bank.guids # example of sound mod
 ```
@@ -53,6 +54,8 @@ You will generally need to mute/lower the truck engine, exhaust and turbo sound
 
 If you have the developer console enabled in-game you can switch sound mods without restarting by changing the filename in `selected.bank.txt` and then in the game console enter `sdk reload`. This will reload all telemetry plugins and cause this plugin to load the newly selected sound mod.
 
+You can change the sound levels in the `sound_levels.txt` file, you will just kind of need to play with them until you get something you like. Again you can use the `sdk reload` console command after you've changed these to reload the plugin with these new values.
+
 When the game updates you might need to update the `master.bank` file, it is located in the base.scs file for the specific game, in that file it is located in `/sound/master/`
 
 # Supported FMOD events and parameters

dist/ts-fmod-plugin.dll

@@ -0,0 +1,8 @@
+{
+    "master": 0.5,
+    "engine": 0.5,
+    "exhaust": 0.5,
+    "turbo": 0.5,
+    "interior": 1,
+    "exterior_when_windows_closed": 0.75
+}

dist/ts-fmod-plugin/sound_levels.txt

@@ -125,15 +125,28 @@ SCSAPI_VOID telemetry_tick(const scs_event_t event, const void* const event_info
             const auto window_pos = unk_window_parent->get_window_state();
             if (window_pos.x >= 0 && window_pos.x <= 1) fmod_manager_instance->set_global_parameter("wnd_left", window_pos.x);
             if (window_pos.y >= 0 && window_pos.y <= 1) fmod_manager_instance->set_global_parameter("wnd_right", window_pos.y);
-            if (common::cmpf(window_pos.x, 0) && common::cmpf(window_pos.y, 0)) // not sure what to to with this (sound levels when windows close(d)) yet / maybe fade audio the more it closes/opens
+            if (common::cmpf(window_pos.x, 0) && common::cmpf(window_pos.y, 0))
             {
-                fmod_manager_instance->set_bus_volume("outside", consts::window_closed_volume);
-                fmod_manager_instance->set_bus_volume("exterior", consts::window_closed_volume); // backward compatibility
+                fmod_manager_instance->set_bus_volume("outside", fmod_manager_instance->sound_levels.windows_closed);
+                fmod_manager_instance->set_bus_volume("exterior", fmod_manager_instance->sound_levels.windows_closed); // backward compatibility
             }
             else
             {
-                fmod_manager_instance->set_bus_volume("outside", consts::window_open_volume);
-                fmod_manager_instance->set_bus_volume("exterior", consts::window_open_volume); // backward compatibility
+                fmod_manager_instance->set_bus_volume("outside", 1);
+                fmod_manager_instance->set_bus_volume("exterior", 1); // backward compatibility
+            }
+
+            if (unk_window_parent->get_is_camera_inside())
+            {
+                fmod_manager_instance->set_bus_volume("cabin/interior", fmod_manager_instance->sound_levels.interior);
+            }
+            else if (unk_window_parent->get_is_on_interior_cam())
+            {
+                fmod_manager_instance->set_bus_volume("cabin/interior", fmod_manager_instance->sound_levels.interior / 2.0f);
+            }
+            else
+            {
+                fmod_manager_instance->set_bus_volume("cabin/interior", 0);
             }
 
             fmod_manager_instance->set_global_parameter("surr_type", unk_window_parent->get_has_echo());

ts-fmod-plugin/consts.h

@@ -78,8 +78,16 @@ bool fmod_manager::init()
         return false;
     }
 
-    set_bus_volume("outside", consts::window_closed_volume);
-    set_bus_volume("exterior", consts::window_closed_volume); // backward compatibility for 1.37 sound mods
+    load_sound_levels(plugin_files_dir);
+
+    set_bus_volume("", sound_levels.master);
+    set_bus_volume("outside/exterior/truck_engine", sound_levels.engine);
+    set_bus_volume("outside/exterior/truck_exhaust", sound_levels.exhaust);
+    set_bus_volume("outside/exterior/truck_turbo", sound_levels.turbo);
+    set_bus_volume("cabin/interior", sound_levels.interior);
+
+    set_bus_volume("outside", sound_levels.windows_closed);
+    set_bus_volume("exterior", sound_levels.windows_closed); // backward compatibility for 1.37 sound mods
 
     return true;
 }
@@ -127,6 +135,73 @@ bool fmod_manager::init_channels(const std::string& plugin_files_dir)
     return true;
 }
 
+float fmod_manager::get_sound_level_from_json(json j, const char* key, float defaultValue = 1.0f)
+{
+
+    std::stringstream ss;
+
+    float val = defaultValue;
+    if (j.contains(key) && j[key].is_number())
+    {
+        val = j[key].get<float>();
+        if (val < 0.0f)
+        {
+            ss << "[ts-fmod-plugin] Invalid value for sound level '" << key << "', value should be more than 0. Defaulting to " << defaultValue;
+            scs_log_(SCS_LOG_TYPE_error, ss.str().c_str());
+            val = defaultValue;
+        }
+    }
+    else
+    {
+        ss.clear();
+        ss << "[ts-fmod-plugin] Could not read sound level '" << key << "', defaulting to " << defaultValue;
+        scs_log_(SCS_LOG_TYPE_error, ss.str().c_str());
+    }
+
+    return val / 2;
+}
+
+bool fmod_manager::load_sound_levels(const std::string& plugin_files_dir)
+{
+    const auto sound_levels_file_path = plugin_files_dir + "sound_levels.txt";
+
+    if (!fs::exists(sound_levels_file_path))
+    {
+        scs_log_(SCS_LOG_TYPE_error, "[ts-fmod-plugin] Could not find the 'sound_levels.txt' file");
+        return false;
+    }
+
+    std::ifstream sound_levels_file(sound_levels_file_path);
+    std::string line;
+
+    if (!sound_levels_file.is_open())
+    {
+        scs_log_(SCS_LOG_TYPE_error, "[ts-fmod-plugin] Could not read the 'sound_levels.txt' file");
+        return false;
+    }
+
+    json j;
+
+    try {
+        sound_levels_file >> j;
+    }
+    catch (json::parse_error& e)
+    {
+        scs_log_(SCS_LOG_TYPE_error, "[ts-fmod-plugin] Could not parse JSON from 'sound_levels.txt' ");
+        return false;
+    }
+
+
+    sound_levels.master = get_sound_level_from_json(j, "master");
+    sound_levels.engine = get_sound_level_from_json(j, "engine");
+    sound_levels.exhaust = get_sound_level_from_json(j, "exhaust");
+    sound_levels.turbo = get_sound_level_from_json(j, "turbo");
+    sound_levels.interior = get_sound_level_from_json(j, "interior");
+    sound_levels.windows_closed = get_sound_level_from_json(j, "exterior_when_windows_closed", 0.7f);
+
+    return true;
+}
+
 void fmod_manager::set_paused(const bool state)
 {
     pause_bus("", state); // pause/unpause the main bus ('bus:/')

ts-fmod-plugin/dllmain.cpp

@@ -1,8 +1,20 @@
 #pragma once
 #include <scssdk/scssdk.h>
+#include "nlohmann/json.hpp"
+
+using json = nlohmann::json;
 
 #include "fmod_event.h"
 
+struct sound_levels_t {
+    float master = 0.25;
+    float engine = 0.25;
+    float exhaust = 0.25;
+    float turbo = 0.25;
+    float interior = 0.5;
+    float windows_closed = 0.35;
+};
+
 class fmod_manager
 {
     FMOD::Studio::System* system_ = nullptr;
@@ -18,7 +30,12 @@ class fmod_manager
     bool load_selected_bank(const std::string& plugin_files_dir);
     bool init_channels(const std::string& plugin_files_dir);
 
+    float get_sound_level_from_json(json j, const char* key, float defaultValue);
+    bool load_sound_levels(const std::string& plugin_files_dir);
+
 public:
+    sound_levels_t sound_levels;
+
     explicit fmod_manager(scs_log_t scs_log);
     ~fmod_manager();
 

ts-fmod-plugin/fmod_manager.cpp

@@ -148,6 +148,16 @@ class unk_window // still need to figure out what this actually is
     {
         return window_state;
     }
+
+    bool get_is_camera_inside() const
+    {
+        return is_camera_inside;
+    }
+
+    bool get_is_on_interior_cam() const
+    {
+        return interior_camera;
+    }
 };
 
 class economy_base_t