Add some analyzers to MediaBrowser.MediaEncoding

2026-02-16 09:32:25 +00:00 · 2020-08-04 17:08:09 +02:00
parent 18efa25a6f
commit 53f99d5d4b
11 changed files with 210 additions and 169 deletions
--- a/MediaBrowser.MediaEncoding/Encoder/EncoderValidator.cs
+++ b/MediaBrowser.MediaEncoding/Encoder/EncoderValidator.cs
@@ -14,7 +14,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
    {
        private const string DefaultEncoderPath = "ffmpeg";

-        private static readonly string[] requiredDecoders = new[]
+        private static readonly string[] _requiredDecoders = new[]
        {
            "h264",
            "hevc",
@@ -57,7 +57,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
            "vc1_opencl"
        };

-        private static readonly string[] requiredEncoders = new[]
+        private static readonly string[] _requiredEncoders = new[]
        {
            "libx264",
            "libx265",
@@ -112,6 +112,12 @@ namespace MediaBrowser.MediaEncoding.Encoder
            _encoderPath = encoderPath;
        }

+        private enum Codec
+        {
+            Encoder,
+            Decoder
+        }
+
        public static Version MinVersion { get; } = new Version(4, 0);

        public static Version MaxVersion { get; } = null;
@@ -195,8 +201,8 @@ namespace MediaBrowser.MediaEncoding.Encoder
        /// If that fails then we use one of the main libraries to determine if it's new/older than the latest
        /// we have stored.
        /// </summary>
-        /// <param name="output"></param>
-        /// <returns></returns>
+        /// <param name="output">The output from "ffmpeg -version".</param>
+        /// <returns>The FFmpeg version.</returns>
        internal static Version GetFFmpegVersion(string output)
        {
            // For pre-built binaries the FFmpeg version should be mentioned at the very start of the output
@@ -218,10 +224,10 @@ namespace MediaBrowser.MediaEncoding.Encoder

        /// <summary>
        /// Grabs the library names and major.minor version numbers from the 'ffmpeg -version' output
-        /// and condenses them on to one line.  Output format is "name1=major.minor,name2=major.minor,etc."
+        /// and condenses them on to one line.  Output format is "name1=major.minor,name2=major.minor,etc.".
        /// </summary>
-        /// <param name="output"></param>
-        /// <returns></returns>
+        /// <param name="output">The 'ffmpeg -version' output.</param>
+        /// <returns>The library names and major.minor version numbers.</returns>
        private static string GetLibrariesVersionString(string output)
        {
            var rc = new StringBuilder(144);
@@ -241,12 +247,6 @@ namespace MediaBrowser.MediaEncoding.Encoder
            return rc.Length == 0 ? null : rc.ToString();
        }

-        private enum Codec
-        {
-            Encoder,
-            Decoder
-        }
-
        private IEnumerable<string> GetHwaccelTypes()
        {
            string output = null;
@@ -264,7 +264,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
                return Enumerable.Empty<string>();
            }

-            var found = output.Split(new char[] {'\r','\n'}, StringSplitOptions.RemoveEmptyEntries).Skip(1).Distinct().ToList();
+            var found = output.Split(new char[] { '\r', '\n' }, StringSplitOptions.RemoveEmptyEntries).Skip(1).Distinct().ToList();
            _logger.LogInformation("Available hwaccel types: {Types}", found);

            return found;
@@ -288,7 +288,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
                return Enumerable.Empty<string>();
            }

-            var required = codec == Codec.Encoder ? requiredEncoders : requiredDecoders;
+            var required = codec == Codec.Encoder ? _requiredEncoders : _requiredDecoders;

            var found = Regex
                .Matches(output, @"^\s\S{6}\s(?<codec>[\w|-]+)\s+.+$", RegexOptions.Multiline)
--- a/MediaBrowser.MediaEncoding/Encoder/MediaEncoder.cs
+++ b/MediaBrowser.MediaEncoding/Encoder/MediaEncoder.cs
@@ -2,6 +2,7 @@

 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Globalization;
 using System.IO;
 using System.Linq;
@@ -21,9 +22,8 @@ using MediaBrowser.Model.Globalization;
 using MediaBrowser.Model.IO;
 using MediaBrowser.Model.MediaInfo;
 using MediaBrowser.Model.System;
-using Microsoft.Extensions.Logging;
-using System.Diagnostics;
 using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;

 namespace MediaBrowser.MediaEncoding.Encoder
 {
@@ -37,6 +37,11 @@ namespace MediaBrowser.MediaEncoding.Encoder
        /// </summary>
        internal const int DefaultImageExtractionTimeout = 5000;

+        /// <summary>
+        /// The us culture.
+        /// </summary>
+        private readonly CultureInfo _usCulture = new CultureInfo("en-US");
+
        private readonly ILogger<MediaEncoder> _logger;
        private readonly IServerConfigurationManager _configurationManager;
        private readonly IFileSystem _fileSystem;
@@ -49,6 +54,10 @@ namespace MediaBrowser.MediaEncoding.Encoder
        private readonly object _runningProcessesLock = new object();
        private readonly List<ProcessWrapper> _runningProcesses = new List<ProcessWrapper>();

+        private List<string> _encoders = new List<string>();
+        private List<string> _decoders = new List<string>();
+        private List<string> _hwaccels = new List<string>();
+
        private string _ffmpegPath = string.Empty;
        private string _ffprobePath;

@@ -79,7 +88,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
        /// <summary>
        /// Run at startup or if the user removes a Custom path from transcode page.
        /// Sets global variables FFmpegPath.
-        /// Precedence is: Config > CLI > $PATH
+        /// Precedence is: Config > CLI > $PATH.
        /// </summary>
        public void SetFFmpegPath()
        {
@@ -124,8 +133,8 @@ namespace MediaBrowser.MediaEncoding.Encoder
        /// 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.
        /// </summary>
-        /// <param name="path"></param>
-        /// <param name="pathType"></param>
+        /// <param name="path">The path.</param>
+        /// <param name="pathType">The path type.</param>
        public void UpdateEncoderPath(string path, string pathType)
        {
            string newPath;
@@ -170,8 +179,8 @@ namespace MediaBrowser.MediaEncoding.Encoder
        /// If checks pass, global variable FFmpegPath and EncoderLocation are updated.
        /// </summary>
        /// <param name="path">FQPN to test.</param>
-        /// <param name="location">Location (External, Custom, System) of tool</param>
-        /// <returns></returns>
+        /// <param name="location">Location (External, Custom, System) of tool.</param>
+        /// <returns><c>true</c> if the version validation succeeded; otherwise, <c>false</c>.</returns>
        private bool ValidatePath(string path, FFmpegLocation location)
        {
            bool rc = false;
@@ -223,8 +232,8 @@ namespace MediaBrowser.MediaEncoding.Encoder
        /// <summary>
        /// Search the system $PATH environment variable looking for given filename.
        /// </summary>
-        /// <param name="fileName"></param>
-        /// <returns></returns>
+        /// <param name="fileName">The filename.</param>
+        /// <returns>The full path to the file.</returns>
        private string ExistsOnSystemPath(string fileName)
        {
            var inJellyfinPath = GetEncoderPathFromDirectory(AppContext.BaseDirectory, fileName, recursive: true);
@@ -248,25 +257,19 @@ namespace MediaBrowser.MediaEncoding.Encoder
            return null;
        }

-        private List<string> _encoders = new List<string>();
        public void SetAvailableEncoders(IEnumerable<string> list)
        {
            _encoders = list.ToList();
-            // _logger.Info("Supported encoders: {0}", string.Join(",", list.ToArray()));
        }

-        private List<string> _decoders = new List<string>();
        public void SetAvailableDecoders(IEnumerable<string> list)
        {
            _decoders = list.ToList();
-            // _logger.Info("Supported decoders: {0}", string.Join(",", list.ToArray()));
        }

-        private List<string> _hwaccels = new List<string>();
        public void SetAvailableHwaccels(IEnumerable<string> list)
        {
            _hwaccels = list.ToList();
-            //_logger.Info("Supported hwaccels: {0}", string.Join(",", list.ToArray()));
        }

        public bool SupportsEncoder(string encoder)
@@ -334,8 +337,16 @@ namespace MediaBrowser.MediaEncoding.Encoder

            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);
+            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>
@@ -344,7 +355,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
        /// <param name="inputFiles">The input files.</param>
        /// <param name="protocol">The protocol.</param>
        /// <returns>System.String.</returns>
-        /// <exception cref="ArgumentException">Unrecognized InputType</exception>
+        /// <exception cref="ArgumentException">Unrecognized InputType.</exception>
        public string GetInputArgument(IReadOnlyList<string> inputFiles, MediaProtocol protocol)
            => EncodingUtils.GetInputArgument(inputFiles, protocol);

@@ -352,7 +363,8 @@ namespace MediaBrowser.MediaEncoding.Encoder
        /// Gets the media info internal.
        /// </summary>
        /// <returns>Task{MediaInfoResult}.</returns>
-        private async Task<MediaInfo> GetMediaInfoInternal(string inputPath,
+        private async Task<MediaInfo> GetMediaInfoInternal(
+            string inputPath,
            string primaryPath,
            MediaProtocol protocol,
            bool extractChapters,
@@ -380,7 +392,6 @@ namespace MediaBrowser.MediaEncoding.Encoder
                    FileName = _ffprobePath,
                    Arguments = args,

-
                    WindowStyle = ProcessWindowStyle.Hidden,
                    ErrorDialog = false,
                },
@@ -441,11 +452,6 @@ namespace MediaBrowser.MediaEncoding.Encoder
            }
        }

-        /// <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);
@@ -461,8 +467,16 @@ namespace MediaBrowser.MediaEncoding.Encoder
            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)
+        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);

@@ -647,7 +661,7 @@ namespace MediaBrowser.MediaEncoding.Encoder

        public string GetTimeParameter(TimeSpan time)
        {
-            return time.ToString(@"hh\:mm\:ss\.fff", UsCulture);
+            return time.ToString(@"hh\:mm\:ss\.fff", _usCulture);
        }

        public async Task ExtractVideoImagesOnInterval(
@@ -664,11 +678,11 @@ namespace MediaBrowser.MediaEncoding.Encoder
        {
            var inputArgument = GetInputArgument(inputFiles, protocol);

-            var vf = "fps=fps=1/" + interval.TotalSeconds.ToString(UsCulture);
+            var vf = "fps=fps=1/" + interval.TotalSeconds.ToString(_usCulture);

            if (maxWidth.HasValue)
            {
-                var maxWidthParam = maxWidth.Value.ToString(UsCulture);
+                var maxWidthParam = maxWidth.Value.ToString(_usCulture);

                vf += string.Format(",scale=min(iw\\,{0}):trunc(ow/dar/2)*2", maxWidthParam);
            }