From 893ae7f0ca9bd7295a855bf9de66045368dea1b2 Mon Sep 17 00:00:00 2001 From: Rahul Unniyampath <129629104+rahulu1@users.noreply.github.com> Date: Sat, 20 Apr 2024 18:12:13 -0400 Subject: [PATCH] Refactor constant notation in Audio.h Co-authored-by: ncerroneumich --- src/openrct2-ui/ride/VehicleSounds.cpp | 14 ++++++------- src/openrct2/audio/Audio.cpp | 22 ++++++++++---------- src/openrct2/audio/audio.h | 28 +++++++++++++------------- src/openrct2/object/ObjectFactory.cpp | 6 +++--- src/openrct2/ride/RideAudio.cpp | 2 +- 5 files changed, 36 insertions(+), 36 deletions(-) diff --git a/src/openrct2-ui/ride/VehicleSounds.cpp b/src/openrct2-ui/ride/VehicleSounds.cpp index e848ffd36d..7380b1448a 100644 --- a/src/openrct2-ui/ride/VehicleSounds.cpp +++ b/src/openrct2-ui/ride/VehicleSounds.cpp @@ -230,7 +230,7 @@ namespace OpenRCT2::Audio * rct2: 0x006BB9FF */ static void UpdateSoundParams( - const Vehicle& vehicle, FixedVector& vehicleSoundParamsList) + const Vehicle& vehicle, FixedVector& vehicleSoundParamsList) { if (!SoundCanPlay(vehicle)) return; @@ -243,14 +243,14 @@ namespace OpenRCT2::Audio if (soundParamIter == std::end(vehicleSoundParamsList)) { - if (vehicleSoundParamsList.size() < MaxVehicleSounds) + if (vehicleSoundParamsList.size() < kMaxVehicleSounds) { vehicleSoundParamsList.push_back(CreateSoundParam(vehicle, soundPriority)); } } else { - if (vehicleSoundParamsList.size() < MaxVehicleSounds) + if (vehicleSoundParamsList.size() < kMaxVehicleSounds) { // Shift all sound params down one if using a free space vehicleSoundParamsList.insert(soundParamIter, CreateSoundParam(vehicle, soundPriority)); @@ -351,7 +351,7 @@ namespace OpenRCT2::Audio for (auto& vehicleSound : gVehicleSoundList) { // Use free slot - if (vehicleSound.id == SoundIdNull) + if (vehicleSound.id == kSoundIdNull) { vehicleSound.id = sound_params->id; vehicleSound.TrackSound.Id = SoundId::Null; @@ -528,7 +528,7 @@ namespace OpenRCT2::Audio if (!IsAvailable()) return; - FixedVector vehicleSoundParamsList; + FixedVector vehicleSoundParamsList; VehicleSoundsUpdateWindowSetup(); @@ -540,7 +540,7 @@ namespace OpenRCT2::Audio // Stop all playing sounds that no longer have priority to play after vehicle_update_sound_params for (auto& vehicleSound : gVehicleSoundList) { - if (vehicleSound.id != SoundIdNull) + if (vehicleSound.id != kSoundIdNull) { bool keepPlaying = false; for (auto vehicleSoundParams : vehicleSoundParamsList) @@ -563,7 +563,7 @@ namespace OpenRCT2::Audio { vehicleSound.OtherSound.Channel->Stop(); } - vehicleSound.id = SoundIdNull; + vehicleSound.id = kSoundIdNull; } } diff --git a/src/openrct2/audio/Audio.cpp b/src/openrct2/audio/Audio.cpp index e9a6e221e3..fbac597e0c 100644 --- a/src/openrct2/audio/Audio.cpp +++ b/src/openrct2/audio/Audio.cpp @@ -58,7 +58,7 @@ namespace OpenRCT2::Audio static std::shared_ptr _titleMusicChannel = nullptr; - VehicleSound gVehicleSoundList[MaxVehicleSounds]; + VehicleSound gVehicleSoundList[kMaxVehicleSounds]; bool IsAvailable() { @@ -101,16 +101,16 @@ namespace OpenRCT2::Audio { auto& objManager = GetContext()->GetObjectManager(); - Object* baseAudio = objManager.LoadObject(AudioObjectIdentifiers::RCT2); + Object* baseAudio = objManager.LoadObject(AudioObjectIdentifiers::kRCT2); if (baseAudio != nullptr) { _soundsAudioObjectEntryIndex = objManager.GetLoadedObjectEntryIndex(baseAudio); } - objManager.LoadObject(AudioObjectIdentifiers::OpenRCT2Additional); + objManager.LoadObject(AudioObjectIdentifiers::kOpenRCT2Additional); _soundsAdditionalAudioObjectEntryIndex = objManager.GetLoadedObjectEntryIndex( - AudioObjectIdentifiers::OpenRCT2Additional); - objManager.LoadObject(AudioObjectIdentifiers::RCT2Circus); + AudioObjectIdentifiers::kOpenRCT2Additional); + objManager.LoadObject(AudioObjectIdentifiers::kRCT2Circus); } void PopulateDevices() @@ -262,13 +262,13 @@ namespace OpenRCT2::Audio static std::map GetAvailableMusicMap() { auto musicMap = std::map{ - { TitleMusicKind::OpenRCT2, AudioObjectIdentifiers::OpenRCT2Title }, - { TitleMusicKind::RCT2, AudioObjectIdentifiers::RCT2Title }, + { TitleMusicKind::OpenRCT2, AudioObjectIdentifiers::kOpenRCT2Title }, + { TitleMusicKind::RCT2, AudioObjectIdentifiers::kRCT2Title }, }; if (IsRCT1TitleMusicAvailable()) { - musicMap.emplace(TitleMusicKind::RCT1, AudioObjectIdentifiers::RCT1Title); + musicMap.emplace(TitleMusicKind::RCT1, AudioObjectIdentifiers::kRCT1Title); } return musicMap; @@ -382,7 +382,7 @@ namespace OpenRCT2::Audio Close(); for (auto& vehicleSound : gVehicleSoundList) { - vehicleSound.id = SoundIdNull; + vehicleSound.id = kSoundIdNull; } _currentAudioDevice = device; @@ -436,9 +436,9 @@ namespace OpenRCT2::Audio for (auto& vehicleSound : gVehicleSoundList) { - if (vehicleSound.id != SoundIdNull) + if (vehicleSound.id != kSoundIdNull) { - vehicleSound.id = SoundIdNull; + vehicleSound.id = kSoundIdNull; if (vehicleSound.TrackSound.Id != SoundId::Null) { vehicleSound.TrackSound.Channel->Stop(); diff --git a/src/openrct2/audio/audio.h b/src/openrct2/audio/audio.h index 5d34b28a26..2946739e38 100644 --- a/src/openrct2/audio/audio.h +++ b/src/openrct2/audio/audio.h @@ -23,10 +23,10 @@ struct CoordsXYZ; namespace OpenRCT2::Audio { - constexpr size_t MaxDeviceNameSize = 256; - constexpr size_t MaxVehicleSounds = 14; - constexpr size_t MaxDefaultMusic = 46; - constexpr uint16_t SoundIdNull = 0xFFFF; + constexpr size_t kMaxDeviceNameSize = 256; + constexpr size_t kMaxVehicleSounds = 14; + constexpr size_t kMaxDefaultMusic = 46; + constexpr uint16_t kSoundIdNull = 0xFFFF; #define AUDIO_PLAY_AT_CENTRE 0x8000 @@ -135,25 +135,25 @@ namespace OpenRCT2::Audio Null = 255 }; - constexpr uint8_t RCT2SoundCount = static_cast(SoundId::Portcullis) + 1; + constexpr uint8_t kRCT2SoundCount = static_cast(SoundId::Portcullis) + 1; namespace AudioObjectIdentifiers { - constexpr std::string_view RCT1Title = "rct1.audio.title"; + constexpr std::string_view kRCT1Title = "rct1.audio.title"; // virtual name, used by either RCT2Base or RCTCBase, depending on which one is loaded. - constexpr std::string_view RCT2 = "rct2.audio.base"; - constexpr std::string_view RCT2Base = "rct2.audio.base.rct2"; - constexpr std::string_view RCTCBase = "rct2.audio.base.rctc"; - constexpr std::string_view RCT2Title = "rct2.audio.title"; - constexpr std::string_view OpenRCT2Title = "openrct2.audio.title"; - constexpr std::string_view RCT2Circus = "rct2.audio.circus"; - constexpr std::string_view OpenRCT2Additional = "openrct2.audio.additional"; + constexpr std::string_view kRCT2 = "rct2.audio.base"; + constexpr std::string_view kRCT2Base = "rct2.audio.base.rct2"; + constexpr std::string_view kRCTCBase = "rct2.audio.base.rctc"; + constexpr std::string_view kRCT2Title = "rct2.audio.title"; + constexpr std::string_view kOpenRCT2Title = "openrct2.audio.title"; + constexpr std::string_view kRCT2Circus = "rct2.audio.circus"; + constexpr std::string_view kOpenRCT2Additional = "openrct2.audio.additional"; } // namespace AudioObjectIdentifiers extern bool gGameSoundsOff; extern int32_t gVolumeAdjustZoom; - extern VehicleSound gVehicleSoundList[MaxVehicleSounds]; + extern VehicleSound gVehicleSoundList[kMaxVehicleSounds]; /** * Returns false when no audio device is available or when audio is turned off, otherwise true. diff --git a/src/openrct2/object/ObjectFactory.cpp b/src/openrct2/object/ObjectFactory.cpp index 1942f5fae6..01d6646924 100644 --- a/src/openrct2/object/ObjectFactory.cpp +++ b/src/openrct2/object/ObjectFactory.cpp @@ -526,11 +526,11 @@ namespace ObjectFactory auto id = Json::GetString(jRoot["id"]); // Base audio files are renamed to a common, virtual name so asset packs can override it correctly. - const bool isRCT2BaseAudio = id == OpenRCT2::Audio::AudioObjectIdentifiers::RCT2Base && !isUsingClassic(); - const bool isRCTCBaseAudio = id == OpenRCT2::Audio::AudioObjectIdentifiers::RCTCBase && isUsingClassic(); + const bool isRCT2BaseAudio = id == OpenRCT2::Audio::AudioObjectIdentifiers::kRCT2Base && !isUsingClassic(); + const bool isRCTCBaseAudio = id == OpenRCT2::Audio::AudioObjectIdentifiers::kRCTCBase && isUsingClassic(); if (isRCT2BaseAudio || isRCTCBaseAudio) { - id = OpenRCT2::Audio::AudioObjectIdentifiers::RCT2; + id = OpenRCT2::Audio::AudioObjectIdentifiers::kRCT2; } auto version = VersionTuple(Json::GetString(jRoot["version"])); diff --git a/src/openrct2/ride/RideAudio.cpp b/src/openrct2/ride/RideAudio.cpp index f2ff8546b4..02f08846f6 100644 --- a/src/openrct2/ride/RideAudio.cpp +++ b/src/openrct2/ride/RideAudio.cpp @@ -187,7 +187,7 @@ namespace OpenRCT2::RideAudio void CircusStartRideMusicChannel(const ViewportRideMusicInstance& instance) { auto& objManager = GetContext()->GetObjectManager(); - ObjectEntryDescriptor desc(ObjectType::Audio, AudioObjectIdentifiers::RCT2Circus); + ObjectEntryDescriptor desc(ObjectType::Audio, AudioObjectIdentifiers::kRCT2Circus); auto audioObj = static_cast(objManager.GetLoadedObject(desc)); if (audioObj != nullptr) {