Png chunk reader codec bitmap

binding/Binding/SKBitmap.cs

@@ -37,8 +37,6 @@ public static SKFilterQuality ToFilterQuality (this SKBitmapResizeMethod method)
 	}
 
 	// TODO: keep in mind SKBitmap may be going away (according to Google)
-	// TODO: `ComputeIsOpaque` may be useful
-	// TODO: `GenerationID` may be useful
 	// TODO: `GetAddr` and `GetPixel` are confusing
 
 	public unsafe class SKBitmap : SKObject, ISKSkipObjectRegistration
@@ -115,6 +113,47 @@ protected override void Dispose (bool disposing) =>
 		protected override void DisposeNative () =>
 			SkiaApi.sk_bitmap_destructor (Handle);
 
+		// Other
+
+		public bool SetInfo (SKImageInfo info) =>
+			SetInfo (info, 0);
+
+		public bool SetInfo (SKImageInfo info, int rowBytes)
+		{
+			var cinfo = SKImageInfoNative.FromManaged (ref info);
+			return SkiaApi.sk_bitmap_set_info (Handle, &cinfo, (IntPtr)rowBytes);
+		}
+
+		public bool ComputeIsOpaque () =>
+			SkiaApi.sk_bitmap_compute_is_opaque (Handle);
+
+		// AllocPixels
+
+		public void AllocPixels (SKImageInfo info) =>
+			AllocPixels (info, info.RowBytes);
+
+		public void AllocPixels (SKImageInfo info, int rowBytes)
+		{
+			if (!TryAllocPixels (info, rowBytes)) {
+				SKImageInfo i = Info;
+				throw new OutOfMemoryException ("SkBitmap::tryAllocPixels failed "
+					+ "ColorType:" + i.ColorType + "AlphaType:" + i.AlphaType +
+					"[w:" + i.Width + " h:" + i.Height + "] rb:" + RowBytes
+				);
+			}
+		}
+
+		public void AllocPixels (SKImageInfo info, SKBitmapAllocFlags flags)
+		{
+			if (!TryAllocPixels (info, flags)) {
+				SKImageInfo i = Info;
+				throw new OutOfMemoryException ("SkBitmap::tryAllocPixels failed "
+					+ "ColorType:" + i.ColorType + "AlphaType:" + i.AlphaType +
+					"[w:" + i.Width + " h:" + i.Height + "] rb:" + RowBytes
+				);
+			}
+		}
+
 		// TryAllocPixels
 
 		public bool TryAllocPixels (SKImageInfo info)
@@ -361,6 +400,9 @@ public int ByteCount {
 			get { return (int)SkiaApi.sk_bitmap_get_byte_count (Handle); }
 		}
 
+		public uint GenerationId =>
+			(uint)SkiaApi.sk_bitmap_get_generation_id (Handle);
+
 		// *Pixels*
 
 		public IntPtr GetPixels () =>
@@ -401,6 +443,14 @@ public void SetColorTable (SKColorTable ct)
 
 		// more properties
 
+		public SKPixmap Pixmap {
+			get {
+				var pixmap = new SKPixmap (SkiaApi.sk_bitmap_get_pixmap (Handle), false); // pixmap is owned by this
+				pixmap.pixelSource = this;
+				return pixmap;
+			}
+		}
+
 		public byte[] Bytes {
 			get {
 				var array = GetPixelSpan ().ToArray ();
@@ -723,6 +773,29 @@ public bool InstallPixels (SKImageInfo info, IntPtr pixels, int rowBytes, SKBitm
 			return SkiaApi.sk_bitmap_install_pixels (Handle, &cinfo, (void*)pixels, (IntPtr)rowBytes, proxy, (void*)ctx);
 		}
 
+		public bool ReadPixels (SKImageInfo info, IntPtr dstPixels, int rowBytes, int x, int y)
+		{
+			if (GetPixels () == IntPtr.Zero)
+				return false;
+			return Pixmap.ReadPixels (info, dstPixels, rowBytes, x, y);
+		}
+
+		public bool ReadPixels (SKPixmap dstPixmap) =>
+			ReadPixels (dstPixmap, 0, 0);
+
+		public bool ReadPixels (SKPixmap dstPixmap, int x, int y)
+		{
+			if (GetPixels () == IntPtr.Zero)
+				return false;
+			return Pixmap.ReadPixels (dstPixmap.Info, dstPixmap.GetPixels (), dstPixmap.RowBytes, x, y);
+		}
+
+		public bool WritePixels (SKPixmap pixmap) =>
+			WritePixels (pixmap, 0, 0);
+
+		public bool WritePixels (SKPixmap dstPixmap, int x, int y) =>
+			SkiaApi.sk_bitmap_write_pixels_at_location (Handle, dstPixmap.Handle, x, y);
+
 		public bool InstallPixels (SKPixmap pixmap)
 		{
 			return SkiaApi.sk_bitmap_install_pixels_with_pixmap (Handle, pixmap.Handle);
@@ -842,6 +915,9 @@ public static SKBitmap FromImage (SKImage image)
 			return bmp;
 		}
 
+		public SKImage ToImage () =>
+			SKImage.FromBitmap (this);
+
 		// Encode
 
 		public SKData Encode (SKEncodedImageFormat format, int quality)

binding/Binding/SKCodec.cs

@@ -4,7 +4,6 @@
 
 namespace SkiaSharp
 {
-	// TODO: `Create(...)` should have overloads that accept a SKPngChunkReader
 	// TODO: missing the `QueryYuv8` and `GetYuv8Planes` members
 
 	public unsafe class SKCodec : SKObject, ISKSkipObjectRegistration
@@ -42,6 +41,8 @@ public SKImageInfo Info {
 		public SKEncodedImageFormat EncodedFormat =>
 			SkiaApi.sk_codec_get_encoded_format (Handle);
 
+		public SKSizeI EncodedDimensions => Info.Size;
+
 		public SKSizeI GetScaledDimensions (float desiredScale)
 		{
 			SKSizeI dimensions;
@@ -277,53 +278,72 @@ public bool SkipScanlines (int countLines) =>
 		public int GetOutputScanline (int inputScanline) =>
 			SkiaApi.sk_codec_output_scanline (Handle, inputScanline);
 
-		// create (streams)
+		// create (filename)
 
 		public static SKCodec Create (string filename) =>
-			Create (filename, out var result);
+			Create (filename, null, SKCodecSelectionPolicy.PreferStillImage, out _);
+
+		public static SKCodec Create (string filename, out SKCodecResult result) =>
+			Create (filename, null, SKCodecSelectionPolicy.PreferStillImage, out result);
 
-		public static SKCodec Create (string filename, out SKCodecResult result)
+		public static SKCodec Create (string filename, SKPngChunkReader chunkReader, SKCodecSelectionPolicy selectionPolicy, out SKCodecResult result)
 		{
 			var stream = SKFileStream.OpenStream (filename);
 			if (stream == null) {
 				result = SKCodecResult.InternalError;
 				return null;
 			}
 
-			return Create (stream, out result);
+			return Create (stream, chunkReader, selectionPolicy, out result);
 		}
 
+		// create (Stream)
+
 		public static SKCodec Create (Stream stream) =>
-			Create (stream, out var result);
+			Create (WrapManagedStream (stream), null, SKCodecSelectionPolicy.PreferStillImage, out _);
 
 		public static SKCodec Create (Stream stream, out SKCodecResult result) =>
-			Create (WrapManagedStream (stream), out result);
+			Create (WrapManagedStream (stream), null, SKCodecSelectionPolicy.PreferStillImage, out result);
+
+		public static SKCodec Create (Stream stream, SKPngChunkReader chunkReader, SKCodecSelectionPolicy selectionPolicy, out SKCodecResult result) =>
+			Create (WrapManagedStream (stream), chunkReader, selectionPolicy, out result);
+
+		// create (SKStream)
 
 		public static SKCodec Create (SKStream stream) =>
-			Create (stream, out var result);
+			Create (stream, null, SKCodecSelectionPolicy.PreferStillImage, out _);
+
+		public static SKCodec Create (SKStream stream, out SKCodecResult result) =>
+			Create (stream, null, SKCodecSelectionPolicy.PreferStillImage, out result);
 
-		public static SKCodec Create (SKStream stream, out SKCodecResult result)
+		public static SKCodec Create (SKStream stream, SKPngChunkReader chunkReader, SKCodecSelectionPolicy selectionPolicy, out SKCodecResult result)
 		{
 			if (stream == null)
 				throw new ArgumentNullException (nameof (stream));
 			if (stream is SKFileStream filestream && !filestream.IsValid)
-				throw new ArgumentException ("File stream was not valid.", nameof(stream));
+				throw new ArgumentException ("File stream was not valid.", nameof (stream));
 
 			fixed (SKCodecResult* r = &result) {
-				var codec = GetObject (SkiaApi.sk_codec_new_from_stream (stream.Handle, r));
+				var codec = GetObject (SkiaApi.sk_codec_new_from_stream_with_pngchunkreader_and_selection_policy (stream.Handle, r, chunkReader?.Handle ?? IntPtr.Zero, selectionPolicy));
 				stream.RevokeOwnership (codec);
+				Referenced (codec, chunkReader);
 				return codec;
 			}
 		}
 
 		// create (data)
 
-		public static SKCodec Create (SKData data)
+		public static SKCodec Create (SKData data) =>
+			Create (data, null);
+
+		public static SKCodec Create (SKData data, SKPngChunkReader chunkReader)
 		{
 			if (data == null)
 				throw new ArgumentNullException (nameof (data));
 
-			return GetObject (SkiaApi.sk_codec_new_from_data (data.Handle));
+			var codec = GetObject (SkiaApi.sk_codec_new_from_data_with_pngchunkreader (data.Handle, chunkReader?.Handle ?? IntPtr.Zero));
+			Referenced (codec, chunkReader);
+			return codec;
 		}
 
 		// utils

binding/Binding/SKObject.cs

@@ -193,7 +193,7 @@ internal static T Owned<T> (T owner, SKObject child)
 			return owner;
 		}
 
-		// indicate that the chile should not be garbage collected while
+		// indicate that the child should not be garbage collected while
 		// the owner still lives
 		internal static T Referenced<T> (T owner, SKObject child)
 			where T : SKObject

binding/Binding/SKPngChunkReader.cs

@@ -0,0 +1,62 @@
+using System;
+using System.Runtime.InteropServices;
+using System.Threading;
+
+namespace SkiaSharp
+{
+	public unsafe abstract class SKPngChunkReader : SKObject, ISKSkipObjectRegistration
+	{
+		private static readonly SKManagedPngChunkReaderDelegates delegates;
+		private readonly IntPtr userData;
+		private int fromNative;
+
+		static SKPngChunkReader ()
+		{
+			delegates = new SKManagedPngChunkReaderDelegates {
+				fReadChunk = ReadChunkInternal,
+				fDestroy = DestroyInternal,
+			};
+
+			SkiaApi.sk_managedpngchunkreader_set_procs (delegates);
+		}
+
+		protected SKPngChunkReader ()
+			: base (IntPtr.Zero, true)
+		{
+			userData = DelegateProxies.CreateUserData (this, true);
+			Handle = SkiaApi.sk_managedpngchunkreader_new ((void*)userData);
+
+			if (Handle == IntPtr.Zero)
+				throw new InvalidOperationException ("Unable to create a new SKPngChunkReader instance.");
+		}
+
+		protected override void DisposeNative ()
+		{
+			if (Interlocked.CompareExchange (ref fromNative, 0, 0) == 0) {
+				SkiaApi.sk_managedpngchunkreader_delete (Handle);
+			}
+		}
+
+		protected abstract bool ReadChunk (string tag, IntPtr data, IntPtr length);
+
+		// impl
+
+		[MonoPInvokeCallback (typeof (SKManagedPngChunkReaderReadChunkProxyDelegate))]
+		private static bool ReadChunkInternal (IntPtr d, void* context, void* tag, void* data, IntPtr length)
+		{
+			var dump = DelegateProxies.GetUserData<SKPngChunkReader> ((IntPtr)context, out _);
+			return dump.ReadChunk (Marshal.PtrToStringAnsi ((IntPtr)tag), (IntPtr)data, length);
+		}
+
+		[MonoPInvokeCallback (typeof (SKManagedPngChunkReaderDestroyProxyDelegate))]
+		private static void DestroyInternal (IntPtr s, void* context)
+		{
+			var id = DelegateProxies.GetUserData<SKPngChunkReader> ((IntPtr)context, out var gch);
+			if (id != null) {
+				Interlocked.Exchange (ref id.fromNative, 1);
+				id.Dispose ();
+			}
+			gch.Free ();
+		}
+	}
+}

binding/libSkiaSharp.json

@@ -341,6 +341,10 @@
         "cs": "SKRunBufferInternal",
         "internal": true
       },
+      "sk_managedpngchunkreader_procs_t": {
+        "cs": "SKManagedPngChunkReaderDelegates",
+        "internal": true
+      },
       "sk_managedstream_procs_t": {
         "cs": "SKManagedStreamDelegates",
         "internal": true
@@ -391,6 +395,12 @@
           "-1": "IntPtr"
         }
       },
+      "sk_managedpngchunkreader_read_chunk_proc": {
+        "cs": "SKManagedPngChunkReaderReadChunkProxyDelegate"
+      },
+      "sk_managedpngchunkreader_destroy_proc": {
+        "cs": "SKManagedPngChunkReaderDestroyProxyDelegate"
+      },
       "sk_managedwstream_write_proc": {
         "cs": "SKManagedWStreamWriteProxyDelegate"
       },

native/android/build.cake

@@ -36,7 +36,7 @@ Task("libSkiaSharp")
             $"skia_use_system_zlib=false " +
             $"skia_use_vulkan={SUPPORT_VULKAN} ".ToLower () +
             $"skia_enable_skottie=true " +
-            $"extra_cflags=[ '-DSKIA_C_DLL', '-DHAVE_SYSCALL_GETRANDOM', '-DXML_DEV_URANDOM' ] " +
+            $"extra_cflags=[ '-DSKIA_C_DLL', '-DHAVE_SYSCALL_GETRANDOM', '-DXML_DEV_URANDOM', '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED' ] " +
             $"ndk='{ANDROID_NDK_HOME}' " +
             $"ndk_api={(skiaArch == "x64" || skiaArch == "arm64" ? 21 : 16)}");
 

native/ios/build.cake

@@ -42,7 +42,7 @@ Task("libSkiaSharp")
             $"skia_use_system_libwebp=false " +
             $"skia_use_system_zlib=false " +
             $"skia_enable_skottie=true " +
-            $"extra_cflags=[ '-DSKIA_C_DLL', '-DHAVE_ARC4RANDOM_BUF' ] ");
+            $"extra_cflags=[ '-DSKIA_C_DLL', '-DHAVE_ARC4RANDOM_BUF', '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED' ] ");
 
         RunXCodeBuild("libSkiaSharp/libSkiaSharp.xcodeproj", "libSkiaSharp", sdk, arch, platform: VARIANT);
 

native/linux/build.cake

@@ -108,7 +108,7 @@ Task("libHarfBuzzSharp")
             $"target_cpu='{arch}' " +
             $"visibility_hidden=false " +
             $"extra_asmflags=[] " +
-            $"extra_cflags=[] " +
+            $"extra_cflags=[ '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED' ] " +
             $"extra_ldflags=[ '-static-libstdc++', '-static-libgcc', '-Wl,--version-script={map}' ] " +
             COMPILERS +
             $"linux_soname_version='{soname}' " +

native/macos/build.cake

@@ -36,7 +36,9 @@ Task("libSkiaSharp")
             $"skia_use_system_libwebp=false " +
             $"skia_use_system_zlib=false " +
             $"skia_enable_skottie=true " +
-            $"extra_cflags=[ '-DSKIA_C_DLL', '-DHAVE_ARC4RANDOM_BUF', '-stdlib=libc++' ] " +
+            $"extra_cflags=[ " +
+            $"  '-DSKIA_C_DLL', '-DHAVE_ARC4RANDOM_BUF', '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED', " +
+            $"  '-stdlib=libc++' ] " +
             $"extra_ldflags=[ '-stdlib=libc++' ]");
 
         RunXCodeBuild("libSkiaSharp/libSkiaSharp.xcodeproj", "libSkiaSharp", "macosx", arch);

native/tizen/build.cake

@@ -35,7 +35,7 @@ Task("libSkiaSharp")
            $"skia_use_system_libwebp=false " +
            $"skia_use_system_zlib=true " +
            $"skia_enable_skottie=true " +
-           $"extra_cflags=[ '-DSKIA_C_DLL', '-DXML_DEV_URANDOM', '-DSK_NO_MAKE_SHARED_PTR' ] " +
+           $"extra_cflags=[ '-DSKIA_C_DLL', '-DXML_DEV_URANDOM', '-DSK_NO_MAKE_SHARED_PTR', '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED' ] " +
            $"ncli='{TIZEN_STUDIO_HOME}' " +
            $"ncli_version='4.0'");
 

native/tizen/libSkiaSharp/project_def.prop

@@ -51,4 +51,6 @@ USER_SRCS = $(skia_root)/src/xamarin/sk_xamarin.cpp                 \
             $(skia_root)/src/xamarin/sk_manageddrawable.cpp         \
             $(skia_root)/src/xamarin/SkManagedDrawable.cpp          \
             $(skia_root)/src/xamarin/sk_managedtracememorydump.cpp  \
+            $(skia_root)/src/xamarin/sk_managedpngchunkreader.cpp        \
+            $(skia_root)/src/xamarin/SkManagedPngChunkReader.cpp         \
             $(skia_root)/src/xamarin/SkManagedTraceMemoryDump.cpp

native/tvos/build.cake

@@ -31,7 +31,7 @@ Task("libSkiaSharp")
             $"skia_use_system_libwebp=false " +
             $"skia_use_system_zlib=false " +
             $"skia_enable_skottie=true " +
-            $"extra_cflags=[ '-DSKIA_C_DLL', '-DHAVE_ARC4RANDOM_BUF' ] ");
+            $"extra_cflags=[ '-DSKIA_C_DLL', '-DHAVE_ARC4RANDOM_BUF', '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED' ] ");
 
         RunXCodeBuild("libSkiaSharp/libSkiaSharp.xcodeproj", "libSkiaSharp", sdk, arch);
 

native/uwp/build.cake

@@ -41,7 +41,8 @@ Task("libSkiaSharp")
             win_vcvars_version +
             $"extra_cflags=[  " +
             $"  '-DSKIA_C_DLL', '/MD{d}', '/EHsc', '/Z7', " +
-            $"  '-DSK_HAS_DWRITE_1_H', '-DSK_HAS_DWRITE_2_H', '-DNO_GETENV', '-D_HAS_AUTO_PTR_ETC=1' ] " +
+            $"  '-DSK_HAS_DWRITE_1_H', '-DSK_HAS_DWRITE_2_H', '-DNO_GETENV', '-D_HAS_AUTO_PTR_ETC=1', " +
+            $"  '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED' ] " +
             $"extra_ldflags=[ '/DEBUG:FULL' ]");
 
         var outDir = OUTPUT_PATH.Combine(dir);

native/wasm/build.cake

@@ -52,6 +52,7 @@ Task("libSkiaSharp")
         $"extra_cflags=[ " +
         $"  '-DSKIA_C_DLL', '-DXML_POOR_ENTROPY', " + 
         $"  '-DSKNX_NO_SIMD', '-DSK_DISABLE_AAA', '-DGR_GL_CHECK_ALLOC_WITH_GET_ERROR=0', " +
+        $"  '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED', " +
         $"  '-s', 'WARN_UNALIGNED=1' " + // '-s', 'USE_WEBGL2=1' (experimental)
         $"] " +
         $"extra_cflags_cc=[ '-frtti' ] " +

native/watchos/build.cake

@@ -33,7 +33,7 @@ Task("libSkiaSharp")
             $"skia_use_system_libwebp=false " +
             $"skia_use_system_zlib=false " +
             $"skia_enable_skottie=true " +
-            $"extra_cflags=[ '-DSKIA_C_DLL', '-DHAVE_ARC4RANDOM_BUF' ] ");
+            $"extra_cflags=[ '-DSKIA_C_DLL', '-DHAVE_ARC4RANDOM_BUF', '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED' ] ");
 
         RunXCodeBuild("libSkiaSharp/libSkiaSharp.xcodeproj", "libSkiaSharp", sdk, arch);
 

native/windows/build.cake

@@ -52,7 +52,9 @@ Task("libSkiaSharp")
             $"skia_use_vulkan={SUPPORT_VULKAN} ".ToLower () +
             clang +
             win_vcvars_version +
-            $"extra_cflags=[ '-DSKIA_C_DLL', '/MT{d}', '/EHsc', '/Z7', '-D_HAS_AUTO_PTR_ETC=1' ] " +
+            $"extra_cflags=[ " +
+            $"  '-DSKIA_C_DLL', '/MT{d}', '/EHsc', '/Z7', '-D_HAS_AUTO_PTR_ETC=1', "+
+            $"  '-DPNG_READ_UNKNOWN_CHUNKS_SUPPORTED' ] " +
             $"extra_ldflags=[ '/DEBUG:FULL' ] " +
             ADDITIONAL_GN_ARGS);
 

tests/Tests/SKCodecTest.cs

@@ -1,6 +1,8 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Net.Http;
+using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
 using Xunit;
 
@@ -491,5 +493,31 @@ public void CanDecodeData(string image)
 			Assert.Equal(SKCodecResult.Success, codec.GetPixels(out var pixels));
 			Assert.NotEmpty(pixels);
 		}
+
+		[SkippableFact]
+		public void CanReadPngChunks_NonStandard()
+		{
+			var path = Path.Combine(PathToImages, "png_chunks/circle.9.png");
+
+			using var chunkReader = new TestPngChunkReader();
+			using var codec = SKCodec.Create(path, chunkReader, SKCodecSelectionPolicy.PreferStillImage, out var codecResult);
+			using var bmp = SKBitmap.Decode(codec);
+
+			var chunks = chunkReader.Chunks;
+
+			Assert.NotEmpty(chunks);
+		}
+
+		unsafe class TestPngChunkReader : SKPngChunkReader
+		{
+			protected override bool ReadChunk(string tag, IntPtr data, IntPtr length)
+			{
+				var d = new ReadOnlySpan<byte>((void*)data, (int)length).ToArray();
+				Chunks.Add((tag, d));
+				return true;
+			}
+
+			public List<(string, byte[])> Chunks { get; } = new List<(string, byte[])>();
+		}
 	}
 }