2019-01-13 19:26:04 +00:00
using System ;
using System.Collections.Generic ;
using System.Globalization ;
using System.IO ;
using System.Linq ;
2019-02-12 22:05:42 +00:00
using System.Text.RegularExpressions ;
2019-01-13 19:26:04 +00:00
using System.Threading ;
using System.Threading.Tasks ;
using MediaBrowser.Common.Configuration ;
using MediaBrowser.Common.Extensions ;
2018-12-14 09:40:55 +00:00
using MediaBrowser.Controller.Configuration ;
using MediaBrowser.Controller.Library ;
using MediaBrowser.Controller.MediaEncoding ;
using MediaBrowser.MediaEncoding.Probing ;
2019-01-13 19:26:04 +00:00
using MediaBrowser.Model.Configuration ;
using MediaBrowser.Model.Diagnostics ;
2018-12-14 09:40:55 +00:00
using MediaBrowser.Model.Dlna ;
using MediaBrowser.Model.Entities ;
using MediaBrowser.Model.IO ;
using MediaBrowser.Model.MediaInfo ;
using MediaBrowser.Model.Serialization ;
2019-02-12 22:05:42 +00:00
using MediaBrowser.Model.System ;
2018-12-14 23:48:06 +00:00
using Microsoft.Extensions.Logging ;
2018-12-14 09:40:55 +00:00
namespace MediaBrowser.MediaEncoding.Encoder
{
/// <summary>
/// Class MediaEncoder
/// </summary>
public class MediaEncoder : IMediaEncoder , IDisposable
{
/// <summary>
2019-02-08 13:35:26 +00:00
/// Gets the encoder path.
2018-12-14 09:40:55 +00:00
/// </summary>
2019-02-08 13:35:26 +00:00
/// <value>The encoder path.</value>
public string EncoderPath = > FFmpegPath ;
2018-12-14 09:40:55 +00:00
/// <summary>
2019-02-12 22:05:42 +00:00
/// The location of the discovered FFmpeg tool.
2018-12-14 09:40:55 +00:00
/// </summary>
2019-02-12 22:05:42 +00:00
public FFmpegLocation EncoderLocation { get ; private set ; }
2019-02-08 13:35:26 +00:00
private readonly ILogger _logger ;
private readonly IJsonSerializer _jsonSerializer ;
2019-02-12 22:05:42 +00:00
private string FFmpegPath ;
private string FFprobePath ;
2018-12-14 09:40:55 +00:00
protected readonly IServerConfigurationManager ConfigurationManager ;
protected readonly IFileSystem FileSystem ;
protected readonly Func < ISubtitleEncoder > SubtitleEncoder ;
protected readonly Func < IMediaSourceManager > MediaSourceManager ;
private readonly IProcessFactory _processFactory ;
2019-02-08 13:35:26 +00:00
private readonly int DefaultImageExtractionTimeoutMs ;
private readonly string StartupOptionFFmpegPath ;
private readonly string StartupOptionFFprobePath ;
2018-12-14 09:40:55 +00:00
2019-02-08 13:35:26 +00:00
private readonly SemaphoreSlim _thumbnailResourcePool = new SemaphoreSlim ( 1 , 1 ) ;
2018-12-14 09:40:55 +00:00
private readonly List < ProcessWrapper > _runningProcesses = new List < ProcessWrapper > ( ) ;
2019-01-17 22:55:05 +00:00
public MediaEncoder (
ILoggerFactory loggerFactory ,
2019-01-02 14:12:52 +00:00
IJsonSerializer jsonSerializer ,
2019-02-08 13:35:26 +00:00
string startupOptionsFFmpegPath ,
string startupOptionsFFprobePath ,
2019-01-02 14:12:52 +00:00
IServerConfigurationManager configurationManager ,
IFileSystem fileSystem ,
Func < ISubtitleEncoder > subtitleEncoder ,
Func < IMediaSourceManager > mediaSourceManager ,
IProcessFactory processFactory ,
2019-01-08 16:29:34 +00:00
int defaultImageExtractionTimeoutMs )
2018-12-14 09:40:55 +00:00
{
2019-01-17 22:55:05 +00:00
_logger = loggerFactory . CreateLogger ( nameof ( MediaEncoder ) ) ;
2018-12-14 09:40:55 +00:00
_jsonSerializer = jsonSerializer ;
2019-02-08 13:35:26 +00:00
StartupOptionFFmpegPath = startupOptionsFFmpegPath ;
StartupOptionFFprobePath = startupOptionsFFprobePath ;
2018-12-14 09:40:55 +00:00
ConfigurationManager = configurationManager ;
FileSystem = fileSystem ;
SubtitleEncoder = subtitleEncoder ;
_processFactory = processFactory ;
DefaultImageExtractionTimeoutMs = defaultImageExtractionTimeoutMs ;
}
2019-02-08 13:35:26 +00:00
/// <summary>
/// Run at startup or if the user removes a Custom path from transcode page.
2019-02-12 22:05:42 +00:00
/// Sets global variables FFmpegPath.
/// Precedence is: Config > CLI > $PATH
2019-02-08 13:35:26 +00:00
/// </summary>
2019-02-28 22:47:56 +00:00
public void SetFFmpegPath ( )
2018-12-14 09:40:55 +00:00
{
2019-02-28 22:06:56 +00:00
// ToDo - Finalise removal of the --ffprobe switch
if ( ! string . IsNullOrEmpty ( StartupOptionFFprobePath ) )
{
_logger . LogWarning ( "--ffprobe switch is deprecated and shall be removed in the next release" ) ;
}
// 1) Custom path stored in config/encoding xml file under tag <EncoderAppPath> takes precedence
if ( ! ValidatePath ( ConfigurationManager . GetConfiguration < EncodingOptions > ( "encoding" ) . EncoderAppPath , FFmpegLocation . Custom ) )
2019-02-08 13:35:26 +00:00
{
2019-02-12 22:05:42 +00:00
// 2) Check if the --ffmpeg CLI switch has been given
2019-02-28 22:06:56 +00:00
if ( ! ValidatePath ( StartupOptionFFmpegPath , FFmpegLocation . SetByArgument ) )
2019-02-12 22:05:42 +00:00
{
// 3) Search system $PATH environment variable for valid FFmpeg
2019-02-28 22:06:56 +00:00
if ( ! ValidatePath ( ExistsOnSystemPath ( "ffmpeg" ) , FFmpegLocation . System ) )
2019-02-12 22:05:42 +00:00
{
EncoderLocation = FFmpegLocation . NotFound ;
FFmpegPath = null ;
}
}
2018-12-14 09:40:55 +00:00
}
2019-02-28 22:06:56 +00:00
// Write the FFmpeg path to the config/encoding.xml file as <EncoderAppPathDisplay> so it appears in UI
2019-02-08 13:35:26 +00:00
var config = ConfigurationManager . GetConfiguration < EncodingOptions > ( "encoding" ) ;
2019-02-28 22:06:56 +00:00
config . EncoderAppPathDisplay = FFmpegPath ? ? string . Empty ;
2019-02-08 13:35:26 +00:00
ConfigurationManager . SaveConfiguration ( "encoding" , config ) ;
2018-12-14 09:40:55 +00:00
2019-02-08 13:35:26 +00:00
// Only if mpeg path is set, try and set path to probe
if ( FFmpegPath ! = null )
2018-12-14 09:40:55 +00:00
{
2019-02-28 22:06:56 +00:00
// Determine a probe path from the mpeg path
FFprobePath = Regex . Replace ( FFmpegPath , @"[^\/\\]+?(\.[^\/\\\n.]+)?$" , @"ffprobe$1" ) ;
2018-12-14 09:40:55 +00:00
2019-02-28 22:06:56 +00:00
// Interrogate to understand what coders are supported
2019-02-08 13:35:26 +00:00
var result = new EncoderValidator ( _logger , _processFactory ) . GetAvailableCoders ( FFmpegPath ) ;
SetAvailableDecoders ( result . decoders ) ;
SetAvailableEncoders ( result . encoders ) ;
2018-12-14 09:40:55 +00:00
}
2019-02-08 13:35:26 +00:00
2019-02-28 22:06:56 +00:00
_logger . LogInformation ( "FFmpeg: {0}: {1}" , EncoderLocation . ToString ( ) , FFmpegPath ? ? string . Empty ) ;
2018-12-14 09:40:55 +00:00
}
2019-02-08 13:35:26 +00:00
/// <summary>
2019-02-28 22:06:56 +00:00
/// Triggered from the Settings > Transcoding UI page when users submits Custom FFmpeg path to use.
/// Only write the new path to xml if it exists. Do not perform validation checks on ffmpeg here.
2019-02-08 13:35:26 +00:00
/// </summary>
/// <param name="path"></param>
/// <param name="pathType"></param>
2018-12-14 09:40:55 +00:00
public void UpdateEncoderPath ( string path , string pathType )
{
2019-02-28 22:06:56 +00:00
string newPath ;
2018-12-14 23:48:06 +00:00
_logger . LogInformation ( "Attempting to update encoder path to {0}. pathType: {1}" , path ? ? string . Empty , pathType ? ? string . Empty ) ;
2018-12-14 09:40:55 +00:00
2019-02-08 13:35:26 +00:00
if ( ! string . Equals ( pathType , "custom" , StringComparison . OrdinalIgnoreCase ) )
2018-12-14 09:40:55 +00:00
{
2019-02-08 13:35:26 +00:00
throw new ArgumentException ( "Unexpected pathType value" ) ;
2018-12-14 09:40:55 +00:00
}
2019-02-28 22:06:56 +00:00
else if ( string . IsNullOrWhiteSpace ( path ) )
2018-12-14 09:40:55 +00:00
{
2019-02-28 22:06:56 +00:00
// User had cleared the custom path in UI
newPath = string . Empty ;
2019-02-12 22:05:42 +00:00
}
2019-02-28 22:06:56 +00:00
else if ( File . Exists ( path ) )
2019-02-12 22:05:42 +00:00
{
2019-02-28 22:06:56 +00:00
newPath = path ;
}
else if ( Directory . Exists ( path ) )
{
// Given path is directory, so resolve down to filename
newPath = GetEncoderPathFromDirectory ( path , "ffmpeg" ) ;
2019-02-12 22:05:42 +00:00
}
else
{
2019-02-28 22:06:56 +00:00
throw new ResourceNotFoundException ( ) ;
2019-02-08 13:35:26 +00:00
}
2019-02-28 22:06:56 +00:00
// Write the new ffmpeg path to the xml as <EncoderAppPath>
// This ensures its not lost on next startup
var config = ConfigurationManager . GetConfiguration < EncodingOptions > ( "encoding" ) ;
config . EncoderAppPath = newPath ;
ConfigurationManager . SaveConfiguration ( "encoding" , config ) ;
2019-02-28 22:47:56 +00:00
// Trigger SetFFmpegPath so we validate the new path and setup probe path
SetFFmpegPath ( ) ;
2018-12-14 09:40:55 +00:00
}
2019-02-12 22:05:42 +00:00
/// <summary>
2019-02-28 22:06:56 +00:00
/// Validates the supplied FQPN to ensure it is a ffmpeg utility.
/// If checks pass, global variable FFmpegPath and EncoderLocation are updated.
2019-02-12 22:05:42 +00:00
/// </summary>
/// <param name="path">FQPN to test</param>
/// <param name="location">Location (External, Custom, System) of tool</param>
/// <returns></returns>
2019-02-28 22:06:56 +00:00
private bool ValidatePath ( string path , FFmpegLocation location )
2018-12-14 09:40:55 +00:00
{
2019-02-12 22:05:42 +00:00
bool rc = false ;
2019-02-08 13:35:26 +00:00
if ( ! string . IsNullOrEmpty ( path ) )
2018-12-14 09:40:55 +00:00
{
2019-02-08 13:35:26 +00:00
if ( File . Exists ( path ) )
{
2019-02-28 22:06:56 +00:00
rc = new EncoderValidator ( _logger , _processFactory ) . ValidateVersion ( path , true ) ;
2018-12-14 09:40:55 +00:00
2019-02-28 22:06:56 +00:00
if ( ! rc )
2019-02-08 13:35:26 +00:00
{
2019-02-28 22:06:56 +00:00
_logger . LogWarning ( "FFmpeg: {0}: Failed version check: {1}" , location . ToString ( ) , path ) ;
2019-02-08 13:35:26 +00:00
}
2019-02-28 22:06:56 +00:00
// ToDo - Enable the ffmpeg validator. At the moment any version can be used.
rc = true ;
FFmpegPath = path ;
EncoderLocation = location ;
2019-02-08 13:35:26 +00:00
}
else
{
2019-02-28 22:06:56 +00:00
_logger . LogWarning ( "FFmpeg: {0}: File not found: {1}" , location . ToString ( ) , path ) ;
2019-02-08 13:35:26 +00:00
}
2018-12-14 09:40:55 +00:00
}
2019-02-12 22:05:42 +00:00
return rc ;
2018-12-14 09:40:55 +00:00
}
2019-02-12 22:05:42 +00:00
private string GetEncoderPathFromDirectory ( string path , string filename )
2018-12-14 09:40:55 +00:00
{
2019-02-08 13:35:26 +00:00
try
2018-12-14 09:40:55 +00:00
{
2019-02-08 13:35:26 +00:00
var files = FileSystem . GetFilePaths ( path ) ;
2018-12-14 09:40:55 +00:00
2019-02-08 13:35:26 +00:00
var excludeExtensions = new [ ] { ".c" } ;
2018-12-14 09:40:55 +00:00
2019-02-12 22:05:42 +00:00
return files . FirstOrDefault ( i = > string . Equals ( Path . GetFileNameWithoutExtension ( i ) , filename , StringComparison . OrdinalIgnoreCase )
& & ! excludeExtensions . Contains ( Path . GetExtension ( i ) ? ? string . Empty ) ) ;
2019-02-08 13:35:26 +00:00
}
catch ( Exception )
{
// Trap all exceptions, like DirNotExists, and return null
return null ;
2018-12-14 09:40:55 +00:00
}
}
2019-02-08 13:35:26 +00:00
/// <summary>
/// Search the system $PATH environment variable looking for given filename.
/// </summary>
/// <param name="fileName"></param>
/// <returns></returns>
2019-02-12 22:05:42 +00:00
private string ExistsOnSystemPath ( string filename )
2018-12-14 09:40:55 +00:00
{
2019-02-08 13:35:26 +00:00
var values = Environment . GetEnvironmentVariable ( "PATH" ) ;
foreach ( var path in values . Split ( Path . PathSeparator ) )
{
2019-02-12 22:05:42 +00:00
var candidatePath = GetEncoderPathFromDirectory ( path , filename ) ;
2019-02-08 13:35:26 +00:00
2019-02-12 22:05:42 +00:00
if ( ! string . IsNullOrEmpty ( candidatePath ) )
2019-02-08 13:35:26 +00:00
{
return candidatePath ;
}
}
return null ;
2018-12-14 09:40:55 +00:00
}
private List < string > _encoders = new List < string > ( ) ;
2019-01-02 00:23:49 +00:00
public void SetAvailableEncoders ( IEnumerable < string > list )
2018-12-14 09:40:55 +00:00
{
_encoders = list . ToList ( ) ;
//_logger.Info("Supported encoders: {0}", string.Join(",", list.ToArray()));
}
private List < string > _decoders = new List < string > ( ) ;
2019-01-02 00:23:49 +00:00
public void SetAvailableDecoders ( IEnumerable < string > list )
2018-12-14 09:40:55 +00:00
{
_decoders = list . ToList ( ) ;
//_logger.Info("Supported decoders: {0}", string.Join(",", list.ToArray()));
}
public bool SupportsEncoder ( string encoder )
{
return _encoders . Contains ( encoder , StringComparer . OrdinalIgnoreCase ) ;
}
public bool SupportsDecoder ( string decoder )
{
return _decoders . Contains ( decoder , StringComparer . OrdinalIgnoreCase ) ;
}
public bool CanEncodeToAudioCodec ( string codec )
{
if ( string . Equals ( codec , "opus" , StringComparison . OrdinalIgnoreCase ) )
{
codec = "libopus" ;
}
else if ( string . Equals ( codec , "mp3" , StringComparison . OrdinalIgnoreCase ) )
{
codec = "libmp3lame" ;
}
return SupportsEncoder ( codec ) ;
}
public bool CanEncodeToSubtitleCodec ( string codec )
{
// TODO
return true ;
}
/// <summary>
/// Gets the media info.
/// </summary>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Task.</returns>
public Task < MediaInfo > GetMediaInfo ( MediaInfoRequest request , CancellationToken cancellationToken )
{
var extractChapters = request . MediaType = = DlnaProfileType . Video & & request . ExtractChapters ;
var inputFiles = MediaEncoderHelpers . GetInputArgument ( FileSystem , request . MediaSource . Path , request . MediaSource . Protocol , request . MountedIso , request . PlayableStreamFileNames ) ;
var probeSize = EncodingHelper . GetProbeSizeArgument ( inputFiles . Length ) ;
string analyzeDuration ;
if ( request . MediaSource . AnalyzeDurationMs > 0 )
{
analyzeDuration = "-analyzeduration " +
( request . MediaSource . AnalyzeDurationMs * 1000 ) . ToString ( ) ;
}
else
{
analyzeDuration = EncodingHelper . GetAnalyzeDurationArgument ( inputFiles . Length ) ;
}
probeSize = probeSize + " " + analyzeDuration ;
probeSize = probeSize . Trim ( ) ;
var forceEnableLogging = request . MediaSource . Protocol ! = MediaProtocol . File ;
return GetMediaInfoInternal ( GetInputArgument ( inputFiles , request . MediaSource . Protocol ) , request . MediaSource . Path , request . MediaSource . Protocol , extractChapters ,
probeSize , request . MediaType = = DlnaProfileType . Audio , request . MediaSource . VideoType , forceEnableLogging , cancellationToken ) ;
}
/// <summary>
/// Gets the input argument.
/// </summary>
/// <param name="inputFiles">The input files.</param>
/// <param name="protocol">The protocol.</param>
/// <returns>System.String.</returns>
2019-01-13 20:37:13 +00:00
/// <exception cref="ArgumentException">Unrecognized InputType</exception>
2019-02-24 14:47:59 +00:00
public string GetInputArgument ( IReadOnlyList < string > inputFiles , MediaProtocol protocol )
= > EncodingUtils . GetInputArgument ( inputFiles , protocol ) ;
2018-12-14 09:40:55 +00:00
/// <summary>
/// Gets the media info internal.
/// </summary>
/// <returns>Task{MediaInfoResult}.</returns>
private async Task < MediaInfo > GetMediaInfoInternal ( string inputPath ,
string primaryPath ,
MediaProtocol protocol ,
bool extractChapters ,
string probeSizeArgument ,
bool isAudio ,
VideoType ? videoType ,
bool forceEnableLogging ,
CancellationToken cancellationToken )
{
var args = extractChapters
2019-02-24 14:47:59 +00:00
? "{0} -i {1} -threads 0 -v warning -print_format json -show_streams -show_chapters -show_format"
: "{0} -i {1} -threads 0 -v warning -print_format json -show_streams -show_format" ;
args = string . Format ( args , probeSizeArgument , inputPath ) . Trim ( ) ;
2018-12-14 09:40:55 +00:00
var process = _processFactory . Create ( new ProcessOptions
{
CreateNoWindow = true ,
UseShellExecute = false ,
2019-01-08 16:29:34 +00:00
// Must consume both or ffmpeg may hang due to deadlocks. See comments below.
2018-12-14 09:40:55 +00:00
RedirectStandardOutput = true ,
2019-02-24 14:47:59 +00:00
2019-02-08 13:35:26 +00:00
FileName = FFprobePath ,
2019-02-24 14:47:59 +00:00
Arguments = args ,
2018-12-14 09:40:55 +00:00
IsHidden = true ,
ErrorDialog = false ,
EnableRaisingEvents = true
} ) ;
if ( forceEnableLogging )
{
2018-12-14 23:48:06 +00:00
_logger . LogInformation ( "{0} {1}" , process . StartInfo . FileName , process . StartInfo . Arguments ) ;
2018-12-14 09:40:55 +00:00
}
else
{
2018-12-14 23:48:06 +00:00
_logger . LogDebug ( "{0} {1}" , process . StartInfo . FileName , process . StartInfo . Arguments ) ;
2018-12-14 09:40:55 +00:00
}
using ( var processWrapper = new ProcessWrapper ( process , this , _logger ) )
{
2019-02-24 14:47:59 +00:00
_logger . LogDebug ( "Starting ffprobe with args {Args}" , args ) ;
2018-12-14 09:40:55 +00:00
StartProcess ( processWrapper ) ;
2019-02-24 14:47:59 +00:00
InternalMediaInfoResult result ;
2018-12-14 09:40:55 +00:00
try
{
2019-02-24 14:47:59 +00:00
result = await _jsonSerializer . DeserializeFromStreamAsync < InternalMediaInfoResult > ( process . StandardOutput . BaseStream ) . ConfigureAwait ( false ) ;
}
catch
{
StopProcess ( processWrapper , 100 ) ;
2018-12-14 09:40:55 +00:00
2019-02-24 14:47:59 +00:00
throw ;
}
2018-12-14 09:40:55 +00:00
2019-02-24 14:47:59 +00:00
if ( result = = null | | ( result . streams = = null & & result . format = = null ) )
{
throw new Exception ( "ffprobe failed - streams and format are both null." ) ;
}
2018-12-14 09:40:55 +00:00
2019-02-24 14:47:59 +00:00
if ( result . streams ! = null )
{
// Normalize aspect ratio if invalid
foreach ( var stream in result . streams )
2018-12-14 09:40:55 +00:00
{
2019-02-24 14:47:59 +00:00
if ( string . Equals ( stream . display_aspect_ratio , "0:1" , StringComparison . OrdinalIgnoreCase ) )
2018-12-14 09:40:55 +00:00
{
2019-02-24 14:47:59 +00:00
stream . display_aspect_ratio = string . Empty ;
2018-12-14 09:40:55 +00:00
}
2019-02-24 14:47:59 +00:00
if ( string . Equals ( stream . sample_aspect_ratio , "0:1" , StringComparison . OrdinalIgnoreCase ) )
{
stream . sample_aspect_ratio = string . Empty ;
}
}
2018-12-14 09:40:55 +00:00
}
2019-02-24 14:47:59 +00:00
return new ProbeResultNormalizer ( _logger , FileSystem ) . GetMediaInfo ( result , videoType , isAudio , primaryPath , protocol ) ;
2018-12-14 09:40:55 +00:00
}
}
/// <summary>
/// The us culture
/// </summary>
protected readonly CultureInfo UsCulture = new CultureInfo ( "en-US" ) ;
public Task < string > ExtractAudioImage ( string path , int? imageStreamIndex , CancellationToken cancellationToken )
{
return ExtractImage ( new [ ] { path } , null , null , imageStreamIndex , MediaProtocol . File , true , null , null , cancellationToken ) ;
}
public Task < string > ExtractVideoImage ( string [ ] inputFiles , string container , MediaProtocol protocol , MediaStream videoStream , Video3DFormat ? threedFormat , TimeSpan ? offset , CancellationToken cancellationToken )
{
return ExtractImage ( inputFiles , container , videoStream , null , protocol , false , threedFormat , offset , cancellationToken ) ;
}
public Task < string > ExtractVideoImage ( string [ ] inputFiles , string container , MediaProtocol protocol , MediaStream imageStream , int? imageStreamIndex , CancellationToken cancellationToken )
{
return ExtractImage ( inputFiles , container , imageStream , imageStreamIndex , protocol , false , null , null , cancellationToken ) ;
}
private async Task < string > ExtractImage ( string [ ] inputFiles , string container , MediaStream videoStream , int? imageStreamIndex , MediaProtocol protocol , bool isAudio ,
Video3DFormat ? threedFormat , TimeSpan ? offset , CancellationToken cancellationToken )
{
var inputArgument = GetInputArgument ( inputFiles , protocol ) ;
if ( isAudio )
{
if ( imageStreamIndex . HasValue & & imageStreamIndex . Value > 0 )
{
// It seems for audio files we need to subtract 1 (for the audio stream??)
imageStreamIndex = imageStreamIndex . Value - 1 ;
}
}
else
{
try
{
return await ExtractImageInternal ( inputArgument , container , videoStream , imageStreamIndex , threedFormat , offset , true , cancellationToken ) . ConfigureAwait ( false ) ;
}
catch ( ArgumentException )
{
throw ;
}
2018-12-20 12:11:26 +00:00
catch ( Exception ex )
2018-12-14 09:40:55 +00:00
{
2018-12-20 12:11:26 +00:00
_logger . LogError ( ex , "I-frame image extraction failed, will attempt standard way. Input: {arguments}" , inputArgument ) ;
2018-12-14 09:40:55 +00:00
}
}
return await ExtractImageInternal ( inputArgument , container , videoStream , imageStreamIndex , threedFormat , offset , false , cancellationToken ) . ConfigureAwait ( false ) ;
}
private async Task < string > ExtractImageInternal ( string inputPath , string container , MediaStream videoStream , int? imageStreamIndex , Video3DFormat ? threedFormat , TimeSpan ? offset , bool useIFrame , CancellationToken cancellationToken )
{
if ( string . IsNullOrEmpty ( inputPath ) )
{
2019-01-06 20:50:43 +00:00
throw new ArgumentNullException ( nameof ( inputPath ) ) ;
2018-12-14 09:40:55 +00:00
}
var tempExtractPath = Path . Combine ( ConfigurationManager . ApplicationPaths . TempDirectory , Guid . NewGuid ( ) + ".jpg" ) ;
2019-01-26 21:08:04 +00:00
Directory . CreateDirectory ( Path . GetDirectoryName ( tempExtractPath ) ) ;
2018-12-14 09:40:55 +00:00
2019-01-08 16:29:34 +00:00
// apply some filters to thumbnail extracted below (below) crop any black lines that we made and get the correct ar then scale to width 600.
2018-12-14 09:40:55 +00:00
// This filter chain may have adverse effects on recorded tv thumbnails if ar changes during presentation ex. commercials @ diff ar
var vf = "scale=600:trunc(600/dar/2)*2" ;
if ( threedFormat . HasValue )
{
switch ( threedFormat . Value )
{
case Video3DFormat . HalfSideBySide :
vf = "crop=iw/2:ih:0:0,scale=(iw*2):ih,setdar=dar=a,crop=min(iw\\,ih*dar):min(ih\\,iw/dar):(iw-min(iw\\,iw*sar))/2:(ih - min (ih\\,ih/sar))/2,setsar=sar=1,scale=600:trunc(600/dar/2)*2" ;
// hsbs crop width in half,scale to correct size, set the display aspect,crop out any black bars we may have made the scale width to 600. Work out the correct height based on the display aspect it will maintain the aspect where -1 in this case (3d) may not.
break ;
case Video3DFormat . FullSideBySide :
vf = "crop=iw/2:ih:0:0,setdar=dar=a,crop=min(iw\\,ih*dar):min(ih\\,iw/dar):(iw-min(iw\\,iw*sar))/2:(ih - min (ih\\,ih/sar))/2,setsar=sar=1,scale=600:trunc(600/dar/2)*2" ;
//fsbs crop width in half,set the display aspect,crop out any black bars we may have made the scale width to 600.
break ;
case Video3DFormat . HalfTopAndBottom :
vf = "crop=iw:ih/2:0:0,scale=(iw*2):ih),setdar=dar=a,crop=min(iw\\,ih*dar):min(ih\\,iw/dar):(iw-min(iw\\,iw*sar))/2:(ih - min (ih\\,ih/sar))/2,setsar=sar=1,scale=600:trunc(600/dar/2)*2" ;
//htab crop heigh in half,scale to correct size, set the display aspect,crop out any black bars we may have made the scale width to 600
break ;
case Video3DFormat . FullTopAndBottom :
vf = "crop=iw:ih/2:0:0,setdar=dar=a,crop=min(iw\\,ih*dar):min(ih\\,iw/dar):(iw-min(iw\\,iw*sar))/2:(ih - min (ih\\,ih/sar))/2,setsar=sar=1,scale=600:trunc(600/dar/2)*2" ;
// ftab crop heigt in half, set the display aspect,crop out any black bars we may have made the scale width to 600
break ;
default :
break ;
}
}
2019-01-08 16:29:34 +00:00
2018-12-14 09:40:55 +00:00
var mapArg = imageStreamIndex . HasValue ? ( " -map 0:v:" + imageStreamIndex . Value . ToString ( CultureInfo . InvariantCulture ) ) : string . Empty ;
var enableThumbnail = ! new List < string > { "wtv" } . Contains ( container ? ? string . Empty , StringComparer . OrdinalIgnoreCase ) ;
// Use ffmpeg to sample 100 (we can drop this if required using thumbnail=50 for 50 frames) frames and pick the best thumbnail. Have a fall back just in case.
var thumbnail = enableThumbnail ? ",thumbnail=24" : string . Empty ;
var args = useIFrame ? string . Format ( "-i {0}{3} -threads 0 -v quiet -vframes 1 -vf \"{2}{4}\" -f image2 \"{1}\"" , inputPath , tempExtractPath , vf , mapArg , thumbnail ) :
string . Format ( "-i {0}{3} -threads 0 -v quiet -vframes 1 -vf \"{2}\" -f image2 \"{1}\"" , inputPath , tempExtractPath , vf , mapArg ) ;
var probeSizeArgument = EncodingHelper . GetProbeSizeArgument ( 1 ) ;
var analyzeDurationArgument = EncodingHelper . GetAnalyzeDurationArgument ( 1 ) ;
if ( ! string . IsNullOrWhiteSpace ( probeSizeArgument ) )
{
args = probeSizeArgument + " " + args ;
}
if ( ! string . IsNullOrWhiteSpace ( analyzeDurationArgument ) )
{
args = analyzeDurationArgument + " " + args ;
}
if ( offset . HasValue )
{
args = string . Format ( "-ss {0} " , GetTimeParameter ( offset . Value ) ) + args ;
}
var encodinghelper = new EncodingHelper ( this , FileSystem , SubtitleEncoder ( ) ) ;
if ( videoStream ! = null )
{
2018-12-27 23:27:57 +00:00
/ * fix
2018-12-14 09:40:55 +00:00
var decoder = encodinghelper . GetHardwareAcceleratedVideoDecoder ( VideoType . VideoFile , videoStream , GetEncodingOptions ( ) ) ;
if ( ! string . IsNullOrWhiteSpace ( decoder ) )
{
args = decoder + " " + args ;
}
2018-12-27 23:27:57 +00:00
* /
2018-12-14 09:40:55 +00:00
}
if ( ! string . IsNullOrWhiteSpace ( container ) )
{
var inputFormat = encodinghelper . GetInputFormat ( container ) ;
if ( ! string . IsNullOrWhiteSpace ( inputFormat ) )
{
args = "-f " + inputFormat + " " + args ;
}
}
var process = _processFactory . Create ( new ProcessOptions
{
CreateNoWindow = true ,
UseShellExecute = false ,
2019-02-08 13:35:26 +00:00
FileName = FFmpegPath ,
2018-12-14 09:40:55 +00:00
Arguments = args ,
IsHidden = true ,
2019-02-24 15:33:05 +00:00
ErrorDialog = false ,
EnableRaisingEvents = true
2018-12-14 09:40:55 +00:00
} ) ;
2018-12-14 23:48:06 +00:00
_logger . LogDebug ( "{0} {1}" , process . StartInfo . FileName , process . StartInfo . Arguments ) ;
2018-12-14 09:40:55 +00:00
using ( var processWrapper = new ProcessWrapper ( process , this , _logger ) )
{
bool ranToCompletion ;
StartProcess ( processWrapper ) ;
var timeoutMs = ConfigurationManager . Configuration . ImageExtractionTimeoutMs ;
if ( timeoutMs < = 0 )
{
timeoutMs = DefaultImageExtractionTimeoutMs ;
}
ranToCompletion = await process . WaitForExitAsync ( timeoutMs ) . ConfigureAwait ( false ) ;
if ( ! ranToCompletion )
{
StopProcess ( processWrapper , 1000 ) ;
}
var exitCode = ranToCompletion ? processWrapper . ExitCode ? ? 0 : - 1 ;
var file = FileSystem . GetFileInfo ( tempExtractPath ) ;
if ( exitCode = = - 1 | | ! file . Exists | | file . Length = = 0 )
{
var msg = string . Format ( "ffmpeg image extraction failed for {0}" , inputPath ) ;
2018-12-14 23:48:06 +00:00
_logger . LogError ( msg ) ;
2018-12-14 09:40:55 +00:00
throw new Exception ( msg ) ;
}
return tempExtractPath ;
}
}
public string GetTimeParameter ( long ticks )
{
var time = TimeSpan . FromTicks ( ticks ) ;
return GetTimeParameter ( time ) ;
}
public string GetTimeParameter ( TimeSpan time )
{
return time . ToString ( @"hh\:mm\:ss\.fff" , UsCulture ) ;
}
public async Task ExtractVideoImagesOnInterval ( string [ ] inputFiles ,
string container ,
MediaStream videoStream ,
MediaProtocol protocol ,
Video3DFormat ? threedFormat ,
TimeSpan interval ,
string targetDirectory ,
string filenamePrefix ,
int? maxWidth ,
CancellationToken cancellationToken )
{
var resourcePool = _thumbnailResourcePool ;
var inputArgument = GetInputArgument ( inputFiles , protocol ) ;
var vf = "fps=fps=1/" + interval . TotalSeconds . ToString ( UsCulture ) ;
if ( maxWidth . HasValue )
{
var maxWidthParam = maxWidth . Value . ToString ( UsCulture ) ;
vf + = string . Format ( ",scale=min(iw\\,{0}):trunc(ow/dar/2)*2" , maxWidthParam ) ;
}
2019-01-26 21:08:04 +00:00
Directory . CreateDirectory ( targetDirectory ) ;
2018-12-14 09:40:55 +00:00
var outputPath = Path . Combine ( targetDirectory , filenamePrefix + "%05d.jpg" ) ;
var args = string . Format ( "-i {0} -threads 0 -v quiet -vf \"{2}\" -f image2 \"{1}\"" , inputArgument , outputPath , vf ) ;
var probeSizeArgument = EncodingHelper . GetProbeSizeArgument ( 1 ) ;
var analyzeDurationArgument = EncodingHelper . GetAnalyzeDurationArgument ( 1 ) ;
if ( ! string . IsNullOrWhiteSpace ( probeSizeArgument ) )
{
args = probeSizeArgument + " " + args ;
}
if ( ! string . IsNullOrWhiteSpace ( analyzeDurationArgument ) )
{
args = analyzeDurationArgument + " " + args ;
}
var encodinghelper = new EncodingHelper ( this , FileSystem , SubtitleEncoder ( ) ) ;
if ( videoStream ! = null )
{
2018-12-27 23:27:57 +00:00
/ * fix
2018-12-14 09:40:55 +00:00
var decoder = encodinghelper . GetHardwareAcceleratedVideoDecoder ( VideoType . VideoFile , videoStream , GetEncodingOptions ( ) ) ;
if ( ! string . IsNullOrWhiteSpace ( decoder ) )
{
args = decoder + " " + args ;
}
2018-12-27 23:27:57 +00:00
* /
2018-12-14 09:40:55 +00:00
}
if ( ! string . IsNullOrWhiteSpace ( container ) )
{
var inputFormat = encodinghelper . GetInputFormat ( container ) ;
if ( ! string . IsNullOrWhiteSpace ( inputFormat ) )
{
args = "-f " + inputFormat + " " + args ;
}
}
var process = _processFactory . Create ( new ProcessOptions
{
CreateNoWindow = true ,
UseShellExecute = false ,
2019-02-08 13:35:26 +00:00
FileName = FFmpegPath ,
2018-12-14 09:40:55 +00:00
Arguments = args ,
IsHidden = true ,
2019-02-24 15:33:05 +00:00
ErrorDialog = false ,
EnableRaisingEvents = true
2018-12-14 09:40:55 +00:00
} ) ;
2018-12-14 23:48:06 +00:00
_logger . LogInformation ( process . StartInfo . FileName + " " + process . StartInfo . Arguments ) ;
2018-12-14 09:40:55 +00:00
await resourcePool . WaitAsync ( cancellationToken ) . ConfigureAwait ( false ) ;
bool ranToCompletion = false ;
using ( var processWrapper = new ProcessWrapper ( process , this , _logger ) )
{
try
{
StartProcess ( processWrapper ) ;
// Need to give ffmpeg enough time to make all the thumbnails, which could be a while,
// but we still need to detect if the process hangs.
// Making the assumption that as long as new jpegs are showing up, everything is good.
bool isResponsive = true ;
int lastCount = 0 ;
while ( isResponsive )
{
if ( await process . WaitForExitAsync ( 30000 ) . ConfigureAwait ( false ) )
{
ranToCompletion = true ;
break ;
}
cancellationToken . ThrowIfCancellationRequested ( ) ;
var jpegCount = FileSystem . GetFilePaths ( targetDirectory )
. Count ( i = > string . Equals ( Path . GetExtension ( i ) , ".jpg" , StringComparison . OrdinalIgnoreCase ) ) ;
isResponsive = ( jpegCount > lastCount ) ;
lastCount = jpegCount ;
}
if ( ! ranToCompletion )
{
StopProcess ( processWrapper , 1000 ) ;
}
}
finally
{
resourcePool . Release ( ) ;
}
var exitCode = ranToCompletion ? processWrapper . ExitCode ? ? 0 : - 1 ;
if ( exitCode = = - 1 )
{
var msg = string . Format ( "ffmpeg image extraction failed for {0}" , inputArgument ) ;
2018-12-14 23:48:06 +00:00
_logger . LogError ( msg ) ;
2018-12-14 09:40:55 +00:00
throw new Exception ( msg ) ;
}
}
}
private void StartProcess ( ProcessWrapper process )
{
process . Process . Start ( ) ;
lock ( _runningProcesses )
{
_runningProcesses . Add ( process ) ;
}
}
private void StopProcess ( ProcessWrapper process , int waitTimeMs )
{
try
{
if ( process . Process . WaitForExit ( waitTimeMs ) )
{
return ;
}
}
catch ( Exception ex )
{
2018-12-20 12:11:26 +00:00
_logger . LogError ( ex , "Error in WaitForExit" ) ;
2018-12-14 09:40:55 +00:00
}
try
{
2018-12-14 23:48:06 +00:00
_logger . LogInformation ( "Killing ffmpeg process" ) ;
2018-12-14 09:40:55 +00:00
process . Process . Kill ( ) ;
}
catch ( Exception ex )
{
2018-12-20 12:11:26 +00:00
_logger . LogError ( ex , "Error killing process" ) ;
2018-12-14 09:40:55 +00:00
}
}
private void StopProcesses ( )
{
List < ProcessWrapper > proceses ;
lock ( _runningProcesses )
{
proceses = _runningProcesses . ToList ( ) ;
_runningProcesses . Clear ( ) ;
}
foreach ( var process in proceses )
{
if ( ! process . HasExited )
{
StopProcess ( process , 500 ) ;
}
}
}
public string EscapeSubtitleFilterPath ( string path )
{
// https://ffmpeg.org/ffmpeg-filters.html#Notes-on-filtergraph-escaping
// We need to double escape
return path . Replace ( '\\' , '/' ) . Replace ( ":" , "\\:" ) . Replace ( "'" , "'\\\\\\''" ) ;
}
/// <summary>
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
/// </summary>
public void Dispose ( )
{
Dispose ( true ) ;
}
/// <summary>
/// Releases unmanaged and - optionally - managed resources.
/// </summary>
/// <param name="dispose"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
protected virtual void Dispose ( bool dispose )
{
if ( dispose )
{
StopProcesses ( ) ;
}
}
public Task ConvertImage ( string inputPath , string outputPath )
{
throw new NotImplementedException ( ) ;
}
public string [ ] GetPlayableStreamFileNames ( string path , VideoType videoType )
{
throw new NotImplementedException ( ) ;
}
public IEnumerable < string > GetPrimaryPlaylistVobFiles ( string path , IIsoMount isoMount , uint? titleNumber )
{
throw new NotImplementedException ( ) ;
}
public bool CanExtractSubtitles ( string codec )
{
2019-01-20 20:03:18 +00:00
// TODO is there ever a case when a subtitle can't be extracted??
return true ;
2018-12-14 09:40:55 +00:00
}
private class ProcessWrapper : IDisposable
{
public readonly IProcess Process ;
public bool HasExited ;
public int? ExitCode ;
private readonly MediaEncoder _mediaEncoder ;
private readonly ILogger _logger ;
public ProcessWrapper ( IProcess process , MediaEncoder mediaEncoder , ILogger logger )
{
Process = process ;
_mediaEncoder = mediaEncoder ;
_logger = logger ;
Process . Exited + = Process_Exited ;
}
void Process_Exited ( object sender , EventArgs e )
{
var process = ( IProcess ) sender ;
HasExited = true ;
try
{
ExitCode = process . ExitCode ;
}
catch
{
}
DisposeProcess ( process ) ;
}
private void DisposeProcess ( IProcess process )
{
lock ( _mediaEncoder . _runningProcesses )
{
_mediaEncoder . _runningProcesses . Remove ( this ) ;
}
try
{
process . Dispose ( ) ;
}
catch
{
}
}
private bool _disposed ;
private readonly object _syncLock = new object ( ) ;
public void Dispose ( )
{
lock ( _syncLock )
{
if ( ! _disposed )
{
if ( Process ! = null )
{
Process . Exited - = Process_Exited ;
DisposeProcess ( Process ) ;
}
}
_disposed = true ;
}
}
}
}
2018-12-27 23:27:57 +00:00
}