Chara file data export (#38)

* add rudimentary saving of chara file data

* fix building

* working prototype for MCDF import and application

* adjust code to use streams

* rename cache -> storage
add ui for import/export mcdf

* minor wording adjustments, version bump

Co-authored-by: rootdarkarchon <root.darkarchon@outlook.com>
Co-authored-by: Stanley Dimant <stanley.dimant@varian.com>
This commit is contained in:
rootdarkarchon
2023-01-23 12:56:43 +01:00
committed by GitHub
parent 1c95a6d40e
commit 7a8655f6b1
15 changed files with 664 additions and 51 deletions

View File

@@ -0,0 +1,65 @@
using MareSynchronos.API;
using MareSynchronos.FileCache;
using Newtonsoft.Json;
using System.Collections.Generic;
using System.IO;
using System.Text;
namespace MareSynchronos.Export;
public record MareCharaFileData
{
public string Description { get; set; } = string.Empty;
public string GlamourerData { get; set; } = string.Empty;
public string CustomizePlusData { get; set; } = string.Empty;
public string ManipulationData { get; set; } = string.Empty;
public List<FileData> Files { get; set; } = new();
public List<FileSwap> FileSwaps { get; set; } = new();
public MareCharaFileData() { }
public MareCharaFileData(FileCacheManager manager, string description, CharacterCacheDto dto)
{
Description = description;
if (dto.GlamourerData.TryGetValue(ObjectKind.Player, out var glamourerData))
{
GlamourerData = glamourerData;
}
CustomizePlusData = dto.CustomizePlusData;
ManipulationData = dto.ManipulationData;
if (dto.FileReplacements.TryGetValue(ObjectKind.Player, out var fileReplacements))
{
foreach (var file in fileReplacements)
{
if (!string.IsNullOrEmpty(file.FileSwapPath))
{
FileSwaps.Add(new FileSwap(file.GamePaths, file.FileSwapPath));
}
else
{
var filePath = manager.GetFileCacheByHash(file.Hash)?.ResolvedFilepath;
if (filePath != null)
{
Files.Add(new FileData(file.GamePaths, new FileInfo(filePath).Length));
}
}
}
}
}
public byte[] ToByteArray()
{
return Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(this));
}
public static MareCharaFileData FromByteArray(byte[] data)
{
return JsonConvert.DeserializeObject<MareCharaFileData>(Encoding.UTF8.GetString(data))!;
}
public record FileSwap(IEnumerable<string> GamePaths, string FileSwapPath);
public record FileData(IEnumerable<string> GamePaths, long Length);
}

View File

@@ -0,0 +1,19 @@
using MareSynchronos.API;
using MareSynchronos.FileCache;
namespace MareSynchronos.Export;
internal class MareCharaFileDataFactory
{
private readonly FileCacheManager _fileCacheManager;
public MareCharaFileDataFactory(FileCacheManager fileCacheManager)
{
_fileCacheManager = fileCacheManager;
}
public MareCharaFileData Create(string description, CharacterCacheDto characterCacheDto)
{
return new MareCharaFileData(_fileCacheManager, description, characterCacheDto);
}
}

View File

@@ -0,0 +1,57 @@
using Lumina.Extensions;
using System.Collections.Generic;
using System.IO;
using System.Runtime.CompilerServices;
namespace MareSynchronos.Export;
public record MareCharaFileHeader(byte Version, MareCharaFileData CharaFileData)
{
public static readonly byte CurrentVersion = 1;
public byte Version { get; set; } = Version;
public MareCharaFileData CharaFileData { get; set; } = CharaFileData;
public string FilePath { get; private set; }
public void WriteToStream(BinaryWriter writer)
{
writer.Write('M');
writer.Write('C');
writer.Write('D');
writer.Write('F');
writer.Write(Version);
var charaFileDataArray = CharaFileData.ToByteArray();
writer.Write(charaFileDataArray.Length);
writer.Write(charaFileDataArray);
}
public static MareCharaFileHeader? FromBinaryReader(string path, BinaryReader reader)
{
var chars = new string(reader.ReadChars(4));
if (!string.Equals(chars, "MCDF", System.StringComparison.Ordinal)) throw new System.Exception("Not a Mare Chara File");
MareCharaFileHeader? decoded = null;
var version = reader.ReadByte();
if (version == 1)
{
var dataLength = reader.ReadInt32();
decoded = new(version, MareCharaFileData.FromByteArray(reader.ReadBytes(dataLength)));
decoded.FilePath = path;
}
return decoded;
}
public void AdvanceReaderToData(BinaryReader reader)
{
reader.ReadChars(4);
var version = reader.ReadByte();
if (version == 1)
{
var length = reader.ReadInt32();
_ = reader.ReadBytes(length);
}
}
}

View File

@@ -0,0 +1,163 @@
using System.Linq;
using Dalamud.Game.ClientState.Objects.Types;
using LZ4;
using MareSynchronos.API;
using MareSynchronos.FileCache;
using MareSynchronos.Managers;
using MareSynchronos.Utils;
using System;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
namespace MareSynchronos.Export;
public class MareCharaFileManager
{
private readonly FileCacheManager _manager;
private readonly IpcManager _ipcManager;
private readonly DalamudUtil _dalamudUtil;
private readonly MareCharaFileDataFactory _factory;
public MareCharaFileHeader? LoadedCharaFile { get; private set; }
public bool CurrentlyWorking { get; private set; } = false;
public MareCharaFileManager(FileCacheManager manager, IpcManager ipcManager, DalamudUtil dalamudUtil)
{
_factory = new(manager);
_manager = manager;
_ipcManager = ipcManager;
_dalamudUtil = dalamudUtil;
}
public void ClearMareCharaFile()
{
LoadedCharaFile = null;
}
public void LoadMareCharaFile(string filePath)
{
CurrentlyWorking = true;
try
{
using var unwrapped = File.OpenRead(filePath);
using var lz4Stream = new LZ4Stream(unwrapped, LZ4StreamMode.Decompress, LZ4StreamFlags.HighCompression);
using var reader = new BinaryReader(lz4Stream);
LoadedCharaFile = MareCharaFileHeader.FromBinaryReader(filePath, reader);
Logger.Debug("Read Mare Chara File");
Logger.Debug("Version: " + LoadedCharaFile.Version);
}
catch { throw; }
finally { CurrentlyWorking = false; }
}
public async Task ApplyMareCharaFile(GameObject charaTarget)
{
Dictionary<string, string> extractedFiles = new();
CurrentlyWorking = true;
try
{
if (LoadedCharaFile == null || charaTarget == null || !File.Exists(LoadedCharaFile.FilePath)) return;
using var unwrapped = File.OpenRead(LoadedCharaFile.FilePath);
using var lz4Stream = new LZ4Stream(unwrapped, LZ4StreamMode.Decompress, LZ4StreamFlags.HighCompression);
using var reader = new BinaryReader(lz4Stream);
LoadedCharaFile.AdvanceReaderToData(reader);
Logger.Debug("Applying to " + charaTarget.Name.TextValue);
extractedFiles = ExtractFilesFromCharaFile(LoadedCharaFile, reader);
Dictionary<string, string> fileSwaps = new(StringComparer.Ordinal);
foreach (var fileSwap in LoadedCharaFile.CharaFileData.FileSwaps)
{
foreach (var path in fileSwap.GamePaths)
{
fileSwaps.Add(path, fileSwap.FileSwapPath);
}
}
_ipcManager.ToggleGposeQueueMode(true);
_ipcManager.PenumbraRemoveTemporaryCollection(charaTarget.Name.TextValue);
_ipcManager.PenumbraSetTemporaryMods(charaTarget.Name.TextValue,
extractedFiles.Union(fileSwaps).ToDictionary(d => d.Key, d => d.Value, StringComparer.Ordinal),
LoadedCharaFile.CharaFileData.ManipulationData);
_ipcManager.GlamourerApplyAll(LoadedCharaFile.CharaFileData.GlamourerData, charaTarget.Address);
_dalamudUtil.WaitWhileGposeCharacterIsDrawing(charaTarget.Address);
_ipcManager.PenumbraRemoveTemporaryCollection(charaTarget.Name.TextValue);
_ipcManager.ToggleGposeQueueMode(false);
}
catch { throw; }
finally
{
CurrentlyWorking = false;
Logger.Debug("Clearing local files");
foreach (var file in extractedFiles)
{
File.Delete(file.Value);
}
}
}
private Dictionary<string, string> ExtractFilesFromCharaFile(MareCharaFileHeader charaFileHeader, BinaryReader reader)
{
Dictionary<string, string> gamePathToFilePath = new(StringComparer.Ordinal);
int i = 0;
foreach (var fileData in charaFileHeader.CharaFileData.Files)
{
var fileName = Path.Combine(Path.GetTempPath(), "mare_" + (i++) + ".tmp");
var length = fileData.Length;
var bufferSize = 4 * 1024 * 1024;
var buffer = new byte[bufferSize];
using var fs = File.OpenWrite(fileName);
using var wr = new BinaryWriter(fs);
while (length > 0)
{
if (length < bufferSize) bufferSize = (int)length;
buffer = reader.ReadBytes(bufferSize);
wr.Write(length > bufferSize ? buffer : buffer.Take((int)length).ToArray());
length -= bufferSize;
}
foreach (var path in fileData.GamePaths)
{
gamePathToFilePath[path] = fileName;
Logger.Verbose(path + " => " + fileName);
}
}
return gamePathToFilePath;
}
public void SaveMareCharaFile(CharacterCacheDto? dto, string description, string filePath)
{
CurrentlyWorking = true;
try
{
if (dto == null) return;
var mareCharaFileData = _factory.Create(description, dto);
MareCharaFileHeader output = new(MareCharaFileHeader.CurrentVersion, mareCharaFileData);
using var fs = new FileStream(filePath, FileMode.Create);
using var lz4 = new LZ4Stream(fs, LZ4StreamMode.Compress, LZ4StreamFlags.HighCompression);
using var writer = new BinaryWriter(lz4);
output.WriteToStream(writer);
var bufferSize = 4 * 1024 * 1024;
byte[] buffer = new byte[bufferSize];
if (dto.FileReplacements.TryGetValue(ObjectKind.Player, out var replacement))
{
foreach (var file in replacement.Select(item => _manager.GetFileCacheByHash(item.Hash)).Where(file => file != null))
{
var length = new FileInfo(file.ResolvedFilepath).Length;
using var fsRead = File.OpenRead(file.ResolvedFilepath);
using var br = new BinaryReader(fsRead);
int readBytes = 0;
while ((readBytes = br.Read(buffer, 0, bufferSize)) > 0)
{
writer.Write(readBytes == bufferSize ? buffer : buffer.Take(readBytes).ToArray());
}
}
}
}
catch { throw; }
finally { CurrentlyWorking = false; }
}
}