jellyfin/Emby.Drawing/ImageProcessor.cs

921 lines
32 KiB
C#
Raw Normal View History

2015-09-20 17:56:26 +00:00
using MediaBrowser.Common.Extensions;
2013-09-18 18:49:06 +00:00
using MediaBrowser.Controller;
using MediaBrowser.Controller.Drawing;
using MediaBrowser.Controller.Entities;
using MediaBrowser.Controller.Providers;
using MediaBrowser.Model.Drawing;
2013-09-19 15:12:28 +00:00
using MediaBrowser.Model.Entities;
using MediaBrowser.Model.Logging;
using MediaBrowser.Model.Serialization;
2013-09-18 18:49:06 +00:00
using System;
using System.Collections.Concurrent;
2013-09-19 15:12:28 +00:00
using System.Collections.Generic;
using System.Globalization;
2013-09-18 18:49:06 +00:00
using System.IO;
2013-09-19 15:12:28 +00:00
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Model.IO;
2015-09-20 17:56:26 +00:00
using Emby.Drawing.Common;
2015-10-16 17:06:31 +00:00
using MediaBrowser.Controller.Library;
using MediaBrowser.Controller.MediaEncoding;
2015-11-09 18:18:37 +00:00
using MediaBrowser.Model.Net;
2016-11-11 17:33:10 +00:00
using MediaBrowser.Model.Threading;
using MediaBrowser.Model.Extensions;
2013-02-21 01:33:05 +00:00
2015-04-08 14:38:02 +00:00
namespace Emby.Drawing
2013-02-21 01:33:05 +00:00
{
/// <summary>
2013-09-18 18:49:06 +00:00
/// Class ImageProcessor
2013-02-21 01:33:05 +00:00
/// </summary>
public class ImageProcessor : IImageProcessor, IDisposable
2013-02-21 01:33:05 +00:00
{
2013-06-03 18:15:35 +00:00
/// <summary>
2013-09-18 18:49:06 +00:00
/// The us culture
2013-02-21 01:33:05 +00:00
/// </summary>
2013-09-18 18:49:06 +00:00
protected readonly CultureInfo UsCulture = new CultureInfo("en-US");
2013-02-21 01:33:05 +00:00
/// <summary>
2013-09-18 18:49:06 +00:00
/// Gets the list of currently registered image processors
/// Image processors are specialized metadata providers that run after the normal ones
2013-02-21 01:33:05 +00:00
/// </summary>
2013-09-18 18:49:06 +00:00
/// <value>The image enhancers.</value>
2017-08-24 19:52:19 +00:00
public IImageEnhancer[] ImageEnhancers { get; private set; }
2013-02-21 01:33:05 +00:00
2013-02-21 21:39:53 +00:00
/// <summary>
/// The _logger
/// </summary>
private readonly ILogger _logger;
private readonly IFileSystem _fileSystem;
private readonly IJsonSerializer _jsonSerializer;
private readonly IServerApplicationPaths _appPaths;
2017-05-12 18:09:42 +00:00
private IImageEncoder _imageEncoder;
2015-10-16 17:06:31 +00:00
private readonly Func<ILibraryManager> _libraryManager;
private readonly Func<IMediaEncoder> _mediaEncoder;
2013-09-18 18:49:06 +00:00
2015-04-29 17:39:23 +00:00
public ImageProcessor(ILogger logger,
IServerApplicationPaths appPaths,
IFileSystem fileSystem,
IJsonSerializer jsonSerializer,
IImageEncoder imageEncoder,
Func<ILibraryManager> libraryManager, ITimerFactory timerFactory, Func<IMediaEncoder> mediaEncoder)
2013-02-21 01:33:05 +00:00
{
2013-02-21 21:39:53 +00:00
_logger = logger;
_fileSystem = fileSystem;
_jsonSerializer = jsonSerializer;
2015-04-08 14:38:02 +00:00
_imageEncoder = imageEncoder;
2015-10-16 17:06:31 +00:00
_libraryManager = libraryManager;
_mediaEncoder = mediaEncoder;
_appPaths = appPaths;
2013-02-21 21:39:53 +00:00
ImageEnhancers = new IImageEnhancer[] { };
2017-05-17 18:18:18 +00:00
ImageHelper.ImageProcessor = this;
2015-04-08 14:38:02 +00:00
}
2014-10-27 03:06:01 +00:00
2017-05-12 18:09:42 +00:00
public IImageEncoder ImageEncoder
{
get { return _imageEncoder; }
set
{
if (value == null)
{
throw new ArgumentNullException("value");
}
_imageEncoder = value;
}
}
2015-04-08 14:38:02 +00:00
public string[] SupportedInputFormats
{
get
{
return new string[]
{
"tiff",
2017-09-05 19:49:02 +00:00
"tif",
"jpeg",
"jpg",
"png",
"aiff",
"cr2",
"crw",
// Remove until supported
//"nef",
"orf",
"pef",
"arw",
"webp",
"gif",
"bmp",
"erf",
"raf",
"rw2",
"nrw",
"dng",
"ico",
"astc",
"ktx",
"pkm",
"wbmp"
};
2015-04-08 14:38:02 +00:00
}
2013-09-18 18:49:06 +00:00
}
2015-10-26 05:29:32 +00:00
public bool SupportsImageCollageCreation
{
get
{
return _imageEncoder.SupportsImageCollageCreation;
}
}
2013-12-15 01:17:57 +00: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 18:49:06 +00:00
public void AddParts(IEnumerable<IImageEnhancer> enhancers)
{
ImageEnhancers = enhancers.ToArray();
2013-02-21 01:33:05 +00:00
}
2013-09-19 15:12:28 +00:00
public async Task ProcessImage(ImageProcessingOptions options, Stream toStream)
2013-02-21 01:33:05 +00:00
{
2014-07-17 22:21:35 +00:00
var file = await ProcessImage(options).ConfigureAwait(false);
2016-10-25 19:02:04 +00:00
using (var fileStream = _fileSystem.GetFileStream(file.Item1, FileOpenMode.Open, FileAccessMode.Read, FileShareMode.Read, true))
2013-02-21 01:33:05 +00:00
{
2014-07-17 22:21:35 +00:00
await fileStream.CopyToAsync(toStream).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
}
2014-07-17 22:21:35 +00:00
}
2013-02-21 01:33:05 +00:00
public ImageFormat[] GetSupportedImageOutputFormats()
{
2015-04-08 14:38:02 +00:00
return _imageEncoder.SupportedOutputFormats;
}
2017-07-25 18:32:03 +00:00
private static readonly string[] TransparentImageTypes = new string[] { ".png", ".webp" };
2017-09-07 18:17:18 +00:00
public bool SupportsTransparency(string path)
2017-07-25 18:32:03 +00:00
{
return TransparentImageTypes.Contains(Path.GetExtension(path) ?? string.Empty);
}
2016-07-17 16:59:40 +00:00
public async Task<Tuple<string, string, DateTime>> ProcessImage(ImageProcessingOptions options)
2014-07-17 22:21:35 +00:00
{
if (options == null)
2013-02-21 01:33:05 +00:00
{
2014-07-17 22:21:35 +00:00
throw new ArgumentNullException("options");
2013-02-21 01:33:05 +00:00
}
2015-10-16 17:06:31 +00:00
var originalImage = options.Image;
2017-08-07 21:06:13 +00:00
IHasMetadata item = options.Item;
2015-10-16 17:06:31 +00:00
if (!originalImage.IsLocalFile)
{
2017-05-21 07:25:49 +00:00
if (item == null)
{
item = _libraryManager().GetItemById(options.ItemId);
}
originalImage = await _libraryManager().ConvertImageToLocal(item, originalImage, options.ImageIndex).ConfigureAwait(false);
2015-10-16 17:06:31 +00:00
}
var originalImagePath = originalImage.Path;
2016-07-17 16:59:40 +00:00
var dateModified = originalImage.DateModified;
2015-10-26 05:29:32 +00:00
if (!_imageEncoder.SupportsImageEncoding)
{
2016-07-17 16:59:40 +00:00
return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
}
var supportedImageInfo = await GetSupportedImage(originalImagePath, dateModified).ConfigureAwait(false);
originalImagePath = supportedImageInfo.Item1;
dateModified = supportedImageInfo.Item2;
2017-09-07 18:17:18 +00:00
var requiresTransparency = TransparentImageTypes.Contains(Path.GetExtension(originalImagePath) ?? string.Empty);
2013-09-19 15:12:28 +00:00
if (options.Enhancers.Count > 0)
2013-02-21 01:33:05 +00:00
{
2017-05-21 07:25:49 +00:00
if (item == null)
{
item = _libraryManager().GetItemById(options.ItemId);
}
var tuple = await GetEnhancedImage(new ItemImageInfo
{
DateModified = dateModified,
2015-10-16 17:06:31 +00:00
Type = originalImage.Type,
Path = originalImagePath
2017-09-07 18:17:18 +00:00
}, requiresTransparency, item, options.ImageIndex, options.Enhancers).ConfigureAwait(false);
2013-06-02 16:45:32 +00:00
2013-09-19 15:12:28 +00:00
originalImagePath = tuple.Item1;
dateModified = tuple.Item2;
2017-09-07 18:17:18 +00:00
requiresTransparency = tuple.Item3;
2013-02-21 01:33:05 +00:00
}
2017-06-09 19:24:31 +00:00
var photo = item as Photo;
var autoOrient = false;
ImageOrientation? orientation = null;
if (photo != null && photo.Orientation.HasValue && photo.Orientation.Value != ImageOrientation.TopLeft)
{
autoOrient = true;
orientation = photo.Orientation;
}
2017-09-07 18:17:18 +00:00
if (options.HasDefaultOptions(originalImagePath) && (!autoOrient || !options.RequiresAutoOrientation))
2015-11-09 18:18:37 +00:00
{
// Just spit out the original file if all the options are default
2016-07-17 16:59:40 +00:00
return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
2015-11-09 18:18:37 +00:00
}
2013-02-21 01:33:05 +00:00
2017-09-22 20:33:01 +00: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
// _logger.Info("Returning original image {0}", originalImagePath);
// return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
//}
2017-09-22 20:33:01 +00:00
var newSize = ImageHelper.GetNewImageSize(options, null);
2015-10-27 14:02:30 +00:00
var quality = options.Quality;
2013-02-21 01:33:05 +00:00
2017-09-07 18:17:18 +00:00
var outputFormat = GetOutputFormat(options.SupportedOutputFormats, requiresTransparency);
2016-12-03 07:58:48 +00:00
var cacheFilePath = GetCacheFilePath(originalImagePath, newSize, quality, dateModified, outputFormat, options.AddPlayedIndicator, options.PercentPlayed, options.UnplayedCount, options.Blur, options.BackgroundColor, options.ForegroundLayer);
2013-02-21 01:33:05 +00:00
2013-04-03 02:59:27 +00:00
try
2013-02-21 01:33:05 +00:00
{
CheckDisposed();
2015-03-06 17:50:14 +00:00
2015-09-20 17:56:26 +00:00
if (!_fileSystem.FileExists(cacheFilePath))
2015-03-27 04:17:04 +00:00
{
2016-07-23 05:03:16 +00:00
var tmpPath = Path.ChangeExtension(Path.Combine(_appPaths.TempDirectory, Guid.NewGuid().ToString("N")), Path.GetExtension(cacheFilePath));
2017-05-04 18:14:45 +00:00
_fileSystem.CreateDirectory(_fileSystem.GetDirectoryName(tmpPath));
2017-07-25 18:32:03 +00:00
if (options.CropWhiteSpace && !SupportsTransparency(originalImagePath))
{
options.CropWhiteSpace = false;
}
2017-06-09 19:24:31 +00:00
var resultPath = _imageEncoder.EncodeImage(originalImagePath, dateModified, tmpPath, autoOrient, orientation, quality, options, outputFormat);
2017-05-17 18:18:18 +00:00
if (string.Equals(resultPath, originalImagePath, StringComparison.OrdinalIgnoreCase))
{
return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
}
2017-06-09 19:24:31 +00:00
_fileSystem.CreateDirectory(_fileSystem.GetDirectoryName(cacheFilePath));
2016-07-17 16:59:40 +00:00
CopyFile(tmpPath, cacheFilePath);
return new Tuple<string, string, DateTime>(tmpPath, GetMimeType(outputFormat, cacheFilePath), _fileSystem.GetLastWriteTimeUtc(tmpPath));
2013-02-21 01:33:05 +00:00
}
2015-11-11 14:56:31 +00:00
2016-07-17 16:59:40 +00:00
return new Tuple<string, string, DateTime>(cacheFilePath, GetMimeType(outputFormat, cacheFilePath), _fileSystem.GetLastWriteTimeUtc(cacheFilePath));
2015-11-11 14:56:31 +00:00
}
2017-08-31 03:49:38 +00:00
catch (ArgumentOutOfRangeException ex)
{
// Decoder failed to decode it
#if DEBUG
_logger.ErrorException("Error encoding image", ex);
#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 14:56:31 +00:00
catch (Exception ex)
{
// If it fails for whatever reason, return the original image
_logger.ErrorException("Error encoding image", ex);
// Just spit out the original file if all the options are default
2016-07-17 16:59:40 +00:00
return new Tuple<string, string, DateTime>(originalImagePath, MimeTypes.GetMimeType(originalImagePath), dateModified);
2013-02-21 01:33:05 +00:00
}
2016-07-17 16:59:40 +00:00
}
2017-09-07 18:17:18 +00: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
if (requiresTransparency)
{
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 16:59:40 +00:00
private void CopyFile(string src, string destination)
{
try
{
2016-11-11 17:33:10 +00:00
_fileSystem.CopyFile(src, destination, true);
2016-07-17 16:59:40 +00:00
}
catch
{
2013-04-03 02:59:27 +00:00
}
}
2016-01-21 16:53:03 +00:00
//private static int[][] OPERATIONS = new int[][] {
// TopLeft
//new int[] { 0, NONE},
// TopRight
//new int[] { 0, HORIZONTAL},
//new int[] {180, NONE},
// LeftTop
//new int[] { 0, VERTICAL},
//new int[] { 90, HORIZONTAL},
// RightTop
//new int[] { 90, NONE},
//new int[] {-90, HORIZONTAL},
//new int[] {-90, NONE},
//};
2015-11-09 18:18:37 +00:00
private string GetMimeType(ImageFormat format, string path)
2015-10-28 02:30:19 +00:00
{
2015-11-09 18:18:37 +00: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-28 02:30:19 +00:00
{
2015-11-09 18:18:37 +00:00
return MimeTypes.GetMimeType("i.webp");
}
2015-10-28 02:30:19 +00:00
2015-11-09 18:18:37 +00:00
return MimeTypes.GetMimeType(path);
}
2015-10-28 02:30:19 +00:00
/// <summary>
2015-03-02 05:16:29 +00:00
/// Increment this when there's a change requiring caches to be invalidated
/// </summary>
2015-03-02 05:16:29 +00:00
private const string Version = "3";
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the cache file path based on a set of parameters
/// </summary>
2016-12-03 07:58:48 +00: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-21 01:33:05 +00:00
{
var filename = originalPath;
filename += "width=" + outputSize.Width;
filename += "height=" + outputSize.Height;
filename += "quality=" + quality;
filename += "datemodified=" + dateModified.Ticks;
filename += "f=" + format;
2013-09-19 15:12:28 +00:00
if (addPlayedIndicator)
{
filename += "pl=true";
}
if (percentPlayed > 0)
{
filename += "p=" + percentPlayed;
2013-09-21 15:06:00 +00:00
}
if (unwatchedCount.HasValue)
{
filename += "p=" + unwatchedCount.Value;
}
2014-03-28 03:32:43 +00:00
2016-12-03 07:58:48 +00:00
if (blur.HasValue)
{
filename += "blur=" + blur.Value;
}
2013-09-21 15:06:00 +00:00
if (!string.IsNullOrEmpty(backgroundColor))
{
filename += "b=" + backgroundColor;
}
2016-02-23 19:48:58 +00:00
if (!string.IsNullOrEmpty(foregroundLayer))
{
filename += "fl=" + foregroundLayer;
}
2015-03-02 05:16:29 +00:00
filename += "v=" + Version;
2014-12-09 04:57:18 +00:00
return GetCachePath(ResizedImageCachePath, filename, "." + format.ToString().ToLower());
2013-02-21 01:33:05 +00:00
}
2017-10-22 06:22:43 +00:00
public ImageSize GetImageSize(BaseItem item, ItemImageInfo info)
2017-06-24 18:29:23 +00:00
{
2017-10-22 06:22:43 +00:00
return GetImageSize(item, info, false, true);
2017-06-24 18:29:23 +00:00
}
2017-10-22 06:22:43 +00:00
public ImageSize GetImageSize(BaseItem item, ItemImageInfo info, bool allowSlowMethods, bool updateItem)
2015-02-28 13:42:47 +00:00
{
2017-10-22 06:22:43 +00:00
var width = info.Width;
var height = info.Height;
2015-02-28 13:42:47 +00:00
2017-10-22 06:22:43 +00:00
if (height > 0 && width > 0)
{
return new ImageSize
{
Width = width,
Height = height
};
}
2017-10-23 00:43:52 +00:00
var path = info.Path;
2017-10-22 06:22:43 +00:00
_logger.Info("Getting image size for item {0} {1}", item.GetType().Name, path);
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 19:25:19 +00:00
}
2017-10-22 21:38:03 +00:00
public ImageSize GetImageSize(string path)
{
return GetImageSize(path, true);
}
2013-02-21 01:33:05 +00:00
/// <summary>
2013-09-18 18:49:06 +00:00
/// Gets the size of the image.
2013-02-21 01:33:05 +00:00
/// </summary>
2017-09-22 20:33:01 +00:00
private ImageSize GetImageSize(string path, bool allowSlowMethod)
2013-02-21 01:33:05 +00:00
{
2013-09-18 18:49:06 +00:00
if (string.IsNullOrEmpty(path))
2013-02-21 01:33:05 +00:00
{
2013-09-18 18:49:06 +00:00
throw new ArgumentNullException("path");
2013-02-21 01:33:05 +00:00
}
2017-09-22 20:33:01 +00:00
return GetImageSizeInternal(path, allowSlowMethod);
2013-02-21 01:33:05 +00:00
}
/// <summary>
2013-09-18 18:49:06 +00:00
/// Gets the image size internal.
2013-02-21 01:33:05 +00:00
/// </summary>
2013-09-18 18:49:06 +00:00
/// <param name="path">The path.</param>
2015-08-02 23:56:21 +00:00
/// <param name="allowSlowMethod">if set to <c>true</c> [allow slow method].</param>
2013-02-21 01:33:05 +00:00
/// <returns>ImageSize.</returns>
2015-08-02 23:56:21 +00:00
private ImageSize GetImageSizeInternal(string path, bool allowSlowMethod)
2013-02-21 01:33:05 +00:00
{
2017-05-12 05:00:45 +00:00
//try
//{
2017-05-14 18:55:40 +00:00
// using (var fileStream = _fileSystem.OpenRead(path))
2017-05-12 05:00:45 +00:00
// {
2017-05-14 18:55:40 +00:00
// using (var file = TagLib.File.Create(new StreamFileAbstraction(Path.GetFileName(path), fileStream, null)))
2017-05-12 05:00:45 +00:00
// {
2017-05-14 18:55:40 +00:00
// var image = file as TagLib.Image.File;
// if (image != null)
// {
// var properties = image.Properties;
// return new ImageSize
// {
// Height = properties.PhotoHeight,
// Width = properties.PhotoWidth
// };
// }
// }
2017-05-12 05:00:45 +00:00
// }
//}
//catch
//{
//}
2015-09-15 04:31:12 +00:00
try
2015-08-02 23:56:21 +00:00
{
2017-05-12 05:00:45 +00:00
return ImageHeader.GetDimensions(path, _logger, _fileSystem);
2015-09-20 17:56:26 +00:00
}
catch
{
2017-05-12 05:00:45 +00:00
if (allowSlowMethod)
{
return _imageEncoder.GetImageSize(path);
}
2015-09-15 04:31:12 +00:00
2017-05-12 05:00:45 +00:00
throw;
}
}
2013-06-04 02:02:49 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
2013-09-18 18:49:06 +00:00
/// Gets the image cache tag.
2013-02-21 01:33:05 +00:00
/// </summary>
/// <param name="item">The item.</param>
2014-02-07 20:30:41 +00:00
/// <param name="image">The image.</param>
2013-09-18 18:49:06 +00:00
/// <returns>Guid.</returns>
2013-02-21 01:33:05 +00:00
/// <exception cref="System.ArgumentNullException">item</exception>
2017-08-07 21:06:13 +00:00
public string GetImageCacheTag(IHasMetadata item, ItemImageInfo image)
2013-02-21 01:33:05 +00:00
{
if (item == null)
{
throw new ArgumentNullException("item");
}
2014-02-07 20:30:41 +00:00
if (image == null)
2013-02-21 01:33:05 +00:00
{
2014-02-07 20:30:41 +00:00
throw new ArgumentNullException("image");
2013-02-21 01:33:05 +00:00
}
2014-02-07 20:30:41 +00:00
var supportedEnhancers = GetSupportedEnhancers(item, image.Type);
2013-04-03 02:59:27 +00:00
2017-08-24 19:52:19 +00:00
return GetImageCacheTag(item, image, supportedEnhancers);
2013-02-21 01:33:05 +00:00
}
/// <summary>
2013-09-18 18:49:06 +00:00
/// Gets the image cache tag.
2013-02-21 01:33:05 +00:00
/// </summary>
/// <param name="item">The item.</param>
2014-06-18 15:12:20 +00:00
/// <param name="image">The image.</param>
2013-09-18 18:49:06 +00:00
/// <param name="imageEnhancers">The image enhancers.</param>
/// <returns>Guid.</returns>
2013-02-21 01:33:05 +00:00
/// <exception cref="System.ArgumentNullException">item</exception>
2017-08-07 21:06:13 +00:00
public string GetImageCacheTag(IHasMetadata item, ItemImageInfo image, List<IImageEnhancer> imageEnhancers)
2013-02-21 01:33:05 +00:00
{
if (item == null)
{
throw new ArgumentNullException("item");
}
2013-09-18 18:49:06 +00:00
if (imageEnhancers == null)
2013-04-03 02:59:27 +00:00
{
2013-09-18 18:49:06 +00:00
throw new ArgumentNullException("imageEnhancers");
2013-04-03 02:59:27 +00:00
}
2013-06-04 02:02:49 +00:00
2014-06-18 15:12:20 +00:00
if (image == null)
2013-02-21 01:33:05 +00:00
{
2014-06-18 15:12:20 +00:00
throw new ArgumentNullException("image");
2013-02-21 01:33:05 +00:00
}
2013-03-18 20:40:15 +00:00
2014-06-18 15:12:20 +00:00
var originalImagePath = image.Path;
var dateModified = image.DateModified;
var imageType = image.Type;
2013-11-08 21:22:02 +00:00
// Optimization
if (imageEnhancers.Count == 0)
{
2015-04-19 19:17:17 +00:00
return (originalImagePath + dateModified.Ticks).GetMD5().ToString("N");
2013-11-08 21:22:02 +00:00
}
2013-09-18 18:49:06 +00: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 19:17:17 +00:00
cacheKeys.Add(originalImagePath + dateModified.Ticks);
2013-04-03 02:59:27 +00:00
return string.Join("|", cacheKeys.ToArray(cacheKeys.Count)).GetMD5().ToString("N");
2013-03-18 20:40:15 +00:00
}
private async Task<Tuple<string, DateTime>> GetSupportedImage(string originalImagePath, DateTime dateModified)
{
var inputFormat = (Path.GetExtension(originalImagePath) ?? string.Empty)
.TrimStart('.')
.Replace("jpeg", "jpg", StringComparison.OrdinalIgnoreCase);
// These are just jpg files renamed as tbn
if (string.Equals(inputFormat, "tbn", StringComparison.OrdinalIgnoreCase))
{
return new Tuple<string, DateTime>(originalImagePath, dateModified);
}
if (!_imageEncoder.SupportedInputFormats.Contains(inputFormat, StringComparer.OrdinalIgnoreCase))
{
try
{
var filename = (originalImagePath + dateModified.Ticks.ToString(UsCulture)).GetMD5().ToString("N");
2017-09-18 17:07:50 +00:00
var cacheExtension = _mediaEncoder().SupportsEncoder("libwebp") ? ".webp" : ".png";
var outputPath = Path.Combine(_appPaths.ImageCachePath, "converted-images", filename + cacheExtension);
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)
{
_logger.ErrorException("Image conversion failed for {0}", ex, originalImagePath);
}
}
return new Tuple<string, DateTime>(originalImagePath, dateModified);
}
/// <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>
2017-08-07 21:06:13 +00:00
public async Task<string> GetEnhancedImage(IHasMetadata item, ImageType imageType, int imageIndex)
{
2017-08-24 19:52:19 +00:00
var enhancers = GetSupportedEnhancers(item, imageType);
2014-02-07 20:30:41 +00:00
var imageInfo = item.GetImageInfo(imageType, imageIndex);
2017-09-07 18:17:18 +00:00
var inputImageSupportsTransparency = SupportsTransparency(imageInfo.Path);
var result = await GetEnhancedImage(imageInfo, inputImageSupportsTransparency, item, imageIndex, enhancers);
return result.Item1;
}
2017-09-07 18:17:18 +00:00
private async Task<Tuple<string, DateTime, bool>> GetEnhancedImage(ItemImageInfo image,
bool inputImageSupportsTransparency,
2017-08-07 21:06:13 +00:00
IHasMetadata item,
2014-06-18 15:12:20 +00:00
int imageIndex,
List<IImageEnhancer> enhancers)
2013-06-04 16:53:36 +00:00
{
2014-06-18 15:12:20 +00:00
var originalImagePath = image.Path;
var dateModified = image.DateModified;
var imageType = image.Type;
2014-10-27 03:06:01 +00:00
2013-09-19 15:12:28 +00:00
try
2013-06-04 16:53:36 +00:00
{
2014-06-18 15:12:20 +00:00
var cacheGuid = GetImageCacheTag(item, image, enhancers);
2013-09-19 15:12:28 +00:00
// Enhance if we have enhancers
2017-09-07 18:17:18 +00:00
var ehnancedImageInfo = await GetEnhancedImageInternal(originalImagePath, item, imageType, imageIndex, enhancers, cacheGuid).ConfigureAwait(false);
var ehnancedImagePath = ehnancedImageInfo.Item1;
2013-06-04 16:53:36 +00:00
2013-09-19 15:12:28 +00:00
// If the path changed update dateModified
2017-05-19 17:09:37 +00:00
if (!string.Equals(ehnancedImagePath, originalImagePath, StringComparison.OrdinalIgnoreCase))
2013-06-04 16:53:36 +00:00
{
2017-09-07 18:17:18 +00:00
var treatmentRequiresTransparency = ehnancedImageInfo.Item2;
return new Tuple<string, DateTime, bool>(ehnancedImagePath, _fileSystem.GetLastWriteTimeUtc(ehnancedImagePath), treatmentRequiresTransparency);
2013-06-04 16:53:36 +00:00
}
2013-09-19 15:12:28 +00:00
}
catch (Exception ex)
{
2017-09-19 20:08:34 +00:00
_logger.ErrorException("Error enhancing image", ex);
2013-09-19 15:12:28 +00:00
}
2013-06-04 16:53:36 +00:00
2017-09-07 18:17:18 +00:00
return new Tuple<string, DateTime, bool>(originalImagePath, dateModified, inputImageSupportsTransparency);
2013-06-04 16:53:36 +00:00
}
2013-09-17 02:44:06 +00:00
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the enhanced image internal.
2013-02-21 01:33:05 +00: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 16:45:32 +00:00
/// <param name="supportedEnhancers">The supported enhancers.</param>
2014-06-18 15:12:20 +00:00
/// <param name="cacheGuid">The cache unique identifier.</param>
/// <returns>Task&lt;System.String&gt;.</returns>
/// <exception cref="ArgumentNullException">
/// originalImagePath
/// or
/// item
/// </exception>
2017-09-07 18:17:18 +00:00
private async Task<Tuple<string, bool>> GetEnhancedImageInternal(string originalImagePath,
2017-08-07 21:06:13 +00:00
IHasMetadata item,
2014-10-27 03:06:01 +00:00
ImageType imageType,
int imageIndex,
2017-09-07 18:17:18 +00:00
List<IImageEnhancer> supportedEnhancers,
2014-06-18 15:12:20 +00:00
string cacheGuid)
2013-02-21 01:33:05 +00:00
{
if (string.IsNullOrEmpty(originalImagePath))
{
throw new ArgumentNullException("originalImagePath");
}
if (item == null)
{
throw new ArgumentNullException("item");
}
2017-09-07 18:17:18 +00:00
var treatmentRequiresTransparency = false;
foreach (var enhancer in supportedEnhancers)
{
if (!treatmentRequiresTransparency)
{
treatmentRequiresTransparency = enhancer.GetEnhancedImageInfo(item, originalImagePath, imageType, imageIndex).RequiresTransparency;
}
}
2013-02-21 01:33:05 +00:00
// All enhanced images are saved as png to allow transparency
2017-09-07 18:17:18 +00:00
var cacheExtension = _imageEncoder.SupportedOutputFormats.Contains(ImageFormat.Webp) ?
".webp" :
(treatmentRequiresTransparency ? ".png" : ".jpg");
var enhancedImagePath = GetCachePath(EnhancedImageCachePath, cacheGuid + cacheExtension);
2013-02-21 01:33:05 +00:00
2013-04-03 02:59:27 +00:00
// Check again in case of contention
2015-09-20 17:56:26 +00:00
if (_fileSystem.FileExists(enhancedImagePath))
2013-04-03 02:59:27 +00:00
{
2017-09-07 18:17:18 +00:00
return new Tuple<string, bool>(enhancedImagePath, treatmentRequiresTransparency);
2013-04-03 02:59:27 +00:00
}
2017-05-04 18:14:45 +00:00
_fileSystem.CreateDirectory(_fileSystem.GetDirectoryName(enhancedImagePath));
2016-10-31 04:28:23 +00:00
var tmpPath = Path.Combine(_appPaths.TempDirectory, Path.ChangeExtension(Guid.NewGuid().ToString(), Path.GetExtension(enhancedImagePath)));
2017-05-04 18:14:45 +00:00
_fileSystem.CreateDirectory(_fileSystem.GetDirectoryName(tmpPath));
2017-04-12 17:09:12 +00:00
await ExecuteImageEnhancers(supportedEnhancers, originalImagePath, tmpPath, item, imageType, imageIndex).ConfigureAwait(false);
2016-10-31 04:28:23 +00:00
try
{
2017-04-12 17:09:12 +00:00
_fileSystem.CopyFile(tmpPath, enhancedImagePath, true);
2013-02-21 01:33:05 +00:00
}
2017-04-12 17:09:12 +00:00
catch
2013-04-03 02:59:27 +00:00
{
2017-04-12 17:09:12 +00:00
2013-04-03 02:59:27 +00:00
}
2013-02-21 01:33:05 +00:00
2017-09-07 18:17:18 +00:00
return new Tuple<string, bool>(tmpPath, treatmentRequiresTransparency);
2013-02-21 01:33:05 +00:00
}
/// <summary>
/// Executes the image enhancers.
/// </summary>
/// <param name="imageEnhancers">The image enhancers.</param>
/// <param name="inputPath">The input path.</param>
/// <param name="outputPath">The output path.</param>
2013-02-21 01:33:05 +00: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>
2017-08-07 21:06:13 +00:00
private async Task ExecuteImageEnhancers(IEnumerable<IImageEnhancer> imageEnhancers, string inputPath, string outputPath, IHasMetadata item, ImageType imageType, int imageIndex)
2013-02-21 01:33:05 +00:00
{
// Run the enhancers sequentially in order of priority
foreach (var enhancer in imageEnhancers)
{
2016-10-07 15:08:13 +00:00
await enhancer.EnhanceImageAsync(item, inputPath, outputPath, imageType, imageIndex).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
// Feed the output into the next enhancer as input
inputPath = outputPath;
}
2013-02-21 01:33:05 +00:00
}
2013-09-18 18:49:06 +00: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))
{
throw new ArgumentNullException("path");
}
if (string.IsNullOrEmpty(uniqueName))
{
throw new ArgumentNullException("uniqueName");
}
if (string.IsNullOrEmpty(fileExtension))
{
throw new ArgumentNullException("fileExtension");
}
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))
{
throw new ArgumentNullException("path");
}
if (string.IsNullOrEmpty(filename))
{
throw new ArgumentNullException("filename");
}
var prefix = filename.Substring(0, 1);
path = Path.Combine(path, prefix);
return Path.Combine(path, filename);
}
2017-05-19 17:09:37 +00:00
public void CreateImageCollage(ImageCollageOptions options)
2015-04-08 14:38:02 +00:00
{
2016-12-02 20:10:35 +00:00
_logger.Info("Creating image collage and saving to {0}", options.OutputPath);
2016-12-02 20:10:35 +00:00
_imageEncoder.CreateImageCollage(options);
2015-05-11 16:32:15 +00:00
2016-12-02 20:10:35 +00:00
_logger.Info("Completed creation of image collage and saved to {0}", options.OutputPath);
2015-04-08 14:38:02 +00:00
}
2017-08-24 19:52:19 +00:00
public List<IImageEnhancer> GetSupportedEnhancers(IHasMetadata item, ImageType imageType)
2013-09-18 18:49:06 +00:00
{
2017-08-24 19:52:19 +00:00
var list = new List<IImageEnhancer>();
foreach (var i in ImageEnhancers)
2013-09-18 18:49:06 +00:00
{
try
{
2017-08-24 19:52:19 +00:00
if (i.Supports(item, imageType))
{
list.Add(i);
}
2013-09-18 18:49:06 +00:00
}
catch (Exception ex)
{
_logger.ErrorException("Error in image enhancer: {0}", ex, i.GetType().Name);
}
2017-08-24 19:52:19 +00:00
}
return list;
2013-04-03 02:59:27 +00:00
}
private bool _disposed;
public void Dispose()
{
_disposed = true;
2017-09-05 19:49:02 +00:00
var disposable = _imageEncoder as IDisposable;
if (disposable != null)
{
disposable.Dispose();
}
GC.SuppressFinalize(this);
}
private void CheckDisposed()
{
if (_disposed)
{
throw new ObjectDisposedException(GetType().Name);
}
}
2013-02-21 01:33:05 +00:00
}
2015-09-20 17:56:26 +00:00
}