@ -12,534 +12,533 @@ using Microsoft.Extensions.Logging;
using SkiaSharp ;
using SKSvg = SkiaSharp . Extended . Svg . SKSvg ;
namespace Jellyfin.Drawing.Skia
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 ( StringComparer . OrdinalIgnoreCase ) { ".png" , ".gif" , ".webp" } ;
private readonly ILogger < SkiaEncoder > _logger ;
private readonly IApplicationPaths _appPaths ;
/// <summary>
/// Image encoder that uses <see cref="SkiaSharp"/> to manipulate images.
/// I nitializes a new instance of the <see cref="SkiaEncoder"/> clas s.
/// </summary>
public class SkiaEncoder : IImageEncoder
/// <param name="logger">The application logger.</param>
/// <param name="appPaths">The application paths.</param>
public SkiaEncoder ( ILogger < SkiaEncoder > logger , IApplicationPaths appPaths )
{
private static readonly HashSet < string > _transparentImageTypes = new ( StringComparer . OrdinalIgnoreCase ) { ".png" , ".gif" , ".webp" } ;
_logger = logger ;
_appPaths = appPaths ;
}
private readonly ILogger < SkiaEncoder > _logger ;
private readonly IApplicationPaths _appPaths ;
/// <inheritdoc/>
public string Name = > "Skia" ;
/// <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 bool SupportsImageCollageCreation = > true ;
/// <inheritdoc/>
public string Name = > "Skia" ;
/// <inheritdoc/>
public bool SupportsImageEncoding = > true ;
/// <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 } ;
/// <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>
/// 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 ;
}
/// <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 )
catch ( Exception )
{
return selectedFormat switch
{
ImageFormat . Bmp = > SKEncodedImageFormat . Bmp ,
ImageFormat . Jpg = > SKEncodedImageFormat . Jpeg ,
ImageFormat . Gif = > SKEncodedImageFormat . Gif ,
ImageFormat . Webp = > SKEncodedImageFormat . Webp ,
_ = > SKEncodedImageFormat . Png
} ;
return false ;
}
}
/// <inheritdoc />
/// <exception cref="FileNotFoundException">The path is not valid.</exception>
public ImageDimensions GetImageSize ( string path )
/// <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
{
if ( ! File . Exists ( path ) )
{
throw new FileNotFoundException ( "File not found" , path ) ;
}
ImageFormat . Bmp = > SKEncodedImageFormat . Bmp ,
ImageFormat . Jpg = > SKEncodedImageFormat . Jpeg ,
ImageFormat . Gif = > SKEncodedImageFormat . Gif ,
ImageFormat . Webp = > SKEncodedImageFormat . Webp ,
_ = > SKEncodedImageFormat . Png
} ;
}
var extension = Path . GetExtension ( path . AsSpan ( ) ) ;
if ( extension . Equals ( ".svg" , StringComparison . OrdinalIgnoreCase ) )
{
var svg = new SKSvg ( ) ;
svg . Load ( path ) ;
return new ImageDimensions ( Convert . ToInt32 ( svg . Picture . CullRect . Width ) , Convert . ToInt32 ( svg . Picture . CullRect . Height ) ) ;
}
/// <inheritdoc />
/// <exception cref="FileNotFoundException">The path is not valid.</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 ) ;
switch ( result )
{
case SKCodecResult . Success :
var info = codec . Info ;
return new ImageDimensions ( info . Width , info . Height ) ;
case SKCodecResult . Unimplemented :
_logger . LogDebug ( "Image format not supported: {FilePath}" , path ) ;
return new ImageDimensions ( 0 , 0 ) ;
default :
_logger . LogError ( "Unable to determine image dimensions for {FilePath}: {SkCodecResult}" , path , result ) ;
return new ImageDimensions ( 0 , 0 ) ;
}
var extension = Path . GetExtension ( path . AsSpan ( ) ) ;
if ( extension . Equals ( ".svg" , StringComparison . OrdinalIgnoreCase ) )
{
var svg = new SKSvg ( ) ;
svg . Load ( path ) ;
return new ImageDimensions ( Convert . ToInt32 ( svg . Picture . CullRect . Width ) , Convert . ToInt32 ( svg . Picture . CullRect . 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 )
using var codec = SKCodec . Create ( path , out SKCodecResult result ) ;
switch ( result )
{
ArgumentException . ThrowIfNullOrEmpty ( path ) ;
case SKCodecResult . Success :
var info = codec . Info ;
return new ImageDimensions ( info . Width , info . Height ) ;
case SKCodecResult . Unimplemented :
_logger . LogDebug ( "Image format not supported: {FilePath}" , path ) ;
return new ImageDimensions ( 0 , 0 ) ;
default :
_logger . LogError ( "Unable to determine image dimensions for {FilePath}: {SkCodecResult}" , path , result ) ;
return new ImageDimensions ( 0 , 0 ) ;
}
}
var extension = Path . GetExtension ( path . AsSpan ( ) ) . TrimStart ( '.' ) ;
if ( ! SupportedInputFormats . Contains ( extension , StringComparison . OrdinalIgnoreCase ) )
{
_logger . LogDebug ( "Unable to compute blur hash due to unsupported format: {ImagePath}" , path ) ;
return string . Empty ;
}
/// <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 )
{
ArgumentException . ThrowIfNullOrEmpty ( path ) ;
// Any larger than 128x128 is too slow and there's no visually discernible difference
return BlurHashEncoder . Encode ( xComp , yComp , path , 128 , 128 ) ;
var extension = Path . GetExtension ( path . AsSpan ( ) ) . TrimStart ( '.' ) ;
if ( ! SupportedInputFormats . Contains ( extension , StringComparison . OrdinalIgnoreCase ) )
{
_logger . LogDebug ( "Unable to compute blur hash due to unsupported format: {ImagePath}" , path ) ;
return string . Empty ;
}
private bool RequiresSpecialCharacterHack ( string 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 + + )
{
for ( int i = 0 ; i < path . Length ; i + + )
if ( char . GetUnicodeCategory ( path [ i ] ) = = UnicodeCategory . OtherLetter )
{
if ( char . GetUnicodeCategory ( path [ i ] ) = = UnicodeCategory . OtherLetter )
{
return true ;
}
return true ;
}
return path . HasDiacritics ( ) ;
}
private string NormalizePath ( string path )
return path . HasDiacritics ( ) ;
}
private string NormalizePath ( string path )
{
if ( ! RequiresSpecialCharacterHack ( path ) )
{
if ( ! RequiresSpecialCharacterHack ( path ) )
{
return 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 ) ;
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 ;
}
return tempPath ;
private static SKEncodedOrigin GetSKEncodedOrigin ( ImageOrientation ? orientation )
{
if ( ! orientation . HasValue )
{
return SKEncodedOrigin . TopLeft ;
}
private static SKEncodedOrigin GetSKEncodedOrigin ( ImageOrientation ? orientation )
return orientation . Value switch
{
if ( ! orientation . HasValue )
{
return SKEncodedOrigin . TopLeft ;
}
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
} ;
}
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 ) ;
}
/// <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 ) )
var requiresTransparencyHack = _transparentImageTypes . Contains ( Path . GetExtension ( path ) ) ;
if ( requiresTransparencyHack | | forceCleanBitmap )
{
using SKCodec codec = SKCodec . Create ( NormalizePath ( path ) , out SKCodecResult res ) ;
if ( res ! = SKCodecResult . Success )
{
throw new FileNotFoundException ( "File not found" , path ) ;
origin = GetSKEncodedOrigin ( orientation ) ;
return null ;
}
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 ) ;
// create the bitmap
var bitmap = new SKBitmap ( codec . Info . Width , codec . Info . Height , ! requiresTransparencyHack ) ;
// decode
_ = codec . GetPixels ( bitmap . Info , bitmap . GetPixels ( ) ) ;
// decode
_ = codec . GetPixels ( bitmap . Info , bitmap . GetPixels ( ) ) ;
origin = codec . EncodedOrigin ;
origin = codec . EncodedOrigin ;
return bitmap ;
}
return bitmap ;
}
var resultBitmap = SKBitmap . Decode ( NormalizePath ( path ) ) ;
var resultBitmap = SKBitmap . Decode ( NormalizePath ( path ) ) ;
if ( resultBitmap is null )
{
return Decode ( path , true , orientation , out origin ) ;
}
if ( resultBitmap is null )
// 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 we have to resize these they often end up distorted
if ( resultBitmap . ColorType = = SKColorType . Gray8 )
if ( bitmap is not null & & origin ! = SKEncodedOrigin . TopLeft )
{
using ( resultBitmap )
using ( b itmap)
{
return Decode ( path , true , orientation , out origin ) ;
return OrientImage( bitmap , origin ) ;
}
}
origin = SKEncodedOrigin . TopLeft ;
return resultBitmap ;
return bitmap ;
}
private SKBitmap ? GetBitmap ( string path , bool autoOrient , ImageOrientation ? orientation )
{
if ( autoOrient )
{
var bitmap = Decode ( path , true , orientation , out var origin ) ;
return Decode ( path , false , orientation , out _ ) ;
}
if ( bitmap is not null & & origin ! = SKEncodedOrigin . TopLeft )
{
using ( bitmap )
{
return OrientImage ( bitmap , origin ) ;
}
}
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 ;
}
return bitmap ;
}
surface . DrawBitmap ( bitmap , 0 , 0 ) ;
return rotated ;
}
return Decode ( path , false , orientation , out _ ) ;
}
/// <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
} ;
private SKBitmap OrientImage ( SKBitmap bitmap , SKEncodedOrigin origin )
var kernel = new float [ 9 ]
{
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 ;
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 ( ) ;
}
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 ;
}
/// <inheritdoc/>
public string EncodeImage ( string inputPath , DateTime dateModified , string outputPath , bool autoOrient , ImageOrientation ? orientation , int quality , ImageProcessingOptions options , ImageFormat outputFormat )
{
ArgumentException . ThrowIfNullOrEmpty ( inputPath ) ;
ArgumentException . ThrowIfNullOrEmpty ( outputPath ) ;
surface . DrawBitmap ( bitmap , 0 , 0 ) ;
return rotated ;
var inputFormat = Path . GetExtension ( inputPath . AsSpan ( ) ) . TrimStart ( '.' ) ;
if ( ! SupportedInputFormats . Contains ( inputFormat , StringComparison . OrdinalIgnoreCase ) )
{
_logger . LogDebug ( "Unable to encode image due to unsupported format: {ImagePath}" , inputPath ) ;
return inputPath ;
}
/// <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 skiaOutputFormat = GetImageFormat ( outputFormat ) ;
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 ( ) ;
}
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 ) ;
/// <inheritdoc/>
public string EncodeImage ( string inputPath , DateTime dateModified , string outputPath , bool autoOrient , ImageOrientation ? orientation , int quality , ImageProcessingOptions options , ImageFormat outputFormat )
using var bitmap = GetBitmap ( inputPath , autoOrient , orientation ) ;
if ( bitmap is null )
{
ArgumentException . ThrowIfNullOrEmpty ( inputPath ) ;
ArgumentException . ThrowIfNullOrEmpty ( outputPath ) ;
var inputFormat = Path . GetExtension ( inputPath . AsSpan ( ) ) . TrimStart ( '.' ) ;
if ( ! SupportedInputFormats . Contains ( inputFormat , StringComparison . OrdinalIgnoreCase ) )
{
_logger . LogDebug ( "Unable to encode image due to unsupported format: {ImagePath}" , inputPath ) ;
return inputPath ;
}
throw new InvalidDataException ( $"Skia unable to read image {inputPath}" ) ;
}
var skiaOutputFormat = GetImageFormat ( outputForma t) ;
var originalImageSize = new ImageDimensions ( bitmap . Width , bitmap . Height ) ;
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 ) ;
if ( options . HasDefaultOptions ( inputPath , originalImageSize ) & & ! autoOrient )
{
// Just spit out the original file if all the options are default
return inputPath ;
}
using var bitmap = GetBitmap ( inputPath , autoOrient , orientation ) ;
if ( bitmap is null )
{
throw new InvalidDataException ( $"Skia unable to read image {inputPath}" ) ;
}
var newImageSize = ImageHelper . GetNewImageSize ( options , originalImageSize ) ;
var originalImageSize = new ImageDimensions ( bitmap . Width , bitmap . Height ) ;
var width = newImageSize . Width ;
var height = newImageSize . Height ;
if ( options . HasDefaultOptions ( inputPath , originalImageSize ) & & ! autoOrient )
{
// Just spit out the original file if all the options are default
return inputPath ;
}
// 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 ) ) ;
var newImageSize = ImageHelper . GetNewImageSize ( options , originalImageSize ) ;
// 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 ;
}
var width = newImageSize . Width ;
var height = newImageSize . Height ;
// 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 ) ) ;
}
// 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 ) ) ;
// 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 all we're doing is resizing then we can stop now
if ( ! hasBackgroundColor & & ! hasForegroundColor & & blur = = 0 & & ! hasIndicator )
// If foreground layer present then draw
if ( hasForegroundColor )
{
if ( ! double . TryParse ( options . ForegroundLayer , out double opacity ) )
{
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 ;
opacity = . 4 ;
}
// 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 ) ) ;
}
canvas . DrawColor ( new SKColor ( 0 , 0 , 0 , ( byte ) ( ( 1 - opacity ) * 0xFF ) ) , SKBlendMode . SrcOver ) ;
}
// 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 ( hasIndicator )
{
DrawIndicator ( canvas , width , height , options ) ;
}
// If foreground layer present then draw
if ( hasForegroundColor )
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 ( ) ) )
{
if ( ! double . TryParse ( options . ForegroundLayer , out double opacity ) )
{
opacity = . 4 ;
}
canvas . DrawColor ( new SKColor ( 0 , 0 , 0 , ( byte ) ( ( 1 - opacity ) * 0xFF ) ) , SKBlendMode . SrcOver ) ;
pixmap . Encode ( outputStream , skiaOutputFormat , quality ) ;
}
}
if ( hasIndicator )
{
DrawIndicator ( canvas , width , height , options ) ;
}
return outputPath ;
}
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 ) ;
}
}
/// <inheritdoc/>
public void CreateImageCollage ( ImageCollageOptions options , string? libraryName )
{
double ratio = ( double ) options . Width / options . Height ;
return outputPath ;
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 ) ;
}
}
/// <inheritdoc />
public void CreateSplashscreen ( IReadOnlyList < string > posters , IReadOnlyList < string > backdrops )
{
var splashBuilder = new SplashscreenBuilder ( this ) ;
var outputPath = Path . Combine ( _appPaths . DataPath , "splashscreen.png" ) ;
splashBuilder . GenerateSplash ( posters , backdrops , outputPath ) ;
}
/// <inheritdoc/>
public void CreateImageCollage ( ImageCollageOptions options , string? libraryName )
private void DrawIndicator ( SKCanvas canvas , int imageWidth , int imageHeight , ImageProcessingOptions options )
{
try
{
double ratio = ( double ) options . Width / options . Height ;
var currentImageSize = new ImageDimensions ( imageWidth , imageHeight ) ;
if ( ratio > = 1.4 )
if ( options. AddPlayedIndicator )
{
new StripCollageBuilder ( this ) . BuildThumbCollage ( options . InputPaths , options . OutputPath , options . Width , options . Height , libraryName ) ;
PlayedIndicatorDrawer . DrawPlayedIndicator ( canvas , currentImageSiz ) ;
}
else if ( ratio > = . 9 )
else if ( options. UnplayedCount . HasValue )
{
new StripCollageBuilder ( this ) . BuildSquareCollage ( options . InputPaths , options . OutputPath , options . Width , options . Height ) ;
UnplayedCountIndicator . DrawUnplayedCountIndicator ( canvas , currentImageSize , options . UnplayedCount . Value ) ;
}
else
if ( options . PercentPlayed > 0 )
{
// TODO: Create Poster collage capability
new StripCollageBuilder ( this ) . BuildSquareCollage ( options . InputPaths , options . OutputPath , options . Width , options . Height ) ;
PercentPlayedDrawer . Process ( canvas , currentImageSize , options . PercentPlayed ) ;
}
}
/// <inheritdoc />
public void CreateSplashscreen ( IReadOnlyList < string > posters , IReadOnlyList < string > backdrops )
catch ( Exception ex )
{
var splashBuilder = new SplashscreenBuilder ( this ) ;
var outputPath = Path . Combine ( _appPaths . DataPath , "splashscreen.png" ) ;
splashBuilder . GenerateSplash ( posters , backdrops , outputPath ) ;
}
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" ) ;
}
_logger . LogError ( ex , "Error drawing indicator overlay" ) ;
}
}
}
Patrick Barron
1 year ago