2020-08-04 16:20:52 +02:00
#pragma warning disable CS1591
2019-01-13 21:02:23 +01:00
using System ;
2018-12-14 10:40:55 +01:00
using System.Collections.Generic ;
2019-09-28 01:29:54 +02:00
using System.Diagnostics ;
2019-01-02 01:23:49 +01:00
using System.Linq ;
2019-09-28 01:29:54 +02:00
using System.Text ;
2019-01-02 10:48:10 +01:00
using System.Text.RegularExpressions ;
2018-12-15 00:48:06 +01:00
using Microsoft.Extensions.Logging ;
2018-12-14 10:40:55 +01:00
namespace MediaBrowser.MediaEncoding.Encoder
{
public class EncoderValidator
{
2019-09-28 01:29:54 +02:00
private const string DefaultEncoderPath = "ffmpeg" ;
2018-12-14 10:40:55 +01:00
2020-06-01 07:10:15 +02:00
private static readonly string [ ] _requiredDecoders = new [ ]
2018-12-14 10:40:55 +01:00
{
2020-04-08 18:15:01 +02:00
"h264" ,
"hevc" ,
2019-09-28 01:29:54 +02:00
"mpeg2video" ,
2020-04-08 18:15:01 +02:00
"mpeg4" ,
"msmpeg4" ,
"dts" ,
"ac3" ,
"aac" ,
"mp3" ,
2019-09-28 01:29:54 +02:00
"h264_qsv" ,
"hevc_qsv" ,
"mpeg2_qsv" ,
"vc1_qsv" ,
2020-04-08 18:15:01 +02:00
"vp8_qsv" ,
"vp9_qsv" ,
2019-09-28 01:29:54 +02:00
"h264_cuvid" ,
"hevc_cuvid" ,
2020-04-08 18:15:01 +02:00
"mpeg2_cuvid" ,
"vc1_cuvid" ,
"mpeg4_cuvid" ,
"vp8_cuvid" ,
"vp9_cuvid" ,
2019-11-25 23:09:23 +01:00
"h264_mmal" ,
2020-04-08 18:15:01 +02:00
"mpeg2_mmal" ,
"mpeg4_mmal" ,
"vc1_mmal" ,
"h264_mediacodec" ,
"hevc_mediacodec" ,
"mpeg2_mediacodec" ,
"mpeg4_mediacodec" ,
"vp8_mediacodec" ,
2020-05-26 17:41:38 +02:00
"vp9_mediacodec" ,
2020-05-29 16:20:47 +02:00
"h264_opencl" ,
"hevc_opencl" ,
"mpeg2_opencl" ,
"mpeg4_opencl" ,
"vp8_opencl" ,
"vp9_opencl" ,
"vc1_opencl"
2019-09-28 01:29:54 +02:00
} ;
2018-12-14 10:40:55 +01:00
2020-06-01 07:10:15 +02:00
private static readonly string [ ] _requiredEncoders = new [ ]
2019-09-28 01:29:54 +02:00
{
"libx264" ,
"libx265" ,
"mpeg4" ,
"msmpeg4" ,
"libvpx" ,
"libvpx-vp9" ,
"aac" ,
2020-03-30 09:53:49 +02:00
"libfdk_aac" ,
2020-04-08 18:15:01 +02:00
"ac3" ,
2019-09-28 01:29:54 +02:00
"libmp3lame" ,
"libopus" ,
"libvorbis" ,
"srt" ,
2020-04-08 18:15:01 +02:00
"h264_amf" ,
"hevc_amf" ,
2019-09-28 01:29:54 +02:00
"h264_qsv" ,
"hevc_qsv" ,
2020-04-08 18:15:01 +02:00
"h264_nvenc" ,
"hevc_nvenc" ,
2019-09-28 01:29:54 +02:00
"h264_vaapi" ,
"hevc_vaapi" ,
2020-04-08 18:15:01 +02:00
"h264_omx" ,
"hevc_omx" ,
2019-09-28 01:29:54 +02:00
"h264_v4l2m2m" ,
2020-05-26 17:41:38 +02:00
"h264_videotoolbox" ,
2020-05-25 23:58:29 +02:00
"hevc_videotoolbox"
2019-09-28 01:29:54 +02:00
} ;
2020-06-01 07:10:15 +02:00
// These are the library versions that corresponds to our minimum ffmpeg version 4.x according to the version table below
2020-06-15 15:10:59 +02:00
private static readonly IReadOnlyDictionary < string , Version > _ffmpegMinimumLibraryVersions = new Dictionary < string , Version >
2020-06-01 07:10:15 +02:00
{
2020-06-15 15:10:59 +02:00
{ "libavutil" , new Version ( 56 , 14 ) } ,
{ "libavcodec" , new Version ( 58 , 18 ) } ,
{ "libavformat" , new Version ( 58 , 12 ) } ,
{ "libavdevice" , new Version ( 58 , 3 ) } ,
{ "libavfilter" , new Version ( 7 , 16 ) } ,
{ "libswscale" , new Version ( 5 , 1 ) } ,
{ "libswresample" , new Version ( 3 , 1 ) } ,
{ "libpostproc" , new Version ( 55 , 1 ) }
2020-06-01 07:10:15 +02:00
} ;
2019-09-28 01:29:54 +02:00
private readonly ILogger _logger ;
2018-12-14 10:40:55 +01:00
2019-09-28 01:29:54 +02:00
private readonly string _encoderPath ;
2018-12-14 10:40:55 +01:00
2019-09-28 01:29:54 +02:00
public EncoderValidator ( ILogger logger , string encoderPath = DefaultEncoderPath )
{
_logger = logger ;
_encoderPath = encoderPath ;
2018-12-14 10:40:55 +01:00
}
2020-08-04 17:08:09 +02:00
private enum Codec
{
Encoder ,
Decoder
}
2020-08-20 17:16:09 +02:00
// When changing this, also change the minimum library versions in _ffmpegMinimumLibraryVersions
2019-09-28 01:29:54 +02:00
public static Version MinVersion { get ; } = new Version ( 4 , 0 ) ;
public static Version MaxVersion { get ; } = null ;
public bool ValidateVersion ( )
2018-12-14 10:40:55 +01:00
{
2019-01-02 01:23:49 +01:00
string output = null ;
2018-12-14 10:40:55 +01:00
try
{
2019-09-28 01:29:54 +02:00
output = GetProcessOutput ( _encoderPath , "-version" ) ;
2018-12-14 10:40:55 +01:00
}
catch ( Exception ex )
{
2019-09-28 01:29:54 +02:00
_logger . LogError ( ex , "Error validating encoder" ) ;
2018-12-14 10:40:55 +01:00
}
if ( string . IsNullOrWhiteSpace ( output ) )
{
2019-09-28 01:29:54 +02:00
_logger . LogError ( "FFmpeg validation: The process returned no result" ) ;
2018-12-14 10:40:55 +01:00
return false ;
}
2019-01-05 22:40:33 +01:00
_logger . LogDebug ( "ffmpeg output: {Output}" , output ) ;
2018-12-14 10:40:55 +01:00
2019-09-28 01:29:54 +02:00
return ValidateVersionInternal ( output ) ;
}
internal bool ValidateVersionInternal ( string versionOutput )
{
if ( versionOutput . IndexOf ( "Libav developers" , StringComparison . OrdinalIgnoreCase ) ! = - 1 )
2018-12-14 10:40:55 +01:00
{
2019-09-28 01:29:54 +02:00
_logger . LogError ( "FFmpeg validation: avconv instead of ffmpeg is not supported" ) ;
2018-12-14 10:40:55 +01:00
return false ;
}
2019-02-14 23:01:09 +01:00
// Work out what the version under test is
2019-09-28 01:29:54 +02:00
var version = GetFFmpegVersion ( versionOutput ) ;
2019-02-14 23:01:09 +01:00
2020-06-01 07:10:15 +02:00
_logger . LogInformation ( "Found ffmpeg version {Version}" , version ! = null ? version . ToString ( ) : "unknown" ) ;
2019-02-16 00:51:22 +01:00
2019-09-29 13:41:24 +02:00
if ( version = = null )
2019-09-28 01:29:54 +02:00
{
2020-06-01 07:10:15 +02:00
if ( MaxVersion ! = null ) // Version is unknown
2019-02-14 23:01:09 +01:00
{
2019-09-29 13:41:24 +02:00
if ( MinVersion = = MaxVersion )
{
2020-06-01 07:10:15 +02:00
_logger . LogWarning ( "FFmpeg validation: We recommend version {MinVersion}" , MinVersion ) ;
2019-09-29 13:41:24 +02:00
}
else
{
2020-06-01 07:10:15 +02:00
_logger . LogWarning ( "FFmpeg validation: We recommend a minimum of {MinVersion} and maximum of {MaxVersion}" , MinVersion , MaxVersion ) ;
2019-09-29 13:41:24 +02:00
}
2019-02-14 23:01:09 +01:00
}
2020-06-01 07:10:15 +02:00
else
{
_logger . LogWarning ( "FFmpeg validation: We recommend minimum version {MinVersion}" , MinVersion ) ;
}
2019-09-28 01:29:54 +02:00
return false ;
}
2020-06-01 07:10:15 +02:00
else if ( version < MinVersion ) // Version is below what we recommend
2019-09-28 01:29:54 +02:00
{
2020-06-01 07:10:15 +02:00
_logger . LogWarning ( "FFmpeg validation: The minimum recommended version is {MinVersion}" , MinVersion ) ;
2019-09-28 01:29:54 +02:00
return false ;
}
else if ( MaxVersion ! = null & & version > MaxVersion ) // Version is above what we recommend
{
2020-06-01 07:10:15 +02:00
_logger . LogWarning ( "FFmpeg validation: The maximum recommended version is {MaxVersion}" , MaxVersion ) ;
2019-09-28 01:29:54 +02:00
return false ;
2019-02-14 23:01:09 +01:00
}
2019-09-28 01:29:54 +02:00
return true ;
2019-02-14 23:01:09 +01:00
}
2019-09-28 01:29:54 +02:00
public IEnumerable < string > GetDecoders ( ) = > GetCodecs ( Codec . Decoder ) ;
public IEnumerable < string > GetEncoders ( ) = > GetCodecs ( Codec . Encoder ) ;
2020-04-08 18:15:01 +02:00
public IEnumerable < string > GetHwaccels ( ) = > GetHwaccelTypes ( ) ;
2019-02-14 23:01:09 +01:00
/// <summary>
/// Using the output from "ffmpeg -version" work out the FFmpeg version.
/// For pre-built binaries the first line should contain a string like "ffmpeg version x.y", which is easy
2020-06-01 07:10:15 +02:00
/// to parse. If this is not available, then we try to match known library versions to FFmpeg versions.
/// If that fails then we test the libraries to determine if they're newer than our minimum versions.
2019-02-14 23:01:09 +01:00
/// </summary>
2020-08-04 17:08:09 +02:00
/// <param name="output">The output from "ffmpeg -version".</param>
/// <returns>The FFmpeg version.</returns>
2020-06-01 07:10:15 +02:00
internal Version GetFFmpegVersion ( string output )
2019-02-14 23:01:09 +01:00
{
// For pre-built binaries the FFmpeg version should be mentioned at the very start of the output
2020-07-20 14:14:15 +02:00
var match = Regex . Match ( output , @"^ffmpeg version n?((?:[0-9]+\.?)+)" ) ;
2019-02-14 23:01:09 +01:00
if ( match . Success )
{
2019-02-27 19:20:48 +01:00
return new Version ( match . Groups [ 1 ] . Value ) ;
2019-02-14 23:01:09 +01:00
}
2020-06-01 07:10:15 +02:00
2020-08-20 17:16:09 +02:00
var versionMap = GetFFmpegLibraryVersions ( output ) ;
2020-06-01 07:10:15 +02:00
var allVersionsValidated = true ;
2019-02-14 23:01:09 +01:00
2020-06-01 07:10:15 +02:00
foreach ( var minimumVersion in _ffmpegMinimumLibraryVersions )
{
if ( versionMap . TryGetValue ( minimumVersion . Key , out var foundVersion ) )
{
if ( foundVersion > = minimumVersion . Value )
{
_logger . LogInformation ( "Found {Library} version {FoundVersion} ({MinimumVersion})" , minimumVersion . Key , foundVersion , minimumVersion . Value ) ;
}
else
{
_logger . LogWarning ( "Found {Library} version {FoundVersion} lower than recommended version {MinimumVersion}" , minimumVersion . Key , foundVersion , minimumVersion . Value ) ;
allVersionsValidated = false ;
}
}
else
{
_logger . LogError ( "{Library} version not found" , minimumVersion . Key ) ;
allVersionsValidated = false ;
}
2019-02-14 23:01:09 +01:00
}
2020-06-01 07:10:15 +02:00
return allVersionsValidated ? MinVersion : null ;
2019-02-14 23:01:09 +01:00
}
/// <summary>
/// Grabs the library names and major.minor version numbers from the 'ffmpeg -version' output
2020-08-04 17:08:09 +02:00
/// and condenses them on to one line. Output format is "name1=major.minor,name2=major.minor,etc.".
2019-02-14 23:01:09 +01:00
/// </summary>
2020-08-04 17:08:09 +02:00
/// <param name="output">The 'ffmpeg -version' output.</param>
/// <returns>The library names and major.minor version numbers.</returns>
2020-08-20 17:16:09 +02:00
private static IReadOnlyDictionary < string , Version > GetFFmpegLibraryVersions ( string output )
2019-02-14 23:01:09 +01:00
{
2020-06-15 15:10:59 +02:00
var map = new Dictionary < string , Version > ( ) ;
2020-06-01 07:10:15 +02:00
foreach ( Match match in Regex . Matches (
2019-09-28 01:29:54 +02:00
output ,
2020-07-20 14:14:15 +02:00
@"((?<name>lib\w+)\s+(?<major>[0-9]+)\.\s*(?<minor>[0-9]+))" ,
2019-09-28 01:29:54 +02:00
RegexOptions . Multiline ) )
2019-02-14 23:01:09 +01:00
{
2020-08-20 17:16:09 +02:00
var version = new Version (
int . Parse ( match . Groups [ "major" ] . Value ) ,
int . Parse ( match . Groups [ "minor" ] . Value ) ) ;
2020-06-15 15:10:59 +02:00
map . Add ( match . Groups [ "name" ] . Value , version ) ;
2018-12-14 10:40:55 +01:00
}
2020-08-20 17:16:09 +02:00
return map ;
2018-12-14 10:40:55 +01:00
}
2020-04-08 18:15:01 +02:00
private IEnumerable < string > GetHwaccelTypes ( )
{
string output = null ;
try
{
output = GetProcessOutput ( _encoderPath , "-hwaccels" ) ;
}
catch ( Exception ex )
{
_logger . LogError ( ex , "Error detecting available hwaccel types" ) ;
}
if ( string . IsNullOrWhiteSpace ( output ) )
{
return Enumerable . Empty < string > ( ) ;
}
2020-08-04 17:08:09 +02:00
var found = output . Split ( new char [ ] { '\r' , '\n' } , StringSplitOptions . RemoveEmptyEntries ) . Skip ( 1 ) . Distinct ( ) . ToList ( ) ;
2020-04-08 18:15:01 +02:00
_logger . LogInformation ( "Available hwaccel types: {Types}" , found ) ;
return found ;
}
2019-09-28 01:29:54 +02:00
private IEnumerable < string > GetCodecs ( Codec codec )
2019-01-02 10:48:10 +01:00
{
string codecstr = codec = = Codec . Encoder ? "encoders" : "decoders" ;
string output = null ;
try
{
2019-09-28 01:29:54 +02:00
output = GetProcessOutput ( _encoderPath , "-" + codecstr ) ;
2019-01-02 10:48:10 +01:00
}
catch ( Exception ex )
{
_logger . LogError ( ex , "Error detecting available {Codec}" , codecstr ) ;
}
if ( string . IsNullOrWhiteSpace ( output ) )
{
return Enumerable . Empty < string > ( ) ;
}
2020-06-01 07:10:15 +02:00
var required = codec = = Codec . Encoder ? _requiredEncoders : _requiredDecoders ;
2019-01-02 10:48:10 +01:00
2019-01-02 11:32:35 +01:00
var found = Regex
. Matches ( output , @"^\s\S{6}\s(?<codec>[\w|-]+)\s+.+$" , RegexOptions . Multiline )
. Cast < Match > ( )
2019-01-02 10:48:10 +01:00
. Select ( x = > x . Groups [ "codec" ] . Value )
. Where ( x = > required . Contains ( x ) ) ;
_logger . LogInformation ( "Available {Codec}: {Codecs}" , codecstr , found ) ;
2019-01-02 01:01:36 +01:00
2018-12-14 10:40:55 +01:00
return found ;
}
private string GetProcessOutput ( string path , string arguments )
{
2019-09-28 01:29:54 +02:00
using ( var process = new Process ( )
2018-12-14 10:40:55 +01:00
{
2019-09-28 01:29:54 +02:00
StartInfo = new ProcessStartInfo ( path , arguments )
{
CreateNoWindow = true ,
UseShellExecute = false ,
WindowStyle = ProcessWindowStyle . Hidden ,
ErrorDialog = false ,
RedirectStandardOutput = true ,
// ffmpeg uses stderr to log info, don't show this
RedirectStandardError = true
}
} )
2018-12-14 10:40:55 +01:00
{
2019-09-28 01:29:54 +02:00
_logger . LogDebug ( "Running {Path} {Arguments}" , path , arguments ) ;
2018-12-14 10:40:55 +01:00
process . Start ( ) ;
2019-09-28 01:29:54 +02:00
return process . StandardOutput . ReadToEnd ( ) ;
2018-12-14 10:40:55 +01:00
}
}
}
}