Merge pull request #3108 from SixLabors/js/imageinfobytes

Add ImageInfo.GetPixelMemorySize; docs & tests

Author: JimBobSquarePants

src/ImageSharp/Formats/Gif/GifDecoderCore.cs

@@ -468,7 +468,7 @@ private bool ReadFrame<TPixel>(
             int length = this.currentLocalColorTableSize = this.imageDescriptor.LocalColorTableSize * 3;
             this.currentLocalColorTable ??= this.configuration.MemoryAllocator.Allocate<byte>(768, AllocationOptions.Clean);
             stream.Read(this.currentLocalColorTable.GetSpan()[..length]);
-            rawColorTable = this.currentLocalColorTable!.GetSpan()[..length];
+            rawColorTable = this.currentLocalColorTable.GetSpan()[..length];
         }
         else if (this.globalColorTable != null)
         {

src/ImageSharp/ImageInfo.cs

@@ -63,8 +63,12 @@ public ImageInfo(
     public int Height => this.Size.Height;
 
     /// <summary>
-    /// Gets the number of frames in the image.
+    /// Gets the number of frame metadata entries available for the image.
     /// </summary>
+    /// <remarks>
+    /// This value is the same as <see cref="FrameMetadataCollection"/> count and may be <c>0</c> when frame
+    /// metadata was not populated by the decoder.
+    /// </remarks>
     public int FrameCount => this.FrameMetadataCollection.Count;
 
     /// <summary>
@@ -73,8 +77,12 @@ public ImageInfo(
     public ImageMetadata Metadata { get; }
 
     /// <summary>
-    /// Gets the collection of metadata associated with individual image frames.
+    /// Gets the metadata associated with the decoded image frames, if available.
     /// </summary>
+    /// <remarks>
+    /// For multi-frame formats, decoders populate one entry per decoded frame. For single-frame formats, this
+    /// collection is typically empty.
+    /// </remarks>
     public IReadOnlyList<ImageFrameMetadata> FrameMetadataCollection { get; }
 
     /// <summary>
@@ -86,4 +94,24 @@ public ImageInfo(
     /// Gets the bounds of the image.
     /// </summary>
     public Rectangle Bounds => new(Point.Empty, this.Size);
+
+    /// <summary>
+    /// Gets the total number of bytes required to store the image pixels in memory.
+    /// </summary>
+    /// <remarks>
+    /// This reports the in-memory size of the pixel data represented by this <see cref="ImageInfo"/>, not the
+    /// encoded size of the image file. The value is computed from the image dimensions and
+    /// <see cref="PixelType"/>. When <see cref="FrameMetadataCollection"/> contains decoded frame metadata, the
+    /// per-frame size is multiplied by that count. Otherwise, the value is the in-memory size of the single
+    /// image frame represented by this <see cref="ImageInfo"/>.
+    /// </remarks>
+    /// <returns>The total number of bytes required to store the image pixels in memory.</returns>
+    public long GetPixelMemorySize()
+    {
+        int count = this.FrameMetadataCollection.Count > 0
+            ? this.FrameMetadataCollection.Count
+            : 1;
+
+        return (long)this.Size.Width * this.Size.Height * (this.PixelType.BitsPerPixel / 8) * count;
+    }
 }

tests/ImageSharp.Tests/ImageInfoTests.cs

@@ -54,4 +54,34 @@ public void ImageInfoInitializesCorrectlyWithFrameMetadata()
         Assert.Equal(meta, info.Metadata);
         Assert.Equal(frameMetadata.Count, info.FrameMetadataCollection.Count);
     }
+
+    [Fact]
+    public void GetPixelMemorySize_UsesSingleFrameWhenFrameMetadataIsEmpty()
+    {
+        const int width = 10;
+        const int height = 20;
+
+        ImageMetadata meta = new() { DecodedImageFormat = PngFormat.Instance };
+        meta.GetPngMetadata();
+
+        ImageInfo info = new(new Size(width, height), meta);
+
+        Assert.Equal(width * height * 4, info.GetPixelMemorySize());
+    }
+
+    [Fact]
+    public void GetPixelMemorySize_UsesFrameMetadataCountWhenAvailable()
+    {
+        const int width = 10;
+        const int height = 20;
+        IReadOnlyList<ImageFrameMetadata> frameMetadata = [new(), new(), new()];
+
+        ImageMetadata meta = new() { DecodedImageFormat = PngFormat.Instance };
+        meta.GetPngMetadata();
+
+        ImageInfo info = new(new Size(width, height), meta, frameMetadata);
+
+        Assert.Equal(width * height * 4 * frameMetadata.Count, info.GetPixelMemorySize());
+    }
+
 }