Merge pull request #47 from ilamp/main

Restoring Martialing to fix buffer length issues
SharpAdb · Apr 4, 2023 · e4d83fd · e4d83fd
2 parents 9c72a09 + 7691321
commit e4d83fd
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 8 deletions.
diff --git a/AdvancedSharpAdbClient.Tests/Models/FramebufferHeaderTests.cs b/AdvancedSharpAdbClient.Tests/Models/FramebufferHeaderTests.cs
@@ -66,7 +66,7 @@ public void ToImageTest()
             FramebufferHeader header = FramebufferHeader.Read(data);
             header.Width = 1;
             header.Height = 1;
-
+            header.Size = 4;
             byte[] framebuffer = File.ReadAllBytes("Assets/framebuffer.bin");
             using Bitmap image = (Bitmap)header.ToImage(framebuffer);
             Assert.NotNull(image);

diff --git a/AdvancedSharpAdbClient/Framebuffer.cs b/AdvancedSharpAdbClient/Framebuffer.cs
@@ -6,6 +6,8 @@
 using System.Drawing;
 using System.Threading;
 using System.Threading.Tasks;
+using System.Runtime.InteropServices;
+using System.Buffers;
 
 #if NET
 using System.Runtime.Versioning;
@@ -35,7 +37,8 @@ public Framebuffer(DeviceData device, AdbClient client)
             this.client = client ?? throw new ArgumentNullException(nameof(client));
 
             // Initialize the headerData buffer
-            headerData = new byte[52];
+            var size = Marshal.SizeOf(default(FramebufferHeader));
+            this.headerData = new byte[size];
         }
 
         /// <summary>
@@ -84,7 +87,13 @@ public async Task RefreshAsync(CancellationToken cancellationToken = default)
 
             if (Data == null || Data.Length < Header.Size)
             {
-                Data = new byte[Header.Size];
+                // Optimization on .NET Core: Use the BufferPool to rent buffers
+                if (Data != null)
+                {
+                    ArrayPool<byte>.Shared.Return(Data, clearArray: false);
+                }
+
+                Data = ArrayPool<byte>.Shared.Rent((int)Header.Size);
             }
 
             // followed by the actual framebuffer content
@@ -108,6 +117,11 @@ public Image ToImage()
         /// <inheritdoc/>
         public void Dispose()
         {
+            if (Data != null)
+            {
+                ArrayPool<byte>.Shared.Return(Data, clearArray: false);
+            }
+
             headerData = null;
             headerInitialized = false;
             disposed = true;

diff --git a/AdvancedSharpAdbClient/Models/FramebufferHeader.cs b/AdvancedSharpAdbClient/Models/FramebufferHeader.cs
@@ -168,7 +168,7 @@ public Image ToImage(byte[] buffer)
 #if HAS_Process
             Bitmap bitmap = new((int)Width, (int)Height, pixelFormat);
             BitmapData bitmapData = bitmap.LockBits(new Rectangle(0, 0, bitmap.Width, bitmap.Height), ImageLockMode.WriteOnly, pixelFormat);
-            Marshal.Copy(buffer, 0, bitmapData.Scan0, buffer.Length);
+            Marshal.Copy(buffer, 0, bitmapData.Scan0, (int)Size);
             bitmap.UnlockBits(bitmapData);
 
             return bitmap;
@@ -196,10 +196,10 @@ private PixelFormat StandardizePixelFormat(byte[] buffer)
                 throw new ArgumentNullException(nameof(buffer));
             }
 
-            if (buffer.Length != Width * Height * (Bpp / 8))
+            if (buffer.Length < Width * Height * (Bpp / 8))
             {
-                throw new ArgumentOutOfRangeException(nameof(buffer), $"The buffer length {buffer.Length} does not match the expected buffer " +
-                    $"length for a picture of width {Width}, height {Height} and pixel depth {Bpp}");
+                throw new ArgumentOutOfRangeException(nameof(buffer), $"The buffer length {buffer.Length} is less than expected buffer " +
+                    $"length ({Width * Height * (Bpp / 8)}) for a picture of width {Width}, height {Height} and pixel depth {Bpp}");
             }
 
             if (Width == 0 || Height == 0 || Bpp == 0)
@@ -230,7 +230,7 @@ private PixelFormat StandardizePixelFormat(byte[] buffer)
                 uint alphaIndex = Alpha.Offset / 8;
 
                 // Loop over the array and re-order as required
-                for (int i = 0; i < buffer.Length; i += 4)
+                for (int i = 0; i < (int)Size; i += 4)
                 {
                     byte red = buffer[i + redIndex];
                     byte blue = buffer[i + blueIndex];