GARbro-mirror/ArcFormats/LiveMaker/ArcVF.cs

//! \file       ArcVF.cs
//! \date       Wed Jun 08 00:27:36 2016
//! \brief      LiveMaker resource archive.
//
// Copyright (C) 2016-2019 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.Diagnostics;
using System.IO;
using System.Linq;
using GameRes.Compression;

namespace GameRes.Formats.LiveMaker
{
    [Export(typeof(ArchiveFormat))]
    public class VffOpener : ArchiveFormat
    {
        public override string         Tag { get { return "DAT/vf"; } }
        public override string Description { get { return "LiveMaker resource archive"; } }
        public override uint     Signature { get { return 0x666676; } } // 'vff'
        public override bool  IsHierarchic { get { return true; } }
        public override bool      CanWrite { get { return false; } }

        public VffOpener ()
        {
            Extensions = new string[] { "dat" };
            Signatures = new uint[] { 0x666676, 0 };
        }

        public override ArcFile TryOpen (ArcView file)
        {
            uint base_offset = 0;
            ArcView index_file = file;
            try
            {
                // possible filesystem structure:
                //   game.dat  -- main archive body
                //   game.ext  -- [optional] separate index (could be included into the main body)
                //   game.001  -- [optional] extra parts
                //   game.002
                //   ...

                uint signature = index_file.View.ReadUInt32 (0);
                if (file.Name.HasExtension (".exe")
                    && (0x5A4D == (signature & 0xFFFF))) // 'MZ'
                {
                    base_offset = SkipExeData (index_file);
                    signature = index_file.View.ReadUInt32 (base_offset);
                }
                else if (!file.Name.HasExtension (".dat"))
                {
                    return null;
                }
                else if (0x666676 != signature)
                {
                    var ext_filename = Path.ChangeExtension (file.Name, ".ext");
                    if (!VFS.FileExists (ext_filename))
                        return null;
                    index_file = VFS.OpenView (ext_filename);
                    signature = index_file.View.ReadUInt32 (0);
                }
                if (0x666676 != signature)
                    return null;
                int count = index_file.View.ReadInt32 (base_offset+6);
                if (!IsSaneCount (count))
                    return null;

                var dir = ReadIndex (index_file, base_offset, count);
                if (null == dir)
                    return null;
                long max_offset = file.MaxOffset;
                var parts = new List<ArcView>();
                try
                {
                    for (int i = 1; i < 100; ++i)
                    {
                        var ext = string.Format (".{0:D3}", i);
                        var part_filename = Path.ChangeExtension (file.Name, ext);
                        if (!VFS.FileExists (part_filename))
                            break;
                        var arc_file = VFS.OpenView (part_filename);
                        max_offset += arc_file.MaxOffset;
                        parts.Add (arc_file);
                    }
                }
                catch
                {
                    foreach (var part in parts)
                        part.Dispose();
                    throw;
                }
                if (0 == parts.Count)
                    return new ArcFile (file, this, dir);
                return new MultiFileArchive (file, this, dir, parts);
            }
            finally
            {
                if (index_file != file)
                    index_file.Dispose();
            }
        }

        public override Stream OpenEntry (ArcFile arc, Entry entry)
        {
            var vff = arc as MultiFileArchive;
            Stream input = null;
            if (vff != null)
                input = vff.OpenStream (entry);
            else
                input = arc.File.CreateStream (entry.Offset, entry.Size);

            var pent = entry as VfEntry;
            if (null == pent)
                return input;
            if (pent.IsScrambled)
            {
                byte[] data;
                using (input)
                {
                    if (entry.Size <= 8)
                        return Stream.Null;
                    data = ReshuffleStream (input);
                }
                input = new BinMemoryStream (data, entry.Name);
            }
            if (pent.IsPacked)
                input = new ZLibStream (input, CompressionMode.Decompress);
            return input;
        }

        List<Entry> ReadIndex (ArcView file, uint base_offset, int count)
        {
            uint index_offset = base_offset+0xA;
            var name_buffer = new byte[0x100];
            var rnd = new TpRandom (0x75D6EE39u);
            var dir = new List<Entry> (count);
            for (int i = 0; i < count; ++i)
            {
                uint name_length = file.View.ReadUInt32 (index_offset);
                index_offset += 4;
                if (0 == name_length || name_length > name_buffer.Length)
                    return null;
                if (name_length != file.View.Read (index_offset, name_buffer, 0, name_length))
                    return null;
                index_offset += name_length;

                var name = DecryptName (name_buffer, (int)name_length, rnd);
                dir.Add (Create<VfEntry> (name));
            }
            rnd.Reset();
            long offset = base_offset + (file.View.ReadInt64 (index_offset) ^ (int)rnd.GetRand32());
            foreach (var entry in dir)
            {
                index_offset += 8;
                long next_offset = base_offset + (file.View.ReadInt64 (index_offset) ^ (int)rnd.GetRand32());
                entry.Offset = offset;
                entry.Size = (uint)(next_offset - offset);
                offset = next_offset;
            }
            index_offset += 8;
            foreach (VfEntry entry in dir)
            {
                byte flags = file.View.ReadByte (index_offset++);
                entry.IsPacked = 0 == flags || 3 == flags;
                entry.IsScrambled = 2 == flags || 3 == flags;
            }
            return dir;
        }

        string DecryptName (byte[] name_buf, int name_length, TpRandom key)
        {
            for (int i = 0; i < name_length; ++i)
            {
                name_buf[i] ^= (byte)key.GetRand32();
            }
            return Encodings.cp932.GetString (name_buf, 0, name_length);
        }

        uint SkipExeData (ArcView file)
        {
            var exe = new ExeFile (file);
            return (uint)exe.Overlay.Offset;
        }

        byte[] ReshuffleStream (Stream input)
        {
            var header = new byte[8];
            input.Read (header, 0, 8);
            int chunk_size = header.ToInt32 (0);
            uint seed = header.ToUInt32 (4) ^ 0xF8EAu;
            int input_length = (int)input.Length - 8;
            var output = new byte[input_length];
            int count = (input_length - 1) / chunk_size + 1;
            int dst = 0;
            foreach (int i in RandomSequence (count, seed))
            {
                int position = i * chunk_size;
                input.Position = 8 + position;
                int length = Math.Min (chunk_size, input_length - position);
                input.Read (output, dst, length);
                dst += length;
            }
            return output;
        }

        static IEnumerable<int> RandomSequence (int count, uint seed)
        {
            var tp = new TpScramble (seed);
            var order = Enumerable.Range (0, count).ToList<int>();
            var seq = new int[order.Count];
            for (int i = 0; order.Count > 1; ++i)
            {
                int n = tp.GetInt32 (0, order.Count - 2);
                seq[order[n]] = i;
                order.RemoveAt (n);
            }
            seq[order[0]] = count - 1;
            return seq;
        }
    }

    internal class VfEntry : PackedEntry
    {
        public bool IsScrambled;
    }

    internal class TpRandom
    {
        uint    m_seed;
        uint    m_current;

        public TpRandom (uint seed)
        {
            m_seed = seed;
            m_current = 0;
        }

        public uint GetRand32 ()
        {
            m_current += m_current << 2;
            m_current += m_seed;
            return m_current;
        }

        public void Reset ()
        {
            m_current = 0;
        }
    }

    internal class TpScramble
    {
        uint[]  m_state = new uint[5];

        const uint FactorA = 2111111111;
        const uint FactorB = 1492;
        const uint FactorC = 1776;
        const uint FactorD = 5115;

        public TpScramble (uint seed)
        {
            Init (seed);
        }

        public void Init (uint seed)
        {
            uint hash = seed != 0 ? seed : 0xFFFFFFFFu;
            for (int i = 0; i < 5; ++i)
            {
                hash ^= hash << 13;
                hash ^= hash >> 17;
                hash ^= hash << 5;
                m_state[i] = hash;
            }
            for (int i = 0; i < 19; ++i)
            {
                GetUInt32();
            }
        }

        public int GetInt32 (int first, int last)
        {
            var num = GetDouble();
            return (int)(first + (long)(num * (last - first + 1)));
        }

        double GetDouble ()
        {
            return (double)GetUInt32() / 0x100000000L;
        }

        uint GetUInt32 ()
        {
            ulong v = FactorA * (ulong)m_state[3]
                    + FactorB * (ulong)m_state[2]
                    + FactorC * (ulong)m_state[1]
                    + FactorD * (ulong)m_state[0] + m_state[4];
            m_state[3] = m_state[2];
            m_state[2] = m_state[1];
            m_state[1] = m_state[0];
            m_state[4] = (uint)(v >> 32);
            return m_state[0] = (uint)v;
        }
    }
}