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.Drawing; using System.Drawing.Drawing2D; using System.Drawing.Imaging; using System.Globalization; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; namespace MediaBrowser.Server.Implementations.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; public ImageProcessor(ILogger logger, IServerApplicationPaths appPaths, IFileSystem fileSystem, IJsonSerializer jsonSerializer) { _logger = logger; _fileSystem = fileSystem; _jsonSerializer = jsonSerializer; _appPaths = appPaths; _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 (Exception ex) { logger.ErrorException("Error parsing image size cache file", ex); sizeDictionary = new Dictionary(); } _cachedImagedSizes = new ConcurrentDictionary(sizeDictionary); } 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) { if (options == null) { throw new ArgumentNullException("options"); } if (toStream == null) { throw new ArgumentNullException("toStream"); } var originalImagePath = options.OriginalImagePath; 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; } } var dateModified = options.OriginalImageDateModified; 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(originalImagePath, dateModified, options.Item, options.ImageType, options.ImageIndex, options.Enhancers).ConfigureAwait(false); originalImagePath = tuple.Item1; dateModified = tuple.Item2; } var originalImageSize = GetImageSize(originalImagePath, dateModified); // Determine the output size based on incoming parameters var newSize = DrawingUtils.Resize(originalImageSize, options.Width, options.Height, options.MaxWidth, options.MaxHeight); if (options.HasDefaultOptionsWithoutSize() && newSize.Equals(originalImageSize) && options.Enhancers.Count == 0) { // 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; } } var quality = options.Quality ?? 90; var cacheFilePath = GetCacheFilePath(originalImagePath, newSize, quality, dateModified, options.OutputFormat, options.AddPlayedIndicator, options.PercentPlayed, options.BackgroundColor); try { using (var fileStream = _fileSystem.GetFileStream(cacheFilePath, FileMode.Open, FileAccess.Read, FileShare.Read, true)) { await fileStream.CopyToAsync(toStream).ConfigureAwait(false); return; } } catch (IOException) { // Cache file doesn't exist or is currently being written to } var semaphore = GetLock(cacheFilePath); await semaphore.WaitAsync().ConfigureAwait(false); // Check again in case of lock contention try { using (var fileStream = _fileSystem.GetFileStream(cacheFilePath, FileMode.Open, FileAccess.Read, FileShare.Read, true)) { await fileStream.CopyToAsync(toStream).ConfigureAwait(false); semaphore.Release(); return; } } catch (IOException) { // Cache file doesn't exist or is currently being written to } catch { semaphore.Release(); throw; } try { using (var fileStream = _fileSystem.GetFileStream(originalImagePath, FileMode.Open, FileAccess.Read, FileShare.Read, true)) { // Copy to memory stream to avoid Image locking file using (var memoryStream = new MemoryStream()) { await fileStream.CopyToAsync(memoryStream).ConfigureAwait(false); using (var originalImage = Image.FromStream(memoryStream, true, false)) { var newWidth = Convert.ToInt32(newSize.Width); var newHeight = Convert.ToInt32(newSize.Height); // 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); 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; SetBackgroundColor(thumbnailGraph, options); thumbnailGraph.DrawImage(originalImage, 0, 0, newWidth, newHeight); DrawIndicator(thumbnailGraph, newWidth, newHeight, options); var outputFormat = GetOutputFormat(originalImage, options.OutputFormat); using (var outputMemoryStream = new MemoryStream()) { // Save to the memory stream thumbnail.Save(outputFormat, outputMemoryStream, quality); var bytes = outputMemoryStream.ToArray(); await toStream.WriteAsync(bytes, 0, bytes.Length).ConfigureAwait(false); // kick off a task to cache the result CacheResizedImage(cacheFilePath, bytes, semaphore); } } } } } } } catch { semaphore.Release(); throw; } } /// /// Caches the resized image. /// /// The cache file path. /// The bytes. /// The semaphore. 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(); } }); } /// /// Sets the color of the background. /// /// The graphics. /// The options. 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); } graphics.Clear(drawingColor); } } /// /// Draws the indicator. /// /// The graphics. /// Width of the image. /// Height of the image. /// The options. 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) { var currentImageSize = new Size(imageWidth, imageHeight); new WatchedIndicatorDrawer().Process(graphics, currentImageSize); percentOffset = 0 - WatchedIndicatorDrawer.IndicatorWidth; } if (options.PercentPlayed.HasValue) { 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); } } /// /// Gets the output format. /// /// The image. /// The output format. /// ImageFormat. 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; } } /// /// Crops whitespace from an image, caches the result, and returns the cached path /// /// The original image path. /// The date modified. /// System.String. 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 (File.Exists(croppedImagePath)) { semaphore.Release(); return new Tuple(croppedImagePath, _fileSystem.GetLastWriteTimeUtc(croppedImagePath)); } try { using (var fileStream = _fileSystem.GetFileStream(originalImagePath, FileMode.Open, FileAccess.Read, FileShare.Read, true)) { // 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()) { Directory.CreateDirectory(Path.GetDirectoryName(croppedImagePath)); using (var outputStream = _fileSystem.GetFileStream(croppedImagePath, FileMode.Create, FileAccess.Write, FileShare.Read, false)) { 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); return new Tuple(originalImagePath, dateModified); } finally { semaphore.Release(); } return new Tuple(croppedImagePath, _fileSystem.GetLastWriteTimeUtc(croppedImagePath)); } /// /// Gets the cache file path based on a set of parameters /// private string GetCacheFilePath(string originalPath, ImageSize outputSize, int quality, DateTime dateModified, ImageOutputFormat format, bool addPlayedIndicator, int? percentPlayed, string backgroundColor) { var filename = originalPath; filename += "width=" + outputSize.Width; filename += "height=" + outputSize.Height; filename += "quality=" + quality; filename += "datemodified=" + dateModified.Ticks; if (format != ImageOutputFormat.Original) { filename += "f=" + format; } if (addPlayedIndicator) { filename += "pl=true"; } if (percentPlayed.HasValue) { filename += "p=" + percentPlayed.Value; } if (!string.IsNullOrEmpty(backgroundColor)) { filename += "b=" + backgroundColor; } return GetCachePath(ResizedImageCachePath, filename, Path.GetExtension(originalPath)); } /// /// Gets the size of the image. /// /// The path. /// ImageSize. public ImageSize GetImageSize(string path) { return GetImageSize(path, File.GetLastWriteTimeUtc(path)); } /// /// Gets the size of the image. /// /// The path. /// The image date modified. /// ImageSize. /// path public ImageSize GetImageSize(string path, DateTime imageDateModified) { 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); _cachedImagedSizes.AddOrUpdate(cacheHash, size, (keyName, oldValue) => size); } return size; } /// /// Gets the image size internal. /// /// The path. /// ImageSize. private ImageSize GetImageSizeInternal(string path) { var size = ImageHeader.GetDimensions(path, _logger, _fileSystem); StartSaveImageSizeTimer(); return new ImageSize { Width = size.Width, Height = size.Height }; } 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; Directory.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. /// Type of the image. /// The image path. /// Guid. /// item public Guid GetImageCacheTag(IHasImages item, ImageType imageType, string imagePath) { if (item == null) { throw new ArgumentNullException("item"); } if (string.IsNullOrEmpty(imagePath)) { throw new ArgumentNullException("imagePath"); } var dateModified = item.GetImageDateModified(imagePath); var supportedEnhancers = GetSupportedEnhancers(item, imageType); return GetImageCacheTag(item, imageType, imagePath, dateModified, supportedEnhancers.ToList()); } /// /// Gets the image cache tag. /// /// The item. /// Type of the image. /// The original image path. /// The date modified of the original image file. /// The image enhancers. /// Guid. /// item public Guid GetImageCacheTag(IHasImages item, ImageType imageType, string originalImagePath, DateTime dateModified, List imageEnhancers) { if (item == null) { throw new ArgumentNullException("item"); } if (imageEnhancers == null) { throw new ArgumentNullException("imageEnhancers"); } if (string.IsNullOrEmpty(originalImagePath)) { throw new ArgumentNullException("originalImagePath"); } // Optimization if (imageEnhancers.Count == 0) { return (originalImagePath + dateModified.Ticks).GetMD5(); } // 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(); } /// /// 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 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> GetEnhancedImage(string originalImagePath, DateTime dateModified, IHasImages item, ImageType imageType, int imageIndex, List enhancers) { try { // Enhance if we have enhancers var ehnancedImagePath = await GetEnhancedImageInternal(originalImagePath, dateModified, item, imageType, imageIndex, enhancers).ConfigureAwait(false); // If the path changed update dateModified if (!ehnancedImagePath.Equals(originalImagePath, StringComparison.OrdinalIgnoreCase)) { dateModified = _fileSystem.GetLastWriteTimeUtc(ehnancedImagePath); return new Tuple(ehnancedImagePath, dateModified); } } catch (Exception ex) { _logger.Error("Error enhancing image", ex); } return new Tuple(originalImagePath, dateModified); } /// /// Runs an image through the image enhancers, caches the result, and returns the cached path /// /// The original image path. /// The date modified of the original image file. /// The item. /// Type of the image. /// Index of the image. /// The supported enhancers. /// System.String. /// originalImagePath private async Task GetEnhancedImageInternal(string originalImagePath, DateTime dateModified, IHasImages item, ImageType imageType, int imageIndex, List supportedEnhancers) { if (string.IsNullOrEmpty(originalImagePath)) { throw new ArgumentNullException("originalImagePath"); } if (item == null) { throw new ArgumentNullException("item"); } var cacheGuid = GetImageCacheTag(item, imageType, originalImagePath, dateModified, supportedEnhancers); // 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 (File.Exists(enhancedImagePath)) { semaphore.Release(); return enhancedImagePath; } try { using (var fileStream = _fileSystem.GetFileStream(originalImagePath, FileMode.Open, FileAccess.Read, FileShare.Read, true)) { // Copy to memory stream to avoid Image locking file using (var memoryStream = new MemoryStream()) { await fileStream.CopyToAsync(memoryStream).ConfigureAwait(false); using (var originalImage = Image.FromStream(memoryStream, true, false)) { //Pass the image through registered enhancers using (var newImage = await ExecuteImageEnhancers(supportedEnhancers, originalImage, item, imageType, imageIndex).ConfigureAwait(false)) { var parentDirectory = Path.GetDirectoryName(enhancedImagePath); Directory.CreateDirectory(parentDirectory); //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); } } } } } } finally { semaphore.Release(); } return enhancedImagePath; } /// /// Executes the image enhancers. /// /// The image enhancers. /// The original image. /// The item. /// Type of the image. /// Index of the image. /// Task{EnhancedImage}. private async Task ExecuteImageEnhancers(IEnumerable imageEnhancers, Image originalImage, IHasImages item, ImageType imageType, int imageIndex) { 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; } } return result; } /// /// The _semaphoreLocks /// private readonly ConcurrentDictionary _locks = new ConcurrentDictionary(); /// /// Gets the lock. /// /// The filename. /// System.Object. private object GetObjectLock(string filename) { return _locks.GetOrAdd(filename, key => new object()); } /// /// 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 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; } }); } public void Dispose() { _saveImageSizeTimer.Dispose(); } } }