GARbro-mirror/ArcFormats/Ethornell/ArcBGI.cs
2018-09-27 18:23:52 +04:00

403 lines
15 KiB
C#

//! \file ArcBGI.cs
//! \date Tue Sep 09 09:29:12 2014
//! \brief BGI/Ethornell engine archive implementation.
//
// Copyright (C) 2014-2015 by morkt
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//
using System;
using System.Collections.Generic;
using System.ComponentModel.Composition;
using System.IO;
using System.Linq;
using GameRes.Utility;
namespace GameRes.Formats.BGI
{
[Export(typeof(ArchiveFormat))]
public class ArcOpener : ArchiveFormat
{
public override string Tag { get { return "BGI"; } }
public override string Description { get { return "BGI/Ethornell engine resource archive"; } }
public override uint Signature { get { return 0x6b636150; } } // "Pack"
public override bool IsHierarchic { get { return false; } }
public override bool CanWrite { get { return false; } }
public ArcOpener ()
{
Extensions = new string[] { "arc" };
ContainedFormats = new[] { "BGI", "CompressedBG", "BW", "SCR" };
}
public override ArcFile TryOpen (ArcView file)
{
if (!file.View.AsciiEqual (4, "File "))
return null;
uint count = file.View.ReadUInt32 (12);
if (count > 0xfffff)
return null;
uint index_size = 0x20 * count;
if (index_size > file.View.Reserve (0x10, index_size))
return null;
var dir = new List<Entry> ((int)count);
long index_offset = 0x10;
long base_offset = index_offset + index_size;
for (uint i = 0; i < count; ++i)
{
string name = file.View.ReadString (index_offset, 0x10);
var entry = Create<PackedEntry> (name);
entry.Offset = base_offset + file.View.ReadUInt32 (index_offset+0x10);
entry.Size = file.View.ReadUInt32 (index_offset+0x14);
if (!entry.CheckPlacement (file.MaxOffset))
return null;
dir.Add (entry);
index_offset += 0x20;
}
foreach (var entry in dir.Where (e => string.IsNullOrEmpty (e.Type)))
{
if (file.View.AsciiEqual (entry.Offset, "CompressedBG"))
entry.Type = "image";
else if (file.View.AsciiEqual (entry.Offset+4, "bw "))
entry.Type = "audio";
}
return new ArcFile (file, this, dir);
}
public override Stream OpenEntry (ArcFile arc, Entry entry)
{
var entry_offset = entry.Offset;
var input = arc.File.CreateStream (entry_offset, entry.Size);
var pent = entry as PackedEntry;
if (null == pent)
return input;
if (!pent.IsPacked)
{
if (pent.Size <= 0x220 || !arc.File.View.AsciiEqual (entry_offset, "DSC FORMAT 1.00\0"))
return input;
pent.IsPacked = true;
pent.UnpackedSize = arc.File.View.ReadUInt32 (entry_offset+0x14);
}
try
{
using (var decoder = new DscDecoder (input))
{
decoder.Unpack();
return new BinMemoryStream (decoder.Output, entry.Name);
}
}
catch (Exception X)
{
System.Diagnostics.Trace.WriteLine (X.Message, "BgiOpener");
return arc.File.CreateStream (entry_offset, entry.Size);
}
}
}
[Export(typeof(ArchiveFormat))]
public class Arc2Opener : ArcOpener
{
public override string Tag { get { return "BURIKO ARC"; } }
public override string Description { get { return "BGI/Ethornell engine resource archive v2"; } }
public override uint Signature { get { return 0x49525542; } } // "BURI"
public override bool IsHierarchic { get { return false; } }
public override bool CanWrite { get { return false; } }
public override ArcFile TryOpen (ArcView file)
{
if (!file.View.AsciiEqual (4, "KO ARC20"))
return null;
int count = file.View.ReadInt32 (12);
if (!IsSaneCount (count))
return null;
uint index_size = 0x80 * (uint)count;
if (index_size > file.View.Reserve (0x10, index_size))
return null;
var dir = new List<Entry> (count);
long index_offset = 0x10;
long base_offset = index_offset + index_size;
for (uint i = 0; i < count; ++i)
{
string name = file.View.ReadString (index_offset, 0x60);
var offset = base_offset + file.View.ReadUInt32 (index_offset+0x60);
var entry = new PackedEntry { Name = name, Offset = offset };
entry.Size = file.View.ReadUInt32 (index_offset+0x64);
if (!entry.CheckPlacement (file.MaxOffset))
return null;
dir.Add (entry);
index_offset += 0x80;
}
foreach (var entry in dir)
{
uint signature = file.View.ReadUInt32 (entry.Offset);
var res = AutoEntry.DetectFileType (signature);
if (res != null)
entry.Type = res.Type;
else if (file.View.AsciiEqual (entry.Offset, "BSE 1."))
entry.Type = "image";
else if (file.View.AsciiEqual (entry.Offset+4, "bw "))
entry.Type = "audio";
}
return new ArcFile (file, this, dir);
}
public override Stream OpenEntry (ArcFile arc, Entry entry)
{
if (entry.Size < 0x50 || !arc.File.View.AsciiEqual (entry.Offset, "BSE 1."))
return base.OpenEntry (arc, entry);
int version = arc.File.View.ReadUInt16 (entry.Offset+8);
if (version != 0x100 && version != 0x101)
return base.OpenEntry (arc, entry);
ushort checksum = arc.File.View.ReadUInt16 (entry.Offset+0xA);
uint key = arc.File.View.ReadUInt32 (entry.Offset+0xC);
var header = arc.File.View.ReadBytes (entry.Offset+0x10, 0x40);
if (0x101 == version)
DecryptBse (header, new BseGenerator101 (key));
else
DecryptBse (header, new BseGenerator100 (key));
var body = arc.File.CreateStream (entry.Offset+0x50, entry.Size-0x50);
return new PrefixStream (header, body);
}
void DecryptBse (byte[] data, IBseGenerator decoder)
{
var decoded = new bool[0x40];
for (int i = 0; i < decoded.Length; ++i)
{
int dst = decoder.NextKey() & 0x3F;
while (decoded[dst])
{
dst = (dst + 1) & 0x3F;
}
int shift = decoder.NextKey() & 7;
bool right_shift = (decoder.NextKey() & 1) == 0;
byte symbol = (byte)(data[dst] - decoder.NextKey());
if (right_shift)
{
data[dst] = Binary.RotByteR (symbol, shift);
}
else
{
data[dst] = Binary.RotByteL (symbol, shift);
}
decoded[dst] = true;
}
}
}
internal class BgiDecoderBase : MsbBitStream
{
protected uint m_key;
protected uint m_magic;
protected BgiDecoderBase (Stream input, bool leave_open = false) : base (input, leave_open)
{
}
protected byte UpdateKey ()
{
uint v0 = 20021 * (m_key & 0xffff);
uint v1 = m_magic | (m_key >> 16);
v1 = v1 * 20021 + m_key * 346;
v1 = (v1 + (v0 >> 16)) & 0xffff;
m_key = (v1 << 16) + (v0 & 0xffff) + 1;
return (byte)v1;
}
}
internal sealed class DscDecoder : BgiDecoderBase
{
byte[] m_output;
uint m_dec_count;
public byte[] Output { get { return m_output; } }
public DscDecoder (IBinaryStream input) : base (input.AsStream)
{
m_magic = (uint)input.ReadUInt16() << 16;
input.Position = 0x10;
m_key = input.ReadUInt32();
int output_size = input.ReadInt32();
m_dec_count = input.ReadUInt32();
m_output = new byte[output_size];
}
public void Unpack ()
{
Input.Position = 0x20;
HuffmanCode[] hcodes = new HuffmanCode[512];
HuffmanNode[] hnodes = new HuffmanNode[1023];
int leaf_node_count = 0;
for (ushort i = 0; i < 512; i++)
{
int src = Input.ReadByte();
if (-1 == src)
throw new EndOfStreamException ("Incomplete compressed stream");
byte depth = (byte)(src - UpdateKey());
if (0 != depth)
{
hcodes[leaf_node_count].Depth = depth;
hcodes[leaf_node_count].Code = i;
leaf_node_count++;
}
}
Array.Sort (hcodes, 0, leaf_node_count);
CreateHuffmanTree (hnodes, hcodes, leaf_node_count);
HuffmanDecompress (hnodes, m_dec_count);
}
struct HuffmanCode : IComparable<HuffmanCode>
{
public ushort Code;
public ushort Depth;
public int CompareTo (HuffmanCode other)
{
int cmp = (int)Depth - (int)other.Depth;
if (0 == cmp)
cmp = (int)Code - (int)other.Code;
return cmp;
}
}
class HuffmanNode
{
public bool IsParent;
public int Code;
public int LeftChildIndex;
public int RightChildIndex;
}
static void CreateHuffmanTree (HuffmanNode[] hnodes, HuffmanCode[] hcode, int node_count)
{
var nodes_index = new int[2,512];
int next_node_index = 1;
int depth_nodes = 1;
int depth = 0;
int child_index = 0;
nodes_index[0,0] = 0;
for (int n = 0; n < node_count; )
{
int huffman_nodes_index = child_index;
child_index ^= 1;
int depth_existed_nodes = 0;
while (n < hcode.Length && hcode[n].Depth == depth)
{
var node = new HuffmanNode { IsParent = false, Code = hcode[n++].Code };
hnodes[nodes_index[huffman_nodes_index, depth_existed_nodes]] = node;
depth_existed_nodes++;
}
int depth_nodes_to_create = depth_nodes - depth_existed_nodes;
for (int i = 0; i < depth_nodes_to_create; i++)
{
var node = new HuffmanNode { IsParent = true };
nodes_index[child_index, i * 2] = node.LeftChildIndex = next_node_index++;
nodes_index[child_index, i * 2 + 1] = node.RightChildIndex = next_node_index++;
hnodes[nodes_index[huffman_nodes_index, depth_existed_nodes+i]] = node;
}
depth++;
depth_nodes = depth_nodes_to_create * 2;
}
}
int HuffmanDecompress (HuffmanNode[] hnodes, uint dec_count)
{
int dst_ptr = 0;
for (uint k = 0; k < dec_count; k++)
{
int node_index = 0;
do
{
int bit = GetNextBit();
if (-1 == bit)
throw new EndOfStreamException();
if (0 == bit)
node_index = hnodes[node_index].LeftChildIndex;
else
node_index = hnodes[node_index].RightChildIndex;
}
while (hnodes[node_index].IsParent);
int code = hnodes[node_index].Code;
if (code >= 256)
{
int offset = GetBits (12);
if (-1 == offset)
break;
int count = (code & 0xff) + 2;
offset += 2;
Binary.CopyOverlapped (m_output, dst_ptr - offset, dst_ptr, count);
dst_ptr += count;
} else
m_output[dst_ptr++] = (byte)code;
}
return dst_ptr;
}
}
internal interface IBseGenerator
{
int NextKey ();
}
internal class BseGenerator100 : IBseGenerator
{
int m_key;
public BseGenerator100 (uint key)
{
m_key = (int)key;
}
public int NextKey ()
{
uint v = (uint)(((m_key * 257 >> 8) + m_key * 97 + 23) ^ 0xA6CD9B75);
m_key = (int)Binary.RotR (v, 16);
return m_key;
}
}
internal class BseGenerator101 : IBseGenerator
{
int m_key;
public BseGenerator101 (uint key)
{
m_key = (int)key;
}
public int NextKey ()
{
uint v = (uint)((m_key * 127 >> 7) + m_key * 83 + 53) ^ 0xB97A7E5C;
m_key = (int)Binary.RotR (v, 16);
return m_key;
}
}
[Export(typeof(ResourceAlias))]
[ExportMetadata("Extension", "_BP")]
[ExportMetadata("Target", "SCR")]
public class BpFormat : ResourceAlias { }
}