ImageSharp/tests/ImageSharp.Tests/Image/ImageTests.WrapMemory.cs

// Copyright (c) Six Labors.
// Licensed under the Apache License, Version 2.0.

using System;
using System.Buffers;
using System.Drawing;
using System.Drawing.Imaging;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
using SixLabors.ImageSharp.Advanced;
using SixLabors.ImageSharp.Common.Helpers;
using SixLabors.ImageSharp.Metadata;
using SixLabors.ImageSharp.PixelFormats;
using Xunit;

// ReSharper disable InconsistentNaming
namespace SixLabors.ImageSharp.Tests
{
    public partial class ImageTests
    {
        public class WrapMemory
        {
            /// <summary>
            /// A <see cref="MemoryManager{T}"/> exposing the locked pixel memory of a <see cref="Bitmap"/> instance.
            /// TODO: This should be an example in https://github.com/SixLabors/Samples
            /// </summary>
            public class BitmapMemoryManager : MemoryManager<Bgra32>
            {
                private readonly Bitmap bitmap;

                private readonly BitmapData bmpData;

                private readonly int length;

                public BitmapMemoryManager(Bitmap bitmap)
                {
                    if (bitmap.PixelFormat != PixelFormat.Format32bppArgb)
                    {
                        throw new ArgumentException("bitmap.PixelFormat != PixelFormat.Format32bppArgb", nameof(bitmap));
                    }

                    this.bitmap = bitmap;
                    var rectangle = new System.Drawing.Rectangle(0, 0, bitmap.Width, bitmap.Height);
                    this.bmpData = bitmap.LockBits(rectangle, ImageLockMode.ReadWrite, bitmap.PixelFormat);
                    this.length = bitmap.Width * bitmap.Height;
                }

                public bool IsDisposed { get; private set; }

                protected override void Dispose(bool disposing)
                {
                    if (this.IsDisposed)
                    {
                        return;
                    }

                    if (disposing)
                    {
                        this.bitmap.UnlockBits(this.bmpData);
                    }

                    this.IsDisposed = true;
                }

                public override unsafe Span<Bgra32> GetSpan()
                {
                    void* ptr = (void*)this.bmpData.Scan0;
                    return new Span<Bgra32>(ptr, this.length);
                }

                public override unsafe MemoryHandle Pin(int elementIndex = 0)
                {
                    void* ptr = (void*)this.bmpData.Scan0;
                    return new MemoryHandle(ptr, pinnable: this);
                }

                public override void Unpin()
                {
                }
            }

            public sealed class CastMemoryManager<TFrom, TTo> : MemoryManager<TTo>
                where TFrom : unmanaged
                where TTo : unmanaged
            {
                private readonly Memory<TFrom> memory;

                public CastMemoryManager(Memory<TFrom> memory)
                {
                    this.memory = memory;
                }

                /// <inheritdoc/>
                protected override void Dispose(bool disposing)
                {
                }

                /// <inheritdoc/>
                public override Span<TTo> GetSpan()
                {
                    return MemoryMarshal.Cast<TFrom, TTo>(this.memory.Span);
                }

                /// <inheritdoc/>
                public override MemoryHandle Pin(int elementIndex = 0)
                {
                    int byteOffset = elementIndex * Unsafe.SizeOf<TTo>();
                    int shiftedOffset = Math.DivRem(byteOffset, Unsafe.SizeOf<TFrom>(), out int remainder);

                    if (remainder != 0)
                    {
                        ThrowHelper.ThrowArgumentException("The input index doesn't result in an aligned item access", nameof(elementIndex));
                    }

                    return this.memory.Slice(shiftedOffset).Pin();
                }

                /// <inheritdoc/>
                public override void Unpin()
                {
                }
            }

            [Fact]
            public void WrapMemory_CreatedImageIsCorrect()
            {
                var cfg = Configuration.CreateDefaultInstance();
                var metaData = new ImageMetadata();

                var array = new Rgba32[25];
                var memory = new Memory<Rgba32>(array);

                using (var image = Image.WrapMemory(cfg, memory, 5, 5, metaData))
                {
                    Assert.True(image.TryGetSinglePixelSpan(out Span<Rgba32> imageSpan));
                    ref Rgba32 pixel0 = ref imageSpan[0];
                    Assert.True(Unsafe.AreSame(ref array[0], ref pixel0));

                    Assert.Equal(cfg, image.GetConfiguration());
                    Assert.Equal(metaData, image.Metadata);
                }
            }

            [Fact]
            public void WrapSystemDrawingBitmap_WhenObserved()
            {
                if (ShouldSkipBitmapTest)
                {
                    return;
                }

                using (var bmp = new Bitmap(51, 23))
                {
                    using (var memoryManager = new BitmapMemoryManager(bmp))
                    {
                        Memory<Bgra32> memory = memoryManager.Memory;
                        Bgra32 bg = Color.Red;
                        Bgra32 fg = Color.Green;

                        using (var image = Image.WrapMemory(memory, bmp.Width, bmp.Height))
                        {
                            Assert.Equal(memory, image.GetRootFramePixelBuffer().DangerousGetSingleMemory());
                            Assert.True(image.TryGetSinglePixelSpan(out Span<Bgra32> imageSpan));
                            imageSpan.Fill(bg);
                            for (var i = 10; i < 20; i++)
                            {
                                image.GetPixelRowSpan(i).Slice(10, 10).Fill(fg);
                            }
                        }

                        Assert.False(memoryManager.IsDisposed);
                    }

                    string fn = System.IO.Path.Combine(
                        TestEnvironment.ActualOutputDirectoryFullPath,
                        $"{nameof(this.WrapSystemDrawingBitmap_WhenObserved)}.bmp");

                    bmp.Save(fn, ImageFormat.Bmp);
                }
            }

            [Fact]
            public void WrapSystemDrawingBitmap_WhenOwned()
            {
                if (ShouldSkipBitmapTest)
                {
                    return;
                }

                using (var bmp = new Bitmap(51, 23))
                {
                    var memoryManager = new BitmapMemoryManager(bmp);
                    Bgra32 bg = Color.Red;
                    Bgra32 fg = Color.Green;

                    using (var image = Image.WrapMemory(memoryManager, bmp.Width, bmp.Height))
                    {
                        Assert.Equal(memoryManager.Memory, image.GetRootFramePixelBuffer().DangerousGetSingleMemory());
                        Assert.True(image.TryGetSinglePixelSpan(out Span<Bgra32> imageSpan));
                        imageSpan.Fill(bg);
                        for (var i = 10; i < 20; i++)
                        {
                            image.GetPixelRowSpan(i).Slice(10, 10).Fill(fg);
                        }
                    }

                    Assert.True(memoryManager.IsDisposed);

                    string fn = System.IO.Path.Combine(
                        TestEnvironment.ActualOutputDirectoryFullPath,
                        $"{nameof(this.WrapSystemDrawingBitmap_WhenOwned)}.bmp");

                    bmp.Save(fn, ImageFormat.Bmp);
                }
            }

            [Fact]
            public void WrapMemory_FromBytes_CreatedImageIsCorrect()
            {
                var cfg = Configuration.CreateDefaultInstance();
                var metaData = new ImageMetadata();

                var array = new byte[25 * Unsafe.SizeOf<Rgba32>()];
                var memory = new Memory<byte>(array);

                using (var image = Image.WrapMemory<Rgba32>(cfg, memory, 5, 5, metaData))
                {
                    Assert.True(image.TryGetSinglePixelSpan(out Span<Rgba32> imageSpan));
                    ref Rgba32 pixel0 = ref imageSpan[0];
                    Assert.True(Unsafe.AreSame(ref Unsafe.As<byte, Rgba32>(ref array[0]), ref pixel0));

                    Assert.Equal(cfg, image.GetConfiguration());
                    Assert.Equal(metaData, image.Metadata);
                }
            }

            [Fact]
            public void WrapSystemDrawingBitmap_FromBytes_WhenObserved()
            {
                if (ShouldSkipBitmapTest)
                {
                    return;
                }

                using (var bmp = new Bitmap(51, 23))
                {
                    using (var memoryManager = new BitmapMemoryManager(bmp))
                    {
                        Memory<Bgra32> pixelMemory = memoryManager.Memory;
                        Memory<byte> byteMemory = new CastMemoryManager<Bgra32, byte>(pixelMemory).Memory;
                        Bgra32 bg = Color.Red;
                        Bgra32 fg = Color.Green;

                        using (var image = Image.WrapMemory<Bgra32>(byteMemory, bmp.Width, bmp.Height))
                        {
                            Span<Bgra32> pixelSpan = pixelMemory.Span;
                            Span<Bgra32> imageSpan = image.GetRootFramePixelBuffer().DangerousGetSingleMemory().Span;

                            // We can't compare the two Memory<T> instances directly as they wrap different memory managers.
                            // To check that the underlying data matches, we can just manually check their lenth, and the
                            // fact that a reference to the first pixel in both spans is actually the same memory location.
                            Assert.Equal(pixelSpan.Length, imageSpan.Length);
                            Assert.True(Unsafe.AreSame(ref pixelSpan.GetPinnableReference(), ref imageSpan.GetPinnableReference()));

                            Assert.True(image.TryGetSinglePixelSpan(out imageSpan));
                            imageSpan.Fill(bg);
                            for (var i = 10; i < 20; i++)
                            {
                                image.GetPixelRowSpan(i).Slice(10, 10).Fill(fg);
                            }
                        }

                        Assert.False(memoryManager.IsDisposed);
                    }

                    string fn = System.IO.Path.Combine(
                        TestEnvironment.ActualOutputDirectoryFullPath,
                        $"{nameof(this.WrapSystemDrawingBitmap_WhenObserved)}.bmp");

                    bmp.Save(fn, ImageFormat.Bmp);
                }
            }

            [Fact]
            public unsafe void WrapMemory_FromPointer_CreatedImageIsCorrect()
            {
                var cfg = Configuration.CreateDefaultInstance();
                var metaData = new ImageMetadata();

                var array = new Rgba32[25];

                fixed (void* ptr = array)
                {
                    using (var image = Image.WrapMemory<Rgba32>(cfg, ptr, 5, 5, metaData))
                    {
                        Assert.True(image.TryGetSinglePixelSpan(out Span<Rgba32> imageSpan));
                        ref Rgba32 pixel0 = ref imageSpan[0];
                        Assert.True(Unsafe.AreSame(ref array[0], ref pixel0));
                        ref Rgba32 pixel_1 = ref imageSpan[imageSpan.Length - 1];
                        Assert.True(Unsafe.AreSame(ref array[array.Length - 1], ref pixel_1));

                        Assert.Equal(cfg, image.GetConfiguration());
                        Assert.Equal(metaData, image.Metadata);
                    }
                }
            }

            [Fact]
            public unsafe void WrapSystemDrawingBitmap_FromPointer()
            {
                if (ShouldSkipBitmapTest)
                {
                    return;
                }

                using (var bmp = new Bitmap(51, 23))
                {
                    using (var memoryManager = new BitmapMemoryManager(bmp))
                    {
                        Memory<Bgra32> pixelMemory = memoryManager.Memory;
                        Bgra32 bg = Color.Red;
                        Bgra32 fg = Color.Green;

                        fixed (void* p = pixelMemory.Span)
                        {
                            using (var image = Image.WrapMemory<Bgra32>(p, bmp.Width, bmp.Height))
                            {
                                Span<Bgra32> pixelSpan = pixelMemory.Span;
                                Span<Bgra32> imageSpan = image.GetRootFramePixelBuffer().DangerousGetSingleMemory().Span;

                                Assert.Equal(pixelSpan.Length, imageSpan.Length);
                                Assert.True(Unsafe.AreSame(ref pixelSpan.GetPinnableReference(), ref imageSpan.GetPinnableReference()));

                                Assert.True(image.TryGetSinglePixelSpan(out imageSpan));
                                imageSpan.Fill(bg);
                                for (var i = 10; i < 20; i++)
                                {
                                    image.GetPixelRowSpan(i).Slice(10, 10).Fill(fg);
                                }
                            }

                            Assert.False(memoryManager.IsDisposed);
                        }
                    }

                    string fn = System.IO.Path.Combine(
                        TestEnvironment.ActualOutputDirectoryFullPath,
                        $"{nameof(this.WrapSystemDrawingBitmap_WhenObserved)}.bmp");

                    bmp.Save(fn, ImageFormat.Bmp);
                }
            }

            [Theory]
            [InlineData(0, 5, 5)]
            [InlineData(20, 5, 5)]
            [InlineData(1023, 32, 32)]
            public void WrapMemory_MemoryOfT_InvalidSize(int size, int height, int width)
            {
                var array = new Rgba32[size];
                var memory = new Memory<Rgba32>(array);

                Assert.Throws<ArgumentException>(() => Image.WrapMemory(memory, height, width));
            }

            [Theory]
            [InlineData(25, 5, 5)]
            [InlineData(26, 5, 5)]
            [InlineData(2, 1, 1)]
            [InlineData(1024, 32, 32)]
            [InlineData(2048, 32, 32)]
            public void WrapMemory_MemoryOfT_ValidSize(int size, int height, int width)
            {
                var array = new Rgba32[size];
                var memory = new Memory<Rgba32>(array);

                Image.WrapMemory(memory, height, width);
            }

            private class TestMemoryOwner<T> : IMemoryOwner<T>
            {
                public bool Disposed { get; private set; }

                public Memory<T> Memory { get; set; }

                public void Dispose() => this.Disposed = true;
            }

            [Theory]
            [InlineData(0, 5, 5)]
            [InlineData(20, 5, 5)]
            [InlineData(1023, 32, 32)]
            public void WrapMemory_IMemoryOwnerOfT_InvalidSize(int size, int height, int width)
            {
                var array = new Rgba32[size];
                var memory = new TestMemoryOwner<Rgba32> { Memory = array };

                Assert.Throws<ArgumentException>(() => Image.WrapMemory(memory, height, width));
            }

            [Theory]
            [InlineData(25, 5, 5)]
            [InlineData(26, 5, 5)]
            [InlineData(2, 1, 1)]
            [InlineData(1024, 32, 32)]
            [InlineData(2048, 32, 32)]
            public void WrapMemory_IMemoryOwnerOfT_ValidSize(int size, int height, int width)
            {
                var array = new Rgba32[size];
                var memory = new TestMemoryOwner<Rgba32> { Memory = array };

                using (var img = Image.WrapMemory<Rgba32>(memory, width, height))
                {
                    Assert.Equal(width, img.Width);
                    Assert.Equal(height, img.Height);

                    for (int i = 0; i < height; ++i)
                    {
                        var arrayIndex = width * i;

                        Span<Rgba32> rowSpan = img.GetPixelRowSpan(i);
                        ref Rgba32 r0 = ref rowSpan[0];
                        ref Rgba32 r1 = ref array[arrayIndex];

                        Assert.True(Unsafe.AreSame(ref r0, ref r1));
                    }
                }

                Assert.True(memory.Disposed);
            }

            [Theory]
            [InlineData(0, 5, 5)]
            [InlineData(20, 5, 5)]
            [InlineData(1023, 32, 32)]
            public void WrapMemory_IMemoryOwnerOfByte_InvalidSize(int size, int height, int width)
            {
                var array = new byte[size * Unsafe.SizeOf<Rgba32>()];
                var memory = new TestMemoryOwner<byte> { Memory = array };

                Assert.Throws<ArgumentException>(() => Image.WrapMemory<Rgba32>(memory, height, width));
            }

            [Theory]
            [InlineData(25, 5, 5)]
            [InlineData(26, 5, 5)]
            [InlineData(2, 1, 1)]
            [InlineData(1024, 32, 32)]
            [InlineData(2048, 32, 32)]
            public void WrapMemory_IMemoryOwnerOfByte_ValidSize(int size, int height, int width)
            {
                var pixelSize = Unsafe.SizeOf<Rgba32>();
                var array = new byte[size * pixelSize];
                var memory = new TestMemoryOwner<byte> { Memory = array };

                using (var img = Image.WrapMemory<Rgba32>(memory, width, height))
                {
                    Assert.Equal(width, img.Width);
                    Assert.Equal(height, img.Height);

                    for (int i = 0; i < height; ++i)
                    {
                        var arrayIndex = pixelSize * width * i;

                        Span<Rgba32> rowSpan = img.GetPixelRowSpan(i);
                        ref Rgba32 r0 = ref rowSpan[0];
                        ref Rgba32 r1 = ref Unsafe.As<byte, Rgba32>(ref array[arrayIndex]);

                        Assert.True(Unsafe.AreSame(ref r0, ref r1));
                    }
                }

                Assert.True(memory.Disposed);
            }

            [Theory]
            [InlineData(0, 5, 5)]
            [InlineData(20, 5, 5)]
            [InlineData(1023, 32, 32)]
            public void WrapMemory_MemoryOfByte_InvalidSize(int size, int height, int width)
            {
                var array = new byte[size * Unsafe.SizeOf<Rgba32>()];
                var memory = new Memory<byte>(array);

                Assert.Throws<ArgumentException>(() => Image.WrapMemory<Rgba32>(memory, height, width));
            }

            [Theory]
            [InlineData(25, 5, 5)]
            [InlineData(26, 5, 5)]
            [InlineData(2, 1, 1)]
            [InlineData(1024, 32, 32)]
            [InlineData(2048, 32, 32)]
            public void WrapMemory_MemoryOfByte_ValidSize(int size, int height, int width)
            {
                var array = new byte[size * Unsafe.SizeOf<Rgba32>()];
                var memory = new Memory<byte>(array);

                Image.WrapMemory<Rgba32>(memory, height, width);
            }

            [Theory]
            [InlineData(0, 5, 5)]
            [InlineData(20, 5, 5)]
            [InlineData(26, 5, 5)]
            [InlineData(2, 1, 1)]
            [InlineData(1023, 32, 32)]
            public unsafe void WrapMemory_Pointer_Null(int size, int height, int width)
            {
                Assert.Throws<ArgumentException>(() => Image.WrapMemory<Rgba32>((void*)null, height, width));
            }

            private static bool ShouldSkipBitmapTest =>
                !TestEnvironment.Is64BitProcess || (TestHelpers.ImageSharpBuiltAgainst != "netcoreapp3.1" && TestHelpers.ImageSharpBuiltAgainst != "netcoreapp2.1");
        }
    }
}