From 43367fd363057f34746344a4e6869fce85ba2deb Mon Sep 17 00:00:00 2001
From: Proddy <josh@zhbot.org>
Date: Wed, 3 Jul 2024 19:39:56 +0100
Subject: [PATCH] Added `RandomDialog`

- Added `RCF` library
---
 Randomiser/CustomFiles.lua                    |   1 +
 Randomiser/Meta.ini                           |  90 ++++++++
 Randomiser/Resources/Modules/Audio/Dialog.lua | 204 ++++++++++++++++++
 Randomiser/Resources/lib/RCF.lua              | 122 +++++++++++
 4 files changed, 417 insertions(+)
 create mode 100644 Randomiser/Resources/Modules/Audio/Dialog.lua
 create mode 100644 Randomiser/Resources/lib/RCF.lua

diff --git a/Randomiser/CustomFiles.lua b/Randomiser/CustomFiles.lua
index e55b4b1..e85d824 100644
--- a/Randomiser/CustomFiles.lua
+++ b/Randomiser/CustomFiles.lua
@@ -10,6 +10,7 @@ P3D.LoadChunks(Paths.Lib .. "/P3DChunks")
 dofile(Paths.Lib .. "/P3DUtils.lua")
 dofile(Paths.Lib .. "/MFKLexer.lua")
 dofile(Paths.Lib .. "/SPTParser.lua")
+dofile(Paths.Lib .. "/RCF.lua")
 
 dofile(Paths.Lib .. "/ModuleLoader.lua")
 
diff --git a/Randomiser/Meta.ini b/Randomiser/Meta.ini
index 0703ad9..d63d881 100644
--- a/Randomiser/Meta.ini
+++ b/Randomiser/Meta.ini
@@ -391,6 +391,96 @@ ConditionSetting=RandomMusic
 Operator=EqualTo
 Value=1
 
+[Setting]
+Name=RandomDialog
+Title=Random Dialog
+Type=TickBox
+Default=0
+Tooltip=Randomises all game dialog.
+Page=Randomisations
+Group=Audio
+
+[Setting]
+Name=RandomDialogMode
+Title=Mode
+Type=MultipleChoice
+Option=Normal Random
+Option=Super Random
+Option=Mixed
+Page=Randomisations
+Group=Audio
+
+[SettingCondition]
+Type=Setting
+Setting=RandomDialogMode
+ConditionSetting=RandomDialog
+Operator=EqualTo
+Value=1
+
+[Setting]
+Name=RandomDialogEnglish
+Title=Include English
+Type=TickBox
+Default=1
+Tooltip=Include English dialog - requires dialog.rcf
+Page=Randomisations
+Group=Audio
+
+[SettingCondition]
+Type=Setting
+Setting=RandomDialogEnglish
+ConditionSetting=RandomDialog
+Operator=EqualTo
+Value=1
+
+[Setting]
+Name=RandomDialogFrench
+Title=Include French
+Type=TickBox
+Default=0
+Tooltip=Include French dialog - requires dialogf.rcf
+Page=Randomisations
+Group=Audio
+
+[SettingCondition]
+Type=Setting
+Setting=RandomDialogFrench
+ConditionSetting=RandomDialog
+Operator=EqualTo
+Value=1
+
+[Setting]
+Name=RandomDialogGerman
+Title=Include German
+Type=TickBox
+Default=0
+Tooltip=Include German dialog - requires dialogg.rcf
+Page=Randomisations
+Group=Audio
+
+[SettingCondition]
+Type=Setting
+Setting=RandomDialogGerman
+ConditionSetting=RandomDialog
+Operator=EqualTo
+Value=1
+
+[Setting]
+Name=RandomDialogSpanish
+Title=Include Spanish
+Type=TickBox
+Default=0
+Tooltip=Include Spanish dialog - requires dialogs.rcf
+Page=Randomisations
+Group=Audio
+
+[SettingCondition]
+Type=Setting
+Setting=RandomDialogSpanish
+ConditionSetting=RandomDialog
+Operator=EqualTo
+Value=1
+
 [Setting]
 Name=RandomText
 Title=Random Text
diff --git a/Randomiser/Resources/Modules/Audio/Dialog.lua b/Randomiser/Resources/Modules/Audio/Dialog.lua
new file mode 100644
index 0000000..2c2fa02
--- /dev/null
+++ b/Randomiser/Resources/Modules/Audio/Dialog.lua
@@ -0,0 +1,204 @@
+local math_min = math.min
+local math_random = math.random
+local string_format = string.format
+local string_lower = string.lower
+local string_pack = string.pack
+local string_rep = string.rep
+local string_sub = string.sub
+local string_unpack = string.unpack
+local table_concat = table.concat
+
+local GetFileExtension = GetFileExtension
+
+local RandomDialog = Module("Random Dialog", "RandomDialog")
+
+local RandomDialogMode = Settings.RandomDialogMode
+
+local RSDFiles = {}
+local RSDFilesN = 0
+
+local RSDSignature = "RSD4RADP"
+local function LoadRSDsFromRCF(Path)
+	local RCFFile = RCF.RCFFile(Path)
+	
+	local loaded = 0
+	for i=1,#RCFFile.Files do
+		local file = RCFFile.Files[i]
+		if string_lower(GetFileExtension(file.Name)) == ".rsd" then
+			local Signature, Channels, Bits, SampleRate = string_unpack("<c8III", file.Data)
+			if Signature == RSDSignature and Channels == 1 and Bits == 16 and SampleRate == 24000 then
+				RSDFiles[#RSDFiles + 1] = file
+				loaded = loaded + 1
+			else
+				Alert(string_format("Invalid dialog file found.\n\nRCF File: %s\nFile name: %s\nSignature: %s\nChannels: %i\nBits: %i\nSample Rate: %i", Path, file.Name, Signature, Channels, Bits, SampleRate))
+			end
+		end
+	end
+	return loaded
+end
+
+if Settings[RandomDialog.Setting] then
+	if not Settings.RandomDialogEnglish and not Settings.RandomDialogFrench and not Settings.RandomDialogGerman and not Settings.RandomDialogSpanish then
+		Alert("You've chosen to enable \"Random Dialog\", with no languages selected. You must choose at least one language.")
+		os.exit()
+	end
+	
+	if Settings.RandomDialogEnglish then
+		local DialogPath = "/GameData/dialog.rcf"
+		if not Exists(DialogPath, true, false) then
+			Alert("You've chosen to enable \"Include English\", but \"dialog.rcf\" is not present in the game directoy. This file is required for English dialog.")
+			os.exit()
+		end
+		
+		print(string_format("Loaded %i English dialog lines.", LoadRSDsFromRCF(DialogPath)))
+	end
+	
+	if Settings.RandomDialogFrench then
+		local DialogPath = "/GameData/dialogf.rcf"
+		if not Exists(DialogPath, true, false) then
+			Alert("You've chosen to enable \"Include French\", but \"dialogf.rcf\" is not present in the game directoy. This file is required for French dialog.")
+			os.exit()
+		end
+		
+		print(string_format("Loaded %i French dialog lines.", LoadRSDsFromRCF(DialogPath)))
+	end
+	
+	if Settings.RandomDialogGerman then
+		local DialogPath = "/GameData/dialogg.rcf"
+		if not Exists(DialogPath, true, false) then
+			Alert("You've chosen to enable \"Include German\", but \"dialogg.rcf\" is not present in the game directoy. This file is required for German dialog.")
+			os.exit()
+		end
+		
+		print(string_format("Loaded %i German dialog lines.", LoadRSDsFromRCF(DialogPath)))
+	end
+	
+	if Settings.RandomDialogSpanish then
+		local DialogPath = "/GameData/dialogs.rcf"
+		if not Exists(DialogPath, true, false) then
+			Alert("You've chosen to enable \"Include Spanish\", but \"dialogs.rcf\" is not present in the game directoy. This file is required for Spanish dialog.")
+			os.exit()
+		end
+		
+		print(string_format("Loaded %i Spanish dialog lines.", LoadRSDsFromRCF(DialogPath)))
+	end
+	
+	RSDFilesN = #RSDFiles
+	if RSDFilesN == 0 then
+		Alert("You've chosen to enable \"Random Dialog\", but no dialog files were found.")
+		os.exit()
+	end
+end
+
+local function HandleDialog(Path, Contents)
+	if RandomDialogMode == 1 or (RandomDialogMode == 3 and math.random(2) == 1) then -- Normal or 50% on Mixed
+		local RSDFile = RSDFiles[math_random(RSDFilesN)]
+		print("Replacing dialog \"" .. Path .. "\" with: " .. RSDFile.Name)
+		return true, RSDFile.Data
+	else -- Super Random or 50% on Mixed
+		print("Replacing dialog \"" .. Path .. "\" with super random dialog")
+		local header = string_pack("<c8III", RSDSignature, 1, 16, 24000) .. string_rep("*", 108) .. string_rep("-", 1920)
+		local frameSize = 20 -- * Channels, which is 1
+		
+		local Output = {header}
+		local OutputN = 1
+		
+		local OrigFrames = (#Contents - 2048) / frameSize
+		
+		local frameCount = 0
+		while frameCount < OrigFrames do
+			local RSDFile = RSDFiles[math_random(RSDFilesN)]
+			local AudioData = string_sub(RSDFile.Data, 2049)
+			
+			local BlockCount = #AudioData / frameSize
+			
+			local StartBlock = math_random(BlockCount)
+			local EndBlock = math_min(BlockCount, StartBlock + math_random(700, 1000))
+			
+			frameCount = frameCount + EndBlock - StartBlock
+			
+			OutputN = OutputN + 1
+			Output[OutputN] = string_sub(AudioData, StartBlock * frameSize + 1, EndBlock * frameSize)
+		end
+		return true, table_concat(Output)
+	end
+	return false
+end
+
+RandomDialog:AddGenericHandler("*c_*_*_convinit*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*c_*_*_noboxconv*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*c_*_*_tutorial*.rsd", HandleDialog)
+
+RandomDialog:AddGenericHandler("*d_aidestroy*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_air*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_answer*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_arrive*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_bcrash*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_break*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_burn*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_carway*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_damage*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_dcar*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_destroy*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_door*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_hitp*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_mcrash*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_missp*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*d_time*.rsd", HandleDialog)
+
+RandomDialog:AddGenericHandler("*p_hitbyc*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*p_hitbyw*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*p_nhitbyc*.rsd", HandleDialog)
+
+RandomDialog:AddGenericHandler("*v_damage*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*v_hitcar*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*v_mfail*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*v_mvic*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*v_tail*.rsd", HandleDialog)
+
+RandomDialog:AddGenericHandler("*w_activate*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_aidestroy*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_air*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_answer*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_arrive*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_askfood*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_askride*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_bcrash*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_breakca*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_break*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_burn*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_card*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_carway*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_carbuy*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_char*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_damage*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_dcar*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_dodge*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_doorbell*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_fall*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_foodreply*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_gic*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_goc*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_greeting*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_idle*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_idlereply*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_hitbyc*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_hitp*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_longjump*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_mcrash*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_mfail*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_missa*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_missp*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_mstart*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_mvic*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_newai*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_objectw*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_passed*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_pass*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_ridereply*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_springboard*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_tail*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_time*.rsd", HandleDialog)
+RandomDialog:AddGenericHandler("*w_turbo*.rsd", HandleDialog)
+
+return RandomDialog
\ No newline at end of file
diff --git a/Randomiser/Resources/lib/RCF.lua b/Randomiser/Resources/lib/RCF.lua
new file mode 100644
index 0000000..2b9b05d
--- /dev/null
+++ b/Randomiser/Resources/lib/RCF.lua
@@ -0,0 +1,122 @@
+local assert = assert
+local type = type
+
+local string_byte = string.byte
+local string_find = string.find
+local string_pack = string.pack
+local string_rep = string.rep
+local string_sub = string.sub
+local string_unpack = string.unpack
+
+RCF = {}
+local RadCoreSignature = "RADCORE CEMENT LIBRARY" .. string.rep("\0", 10)
+local ATGCoreSignature = "ATG CORE CEMENT LIBRARY" .. string.rep("\0", 9) -- Unused by SHAR, unsupported
+
+local SupportedMajorVersion = 1
+local SupportedMinorVersion = 2
+
+local function radMakeCaseInsensitiveKey32(pToken, keyValue)
+	keyValue = keyValue or 0
+	
+	local chars = {string_byte(pToken, 1, #pToken)}
+	local c
+	for i=1,#pToken do
+		local c = chars[i]
+		if c < 97 then
+			c = c + 32
+		end
+		keyValue = ((keyValue << 5) - keyValue + c) & 0xFFFFFFFF
+	end
+	
+	return keyValue
+end
+
+local function NullTerminate(str)
+	if str == nil then return nil end
+	local strLen = #str
+	if strLen == 0 then return str end
+	local null = string_find(str, "\0", 1, true)
+	if null == nil then return str end
+	return string_sub(str, 1, null-1)
+end
+
+RCF.RCFFile = setmetatable({}, {
+	__call = function(self, Path)
+		if Path == nil then
+			local Data = {
+				BigEndian = 0,
+				Alignment = 2048,
+				PadNetSize = 0,
+				HashedFileEntriesPointer = 0,
+				HashedFileEntriesPointer = 0,
+				Files = {}
+			}
+			
+			self.__index = self
+			return setmetatable(Data, self)
+		end
+		assert(type(Path) == "string", "Arg #1 (Path) must be a string.")
+		assert(Exists(Path, true, false), "Arg #1 (Path) must be a valid filepath.")
+		
+		local contents = ReadFile(Path)
+		
+		local Data = {}
+		
+		local signature, pos = string_unpack("<c32", contents)
+		assert(signature == RadCoreSignature, "Unknown signature: " .. signature)
+		
+		Data.VersionMajor, Data.VersionMinor, Data.BigEndian, Data.Valid, pos = string_unpack("<BBBB", contents, pos)
+		assert(Data.VersionMajor == SupportedMajorVersion, "Unsupported major version: " .. Data.VersionMajor)
+		assert(Data.VersionMinor == SupportedMinorVersion, "Unsupported minor version: " .. Data.VersionMajor)
+		assert(Data.Valid ~= 0, "File marked as invalid.")
+		local endian = Data.BigEndian ~= 0 and ">" or "<"
+		
+		local headerStartPos
+		Data.Alignment, Data.PadNetSize, headerStartPos, pos = string_unpack(endian .. "III", contents, pos)
+		
+		local numFiles, detailedFileInfoStartPos, firstFileStartPos, hashedFileEntriesPointer, pos = string_unpack(endian .. "III<I", contents, headerStartPos + 1)
+		Data.HashedFileEntriesPointer = hashedFileEntriesPointer
+		
+		local files = {}
+		local fileHashMap = {}
+		Data.Files = files
+		
+		for i=1,numFiles do
+			local file = {}
+			files[i] = file
+			file.Hash, file.Position, file.Size, pos = string_unpack(endian .. "III", contents, pos)
+			fileHashMap[file.Hash] = i
+		end
+		
+		local numEntries, nameEntriesPointer, pos = string_unpack(endian .. "I<I", contents, detailedFileInfoStartPos + 1)
+		assert(numFiles == numEntries, "Detail file info count differs from file count.")
+		Data.NameEntriesPointer = nameEntriesPointer
+		
+		local name, timestamp
+		for i=1,numFiles do
+			name, timestamp, pos = string_unpack(endian .. "s4I", contents, pos)
+			name = NullTerminate(name)
+			
+			local file = files[fileHashMap[radMakeCaseInsensitiveKey32(name)]]
+			file.Name = name
+			file.Timestamp = timestamp
+		end
+		
+		for i=1,numFiles do
+			local file = files[i]
+			
+			file.Hash = nil
+			file.Data = string_sub(contents, file.Position + 1, file.Position + file.Size)
+			
+			file.Position = nil
+			file.Size = nil
+		end
+		
+		self.__index = self
+		return setmetatable(Data, self)
+	end,
+})
+
+function RCF.RCFFile:__tostring()
+	error("Writing RCF files not currently supported")
+end
\ No newline at end of file