/// <summary>
/// Applies the given filename patch to the in-memory RomData
/// </summary>
/// <param name="filename"></param>
/// <returns>SHA256 hash of the patch.</returns>
public static byte[] ApplyPatch(string filename)
{
var hashAlg = new SHA256Managed();
using (var filestream = File.OpenRead(filename))
using (var cryptoStream = new CryptoStream(filestream, hashAlg, CryptoStreamMode.Read))
using (var decompressStream = new GZipStream(cryptoStream, CompressionMode.Decompress))
using (var memoryStream = new MemoryStream())
{
decompressStream.CopyTo(memoryStream);
memoryStream.Seek(0, SeekOrigin.Begin);
using (var reader = new BinaryReader(memoryStream))
{
var magic = ReadWriteUtils.ReadU32(reader);
var version = ReadWriteUtils.ReadU32(reader);
// Validate patch magic and version values
PatchUtils.Validate(magic, version);
while (reader.BaseStream.Position != reader.BaseStream.Length)
{
var fileIndex = ReadWriteUtils.ReadS32(reader);
var fileAddr = ReadWriteUtils.ReadS32(reader);
var index = ReadWriteUtils.ReadS32(reader);
var isStatic = ReadWriteUtils.ReadS32(reader) != 0 ? true : false;
var length = ReadWriteUtils.ReadS32(reader);
var data = reader.ReadBytes(length);
if (fileIndex >= RomData.MMFileList.Count)
{
var newFile = new MMFile
{
Addr = fileAddr,
IsCompressed = false,
Data = data,
End = fileAddr + data.Length,
IsStatic = isStatic,
};
RomUtils.AppendFile(newFile);
}
if (index == -1)
{
RomData.MMFileList[fileIndex].Data = data;
if (data.Length == 0)
{
RomData.MMFileList[fileIndex].Cmp_Addr = -1;
RomData.MMFileList[fileIndex].Cmp_End = -1;
}
}
else
{
CheckCompressed(fileIndex);
ReadWriteUtils.Arr_Insert(data, 0, data.Length, RomData.MMFileList[fileIndex].Data, index);
}
}
}
return(hashAlg.Hash);
}
}
public static int AddNewFile(string path, string filename)
{
byte[] buffer;
using (BinaryReader data = new BinaryReader(File.OpenRead(Path.Combine(path, filename))))
{
int len = (int)data.BaseStream.Length;
buffer = new byte[len];
data.Read(buffer, 0, len);
}
int index = RomUtils.AppendFile(buffer);
return(RomData.MMFileList[index].Addr);
}
public static void WriteNewSoundSamples(List <InstrumentSetInfo> InstrumentSetList)
{
/// Writing all of our new samples in a single file at the end
// in the event we run out of MMFile DMA indexes: These files dont need to be a hard file in the filesystem
// they can be placed anywhere after the soundbank starting address on rom, instrument sample lookup doesnt use file system
// adding to the file system is just useful for shifting in BuildROM()
// issue: we don't know right now where the samples will be written to, because BuildRom will shift the files
// for now we write samples, after audiobank/soundbank/samples are written, we'll update audiobank pointers
// save extra soundsamples fid, and the samples with their data, for later (UpdateBankInstrumentPointers())
int fid = RomData.SamplesFileID = RomUtils.AppendFile(new byte[0x0]);
RomData.ListOfSamples = new List <SequenceSoundSampleBinaryData>();
// for each custom instrument set that needs a custom sample
foreach (InstrumentSetInfo instrumentSet in InstrumentSetList)
{
if (instrumentSet.InstrumentSamples != null && instrumentSet.InstrumentSamples.Count > 0)
{
foreach (SequenceSoundSampleBinaryData sample in instrumentSet.InstrumentSamples)
{
// test if sample was already added by another song (OOT instruments for instance)
var previouslyWrittenSample = RomData.ListOfSamples.Find(u => sample.Hash == u.Hash);
if (previouslyWrittenSample == null) // if sample not already written once before
{
// get the rom addr of our new file, our file will start at the end of the last file
sample.Addr = (uint)RomData.MMFileList[fid].Data.Length;
// concat our sample to sample collection file
RomData.MMFileList[fid].Data = RomData.MMFileList[fid].Data.Concat(sample.BinaryData).ToArray();
// I don't know if samples need to be padded to 0x10 like sequences but might as well
int paddingRemainder = RomData.MMFileList[fid].Data.Length % 0x10;
if (paddingRemainder > 0)
{
RomData.MMFileList[fid].Data = RomData.MMFileList[fid].Data.Concat(new byte[paddingRemainder]).ToArray();
}
RomData.ListOfSamples.Add(sample);
}
else // get address of previously used sample
{
sample.Addr = previouslyWrittenSample.Addr;
}
}
}
}
}
// gets passed RomData.SequenceList in Builder.cs::WriteAudioSeq
public static void RebuildAudioSeq(List <SequenceInfo> SequenceList, OutputSettings _settings)
{
// spoiler log output DEBUG
StringBuilder log = new StringBuilder();
void WriteOutput(string str)
{
Debug.WriteLine(str); // we still want debug output though
log.AppendLine(str);
}
List <MMSequence> OldSeq = new List <MMSequence>();
int f = RomUtils.GetFileIndexForWriting(Addresses.SeqTable);
int basea = RomData.MMFileList[f].Addr;
for (int i = 0; i < 128; i++)
{
MMSequence entry = new MMSequence();
if (i == 0x1E) // intro music when link gets ambushed
{
entry.Addr = 2;
OldSeq.Add(entry);
continue;
}
int entryaddr = Addresses.SeqTable + (i * 16);
entry.Addr = (int)ReadWriteUtils.Arr_ReadU32(RomData.MMFileList[f].Data, entryaddr - basea);
var size = (int)ReadWriteUtils.Arr_ReadU32(RomData.MMFileList[f].Data, (entryaddr - basea) + 4);
if (size > 0)
{
entry.Data = new byte[size];
Array.Copy(RomData.MMFileList[4].Data, entry.Addr, entry.Data, 0, entry.Size);
}
else
{
int j = SequenceList.FindIndex(u => u.Replaces == i);
if (j != -1)
{
if ((entry.Addr > 0) && (entry.Addr < 128))
{
if (SequenceList[j].Replaces != 0x28) // 28 (fairy fountain)
{
SequenceList[j].Replaces = entry.Addr;
}
else
{
entry.Data = OldSeq[0x18].Data;
}
}
}
}
OldSeq.Add(entry);
}
List <MMSequence> NewSeq = new List <MMSequence>();
int addr = 0;
byte[] NewAudioSeq = new byte[0];
for (int i = 0; i < 128; i++)
{
MMSequence newentry = new MMSequence();
if (OldSeq[i].Size == 0)
{
newentry.Addr = OldSeq[i].Addr;
}
else
{
newentry.Addr = addr;
}
if (SequenceList.FindAll(u => u.Replaces == i).Count > 1)
{
WriteOutput("Error: Slot " + i.ToString("X") + " has multiple songs pointing at it!");
}
int p = RomData.PointerizedSequences.FindIndex(u => u.PreviousSlot == i);
int j = SequenceList.FindIndex(u => u.Replaces == i);
if (p != -1)
{
// found song we want to pointerize
newentry.Addr = RomData.PointerizedSequences[p].Replaces;
}
else if (j != -1)
{
// new song to replace old slot found
if (SequenceList[j].MM_seq != -1)
{
newentry.Data = OldSeq[SequenceList[j].MM_seq].Data;
WriteOutput("Slot " + i.ToString("X2") + " -> " + SequenceList[j].Name);
}
else if (SequenceList[j].SequenceBinaryList != null && SequenceList[j].SequenceBinaryList.Count > 0)
{
if (SequenceList[j].SequenceBinaryList.Count > 1)
{
WriteOutput("Warning: writing song with multiple sequence/bank combos, selecting first available");
}
newentry.Data = SequenceList[j].SequenceBinaryList[0].SequenceBinary;
WriteOutput("Slot " + i.ToString("X2") + " := " + SequenceList[j].Name + " *");
}
else // non mm, load file and add
{
byte[] data;
if (File.Exists(SequenceList[j].Filename))
{
using (var reader = new BinaryReader(File.OpenRead(SequenceList[j].Filename)))
{
data = new byte[(int)reader.BaseStream.Length];
reader.Read(data, 0, data.Length);
}
}
else if (SequenceList[j].Name == nameof(Properties.Resources.mmr_f_sot))
{
data = Properties.Resources.mmr_f_sot;
}
else
{
throw new Exception("Music not found as file or built-in resource." + SequenceList[j].Filename);
}
// I think this checks if the sequence type is correct for MM
// because DB ripped sequences from SF64/SM64/MK64 without modifying them
if (data[1] != 0x20)
{
data[1] = 0x20;
}
newentry.Data = data;
WriteOutput("Slot " + i.ToString("X2") + " := " + SequenceList[j].Name);
}
}
else // not found, song wasn't touched by rando, just transfer over
{
newentry.Data = OldSeq[i].Data;
}
// if the sequence is not padded to 16 bytes, the DMA fails
// music can stop from playing and on hardware it will just straight crash
var Padding = 0x10 - newentry.Size % 0x10;
if (Padding != 0x10)
{
newentry.Data = newentry.Data.Concat(new byte[Padding]).ToArray();
}
NewSeq.Add(newentry);
// TODO is there not a better way to write this?
if (newentry.Data != null)
{
NewAudioSeq = NewAudioSeq.Concat(newentry.Data).ToArray();
}
addr += newentry.Size;
}
// discovered when MM-only music was fixed, if the audioseq is left in it's old spot
// audio quality is garbage, sounds like static
//if (addr > (RomData.MMFileList[4].End - RomData.MMFileList[4].Addr))
//else
//RomData.MMFileList[4].Data = NewAudioSeq;
int index = RomUtils.AppendFile(NewAudioSeq);
ResourceUtils.ApplyHack(Values.ModsDirectory, "reloc-audio");
RelocateSeq(index);
RomData.MMFileList[4].Data = new byte[0];
RomData.MMFileList[4].Cmp_Addr = -1;
RomData.MMFileList[4].Cmp_End = -1;
//update sequence index pointer table
f = RomUtils.GetFileIndexForWriting(Addresses.SeqTable);
for (int i = 0; i < 128; i++)
{
ReadWriteUtils.Arr_WriteU32(RomData.MMFileList[f].Data, (Addresses.SeqTable + (i * 16)) - basea, (uint)NewSeq[i].Addr);
ReadWriteUtils.Arr_WriteU32(RomData.MMFileList[f].Data, 4 + (Addresses.SeqTable + (i * 16)) - basea, (uint)NewSeq[i].Size);
}
//update inst sets used by each new seq
// this is NOT the audiobank, its the complementary instrument set value for each sequence
// IE, sequence 7 uses instrument set "10", we replaced it with sequnece ae which needs bank "23"
f = RomUtils.GetFileIndexForWriting(Addresses.InstSetMap);
basea = RomData.MMFileList[f].Addr;
for (int i = 0; i < 128; i++)
{
// huh? paddr? pointer? padding?
int paddr = (Addresses.InstSetMap - basea) + (i * 2) + 2;
int j = -1;
if (NewSeq[i].Size == 0) // pointer, we need to copy the instrumnet set from the destination
{
j = SequenceList.FindIndex(u => u.Replaces == NewSeq[i].Addr);
}
else
{
j = SequenceList.FindIndex(u => u.Replaces == i);
}
if (j != -1)
{
RomData.MMFileList[f].Data[paddr] = (byte)SequenceList[j].Instrument;
}
}
//// DEBUG spoiler log output
//String dir = Path.GetDirectoryName(_settings.OutputROMFilename);
//String path = $"{Path.GetFileNameWithoutExtension(_settings.OutputROMFilename)}";
//// spoiler log should already be written by the time we reach this far
//if (File.Exists(Path.Combine(dir, path + "_SpoilerLog.txt")))
// path += "_SpoilerLog.txt";
//else // TODO add HTML log compatibility
// path += "_SongLog.txt";
//using (StreamWriter sw = new StreamWriter(Path.Combine(dir, path), append: true))
//{
// sw.WriteLine(""); // spacer
// sw.Write(log);
//}
}
public static int AddNewFile(byte[] content)
{
int index = RomUtils.AppendFile(content);
return(RomData.MMFileList[index].Addr);
}
