universaleditor/editor-legacy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add comments

Browse Source
This commit is contained in:
Michael Becker 2019-12-29 17:14:46 -05:00
parent 389f6a4fa7
commit 57892299c4
No known key found for this signature in database
GPG Key ID: 506F54899E2BFED7
6 changed files with 140 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
CSharp/Plugins/UniversalEditor.Plugins.CRI/DataFormats/Database/UTF/UTFColumnDataType.cs
View File

@ -1,5 +1,5 @@
//
// CPKColumnDataType.cs
// UTFColumnDataType.cs - CRI Middleware UTF table column data types
//
// Author:
// Mike Becker <alcexhim@gmail.com>
@ -21,19 +21,58 @@
using System;
namespace UniversalEditor.Plugins.CRI.DataFormats.Database.UTF
{
/// <summary>
/// The data type for a column in a UTF table.
/// </summary>
public enum UTFColumnDataType : byte
{
/// <summary>
/// Mask value for combining <see cref="UTFColumnDataType" /> with <see cref="UTFColumnStorageType" />.
/// </summary>
Mask = 0x0f,
/// <summary>
/// The column represents a variable-length array of <see cref="System.Byte" /> data.
/// </summary>
Data = 0x0b,
/// <summary>
/// The column represents a variable-length <see cref="System.String" />.
/// </summary>
String = 0x0a,
/// <summary>
/// The column represents a <see cref="System.Single" /> value.
/// </summary>
Float = 0x08,
/// <summary>
/// The column represents a <see cref="System.Int64" /> value. There may or may not be a distinction between signed and unsigned types.
/// </summary>
Long2 = 0x07,
/// <summary>
/// The column represents a <see cref="System.Int64" /> value. There may or may not be a distinction between signed and unsigned types.
/// </summary>
Long = 0x06,
/// <summary>
/// The column represents a <see cref="System.Int32" /> value. There may or may not be a distinction between signed and unsigned types.
/// </summary>
Int2 = 0x05,
/// <summary>
/// The column represents a <see cref="System.Int32" /> value. There may or may not be a distinction between signed and unsigned types.
/// </summary>
Int = 0x04,
/// <summary>
/// The column represents a <see cref="System.Int16" /> value. There may or may not be a distinction between signed and unsigned types.
/// </summary>
Short2 = 0x03,
/// <summary>
/// The column represents a <see cref="System.Int16" /> value. There may or may not be a distinction between signed and unsigned types.
/// </summary>
Short = 0x02,
/// <summary>
/// The column represents a <see cref="System.Byte" /> value. There may or may not be a distinction between signed and unsigned types.
/// </summary>
Byte2 = 0x01,
/// <summary>
/// The column represents a <see cref="System.Byte" /> value. There may or may not be a distinction between signed and unsigned types.
/// </summary>
Byte = 0x00
}
}

17
CSharp/Plugins/UniversalEditor.Plugins.CRI/DataFormats/Database/UTF/UTFColumnStorageType.cs
View File

@ -1,5 +1,5 @@
//
// CPKColumnStorageType.cs
// UTFColumnStorageType.cs - CRI Middleware UTF table column storage types
//
// Author:
// Mike Becker <alcexhim@gmail.com>
@ -21,11 +21,26 @@
using System;
namespace UniversalEditor.Plugins.CRI.DataFormats.Database.UTF
{
/// <summary>
/// The storage type for a column in a UTF table.
/// </summary>
public enum UTFColumnStorageType : byte
{
/// <summary>
/// Mask value for combining <see cref="UTFColumnDataType" /> with <see cref="UTFColumnStorageType" />.
/// </summary>
Mask = 0xf0,
/// <summary>
/// Data in this column is stored per row, with a single value written for each ROW in the table.
/// </summary>
PerRow = 0x50,
/// <summary>
/// Data in this column is constant regardless of row, with a single value written for each COLUMN in the table.
/// </summary>
Constant = 0x30,
/// <summary>
/// Data in this column is declared NULL for all rows in the table. No data is written for this column.
/// </summary>
Zero = 0x10
}
}

30
CSharp/Plugins/UniversalEditor.Plugins.CRI/DataFormats/FileSystem/AFS/AFSDataFormat.cs
View File

@ -25,9 +25,16 @@ using UniversalEditor.ObjectModels.FileSystem;
namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.AFS
{
/// <summary>
/// A <see cref="DataFormat" /> for loading and saving <see cref="FileSystemObjectModel" /> archives in CRI Middleware AFS/AWB/ACB format.
/// </summary>
public class AFSDataFormat : DataFormat
{
private static DataFormatReference _dfr = null;
/// <summary>
/// Creates a <see cref="DataFormatReference" /> containing metadata about the <see cref="AFSDataFormat" />.
/// </summary>
/// <returns>The <see cref="DataFormatReference" /> which contains metadata about the <see cref="AFSDataFormat" />.</returns>
protected override DataFormatReference MakeReferenceInternal()
{
if (_dfr == null)
@ -38,8 +45,17 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.AFS
return _dfr;
}
/// <summary>
/// Gets or sets the version of AFS archive to read or write. Defaults to <see cref="AFSFormatVersion.AFS0" /> ('AFS\0').
/// </summary>
/// <value>The version of AFS archive to read or write.</value>
public AFSFormatVersion FormatVersion { get; set; } = AFSFormatVersion.AFS0;
/// <summary>
/// Reads an AFS format 0 archive (AFS).
/// </summary>
/// <param name="reader">The <see cref="Reader" /> which reads the data.</param>
/// <param name="fsom">The <see cref="FileSystemObjectModel" /> into which to populate archive content.</param>
private void ReadAFS0(IO.Reader reader, FileSystemObjectModel fsom)
{
uint fileCount = reader.ReadUInt32();
@ -83,6 +99,11 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.AFS
}
}
/// <summary>
/// Reads an AFS format 2 archive (AWB/ACB).
/// </summary>
/// <param name="reader">The <see cref="Reader" /> which reads the data.</param>
/// <param name="fsom">The <see cref="FileSystemObjectModel" /> into which to populate archive content.</param>
private void ReadAFS2(IO.Reader reader, FileSystemObjectModel fsom)
{
uint unknown1 = reader.ReadUInt32();
@ -119,6 +140,10 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.AFS
}
}
/// <summary>
/// Loads the <see cref="ObjectModel" /> data from the input <see cref="Accessor" />.
/// </summary>
/// <param name="objectModel">A <see cref="FileSystemObjectModel" /> into which to load archive content.</param>
protected override void LoadInternal(ref ObjectModel objectModel)
{
FileSystemObjectModel fsom = (objectModel as FileSystemObjectModel);
@ -158,7 +183,10 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.AFS
e.Data = Accessor.Reader.ReadBytes(fileinfo.length);
}
/// <summary>
/// Writes the <see cref="ObjectModel" /> data to the output <see cref="Accessor" />.
/// </summary>
/// <param name="objectModel">A <see cref="FileSystemObjectModel" /> containing the archive content to write.</param>
protected override void SaveInternal(ObjectModel objectModel)
{
FileSystemObjectModel fsom = (objectModel as FileSystemObjectModel);

2
CSharp/Plugins/UniversalEditor.Plugins.CRI/DataFormats/FileSystem/AFS/AFSFileInfo.cs
View File

@ -21,7 +21,7 @@
using System;
namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.AFS
{
public struct AFSFileInfo
internal struct AFSFileInfo
{
public string name;
public uint offset;

9
CSharp/Plugins/UniversalEditor.Plugins.CRI/DataFormats/FileSystem/AFS/AFSFormatVersion.cs
View File

@ -21,9 +21,18 @@
using System;
namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.AFS
{
/// <summary>
/// The version of AFS archive being handled by a <see cref="AFSDataFormat" /> instance.
/// </summary>
public enum AFSFormatVersion
{
/// <summary>
/// Older version of AFS, which stores file data and TOC information in the same AFS file.
/// </summary>
AFS0,
/// <summary>
/// Newer version of AFS, which stores file data in an AWB file and writes the TOC to a separate ACB file.
/// </summary>
AFS2
}
}

62
CSharp/Plugins/UniversalEditor.Plugins.CRI/DataFormats/FileSystem/CPK/CPKDataFormat.cs
View File

@ -29,9 +29,16 @@ using UniversalEditor.Plugins.CRI.DataFormats.Database.UTF;
namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
{
/// <summary>
/// A <see cref="DataFormat" /> for loading and saving <see cref="FileSystemObjectModel" /> archives in CRI Middleware CPK format.
/// </summary>
public class CPKDataFormat : DataFormat
{
private static DataFormatReference _dfr = null;
/// <summary>
/// Creates a <see cref="DataFormatReference" /> containing metadata about the <see cref="CPKDataFormat" />.
/// </summary>
/// <returns>The <see cref="DataFormatReference" /> which contains metadata about the <see cref="CPKDataFormat" />.</returns>
protected override DataFormatReference MakeReferenceInternal()
{
if (_dfr == null)
@ -44,8 +51,17 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
return _dfr;
}
/// <summary>
/// Gets or sets the version string which contains information about the library which created the archive. The default value is "CPKMC2.14.00, DLL2.74.00" which is the version string that official CRI Middleware CPK tools use.
/// </summary>
/// <value>The version string.</value>
public string VersionString { get; set; } = "CPKMC2.14.00, DLL2.74.00";
public int FileAlignment { get; set; } = 2048;
/// <summary>
/// Gets or sets the sector alignment, in bytes, of the CPK archive. The default value is 2048.
/// </summary>
/// <value>The file alignment.</value>
public int SectorAlignment { get; set; } = 2048;
// these are mainly for the benefit of the CRI Extensions for FileSystemEditor
@ -84,6 +100,10 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
/// <value>The raw data from the "ETOC" chunk.</value>
public byte[] ETocData { get { return _ETocData; } }
/// <summary>
/// Loads the <see cref="ObjectModel" /> data from the input <see cref="Accessor" />.
/// </summary>
/// <param name="objectModel">A <see cref="FileSystemObjectModel" /> into which to load archive content.</param>
protected override void LoadInternal (ref ObjectModel objectModel)
{
FileSystemObjectModel fsom = (objectModel as FileSystemObjectModel);
@ -300,7 +320,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
new DatabaseField("FileSize", null),
new DatabaseField("ContentOffset", contentOffset), // 18432 , should be 20480
new DatabaseField("ContentSize", contentSize), // 8217472, should be 8564736 (347264 difference!)
new DatabaseField("TocOffset", (ulong)FileAlignment),
new DatabaseField("TocOffset", (ulong)SectorAlignment),
new DatabaseField("TocSize", (ulong)tocsize),
new DatabaseField("TocCrc", null),
new DatabaseField("EtocOffset", etocOffset),
@ -323,7 +343,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
new DatabaseField("Updates", null),
new DatabaseField("Version", (ushort)7),
new DatabaseField("Revision", (ushort)0),
new DatabaseField("Align", (ushort)FileAlignment),
new DatabaseField("Align", (ushort)SectorAlignment),
new DatabaseField("Sorted", (ushort)1),
new DatabaseField("EID", (ushort)1),
new DatabaseField("CpkMode", (uint)2),
@ -384,7 +404,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
dt.Fields.Add("UserString", "<NULL>", typeof(string));
ulong offset = initialFileOffset;
offset -= (ulong) FileAlignment; // idk?
offset -= (ulong) SectorAlignment; // idk?
List<IDOFFSET> offsets = new List<IDOFFSET>(files.Length);
for (int i = 0; i < files.Length; i++)
@ -399,7 +419,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
{
offsets[i] = new IDOFFSET(offsets[i].INDEX, offsets[i].ID, offset, offsets[i].SIZE);
offset += offsets[i].SIZE;
offset = offset.RoundUp(FileAlignment);
offset = offset.RoundUp(SectorAlignment);
}
offsets.Sort((x, y) => x.INDEX.CompareTo(y.INDEX));
@ -483,7 +503,11 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
return db;
}
/// <summary>
/// Applies a simple cipher to decrypt an encrypted UTF sector.
/// </summary>
/// <returns>The decrypted data.</returns>
/// <param name="input">The data to decrypt.</param>
private byte[] DecryptUTF(byte[] input)
{
byte[] result = new byte[input.Length];
@ -500,6 +524,10 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
return result;
}
/// <summary>
/// Writes the <see cref="ObjectModel" /> data to the output <see cref="Accessor" />.
/// </summary>
/// <param name="objectModel">A <see cref="FileSystemObjectModel" /> containing the archive content to write.</param>
protected override void SaveInternal(ObjectModel objectModel)
{
FileSystemObjectModel fsom = (objectModel as FileSystemObjectModel);
@ -529,7 +557,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
MemoryAccessor _tmp_ma = new MemoryAccessor();
Document.Save(_tmp_om, dfUTF, _tmp_ma);
contentOffset += (ulong)_tmp_ma.Length;
contentOffset = contentOffset.RoundUp(FileAlignment);
contentOffset = contentOffset.RoundUp(SectorAlignment);
headerLength = (ulong) _tmp_ma.Length;
@ -539,7 +567,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
contentOffset += 16;
contentOffset += (ulong)_tmp_ma.Length;
contentOffset = contentOffset.RoundUp(FileAlignment);
contentOffset = contentOffset.RoundUp(SectorAlignment);
tocLength = (ulong) _tmp_ma.Length;
_tmp_om = BuildItocUTF(sortedOffsets);
@ -550,7 +578,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
contentOffset += 16;
contentOffset += (ulong)_tmp_ma.Length;
contentOffset = contentOffset.RoundUp(FileAlignment);
contentOffset = contentOffset.RoundUp(SectorAlignment);
itocLength = (ulong) _tmp_ma.Length; // 21728
_tmp_om = BuildEtocUTF(files);
@ -572,13 +600,13 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
for (uint i = 0; i < files.Length; i++)
{
contentSize += (ulong)files[i].Size;
contentSize = contentSize.RoundUp(FileAlignment);
contentSize = contentSize.RoundUp(SectorAlignment);
}
ulong itocOffset = 16 + headerLength;
itocOffset = itocOffset.RoundUp(FileAlignment);
itocOffset = itocOffset.RoundUp(SectorAlignment);
itocOffset += (16 + tocLength);
itocOffset = itocOffset.RoundUp(FileAlignment);
itocOffset = itocOffset.RoundUp(SectorAlignment);
itocOffset = itocOffset.RoundToNearestPowerOf2();
@ -593,7 +621,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
bw.WriteInt64(utfHeader_data.Length);
bw.WriteBytes(utfHeader_data);
bw.Align(FileAlignment);
bw.Align(SectorAlignment);
bw.Accessor.Seek(-6, SeekOrigin.Current);
bw.WriteFixedLengthString("(c)CRI");
@ -603,7 +631,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
bw.WriteInt64(utfTOC_data.Length);
bw.WriteBytes(utfTOC_data);
bw.Align(FileAlignment);
bw.Align(SectorAlignment);
// here comes the ITOC (indexes TOC) UTF table chunk.
DatabaseObjectModel utfITOC = BuildItocUTF(sortedOffsets);
@ -619,11 +647,11 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
bw.WriteBytes(utfITOC_data);
// here comes the file data. each file is aligned to FileAlignment bytes, apparently.
bw.Align(FileAlignment);
bw.Align(SectorAlignment);
for (uint i = 0; i < sortedOffsets.Length; i++)
{
bw.WriteBytes(files[sortedOffsets[i].INDEX].GetData());
bw.Align(FileAlignment);
bw.Align(SectorAlignment);
}
DatabaseObjectModel utfETOC = BuildEtocUTF(files);
@ -631,7 +659,7 @@ namespace UniversalEditor.Plugins.CRI.DataFormats.FileSystem.CPK
Document.Save(utfETOC, dfUTF, maUTFETOC);
byte[] utfETOC_data = maUTFETOC.ToArray();
bw.Align(FileAlignment);
bw.Align(SectorAlignment);
bw.WriteFixedLengthString("ETOC");
bw.WriteInt32(255);
bw.WriteInt64(utfETOC_data.Length);