GARbro-mirror/GameRes/ImageBMP.cs

//! \file       ImageBMP.cs
//! \date       Wed Jul 16 18:06:47 2014
//! \brief      BMP image implementation.
//
// Copyright (C) 2014-2016 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.IO;
using System.Linq;
using System.Text;
using System.Collections.Generic;
using System.ComponentModel.Composition;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using GameRes.Strings;
using GameRes.Utility;

namespace GameRes
{
    public class BmpMetaData : ImageMetaData
    {
        public uint ImageLength;
        public uint ImageOffset;
    }

    public interface IBmpExtension
    {
        ImageData Read (IBinaryStream file, BmpMetaData info);
    }

    [Export(typeof(ImageFormat))]
    [ExportMetadata("Priority", 10)]
    public sealed class BmpFormat : ImageFormat
    {
        public override string         Tag { get { return "BMP"; } }
        public override string Description { get { return "Windows device independent bitmap"; } }
        public override uint     Signature { get { return 0; } }
        public override bool      CanWrite { get { return true; } }

        public BmpFormat ()
        {
            Settings = new[] { EnableExtensions };
        }

        #pragma warning disable 649
        [ImportMany(typeof(IBmpExtension))]
        private IEnumerable<IBmpExtension>  m_extensions;
        #pragma warning restore 649

        LocalResourceSetting EnableExtensions = new LocalResourceSetting {
            Name        = "BMPEnableExtensions",
            Text        = garStrings.BMPExtensionsText,
            Description = garStrings.BMPExtensionsDesc,
        };

        public override ImageData Read (IBinaryStream file, ImageMetaData info)
        {
            var bmp_info = info as BmpMetaData;
            if (bmp_info != null && EnableExtensions.Get<bool>() && file.AsStream.CanSeek)
            {
                foreach (var ext in m_extensions)
                {
                    try
                    {
                        var image = ext.Read (file, bmp_info);
                        if (null != image)
                            return image;
                    }
                    catch (System.Exception X)
                    {
                        System.Diagnostics.Trace.WriteLine (X.Message, ext.ToString());
                    }
                    file.Position = 0;
                }
            }
            var decoder = new BmpBitmapDecoder (file.AsStream,
                BitmapCreateOptions.None, BitmapCacheOption.OnLoad);
            BitmapSource frame = decoder.Frames.First();
            frame.Freeze();
            return new ImageData (frame, info);
        }

        public override void Write (Stream file, ImageData image)
        {
            var encoder = new BmpBitmapEncoder();
            encoder.Frames.Add (BitmapFrame.Create (image.Bitmap, null, null, null));
            encoder.Save (file);
        }

        public override ImageMetaData ReadMetaData (IBinaryStream file)
        {
            int c1 = file.ReadByte();
            int c2 = file.ReadByte();
            if ('B' != c1 || 'M' != c2)
                return null;
            uint size = file.ReadUInt32();
            file.ReadUInt32();
            uint image_offset = file.ReadUInt32();
            uint header_size = file.ReadUInt32();
            if (size < 14+header_size)
            {
                // some otherwise valid bitmaps have size field set to zero
                if (size != 0 && size != 0xE || !file.AsStream.CanSeek)
                    return null;
                size = (uint)file.Length;
            }
            else if (file.AsStream.CanSeek)
            {
                if (size > file.Length)
                    size = (uint)file.Length;
            }
            uint width, height;
            if (0xC == header_size)
            {
                width  = file.ReadUInt16();
                height = file.ReadUInt16();
            }
            else if (header_size < 40 || size-14 < header_size)
            {
                return null;
            }
            else
            {
                width  = file.ReadUInt32();
                height = file.ReadUInt32();
            }
            file.ReadInt16();
            int bpp = file.ReadInt16();
            return new BmpMetaData {
                Width = width,
                Height = height,
                OffsetX = 0,
                OffsetY = 0,
                BPP = bpp,
                ImageLength = size,
                ImageOffset = image_offset,
            };
        }
    }

    [Export(typeof(IBmpExtension))]
    public class BitmapWithAlpha : IBmpExtension
    {
        public ImageData Read (IBinaryStream file, BmpMetaData info)
        {
            if (file.AsStream.CanSeek)
            {
                var width_x_height = info.Width * info.Height;
                uint bmp_length = width_x_height * (uint)info.BPP/8 + info.ImageOffset;
                if (bmp_length == info.ImageLength || bmp_length+2 == info.ImageLength)
                {
                    if (0x20 == info.BPP)
                    {
                        return ReadBitmapBGRA (file, info);
                    }
                    else if (0x18 == info.BPP)
                    {
                        uint length_with_alpha = info.ImageLength + width_x_height;
                        if (length_with_alpha == file.Length || length_with_alpha + info.Width == file.Length)
                            return ReadBitmapWithAlpha (file, info);
                    }
                }
                else if (0x20 == info.BPP && (info.ImageLength - (width_x_height * 3 + info.ImageOffset)) <= 2)
                {
                    return ReadBitmapBGRA (file, info);
                }
            }
            return null;
        }

        private ImageData ReadBitmapWithAlpha (IBinaryStream file, BmpMetaData info)
        {
            file.Position = info.ImageLength;
            var alpha = new byte[info.Width*info.Height];
            if (alpha.Length != file.Read (alpha, 0, alpha.Length))
                throw new EndOfStreamException();

            file.Position = info.ImageOffset;
            int dst_stride = (int)info.Width * 4;
            var pixels = new byte[(int)info.Height * dst_stride];
            int a_src = 0;
            for (int y = (int)info.Height-1; y >= 0; --y)
            {
                int dst = dst_stride * y;
                for (int x = 0; x < dst_stride; x += 4)
                {
                    file.Read (pixels, dst+x, 3);
                    pixels[dst+x+3] = alpha[a_src++];
                }
            }
            return ImageData.Create (info, PixelFormats.Bgra32, null, pixels, dst_stride);
        }

        private ImageData ReadBitmapBGRA (IBinaryStream file, BmpMetaData info)
        {
            file.Position = info.ImageOffset;
            int stride = (int)info.Width * 4;
            var pixels = new byte[(int)info.Height * stride];
            bool has_alpha = false;
            for (int y = (int)info.Height-1; y >= 0; --y)
            {
                int dst = stride * y;
                file.Read (pixels, dst, stride);
                for (int x = 3; !has_alpha && x < stride; x += 4)
                    has_alpha = pixels[dst+x] != 0;
                /* // sometimes alpha channel is inverted
                for (int x = 3; x < stride; x += 4)
                {
                    pixels[dst+x] ^= 0xFF;
                    has_alpha = has_alpha || pixels[dst+x] != 0;
                }
                */
            }
            PixelFormat format = has_alpha ? PixelFormats.Bgra32 : PixelFormats.Bgr32;
            return ImageData.Create (info, format, null, pixels, stride);
        }
    }
}