mirror of
https://github.com/soarqin/DSP_Mods.git
synced 2026-03-28 20:17:14 +08:00
Add CompressSave, with Chinese instructions in READMEs
This commit is contained in:
234
CompressSave/CompressSave.cs
Normal file
234
CompressSave/CompressSave.cs
Normal file
@@ -0,0 +1,234 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Reflection.Emit;
|
||||
using BepInEx;
|
||||
using HarmonyLib;
|
||||
using CompressSave.LZ4Wrap;
|
||||
|
||||
namespace CompressSave;
|
||||
|
||||
[BepInPlugin(PluginInfo.PLUGIN_GUID, PluginInfo.PLUGIN_NAME, PluginInfo.PLUGIN_VERSION)]
|
||||
public class CompressSave : BaseUnityPlugin
|
||||
{
|
||||
public void Awake()
|
||||
{
|
||||
SaveUtil.logger = Logger;
|
||||
if (LZ4API.Avaliable)
|
||||
{
|
||||
if (GameConfig.gameVersion != SaveUtil.VerifiedVersion)
|
||||
{
|
||||
SaveUtil.logger.LogWarning($"Save version mismatch. Expect:{SaveUtil.VerifiedVersion}, Current:{GameConfig.gameVersion}. MOD may not work as expected.");
|
||||
}
|
||||
Harmony.CreateAndPatchAll(typeof(PatchSave));
|
||||
if (PatchSave.EnableCompress)
|
||||
Harmony.CreateAndPatchAll(typeof(PatchUISaveGame));
|
||||
Harmony.CreateAndPatchAll(typeof(PatchUILoadGame));
|
||||
}
|
||||
else
|
||||
SaveUtil.logger.LogWarning("LZ4.dll is not avaliable.");
|
||||
}
|
||||
|
||||
public void OnDestroy()
|
||||
{
|
||||
PatchUISaveGame.OnDestroy();
|
||||
PatchUILoadGame.OnDestroy();
|
||||
Harmony.UnpatchAll();
|
||||
}
|
||||
}
|
||||
|
||||
class PatchSave
|
||||
{
|
||||
const long MB = 1024 * 1024;
|
||||
static LZ4CompressionStream.CompressBuffer compressBuffer = LZ4CompressionStream.CreateBuffer((int)MB); //Bigger buffer for GS2 compatible
|
||||
public static bool UseCompressSave = false;
|
||||
public static bool IsCompressedSave;
|
||||
static Stream lzstream = null;
|
||||
public static bool EnableCompress;
|
||||
public static bool EnableDecompress;
|
||||
|
||||
private static void WriteHeader(FileStream fileStream)
|
||||
{
|
||||
for (int i = 0; i < 4; i++)
|
||||
fileStream.WriteByte(0xCC);
|
||||
}
|
||||
|
||||
[HarmonyPrefix]
|
||||
[HarmonyPatch(typeof(GameSave), "AutoSave")]
|
||||
[HarmonyPatch(typeof(GameSave), "SaveAsLastExit")]
|
||||
static void BeforeAutoSave()
|
||||
{
|
||||
UseCompressSave = EnableCompress;
|
||||
}
|
||||
|
||||
[HarmonyTranspiler]
|
||||
[HarmonyPatch(typeof(GameSave), "SaveCurrentGame")]
|
||||
static IEnumerable<CodeInstruction> SaveCurrentGame_Transpiler(IEnumerable<CodeInstruction> instructions, ILGenerator generator)
|
||||
{
|
||||
/* BinaryWriter binaryWriter = new BinaryWriter(fileStream); => Create lzstream and replace binaryWriter.
|
||||
* set PerformanceMonitor.BeginStream to lzstream.
|
||||
* fileStream.Seek(6L, SeekOrigin.Begin); binaryWriter.Write(position); => Disable seek&write function.
|
||||
* binaryWriter.Dispose(); => Dispose lzstream before fileStream close.
|
||||
*/
|
||||
try
|
||||
{
|
||||
var matcher = new CodeMatcher(instructions, generator)
|
||||
.MatchForward(false, new CodeMatch(OpCodes.Newobj, AccessTools.Constructor(typeof(BinaryWriter), new Type[] { typeof(FileStream) })))
|
||||
.Set(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "CreateBinaryWriter"))
|
||||
.MatchForward(false, new CodeMatch(OpCodes.Call, AccessTools.Method(typeof(PerformanceMonitor), "BeginStream")))
|
||||
.Set(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "MonitorStream"))
|
||||
.MatchForward(false, new CodeMatch(OpCodes.Callvirt, AccessTools.Method(typeof(System.IO.Stream), "Seek")))
|
||||
.Set(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "FileLengthWrite0"))
|
||||
.MatchForward(false, new CodeMatch(OpCodes.Callvirt, AccessTools.Method(typeof(BinaryWriter), "Write", new Type[] { typeof(long) })))
|
||||
.Set(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "FileLengthWrite1"))
|
||||
.MatchForward(false, new CodeMatch(OpCodes.Callvirt, AccessTools.Method(typeof(System.IDisposable), "Dispose")))
|
||||
.Advance(1)
|
||||
.Insert(new CodeInstruction(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "DisposeLzstream")));
|
||||
EnableCompress = true;
|
||||
return matcher.InstructionEnumeration();
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
SaveUtil.logger.LogError("SaveCurrentGame_Transpiler failed. Mod version not compatible with game version.");
|
||||
SaveUtil.logger.LogError(ex);
|
||||
}
|
||||
return instructions;
|
||||
}
|
||||
|
||||
public static void MonitorStream(Stream fileStream)
|
||||
{
|
||||
PerformanceMonitor.BeginStream(UseCompressSave ? lzstream : fileStream);
|
||||
}
|
||||
|
||||
public static BinaryWriter CreateBinaryWriter(FileStream fileStream)
|
||||
{
|
||||
if (UseCompressSave)
|
||||
{
|
||||
SaveUtil.logger.LogDebug("Begin compress save");
|
||||
WriteHeader(fileStream);
|
||||
lzstream = new LZ4CompressionStream(fileStream, compressBuffer, true); //need to dispose after use
|
||||
return ((LZ4CompressionStream)lzstream).BufferWriter;
|
||||
}
|
||||
SaveUtil.logger.LogDebug("Begin normal save");
|
||||
return new BinaryWriter(fileStream);
|
||||
}
|
||||
|
||||
public static long FileLengthWrite0(FileStream fileStream, long offset, SeekOrigin origin)
|
||||
{
|
||||
if (!UseCompressSave)
|
||||
return fileStream.Seek(offset, origin);
|
||||
return 0L;
|
||||
}
|
||||
|
||||
public static void FileLengthWrite1(BinaryWriter binaryWriter, long value)
|
||||
{
|
||||
if (!UseCompressSave)
|
||||
binaryWriter.Write(value);
|
||||
}
|
||||
|
||||
public static void DisposeLzstream()
|
||||
{
|
||||
if (!UseCompressSave) return;
|
||||
var writeflag = lzstream.CanWrite;
|
||||
lzstream?.Dispose(); //Dispose need to be done before fstream closed.
|
||||
lzstream = null;
|
||||
if (writeflag) //Reset UseCompressSave after writing to file
|
||||
UseCompressSave = false;
|
||||
}
|
||||
|
||||
|
||||
[HarmonyTranspiler]
|
||||
[HarmonyPatch(typeof(GameSave), "LoadCurrentGame")]
|
||||
[HarmonyPatch(typeof(GameSave), "LoadGameDesc")]
|
||||
[HarmonyPatch(typeof(GameSave), "ReadHeader")]
|
||||
[HarmonyPatch(typeof(GameSave), "ReadHeaderAndDescAndProperty")]
|
||||
static IEnumerable<CodeInstruction> LoadCurrentGame_Transpiler(IEnumerable<CodeInstruction> instructions, ILGenerator iLGenerator)
|
||||
{
|
||||
/* using (BinaryReader binaryReader = new BinaryReader(fileStream)) => Create lzstream and replace binaryReader.
|
||||
* set PerformanceMonitor.BeginStream to lzstream.
|
||||
* if (fileStream.Length != binaryReader.ReadInt64()) => Replace binaryReader.ReadInt64() to pass file length check.
|
||||
* fileStream.Seek((long)num2, SeekOrigin.Current); => Use lzstream.Read to seek forward
|
||||
* binaryReader.Dispose(); => Dispose lzstream before fileStream close.
|
||||
*/
|
||||
try
|
||||
{
|
||||
var matcher = new CodeMatcher(instructions, iLGenerator)
|
||||
.MatchForward(false, new CodeMatch(OpCodes.Newobj, AccessTools.Constructor(typeof(BinaryReader), new Type[] { typeof(FileStream) })))
|
||||
.Set(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "CreateBinaryReader"))
|
||||
.MatchForward(false, new CodeMatch(OpCodes.Call, AccessTools.Method(typeof(PerformanceMonitor), "BeginStream")));
|
||||
|
||||
if (matcher.IsValid)
|
||||
matcher.Set(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "MonitorStream"));
|
||||
|
||||
matcher.Start().MatchForward(false, new CodeMatch(OpCodes.Callvirt, AccessTools.Method(typeof(BinaryReader), "ReadInt64")))
|
||||
.Set(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "FileLengthRead"))
|
||||
.MatchForward(false, new CodeMatch(OpCodes.Callvirt, AccessTools.Method(typeof(System.IDisposable), "Dispose")))
|
||||
.Advance(1)
|
||||
.Insert(new CodeInstruction(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "DisposeLzstream")))
|
||||
.MatchBack(false, new CodeMatch(OpCodes.Callvirt, AccessTools.Method(typeof(System.IO.Stream), "Seek")));
|
||||
if (matcher.IsValid)
|
||||
matcher.Set(OpCodes.Call, AccessTools.Method(typeof(PatchSave), "ReadSeek"));
|
||||
matcher.Start()
|
||||
.MatchForward(false, new CodeMatch(OpCodes.Newobj, AccessTools.Constructor(typeof(GameSaveHeader))));
|
||||
if (matcher.IsValid)
|
||||
matcher.Set(OpCodes.Newobj, AccessTools.Constructor(typeof(CompressionGameSaveHeader))); //ReadHeader
|
||||
|
||||
EnableDecompress = true;
|
||||
return matcher.InstructionEnumeration();
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
SaveUtil.logger.LogError("LoadCurrentGame_Transpiler failed. Mod version not compatible with game version.");
|
||||
SaveUtil.logger.LogError(ex);
|
||||
}
|
||||
return instructions;
|
||||
}
|
||||
|
||||
[HarmonyPostfix]
|
||||
[HarmonyPatch(typeof(GameSave), "ReadHeader")]
|
||||
[HarmonyPatch(typeof(GameSave), "ReadHeaderAndDescAndProperty")]
|
||||
static void ReadHeader_Postfix(ref GameSaveHeader header)
|
||||
{
|
||||
if (header != null)
|
||||
((CompressionGameSaveHeader)header).IsCompressed = IsCompressedSave;
|
||||
}
|
||||
|
||||
public static BinaryReader CreateBinaryReader(FileStream fileStream)
|
||||
{
|
||||
if ((IsCompressedSave = SaveUtil.IsCompressedSave(fileStream)))
|
||||
{
|
||||
UseCompressSave = true;
|
||||
lzstream = new LZ4DecompressionStream(fileStream);
|
||||
return new PeekableReader((LZ4DecompressionStream)lzstream);
|
||||
}
|
||||
else
|
||||
{
|
||||
UseCompressSave = false;
|
||||
fileStream.Seek(0, SeekOrigin.Begin);
|
||||
return new BinaryReader(fileStream);
|
||||
}
|
||||
}
|
||||
|
||||
public static long FileLengthRead(BinaryReader binaryReader)
|
||||
{
|
||||
if (UseCompressSave)
|
||||
{
|
||||
binaryReader.ReadInt64();
|
||||
return lzstream.Length;
|
||||
}
|
||||
else
|
||||
return binaryReader.ReadInt64();
|
||||
}
|
||||
|
||||
public static long ReadSeek(FileStream fileStream, long offset, SeekOrigin origin)
|
||||
{
|
||||
if (UseCompressSave)
|
||||
{
|
||||
while (offset > 0)
|
||||
offset -= lzstream.Read(compressBuffer.outBuffer, 0, (int)offset);
|
||||
return lzstream.Position;
|
||||
}
|
||||
else
|
||||
return fileStream.Seek(offset, origin);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user