GARbro-mirror/ArcFormats/Tamamo/ArcPCK.cs

//! \file       ArcPCK.cs
//! \date       2017 Nov 16
//! \brief      TamamoSystem resource archive.
//
// Copyright (C) 2017 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 System.Windows;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using GameRes.Cryptography;
using GameRes.Formats.Strings;
using ICSharpCode.SharpZipLib.BZip2;

namespace GameRes.Formats.Tamamo
{
    [Serializable]
    public class PckScheme : ResourceScheme
    {
        public Dictionary<string, byte[]> KnownKeys;
    }

    public class PckOptions : ResourceOptions
    {
        public byte[] Key { get; set; }
    }

    internal class PckArchive : ArcFile
    {
        public readonly Blowfish Encryption;

        public PckArchive (ArcView arc, ArchiveFormat impl, ICollection<Entry> dir, byte[] key)
            : base (arc, impl, dir)
        {
            Encryption = new Blowfish (key);
        }
    }

    [Export(typeof(ArchiveFormat))]
    public class PckOpener : ArchiveFormat
    {
        public override string         Tag { get { return "PCK/TAMAMO"; } }
        public override string Description { get { return "TamamoSystem resource archive"; } }
        public override uint     Signature { get { return 0x4B434150; } } // 'PACK'
        public override bool  IsHierarchic { get { return false; } }
        public override bool      CanWrite { get { return false; } }

        public PckOpener ()
        {
            ContainedFormats = new[] { "PNG", "DDS", "OGG", "WAV", "TXT", "DAT/GENERIC" };
        }

        public override ArcFile TryOpen (ArcView file)
        {
            if (!file.View.AsciiEqual (4, "_FILE001"))
                return null;
            int count = file.View.ReadInt32 (0xC);
            if (!IsSaneCount (count))
                return null;
            var key = QueryKey (file.Name);
            if (null == key)
                return null;
            uint index_length = file.View.ReadUInt32 (0x10);
            var index = file.View.ReadBytes (0x14, index_length);
            if (index.Length != index_length)
                return null;
            var bf = new Blowfish (key);
            bf.Decipher (index, index.Length);

            long data_offset = 0x14 + index_length;
            int pos = 0;
            var dir = new List<Entry> (count);
            for (int i = 0; i < count; ++i)
            {
                uint size = index.ToUInt32 (pos);
                pos += 4;
                int name_end = Array.IndexOf<byte> (index, 0, pos);
                if (-1 == name_end)
                    return null;
                var name = Encodings.cp932.GetString (index, pos, name_end-pos);
                pos = name_end+1;
                uint enc_size = index.ToUInt32 (pos);
                pos += 4;
                var entry = Create<PackedEntry> (name);
                entry.Offset = data_offset;
                entry.Size = enc_size;
                entry.UnpackedSize = size;
                entry.IsPacked = enc_size != size;
                if (!entry.CheckPlacement (file.MaxOffset))
                    return null;
                dir.Add (entry);
                data_offset += enc_size + 1;
            }
            return new PckArchive (file, this, dir, key);
        }

        public override Stream OpenEntry (ArcFile arc, Entry entry)
        {
            var parc = (PckArchive)arc;
            var pent = (PackedEntry)entry;
            byte data_type = arc.File.View.ReadByte (pent.Offset);
            Stream input = arc.File.CreateStream (pent.Offset+1, pent.Size);
            if (data_type != 0)
            {
                input = new InputCryptoStream (input, parc.Encryption.CreateDecryptor());
                if (data_type != 3)
                {
                    input = new LimitStream (input, pent.UnpackedSize);
                }
                else
                {
                    input = new BZip2InputStream (input);
                }
            }
            return input;
        }

        public override IImageDecoder OpenImage (ArcFile arc, Entry entry)
        {
            var decoder = base.OpenImage (arc, entry);
            if (1024 != decoder.Info.Width || 512 != decoder.Info.Height && 1024 != decoder.Info.Height)
                return decoder;
            var source = decoder.Image.Bitmap;
            if (512 == decoder.Info.Height) // 1024x512 texture
            {
                if (PixelFormats.Bgra32 == source.Format)
                    return decoder;
                using (decoder)
                {
                    var ev_bitmap = CreateCanvas (800, 600, source, new Int32Rect (0, 0, 800, 512));
                    CopyRegion (source, new Int32Rect (800, 0, 88, 400), ev_bitmap, 0, 512);
                    CopyRegion (source, new Int32Rect (888, 0, 88, 400), ev_bitmap, 400, 512);
                    return new BitmapSourceDecoder (ev_bitmap);
                }
            }
            else // 1024x1024 texture
            {
                // check if bottom-right pixel is black
                var pixel = new byte[4];
                source.CopyPixels (new Int32Rect (1023, 1023, 1, 1), pixel, 4, 0);
                if (0 != pixel[0] || 0 != pixel[1] || 0 != pixel[2] || 0xFF != pixel[3])
                    return decoder;
                using (decoder)
                {
                    var ev_bitmap = CreateCanvas (1280, 720, source, new Int32Rect (0, 0, 1024, 720));
                    CopyRegion (source, new Int32Rect (0, 720, 720, 256), ev_bitmap, 1024, 0);
                    return new BitmapSourceDecoder (ev_bitmap);
                }
            }
        }

        WriteableBitmap CreateCanvas (int width, int height, BitmapSource src_bitmap, Int32Rect base_region)
        {
            var canvas = new WriteableBitmap (width, height, ImageData.DefaultDpiX, ImageData.DefaultDpiY,
                                              src_bitmap.Format, src_bitmap.Palette);
            int buffer_size = canvas.BackBufferStride * canvas.PixelHeight;
            canvas.Lock();
            src_bitmap.CopyPixels (base_region, canvas.BackBuffer, buffer_size, canvas.BackBufferStride);
            canvas.AddDirtyRect (base_region);
            canvas.Unlock();
            return canvas;
        }

        /// <summary>
        /// Copy pixels from source region, rotating by 90 degrees counter-clockwise.
        /// </summary>
        void CopyRegion (BitmapSource source, Int32Rect rect, WriteableBitmap target, int dst_x, int dst_y)
        {
            int bpp = source.Format.BitsPerPixel / 8;
            int width = rect.Width;
            int height = rect.Height;
            int src_stride = width * bpp;
            var src_pixels = new byte[src_stride * height];
            source.CopyPixels (rect, src_pixels, src_stride, 0);

            var transformed = new byte[src_pixels.Length];
            int dst_stride = height * bpp;
            for (int y = 0; y < height; ++y)
            {
                int src = y * src_stride;
                int dst = (width - 1) * dst_stride + y * bpp;
                for (int x = 0; x < width; ++x)
                {
                    for (int p = 0; p < bpp; ++p)
                    {
                        transformed[dst+p] = src_pixels[src+p];
                    }
                    src += bpp;
                    dst -= dst_stride;
                }
            }
            var target_rect = new Int32Rect (0, 0, height, width);
            target.WritePixels (target_rect, transformed, dst_stride, dst_x, dst_y);
        }

        PckScheme DefaultScheme = new PckScheme {
            KnownKeys = new Dictionary<string, byte[]>()
        };

        public Dictionary<string, byte[]> KnownKeys { get { return DefaultScheme.KnownKeys;  } }

        public override ResourceScheme Scheme
        {
            get { return DefaultScheme; }
            set { DefaultScheme = (PckScheme)value; }
        }

        public override object GetAccessWidget ()
        {
            return new GUI.WidgetPCK (KnownKeys.Keys.OrderBy (x => x));
        }

        public override ResourceOptions GetDefaultOptions ()
        {
            return new PckOptions {
                Key = GetKeyForTitle (Properties.Settings.Default.PCKTitle)
            };
        }

        byte[] QueryKey (string arc_name)
        {
            if (0 == KnownKeys.Count)
                return null;
            if (1 == KnownKeys.Count)
                return KnownKeys.Values.First();
            var title = FormatCatalog.Instance.LookupGame (arc_name);
            var key = GetKeyForTitle (title);
            if (key != null)
                return key;
            var options = Query<PckOptions> (arcStrings.ArcEncryptedNotice);
            return options.Key;
        }

        byte[] GetKeyForTitle (string title)
        {
            byte[] key = null;
            if (!string.IsNullOrEmpty (title))
                KnownKeys.TryGetValue (title, out key);
            return key;
        }
    }

    [Export(typeof(ResourceAlias))]
    [ExportMetadata("Extension", "TMX")]
    [ExportMetadata("Target", "DAT/GENERIC")]
    public class TmxFormat : ResourceAlias { }
}