From be965e35b680de9362a09eeee2879e8867911656 Mon Sep 17 00:00:00 2001
From: Bond_009 <bond.009@outlook.com>
Date: Fri, 8 Jan 2021 23:21:50 +0100
Subject: [PATCH] Log subtitle errors

---
 .../Subtitles/AssParser.cs                    |  8 +++++++
 .../Subtitles/SrtParser.cs                    |  8 +++++++
 .../Subtitles/SsaParser.cs                    |  8 +++++++
 .../Subtitles/SubtitleEditParser.cs           | 22 +++++++++++++++++--
 .../Subtitles/SubtitleEncoder.cs              |  6 ++---
 .../Subtitles/AssParserTests.cs               |  3 ++-
 .../Subtitles/SrtParserTests.cs               |  3 ++-
 .../Subtitles/SsaParserTests.cs               |  3 ++-
 8 files changed, 53 insertions(+), 8 deletions(-)

diff --git a/MediaBrowser.MediaEncoding/Subtitles/AssParser.cs b/MediaBrowser.MediaEncoding/Subtitles/AssParser.cs
index cdfd87bad0..8219aa7b47 100644
--- a/MediaBrowser.MediaEncoding/Subtitles/AssParser.cs
+++ b/MediaBrowser.MediaEncoding/Subtitles/AssParser.cs
@@ -1,5 +1,6 @@
 #nullable enable
 
+using Microsoft.Extensions.Logging;
 using Nikse.SubtitleEdit.Core.SubtitleFormats;
 
 namespace MediaBrowser.MediaEncoding.Subtitles
@@ -9,5 +10,12 @@ namespace MediaBrowser.MediaEncoding.Subtitles
     /// </summary>
     public class AssParser : SubtitleEditParser<AdvancedSubStationAlpha>
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AssParser"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        public AssParser(ILogger logger) : base(logger)
+        {
+        }
     }
 }
diff --git a/MediaBrowser.MediaEncoding/Subtitles/SrtParser.cs b/MediaBrowser.MediaEncoding/Subtitles/SrtParser.cs
index 7a7196f6c3..19fb951dc5 100644
--- a/MediaBrowser.MediaEncoding/Subtitles/SrtParser.cs
+++ b/MediaBrowser.MediaEncoding/Subtitles/SrtParser.cs
@@ -1,5 +1,6 @@
 #nullable enable
 
+using Microsoft.Extensions.Logging;
 using Nikse.SubtitleEdit.Core.SubtitleFormats;
 
 namespace MediaBrowser.MediaEncoding.Subtitles
@@ -9,5 +10,12 @@ namespace MediaBrowser.MediaEncoding.Subtitles
     /// </summary>
     public class SrtParser : SubtitleEditParser<SubRip>
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SrtParser"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        public SrtParser(ILogger logger) : base(logger)
+        {
+        }
     }
 }
diff --git a/MediaBrowser.MediaEncoding/Subtitles/SsaParser.cs b/MediaBrowser.MediaEncoding/Subtitles/SsaParser.cs
index 8cd06194d9..36dc2e01fc 100644
--- a/MediaBrowser.MediaEncoding/Subtitles/SsaParser.cs
+++ b/MediaBrowser.MediaEncoding/Subtitles/SsaParser.cs
@@ -1,5 +1,6 @@
 #nullable enable
 
+using Microsoft.Extensions.Logging;
 using Nikse.SubtitleEdit.Core.SubtitleFormats;
 
 namespace MediaBrowser.MediaEncoding.Subtitles
@@ -9,5 +10,12 @@ namespace MediaBrowser.MediaEncoding.Subtitles
     /// </summary>
     public class SsaParser : SubtitleEditParser<SubStationAlpha>
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SsaParser"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        public SsaParser(ILogger logger) : base(logger)
+        {
+        }
     }
 }
diff --git a/MediaBrowser.MediaEncoding/Subtitles/SubtitleEditParser.cs b/MediaBrowser.MediaEncoding/Subtitles/SubtitleEditParser.cs
index 441b9ce332..82ec6ca217 100644
--- a/MediaBrowser.MediaEncoding/Subtitles/SubtitleEditParser.cs
+++ b/MediaBrowser.MediaEncoding/Subtitles/SubtitleEditParser.cs
@@ -6,17 +6,31 @@ using System.Linq;
 using System.Threading;
 using MediaBrowser.Common.Extensions;
 using MediaBrowser.Model.MediaInfo;
+using Microsoft.Extensions.Logging;
 using Nikse.SubtitleEdit.Core;
+using ILogger = Microsoft.Extensions.Logging.ILogger;
+using SubtitleFormat = Nikse.SubtitleEdit.Core.SubtitleFormats.SubtitleFormat;
 
 namespace MediaBrowser.MediaEncoding.Subtitles
 {
     /// <summary>
     /// SubStation Alpha subtitle parser.
     /// </summary>
-    /// <typeparam name="T">The <see cref="Nikse.SubtitleEdit.Core.SubtitleFormats.SubtitleFormat" />.</typeparam>
+    /// <typeparam name="T">The <see cref="SubtitleFormat" />.</typeparam>
     public abstract class SubtitleEditParser<T> : ISubtitleParser
-        where T : Nikse.SubtitleEdit.Core.SubtitleFormats.SubtitleFormat, new()
+        where T : SubtitleFormat, new()
     {
+        private readonly ILogger _logger;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SubtitleEditParser{T}"/> class.
+        /// </summary>
+        /// <param name="logger">The logger.</param>
+        protected SubtitleEditParser(ILogger logger)
+        {
+            _logger = logger;
+        }
+
         /// <inheritdoc />
         public SubtitleTrackInfo Parse(Stream stream, CancellationToken cancellationToken)
         {
@@ -24,6 +38,10 @@ namespace MediaBrowser.MediaEncoding.Subtitles
             var subRip = new T();
             var lines = stream.ReadAllLines().ToList();
             subRip.LoadSubtitle(subtitle, lines, "untitled");
+            if (subRip.ErrorCount > 0)
+            {
+                _logger.LogError("{ErrorCount} errors encountered while parsing subtitle.");
+            }
 
             var trackInfo = new SubtitleTrackInfo();
             int len = subtitle.Paragraphs.Count;
diff --git a/MediaBrowser.MediaEncoding/Subtitles/SubtitleEncoder.cs b/MediaBrowser.MediaEncoding/Subtitles/SubtitleEncoder.cs
index 62ac83c91b..a9d118ef58 100644
--- a/MediaBrowser.MediaEncoding/Subtitles/SubtitleEncoder.cs
+++ b/MediaBrowser.MediaEncoding/Subtitles/SubtitleEncoder.cs
@@ -271,17 +271,17 @@ namespace MediaBrowser.MediaEncoding.Subtitles
 
             if (string.Equals(format, SubtitleFormat.SRT, StringComparison.OrdinalIgnoreCase))
             {
-                return new SrtParser();
+                return new SrtParser(_logger);
             }
 
             if (string.Equals(format, SubtitleFormat.SSA, StringComparison.OrdinalIgnoreCase))
             {
-                return new SsaParser();
+                return new SsaParser(_logger);
             }
 
             if (string.Equals(format, SubtitleFormat.ASS, StringComparison.OrdinalIgnoreCase))
             {
-                return new AssParser();
+                return new AssParser(_logger);
             }
 
             if (throwIfMissing)
diff --git a/tests/Jellyfin.MediaEncoding.Tests/Subtitles/AssParserTests.cs b/tests/Jellyfin.MediaEncoding.Tests/Subtitles/AssParserTests.cs
index 457ef45446..f38fc23d5e 100644
--- a/tests/Jellyfin.MediaEncoding.Tests/Subtitles/AssParserTests.cs
+++ b/tests/Jellyfin.MediaEncoding.Tests/Subtitles/AssParserTests.cs
@@ -3,6 +3,7 @@ using System.Globalization;
 using System.IO;
 using System.Threading;
 using MediaBrowser.MediaEncoding.Subtitles;
+using Microsoft.Extensions.Logging.Abstractions;
 using Xunit;
 
 namespace Jellyfin.MediaEncoding.Subtitles.Tests
@@ -14,7 +15,7 @@ namespace Jellyfin.MediaEncoding.Subtitles.Tests
         {
             using (var stream = File.OpenRead("Test Data/example.ass"))
             {
-                var parsed = new AssParser().Parse(stream, CancellationToken.None);
+                var parsed = new AssParser(new NullLogger<AssParser>()).Parse(stream, CancellationToken.None);
                 Assert.Single(parsed.TrackEvents);
                 var trackEvent = parsed.TrackEvents[0];
 
diff --git a/tests/Jellyfin.MediaEncoding.Tests/Subtitles/SrtParserTests.cs b/tests/Jellyfin.MediaEncoding.Tests/Subtitles/SrtParserTests.cs
index 6bfc426cb1..25b8b47461 100644
--- a/tests/Jellyfin.MediaEncoding.Tests/Subtitles/SrtParserTests.cs
+++ b/tests/Jellyfin.MediaEncoding.Tests/Subtitles/SrtParserTests.cs
@@ -3,6 +3,7 @@ using System.Globalization;
 using System.IO;
 using System.Threading;
 using MediaBrowser.MediaEncoding.Subtitles;
+using Microsoft.Extensions.Logging.Abstractions;
 using Xunit;
 
 namespace Jellyfin.MediaEncoding.Subtitles.Tests
@@ -14,7 +15,7 @@ namespace Jellyfin.MediaEncoding.Subtitles.Tests
         {
             using (var stream = File.OpenRead("Test Data/example.srt"))
             {
-                var parsed = new SrtParser().Parse(stream, CancellationToken.None);
+                var parsed = new SrtParser(new NullLogger<SrtParser>()).Parse(stream, CancellationToken.None);
                 Assert.Equal(2, parsed.TrackEvents.Count);
 
                 var trackEvent1 = parsed.TrackEvents[0];
diff --git a/tests/Jellyfin.MediaEncoding.Tests/Subtitles/SsaParserTests.cs b/tests/Jellyfin.MediaEncoding.Tests/Subtitles/SsaParserTests.cs
index 660b7f1be6..0ff7cb1ec3 100644
--- a/tests/Jellyfin.MediaEncoding.Tests/Subtitles/SsaParserTests.cs
+++ b/tests/Jellyfin.MediaEncoding.Tests/Subtitles/SsaParserTests.cs
@@ -3,6 +3,7 @@ using System.Globalization;
 using System.IO;
 using System.Threading;
 using MediaBrowser.MediaEncoding.Subtitles;
+using Microsoft.Extensions.Logging.Abstractions;
 using Xunit;
 
 namespace Jellyfin.MediaEncoding.Subtitles.Tests
@@ -14,7 +15,7 @@ namespace Jellyfin.MediaEncoding.Subtitles.Tests
         {
             using (var stream = File.OpenRead("Test Data/example.ssa"))
             {
-                var parsed = new SsaParser().Parse(stream, CancellationToken.None);
+                var parsed = new SsaParser(new NullLogger<SsaParser>()).Parse(stream, CancellationToken.None);
                 Assert.Single(parsed.TrackEvents);
                 var trackEvent = parsed.TrackEvents[0];