using MediaBrowser.Common.Extensions; using MediaBrowser.Common.IO; using MediaBrowser.Controller; using MediaBrowser.Controller.Drawing; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Providers; using MediaBrowser.Model.Drawing; using MediaBrowser.Model.Entities; using MediaBrowser.Model.Logging; using MediaBrowser.Model.Serialization; using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.Globalization; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; using CommonIO; using Emby.Drawing.Common; using MediaBrowser.Controller.Library; namespace Emby.Drawing { /// /// Class ImageProcessor /// public class ImageProcessor : IImageProcessor, IDisposable { /// /// The us culture /// protected readonly CultureInfo UsCulture = new CultureInfo("en-US"); /// /// The _cached imaged sizes /// private readonly ConcurrentDictionary _cachedImagedSizes; /// /// Gets the list of currently registered image processors /// Image processors are specialized metadata providers that run after the normal ones /// /// The image enhancers. public IEnumerable ImageEnhancers { get; private set; } /// /// The _logger /// private readonly ILogger _logger; private readonly IFileSystem _fileSystem; private readonly IJsonSerializer _jsonSerializer; private readonly IServerApplicationPaths _appPaths; private readonly IImageEncoder _imageEncoder; private readonly SemaphoreSlim _imageProcessingSemaphore; private readonly Func _libraryManager; public ImageProcessor(ILogger logger, IServerApplicationPaths appPaths, IFileSystem fileSystem, IJsonSerializer jsonSerializer, IImageEncoder imageEncoder, int maxConcurrentImageProcesses, Func libraryManager) { _logger = logger; _fileSystem = fileSystem; _jsonSerializer = jsonSerializer; _imageEncoder = imageEncoder; _libraryManager = libraryManager; _appPaths = appPaths; ImageEnhancers = new List(); _saveImageSizeTimer = new Timer(SaveImageSizeCallback, null, Timeout.Infinite, Timeout.Infinite); Dictionary sizeDictionary; try { sizeDictionary = jsonSerializer.DeserializeFromFile>(ImageSizeFile) ?? new Dictionary(); } catch (FileNotFoundException) { // No biggie sizeDictionary = new Dictionary(); } catch (DirectoryNotFoundException) { // No biggie sizeDictionary = new Dictionary(); } catch (Exception ex) { logger.ErrorException("Error parsing image size cache file", ex); sizeDictionary = new Dictionary(); } _cachedImagedSizes = new ConcurrentDictionary(sizeDictionary); _logger.Info("ImageProcessor started with {0} max concurrent image processes", maxConcurrentImageProcesses); _imageProcessingSemaphore = new SemaphoreSlim(maxConcurrentImageProcesses, maxConcurrentImageProcesses); } public string[] SupportedInputFormats { get { return _imageEncoder.SupportedInputFormats; } } 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"); } } public void AddParts(IEnumerable enhancers) { ImageEnhancers = enhancers.ToArray(); } public async Task ProcessImage(ImageProcessingOptions options, Stream toStream) { var file = await ProcessImage(options).ConfigureAwait(false); using (var fileStream = _fileSystem.GetFileStream(file, FileMode.Open, FileAccess.Read, FileShare.Read, true)) { await fileStream.CopyToAsync(toStream).ConfigureAwait(false); } } public ImageFormat[] GetSupportedImageOutputFormats() { return _imageEncoder.SupportedOutputFormats; } public async Task ProcessImage(ImageProcessingOptions options) { if (options == null) { throw new ArgumentNullException("options"); } var originalImage = options.Image; if (!originalImage.IsLocalFile) { originalImage = await _libraryManager().ConvertImageToLocal(options.Item, originalImage, options.ImageIndex).ConfigureAwait(false); } var originalImagePath = originalImage.Path; if (options.HasDefaultOptions(originalImagePath) && options.Enhancers.Count == 0 && !options.CropWhiteSpace) { // Just spit out the original file if all the options are default return originalImagePath; } var dateModified = originalImage.DateModified; if (options.CropWhiteSpace) { var tuple = await GetWhitespaceCroppedImage(originalImagePath, dateModified).ConfigureAwait(false); originalImagePath = tuple.Item1; dateModified = tuple.Item2; } if (options.Enhancers.Count > 0) { var tuple = await GetEnhancedImage(new ItemImageInfo { DateModified = dateModified, Type = originalImage.Type, Path = originalImagePath }, options.Item, options.ImageIndex, options.Enhancers).ConfigureAwait(false); originalImagePath = tuple.Item1; dateModified = tuple.Item2; } var originalImageSize = GetImageSize(originalImagePath, dateModified, true); // Determine the output size based on incoming parameters var newSize = DrawingUtils.Resize(originalImageSize, options.Width, options.Height, options.MaxWidth, options.MaxHeight); if (options.HasDefaultOptionsWithoutSize(originalImagePath) && newSize.Equals(originalImageSize) && options.Enhancers.Count == 0) { // Just spit out the original file if the new size equals the old return originalImagePath; } var quality = options.Quality ?? 90; var outputFormat = GetOutputFormat(options.OutputFormat); var cacheFilePath = GetCacheFilePath(originalImagePath, newSize, quality, dateModified, outputFormat, options.AddPlayedIndicator, options.PercentPlayed, options.UnplayedCount, options.BackgroundColor); var semaphore = GetLock(cacheFilePath); await semaphore.WaitAsync().ConfigureAwait(false); var imageProcessingLockTaken = false; try { CheckDisposed(); if (!_fileSystem.FileExists(cacheFilePath)) { var newWidth = Convert.ToInt32(newSize.Width); var newHeight = Convert.ToInt32(newSize.Height); _fileSystem.CreateDirectory(Path.GetDirectoryName(cacheFilePath)); await _imageProcessingSemaphore.WaitAsync().ConfigureAwait(false); imageProcessingLockTaken = true; _imageEncoder.EncodeImage(originalImagePath, cacheFilePath, newWidth, newHeight, quality, options); // ImageMagick doesn't seem to always release it right away await Task.Delay(300).ConfigureAwait(false); } } finally { if (imageProcessingLockTaken) { _imageProcessingSemaphore.Release(); } semaphore.Release(); } return cacheFilePath; } private ImageFormat GetOutputFormat(ImageFormat requestedFormat) { if (requestedFormat == ImageFormat.Webp && !_imageEncoder.SupportedOutputFormats.Contains(ImageFormat.Webp)) { return ImageFormat.Png; } return requestedFormat; } /// /// Crops whitespace from an image, caches the result, and returns the cached path /// private async Task> GetWhitespaceCroppedImage(string originalImagePath, DateTime dateModified) { 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 (_fileSystem.FileExists(croppedImagePath)) { semaphore.Release(); return GetResult(croppedImagePath); } var imageProcessingLockTaken = false; try { _fileSystem.CreateDirectory(Path.GetDirectoryName(croppedImagePath)); await _imageProcessingSemaphore.WaitAsync().ConfigureAwait(false); imageProcessingLockTaken = true; _imageEncoder.CropWhiteSpace(originalImagePath, croppedImagePath); } 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); return new Tuple(originalImagePath, dateModified); } finally { if (imageProcessingLockTaken) { _imageProcessingSemaphore.Release(); } semaphore.Release(); } return GetResult(croppedImagePath); } private Tuple GetResult(string path) { return new Tuple(path, _fileSystem.GetLastWriteTimeUtc(path)); } /// /// Increment this when there's a change requiring caches to be invalidated /// private const string Version = "3"; /// /// Gets the cache file path based on a set of parameters /// private string GetCacheFilePath(string originalPath, ImageSize outputSize, int quality, DateTime dateModified, ImageFormat format, bool addPlayedIndicator, double percentPlayed, int? unwatchedCount, string backgroundColor) { var filename = originalPath; filename += "width=" + outputSize.Width; filename += "height=" + outputSize.Height; filename += "quality=" + quality; filename += "datemodified=" + dateModified.Ticks; filename += "f=" + format; if (addPlayedIndicator) { filename += "pl=true"; } if (percentPlayed > 0) { filename += "p=" + percentPlayed; } if (unwatchedCount.HasValue) { filename += "p=" + unwatchedCount.Value; } if (!string.IsNullOrEmpty(backgroundColor)) { filename += "b=" + backgroundColor; } filename += "v=" + Version; return GetCachePath(ResizedImageCachePath, filename, "." + format.ToString().ToLower()); } public ImageSize GetImageSize(ItemImageInfo info) { return GetImageSize(info.Path, info.DateModified, false); } public ImageSize GetImageSize(string path) { return GetImageSize(path, _fileSystem.GetLastWriteTimeUtc(path), false); } /// /// Gets the size of the image. /// /// The path. /// The image date modified. /// if set to true [allow slow method]. /// ImageSize. /// path private ImageSize GetImageSize(string path, DateTime imageDateModified, bool allowSlowMethod) { if (string.IsNullOrEmpty(path)) { throw new ArgumentNullException("path"); } var name = path + "datemodified=" + imageDateModified.Ticks; ImageSize size; var cacheHash = name.GetMD5(); if (!_cachedImagedSizes.TryGetValue(cacheHash, out size)) { size = GetImageSizeInternal(path, allowSlowMethod); StartSaveImageSizeTimer(); _cachedImagedSizes.AddOrUpdate(cacheHash, size, (keyName, oldValue) => size); } return size; } /// /// Gets the image size internal. /// /// The path. /// if set to true [allow slow method]. /// ImageSize. private ImageSize GetImageSizeInternal(string path, bool allowSlowMethod) { try { using (var file = TagLib.File.Create(path)) { var image = file as TagLib.Image.File; var properties = image.Properties; return new ImageSize { Height = properties.PhotoHeight, Width = properties.PhotoWidth }; } } catch { } return ImageHeader.GetDimensions(path, _logger, _fileSystem); } private readonly Timer _saveImageSizeTimer; private const int SaveImageSizeTimeout = 5000; private readonly object _saveImageSizeLock = new object(); private void StartSaveImageSizeTimer() { _saveImageSizeTimer.Change(SaveImageSizeTimeout, Timeout.Infinite); } private void SaveImageSizeCallback(object state) { lock (_saveImageSizeLock) { try { var path = ImageSizeFile; _fileSystem.CreateDirectory(Path.GetDirectoryName(path)); _jsonSerializer.SerializeToFile(_cachedImagedSizes, path); } catch (Exception ex) { _logger.ErrorException("Error saving image size file", ex); } } } private string ImageSizeFile { get { return Path.Combine(_appPaths.DataPath, "imagesizes.json"); } } /// /// Gets the image cache tag. /// /// The item. /// The image. /// Guid. /// item public string GetImageCacheTag(IHasImages item, ItemImageInfo image) { if (item == null) { throw new ArgumentNullException("item"); } if (image == null) { throw new ArgumentNullException("image"); } var supportedEnhancers = GetSupportedEnhancers(item, image.Type); return GetImageCacheTag(item, image, supportedEnhancers.ToList()); } /// /// Gets the image cache tag. /// /// The item. /// The image. /// The image enhancers. /// Guid. /// item public string GetImageCacheTag(IHasImages item, ItemImageInfo image, List imageEnhancers) { if (item == null) { throw new ArgumentNullException("item"); } if (imageEnhancers == null) { throw new ArgumentNullException("imageEnhancers"); } if (image == null) { throw new ArgumentNullException("image"); } var originalImagePath = image.Path; var dateModified = image.DateModified; var imageType = image.Type; // Optimization if (imageEnhancers.Count == 0) { return (originalImagePath + dateModified.Ticks).GetMD5().ToString("N"); } // 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); return string.Join("|", cacheKeys.ToArray()).GetMD5().ToString("N"); } /// /// Gets the enhanced image. /// /// The item. /// Type of the image. /// Index of the image. /// Task{System.String}. public async Task GetEnhancedImage(IHasImages item, ImageType imageType, int imageIndex) { var enhancers = GetSupportedEnhancers(item, imageType).ToList(); var imageInfo = item.GetImageInfo(imageType, imageIndex); var result = await GetEnhancedImage(imageInfo, item, imageIndex, enhancers); return result.Item1; } private async Task> GetEnhancedImage(ItemImageInfo image, IHasImages item, int imageIndex, List enhancers) { var originalImagePath = image.Path; var dateModified = image.DateModified; var imageType = image.Type; try { var cacheGuid = GetImageCacheTag(item, image, enhancers); // Enhance if we have enhancers var ehnancedImagePath = await GetEnhancedImageInternal(originalImagePath, item, imageType, imageIndex, enhancers, cacheGuid).ConfigureAwait(false); // If the path changed update dateModified if (!ehnancedImagePath.Equals(originalImagePath, StringComparison.OrdinalIgnoreCase)) { return GetResult(ehnancedImagePath); } } catch (Exception ex) { _logger.Error("Error enhancing image", ex); } return new Tuple(originalImagePath, dateModified); } /// /// Gets the enhanced image internal. /// /// The original image path. /// The item. /// Type of the image. /// Index of the image. /// The supported enhancers. /// The cache unique identifier. /// Task<System.String>. /// /// originalImagePath /// or /// item /// private async Task GetEnhancedImageInternal(string originalImagePath, IHasImages item, ImageType imageType, int imageIndex, IEnumerable supportedEnhancers, string cacheGuid) { 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 var enhancedImagePath = GetCachePath(EnhancedImageCachePath, cacheGuid + ".png"); var semaphore = GetLock(enhancedImagePath); await semaphore.WaitAsync().ConfigureAwait(false); // Check again in case of contention if (_fileSystem.FileExists(enhancedImagePath)) { semaphore.Release(); return enhancedImagePath; } var imageProcessingLockTaken = false; try { _fileSystem.CreateDirectory(Path.GetDirectoryName(enhancedImagePath)); await _imageProcessingSemaphore.WaitAsync().ConfigureAwait(false); imageProcessingLockTaken = true; await ExecuteImageEnhancers(supportedEnhancers, originalImagePath, enhancedImagePath, item, imageType, imageIndex).ConfigureAwait(false); } finally { if (imageProcessingLockTaken) { _imageProcessingSemaphore.Release(); } semaphore.Release(); } return enhancedImagePath; } /// /// Executes the image enhancers. /// /// The image enhancers. /// The input path. /// The output path. /// The item. /// Type of the image. /// Index of the image. /// Task{EnhancedImage}. private async Task ExecuteImageEnhancers(IEnumerable imageEnhancers, string inputPath, string outputPath, IHasImages item, ImageType imageType, int imageIndex) { // Run the enhancers sequentially in order of priority foreach (var enhancer in imageEnhancers) { var typeName = enhancer.GetType().Name; try { await enhancer.EnhanceImageAsync(item, inputPath, outputPath, imageType, imageIndex).ConfigureAwait(false); } catch (Exception ex) { _logger.ErrorException("{0} failed enhancing {1}", ex, typeName, item.Name); throw; } // Feed the output into the next enhancer as input inputPath = outputPath; } } /// /// The _semaphoreLocks /// private readonly ConcurrentDictionary _semaphoreLocks = new ConcurrentDictionary(); /// /// Gets the lock. /// /// The filename. /// System.Object. private SemaphoreSlim GetLock(string filename) { return _semaphoreLocks.GetOrAdd(filename, key => new SemaphoreSlim(1, 1)); } /// /// Gets the cache path. /// /// The path. /// Name of the unique. /// The file extension. /// System.String. /// /// path /// or /// uniqueName /// or /// fileExtension /// 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); } /// /// Gets the cache path. /// /// The path. /// The filename. /// System.String. /// /// path /// or /// filename /// 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) { await _imageProcessingSemaphore.WaitAsync().ConfigureAwait(false); try { _logger.Info("Creating image collage and saving to {0}", options.OutputPath); _imageEncoder.CreateImageCollage(options); _logger.Info("Completed creation of image collage and saved to {0}", options.OutputPath); } finally { _imageProcessingSemaphore.Release(); } } public IEnumerable GetSupportedEnhancers(IHasImages item, ImageType imageType) { return ImageEnhancers.Where(i => { try { return i.Supports(item, imageType); } catch (Exception ex) { _logger.ErrorException("Error in image enhancer: {0}", ex, i.GetType().Name); return false; } }); } private bool _disposed; public void Dispose() { _disposed = true; _imageEncoder.Dispose(); _saveImageSizeTimer.Dispose(); } private void CheckDisposed() { if (_disposed) { throw new ObjectDisposedException(GetType().Name); } } } }