The-Homebrew-Cloud/dsdecmp
2
0
Fork 0
mirror of https://github.com/Barubary/dsdecmp.git synced 2025-02-21 13:47:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

C#: added the Golden Sun: Dark Dawn format in the new structure. This version hasn't been tested yet, and thus hasn't been included in the main program. I also need to think of how to include these game-specific formats in the main program, as they may conflict with built-in formats regarding their header (with GSDD I just try to decompress the file when checking if a file is supported).

Browse Source
This commit is contained in:
barubary 2011-05-18 12:24:16 +00:00
parent d23cbad089
commit 0f9b368b04
8 changed files with 274 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CSharp/DSDecmp/DSDecmp.csproj
View File

@ -47,6 +47,7 @@
<Compile Include="Exceptions\StreamTooShortException.cs" />
<Compile Include="Exceptions\TooMuchInputException.cs" />
<Compile Include="Formats\CompressionFormat.cs" />
<Compile Include="Formats\GameSpecific\GoldenSunDD.cs" />
<Compile Include="Formats\Nitro\Huffman.cs" />
<Compile Include="Formats\Nitro\LZ10.cs" />
<Compile Include="Formats\Nitro\LZ11.cs" />

232
CSharp/DSDecmp/Formats/GameSpecific/GoldenSunDD.cs Normal file
View File

@ -0,0 +1,232 @@
using System;
using System.Collections.Generic;
using System.Text;
using System.IO;
namespace DSDecmp.Formats.GameSpecific
{
public class GoldenSunDD : CompressionFormat
{
public override bool Supports(System.IO.Stream stream, long inLength)
{
long streamStart = stream.Position;
try
{
// because of the specific format, and especially since it overlaps with
// the LZH8 header format, we'll need to try and decompress the file in
// order to check if it is supported.
try
{
using (MemoryStream tempStream = new MemoryStream())
this.Decompress(stream, inLength, tempStream);
return true;
}
catch (TooMuchInputException)
{
// too much input is still OK.
return true;
}
catch
{
// anything else is not OK.
return false;
}
}
finally
{
stream.Position = streamStart;
}
}
#region Decompression method
public override long Decompress(System.IO.Stream instream, long inLength, System.IO.Stream outstream)
{
#region format specification
// no NDSTEK-like specification for this one; I seem to not be able to get those right.
/*
* byte tag; // 0x40
* byte[3] decompressedSize;
* the rest is the data;
*
* for each chunk:
* - first byte determines which blocks are compressed
* - block i is compressed iff:
* - the i'th MSB is the last 1-bit in the byte
* - OR the i'th MSB is a 0-bit, not directly followed by other 0-bits.
* - note that there will never be more than one 0-bit before any 1-bit in this byte
* (look at the corresponding code, it may clarify this a bit more)
* - then come 8 blocks:
* - a non-compressed block is simply one single byte
* - a compressed block can have 3 sizes:
* - A0 CD EF
* -> Length = EF + 0x10, Disp = CDA
* - A1 CD EF GH
* -> Length = GHEF + 0x110, Disp = CDA
* - AB CD (B > 1)
* -> Length = B, Disp = CDA
* Copy <Length> bytes from Dest-<Disp> to Dest (with <Dest> similar to the NDSTEK specs)
*/
#endregion
long readBytes = 0;
byte type = (byte)instream.ReadByte();
if (type != 0x40)
throw new InvalidDataException("The provided stream is not a valid 'LZ-0x40' "
+ "compressed stream (invalid type 0x" + type.ToString("X") + ")");
byte[] sizeBytes = new byte[3];
instream.Read(sizeBytes, 0, 3);
int decompressedSize = IOUtils.ToNDSu24(sizeBytes, 0);
readBytes += 4;
if (decompressedSize == 0)
{
sizeBytes = new byte[4];
instream.Read(sizeBytes, 0, 4);
decompressedSize = IOUtils.ToNDSs32(sizeBytes, 0);
readBytes += 4;
}
// the maximum 'DISP' is 0xFFF.
int bufferLength = 0x1000;
byte[] buffer = new byte[bufferLength];
int bufferOffset = 0;
int currentOutSize = 0;
int currentBlock = 0;
// the expended flag byte
bool[] expandedFlags = null;
while (currentOutSize < decompressedSize)
{
// (throws when requested new flags byte is not available)
#region Update the mask. If all flag bits have been read, get a new set.
// the current mask is the mask used in the previous run. So if it masks the
// last flag bit, get a new flags byte.
if (currentBlock == 8)
{
if (readBytes >= inLength)
throw new NotEnoughDataException(currentOutSize, decompressedSize);
int flags = instream.ReadByte(); readBytes++;
if (flags < 0)
throw new StreamTooShortException();
// determine which blocks are compressed
int b = 0;
expandedFlags = new bool[8];
while (flags > 0)
{
bool bit = (flags & 0x80) > 0;
flags = (flags & 0x7F) << 1;
expandedFlags[b++] = (flags == 0) || !bit;
}
currentBlock = 0;
}
else
{
currentBlock++;
}
#endregion
// bit = 1 <=> compressed.
if (expandedFlags[currentBlock])
{
// (throws when < 2, 3 or 4 bytes are available)
#region Get length and displacement('disp') values from next 2, 3 or 4 bytes
// there are < 2 bytes available when the end is at most 1 byte away
if (readBytes + 1 >= inLength)
{
// make sure the stream is at the end
if (readBytes < inLength)
{
instream.ReadByte(); readBytes++;
}
throw new NotEnoughDataException(currentOutSize, decompressedSize);
}
int byte1 = instream.ReadByte(); readBytes++;
int byte2 = instream.ReadByte(); readBytes++;
if (byte2 < 0)
throw new StreamTooShortException();
int disp, length;
disp = (byte1 >> 4) + (byte2 << 4);
if (disp > currentOutSize)
throw new InvalidDataException("Cannot go back more than already written. "
+ "DISP = 0x" + disp.ToString("X") + ", #written bytes = 0x" + currentOutSize.ToString("X")
+ " at 0x" + (instream.Position - 2).ToString("X"));
switch (byte1 & 0x0F)
{
case 0:
{
if (readBytes >= inLength)
throw new NotEnoughDataException(currentOutSize, decompressedSize);
int byte3 = instream.ReadByte(); readBytes++;
if (byte3 < 0)
throw new StreamTooShortException();
length = byte3 + 0x10;
break;
}
case 1:
{
if (readBytes + 1 >= inLength)
throw new NotEnoughDataException(currentOutSize, decompressedSize);
int byte3 = instream.ReadByte(); readBytes++;
int byte4 = instream.ReadByte(); readBytes++;
if (byte4 < 0)
throw new StreamTooShortException();
length = ((byte3 << 8) + byte4) + 0x110;
break;
}
default:
{
length = byte1 & 0x0F;
break;
}
}
#endregion
int bufIdx = bufferOffset + bufferLength - disp;
for (int i = 0; i < length; i++)
{
byte next = buffer[bufIdx % bufferLength];
bufIdx++;
outstream.WriteByte(next);
buffer[bufferOffset] = next;
bufferOffset = (bufferOffset + 1) % bufferLength;
}
currentOutSize += length;
}
else
{
if (readBytes >= inLength)
throw new NotEnoughDataException(currentOutSize, decompressedSize);
int next = instream.ReadByte(); readBytes++;
if (next < 0)
throw new StreamTooShortException();
currentOutSize++;
outstream.WriteByte((byte)next);
buffer[bufferOffset] = (byte)next;
bufferOffset = (bufferOffset + 1) % bufferLength;
}
outstream.Flush();
}
if (readBytes < inLength)
{
// the input may be 4-byte aligned.
if ((readBytes ^ (readBytes & 3)) + 4 < inLength)
throw new TooMuchInputException(readBytes, inLength);
}
return decompressedSize;
}
#endregion
public override int Compress(System.IO.Stream instream, long inLength, System.IO.Stream outstream)
{
throw new NotImplementedException();
}
}
}

4
CSharp/DSDecmp/Formats/Nitro/Huffman.cs
View File

@ -71,13 +71,13 @@ namespace DSDecmp.Formats.Nitro
+ "compressed stream (invalid type 0x" + type.ToString("X") + "); unknown block size.");
byte[] sizeBytes = new byte[3];
instream.Read(sizeBytes, 0, 3);
int decompressedSize = base.Bytes2Size(sizeBytes);
int decompressedSize = IOUtils.ToNDSu24(sizeBytes, 0);
readBytes += 4;
if (decompressedSize == 0)
{
sizeBytes = new byte[4];
instream.Read(sizeBytes, 0, 4);
decompressedSize = base.Bytes2Size(sizeBytes);
decompressedSize = IOUtils.ToNDSs32(sizeBytes, 0);
readBytes += 4;
}

8
CSharp/DSDecmp/Formats/Nitro/LZ10.cs
View File

@ -35,7 +35,7 @@ namespace DSDecmp.Formats.Nitro
public override long Decompress(Stream instream, long inLength,
Stream outstream)
{
#region format definition form GBATEK/NDSTEK
#region format definition from GBATEK/NDSTEK
/* Data header (32bit)
Bit 0-3 Reserved
Bit 4-7 Compressed type (must be 1 for LZ77)
@ -60,13 +60,13 @@ namespace DSDecmp.Formats.Nitro
+ "compressed stream (invalid type 0x" + type.ToString("X") + ")");
byte[] sizeBytes = new byte[3];
instream.Read(sizeBytes, 0, 3);
int decompressedSize = base.Bytes2Size(sizeBytes);
int decompressedSize = IOUtils.ToNDSu24(sizeBytes, 0);
readBytes += 4;
if (decompressedSize == 0)
{
sizeBytes = new byte[4];
instream.Read(sizeBytes, 0, 4);
decompressedSize = base.Bytes2Size(sizeBytes);
decompressedSize = IOUtils.ToNDSs32(sizeBytes, 0);
readBytes += 4;
}
@ -130,7 +130,7 @@ namespace DSDecmp.Formats.Nitro
if (disp > currentOutSize)
throw new InvalidDataException("Cannot go back more than already written. "
+ "DISP = 0x" + disp.ToString("X") + ", #written bytes = 0x" + currentOutSize.ToString("X")
+ " at 0x" + instream.Position.ToString("X"));
+ " at 0x" + (instream.Position - 2).ToString("X"));
#endregion
int bufIdx = bufferOffset + bufferLength - disp;

4
CSharp/DSDecmp/Formats/Nitro/LZ11.cs
View File

@ -74,13 +74,13 @@ namespace DSDecmp.Formats.Nitro
+ "compressed stream (invalid type 0x" + type.ToString("X") + ")");
byte[] sizeBytes = new byte[3];
instream.Read(sizeBytes, 0, 3);
int decompressedSize = base.Bytes2Size(sizeBytes);
int decompressedSize = IOUtils.ToNDSu24(sizeBytes, 0);
readBytes += 4;
if (decompressedSize == 0)
{
sizeBytes = new byte[4];
instream.Read(sizeBytes, 0, 4);
decompressedSize = base.Bytes2Size(sizeBytes);
decompressedSize = IOUtils.ToNDSs32(sizeBytes, 0);
readBytes += 4;
}

17
CSharp/DSDecmp/Formats/Nitro/NitroCFormat.cs
View File

@ -32,19 +32,6 @@ namespace DSDecmp.Formats.Nitro
this.magicByte = magicByte;
}
/// <summary>
/// Converts an array of (at least) 3 bytes into an integer, using the format used
/// in Nitro compression formats to store the decompressed size.
/// If the size is not 3, the fourth byte will also be included.
/// </summary>
protected int Bytes2Size(byte[] bytes)
{
if (bytes.Length == 3)
return bytes[0] | (bytes[1] << 8) | (bytes[2] << 16);
else
return bytes[0] | (bytes[1] << 8) | (bytes[2] << 16) | (bytes[3] << 24);
}
public override bool Supports(System.IO.Stream stream, long inLength)
{
long startPosition = stream.Position;
@ -58,12 +45,12 @@ namespace DSDecmp.Formats.Nitro
return true;
byte[] sizeBytes = new byte[3];
stream.Read(sizeBytes, 0, 3);
int outSize = this.Bytes2Size(sizeBytes);
int outSize = IOUtils.ToNDSu24(sizeBytes, 0);
if (outSize == 0)
{
sizeBytes = new byte[4];
stream.Read(sizeBytes, 0, 4);
outSize = this.Bytes2Size(sizeBytes);
outSize = (int)IOUtils.ToNDSu32(sizeBytes, 0);
}
return outSize <= MaxPlaintextSize;
}

4
CSharp/DSDecmp/Formats/Nitro/RLE.cs
View File

@ -35,13 +35,13 @@ namespace DSDecmp.Formats.Nitro
+ "compressed stream (invalid type 0x" + type.ToString("X") + ")");
byte[] sizeBytes = new byte[3];
instream.Read(sizeBytes, 0, 3);
int decompressedSize = base.Bytes2Size(sizeBytes);
int decompressedSize = IOUtils.ToNDSu24(sizeBytes, 0);
readBytes += 4;
if (decompressedSize == 0)
{
sizeBytes = new byte[4];
instream.Read(sizeBytes, 0, 4);
decompressedSize = base.Bytes2Size(sizeBytes);
decompressedSize = IOUtils.ToNDSs32(sizeBytes, 0);
readBytes += 4;
}

29
CSharp/DSDecmp/Utils/IOUtils.cs
View File

@ -24,6 +24,21 @@ namespace DSDecmp
| (buffer[offset + 3] << 24));
}
/// <summary>
/// Returns a 4-byte signed integer as used on the NDS converted from four bytes
/// at a specified position in a byte array.
/// </summary>
/// <param name="buffer">The source of the data.</param>
/// <param name="offset">The location of the data in the source.</param>
/// <returns>The indicated 4 bytes converted to int</returns>
public static int ToNDSs32(byte[] buffer, int offset)
{
return (int)(buffer[offset]
| (buffer[offset + 1] << 8)
| (buffer[offset + 2] << 16)
| (buffer[offset + 3] << 24));
}
/// <summary>
/// Converts a u32 value into a sequence of bytes that would make ToNDSu32 return
/// the given input value.
@ -37,5 +52,19 @@ namespace DSDecmp
(byte)((value >> 24) & 0xFF)
};
}
/// <summary>
/// Returns a 3-byte integer as used in the built-in compression
/// formats in the DS, convrted from three bytes at a specified position in a byte array,
/// </summary>
/// <param name="buffer">The source of the data.</param>
/// <param name="offset">The location of the data in the source.</param>
/// <returns>The indicated 3 bytes converted to an integer.</returns>
public static int ToNDSu24(byte[] buffer, int offset)
{
return (int)(buffer[offset]
| (buffer[offset + 1] << 8)
| (buffer[offset + 2] << 16));
}
}
}