// Copyright (c) Six Labors. // Licensed under the Apache License, Version 2.0. using System; using System.Linq; using SixLabors.ImageSharp.Advanced; using SixLabors.ImageSharp.PixelFormats; using Xunit; namespace SixLabors.ImageSharp.Tests { public abstract partial class ImageFrameCollectionTests { [GroupOutput("ImageFramesCollectionTests")] public class Generic : ImageFrameCollectionTests { [Fact] public void Constructor_ShouldCreateOneFrame() { Assert.Equal(1, this.Collection.Count); } [Fact] public void AddNewFrame_FramesMustHaveSameSize() { ArgumentException ex = Assert.Throws( () => { using var frame = new ImageFrame(Configuration.Default, 1, 1); using ImageFrame addedFrame = this.Collection.AddFrame(frame); }); Assert.StartsWith("Frame must have the same dimensions as the image.", ex.Message); } [Fact] public void AddNewFrame_Frame_FramesNotBeNull() { ArgumentNullException ex = Assert.Throws( () => { using ImageFrame addedFrame = this.Collection.AddFrame((ImageFrame)null); }); Assert.StartsWith("Parameter \"frame\" must be not null.", ex.Message); } [Fact] public void AddNewFrame_PixelBuffer_DataMustNotBeNull() { Rgba32[] data = null; ArgumentNullException ex = Assert.Throws( () => { using ImageFrame addedFrame = this.Collection.AddFrame(data); }); Assert.StartsWith("Parameter \"source\" must be not null.", ex.Message); } [Fact] public void AddNewFrame_PixelBuffer_BufferIncorrectSize() { ArgumentOutOfRangeException ex = Assert.Throws( () => { using ImageFrame addedFrame = this.Collection.AddFrame(Array.Empty()); }); Assert.StartsWith($"Parameter \"data\" ({typeof(int)}) must be greater than or equal to {100}, was {0}", ex.Message); } [Fact] public void InsertNewFrame_FramesMustHaveSameSize() { ArgumentException ex = Assert.Throws( () => { using var frame = new ImageFrame(Configuration.Default, 1, 1); using ImageFrame insertedFrame = this.Collection.InsertFrame(1, frame); }); Assert.StartsWith("Frame must have the same dimensions as the image.", ex.Message); } [Fact] public void InsertNewFrame_FramesNotBeNull() { ArgumentNullException ex = Assert.Throws( () => { using ImageFrame insertedFrame = this.Collection.InsertFrame(1, null); }); Assert.StartsWith("Parameter \"frame\" must be not null.", ex.Message); } [Fact] public void Constructor_FramesMustHaveSameSize() { ArgumentException ex = Assert.Throws( () => { using var imageFrame1 = new ImageFrame(Configuration.Default, 10, 10); using var imageFrame2 = new ImageFrame(Configuration.Default, 1, 1); new ImageFrameCollection( this.Image, new[] { imageFrame1, imageFrame2 }); }); Assert.StartsWith("Frame must have the same dimensions as the image.", ex.Message); } [Fact] public void RemoveAtFrame_ThrowIfRemovingLastFrame() { using var imageFrame = new ImageFrame(Configuration.Default, 10, 10); var collection = new ImageFrameCollection( this.Image, new[] { imageFrame }); InvalidOperationException ex = Assert.Throws( () => collection.RemoveFrame(0)); Assert.Equal("Cannot remove last frame.", ex.Message); } [Fact] public void RemoveAtFrame_CanRemoveFrameZeroIfMultipleFramesExist() { using var imageFrame1 = new ImageFrame(Configuration.Default, 10, 10); using var imageFrame2 = new ImageFrame(Configuration.Default, 10, 10); var collection = new ImageFrameCollection( this.Image, new[] { imageFrame1, imageFrame2 }); collection.RemoveFrame(0); Assert.Equal(1, collection.Count); } [Fact] public void RootFrameIsFrameAtIndexZero() { using var imageFrame1 = new ImageFrame(Configuration.Default, 10, 10); using var imageFrame2 = new ImageFrame(Configuration.Default, 10, 10); var collection = new ImageFrameCollection( this.Image, new[] { imageFrame1, imageFrame2 }); Assert.Equal(collection.RootFrame, collection[0]); } [Fact] public void ConstructorPopulatesFrames() { using var imageFrame1 = new ImageFrame(Configuration.Default, 10, 10); using var imageFrame2 = new ImageFrame(Configuration.Default, 10, 10); var collection = new ImageFrameCollection( this.Image, new[] { imageFrame1, imageFrame2 }); Assert.Equal(2, collection.Count); } [Fact] public void DisposeClearsCollection() { using var imageFrame1 = new ImageFrame(Configuration.Default, 10, 10); using var imageFrame2 = new ImageFrame(Configuration.Default, 10, 10); var collection = new ImageFrameCollection( this.Image, new[] { imageFrame1, imageFrame2 }); collection.Dispose(); Assert.Equal(0, collection.Count); } [Fact] public void Dispose_DisposesAllInnerFrames() { using var imageFrame1 = new ImageFrame(Configuration.Default, 10, 10); using var imageFrame2 = new ImageFrame(Configuration.Default, 10, 10); var collection = new ImageFrameCollection( this.Image, new[] { imageFrame1, imageFrame2 }); IPixelSource[] framesSnapShot = collection.OfType>().ToArray(); collection.Dispose(); Assert.All( framesSnapShot, f => { // The pixel source of the frame is null after its been disposed. Assert.Null(f.PixelBuffer); }); } [Theory] [WithTestPatternImages(10, 10, PixelTypes.Rgba32)] public void CloneFrame(TestImageProvider provider) where TPixel : unmanaged, IPixel { using (Image img = provider.GetImage()) { using var imageFrame = new ImageFrame(Configuration.Default, 10, 10); using ImageFrame addedFrame = img.Frames.AddFrame(imageFrame); // add a frame anyway using (Image cloned = img.Frames.CloneFrame(0)) { Assert.Equal(2, img.Frames.Count); Assert.True(img.TryGetSinglePixelSpan(out Span imgSpan)); cloned.ComparePixelBufferTo(imgSpan); } } } [Theory] [WithTestPatternImages(10, 10, PixelTypes.Rgba32)] public void ExtractFrame(TestImageProvider provider) where TPixel : unmanaged, IPixel { using (Image img = provider.GetImage()) { Assert.True(img.TryGetSinglePixelSpan(out Span imgSpan)); TPixel[] sourcePixelData = imgSpan.ToArray(); using var imageFrame = new ImageFrame(Configuration.Default, 10, 10); using ImageFrame addedFrame = img.Frames.AddFrame(imageFrame); using (Image cloned = img.Frames.ExportFrame(0)) { Assert.Equal(1, img.Frames.Count); cloned.ComparePixelBufferTo(sourcePixelData); } } } [Fact] public void CreateFrame_Default() { using (this.Image.Frames.CreateFrame()) { Assert.Equal(2, this.Image.Frames.Count); this.Image.Frames[1].ComparePixelBufferTo(default(Rgba32)); } } [Fact] public void CreateFrame_CustomFillColor() { using (this.Image.Frames.CreateFrame(Color.HotPink)) { Assert.Equal(2, this.Image.Frames.Count); this.Image.Frames[1].ComparePixelBufferTo(Color.HotPink); } } [Fact] public void AddFrameFromPixelData() { Assert.True(this.Image.Frames.RootFrame.TryGetSinglePixelSpan(out Span imgSpan)); Rgba32[] pixelData = imgSpan.ToArray(); using ImageFrame addedFrame = this.Image.Frames.AddFrame(pixelData); Assert.Equal(2, this.Image.Frames.Count); } [Fact] public void AddFrame_clones_sourceFrame() { using var otherFrame = new ImageFrame(Configuration.Default, 10, 10); using ImageFrame addedFrame = this.Image.Frames.AddFrame(otherFrame); Assert.True(otherFrame.TryGetSinglePixelSpan(out Span otherFrameSpan)); addedFrame.ComparePixelBufferTo(otherFrameSpan); Assert.NotEqual(otherFrame, addedFrame); } [Fact] public void InsertFrame_clones_sourceFrame() { using var otherFrame = new ImageFrame(Configuration.Default, 10, 10); using ImageFrame addedFrame = this.Image.Frames.InsertFrame(0, otherFrame); Assert.True(otherFrame.TryGetSinglePixelSpan(out Span otherFrameSpan)); addedFrame.ComparePixelBufferTo(otherFrameSpan); Assert.NotEqual(otherFrame, addedFrame); } [Fact] public void MoveFrame_LeavesFrameInCorrectLocation() { for (int i = 0; i < 9; i++) { this.Image.Frames.CreateFrame(); } ImageFrame frame = this.Image.Frames[4]; this.Image.Frames.MoveFrame(4, 7); int newIndex = this.Image.Frames.IndexOf(frame); Assert.Equal(7, newIndex); } [Fact] public void IndexOf_ReturnsCorrectIndex() { for (int i = 0; i < 9; i++) { this.Image.Frames.CreateFrame(); } ImageFrame frame = this.Image.Frames[4]; int index = this.Image.Frames.IndexOf(frame); Assert.Equal(4, index); } [Fact] public void Contains_TrueIfMember() { for (int i = 0; i < 9; i++) { this.Image.Frames.CreateFrame(); } ImageFrame frame = this.Image.Frames[4]; Assert.True(this.Image.Frames.Contains(frame)); } [Fact] public void Contains_FalseIfNonMember() { for (int i = 0; i < 9; i++) { this.Image.Frames.CreateFrame(); } using var frame = new ImageFrame(Configuration.Default, 10, 10); Assert.False(this.Image.Frames.Contains(frame)); } } } }