GARbro-mirror/ArcFormats/Leaf/ArcPAK.cs

//! \file       ArcPAK.cs
//! \date       2018 Nov 04
//! \brief      Leaf resource archive.
//
// Copyright (C) 2018-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.Collections.Generic;
using System.ComponentModel.Composition;
using System.IO;
using GameRes.Compression;
using GameRes.Utility.Serialization;

namespace GameRes.Formats.Leaf
{
    [Export(typeof(ArchiveFormat))]
    public class KcapOpener : ArchiveFormat
    {
        public override string         Tag { get { return "PAK/KCAP"; } }
        public override string Description { get { return "Leaf resource archive"; } }
        public override uint     Signature { get { return 0x5041434B; } } // 'KCAP'
        public override bool  IsHierarchic { get { return false; } }
        public override bool      CanWrite { get { return false; } }

        public KcapOpener ()
        {
            ContainedFormats = new[] { "TGA", "BJR", "BMP", "OGG", "WAV", "AMP/LEAF", "SCR" };
        }

        public override ArcFile TryOpen (ArcView file)
        {
            int version = -1;
            int count = file.View.ReadInt32 (4);
            uint index_offset = 8;
            uint first_offset = file.View.ReadUInt32 (0x20);
            if (IsSaneCount (count))
            {
                if (count * 0x20 + 8 == first_offset)
                {
                    version = 0;
                }
                else
                {
                    first_offset = file.View.ReadUInt32 (0x24);
                    if (count * 0x24 + 8 == first_offset)
                        version = 1;
                }
            }
            if (version < 0)
            {
                count = file.View.ReadInt32 (8);
                first_offset = file.View.ReadUInt32 (0x28);
                if (IsSaneCount (count) && count * 0x24 + 0xC == first_offset)
                {
                    version = 1;
                    index_offset = 0xC;
                }
                else
                {
                    count = file.View.ReadInt32 (12);
                    first_offset = file.View.ReadUInt32 (0x34);
                    if (IsSaneCount (count) && count * 0x2C + 0x10 == first_offset)
                    {
                        version = 2;
                        index_offset = 0x10;
                    }
                }
            }
            List<Entry> dir = null;
            switch (version)
            {
            case 0: dir = ReadIndex<EntryDefV0> (file, count, index_offset); break;
            case 1: dir = ReadIndex<EntryDefV1> (file, count, index_offset); break;
            case 2: dir = ReadIndex<EntryDefV2> (file, count, index_offset); break;
            default: return null;
            }
            if (null == dir)
                return null;
            return new ArcFile (file, this, dir);
        }

        List<Entry> ReadIndex<EntryDef> (ArcView file, int count, uint index_offset)
            where EntryDef : IEntryDefinition, new()
        {
            using (var input = file.CreateStream())
            {
                input.Position = index_offset;
                var dir = new List<Entry> (count);
                var def = new EntryDef();
                for (int i = 0; i < count; ++i)
                {
                    input.ReadStruct (out def);
                    if (def.Size != 0)
                    {
                        var entry = Create<PackedEntry> (def.Name);
                        entry.Offset = def.Offset;
                        entry.Size   = def.Size;
                        if (!entry.CheckPlacement (file.MaxOffset))
                            return null;
                        entry.IsPacked = def.IsPacked;
                        dir.Add (entry);
                    }
                }
                return dir;
            }
        }

        public override Stream OpenEntry (ArcFile arc, Entry entry)
        {
            var pent = entry as PackedEntry;
            if (null == pent || !pent.IsPacked)
                return base.OpenEntry (arc, entry);
            if (0 == pent.UnpackedSize)
                pent.UnpackedSize = arc.File.View.ReadUInt32 (entry.Offset+4);
            var input = arc.File.CreateStream (entry.Offset+8, entry.Size-8);
            return new LzssStream (input);
        }

        public override IImageDecoder OpenImage (ArcFile arc, Entry entry)
        {
            if (!entry.Name.HasExtension (".tga"))
                return base.OpenImage (arc, entry);
            var input = arc.OpenBinaryEntry (entry);
            try
            {
                var header = input.ReadHeader (18);
                if (0 == header[16])
                    header[16] = 32;
                if (0 == header[17] && 32 == header[16])
                    header[17] = 8;
                Stream tga_input = new StreamRegion (input.AsStream, 18);
                tga_input = new PrefixStream (header.ToArray(), tga_input);
                var tga = new BinaryStream (tga_input, entry.Name);
                var info = ImageFormat.Tga.ReadMetaData (tga);
                if (info != null)
                {
                    tga.Position = 0;
                    return new ImageFormatDecoder (tga, ImageFormat.Tga, info);
                }
            }
            catch { /* ignore errors */ }
            input.Position = 0;
            return ImageFormatDecoder.Create (input);
        }
    }

    [Export(typeof(ScriptFormat))]
    public class AmpFormat : GenericScriptFormat
    {
        public override string        Type { get { return ""; } }
        public override string         Tag { get { return "AMP/LEAF"; } }
        public override string Description { get { return "Leaf engine internal file"; } }
        public override uint     Signature { get { return 0; } }
    }

    [Export(typeof(ResourceAlias))]
    [ExportMetadata("Extension", "SDT")]
    [ExportMetadata("Target", "SCR")]
    public class SdtFormat : ResourceAlias { }

    internal interface IEntryDefinition
    {
        string   Name { get; }
        long   Offset { get; }
        uint     Size { get; }
        bool IsPacked { get; }
    }

    #pragma warning disable 649,169
    internal struct EntryDefV0 : IEntryDefinition
    {
        [CString(Length = 0x18)]
        string  _name;
        uint    _offset;
        uint    _size;

        public string   Name { get { return _name; } }
        public long   Offset { get { return _offset; } }
        public uint     Size { get { return _size; } }
        public bool IsPacked { get { return true; } }
    }

    internal struct EntryDefV1 : IEntryDefinition
    {
        int     _is_packed;
        [CString(Length = 0x18)]
        string  _name;
        uint    _offset;
        uint    _size;

        public string   Name { get { return _name; } }
        public long   Offset { get { return _offset; } }
        public uint     Size { get { return _size; } }
        public bool IsPacked { get { return _is_packed != 0; } }
    }

    internal struct EntryDefV2 : IEntryDefinition
    {
        int     _is_packed;
        [CString(Length = 0x18)]
        string  _name;
        uint    _crc;
        uint    _unpacked_size;
        uint    _offset;
        uint    _size;

        public string   Name { get { return _name; } }
        public long   Offset { get { return _offset; } }
        public uint     Size { get { return _size; } }
        public bool IsPacked { get { return _is_packed != 0; } }
    }
    #pragma warning restore 649,169
}