Merge pull request #1552 from SixLabors/webp

Add WebP Format Support

src/ImageSharp/Advanced/AotCompilerTools.cs

@@ -13,6 +13,7 @@
 using SixLabors.ImageSharp.Formats.Png;
 using SixLabors.ImageSharp.Formats.Tga;
 using SixLabors.ImageSharp.Formats.Tiff;
+using SixLabors.ImageSharp.Formats.Webp;
 using SixLabors.ImageSharp.Memory;
 using SixLabors.ImageSharp.PixelFormats;
 using SixLabors.ImageSharp.Processing;
@@ -195,6 +196,7 @@ private static void AotCompileImageProcessingContextFactory<TPixel>()
         private static void AotCompileImageEncoderInternals<TPixel>()
             where TPixel : unmanaged, IPixel<TPixel>
         {
+            default(WebpEncoderCore).Encode<TPixel>(default, default, default);
             default(BmpEncoderCore).Encode<TPixel>(default, default, default);
             default(GifEncoderCore).Encode<TPixel>(default, default, default);
             default(JpegEncoderCore).Encode<TPixel>(default, default, default);
@@ -211,6 +213,7 @@ private static void AotCompileImageEncoderInternals<TPixel>()
         private static void AotCompileImageDecoderInternals<TPixel>()
             where TPixel : unmanaged, IPixel<TPixel>
         {
+            default(WebpDecoderCore).Decode<TPixel>(default, default, default);
             default(BmpDecoderCore).Decode<TPixel>(default, default, default);
             default(GifDecoderCore).Decode<TPixel>(default, default, default);
             default(JpegDecoderCore).Decode<TPixel>(default, default, default);
@@ -227,6 +230,7 @@ private static void AotCompileImageDecoderInternals<TPixel>()
         private static void AotCompileImageEncoders<TPixel>()
            where TPixel : unmanaged, IPixel<TPixel>
         {
+            AotCompileImageEncoder<TPixel, WebpEncoder>();
             AotCompileImageEncoder<TPixel, BmpEncoder>();
             AotCompileImageEncoder<TPixel, GifEncoder>();
             AotCompileImageEncoder<TPixel, JpegEncoder>();
@@ -243,6 +247,7 @@ private static void AotCompileImageEncoders<TPixel>()
         private static void AotCompileImageDecoders<TPixel>()
             where TPixel : unmanaged, IPixel<TPixel>
         {
+            AotCompileImageDecoder<TPixel, WebpDecoder>();
             AotCompileImageDecoder<TPixel, BmpDecoder>();
             AotCompileImageDecoder<TPixel, GifDecoder>();
             AotCompileImageDecoder<TPixel, JpegDecoder>();

src/ImageSharp/Configuration.cs

@@ -11,6 +11,7 @@
 using SixLabors.ImageSharp.Formats.Png;
 using SixLabors.ImageSharp.Formats.Tga;
 using SixLabors.ImageSharp.Formats.Tiff;
+using SixLabors.ImageSharp.Formats.Webp;
 using SixLabors.ImageSharp.IO;
 using SixLabors.ImageSharp.Memory;
 using SixLabors.ImageSharp.Processing;
@@ -159,20 +160,17 @@ public void Configure(IConfigurationModule configuration)
         /// Creates a shallow copy of the <see cref="Configuration"/>.
         /// </summary>
         /// <returns>A new configuration instance.</returns>
-        public Configuration Clone()
+        public Configuration Clone() => new Configuration
         {
-            return new Configuration
-            {
-                MaxDegreeOfParallelism = this.MaxDegreeOfParallelism,
-                StreamProcessingBufferSize = this.StreamProcessingBufferSize,
-                ImageFormatsManager = this.ImageFormatsManager,
-                MemoryAllocator = this.MemoryAllocator,
-                ImageOperationsProvider = this.ImageOperationsProvider,
-                ReadOrigin = this.ReadOrigin,
-                FileSystem = this.FileSystem,
-                WorkingBufferSizeHintInBytes = this.WorkingBufferSizeHintInBytes,
-            };
-        }
+            MaxDegreeOfParallelism = this.MaxDegreeOfParallelism,
+            StreamProcessingBufferSize = this.StreamProcessingBufferSize,
+            ImageFormatsManager = this.ImageFormatsManager,
+            MemoryAllocator = this.MemoryAllocator,
+            ImageOperationsProvider = this.ImageOperationsProvider,
+            ReadOrigin = this.ReadOrigin,
+            FileSystem = this.FileSystem,
+            WorkingBufferSizeHintInBytes = this.WorkingBufferSizeHintInBytes,
+        };
 
         /// <summary>
         /// Creates the default instance with the following <see cref="IConfigurationModule"/>s preregistered:
@@ -182,17 +180,16 @@ public Configuration Clone()
         /// <see cref="BmpConfigurationModule"/>.
         /// <see cref="TgaConfigurationModule"/>.
         /// <see cref="TiffConfigurationModule"/>.
+        /// <see cref="WebpConfigurationModule"/>.
         /// </summary>
         /// <returns>The default configuration of <see cref="Configuration"/>.</returns>
-        internal static Configuration CreateDefaultInstance()
-        {
-            return new Configuration(
+        internal static Configuration CreateDefaultInstance() => new Configuration(
                 new PngConfigurationModule(),
                 new JpegConfigurationModule(),
                 new GifConfigurationModule(),
                 new BmpConfigurationModule(),
                 new TgaConfigurationModule(),
-                new TiffConfigurationModule());
-        }
+                new TiffConfigurationModule(),
+                new WebpConfigurationModule());
     }
 }

src/ImageSharp/Formats/ImageExtensions.Save.cs

@@ -12,6 +12,7 @@
 using SixLabors.ImageSharp.Formats.Jpeg;
 using SixLabors.ImageSharp.Formats.Png;
 using SixLabors.ImageSharp.Formats.Tga;
+using SixLabors.ImageSharp.Formats.Webp;
 using SixLabors.ImageSharp.Formats.Tiff;
 
 namespace SixLabors.ImageSharp
@@ -536,6 +537,109 @@ public static Task SaveAsTgaAsync(this Image source, Stream stream, TgaEncoder e
                 encoder ?? source.GetConfiguration().ImageFormatsManager.FindEncoder(TgaFormat.Instance),
                 cancellationToken);
 
+        /// <summary>
+        /// Saves the image to the given stream with the Webp format.
+        /// </summary>
+        /// <param name="source">The image this method extends.</param>
+        /// <param name="path">The file path to save the image to.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown if the path is null.</exception>
+        public static void SaveAsWebp(this Image source, string path) => SaveAsWebp(source, path, null);
+
+        /// <summary>
+        /// Saves the image to the given stream with the Webp format.
+        /// </summary>
+        /// <param name="source">The image this method extends.</param>
+        /// <param name="path">The file path to save the image to.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown if the path is null.</exception>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+        public static Task SaveAsWebpAsync(this Image source, string path) => SaveAsWebpAsync(source, path, null);
+
+        /// <summary>
+        /// Saves the image to the given stream with the Webp format.
+        /// </summary>
+        /// <param name="source">The image this method extends.</param>
+        /// <param name="path">The file path to save the image to.</param>
+        /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown if the path is null.</exception>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+        public static Task SaveAsWebpAsync(this Image source, string path, CancellationToken cancellationToken)
+            => SaveAsWebpAsync(source, path, null, cancellationToken);
+
+        /// <summary>
+        /// Saves the image to the given stream with the Webp format.
+        /// </summary>
+        /// <param name="source">The image this method extends.</param>
+        /// <param name="path">The file path to save the image to.</param>
+        /// <param name="encoder">The encoder to save the image with.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown if the path is null.</exception>
+        public static void SaveAsWebp(this Image source, string path, WebpEncoder encoder) =>
+            source.Save(
+                path,
+                encoder ?? source.GetConfiguration().ImageFormatsManager.FindEncoder(WebpFormat.Instance));
+
+        /// <summary>
+        /// Saves the image to the given stream with the Webp format.
+        /// </summary>
+        /// <param name="source">The image this method extends.</param>
+        /// <param name="path">The file path to save the image to.</param>
+        /// <param name="encoder">The encoder to save the image with.</param>
+        /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown if the path is null.</exception>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+        public static Task SaveAsWebpAsync(this Image source, string path, WebpEncoder encoder, CancellationToken cancellationToken = default) =>
+            source.SaveAsync(
+                path,
+                encoder ?? source.GetConfiguration().ImageFormatsManager.FindEncoder(WebpFormat.Instance),
+                cancellationToken);
+
+        /// <summary>
+        /// Saves the image to the given stream with the Webp format.
+        /// </summary>
+        /// <param name="source">The image this method extends.</param>
+        /// <param name="stream">The stream to save the image to.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown if the stream is null.</exception>
+        public static void SaveAsWebp(this Image source, Stream stream)
+            => SaveAsWebp(source, stream, null);
+
+        /// <summary>
+        /// Saves the image to the given stream with the Webp format.
+        /// </summary>
+        /// <param name="source">The image this method extends.</param>
+        /// <param name="stream">The stream to save the image to.</param>
+        /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown if the stream is null.</exception>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+        public static Task SaveAsWebpAsync(this Image source, Stream stream, CancellationToken cancellationToken = default)
+            => SaveAsWebpAsync(source, stream, null, cancellationToken);
+
+        /// <summary>
+        /// Saves the image to the given stream with the Webp format.
+        /// </summary>
+        /// <param name="source">The image this method extends.</param>
+        /// <param name="stream">The stream to save the image to.</param>
+        /// <param name="encoder">The encoder to save the image with.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown if the stream is null.</exception>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+        public static void SaveAsWebp(this Image source, Stream stream, WebpEncoder encoder)
+            => source.Save(
+                stream,
+                encoder ?? source.GetConfiguration().ImageFormatsManager.FindEncoder(WebpFormat.Instance));
+
+        /// <summary>
+        /// Saves the image to the given stream with the Webp format.
+        /// </summary>
+        /// <param name="source">The image this method extends.</param>
+        /// <param name="stream">The stream to save the image to.</param>
+        /// <param name="encoder">The encoder to save the image with.</param>
+        /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+        /// <exception cref="System.ArgumentNullException">Thrown if the stream is null.</exception>
+        /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
+        public static Task SaveAsWebpAsync(this Image source, Stream stream, WebpEncoder encoder, CancellationToken cancellationToken = default) =>
+            source.SaveAsync(
+                stream,
+                encoder ?? source.GetConfiguration().ImageFormatsManager.FindEncoder(WebpFormat.Instance),
+                cancellationToken);
+
         /// <summary>
         /// Saves the image to the given stream with the Tiff format.
         /// </summary>

src/ImageSharp/Formats/ImageExtensions.Save.tt

@@ -17,6 +17,7 @@ using SixLabors.ImageSharp.Advanced;
         "Jpeg",
         "Png",
         "Tga",
+        "Webp",
         "Tiff",
     };