jellyfin/MediaBrowser.Server.Implementations/Drawing/ImageProcessor.cs

910 lines
34 KiB
C#
Raw Normal View History

2013-09-19 15:12:28 +00:00
using MediaBrowser.Common.Extensions;
2013-09-18 18:49:06 +00:00
using MediaBrowser.Common.IO;
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.Drawing;
using System.Drawing.Drawing2D;
using System.Drawing.Imaging;
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;
2013-02-21 01:33:05 +00:00
2013-09-18 18:49:06 +00:00
namespace MediaBrowser.Server.Implementations.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;
2013-09-18 18:49:06 +00:00
private readonly string _croppedWhitespaceImageCachePath;
private readonly string _enhancedImageCachePath;
private readonly string _resizedImageCachePath;
public ImageProcessor(ILogger logger, IServerApplicationPaths appPaths, IFileSystem fileSystem, IJsonSerializer jsonSerializer)
2013-02-21 01:33:05 +00:00
{
2013-02-21 21:39:53 +00:00
_logger = logger;
_fileSystem = fileSystem;
_jsonSerializer = jsonSerializer;
_appPaths = appPaths;
2013-02-21 21:39:53 +00:00
_croppedWhitespaceImageCachePath = Path.Combine(appPaths.ImageCachePath, "cropped-images");
_enhancedImageCachePath = Path.Combine(appPaths.ImageCachePath, "enhanced-images");
_resizedImageCachePath = Path.Combine(appPaths.ImageCachePath, "resized-images");
_saveImageSizeTimer = new Timer(SaveImageSizeCallback, null, Timeout.Infinite, Timeout.Infinite);
Dictionary<Guid, ImageSize> sizeDictionary;
try
{
sizeDictionary = jsonSerializer.DeserializeFromFile<Dictionary<Guid, ImageSize>>(ImageSizeFile);
}
2013-11-12 15:36:25 +00:00
catch (FileNotFoundException)
{
// 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);
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
{
2013-09-19 15:12:28 +00:00
if (options == null)
2013-02-21 01:33:05 +00:00
{
2013-09-19 15:12:28 +00:00
throw new ArgumentNullException("options");
2013-02-21 01:33:05 +00:00
}
if (toStream == null)
{
throw new ArgumentNullException("toStream");
}
2013-09-19 15:12:28 +00:00
var originalImagePath = options.OriginalImagePath;
2013-11-15 16:00:39 +00:00
if (options.HasDefaultOptions() && options.Enhancers.Count == 0 && !options.CropWhiteSpace)
{
// Just spit out the original file if all the options are default
using (var fileStream = _fileSystem.GetFileStream(originalImagePath, FileMode.Open, FileAccess.Read, FileShare.Read, true))
{
await fileStream.CopyToAsync(toStream).ConfigureAwait(false);
return;
}
}
2013-09-19 15:12:28 +00:00
var dateModified = options.OriginalImageDateModified;
if (options.CropWhiteSpace)
2013-02-21 01:33:05 +00:00
{
2013-11-15 16:00:39 +00:00
var tuple = await GetWhitespaceCroppedImage(originalImagePath, dateModified).ConfigureAwait(false);
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
{
2013-09-19 15:12:28 +00:00
var tuple = await GetEnhancedImage(originalImagePath, dateModified, options.Item, options.ImageType, 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
}
2013-09-17 02:44:06 +00:00
var originalImageSize = GetImageSize(originalImagePath, dateModified);
2013-02-21 01:33:05 +00:00
// Determine the output size based on incoming parameters
2013-09-19 15:12:28 +00:00
var newSize = DrawingUtils.Resize(originalImageSize, options.Width, options.Height, options.MaxWidth, options.MaxHeight);
2013-02-21 01:33:05 +00:00
2013-11-15 16:00:39 +00:00
if (options.HasDefaultOptionsWithoutSize() && newSize.Equals(originalImageSize) && options.Enhancers.Count == 0)
{
2013-11-15 16:00:39 +00:00
// Just spit out the original file if the new size equals the old
using (var fileStream = _fileSystem.GetFileStream(originalImagePath, FileMode.Open, FileAccess.Read, FileShare.Read, true))
{
await fileStream.CopyToAsync(toStream).ConfigureAwait(false);
return;
}
}
2013-09-19 15:12:28 +00:00
var quality = options.Quality ?? 90;
2013-02-21 01:33:05 +00:00
var cacheFilePath = GetCacheFilePath(originalImagePath, newSize, quality, dateModified, options.OutputFormat, options.AddPlayedIndicator, options.PercentPlayed, options.BackgroundColor);
2013-02-21 01:33:05 +00:00
2013-06-04 02:02:49 +00:00
try
{
using (var fileStream = _fileSystem.GetFileStream(cacheFilePath, FileMode.Open, FileAccess.Read, FileShare.Read, true))
2013-06-04 02:02:49 +00:00
{
await fileStream.CopyToAsync(toStream).ConfigureAwait(false);
return;
}
}
catch (IOException)
{
// Cache file doesn't exist or is currently being written to
2013-06-04 02:02:49 +00:00
}
2013-04-03 02:59:27 +00:00
var semaphore = GetLock(cacheFilePath);
await semaphore.WaitAsync().ConfigureAwait(false);
// Check again in case of lock contention
try
2013-02-21 01:33:05 +00:00
{
using (var fileStream = _fileSystem.GetFileStream(cacheFilePath, FileMode.Open, FileAccess.Read, FileShare.Read, true))
2013-04-03 02:59:27 +00:00
{
await fileStream.CopyToAsync(toStream).ConfigureAwait(false);
2013-04-03 02:59:27 +00:00
semaphore.Release();
return;
2013-04-03 02:59:27 +00:00
}
2013-02-21 01:33:05 +00:00
}
catch (IOException)
{
// Cache file doesn't exist or is currently being written to
}
catch
{
semaphore.Release();
throw;
}
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
{
using (var fileStream = _fileSystem.GetFileStream(originalImagePath, FileMode.Open, FileAccess.Read, FileShare.Read, true))
2013-02-21 01:33:05 +00:00
{
// Copy to memory stream to avoid Image locking file
using (var memoryStream = new MemoryStream())
2013-04-03 02:59:27 +00:00
{
await fileStream.CopyToAsync(memoryStream).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
2013-06-02 16:45:32 +00:00
using (var originalImage = Image.FromStream(memoryStream, true, false))
{
var newWidth = Convert.ToInt32(newSize.Width);
var newHeight = Convert.ToInt32(newSize.Height);
2013-02-21 01:33:05 +00:00
// Graphics.FromImage will throw an exception if the PixelFormat is Indexed, so we need to handle that here
using (var thumbnail = new Bitmap(newWidth, newHeight, PixelFormat.Format32bppPArgb))
{
// Preserve the original resolution
thumbnail.SetResolution(originalImage.HorizontalResolution, originalImage.VerticalResolution);
2013-02-21 01:33:05 +00:00
using (var thumbnailGraph = Graphics.FromImage(thumbnail))
{
thumbnailGraph.CompositingQuality = CompositingQuality.HighQuality;
thumbnailGraph.SmoothingMode = SmoothingMode.HighQuality;
thumbnailGraph.InterpolationMode = InterpolationMode.HighQualityBicubic;
thumbnailGraph.PixelOffsetMode = PixelOffsetMode.HighQuality;
thumbnailGraph.CompositingMode = string.IsNullOrEmpty(options.BackgroundColor) && !options.PercentPlayed.HasValue && !options.AddPlayedIndicator ? CompositingMode.SourceCopy : CompositingMode.SourceOver;
2013-02-21 01:33:05 +00:00
2013-09-21 15:06:00 +00:00
SetBackgroundColor(thumbnailGraph, options);
thumbnailGraph.DrawImage(originalImage, 0, 0, newWidth, newHeight);
2013-02-21 01:33:05 +00:00
DrawIndicator(thumbnailGraph, newWidth, newHeight, options);
2013-09-19 15:12:28 +00:00
var outputFormat = GetOutputFormat(originalImage, options.OutputFormat);
2013-02-21 01:33:05 +00:00
using (var outputMemoryStream = new MemoryStream())
{
// Save to the memory stream
2013-09-19 15:12:28 +00:00
thumbnail.Save(outputFormat, outputMemoryStream, quality);
2013-02-21 01:33:05 +00:00
var bytes = outputMemoryStream.ToArray();
2013-02-21 01:33:05 +00:00
await toStream.WriteAsync(bytes, 0, bytes.Length).ConfigureAwait(false);
2013-02-21 01:33:05 +00:00
// kick off a task to cache the result
CacheResizedImage(cacheFilePath, bytes, semaphore);
}
}
}
2013-04-03 02:59:27 +00:00
2013-02-21 01:33:05 +00:00
}
}
}
}
catch
2013-04-03 02:59:27 +00:00
{
semaphore.Release();
throw;
2013-04-03 02:59:27 +00:00
}
}
/// <summary>
/// Caches the resized image.
/// </summary>
/// <param name="cacheFilePath">The cache file path.</param>
/// <param name="bytes">The bytes.</param>
/// <param name="semaphore">The semaphore.</param>
private void CacheResizedImage(string cacheFilePath, byte[] bytes, SemaphoreSlim semaphore)
{
Task.Run(async () =>
{
try
{
var parentPath = Path.GetDirectoryName(cacheFilePath);
Directory.CreateDirectory(parentPath);
// Save to the cache location
using (var cacheFileStream = _fileSystem.GetFileStream(cacheFilePath, FileMode.Create, FileAccess.Write, FileShare.Read, true))
{
// Save to the filestream
await cacheFileStream.WriteAsync(bytes, 0, bytes.Length).ConfigureAwait(false);
}
}
catch (Exception ex)
{
_logger.ErrorException("Error writing to image cache file {0}", ex, cacheFilePath);
}
finally
{
semaphore.Release();
}
});
}
2013-09-21 15:06:00 +00:00
/// <summary>
/// Sets the color of the background.
/// </summary>
/// <param name="graphics">The graphics.</param>
/// <param name="options">The options.</param>
private void SetBackgroundColor(Graphics graphics, ImageProcessingOptions options)
{
var color = options.BackgroundColor;
if (!string.IsNullOrEmpty(color))
{
Color drawingColor;
try
{
drawingColor = ColorTranslator.FromHtml(color);
}
catch
{
drawingColor = ColorTranslator.FromHtml("#" + color);
}
2013-09-21 15:06:00 +00:00
graphics.Clear(drawingColor);
}
}
/// <summary>
/// Draws the indicator.
/// </summary>
/// <param name="graphics">The graphics.</param>
/// <param name="imageWidth">Width of the image.</param>
/// <param name="imageHeight">Height of the image.</param>
/// <param name="options">The options.</param>
private void DrawIndicator(Graphics graphics, int imageWidth, int imageHeight, ImageProcessingOptions options)
{
if (!options.AddPlayedIndicator && !options.PercentPlayed.HasValue)
{
return;
}
try
{
var percentOffset = 0;
if (options.AddPlayedIndicator)
{
2013-09-21 15:06:00 +00:00
var currentImageSize = new Size(imageWidth, imageHeight);
2013-09-21 15:06:00 +00:00
new WatchedIndicatorDrawer().Process(graphics, currentImageSize);
percentOffset = 0 - WatchedIndicatorDrawer.IndicatorWidth;
2013-09-21 15:06:00 +00:00
}
if (options.PercentPlayed.HasValue)
2013-09-21 15:06:00 +00:00
{
var currentImageSize = new Size(imageWidth, imageHeight);
new PercentPlayedDrawer().Process(graphics, currentImageSize, options.PercentPlayed.Value, percentOffset);
}
}
catch (Exception ex)
{
_logger.ErrorException("Error drawing indicator overlay", ex);
}
}
2013-09-19 15:12:28 +00:00
/// <summary>
/// Gets the output format.
/// </summary>
/// <param name="image">The image.</param>
/// <param name="outputFormat">The output format.</param>
/// <returns>ImageFormat.</returns>
private ImageFormat GetOutputFormat(Image image, ImageOutputFormat outputFormat)
{
switch (outputFormat)
{
case ImageOutputFormat.Bmp:
return ImageFormat.Bmp;
case ImageOutputFormat.Gif:
return ImageFormat.Gif;
case ImageOutputFormat.Jpg:
return ImageFormat.Jpeg;
case ImageOutputFormat.Png:
return ImageFormat.Png;
default:
return image.RawFormat;
}
}
2013-09-18 18:49:06 +00:00
/// <summary>
/// Crops whitespace from an image, caches the result, and returns the cached path
/// </summary>
/// <param name="originalImagePath">The original image path.</param>
/// <param name="dateModified">The date modified.</param>
/// <returns>System.String.</returns>
2013-11-15 16:00:39 +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;
var croppedImagePath = GetCachePath(_croppedWhitespaceImageCachePath, name, Path.GetExtension(originalImagePath));
var semaphore = GetLock(croppedImagePath);
await semaphore.WaitAsync().ConfigureAwait(false);
// Check again in case of contention
if (File.Exists(croppedImagePath))
{
semaphore.Release();
2013-11-15 16:00:39 +00:00
return new Tuple<string, DateTime>(croppedImagePath, _fileSystem.GetLastWriteTimeUtc(croppedImagePath));
2013-09-18 18:49:06 +00:00
}
try
{
using (var fileStream = _fileSystem.GetFileStream(originalImagePath, FileMode.Open, FileAccess.Read, FileShare.Read, true))
2013-09-18 18:49:06 +00:00
{
// Copy to memory stream to avoid Image locking file
using (var memoryStream = new MemoryStream())
{
await fileStream.CopyToAsync(memoryStream).ConfigureAwait(false);
using (var originalImage = (Bitmap)Image.FromStream(memoryStream, true, false))
{
var outputFormat = originalImage.RawFormat;
using (var croppedImage = originalImage.CropWhitespace())
{
2013-11-15 16:00:39 +00:00
Directory.CreateDirectory(Path.GetDirectoryName(croppedImagePath));
2013-09-18 18:49:06 +00:00
using (var outputStream = _fileSystem.GetFileStream(croppedImagePath, FileMode.Create, FileAccess.Write, FileShare.Read, false))
2013-09-18 18:49:06 +00:00
{
croppedImage.Save(outputFormat, outputStream, 100);
}
}
}
}
}
}
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);
2013-11-15 16:00:39 +00:00
return new Tuple<string, DateTime>(originalImagePath, dateModified);
2013-09-18 18:49:06 +00:00
}
finally
{
semaphore.Release();
}
2013-11-15 16:00:39 +00:00
return new Tuple<string, DateTime>(croppedImagePath, _fileSystem.GetLastWriteTimeUtc(croppedImagePath));
2013-09-18 18:49:06 +00:00
}
2013-02-21 01:33:05 +00:00
/// <summary>
/// Gets the cache file path based on a set of parameters
/// </summary>
private string GetCacheFilePath(string originalPath, ImageSize outputSize, int quality, DateTime dateModified, ImageOutputFormat format, bool addPlayedIndicator, int? percentPlayed, string backgroundColor)
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;
2013-09-19 15:12:28 +00:00
if (format != ImageOutputFormat.Original)
{
2013-09-21 15:06:00 +00:00
filename += "f=" + format;
2013-09-19 15:12:28 +00:00
}
if (addPlayedIndicator)
{
filename += "pl=true";
}
if (percentPlayed.HasValue)
{
filename += "p=" + percentPlayed.Value;
2013-09-21 15:06:00 +00:00
}
if (!string.IsNullOrEmpty(backgroundColor))
{
filename += "b=" + backgroundColor;
}
2013-09-18 18:49:06 +00:00
return GetCachePath(_resizedImageCachePath, filename, Path.GetExtension(originalPath));
2013-02-21 01:33:05 +00:00
}
2013-09-18 18:49:06 +00:00
/// <summary>
/// Gets the size of the image.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>ImageSize.</returns>
public ImageSize GetImageSize(string path)
{
return GetImageSize(path, File.GetLastWriteTimeUtc(path));
}
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>
/// <returns>ImageSize.</returns>
/// <exception cref="System.ArgumentNullException">path</exception>
public ImageSize GetImageSize(string path, DateTime imageDateModified)
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))
{
size = GetImageSizeInternal(path);
_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>
2013-02-21 01:33:05 +00:00
/// <returns>ImageSize.</returns>
private ImageSize GetImageSizeInternal(string path)
2013-02-21 01:33:05 +00:00
{
var size = ImageHeader.GetDimensions(path, _logger, _fileSystem);
2013-02-21 01:33:05 +00:00
StartSaveImageSizeTimer();
2013-06-04 02:02:49 +00:00
return new ImageSize { Width = size.Width, Height = size.Height };
}
2013-06-04 02:02:49 +00:00
private readonly Timer _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;
Directory.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>
/// <param name="imageType">Type of the image.</param>
2013-09-18 18:49:06 +00:00
/// <param name="imagePath">The image path.</param>
/// <returns>Guid.</returns>
2013-02-21 01:33:05 +00:00
/// <exception cref="System.ArgumentNullException">item</exception>
2013-09-18 18:49:06 +00:00
public Guid GetImageCacheTag(BaseItem item, ImageType imageType, string imagePath)
2013-02-21 01:33:05 +00:00
{
if (item == null)
{
throw new ArgumentNullException("item");
}
2013-09-18 18:49:06 +00:00
if (string.IsNullOrEmpty(imagePath))
2013-02-21 01:33:05 +00:00
{
2013-09-18 18:49:06 +00:00
throw new ArgumentNullException("imagePath");
2013-02-21 01:33:05 +00:00
}
2013-09-18 18:49:06 +00:00
var dateModified = item.GetImageDateModified(imagePath);
2013-02-21 01:33:05 +00:00
2013-09-19 15:12:28 +00:00
var supportedEnhancers = GetSupportedEnhancers(item, imageType);
2013-04-03 02:59:27 +00:00
2013-11-08 21:22:02 +00:00
return GetImageCacheTag(item, imageType, imagePath, dateModified, 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>
/// <param name="imageType">Type of the image.</param>
2013-09-18 18:49:06 +00:00
/// <param name="originalImagePath">The original image path.</param>
/// <param name="dateModified">The date modified of the original image file.</param>
/// <param name="imageEnhancers">The image enhancers.</param>
/// <returns>Guid.</returns>
2013-02-21 01:33:05 +00:00
/// <exception cref="System.ArgumentNullException">item</exception>
2013-11-08 21:22:02 +00:00
public Guid GetImageCacheTag(BaseItem item, ImageType imageType, string originalImagePath, DateTime dateModified, 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
2013-09-18 18:49:06 +00:00
if (string.IsNullOrEmpty(originalImagePath))
2013-02-21 01:33:05 +00:00
{
2013-09-18 18:49:06 +00:00
throw new ArgumentNullException("originalImagePath");
2013-02-21 01:33:05 +00:00
}
2013-03-18 20:40:15 +00:00
2013-11-08 21:22:02 +00:00
// Optimization
if (imageEnhancers.Count == 0)
{
return (originalImagePath + dateModified.Ticks).GetMD5();
}
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();
cacheKeys.Add(originalImagePath + dateModified.Ticks);
2013-04-03 02:59:27 +00:00
2013-09-18 18:49:06 +00:00
return string.Join("|", cacheKeys.ToArray()).GetMD5();
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>
public async Task<string> GetEnhancedImage(BaseItem item, ImageType imageType, int imageIndex)
{
var enhancers = GetSupportedEnhancers(item, imageType).ToList();
var imagePath = item.GetImagePath(imageType, imageIndex);
var dateModified = item.GetImageDateModified(imagePath);
var result = await GetEnhancedImage(imagePath, dateModified, item, imageType, imageIndex, enhancers);
return result.Item1;
}
private async Task<Tuple<string, DateTime>> GetEnhancedImage(string originalImagePath, DateTime dateModified, BaseItem item,
2013-09-19 15:12:28 +00:00
ImageType imageType, int imageIndex,
List<IImageEnhancer> enhancers)
2013-06-04 16:53:36 +00:00
{
2013-09-19 15:12:28 +00:00
try
2013-06-04 16:53:36 +00:00
{
2013-09-19 15:12:28 +00:00
// Enhance if we have enhancers
var ehnancedImagePath = await GetEnhancedImageInternal(originalImagePath, dateModified, item, imageType, imageIndex, enhancers).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
{
2013-11-15 16:00:39 +00:00
dateModified = _fileSystem.GetLastWriteTimeUtc(ehnancedImagePath);
2013-06-04 16:53:36 +00:00
2013-09-19 15:12:28 +00:00
return new Tuple<string, DateTime>(ehnancedImagePath, dateModified);
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
2013-09-19 15:12:28 +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>
/// Runs an image through the image enhancers, caches the result, and returns the cached path
/// </summary>
/// <param name="originalImagePath">The original image path.</param>
/// <param name="dateModified">The date modified of the original image file.</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>
2013-02-21 01:33:05 +00:00
/// <returns>System.String.</returns>
/// <exception cref="System.ArgumentNullException">originalImagePath</exception>
2013-09-19 15:12:28 +00:00
private async Task<string> GetEnhancedImageInternal(string originalImagePath, DateTime dateModified, BaseItem item, ImageType imageType, int imageIndex, List<IImageEnhancer> supportedEnhancers)
2013-02-21 01:33:05 +00:00
{
if (string.IsNullOrEmpty(originalImagePath))
{
throw new ArgumentNullException("originalImagePath");
}
if (item == null)
{
throw new ArgumentNullException("item");
}
2013-09-18 18:49:06 +00:00
var cacheGuid = GetImageCacheTag(item, imageType, originalImagePath, dateModified, supportedEnhancers);
2013-02-21 01:33:05 +00:00
// All enhanced images are saved as png to allow transparency
2013-09-18 18:49:06 +00:00
var enhancedImagePath = GetCachePath(_enhancedImageCachePath, cacheGuid + ".png");
2013-02-21 01:33:05 +00:00
2013-04-03 02:59:27 +00:00
var semaphore = GetLock(enhancedImagePath);
await semaphore.WaitAsync().ConfigureAwait(false);
// Check again in case of contention
2013-06-04 02:02:49 +00:00
if (File.Exists(enhancedImagePath))
2013-04-03 02:59:27 +00:00
{
semaphore.Release();
return enhancedImagePath;
}
try
2013-02-21 01:33:05 +00:00
{
using (var fileStream = _fileSystem.GetFileStream(originalImagePath, FileMode.Open, FileAccess.Read, FileShare.Read, true))
2013-02-21 01:33:05 +00:00
{
// Copy to memory stream to avoid Image locking file
using (var memoryStream = new MemoryStream())
2013-02-21 01:33:05 +00:00
{
await fileStream.CopyToAsync(memoryStream).ConfigureAwait(false);
using (var originalImage = Image.FromStream(memoryStream, true, false))
2013-02-21 01:33:05 +00:00
{
//Pass the image through registered enhancers
using (var newImage = await ExecuteImageEnhancers(supportedEnhancers, originalImage, item, imageType, imageIndex).ConfigureAwait(false))
2013-04-03 02:59:27 +00:00
{
2013-06-04 02:02:49 +00:00
var parentDirectory = Path.GetDirectoryName(enhancedImagePath);
Directory.CreateDirectory(parentDirectory);
2013-06-04 02:02:49 +00:00
//And then save it in the cache
using (var outputStream = _fileSystem.GetFileStream(enhancedImagePath, FileMode.Create, FileAccess.Write, FileShare.Read, false))
{
newImage.Save(ImageFormat.Png, outputStream, 100);
}
2013-04-03 02:59:27 +00:00
}
2013-02-21 01:33:05 +00:00
}
}
}
}
2013-04-03 02:59:27 +00:00
finally
{
semaphore.Release();
}
2013-02-21 01:33:05 +00:00
return enhancedImagePath;
}
/// <summary>
/// Executes the image enhancers.
/// </summary>
/// <param name="imageEnhancers">The image enhancers.</param>
/// <param name="originalImage">The original image.</param>
/// <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>
2013-02-23 00:44:20 +00:00
private async Task<Image> ExecuteImageEnhancers(IEnumerable<IImageEnhancer> imageEnhancers, Image originalImage, BaseItem item, ImageType imageType, int imageIndex)
2013-02-21 01:33:05 +00:00
{
var result = originalImage;
// Run the enhancers sequentially in order of priority
foreach (var enhancer in imageEnhancers)
{
var typeName = enhancer.GetType().Name;
try
{
result = await enhancer.EnhanceImageAsync(item, result, imageType, imageIndex).ConfigureAwait(false);
}
catch (Exception ex)
{
_logger.ErrorException("{0} failed enhancing {1}", ex, typeName, item.Name);
throw;
}
2013-02-21 01:33:05 +00:00
}
return result;
}
2013-09-17 02:44:06 +00:00
/// <summary>
/// The _semaphoreLocks
/// </summary>
2013-09-18 18:49:06 +00:00
private readonly ConcurrentDictionary<string, object> _locks = new ConcurrentDictionary<string, object>();
2013-09-17 02:44:06 +00:00
2013-04-03 02:59:27 +00:00
/// <summary>
/// Gets the lock.
/// </summary>
/// <param name="filename">The filename.</param>
/// <returns>System.Object.</returns>
2013-09-18 18:49:06 +00:00
private object GetObjectLock(string filename)
2013-04-03 02:59:27 +00:00
{
2013-09-18 18:49:06 +00:00
return _locks.GetOrAdd(filename, key => new object());
2013-09-17 02:44:06 +00:00
}
/// <summary>
/// The _semaphoreLocks
/// </summary>
2013-09-18 18:49:06 +00:00
private readonly ConcurrentDictionary<string, SemaphoreSlim> _semaphoreLocks = new ConcurrentDictionary<string, SemaphoreSlim>();
2013-09-17 02:44:06 +00:00
/// <summary>
/// Gets the lock.
/// </summary>
/// <param name="filename">The filename.</param>
/// <returns>System.Object.</returns>
2013-09-18 18:49:06 +00:00
private SemaphoreSlim GetLock(string filename)
2013-09-17 02:44:06 +00:00
{
2013-09-18 18:49:06 +00:00
return _semaphoreLocks.GetOrAdd(filename, key => new SemaphoreSlim(1, 1));
}
/// <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 IEnumerable<IImageEnhancer> GetSupportedEnhancers(BaseItem item, ImageType imageType)
{
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
}
public void Dispose()
{
_saveImageSizeTimer.Dispose();
}
2013-02-21 01:33:05 +00:00
}
}