path: root/Jellyfin.Drawing.Skia/SkiaEncoder.cs

using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using BlurHashSharp.SkiaSharp;
using Diacritics.Extensions;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Extensions;
using MediaBrowser.Controller.Drawing;
using MediaBrowser.Model.Drawing;
using Microsoft.Extensions.Logging;
using SkiaSharp;
using static Jellyfin.Drawing.Skia.SkiaHelper;

namespace Jellyfin.Drawing.Skia
{
    /// <summary>
    /// Image encoder that uses <see cref="SkiaSharp"/> to manipulate images.
    /// </summary>
    public class SkiaEncoder : IImageEncoder
    {
        private static readonly HashSet<string> _transparentImageTypes
            = new HashSet<string>(StringComparer.OrdinalIgnoreCase) { ".png", ".gif", ".webp" };

        private readonly ILogger<SkiaEncoder> _logger;
        private readonly IApplicationPaths _appPaths;

        /// <summary>
        /// Initializes a new instance of the <see cref="SkiaEncoder"/> class.
        /// </summary>
        /// <param name="logger">The application logger.</param>
        /// <param name="appPaths">The application paths.</param>
        public SkiaEncoder(ILogger<SkiaEncoder> logger, IApplicationPaths appPaths)
        {
            _logger = logger;
            _appPaths = appPaths;
        }

        /// <inheritdoc/>
        public string Name => "Skia";

        /// <inheritdoc/>
        public bool SupportsImageCollageCreation => true;

        /// <inheritdoc/>
        public bool SupportsImageEncoding => true;

        /// <inheritdoc/>
        public IReadOnlyCollection<string> SupportedInputFormats =>
            new HashSet<string>(StringComparer.OrdinalIgnoreCase)
            {
                "jpeg",
                "jpg",
                "png",
                "dng",
                "webp",
                "gif",
                "bmp",
                "ico",
                "astc",
                "ktx",
                "pkm",
                "wbmp",
                // TODO: check if these are supported on multiple platforms
                // https://github.com/google/skia/blob/master/infra/bots/recipes/test.py#L454
                // working on windows at least
                "cr2",
                "nef",
                "arw"
            };

        /// <inheritdoc/>
        public IReadOnlyCollection<ImageFormat> SupportedOutputFormats
            => new HashSet<ImageFormat>() { ImageFormat.Webp, ImageFormat.Jpg, ImageFormat.Png };

        /// <summary>
        /// Check if the native lib is available.
        /// </summary>
        /// <returns>True if the native lib is available, otherwise false.</returns>
        public static bool IsNativeLibAvailable()
        {
            try
            {
                // test an operation that requires the native library
                SKPMColor.PreMultiply(SKColors.Black);
                return true;
            }
            catch (Exception)
            {
                return false;
            }
        }

        /// <summary>
        /// Convert a <see cref="ImageFormat"/> to a <see cref="SKEncodedImageFormat"/>.
        /// </summary>
        /// <param name="selectedFormat">The format to convert.</param>
        /// <returns>The converted format.</returns>
        public static SKEncodedImageFormat GetImageFormat(ImageFormat selectedFormat)
        {
            return selectedFormat switch
            {
                ImageFormat.Bmp => SKEncodedImageFormat.Bmp,
                ImageFormat.Jpg => SKEncodedImageFormat.Jpeg,
                ImageFormat.Gif => SKEncodedImageFormat.Gif,
                ImageFormat.Webp => SKEncodedImageFormat.Webp,
                _ => SKEncodedImageFormat.Png
            };
        }

        /// <inheritdoc />
        /// <exception cref="ArgumentNullException">The path is null.</exception>
        /// <exception cref="FileNotFoundException">The path is not valid.</exception>
        /// <exception cref="SkiaCodecException">The file at the specified path could not be used to generate a codec.</exception>
        public ImageDimensions GetImageSize(string path)
        {
            if (!File.Exists(path))
            {
                throw new FileNotFoundException("File not found", path);
            }

            using var codec = SKCodec.Create(path, out SKCodecResult result);
            EnsureSuccess(result);

            var info = codec.Info;

            return new ImageDimensions(info.Width, info.Height);
        }

        /// <inheritdoc />
        /// <exception cref="ArgumentNullException">The path is null.</exception>
        /// <exception cref="FileNotFoundException">The path is not valid.</exception>
        /// <exception cref="SkiaCodecException">The file at the specified path could not be used to generate a codec.</exception>
        public string GetImageBlurHash(int xComp, int yComp, string path)
        {
            if (path == null)
            {
                throw new ArgumentNullException(nameof(path));
            }

            // Any larger than 128x128 is too slow and there's no visually discernible difference
            return BlurHashEncoder.Encode(xComp, yComp, path, 128, 128);
        }

        private bool RequiresSpecialCharacterHack(string path)
        {
            for (int i = 0; i < path.Length; i++)
            {
                if (char.GetUnicodeCategory(path[i]) == UnicodeCategory.OtherLetter)
                {
                    return true;
                }
            }

            return path.HasDiacritics();
        }

        private string NormalizePath(string path)
        {
            if (!RequiresSpecialCharacterHack(path))
            {
                return path;
            }

            var tempPath = Path.Combine(_appPaths.TempDirectory, Guid.NewGuid() + Path.GetExtension(path));
            var directory = Path.GetDirectoryName(tempPath) ?? throw new ResourceNotFoundException($"Provided path ({tempPath}) is not valid.");
            Directory.CreateDirectory(directory);
            File.Copy(path, tempPath, true);

            return tempPath;
        }

        private static SKEncodedOrigin GetSKEncodedOrigin(ImageOrientation? orientation)
        {
            if (!orientation.HasValue)
            {
                return SKEncodedOrigin.TopLeft;
            }

            return orientation.Value switch
            {
                ImageOrientation.TopRight => SKEncodedOrigin.TopRight,
                ImageOrientation.RightTop => SKEncodedOrigin.RightTop,
                ImageOrientation.RightBottom => SKEncodedOrigin.RightBottom,
                ImageOrientation.LeftTop => SKEncodedOrigin.LeftTop,
                ImageOrientation.LeftBottom => SKEncodedOrigin.LeftBottom,
                ImageOrientation.BottomRight => SKEncodedOrigin.BottomRight,
                ImageOrientation.BottomLeft => SKEncodedOrigin.BottomLeft,
                _ => SKEncodedOrigin.TopLeft
            };
        }

        /// <summary>
        /// Decode an image.
        /// </summary>
        /// <param name="path">The filepath of the image to decode.</param>
        /// <param name="forceCleanBitmap">Whether to force clean the bitmap.</param>
        /// <param name="orientation">The orientation of the image.</param>
        /// <param name="origin">The detected origin of the image.</param>
        /// <returns>The resulting bitmap of the image.</returns>
        internal SKBitmap? Decode(string path, bool forceCleanBitmap, ImageOrientation? orientation, out SKEncodedOrigin origin)
        {
            if (!File.Exists(path))
            {
                throw new FileNotFoundException("File not found", path);
            }

            var requiresTransparencyHack = _transparentImageTypes.Contains(Path.GetExtension(path));

            if (requiresTransparencyHack || forceCleanBitmap)
            {
                using SKCodec codec = SKCodec.Create(NormalizePath(path), out SKCodecResult res);
                if (res != SKCodecResult.Success)
                {
                    origin = GetSKEncodedOrigin(orientation);
                    return null;
                }

                // create the bitmap
                var bitmap = new SKBitmap(codec.Info.Width, codec.Info.Height, !requiresTransparencyHack);

                // decode
                _ = codec.GetPixels(bitmap.Info, bitmap.GetPixels());

                origin = codec.EncodedOrigin;

                return bitmap;
            }

            var resultBitmap = SKBitmap.Decode(NormalizePath(path));

            if (resultBitmap == null)
            {
                return Decode(path, true, orientation, out origin);
            }

            // If we have to resize these they often end up distorted
            if (resultBitmap.ColorType == SKColorType.Gray8)
            {
                using (resultBitmap)
                {
                    return Decode(path, true, orientation, out origin);
                }
            }

            origin = SKEncodedOrigin.TopLeft;
            return resultBitmap;
        }

        private SKBitmap? GetBitmap(string path, bool autoOrient, ImageOrientation? orientation)
        {
            if (autoOrient)
            {
                var bitmap = Decode(path, true, orientation, out var origin);

                if (bitmap != null && origin != SKEncodedOrigin.TopLeft)
                {
                    using (bitmap)
                    {
                        return OrientImage(bitmap, origin);
                    }
                }

                return bitmap;
            }

            return Decode(path, false, orientation, out _);
        }

        private SKBitmap OrientImage(SKBitmap bitmap, SKEncodedOrigin origin)
        {
            var needsFlip = origin == SKEncodedOrigin.LeftBottom
                            || origin == SKEncodedOrigin.LeftTop
                            || origin == SKEncodedOrigin.RightBottom
                            || origin == SKEncodedOrigin.RightTop;
            var rotated = needsFlip
                ? new SKBitmap(bitmap.Height, bitmap.Width)
                : new SKBitmap(bitmap.Width, bitmap.Height);
            using var surface = new SKCanvas(rotated);
            var midX = (float)rotated.Width / 2;
            var midY = (float)rotated.Height / 2;

            switch (origin)
            {
                case SKEncodedOrigin.TopRight:
                    surface.Scale(-1, 1, midX, midY);
                    break;
                case SKEncodedOrigin.BottomRight:
                    surface.RotateDegrees(180, midX, midY);
                    break;
                case SKEncodedOrigin.BottomLeft:
                    surface.Scale(1, -1, midX, midY);
                    break;
                case SKEncodedOrigin.LeftTop:
                    surface.Translate(0, -rotated.Height);
                    surface.Scale(1, -1, midX, midY);
                    surface.RotateDegrees(-90);
                    break;
                case SKEncodedOrigin.RightTop:
                    surface.Translate(rotated.Width, 0);
                    surface.RotateDegrees(90);
                    break;
                case SKEncodedOrigin.RightBottom:
                    surface.Translate(rotated.Width, 0);
                    surface.Scale(1, -1, midX, midY);
                    surface.RotateDegrees(90);
                    break;
                case SKEncodedOrigin.LeftBottom:
                    surface.Translate(0, rotated.Height);
                    surface.RotateDegrees(-90);
                    break;
            }

            surface.DrawBitmap(bitmap, 0, 0);
            return rotated;
        }

        /// <summary>
        /// Resizes an image on the CPU, by utilizing a surface and canvas.
        ///
        /// The convolutional matrix kernel used in this resize function gives a (light) sharpening effect.
        /// This technique is similar to effect that can be created using for example the [Convolution matrix filter in GIMP](https://docs.gimp.org/2.10/en/gimp-filter-convolution-matrix.html).
        /// </summary>
        /// <param name="source">The source bitmap.</param>
        /// <param name="targetInfo">This specifies the target size and other information required to create the surface.</param>
        /// <param name="isAntialias">This enables anti-aliasing on the SKPaint instance.</param>
        /// <param name="isDither">This enables dithering on the SKPaint instance.</param>
        /// <returns>The resized image.</returns>
        internal static SKImage ResizeImage(SKBitmap source, SKImageInfo targetInfo, bool isAntialias = false, bool isDither = false)
        {
            using var surface = SKSurface.Create(targetInfo);
            using var canvas = surface.Canvas;
            using var paint = new SKPaint
            {
                FilterQuality = SKFilterQuality.High,
                IsAntialias = isAntialias,
                IsDither = isDither
            };

            var kernel = new float[9]
            {
                0,    -.1f,    0,
                -.1f, 1.4f, -.1f,
                0,    -.1f,    0,
            };

            var kernelSize = new SKSizeI(3, 3);
            var kernelOffset = new SKPointI(1, 1);

            paint.ImageFilter = SKImageFilter.CreateMatrixConvolution(
                kernelSize,
                kernel,
                1f,
                0f,
                kernelOffset,
                SKShaderTileMode.Clamp,
                true);

            canvas.DrawBitmap(
                source,
                SKRect.Create(0, 0, source.Width, source.Height),
                SKRect.Create(0, 0, targetInfo.Width, targetInfo.Height),
                paint);

            return surface.Snapshot();
        }

        /// <inheritdoc/>
        public string EncodeImage(string inputPath, DateTime dateModified, string outputPath, bool autoOrient, ImageOrientation? orientation, int quality, ImageProcessingOptions options, ImageFormat outputFormat)
        {
            if (inputPath.Length == 0)
            {
                throw new ArgumentException("String can't be empty.", nameof(inputPath));
            }

            if (outputPath.Length == 0)
            {
                throw new ArgumentException("String can't be empty.", nameof(outputPath));
            }

            var skiaOutputFormat = GetImageFormat(outputFormat);

            var hasBackgroundColor = !string.IsNullOrWhiteSpace(options.BackgroundColor);
            var hasForegroundColor = !string.IsNullOrWhiteSpace(options.ForegroundLayer);
            var blur = options.Blur ?? 0;
            var hasIndicator = options.AddPlayedIndicator || options.UnplayedCount.HasValue || !options.PercentPlayed.Equals(0);

            using var bitmap = GetBitmap(inputPath, autoOrient, orientation);
            if (bitmap == null)
            {
                throw new InvalidDataException($"Skia unable to read image {inputPath}");
            }

            var originalImageSize = new ImageDimensions(bitmap.Width, bitmap.Height);

            if (options.HasDefaultOptions(inputPath, originalImageSize) && !autoOrient)
            {
                // Just spit out the original file if all the options are default
                return inputPath;
            }

            var newImageSize = ImageHelper.GetNewImageSize(options, originalImageSize);

            var width = newImageSize.Width;
            var height = newImageSize.Height;

            // scale image (the FromImage creates a copy)
            var imageInfo = new SKImageInfo(width, height, bitmap.ColorType, bitmap.AlphaType, bitmap.ColorSpace);
            using var resizedBitmap = SKBitmap.FromImage(ResizeImage(bitmap, imageInfo));

            // If all we're doing is resizing then we can stop now
            if (!hasBackgroundColor && !hasForegroundColor && blur == 0 && !hasIndicator)
            {
                var outputDirectory = Path.GetDirectoryName(outputPath) ?? throw new ArgumentException($"Provided path ({outputPath}) is not valid.", nameof(outputPath));
                Directory.CreateDirectory(outputDirectory);
                using var outputStream = new SKFileWStream(outputPath);
                using var pixmap = new SKPixmap(new SKImageInfo(width, height), resizedBitmap.GetPixels());
                resizedBitmap.Encode(outputStream, skiaOutputFormat, quality);
                return outputPath;
            }

            // create bitmap to use for canvas drawing used to draw into bitmap
            using var saveBitmap = new SKBitmap(width, height);
            using var canvas = new SKCanvas(saveBitmap);
            // set background color if present
            if (hasBackgroundColor)
            {
                canvas.Clear(SKColor.Parse(options.BackgroundColor));
            }

            // Add blur if option is present
            if (blur > 0)
            {
                // create image from resized bitmap to apply blur
                using var paint = new SKPaint();
                using var filter = SKImageFilter.CreateBlur(blur, blur);
                paint.ImageFilter = filter;
                canvas.DrawBitmap(resizedBitmap, SKRect.Create(width, height), paint);
            }
            else
            {
                // draw resized bitmap onto canvas
                canvas.DrawBitmap(resizedBitmap, SKRect.Create(width, height));
            }

            // If foreground layer present then draw
            if (hasForegroundColor)
            {
                if (!double.TryParse(options.ForegroundLayer, out double opacity))
                {
                    opacity = .4;
                }

                canvas.DrawColor(new SKColor(0, 0, 0, (byte)((1 - opacity) * 0xFF)), SKBlendMode.SrcOver);
            }

            if (hasIndicator)
            {
                DrawIndicator(canvas, width, height, options);
            }

            var directory = Path.GetDirectoryName(outputPath) ?? throw new ArgumentException($"Provided path ({outputPath}) is not valid.", nameof(outputPath));
            Directory.CreateDirectory(directory);
            using (var outputStream = new SKFileWStream(outputPath))
            {
                using (var pixmap = new SKPixmap(new SKImageInfo(width, height), saveBitmap.GetPixels()))
                {
                    pixmap.Encode(outputStream, skiaOutputFormat, quality);
                }
            }

            return outputPath;
        }

        /// <inheritdoc/>
        public void CreateImageCollage(ImageCollageOptions options, string? libraryName)
        {
            double ratio = (double)options.Width / options.Height;

            if (ratio >= 1.4)
            {
                new StripCollageBuilder(this).BuildThumbCollage(options.InputPaths, options.OutputPath, options.Width, options.Height, libraryName);
            }
            else if (ratio >= .9)
            {
                new StripCollageBuilder(this).BuildSquareCollage(options.InputPaths, options.OutputPath, options.Width, options.Height);
            }
            else
            {
                // TODO: Create Poster collage capability
                new StripCollageBuilder(this).BuildSquareCollage(options.InputPaths, options.OutputPath, options.Width, options.Height);
            }
        }

        private void DrawIndicator(SKCanvas canvas, int imageWidth, int imageHeight, ImageProcessingOptions options)
        {
            try
            {
                var currentImageSize = new ImageDimensions(imageWidth, imageHeight);

                if (options.AddPlayedIndicator)
                {
                    PlayedIndicatorDrawer.DrawPlayedIndicator(canvas, currentImageSize);
                }
                else if (options.UnplayedCount.HasValue)
                {
                    UnplayedCountIndicator.DrawUnplayedCountIndicator(canvas, currentImageSize, options.UnplayedCount.Value);
                }

                if (options.PercentPlayed > 0)
                {
                    PercentPlayedDrawer.Process(canvas, currentImageSize, options.PercentPlayed);
                }
            }
            catch (Exception ex)
            {
                _logger.LogError(ex, "Error drawing indicator overlay");
            }
        }
    }
}