using MediaBrowser.Common.Extensions; using MediaBrowser.Common.IO; using MediaBrowser.Common.Kernel; using MediaBrowser.Common.Serialization; using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Entities.Audio; using MediaBrowser.Model.Entities; using MediaBrowser.Model.IO; using MediaBrowser.Model.Logging; using System; using System.Collections.Generic; using System.ComponentModel; using System.Diagnostics; using System.IO; using System.Linq; using System.Reflection; using System.Runtime.InteropServices; using System.Threading; using System.Threading.Tasks; namespace MediaBrowser.Controller.MediaInfo { /// /// Class FFMpegManager /// public class FFMpegManager : BaseManager { /// /// Gets or sets the video image cache. /// /// The video image cache. internal FileSystemRepository VideoImageCache { get; set; } /// /// Gets or sets the image cache. /// /// The image cache. internal FileSystemRepository AudioImageCache { get; set; } /// /// Gets or sets the subtitle cache. /// /// The subtitle cache. internal FileSystemRepository SubtitleCache { get; set; } /// /// Gets or sets the zip client. /// /// The zip client. private IZipClient ZipClient { get; set; } /// /// The _logger /// private readonly ILogger _logger; /// /// Initializes a new instance of the class. /// /// The kernel. /// The zip client. /// The logger. /// zipClient public FFMpegManager(Kernel kernel, IZipClient zipClient, ILogger logger) : base(kernel) { if (zipClient == null) { throw new ArgumentNullException("zipClient"); } _logger = logger; ZipClient = zipClient; // Not crazy about this but it's the only way to suppress ffmpeg crash dialog boxes SetErrorMode(ErrorModes.SEM_FAILCRITICALERRORS | ErrorModes.SEM_NOALIGNMENTFAULTEXCEPT | ErrorModes.SEM_NOGPFAULTERRORBOX | ErrorModes.SEM_NOOPENFILEERRORBOX); VideoImageCache = new FileSystemRepository(VideoImagesDataPath); AudioImageCache = new FileSystemRepository(AudioImagesDataPath); SubtitleCache = new FileSystemRepository(SubtitleCachePath); Task.Run(() => VersionedDirectoryPath = GetVersionedDirectoryPath()); } /// /// Releases unmanaged and - optionally - managed resources. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. protected override void Dispose(bool dispose) { if (dispose) { SetErrorMode(ErrorModes.SYSTEM_DEFAULT); AudioImageCache.Dispose(); VideoImageCache.Dispose(); } base.Dispose(dispose); } /// /// The FF probe resource pool count /// private const int FFProbeResourcePoolCount = 4; /// /// The audio image resource pool count /// private const int AudioImageResourcePoolCount = 4; /// /// The video image resource pool count /// private const int VideoImageResourcePoolCount = 2; /// /// The FF probe resource pool /// private readonly SemaphoreSlim FFProbeResourcePool = new SemaphoreSlim(FFProbeResourcePoolCount, FFProbeResourcePoolCount); /// /// The audio image resource pool /// private readonly SemaphoreSlim AudioImageResourcePool = new SemaphoreSlim(AudioImageResourcePoolCount, AudioImageResourcePoolCount); /// /// The video image resource pool /// private readonly SemaphoreSlim VideoImageResourcePool = new SemaphoreSlim(VideoImageResourcePoolCount, VideoImageResourcePoolCount); /// /// Gets or sets the versioned directory path. /// /// The versioned directory path. private string VersionedDirectoryPath { get; set; } /// /// Gets the FFMPEG version. /// /// The FFMPEG version. public string FFMpegVersion { get { return Path.GetFileNameWithoutExtension(VersionedDirectoryPath); } } /// /// The _ FF MPEG path /// private string _FFMpegPath; /// /// Gets the path to ffmpeg.exe /// /// The FF MPEG path. public string FFMpegPath { get { return _FFMpegPath ?? (_FFMpegPath = Path.Combine(VersionedDirectoryPath, "ffmpeg.exe")); } } /// /// The _ FF probe path /// private string _FFProbePath; /// /// Gets the path to ffprobe.exe /// /// The FF probe path. public string FFProbePath { get { return _FFProbePath ?? (_FFProbePath = Path.Combine(VersionedDirectoryPath, "ffprobe.exe")); } } /// /// The _video images data path /// private string _videoImagesDataPath; /// /// Gets the video images data path. /// /// The video images data path. public string VideoImagesDataPath { get { if (_videoImagesDataPath == null) { _videoImagesDataPath = Path.Combine(Kernel.ApplicationPaths.DataPath, "ffmpeg-video-images"); if (!Directory.Exists(_videoImagesDataPath)) { Directory.CreateDirectory(_videoImagesDataPath); } } return _videoImagesDataPath; } } /// /// The _audio images data path /// private string _audioImagesDataPath; /// /// Gets the audio images data path. /// /// The audio images data path. public string AudioImagesDataPath { get { if (_audioImagesDataPath == null) { _audioImagesDataPath = Path.Combine(Kernel.ApplicationPaths.DataPath, "ffmpeg-audio-images"); if (!Directory.Exists(_audioImagesDataPath)) { Directory.CreateDirectory(_audioImagesDataPath); } } return _audioImagesDataPath; } } /// /// The _subtitle cache path /// private string _subtitleCachePath; /// /// Gets the subtitle cache path. /// /// The subtitle cache path. public string SubtitleCachePath { get { if (_subtitleCachePath == null) { _subtitleCachePath = Path.Combine(Kernel.ApplicationPaths.CachePath, "ffmpeg-subtitles"); if (!Directory.Exists(_subtitleCachePath)) { Directory.CreateDirectory(_subtitleCachePath); } } return _subtitleCachePath; } } /// /// Gets the versioned directory path. /// /// System.String. private string GetVersionedDirectoryPath() { var assembly = GetType().Assembly; const string prefix = "MediaBrowser.Controller.MediaInfo."; const string srch = prefix + "ffmpeg"; var resource = assembly.GetManifestResourceNames().First(r => r.StartsWith(srch)); var filename = resource.Substring(resource.IndexOf(prefix, StringComparison.OrdinalIgnoreCase) + prefix.Length); var versionedDirectoryPath = Path.Combine(Kernel.ApplicationPaths.MediaToolsPath, Path.GetFileNameWithoutExtension(filename)); if (!Directory.Exists(versionedDirectoryPath)) { Directory.CreateDirectory(versionedDirectoryPath); } ExtractTools(assembly, resource, versionedDirectoryPath); return versionedDirectoryPath; } /// /// Extracts the tools. /// /// The assembly. /// The zip file resource path. /// The target path. private void ExtractTools(Assembly assembly, string zipFileResourcePath, string targetPath) { using (var resourceStream = assembly.GetManifestResourceStream(zipFileResourcePath)) { ZipClient.ExtractAll(resourceStream, targetPath, false); } } /// /// Gets the probe size argument. /// /// The item. /// System.String. public string GetProbeSizeArgument(BaseItem item) { var video = item as Video; return video != null ? GetProbeSizeArgument(video.VideoType, video.IsoType) : string.Empty; } /// /// Gets the probe size argument. /// /// Type of the video. /// Type of the iso. /// System.String. public string GetProbeSizeArgument(VideoType videoType, IsoType? isoType) { if (videoType == VideoType.Dvd || (isoType.HasValue && isoType.Value == IsoType.Dvd)) { return "-probesize 1G -analyzeduration 200M"; } return string.Empty; } /// /// Runs FFProbe against a BaseItem /// /// The item. /// The input path. /// The last date modified. /// The cache. /// The cancellation token. /// Task{FFProbeResult}. /// item public Task RunFFProbe(BaseItem item, string inputPath, DateTime lastDateModified, FileSystemRepository cache, CancellationToken cancellationToken) { if (string.IsNullOrEmpty(inputPath)) { throw new ArgumentNullException("inputPath"); } if (cache == null) { throw new ArgumentNullException("cache"); } // Put the ffmpeg version into the cache name so that it's unique per-version // We don't want to try and deserialize data based on an old version, which could potentially fail var resourceName = item.Id + "_" + lastDateModified.Ticks + "_" + FFMpegVersion; // Forumulate the cache file path var cacheFilePath = cache.GetResourcePath(resourceName, ".pb"); cancellationToken.ThrowIfCancellationRequested(); // Avoid File.Exists by just trying to deserialize try { return Task.FromResult(Kernel.ProtobufSerializer.DeserializeFromFile(cacheFilePath)); } catch (FileNotFoundException) { var extractChapters = false; var video = item as Video; var probeSizeArgument = string.Empty; if (video != null) { extractChapters = true; probeSizeArgument = GetProbeSizeArgument(video.VideoType, video.IsoType); } return RunFFProbeInternal(inputPath, extractChapters, cacheFilePath, probeSizeArgument, cancellationToken); } } /// /// Runs FFProbe against a BaseItem /// /// The input path. /// if set to true [extract chapters]. /// The cache file. /// The probe size argument. /// The cancellation token. /// Task{FFProbeResult}. /// private async Task RunFFProbeInternal(string inputPath, bool extractChapters, string cacheFile, string probeSizeArgument, CancellationToken cancellationToken) { var process = new Process { StartInfo = new ProcessStartInfo { CreateNoWindow = true, UseShellExecute = false, // Must consume both or ffmpeg may hang due to deadlocks. See comments below. RedirectStandardOutput = true, RedirectStandardError = true, FileName = FFProbePath, Arguments = string.Format("{0} -i {1} -threads 0 -v info -print_format json -show_streams -show_format", probeSizeArgument, inputPath).Trim(), WindowStyle = ProcessWindowStyle.Hidden, ErrorDialog = false }, EnableRaisingEvents = true }; _logger.Debug("{0} {1}", process.StartInfo.FileName, process.StartInfo.Arguments); process.Exited += ProcessExited; await FFProbeResourcePool.WaitAsync(cancellationToken).ConfigureAwait(false); FFProbeResult result; string standardError = null; try { process.Start(); Task standardErrorReadTask = null; // MUST read both stdout and stderr asynchronously or a deadlock may occurr if (extractChapters) { standardErrorReadTask = process.StandardError.ReadToEndAsync(); } else { process.BeginErrorReadLine(); } result = JsonSerializer.DeserializeFromStream(process.StandardOutput.BaseStream); if (extractChapters) { standardError = await standardErrorReadTask.ConfigureAwait(false); } } catch { // Hate having to do this try { process.Kill(); } catch (InvalidOperationException ex1) { _logger.ErrorException("Error killing ffprobe", ex1); } catch (Win32Exception ex1) { _logger.ErrorException("Error killing ffprobe", ex1); } throw; } finally { FFProbeResourcePool.Release(); } if (result == null) { throw new ApplicationException(string.Format("FFProbe failed for {0}", inputPath)); } cancellationToken.ThrowIfCancellationRequested(); if (extractChapters && !string.IsNullOrEmpty(standardError)) { AddChapters(result, standardError); } Kernel.ProtobufSerializer.SerializeToFile(result, cacheFile); return result; } /// /// Adds the chapters. /// /// The result. /// The standard error. private void AddChapters(FFProbeResult result, string standardError) { var lines = standardError.Split('\n').Select(l => l.TrimStart()); var chapters = new List { }; ChapterInfo lastChapter = null; foreach (var line in lines) { if (line.StartsWith("Chapter", StringComparison.OrdinalIgnoreCase)) { // Example: // Chapter #0.2: start 400.534, end 4565.435 const string srch = "start "; var start = line.IndexOf(srch, StringComparison.OrdinalIgnoreCase); if (start == -1) { continue; } var subString = line.Substring(start + srch.Length); subString = subString.Substring(0, subString.IndexOf(',')); double seconds; if (double.TryParse(subString, out seconds)) { lastChapter = new ChapterInfo { StartPositionTicks = TimeSpan.FromSeconds(seconds).Ticks }; chapters.Add(lastChapter); } } else if (line.StartsWith("title", StringComparison.OrdinalIgnoreCase)) { if (lastChapter != null && string.IsNullOrEmpty(lastChapter.Name)) { var index = line.IndexOf(':'); if (index != -1) { lastChapter.Name = line.Substring(index + 1).Trim().TrimEnd('\r'); } } } } result.Chapters = chapters; } /// /// The first chapter ticks /// private static long FirstChapterTicks = TimeSpan.FromSeconds(15).Ticks; /// /// Extracts the chapter images. /// /// The video. /// The cancellation token. /// if set to true [extract images]. /// if set to true [save item]. /// Task. /// public async Task PopulateChapterImages(Video video, CancellationToken cancellationToken, bool extractImages, bool saveItem) { if (video.Chapters == null) { throw new ArgumentNullException(); } var changesMade = false; foreach (var chapter in video.Chapters) { var filename = video.Id + "_" + video.DateModified.Ticks + "_" + chapter.StartPositionTicks; var path = VideoImageCache.GetResourcePath(filename, ".jpg"); if (!VideoImageCache.ContainsFilePath(path)) { if (extractImages) { // Disable for now on folder rips if (video.VideoType != VideoType.VideoFile) { continue; } // Add some time for the first chapter to make sure we don't end up with a black image var time = chapter.StartPositionTicks == 0 ? TimeSpan.FromTicks(Math.Min(FirstChapterTicks, video.RunTimeTicks ?? 0)) : TimeSpan.FromTicks(chapter.StartPositionTicks); var success = await ExtractImage(GetInputArgument(video), time, path, cancellationToken).ConfigureAwait(false); if (success) { chapter.ImagePath = path; changesMade = true; } } } else if (!string.Equals(path, chapter.ImagePath, StringComparison.OrdinalIgnoreCase)) { chapter.ImagePath = path; changesMade = true; } } if (saveItem && changesMade) { await Kernel.ItemRepository.SaveItem(video, CancellationToken.None).ConfigureAwait(false); } } /// /// Extracts an image from an Audio file and returns a Task whose result indicates whether it was successful or not /// /// The input. /// The output path. /// The cancellation token. /// Task{System.Boolean}. /// input public async Task ExtractImage(Audio input, string outputPath, CancellationToken cancellationToken) { if (input == null) { throw new ArgumentNullException("input"); } if (string.IsNullOrEmpty(outputPath)) { throw new ArgumentNullException("outputPath"); } var process = new Process { StartInfo = new ProcessStartInfo { CreateNoWindow = true, UseShellExecute = false, FileName = FFMpegPath, Arguments = string.Format("-i {0} -threads 0 -v quiet -f image2 \"{1}\"", GetInputArgument(input), outputPath), WindowStyle = ProcessWindowStyle.Hidden, ErrorDialog = false } }; await AudioImageResourcePool.WaitAsync(cancellationToken).ConfigureAwait(false); await RunAsync(process).ConfigureAwait(false); AudioImageResourcePool.Release(); var exitCode = process.ExitCode; process.Dispose(); if (exitCode != -1 && File.Exists(outputPath)) { return true; } _logger.Error("ffmpeg audio image extraction failed for {0}", input.Path); return false; } /// /// Determines whether [is subtitle cached] [the specified input]. /// /// The input. /// Index of the subtitle stream. /// The output extension. /// true if [is subtitle cached] [the specified input]; otherwise, false. public bool IsSubtitleCached(Video input, int subtitleStreamIndex, string outputExtension) { return SubtitleCache.ContainsFilePath(GetSubtitleCachePath(input, subtitleStreamIndex, outputExtension)); } /// /// Gets the subtitle cache path. /// /// The input. /// Index of the subtitle stream. /// The output extension. /// System.String. public string GetSubtitleCachePath(Video input, int subtitleStreamIndex, string outputExtension) { return SubtitleCache.GetResourcePath(input.Id + "_" + subtitleStreamIndex + "_" + input.DateModified.Ticks, outputExtension); } /// /// Extracts the text subtitle. /// /// The input. /// Index of the subtitle stream. /// The output path. /// The cancellation token. /// Task{System.Boolean}. /// input public async Task ExtractTextSubtitle(Video input, int subtitleStreamIndex, string outputPath, CancellationToken cancellationToken) { if (input == null) { throw new ArgumentNullException("input"); } if (cancellationToken == null) { throw new ArgumentNullException("cancellationToken"); } var process = new Process { StartInfo = new ProcessStartInfo { CreateNoWindow = true, UseShellExecute = false, FileName = FFMpegPath, Arguments = string.Format("-i {0} -map 0:{1} -an -vn -c:s ass \"{2}\"", GetInputArgument(input), subtitleStreamIndex, outputPath), WindowStyle = ProcessWindowStyle.Hidden, ErrorDialog = false } }; _logger.Debug("{0} {1}", process.StartInfo.FileName, process.StartInfo.Arguments); await AudioImageResourcePool.WaitAsync(cancellationToken).ConfigureAwait(false); await RunAsync(process).ConfigureAwait(false); AudioImageResourcePool.Release(); var exitCode = process.ExitCode; process.Dispose(); if (exitCode != -1 && File.Exists(outputPath)) { return true; } _logger.Error("ffmpeg subtitle extraction failed for {0}", input.Path); return false; } /// /// Converts the text subtitle. /// /// The media stream. /// The output path. /// The cancellation token. /// Task{System.Boolean}. /// mediaStream /// The given MediaStream is not an external subtitle stream public async Task ConvertTextSubtitle(MediaStream mediaStream, string outputPath, CancellationToken cancellationToken) { if (mediaStream == null) { throw new ArgumentNullException("mediaStream"); } if (!mediaStream.IsExternal || string.IsNullOrEmpty(mediaStream.Path)) { throw new ArgumentException("The given MediaStream is not an external subtitle stream"); } var process = new Process { StartInfo = new ProcessStartInfo { CreateNoWindow = true, UseShellExecute = false, FileName = FFMpegPath, Arguments = string.Format("-i \"{0}\" \"{1}\"", mediaStream.Path, outputPath), WindowStyle = ProcessWindowStyle.Hidden, ErrorDialog = false } }; _logger.Debug("{0} {1}", process.StartInfo.FileName, process.StartInfo.Arguments); await AudioImageResourcePool.WaitAsync(cancellationToken).ConfigureAwait(false); await RunAsync(process).ConfigureAwait(false); AudioImageResourcePool.Release(); var exitCode = process.ExitCode; process.Dispose(); if (exitCode != -1 && File.Exists(outputPath)) { return true; } _logger.Error("ffmpeg subtitle conversion failed for {0}", mediaStream.Path); return false; } /// /// Extracts an image from a Video and returns a Task whose result indicates whether it was successful or not /// /// The input path. /// The offset. /// The output path. /// The cancellation token. /// Task{System.Boolean}. /// video public async Task ExtractImage(string inputPath, TimeSpan offset, string outputPath, CancellationToken cancellationToken) { if (string.IsNullOrEmpty(inputPath)) { throw new ArgumentNullException("inputPath"); } if (string.IsNullOrEmpty(outputPath)) { throw new ArgumentNullException("outputPath"); } var process = new Process { StartInfo = new ProcessStartInfo { CreateNoWindow = true, UseShellExecute = false, FileName = FFMpegPath, Arguments = string.Format("-ss {0} -i {1} -threads 0 -v quiet -t 1 -f image2 \"{2}\"", Convert.ToInt32(offset.TotalSeconds), inputPath, outputPath), WindowStyle = ProcessWindowStyle.Hidden, ErrorDialog = false } }; await VideoImageResourcePool.WaitAsync(cancellationToken).ConfigureAwait(false); process.Start(); var ranToCompletion = process.WaitForExit(10000); if (!ranToCompletion) { try { _logger.Info("Killing ffmpeg process"); process.Kill(); process.WaitForExit(1000); } catch (Win32Exception ex) { _logger.ErrorException("Error killing process", ex); } catch (InvalidOperationException ex) { _logger.ErrorException("Error killing process", ex); } catch (NotSupportedException ex) { _logger.ErrorException("Error killing process", ex); } } VideoImageResourcePool.Release(); var exitCode = ranToCompletion ? process.ExitCode : -1; process.Dispose(); if (exitCode == -1) { if (File.Exists(outputPath)) { try { _logger.Info("Deleting extracted image due to failure: ", outputPath); File.Delete(outputPath); } catch (IOException ex) { _logger.ErrorException("Error deleting extracted image {0}", ex, outputPath); } } } else { if (File.Exists(outputPath)) { return true; } } _logger.Error("ffmpeg video image extraction failed for {0}", inputPath); return false; } /// /// Gets the input argument. /// /// The item. /// System.String. public string GetInputArgument(BaseItem item) { var video = item as Video; if (video != null) { if (video.VideoType == VideoType.BluRay) { return GetBlurayInputArgument(video.Path); } if (video.VideoType == VideoType.Dvd) { return GetDvdInputArgument(video.GetPlayableStreamFiles()); } } return string.Format("file:\"{0}\"", item.Path); } /// /// Gets the input argument. /// /// The item. /// The mount. /// System.String. public string GetInputArgument(Video item, IIsoMount mount) { if (item.VideoType == VideoType.Iso && item.IsoType.HasValue) { if (item.IsoType.Value == IsoType.BluRay) { return GetBlurayInputArgument(mount.MountedPath); } if (item.IsoType.Value == IsoType.Dvd) { return GetDvdInputArgument(item.GetPlayableStreamFiles(mount.MountedPath)); } } return GetInputArgument(item); } /// /// Gets the bluray input argument. /// /// The bluray root. /// System.String. public string GetBlurayInputArgument(string blurayRoot) { return string.Format("bluray:\"{0}\"", blurayRoot); } /// /// Gets the DVD input argument. /// /// The playable stream files. /// System.String. public string GetDvdInputArgument(IEnumerable playableStreamFiles) { // Get all streams var streamFilePaths = (playableStreamFiles ?? new string[] { }).ToArray(); // If there's more than one we'll need to use the concat command if (streamFilePaths.Length > 1) { var files = string.Join("|", streamFilePaths); return string.Format("concat:\"{0}\"", files); } // Determine the input path for video files return string.Format("file:\"{0}\"", streamFilePaths[0]); } /// /// Processes the exited. /// /// The sender. /// The instance containing the event data. void ProcessExited(object sender, EventArgs e) { ((Process)sender).Dispose(); } /// /// Provides a non-blocking method to start a process and wait asynchronously for it to exit /// /// The process. /// Task{System.Boolean}. private static Task RunAsync(Process process) { var tcs = new TaskCompletionSource(); process.EnableRaisingEvents = true; process.Exited += (sender, args) => tcs.SetResult(true); process.Start(); return tcs.Task; } /// /// Sets the error mode. /// /// The u mode. /// ErrorModes. [DllImport("kernel32.dll")] static extern ErrorModes SetErrorMode(ErrorModes uMode); /// /// Enum ErrorModes /// [Flags] public enum ErrorModes : uint { /// /// The SYSTE m_ DEFAULT /// SYSTEM_DEFAULT = 0x0, /// /// The SE m_ FAILCRITICALERRORS /// SEM_FAILCRITICALERRORS = 0x0001, /// /// The SE m_ NOALIGNMENTFAULTEXCEPT /// SEM_NOALIGNMENTFAULTEXCEPT = 0x0004, /// /// The SE m_ NOGPFAULTERRORBOX /// SEM_NOGPFAULTERRORBOX = 0x0002, /// /// The SE m_ NOOPENFILEERRORBOX /// SEM_NOOPENFILEERRORBOX = 0x8000 } } }