2015-09-20 13:56:26 -04:00
|
|
|
|
using MediaBrowser.Common.Extensions;
|
2013-09-18 14:49:06 -04:00
|
|
|
|
using MediaBrowser.Controller;
|
|
|
|
|
using MediaBrowser.Controller.Drawing;
|
|
|
|
|
using MediaBrowser.Controller.Entities;
|
|
|
|
|
using MediaBrowser.Controller.Providers;
|
|
|
|
|
using MediaBrowser.Model.Drawing;
|
2013-09-19 11:12:28 -04:00
|
|
|
|
using MediaBrowser.Model.Entities;
|
2018-12-13 08:18:25 -05:00
|
|
|
|
using Microsoft.Extensions.Logging;
|
2013-11-07 10:57:12 -05:00
|
|
|
|
using MediaBrowser.Model.Serialization;
|
2013-09-18 14:49:06 -04:00
|
|
|
|
using System;
|
|
|
|
|
using System.Collections.Concurrent;
|
2013-09-19 11:12:28 -04:00
|
|
|
|
using System.Collections.Generic;
|
|
|
|
|
using System.Globalization;
|
2013-09-18 14:49:06 -04:00
|
|
|
|
using System.IO;
|
2013-09-19 11:12:28 -04:00
|
|
|
|
using System.Linq;
|
|
|
|
|
using System.Threading;
|
|
|
|
|
using System.Threading.Tasks;
|
2016-10-25 15:02:04 -04:00
|
|
|
|
using MediaBrowser.Model.IO;
|
2015-09-20 13:56:26 -04:00
|
|
|
|
using Emby.Drawing.Common;
|
2015-10-16 13:06:31 -04:00
|
|
|
|
using MediaBrowser.Controller.Library;
|
2017-08-26 02:18:52 -04:00
|
|
|
|
using MediaBrowser.Controller.MediaEncoding;
|
2015-11-09 13:18:37 -05:00
|
|
|
|
using MediaBrowser.Model.Net;
|
2016-11-11 12:33:10 -05:00
|
|
|
|
using MediaBrowser.Model.Threading;
|
2017-08-09 15:56:38 -04:00
|
|
|
|
using MediaBrowser.Model.Extensions;
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
2015-04-08 10:38:02 -04:00
|
|
|
|
namespace Emby.Drawing
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
|
|
|
|
/// <summary>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// Class ImageProcessor
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// </summary>
|
2013-11-07 10:57:12 -05:00
|
|
|
|
public class ImageProcessor : IImageProcessor, IDisposable
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2013-06-03 14:15:35 -04:00
|
|
|
|
/// <summary>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// The us culture
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// </summary>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
protected readonly CultureInfo UsCulture = new CultureInfo("en-US");
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
|
|
|
|
/// <summary>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// Gets the list of currently registered image processors
|
|
|
|
|
/// Image processors are specialized metadata providers that run after the normal ones
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// </summary>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// <value>The image enhancers.</value>
|
2017-08-24 15:52:19 -04:00
|
|
|
|
public IImageEnhancer[] ImageEnhancers { get; private set; }
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
2013-02-21 16:39:53 -05:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// The _logger
|
|
|
|
|
/// </summary>
|
|
|
|
|
private readonly ILogger _logger;
|
2013-11-04 14:04:23 -05:00
|
|
|
|
|
2013-10-31 10:03:23 -04:00
|
|
|
|
private readonly IFileSystem _fileSystem;
|
2013-11-07 10:57:12 -05:00
|
|
|
|
private readonly IJsonSerializer _jsonSerializer;
|
|
|
|
|
private readonly IServerApplicationPaths _appPaths;
|
2017-05-12 14:09:42 -04:00
|
|
|
|
private IImageEncoder _imageEncoder;
|
2015-10-16 13:06:31 -04:00
|
|
|
|
private readonly Func<ILibraryManager> _libraryManager;
|
2017-08-26 02:18:52 -04:00
|
|
|
|
private readonly Func<IMediaEncoder> _mediaEncoder;
|
2013-09-18 14:49:06 -04:00
|
|
|
|
|
2015-04-29 13:39:23 -04:00
|
|
|
|
public ImageProcessor(ILogger logger,
|
|
|
|
|
IServerApplicationPaths appPaths,
|
|
|
|
|
IFileSystem fileSystem,
|
|
|
|
|
IJsonSerializer jsonSerializer,
|
|
|
|
|
IImageEncoder imageEncoder,
|
2017-08-26 02:18:52 -04:00
|
|
|
|
Func<ILibraryManager> libraryManager, ITimerFactory timerFactory, Func<IMediaEncoder> mediaEncoder)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2013-02-21 16:39:53 -05:00
|
|
|
|
_logger = logger;
|
2013-10-31 10:03:23 -04:00
|
|
|
|
_fileSystem = fileSystem;
|
2013-11-07 10:57:12 -05:00
|
|
|
|
_jsonSerializer = jsonSerializer;
|
2015-04-08 10:38:02 -04:00
|
|
|
|
_imageEncoder = imageEncoder;
|
2015-10-16 13:06:31 -04:00
|
|
|
|
_libraryManager = libraryManager;
|
2017-08-26 02:18:52 -04:00
|
|
|
|
_mediaEncoder = mediaEncoder;
|
2013-11-07 10:57:12 -05:00
|
|
|
|
_appPaths = appPaths;
|
2013-02-21 16:39:53 -05:00
|
|
|
|
|
2017-08-26 02:18:52 -04:00
|
|
|
|
ImageEnhancers = new IImageEnhancer[] { };
|
2017-05-17 14:18:18 -04:00
|
|
|
|
ImageHelper.ImageProcessor = this;
|
2015-04-08 10:38:02 -04:00
|
|
|
|
}
|
2014-10-26 23:06:01 -04:00
|
|
|
|
|
2017-05-12 14:09:42 -04:00
|
|
|
|
public IImageEncoder ImageEncoder
|
|
|
|
|
{
|
|
|
|
|
get { return _imageEncoder; }
|
|
|
|
|
set
|
|
|
|
|
{
|
|
|
|
|
if (value == null)
|
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(value));
|
2017-05-12 14:09:42 -04:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
_imageEncoder = value;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-04-08 10:38:02 -04:00
|
|
|
|
public string[] SupportedInputFormats
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
2017-08-26 02:18:52 -04:00
|
|
|
|
return new string[]
|
|
|
|
|
{
|
|
|
|
|
"tiff",
|
2017-09-05 15:49:02 -04:00
|
|
|
|
"tif",
|
2017-08-26 02:18:52 -04:00
|
|
|
|
"jpeg",
|
|
|
|
|
"jpg",
|
|
|
|
|
"png",
|
|
|
|
|
"aiff",
|
|
|
|
|
"cr2",
|
|
|
|
|
"crw",
|
|
|
|
|
|
|
|
|
|
// Remove until supported
|
2019-01-07 18:27:46 -05:00
|
|
|
|
//"nef",
|
2017-08-26 02:18:52 -04:00
|
|
|
|
"orf",
|
|
|
|
|
"pef",
|
|
|
|
|
"arw",
|
|
|
|
|
"webp",
|
|
|
|
|
"gif",
|
|
|
|
|
"bmp",
|
|
|
|
|
"erf",
|
|
|
|
|
"raf",
|
|
|
|
|
"rw2",
|
|
|
|
|
"nrw",
|
|
|
|
|
"dng",
|
|
|
|
|
"ico",
|
|
|
|
|
"astc",
|
|
|
|
|
"ktx",
|
|
|
|
|
"pkm",
|
|
|
|
|
"wbmp"
|
|
|
|
|
};
|
2015-04-08 10:38:02 -04:00
|
|
|
|
}
|
2013-09-18 14:49:06 -04:00
|
|
|
|
}
|
|
|
|
|
|
2015-10-26 01:29:32 -04:00
|
|
|
|
|
|
|
|
|
public bool SupportsImageCollageCreation
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
return _imageEncoder.SupportsImageCollageCreation;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2013-12-14 20:17:57 -05:00
|
|
|
|
private string ResizedImageCachePath
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
return Path.Combine(_appPaths.ImageCachePath, "resized-images");
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private string EnhancedImageCachePath
|
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
return Path.Combine(_appPaths.ImageCachePath, "enhanced-images");
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2013-09-18 14:49:06 -04:00
|
|
|
|
public void AddParts(IEnumerable<IImageEnhancer> enhancers)
|
|
|
|
|
{
|
|
|
|
|
ImageEnhancers = enhancers.ToArray();
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
|
2013-09-19 11:12:28 -04:00
|
|
|
|
public async Task ProcessImage(ImageProcessingOptions options, Stream toStream)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2014-07-17 18:21:35 -04:00
|
|
|
|
var file = await ProcessImage(options).ConfigureAwait(false);
|
|
|
|
|
|
2016-10-25 15:02:04 -04:00
|
|
|
|
using (var fileStream = _fileSystem.GetFileStream(file.Item1, FileOpenMode.Open, FileAccessMode.Read, FileShareMode.Read, true))
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2014-07-17 18:21:35 -04:00
|
|
|
|
await fileStream.CopyToAsync(toStream).ConfigureAwait(false);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
2014-07-17 18:21:35 -04:00
|
|
|
|
}
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
2015-02-19 20:57:10 -05:00
|
|
|
|
public ImageFormat[] GetSupportedImageOutputFormats()
|
2014-11-08 22:18:14 -05:00
|
|
|
|
{
|
2015-04-08 10:38:02 -04:00
|
|
|
|
return _imageEncoder.SupportedOutputFormats;
|
2014-11-08 22:18:14 -05:00
|
|
|
|
}
|
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
|
private readonly string[] TransparentImageTypes = new string[] { ".png", ".webp", ".gif" };
|
2017-09-07 14:17:18 -04:00
|
|
|
|
public bool SupportsTransparency(string path)
|
2017-07-25 14:32:03 -04:00
|
|
|
|
{
|
|
|
|
|
return TransparentImageTypes.Contains(Path.GetExtension(path) ?? string.Empty);
|
|
|
|
|
}
|
|
|
|
|
|
2016-07-17 12:59:40 -04:00
|
|
|
|
public async Task<Tuple<string, string, DateTime>> ProcessImage(ImageProcessingOptions options)
|
2014-07-17 18:21:35 -04:00
|
|
|
|
{
|
|
|
|
|
if (options == null)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(options));
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
|
2015-10-16 13:06:31 -04:00
|
|
|
|
var originalImage = options.Image;
|
2018-09-12 13:26:21 -04:00
|
|
|
|
var item = options.Item;
|
2015-10-16 13:06:31 -04:00
|
|
|
|
|
|
|
|
|
if (!originalImage.IsLocalFile)
|
|
|
|
|
{
|
2017-05-21 03:25:49 -04:00
|
|
|
|
if (item == null)
|
|
|
|
|
{
|
|
|
|
|
item = _libraryManager().GetItemById(options.ItemId);
|
|
|
|
|
}
|
|
|
|
|
originalImage = await _libraryManager().ConvertImageToLocal(item, originalImage, options.ImageIndex).ConfigureAwait(false);
|
2015-10-16 13:06:31 -04:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var originalImagePath = originalImage.Path;
|
2016-07-17 12:59:40 -04:00
|
|
|
|
var dateModified = originalImage.DateModified;
|
2018-09-12 13:26:21 -04:00
|
|
|
|
var originalImageSize = originalImage.Width > 0 && originalImage.Height > 0 ? new ImageSize(originalImage.Width, originalImage.Height) : (ImageSize?)null;
|
2013-11-07 10:57:12 -05:00
|
|
|
|
|
2015-10-26 01:29:32 -04:00
|
|
|
|
if (!_imageEncoder.SupportsImageEncoding)
|
|
|
|
|
{
|
2016-07-17 12:59:40 -04:00
|
|
|
|
return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
|
2013-11-06 16:32:26 -05:00
|
|
|
|
}
|
|
|
|
|
|
2017-08-26 02:18:52 -04:00
|
|
|
|
var supportedImageInfo = await GetSupportedImage(originalImagePath, dateModified).ConfigureAwait(false);
|
|
|
|
|
originalImagePath = supportedImageInfo.Item1;
|
|
|
|
|
dateModified = supportedImageInfo.Item2;
|
2017-09-07 14:17:18 -04:00
|
|
|
|
var requiresTransparency = TransparentImageTypes.Contains(Path.GetExtension(originalImagePath) ?? string.Empty);
|
2017-08-26 02:18:52 -04:00
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
|
if (options.Enhancers.Length > 0)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2017-05-21 03:25:49 -04:00
|
|
|
|
if (item == null)
|
|
|
|
|
{
|
|
|
|
|
item = _libraryManager().GetItemById(options.ItemId);
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-20 16:06:04 -04:00
|
|
|
|
var tuple = await GetEnhancedImage(new ItemImageInfo
|
|
|
|
|
{
|
|
|
|
|
DateModified = dateModified,
|
2015-10-16 13:06:31 -04:00
|
|
|
|
Type = originalImage.Type,
|
2015-03-20 16:06:04 -04:00
|
|
|
|
Path = originalImagePath
|
|
|
|
|
|
2017-12-01 12:04:32 -05:00
|
|
|
|
}, requiresTransparency, item, options.ImageIndex, options.Enhancers, CancellationToken.None).ConfigureAwait(false);
|
2013-06-02 12:45:32 -04:00
|
|
|
|
|
2013-09-19 11:12:28 -04:00
|
|
|
|
originalImagePath = tuple.Item1;
|
|
|
|
|
dateModified = tuple.Item2;
|
2017-09-07 14:17:18 -04:00
|
|
|
|
requiresTransparency = tuple.Item3;
|
2018-09-12 13:26:21 -04:00
|
|
|
|
// TODO: Get this info
|
|
|
|
|
originalImageSize = null;
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
|
2017-06-09 15:24:31 -04:00
|
|
|
|
var photo = item as Photo;
|
|
|
|
|
var autoOrient = false;
|
|
|
|
|
ImageOrientation? orientation = null;
|
2018-09-12 13:26:21 -04:00
|
|
|
|
if (photo != null)
|
2017-06-09 15:24:31 -04:00
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
if (photo.Orientation.HasValue)
|
|
|
|
|
{
|
|
|
|
|
if (photo.Orientation.Value != ImageOrientation.TopLeft)
|
|
|
|
|
{
|
|
|
|
|
autoOrient = true;
|
|
|
|
|
orientation = photo.Orientation;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
else
|
|
|
|
|
{
|
|
|
|
|
// Orientation unknown, so do it
|
|
|
|
|
autoOrient = true;
|
|
|
|
|
orientation = photo.Orientation;
|
|
|
|
|
}
|
2017-06-09 15:24:31 -04:00
|
|
|
|
}
|
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
|
if (options.HasDefaultOptions(originalImagePath, originalImageSize) && (!autoOrient || !options.RequiresAutoOrientation))
|
2015-11-09 13:18:37 -05:00
|
|
|
|
{
|
|
|
|
|
// Just spit out the original file if all the options are default
|
2016-07-17 12:59:40 -04:00
|
|
|
|
return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
|
2015-11-09 13:18:37 -05:00
|
|
|
|
}
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
2017-09-22 16:33:01 -04:00
|
|
|
|
//ImageSize? originalImageSize = GetSavedImageSize(originalImagePath, dateModified);
|
|
|
|
|
//if (originalImageSize.HasValue && options.HasDefaultOptions(originalImagePath, originalImageSize.Value) && !autoOrient)
|
|
|
|
|
//{
|
|
|
|
|
// // Just spit out the original file if all the options are default
|
2018-12-13 08:18:25 -05:00
|
|
|
|
// _logger.LogInformation("Returning original image {0}", originalImagePath);
|
2018-09-12 13:26:21 -04:00
|
|
|
|
// return new ValueTuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
|
2017-09-22 16:33:01 -04:00
|
|
|
|
//}
|
2013-11-07 10:57:12 -05:00
|
|
|
|
|
2017-09-22 16:33:01 -04:00
|
|
|
|
var newSize = ImageHelper.GetNewImageSize(options, null);
|
2015-10-27 10:02:30 -04:00
|
|
|
|
var quality = options.Quality;
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
2017-09-07 14:17:18 -04:00
|
|
|
|
var outputFormat = GetOutputFormat(options.SupportedOutputFormats, requiresTransparency);
|
2016-12-03 02:58:48 -05:00
|
|
|
|
var cacheFilePath = GetCacheFilePath(originalImagePath, newSize, quality, dateModified, outputFormat, options.AddPlayedIndicator, options.PercentPlayed, options.UnplayedCount, options.Blur, options.BackgroundColor, options.ForegroundLayer);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
2017-12-01 12:04:32 -05:00
|
|
|
|
CheckDisposed();
|
|
|
|
|
|
|
|
|
|
var lockInfo = GetLock(cacheFilePath);
|
|
|
|
|
|
|
|
|
|
await lockInfo.Lock.WaitAsync().ConfigureAwait(false);
|
|
|
|
|
|
2013-04-02 22:59:27 -04:00
|
|
|
|
try
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2015-09-20 13:56:26 -04:00
|
|
|
|
if (!_fileSystem.FileExists(cacheFilePath))
|
2015-03-27 00:17:04 -04:00
|
|
|
|
{
|
2017-07-25 14:32:03 -04:00
|
|
|
|
if (options.CropWhiteSpace && !SupportsTransparency(originalImagePath))
|
|
|
|
|
{
|
|
|
|
|
options.CropWhiteSpace = false;
|
|
|
|
|
}
|
|
|
|
|
|
2017-12-01 12:04:32 -05:00
|
|
|
|
var resultPath = _imageEncoder.EncodeImage(originalImagePath, dateModified, cacheFilePath, autoOrient, orientation, quality, options, outputFormat);
|
2017-05-17 14:18:18 -04:00
|
|
|
|
|
|
|
|
|
if (string.Equals(resultPath, originalImagePath, StringComparison.OrdinalIgnoreCase))
|
|
|
|
|
{
|
|
|
|
|
return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
|
|
|
|
|
}
|
|
|
|
|
|
2017-12-01 12:04:32 -05:00
|
|
|
|
return new Tuple<string, string, DateTime>(cacheFilePath, GetMimeType(outputFormat, cacheFilePath), _fileSystem.GetLastWriteTimeUtc(cacheFilePath));
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
2015-11-11 09:56:31 -05:00
|
|
|
|
|
2016-07-17 12:59:40 -04:00
|
|
|
|
return new Tuple<string, string, DateTime>(cacheFilePath, GetMimeType(outputFormat, cacheFilePath), _fileSystem.GetLastWriteTimeUtc(cacheFilePath));
|
2015-11-11 09:56:31 -05:00
|
|
|
|
}
|
2017-08-30 23:49:38 -04:00
|
|
|
|
catch (ArgumentOutOfRangeException ex)
|
|
|
|
|
{
|
|
|
|
|
// Decoder failed to decode it
|
|
|
|
|
#if DEBUG
|
2018-12-20 07:11:26 -05:00
|
|
|
|
_logger.LogError(ex, "Error encoding image");
|
2017-08-30 23:49:38 -04:00
|
|
|
|
#endif
|
|
|
|
|
// Just spit out the original file if all the options are default
|
|
|
|
|
return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
|
|
|
|
|
}
|
2015-11-11 09:56:31 -05:00
|
|
|
|
catch (Exception ex)
|
|
|
|
|
{
|
|
|
|
|
// If it fails for whatever reason, return the original image
|
2018-12-20 07:11:26 -05:00
|
|
|
|
_logger.LogError(ex, "Error encoding image");
|
2015-11-11 09:56:31 -05:00
|
|
|
|
|
|
|
|
|
// Just spit out the original file if all the options are default
|
2016-07-17 12:59:40 -04:00
|
|
|
|
return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
2017-12-01 12:04:32 -05:00
|
|
|
|
finally
|
|
|
|
|
{
|
|
|
|
|
ReleaseLock(cacheFilePath, lockInfo);
|
|
|
|
|
}
|
2016-07-17 12:59:40 -04:00
|
|
|
|
}
|
|
|
|
|
|
2017-09-07 14:17:18 -04:00
|
|
|
|
private ImageFormat GetOutputFormat(ImageFormat[] clientSupportedFormats, bool requiresTransparency)
|
|
|
|
|
{
|
|
|
|
|
var serverFormats = GetSupportedImageOutputFormats();
|
|
|
|
|
|
|
|
|
|
// Client doesn't care about format, so start with webp if supported
|
|
|
|
|
if (serverFormats.Contains(ImageFormat.Webp) && clientSupportedFormats.Contains(ImageFormat.Webp))
|
|
|
|
|
{
|
|
|
|
|
return ImageFormat.Webp;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// If transparency is needed and webp isn't supported, than png is the only option
|
2018-09-12 13:26:21 -04:00
|
|
|
|
if (requiresTransparency && clientSupportedFormats.Contains(ImageFormat.Png))
|
2017-09-07 14:17:18 -04:00
|
|
|
|
{
|
|
|
|
|
return ImageFormat.Png;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
foreach (var format in clientSupportedFormats)
|
|
|
|
|
{
|
|
|
|
|
if (serverFormats.Contains(format))
|
|
|
|
|
{
|
|
|
|
|
return format;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// We should never actually get here
|
|
|
|
|
return ImageFormat.Jpg;
|
|
|
|
|
}
|
|
|
|
|
|
2016-07-17 12:59:40 -04:00
|
|
|
|
private void CopyFile(string src, string destination)
|
|
|
|
|
{
|
|
|
|
|
try
|
|
|
|
|
{
|
2016-11-11 12:33:10 -05:00
|
|
|
|
_fileSystem.CopyFile(src, destination, true);
|
2016-07-17 12:59:40 -04:00
|
|
|
|
}
|
|
|
|
|
catch
|
|
|
|
|
{
|
2015-04-23 12:50:54 -04:00
|
|
|
|
|
2013-04-02 22:59:27 -04:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-11-09 13:18:37 -05:00
|
|
|
|
private string GetMimeType(ImageFormat format, string path)
|
2015-10-27 22:30:19 -04:00
|
|
|
|
{
|
2015-11-09 13:18:37 -05:00
|
|
|
|
if (format == ImageFormat.Bmp)
|
|
|
|
|
{
|
|
|
|
|
return MimeTypes.GetMimeType("i.bmp");
|
|
|
|
|
}
|
|
|
|
|
if (format == ImageFormat.Gif)
|
|
|
|
|
{
|
|
|
|
|
return MimeTypes.GetMimeType("i.gif");
|
|
|
|
|
}
|
|
|
|
|
if (format == ImageFormat.Jpg)
|
|
|
|
|
{
|
|
|
|
|
return MimeTypes.GetMimeType("i.jpg");
|
|
|
|
|
}
|
|
|
|
|
if (format == ImageFormat.Png)
|
|
|
|
|
{
|
|
|
|
|
return MimeTypes.GetMimeType("i.png");
|
|
|
|
|
}
|
|
|
|
|
if (format == ImageFormat.Webp)
|
2015-10-27 22:30:19 -04:00
|
|
|
|
{
|
2015-11-09 13:18:37 -05:00
|
|
|
|
return MimeTypes.GetMimeType("i.webp");
|
|
|
|
|
}
|
2015-10-27 22:30:19 -04:00
|
|
|
|
|
2015-11-09 13:18:37 -05:00
|
|
|
|
return MimeTypes.GetMimeType(path);
|
|
|
|
|
}
|
2015-10-27 22:30:19 -04:00
|
|
|
|
|
2014-01-01 13:26:31 -05:00
|
|
|
|
/// <summary>
|
2015-03-02 00:16:29 -05:00
|
|
|
|
/// Increment this when there's a change requiring caches to be invalidated
|
2014-01-01 13:26:31 -05:00
|
|
|
|
/// </summary>
|
2015-03-02 00:16:29 -05:00
|
|
|
|
private const string Version = "3";
|
2014-01-01 13:26:31 -05:00
|
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the cache file path based on a set of parameters
|
|
|
|
|
/// </summary>
|
2016-12-03 02:58:48 -05:00
|
|
|
|
private string GetCacheFilePath(string originalPath, ImageSize outputSize, int quality, DateTime dateModified, ImageFormat format, bool addPlayedIndicator, double percentPlayed, int? unwatchedCount, int? blur, string backgroundColor, string foregroundLayer)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
|
|
|
|
var filename = originalPath;
|
|
|
|
|
|
|
|
|
|
filename += "width=" + outputSize.Width;
|
|
|
|
|
|
|
|
|
|
filename += "height=" + outputSize.Height;
|
|
|
|
|
|
|
|
|
|
filename += "quality=" + quality;
|
|
|
|
|
|
|
|
|
|
filename += "datemodified=" + dateModified.Ticks;
|
|
|
|
|
|
2014-11-08 22:18:14 -05:00
|
|
|
|
filename += "f=" + format;
|
2013-09-19 11:12:28 -04:00
|
|
|
|
|
2013-10-02 11:32:11 -04:00
|
|
|
|
if (addPlayedIndicator)
|
|
|
|
|
{
|
|
|
|
|
filename += "pl=true";
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-01 16:10:54 -04:00
|
|
|
|
if (percentPlayed > 0)
|
2013-09-19 13:45:48 -04:00
|
|
|
|
{
|
2014-09-01 16:10:54 -04:00
|
|
|
|
filename += "p=" + percentPlayed;
|
2013-09-21 11:06:00 -04:00
|
|
|
|
}
|
|
|
|
|
|
2014-01-01 13:26:31 -05:00
|
|
|
|
if (unwatchedCount.HasValue)
|
|
|
|
|
{
|
|
|
|
|
filename += "p=" + unwatchedCount.Value;
|
|
|
|
|
}
|
2014-03-27 23:32:43 -04:00
|
|
|
|
|
2016-12-03 02:58:48 -05:00
|
|
|
|
if (blur.HasValue)
|
|
|
|
|
{
|
|
|
|
|
filename += "blur=" + blur.Value;
|
|
|
|
|
}
|
|
|
|
|
|
2013-09-21 11:06:00 -04:00
|
|
|
|
if (!string.IsNullOrEmpty(backgroundColor))
|
|
|
|
|
{
|
|
|
|
|
filename += "b=" + backgroundColor;
|
2013-09-19 13:45:48 -04:00
|
|
|
|
}
|
|
|
|
|
|
2016-02-23 14:48:58 -05:00
|
|
|
|
if (!string.IsNullOrEmpty(foregroundLayer))
|
|
|
|
|
{
|
|
|
|
|
filename += "fl=" + foregroundLayer;
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 00:16:29 -05:00
|
|
|
|
filename += "v=" + Version;
|
|
|
|
|
|
2014-12-08 23:57:18 -05:00
|
|
|
|
return GetCachePath(ResizedImageCachePath, filename, "." + format.ToString().ToLower());
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
|
2017-10-22 02:22:43 -04:00
|
|
|
|
public ImageSize GetImageSize(BaseItem item, ItemImageInfo info)
|
2017-06-24 14:29:23 -04:00
|
|
|
|
{
|
2017-10-22 02:22:43 -04:00
|
|
|
|
return GetImageSize(item, info, false, true);
|
2017-06-24 14:29:23 -04:00
|
|
|
|
}
|
|
|
|
|
|
2017-10-22 02:22:43 -04:00
|
|
|
|
public ImageSize GetImageSize(BaseItem item, ItemImageInfo info, bool allowSlowMethods, bool updateItem)
|
2015-02-28 08:42:47 -05:00
|
|
|
|
{
|
2017-10-22 02:22:43 -04:00
|
|
|
|
var width = info.Width;
|
|
|
|
|
var height = info.Height;
|
2015-02-28 08:42:47 -05:00
|
|
|
|
|
2017-10-22 02:22:43 -04:00
|
|
|
|
if (height > 0 && width > 0)
|
|
|
|
|
{
|
|
|
|
|
return new ImageSize
|
|
|
|
|
{
|
|
|
|
|
Width = width,
|
|
|
|
|
Height = height
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
2017-10-22 20:43:52 -04:00
|
|
|
|
var path = info.Path;
|
2018-12-13 08:18:25 -05:00
|
|
|
|
_logger.LogInformation("Getting image size for item {0} {1}", item.GetType().Name, path);
|
2017-10-22 02:22:43 -04:00
|
|
|
|
|
|
|
|
|
var size = GetImageSize(path, allowSlowMethods);
|
|
|
|
|
|
|
|
|
|
info.Height = Convert.ToInt32(size.Height);
|
|
|
|
|
info.Width = Convert.ToInt32(size.Width);
|
|
|
|
|
|
|
|
|
|
if (updateItem)
|
|
|
|
|
{
|
|
|
|
|
_libraryManager().UpdateImages(item);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return size;
|
2015-10-16 15:25:19 -04:00
|
|
|
|
}
|
|
|
|
|
|
2017-10-22 17:38:03 -04:00
|
|
|
|
public ImageSize GetImageSize(string path)
|
|
|
|
|
{
|
|
|
|
|
return GetImageSize(path, true);
|
|
|
|
|
}
|
|
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// <summary>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// Gets the size of the image.
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// </summary>
|
2017-09-22 16:33:01 -04:00
|
|
|
|
private ImageSize GetImageSize(string path, bool allowSlowMethod)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2013-09-18 14:49:06 -04:00
|
|
|
|
if (string.IsNullOrEmpty(path))
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(path));
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
|
2015-09-15 00:31:12 -04:00
|
|
|
|
try
|
2015-08-02 19:56:21 -04:00
|
|
|
|
{
|
2017-05-12 01:00:45 -04:00
|
|
|
|
return ImageHeader.GetDimensions(path, _logger, _fileSystem);
|
2015-09-20 13:56:26 -04:00
|
|
|
|
}
|
|
|
|
|
catch
|
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
if (!allowSlowMethod)
|
2017-05-12 01:00:45 -04:00
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
throw;
|
2017-05-12 01:00:45 -04:00
|
|
|
|
}
|
|
|
|
|
}
|
2018-09-12 13:26:21 -04:00
|
|
|
|
|
|
|
|
|
return _imageEncoder.GetImageSize(path);
|
2013-11-07 10:57:12 -05:00
|
|
|
|
}
|
2013-06-03 22:02:49 -04:00
|
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// <summary>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// Gets the image cache tag.
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
2014-02-07 15:30:41 -05:00
|
|
|
|
/// <param name="image">The image.</param>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// <returns>Guid.</returns>
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// <exception cref="System.ArgumentNullException">item</exception>
|
2018-09-12 13:26:21 -04:00
|
|
|
|
public string GetImageCacheTag(BaseItem item, ItemImageInfo image)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
var supportedEnhancers = GetSupportedEnhancers(item, image.Type);
|
|
|
|
|
|
|
|
|
|
return GetImageCacheTag(item, image, supportedEnhancers);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public string GetImageCacheTag(BaseItem item, ChapterInfo chapter)
|
|
|
|
|
{
|
|
|
|
|
try
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
return GetImageCacheTag(item, new ItemImageInfo
|
|
|
|
|
{
|
|
|
|
|
Path = chapter.ImagePath,
|
|
|
|
|
Type = ImageType.Chapter,
|
|
|
|
|
DateModified = chapter.ImageDateModified
|
|
|
|
|
});
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
2018-09-12 13:26:21 -04:00
|
|
|
|
catch
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
return null;
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// Gets the image cache tag.
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
2014-06-18 11:12:20 -04:00
|
|
|
|
/// <param name="image">The image.</param>
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// <param name="imageEnhancers">The image enhancers.</param>
|
|
|
|
|
/// <returns>Guid.</returns>
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// <exception cref="System.ArgumentNullException">item</exception>
|
2018-09-12 13:26:21 -04:00
|
|
|
|
public string GetImageCacheTag(BaseItem item, ItemImageInfo image, IImageEnhancer[] imageEnhancers)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
2014-06-18 11:12:20 -04:00
|
|
|
|
var originalImagePath = image.Path;
|
|
|
|
|
var dateModified = image.DateModified;
|
|
|
|
|
var imageType = image.Type;
|
|
|
|
|
|
2013-11-08 16:22:02 -05:00
|
|
|
|
// Optimization
|
2018-09-12 13:26:21 -04:00
|
|
|
|
if (imageEnhancers.Length == 0)
|
2013-11-08 16:22:02 -05:00
|
|
|
|
{
|
2015-04-19 15:17:17 -04:00
|
|
|
|
return (originalImagePath + dateModified.Ticks).GetMD5().ToString("N");
|
2013-11-08 16:22:02 -05:00
|
|
|
|
}
|
|
|
|
|
|
2013-09-18 14:49:06 -04:00
|
|
|
|
// Cache name is created with supported enhancers combined with the last config change so we pick up new config changes
|
|
|
|
|
var cacheKeys = imageEnhancers.Select(i => i.GetConfigurationCacheKey(item, imageType)).ToList();
|
2015-04-19 15:17:17 -04:00
|
|
|
|
cacheKeys.Add(originalImagePath + dateModified.Ticks);
|
2013-04-02 22:59:27 -04:00
|
|
|
|
|
2018-12-28 10:48:26 -05:00
|
|
|
|
return string.Join("|", cacheKeys.ToArray()).GetMD5().ToString("N");
|
2013-03-18 16:40:15 -04:00
|
|
|
|
}
|
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
|
private async Task<ValueTuple<string, DateTime>> GetSupportedImage(string originalImagePath, DateTime dateModified)
|
2017-08-26 02:18:52 -04:00
|
|
|
|
{
|
|
|
|
|
var inputFormat = (Path.GetExtension(originalImagePath) ?? string.Empty)
|
|
|
|
|
.TrimStart('.')
|
|
|
|
|
.Replace("jpeg", "jpg", StringComparison.OrdinalIgnoreCase);
|
|
|
|
|
|
2017-09-10 16:40:31 -04:00
|
|
|
|
// These are just jpg files renamed as tbn
|
|
|
|
|
if (string.Equals(inputFormat, "tbn", StringComparison.OrdinalIgnoreCase))
|
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
return new ValueTuple<string, DateTime>(originalImagePath, dateModified);
|
2017-09-10 16:40:31 -04:00
|
|
|
|
}
|
|
|
|
|
|
2017-08-26 02:18:52 -04:00
|
|
|
|
if (!_imageEncoder.SupportedInputFormats.Contains(inputFormat, StringComparer.OrdinalIgnoreCase))
|
|
|
|
|
{
|
|
|
|
|
try
|
|
|
|
|
{
|
|
|
|
|
var filename = (originalImagePath + dateModified.Ticks.ToString(UsCulture)).GetMD5().ToString("N");
|
|
|
|
|
|
2017-09-18 13:07:50 -04:00
|
|
|
|
var cacheExtension = _mediaEncoder().SupportsEncoder("libwebp") ? ".webp" : ".png";
|
|
|
|
|
var outputPath = Path.Combine(_appPaths.ImageCachePath, "converted-images", filename + cacheExtension);
|
2017-08-26 02:18:52 -04:00
|
|
|
|
|
|
|
|
|
var file = _fileSystem.GetFileInfo(outputPath);
|
|
|
|
|
if (!file.Exists)
|
|
|
|
|
{
|
|
|
|
|
await _mediaEncoder().ConvertImage(originalImagePath, outputPath).ConfigureAwait(false);
|
|
|
|
|
dateModified = _fileSystem.GetLastWriteTimeUtc(outputPath);
|
|
|
|
|
}
|
|
|
|
|
else
|
|
|
|
|
{
|
|
|
|
|
dateModified = file.LastWriteTimeUtc;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
originalImagePath = outputPath;
|
|
|
|
|
}
|
|
|
|
|
catch (Exception ex)
|
|
|
|
|
{
|
2018-12-20 07:11:26 -05:00
|
|
|
|
_logger.LogError(ex, "Image conversion failed for {originalImagePath}", originalImagePath);
|
2017-08-26 02:18:52 -04:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
|
return new ValueTuple<string, DateTime>(originalImagePath, dateModified);
|
2017-08-26 02:18:52 -04:00
|
|
|
|
}
|
|
|
|
|
|
2013-09-20 11:42:27 -04:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the enhanced image.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
|
|
|
|
/// <param name="imageIndex">Index of the image.</param>
|
|
|
|
|
/// <returns>Task{System.String}.</returns>
|
2018-09-12 13:26:21 -04:00
|
|
|
|
public async Task<string> GetEnhancedImage(BaseItem item, ImageType imageType, int imageIndex)
|
2013-09-20 11:42:27 -04:00
|
|
|
|
{
|
2017-08-24 15:52:19 -04:00
|
|
|
|
var enhancers = GetSupportedEnhancers(item, imageType);
|
2013-09-20 11:42:27 -04:00
|
|
|
|
|
2014-02-07 15:30:41 -05:00
|
|
|
|
var imageInfo = item.GetImageInfo(imageType, imageIndex);
|
2013-09-20 11:42:27 -04:00
|
|
|
|
|
2017-09-07 14:17:18 -04:00
|
|
|
|
var inputImageSupportsTransparency = SupportsTransparency(imageInfo.Path);
|
|
|
|
|
|
2017-12-01 12:04:32 -05:00
|
|
|
|
var result = await GetEnhancedImage(imageInfo, inputImageSupportsTransparency, item, imageIndex, enhancers, CancellationToken.None);
|
2013-09-20 11:42:27 -04:00
|
|
|
|
|
|
|
|
|
return result.Item1;
|
|
|
|
|
}
|
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
|
private async Task<ValueTuple<string, DateTime, bool>> GetEnhancedImage(ItemImageInfo image,
|
2017-09-07 14:17:18 -04:00
|
|
|
|
bool inputImageSupportsTransparency,
|
2018-09-12 13:26:21 -04:00
|
|
|
|
BaseItem item,
|
2014-06-18 11:12:20 -04:00
|
|
|
|
int imageIndex,
|
2018-09-12 13:26:21 -04:00
|
|
|
|
IImageEnhancer[] enhancers,
|
2017-12-01 12:04:32 -05:00
|
|
|
|
CancellationToken cancellationToken)
|
2013-06-04 12:53:36 -04:00
|
|
|
|
{
|
2014-06-18 11:12:20 -04:00
|
|
|
|
var originalImagePath = image.Path;
|
|
|
|
|
var dateModified = image.DateModified;
|
|
|
|
|
var imageType = image.Type;
|
2014-10-26 23:06:01 -04:00
|
|
|
|
|
2013-09-19 11:12:28 -04:00
|
|
|
|
try
|
2013-06-04 12:53:36 -04:00
|
|
|
|
{
|
2014-06-18 11:12:20 -04:00
|
|
|
|
var cacheGuid = GetImageCacheTag(item, image, enhancers);
|
|
|
|
|
|
2013-09-19 11:12:28 -04:00
|
|
|
|
// Enhance if we have enhancers
|
2018-12-20 07:39:58 -05:00
|
|
|
|
var enhancedImageInfo = await GetEnhancedImageInternal(originalImagePath, item, imageType, imageIndex, enhancers, cacheGuid, cancellationToken).ConfigureAwait(false);
|
2017-09-07 14:17:18 -04:00
|
|
|
|
|
2018-12-20 07:39:58 -05:00
|
|
|
|
var enhancedImagePath = enhancedImageInfo.Item1;
|
2013-06-04 12:53:36 -04:00
|
|
|
|
|
2013-09-19 11:12:28 -04:00
|
|
|
|
// If the path changed update dateModified
|
2018-12-20 07:39:58 -05:00
|
|
|
|
if (!string.Equals(enhancedImagePath, originalImagePath, StringComparison.OrdinalIgnoreCase))
|
2013-06-04 12:53:36 -04:00
|
|
|
|
{
|
2018-12-20 07:39:58 -05:00
|
|
|
|
var treatmentRequiresTransparency = enhancedImageInfo.Item2;
|
2017-09-07 14:17:18 -04:00
|
|
|
|
|
2018-12-20 07:39:58 -05:00
|
|
|
|
return new ValueTuple<string, DateTime, bool>(enhancedImagePath, _fileSystem.GetLastWriteTimeUtc(enhancedImagePath), treatmentRequiresTransparency);
|
2013-06-04 12:53:36 -04:00
|
|
|
|
}
|
2013-09-19 11:12:28 -04:00
|
|
|
|
}
|
|
|
|
|
catch (Exception ex)
|
|
|
|
|
{
|
2018-12-20 07:11:26 -05:00
|
|
|
|
_logger.LogError(ex, "Error enhancing image");
|
2013-09-19 11:12:28 -04:00
|
|
|
|
}
|
2013-06-04 12:53:36 -04:00
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
|
return new ValueTuple<string, DateTime, bool>(originalImagePath, dateModified, inputImageSupportsTransparency);
|
2013-06-04 12:53:36 -04:00
|
|
|
|
}
|
2013-09-16 22:44:06 -04:00
|
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// <summary>
|
2015-02-19 20:57:10 -05:00
|
|
|
|
/// Gets the enhanced image internal.
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="originalImagePath">The original image path.</param>
|
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
|
|
|
|
/// <param name="imageIndex">Index of the image.</param>
|
2013-06-02 12:45:32 -04:00
|
|
|
|
/// <param name="supportedEnhancers">The supported enhancers.</param>
|
2014-06-18 11:12:20 -04:00
|
|
|
|
/// <param name="cacheGuid">The cache unique identifier.</param>
|
2015-02-19 20:57:10 -05:00
|
|
|
|
/// <returns>Task<System.String>.</returns>
|
|
|
|
|
/// <exception cref="ArgumentNullException">
|
|
|
|
|
/// originalImagePath
|
|
|
|
|
/// or
|
|
|
|
|
/// item
|
|
|
|
|
/// </exception>
|
2018-09-12 13:26:21 -04:00
|
|
|
|
private async Task<ValueTuple<string, bool>> GetEnhancedImageInternal(string originalImagePath,
|
|
|
|
|
BaseItem item,
|
2014-10-26 23:06:01 -04:00
|
|
|
|
ImageType imageType,
|
|
|
|
|
int imageIndex,
|
2018-09-12 13:26:21 -04:00
|
|
|
|
IImageEnhancer[] supportedEnhancers,
|
2017-12-01 12:04:32 -05:00
|
|
|
|
string cacheGuid,
|
|
|
|
|
CancellationToken cancellationToken)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
|
|
|
|
if (string.IsNullOrEmpty(originalImagePath))
|
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(originalImagePath));
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (item == null)
|
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(item));
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
|
2017-09-07 14:17:18 -04:00
|
|
|
|
var treatmentRequiresTransparency = false;
|
|
|
|
|
foreach (var enhancer in supportedEnhancers)
|
|
|
|
|
{
|
|
|
|
|
if (!treatmentRequiresTransparency)
|
|
|
|
|
{
|
|
|
|
|
treatmentRequiresTransparency = enhancer.GetEnhancedImageInfo(item, originalImagePath, imageType, imageIndex).RequiresTransparency;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2013-02-20 20:33:05 -05:00
|
|
|
|
// All enhanced images are saved as png to allow transparency
|
2018-09-12 13:26:21 -04:00
|
|
|
|
var cacheExtension = _imageEncoder.SupportedOutputFormats.Contains(ImageFormat.Webp) ?
|
|
|
|
|
".webp" :
|
2017-09-07 14:17:18 -04:00
|
|
|
|
(treatmentRequiresTransparency ? ".png" : ".jpg");
|
|
|
|
|
|
|
|
|
|
var enhancedImagePath = GetCachePath(EnhancedImageCachePath, cacheGuid + cacheExtension);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
2017-12-01 12:04:32 -05:00
|
|
|
|
var lockInfo = GetLock(enhancedImagePath);
|
2013-04-02 22:59:27 -04:00
|
|
|
|
|
2017-12-01 12:04:32 -05:00
|
|
|
|
await lockInfo.Lock.WaitAsync(cancellationToken).ConfigureAwait(false);
|
2015-04-23 12:50:54 -04:00
|
|
|
|
|
2016-10-31 00:28:23 -04:00
|
|
|
|
try
|
|
|
|
|
{
|
2017-12-01 12:04:32 -05:00
|
|
|
|
// Check again in case of contention
|
|
|
|
|
if (_fileSystem.FileExists(enhancedImagePath))
|
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
return new ValueTuple<string, bool>(enhancedImagePath, treatmentRequiresTransparency);
|
2017-12-01 12:04:32 -05:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
_fileSystem.CreateDirectory(_fileSystem.GetDirectoryName(enhancedImagePath));
|
|
|
|
|
|
|
|
|
|
await ExecuteImageEnhancers(supportedEnhancers, originalImagePath, enhancedImagePath, item, imageType, imageIndex).ConfigureAwait(false);
|
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
|
return new ValueTuple<string, bool>(enhancedImagePath, treatmentRequiresTransparency);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
2017-12-01 12:04:32 -05:00
|
|
|
|
finally
|
2013-04-02 22:59:27 -04:00
|
|
|
|
{
|
2017-12-01 12:04:32 -05:00
|
|
|
|
ReleaseLock(enhancedImagePath, lockInfo);
|
2013-04-02 22:59:27 -04:00
|
|
|
|
}
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Executes the image enhancers.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="imageEnhancers">The image enhancers.</param>
|
2015-02-19 20:57:10 -05:00
|
|
|
|
/// <param name="inputPath">The input path.</param>
|
|
|
|
|
/// <param name="outputPath">The output path.</param>
|
2013-02-20 20:33:05 -05:00
|
|
|
|
/// <param name="item">The item.</param>
|
|
|
|
|
/// <param name="imageType">Type of the image.</param>
|
|
|
|
|
/// <param name="imageIndex">Index of the image.</param>
|
|
|
|
|
/// <returns>Task{EnhancedImage}.</returns>
|
2018-09-12 13:26:21 -04:00
|
|
|
|
private async Task ExecuteImageEnhancers(IEnumerable<IImageEnhancer> imageEnhancers, string inputPath, string outputPath, BaseItem item, ImageType imageType, int imageIndex)
|
2013-02-20 20:33:05 -05:00
|
|
|
|
{
|
|
|
|
|
// Run the enhancers sequentially in order of priority
|
|
|
|
|
foreach (var enhancer in imageEnhancers)
|
|
|
|
|
{
|
2016-10-07 11:08:13 -04:00
|
|
|
|
await enhancer.EnhanceImageAsync(item, inputPath, outputPath, imageType, imageIndex).ConfigureAwait(false);
|
2013-02-20 20:33:05 -05:00
|
|
|
|
|
2015-02-19 20:57:10 -05:00
|
|
|
|
// Feed the output into the next enhancer as input
|
|
|
|
|
inputPath = outputPath;
|
|
|
|
|
}
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
|
|
|
|
|
2013-09-18 14:49:06 -04:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the cache path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="path">The path.</param>
|
|
|
|
|
/// <param name="uniqueName">Name of the unique.</param>
|
|
|
|
|
/// <param name="fileExtension">The file extension.</param>
|
|
|
|
|
/// <returns>System.String.</returns>
|
|
|
|
|
/// <exception cref="System.ArgumentNullException">
|
|
|
|
|
/// path
|
|
|
|
|
/// or
|
|
|
|
|
/// uniqueName
|
|
|
|
|
/// or
|
|
|
|
|
/// fileExtension
|
|
|
|
|
/// </exception>
|
|
|
|
|
public string GetCachePath(string path, string uniqueName, string fileExtension)
|
|
|
|
|
{
|
|
|
|
|
if (string.IsNullOrEmpty(path))
|
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(path));
|
2013-09-18 14:49:06 -04:00
|
|
|
|
}
|
|
|
|
|
if (string.IsNullOrEmpty(uniqueName))
|
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(uniqueName));
|
2013-09-18 14:49:06 -04:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (string.IsNullOrEmpty(fileExtension))
|
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(fileExtension));
|
2013-09-18 14:49:06 -04:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var filename = uniqueName.GetMD5() + fileExtension;
|
|
|
|
|
|
|
|
|
|
return GetCachePath(path, filename);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Gets the cache path.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <param name="path">The path.</param>
|
|
|
|
|
/// <param name="filename">The filename.</param>
|
|
|
|
|
/// <returns>System.String.</returns>
|
|
|
|
|
/// <exception cref="System.ArgumentNullException">
|
|
|
|
|
/// path
|
|
|
|
|
/// or
|
|
|
|
|
/// filename
|
|
|
|
|
/// </exception>
|
|
|
|
|
public string GetCachePath(string path, string filename)
|
|
|
|
|
{
|
|
|
|
|
if (string.IsNullOrEmpty(path))
|
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(path));
|
2013-09-18 14:49:06 -04:00
|
|
|
|
}
|
|
|
|
|
if (string.IsNullOrEmpty(filename))
|
|
|
|
|
{
|
2019-01-06 15:50:43 -05:00
|
|
|
|
throw new ArgumentNullException(nameof(filename));
|
2013-09-18 14:49:06 -04:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
var prefix = filename.Substring(0, 1);
|
|
|
|
|
|
|
|
|
|
path = Path.Combine(path, prefix);
|
|
|
|
|
|
|
|
|
|
return Path.Combine(path, filename);
|
|
|
|
|
}
|
|
|
|
|
|
2017-05-19 13:09:37 -04:00
|
|
|
|
public void CreateImageCollage(ImageCollageOptions options)
|
2015-04-08 10:38:02 -04:00
|
|
|
|
{
|
2018-12-13 08:18:25 -05:00
|
|
|
|
_logger.LogInformation("Creating image collage and saving to {0}", options.OutputPath);
|
2015-04-23 12:50:54 -04:00
|
|
|
|
|
2016-12-02 15:10:35 -05:00
|
|
|
|
_imageEncoder.CreateImageCollage(options);
|
2015-05-11 12:32:15 -04:00
|
|
|
|
|
2018-12-13 08:18:25 -05:00
|
|
|
|
_logger.LogInformation("Completed creation of image collage and saved to {0}", options.OutputPath);
|
2015-04-08 10:38:02 -04:00
|
|
|
|
}
|
|
|
|
|
|
2018-09-12 13:26:21 -04:00
|
|
|
|
public IImageEnhancer[] GetSupportedEnhancers(BaseItem item, ImageType imageType)
|
2013-09-18 14:49:06 -04:00
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
List<IImageEnhancer> list = null;
|
2017-08-24 15:52:19 -04:00
|
|
|
|
|
|
|
|
|
foreach (var i in ImageEnhancers)
|
2013-09-18 14:49:06 -04:00
|
|
|
|
{
|
|
|
|
|
try
|
|
|
|
|
{
|
2017-08-24 15:52:19 -04:00
|
|
|
|
if (i.Supports(item, imageType))
|
|
|
|
|
{
|
2018-09-12 13:26:21 -04:00
|
|
|
|
if (list == null)
|
|
|
|
|
{
|
|
|
|
|
list = new List<IImageEnhancer>();
|
|
|
|
|
}
|
2017-08-24 15:52:19 -04:00
|
|
|
|
list.Add(i);
|
|
|
|
|
}
|
2013-09-18 14:49:06 -04:00
|
|
|
|
}
|
|
|
|
|
catch (Exception ex)
|
|
|
|
|
{
|
2018-12-20 07:11:26 -05:00
|
|
|
|
_logger.LogError(ex, "Error in image enhancer: {0}", i.GetType().Name);
|
2013-09-18 14:49:06 -04:00
|
|
|
|
}
|
2017-08-24 15:52:19 -04:00
|
|
|
|
}
|
2018-09-12 13:26:21 -04:00
|
|
|
|
|
|
|
|
|
return list == null ? Array.Empty<IImageEnhancer>() : list.ToArray();
|
2013-04-02 22:59:27 -04:00
|
|
|
|
}
|
2013-11-07 10:57:12 -05:00
|
|
|
|
|
2017-12-01 12:04:32 -05:00
|
|
|
|
private Dictionary<string, LockInfo> _locks = new Dictionary<string, LockInfo>();
|
|
|
|
|
private class LockInfo
|
|
|
|
|
{
|
|
|
|
|
public SemaphoreSlim Lock = new SemaphoreSlim(1, 1);
|
|
|
|
|
public int Count = 1;
|
|
|
|
|
}
|
|
|
|
|
private LockInfo GetLock(string key)
|
|
|
|
|
{
|
|
|
|
|
lock (_locks)
|
|
|
|
|
{
|
|
|
|
|
LockInfo info;
|
|
|
|
|
if (_locks.TryGetValue(key, out info))
|
|
|
|
|
{
|
|
|
|
|
info.Count++;
|
|
|
|
|
}
|
|
|
|
|
else
|
|
|
|
|
{
|
|
|
|
|
info = new LockInfo();
|
|
|
|
|
_locks[key] = info;
|
|
|
|
|
}
|
|
|
|
|
return info;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void ReleaseLock(string key, LockInfo info)
|
|
|
|
|
{
|
|
|
|
|
info.Lock.Release();
|
|
|
|
|
|
|
|
|
|
lock (_locks)
|
|
|
|
|
{
|
|
|
|
|
info.Count--;
|
|
|
|
|
if (info.Count <= 0)
|
|
|
|
|
{
|
|
|
|
|
_locks.Remove(key);
|
|
|
|
|
info.Lock.Dispose();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-06 01:42:59 -05:00
|
|
|
|
private bool _disposed;
|
2013-11-07 10:57:12 -05:00
|
|
|
|
public void Dispose()
|
|
|
|
|
{
|
2015-03-06 01:42:59 -05:00
|
|
|
|
_disposed = true;
|
2017-09-05 15:49:02 -04:00
|
|
|
|
|
|
|
|
|
var disposable = _imageEncoder as IDisposable;
|
|
|
|
|
if (disposable != null)
|
|
|
|
|
{
|
|
|
|
|
disposable.Dispose();
|
|
|
|
|
}
|
2013-11-07 10:57:12 -05:00
|
|
|
|
}
|
2015-03-06 01:42:59 -05:00
|
|
|
|
|
|
|
|
|
private void CheckDisposed()
|
|
|
|
|
{
|
|
|
|
|
if (_disposed)
|
|
|
|
|
{
|
|
|
|
|
throw new ObjectDisposedException(GetType().Name);
|
|
|
|
|
}
|
|
|
|
|
}
|
2013-02-20 20:33:05 -05:00
|
|
|
|
}
|
2018-12-28 10:48:26 -05:00
|
|
|
|
}
|