jellyfin/Emby.Drawing/ImageProcessor.cs

956 lines
33 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;
2016-10-25 19:02:04 +00:00
using MediaBrowser.Common.IO;
using MediaBrowser.Controller.IO;
2015-10-16 17:06:31 +00:00
using MediaBrowser.Controller.Library;
2015-11-09 18:18:37 +00:00
using MediaBrowser.Model.Net;
2016-11-11 17:33:10 +00:00
using MediaBrowser.Model.Threading;
2016-10-31 07:47:34 +00:00
using TagLib;
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
/// The _cached imaged sizes
2013-02-21 01:33:05 +00:00
/// </summary>
private readonly ConcurrentDictionary<Guid, ImageSize> _cachedImagedSizes;
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>
public IEnumerable<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;
2015-04-08 14:38:02 +00:00
private readonly IImageEncoder _imageEncoder;
private readonly SemaphoreSlim _imageProcessingSemaphore;
2015-10-16 17:06:31 +00:00
private readonly Func<ILibraryManager> _libraryManager;
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,
2016-11-11 17:33:10 +00:00
int maxConcurrentImageProcesses, Func<ILibraryManager> libraryManager, ITimerFactory timerFactory)
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;
_appPaths = appPaths;
2013-02-21 21:39:53 +00:00
2015-04-17 05:12:51 +00:00
ImageEnhancers = new List<IImageEnhancer>();
2016-11-11 17:33:10 +00:00
_saveImageSizeTimer = timerFactory.Create(SaveImageSizeCallback, null, Timeout.Infinite, Timeout.Infinite);
Dictionary<Guid, ImageSize> sizeDictionary;
try
{
2014-03-28 03:32:43 +00:00
sizeDictionary = jsonSerializer.DeserializeFromFile<Dictionary<Guid, ImageSize>>(ImageSizeFile) ??
2013-12-08 01:42:15 +00:00
new Dictionary<Guid, ImageSize>();
}
2013-11-12 15:36:25 +00:00
catch (FileNotFoundException)
{
// No biggie
sizeDictionary = new Dictionary<Guid, ImageSize>();
}
2016-11-11 17:33:10 +00:00
catch (IOException)
2014-12-23 03:58:14 +00:00
{
// No biggie
sizeDictionary = new Dictionary<Guid, ImageSize>();
}
2013-11-12 15:36:25 +00:00
catch (Exception ex)
{
logger.ErrorException("Error parsing image size cache file", ex);
sizeDictionary = new Dictionary<Guid, ImageSize>();
}
_cachedImagedSizes = new ConcurrentDictionary<Guid, ImageSize>(sizeDictionary);
2015-04-29 17:39:23 +00:00
_logger.Info("ImageProcessor started with {0} max concurrent image processes", maxConcurrentImageProcesses);
_imageProcessingSemaphore = new SemaphoreSlim(maxConcurrentImageProcesses, maxConcurrentImageProcesses);
2015-04-08 14:38:02 +00:00
}
2014-10-27 03:06:01 +00:00
2015-04-08 14:38:02 +00:00
public string[] SupportedInputFormats
{
get
{
return _imageEncoder.SupportedInputFormats;
}
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");
}
}
private string CroppedWhitespaceImageCachePath
{
get
{
return Path.Combine(_appPaths.ImageCachePath, "cropped-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;
}
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;
if (!originalImage.IsLocalFile)
{
originalImage = await _libraryManager().ConvertImageToLocal(options.Item, originalImage, options.ImageIndex).ConfigureAwait(false);
}
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);
}
2015-10-26 05:29:32 +00:00
if (options.CropWhiteSpace && _imageEncoder.SupportsImageEncoding)
2013-02-21 01:33:05 +00:00
{
2015-04-19 19:17:17 +00:00
var tuple = await GetWhitespaceCroppedImage(originalImagePath, dateModified).ConfigureAwait(false);
2013-11-15 16:00:39 +00:00
originalImagePath = tuple.Item1;
dateModified = tuple.Item2;
2013-02-21 01:33:05 +00:00
}
2013-09-19 15:12:28 +00:00
if (options.Enhancers.Count > 0)
2013-02-21 01:33:05 +00:00
{
var tuple = await GetEnhancedImage(new ItemImageInfo
{
DateModified = dateModified,
2015-10-16 17:06:31 +00:00
Type = originalImage.Type,
Path = originalImagePath
}, options.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;
2013-02-21 01:33:05 +00:00
}
2015-11-09 18:18:37 +00:00
if (options.HasDefaultOptions(originalImagePath))
{
// 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
2015-11-09 18:18:37 +00:00
ImageSize? originalImageSize;
try
{
2015-11-09 18:18:37 +00:00
originalImageSize = GetImageSize(originalImagePath, dateModified, true);
if (options.HasDefaultOptions(originalImagePath, originalImageSize.Value))
{
// 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
}
}
catch
{
originalImageSize = null;
}
2015-11-09 18:18:37 +00:00
var newSize = GetNewImageSize(options, originalImageSize);
2015-10-27 14:02:30 +00:00
var quality = options.Quality;
2013-02-21 01:33:05 +00:00
2015-11-09 18:18:37 +00:00
var outputFormat = GetOutputFormat(options.SupportedOutputFormats[0]);
2016-02-24 03:58:25 +00:00
var cacheFilePath = GetCacheFilePath(originalImagePath, newSize, quality, dateModified, outputFormat, options.AddPlayedIndicator, options.PercentPlayed, options.UnplayedCount, options.BackgroundColor, options.ForegroundLayer);
2013-02-21 01:33:05 +00:00
var imageProcessingLockTaken = false;
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
{
var newWidth = Convert.ToInt32(newSize.Width);
var newHeight = Convert.ToInt32(newSize.Height);
2014-03-28 03:32:43 +00:00
2015-09-20 17:56:26 +00:00
_fileSystem.CreateDirectory(Path.GetDirectoryName(cacheFilePath));
2016-07-23 05:03:16 +00:00
var tmpPath = Path.ChangeExtension(Path.Combine(_appPaths.TempDirectory, Guid.NewGuid().ToString("N")), Path.GetExtension(cacheFilePath));
2016-07-17 16:59:40 +00:00
_fileSystem.CreateDirectory(Path.GetDirectoryName(tmpPath));
await _imageProcessingSemaphore.WaitAsync().ConfigureAwait(false);
imageProcessingLockTaken = true;
2016-07-17 16:59:40 +00:00
_imageEncoder.EncodeImage(originalImagePath, tmpPath, AutoOrient(options.Item), newWidth, newHeight, quality, options, outputFormat);
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
}
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
}
2014-03-28 03:32:43 +00:00
finally
2013-04-03 02:59:27 +00:00
{
if (imageProcessingLockTaken)
{
_imageProcessingSemaphore.Release();
}
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 bool AutoOrient(IHasImages item)
2016-01-21 08:23:02 +00:00
{
var photo = item as Photo;
if (photo != null && photo.Orientation.HasValue)
{
2016-01-21 16:53:03 +00:00
return true;
2016-01-21 08:23:02 +00:00
}
2016-01-21 16:53:03 +00:00
return false;
2016-01-21 08:23:02 +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
2015-11-09 18:18:37 +00:00
private ImageSize GetNewImageSize(ImageProcessingOptions options, ImageSize? originalImageSize)
{
if (originalImageSize.HasValue)
2015-10-28 02:30:19 +00:00
{
2015-11-09 18:18:37 +00:00
// Determine the output size based on incoming parameters
var newSize = DrawingUtils.Resize(originalImageSize.Value, options.Width, options.Height, options.MaxWidth, options.MaxHeight);
return newSize;
2015-10-28 02:30:19 +00:00
}
2015-11-09 18:18:37 +00:00
return GetSizeEstimate(options);
2015-10-28 02:30:19 +00:00
}
2015-11-09 18:18:37 +00:00
private ImageSize GetSizeEstimate(ImageProcessingOptions options)
2015-10-28 02:30:19 +00:00
{
if (options.Width.HasValue && options.Height.HasValue)
{
return new ImageSize(options.Width.Value, options.Height.Value);
}
var aspect = GetEstimatedAspectRatio(options.Image.Type);
var width = options.Width ?? options.MaxWidth;
if (width.HasValue)
{
var heightValue = aspect / width.Value;
return new ImageSize(width.Value, Convert.ToInt32(heightValue));
}
var height = options.Height ?? options.MaxHeight ?? 200;
var widthValue = aspect * height;
return new ImageSize(Convert.ToInt32(widthValue), height);
}
private double GetEstimatedAspectRatio(ImageType type)
{
switch (type)
{
case ImageType.Art:
case ImageType.Backdrop:
case ImageType.Chapter:
case ImageType.Screenshot:
case ImageType.Thumb:
return 1.78;
case ImageType.Banner:
return 5.4;
case ImageType.Box:
case ImageType.BoxRear:
case ImageType.Disc:
case ImageType.Menu:
return 1;
case ImageType.Logo:
return 2.58;
case ImageType.Primary:
return .667;
default:
return 1;
}
}
2015-03-17 16:47:56 +00:00
private ImageFormat GetOutputFormat(ImageFormat requestedFormat)
2014-10-27 03:06:01 +00:00
{
2015-04-08 14:38:02 +00:00
if (requestedFormat == ImageFormat.Webp && !_imageEncoder.SupportedOutputFormats.Contains(ImageFormat.Webp))
2014-10-27 03:06:01 +00:00
{
2015-03-17 16:47:56 +00:00
return ImageFormat.Png;
2013-09-21 15:06:00 +00:00
}
2015-03-17 16:47:56 +00:00
return requestedFormat;
2013-09-21 15:06:00 +00:00
}
2013-09-18 18:49:06 +00:00
/// <summary>
/// Crops whitespace from an image, caches the result, and returns the cached path
/// </summary>
2015-04-19 19:17:17 +00:00
private async Task<Tuple<string, DateTime>> GetWhitespaceCroppedImage(string originalImagePath, DateTime dateModified)
2013-09-18 18:49:06 +00:00
{
var name = originalImagePath;
name += "datemodified=" + dateModified.Ticks;
2013-12-15 01:17:57 +00:00
var croppedImagePath = GetCachePath(CroppedWhitespaceImageCachePath, name, Path.GetExtension(originalImagePath));
2013-09-18 18:49:06 +00:00
// Check again in case of contention
2015-09-20 17:56:26 +00:00
if (_fileSystem.FileExists(croppedImagePath))
2013-09-18 18:49:06 +00:00
{
return GetResult(croppedImagePath);
2013-09-18 18:49:06 +00:00
}
var imageProcessingLockTaken = false;
2013-09-18 18:49:06 +00:00
try
{
2015-09-20 17:56:26 +00:00
_fileSystem.CreateDirectory(Path.GetDirectoryName(croppedImagePath));
2016-07-23 05:03:16 +00:00
var tmpPath = Path.ChangeExtension(Path.Combine(_appPaths.TempDirectory, Guid.NewGuid().ToString("N")), Path.GetExtension(croppedImagePath));
2016-07-17 16:59:40 +00:00
_fileSystem.CreateDirectory(Path.GetDirectoryName(tmpPath));
2015-03-06 17:50:14 +00:00
await _imageProcessingSemaphore.WaitAsync().ConfigureAwait(false);
imageProcessingLockTaken = true;
2016-07-17 16:59:40 +00:00
_imageEncoder.CropWhiteSpace(originalImagePath, tmpPath);
CopyFile(tmpPath, croppedImagePath);
return GetResult(tmpPath);
2013-09-18 18:49:06 +00:00
}
2015-10-26 05:29:32 +00:00
catch (NotImplementedException)
{
// No need to spam the log with an error message
return new Tuple<string, DateTime>(originalImagePath, dateModified);
}
2013-09-18 18:49:06 +00:00
catch (Exception ex)
{
// We have to have a catch-all here because some of the .net image methods throw a plain old Exception
_logger.ErrorException("Error cropping image {0}", ex, originalImagePath);
2015-04-19 19:17:17 +00:00
return new Tuple<string, DateTime>(originalImagePath, dateModified);
2013-09-18 18:49:06 +00:00
}
finally
{
if (imageProcessingLockTaken)
{
_imageProcessingSemaphore.Release();
}
2013-09-18 18:49:06 +00:00
}
}
2015-04-19 19:17:17 +00:00
private Tuple<string, DateTime> GetResult(string path)
{
2015-04-19 19:17:17 +00:00
return new Tuple<string, DateTime>(path, _fileSystem.GetLastWriteTimeUtc(path));
2013-09-18 18:49:06 +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-02-23 19:48:58 +00:00
private string GetCacheFilePath(string originalPath, ImageSize outputSize, int quality, DateTime dateModified, ImageFormat format, bool addPlayedIndicator, double percentPlayed, int? unwatchedCount, 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
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
}
2015-02-28 13:42:47 +00:00
public ImageSize GetImageSize(ItemImageInfo info)
{
2015-08-02 23:56:21 +00:00
return GetImageSize(info.Path, info.DateModified, false);
2015-02-28 13:42:47 +00:00
}
2015-10-16 19:25:19 +00:00
public ImageSize GetImageSize(string path)
{
return GetImageSize(path, _fileSystem.GetLastWriteTimeUtc(path), false);
}
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>
2013-09-18 18:49:06 +00:00
/// <param name="path">The path.</param>
/// <param name="imageDateModified">The image date modified.</param>
2015-08-02 23:56:21 +00:00
/// <param name="allowSlowMethod">if set to <c>true</c> [allow slow method].</param>
2013-09-18 18:49:06 +00:00
/// <returns>ImageSize.</returns>
/// <exception cref="System.ArgumentNullException">path</exception>
2015-08-02 23:56:21 +00:00
private ImageSize GetImageSize(string path, DateTime imageDateModified, 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
}
2013-09-18 18:49:06 +00:00
var name = path + "datemodified=" + imageDateModified.Ticks;
2013-02-21 01:33:05 +00:00
ImageSize size;
var cacheHash = name.GetMD5();
if (!_cachedImagedSizes.TryGetValue(cacheHash, out size))
{
2015-08-02 23:56:21 +00:00
size = GetImageSizeInternal(path, allowSlowMethod);
2015-10-26 16:40:35 +00:00
if (size.Width > 0 && size.Height > 0)
{
StartSaveImageSizeTimer();
_cachedImagedSizes.AddOrUpdate(cacheHash, size, (keyName, oldValue) => size);
}
}
return size;
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
{
2015-09-15 04:31:12 +00:00
try
2015-08-02 23:56:21 +00:00
{
2016-10-31 07:47:34 +00:00
using (var file = TagLib.File.Create(new StreamFileAbstraction(Path.GetFileName(path), _fileSystem.OpenRead(path), null)))
2015-09-20 17:22:34 +00:00
{
2015-09-20 17:56:26 +00:00
var image = file as TagLib.Image.File;
2015-09-20 17:22:34 +00:00
2015-09-20 17:56:26 +00:00
var properties = image.Properties;
2015-09-20 17:22:34 +00:00
2015-09-20 17:56:26 +00:00
return new ImageSize
{
Height = properties.PhotoHeight,
Width = properties.PhotoWidth
};
}
}
catch
{
2015-08-02 23:56:21 +00:00
}
2015-09-15 04:31:12 +00:00
2015-09-20 17:56:26 +00:00
return ImageHeader.GetDimensions(path, _logger, _fileSystem);
}
2013-06-04 02:02:49 +00:00
2016-11-11 17:33:10 +00:00
private readonly ITimer _saveImageSizeTimer;
private const int SaveImageSizeTimeout = 5000;
private readonly object _saveImageSizeLock = new object();
private void StartSaveImageSizeTimer()
{
_saveImageSizeTimer.Change(SaveImageSizeTimeout, Timeout.Infinite);
}
2013-02-21 01:33:05 +00:00
private void SaveImageSizeCallback(object state)
{
lock (_saveImageSizeLock)
2013-06-04 02:02:49 +00:00
{
2013-09-17 02:44:06 +00:00
try
{
var path = ImageSizeFile;
2015-09-20 17:56:26 +00:00
_fileSystem.CreateDirectory(Path.GetDirectoryName(path));
_jsonSerializer.SerializeToFile(_cachedImagedSizes, path);
2013-09-17 02:44:06 +00:00
}
catch (Exception ex)
2013-09-17 02:44:06 +00:00
{
_logger.ErrorException("Error saving image size file", ex);
2013-09-17 02:44:06 +00:00
}
}
}
2013-02-21 01:33:05 +00:00
private string ImageSizeFile
{
get
{
return Path.Combine(_appPaths.DataPath, "imagesizes.json");
}
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>
2014-05-08 20:09:53 +00:00
public string GetImageCacheTag(IHasImages 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
2014-06-18 15:12:20 +00:00
return GetImageCacheTag(item, image, supportedEnhancers.ToList());
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>
2014-06-18 15:12:20 +00:00
public string GetImageCacheTag(IHasImages 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
2014-05-08 20:09:53 +00:00
return string.Join("|", cacheKeys.ToArray()).GetMD5().ToString("N");
2013-03-18 20:40:15 +00: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>
2013-12-19 21:51:32 +00:00
public async Task<string> GetEnhancedImage(IHasImages item, ImageType imageType, int imageIndex)
{
var enhancers = GetSupportedEnhancers(item, imageType).ToList();
2014-02-07 20:30:41 +00:00
var imageInfo = item.GetImageInfo(imageType, imageIndex);
2014-06-18 15:12:20 +00:00
var result = await GetEnhancedImage(imageInfo, item, imageIndex, enhancers);
return result.Item1;
}
2015-04-19 19:17:17 +00:00
private async Task<Tuple<string, DateTime>> GetEnhancedImage(ItemImageInfo image,
2014-10-27 03:06:01 +00:00
IHasImages 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
2014-06-18 15:12:20 +00:00
var ehnancedImagePath = await GetEnhancedImageInternal(originalImagePath, item, imageType, imageIndex, enhancers, cacheGuid).ConfigureAwait(false);
2013-06-04 16:53:36 +00:00
2013-09-19 15:12:28 +00:00
// If the path changed update dateModified
if (!ehnancedImagePath.Equals(originalImagePath, StringComparison.OrdinalIgnoreCase))
2013-06-04 16:53:36 +00:00
{
return GetResult(ehnancedImagePath);
2013-06-04 16:53:36 +00:00
}
2013-09-19 15:12:28 +00:00
}
catch (Exception ex)
{
_logger.Error("Error enhancing image", ex);
}
2013-06-04 16:53:36 +00:00
2015-04-19 19:17:17 +00:00
return new Tuple<string, DateTime>(originalImagePath, dateModified);
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>
2014-10-27 03:06:01 +00:00
private async Task<string> GetEnhancedImageInternal(string originalImagePath,
IHasImages item,
ImageType imageType,
int imageIndex,
2014-06-18 15:12:20 +00:00
IEnumerable<IImageEnhancer> supportedEnhancers,
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");
}
// All enhanced images are saved as png to allow transparency
2013-12-15 01:17:57 +00:00
var enhancedImagePath = GetCachePath(EnhancedImageCachePath, cacheGuid + ".png");
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
{
return enhancedImagePath;
}
2016-10-31 04:28:23 +00:00
_fileSystem.CreateDirectory(Path.GetDirectoryName(enhancedImagePath));
2016-10-31 04:28:23 +00:00
var tmpPath = Path.Combine(_appPaths.TempDirectory, Path.ChangeExtension(Guid.NewGuid().ToString(), Path.GetExtension(enhancedImagePath)));
_fileSystem.CreateDirectory(Path.GetDirectoryName(tmpPath));
2016-10-31 04:28:23 +00:00
await _imageProcessingSemaphore.WaitAsync().ConfigureAwait(false);
2016-10-31 04:28:23 +00:00
try
{
await ExecuteImageEnhancers(supportedEnhancers, originalImagePath, tmpPath, item, imageType, imageIndex).ConfigureAwait(false);
2016-10-31 04:28:23 +00:00
try
{
2016-11-11 17:33:10 +00:00
_fileSystem.CopyFile(tmpPath, enhancedImagePath, true);
2016-10-31 04:28:23 +00:00
}
catch
{
}
2013-02-21 01:33:05 +00:00
}
2013-04-03 02:59:27 +00:00
finally
{
2016-10-31 04:28:23 +00:00
_imageProcessingSemaphore.Release();
2013-04-03 02:59:27 +00:00
}
2013-02-21 01:33:05 +00:00
2016-10-31 04:28:23 +00:00
return tmpPath;
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>
private async Task ExecuteImageEnhancers(IEnumerable<IImageEnhancer> imageEnhancers, string inputPath, string outputPath, IHasImages 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);
}
public async Task CreateImageCollage(ImageCollageOptions options)
2015-04-08 14:38:02 +00:00
{
await _imageProcessingSemaphore.WaitAsync().ConfigureAwait(false);
try
{
2015-10-04 22:04:56 +00:00
_logger.Info("Creating image collage and saving to {0}", options.OutputPath);
2015-05-11 16:32:15 +00:00
_imageEncoder.CreateImageCollage(options);
2015-05-11 16:32:15 +00:00
2015-10-04 22:04:56 +00:00
_logger.Info("Completed creation of image collage and saved to {0}", options.OutputPath);
}
finally
{
_imageProcessingSemaphore.Release();
}
2015-04-08 14:38:02 +00:00
}
2013-12-19 21:51:32 +00:00
public IEnumerable<IImageEnhancer> GetSupportedEnhancers(IHasImages item, ImageType imageType)
2013-09-18 18:49:06 +00:00
{
return ImageEnhancers.Where(i =>
{
try
{
2013-11-08 21:22:02 +00:00
return i.Supports(item, imageType);
2013-09-18 18:49:06 +00:00
}
catch (Exception ex)
{
_logger.ErrorException("Error in image enhancer: {0}", ex, i.GetType().Name);
return false;
}
2013-11-08 21:22:02 +00:00
});
2013-04-03 02:59:27 +00:00
}
private bool _disposed;
public void Dispose()
{
_disposed = true;
2015-04-08 14:38:02 +00:00
_imageEncoder.Dispose();
_saveImageSizeTimer.Dispose();
}
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
}