Siren Fix by KLE0
=================

This mod fixes most[1] of the issues with vanilla siren sound slots that are commonly used with ELS/DLS/LSPDFR, namely:

- Volume: SIREN_PA20A_WAIL/SIREN_2 are slightly quiet, and EURO_A/EURO_B are notably quiet
- Speed/pitch: SIREN_WAIL/QUICK_01/02, and SIREN_FIRETRUCK_WAIL/QUICK_01 are slowed down and have a modified pitch
- SIREN_WAIL_04 and SIREN_QUICK_04 did not work and required workarounds

Now all of these slots work correctly with custom sirens and the game will no longer add any speed/pitch/volume adjustments. SIREN_WAIL_04 and SIREN_QUICK_04 slots have been enabled as well. See appendix below for a full list of tested siren slots.


Installation
============

1. Put siren_fix folder in "GTA V/mods/update/x64/dlcpacks"
2. Open "GTA V/mods/update/update.rpf/common/data/dlclist.xml" with OpenIV or CodeWalker
3. Add the following line under <Paths>:

    <Item>dlcpacks:/siren_fix/</Item>


Troubleshooting/FAQ
===================

Q: Some/all sirens are still broken.
A: Make sure other mods are not overriding this one. Some mods have their own audio data which may include the default R* config for the siren sounds. Change the "order" value in setup2.xml in the dlc pack to be higher. This mod only modifies the siren sounds mentioned above, and will not override or conflict with unrelated sounds from other mods.

Q: How does it work? Does this mod replace any siren sounds?
A: No, this mod removed the flags in dat54.rel that will cause the game to modify the pitch and/or use a reduced volume during playback. It does not replace any wav files. The issues are associated with the particular siren slots and not sound files.


Acknowledgments
===============

Big thanks to the following people, as their free contributions to the modding community made this modification possible:

- dexyfex and all contributors to the CodeWalker project
- Monkeypolice188 for his extensive research on audio editing, which can be found at https://github.com/Monkeypolice188/Monkys-Audio-Research


Appendix
========

Below is a list of siren sounds that I have tested to work:

File Name					Sound Name
------------------------    ------------------------------------------
SIREN_PA20A_WAIL			VEHICLES_HORNS_SIREN_1
SIREN_2						VEHICLES_HORNS_SIREN_2
POLICE_WARNING				VEHICLES_HORNS_POLICE_WARNING
AMBULANCE_WARNING			VEHICLES_HORNS_AMBULANCE_WARNING
AIRHORN_EQD					SIRENS_AIRHORN
SIREN_WAIL_01				RESIDENT_VEHICLES_SIREN_WAIL_01
SIREN_QUICK_01				RESIDENT_VEHICLES_SIREN_QUICK_01
SIREN_WAIL_02				RESIDENT_VEHICLES_SIREN_WAIL_02
SIREN_QUICK_02				RESIDENT_VEHICLES_SIREN_QUICK_02
SIREN_WAIL_03				RESIDENT_VEHICLES_SIREN_WAIL_03
SIREN_QUICK_03				RESIDENT_VEHICLES_SIREN_QUICK_03
SIREN_WAIL_04				RESIDENT_VEHICLES_SIREN_WAIL_04
SIREN_QUICK_04				RESIDENT_VEHICLES_SIREN_QUICK_04
SIREN_FIRETRUCK_WAIL_01		RESIDENT_VEHICLES_SIREN_FIRETRUCK_WAIL_01
SIREN_FIRETRUCK_QUICK_01	RESIDENT_VEHICLES_SIREN_FIRETRUCK_QUICK_01
EURO_A						SIRENS_EURO_HIGH
EURO_B						SIRENS_EURO_LOW


[1] The main remaining issue is that POLICE_WARNING and AMBULANCE_WARNING play since the last position as opposed to always from the beginning. The workaround is to simply use these two slots for priority and airhorn tones.
