Better FFmpeg download progress reporting (#840)

* Add FFmpeg download progress reporting to WPF * Update translations * Move expensive console writing off of FFmpeg download thread.
lay295 · Oct 6, 2023 · a7d3bc4 · a7d3bc4
1 parent 8d7982d
commit a7d3bc4
Show file tree

Hide file tree

Showing 10 changed files with 95 additions and 9 deletions.
diff --git a/TwitchDownloaderCLI/Tools/FfmpegHandler.cs b/TwitchDownloaderCLI/Tools/FfmpegHandler.cs
@@ -1,7 +1,10 @@
 using Mono.Unix;
 using System;
+using System.Collections.Concurrent;
 using System.IO;
+using System.Linq;
 using System.Runtime.InteropServices;
+using System.Threading;
 using TwitchDownloaderCLI.Modes.Arguments;
 using Xabe.FFmpeg;
 using Xabe.FFmpeg.Downloader;
@@ -24,8 +27,7 @@ private static void DownloadFfmpeg()
         {
             Console.Write("[INFO] - Downloading FFmpeg");
 
-            var progressHandler = new Progress<ProgressInfo>();
-            progressHandler.ProgressChanged += new XabeProgressHandler().OnProgressReceived;
+            using var progressHandler = new XabeProgressHandler();
 
             if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
             {
@@ -63,20 +65,41 @@ public static void DetectFfmpeg(string ffmpegPath)
             Environment.Exit(1);
         }
 
-        private class XabeProgressHandler
+        private sealed class XabeProgressHandler : IProgress<ProgressInfo>, IDisposable
         {
             private int _lastPercent = -1;
+            private readonly ConcurrentQueue<int> _percentQueue = new();
+            private readonly Timer _timer;
 
-            internal void OnProgressReceived(object sender, ProgressInfo e)
+            public XabeProgressHandler()
             {
-                var percent = (int)(e.DownloadedBytes / (double)e.TotalBytes * 100);
+                _timer = new Timer(Callback, _percentQueue, 0, 100);
+
+                static void Callback(object state)
+                {
+                    if (state is not ConcurrentQueue<int> { IsEmpty: false } queue) return;
+
+                    var currentPercent = queue.Max();
+                    Console.Write($"\r[INFO] - Downloading FFmpeg {currentPercent}%");
+                }
+            }
+
+            public void Report(ProgressInfo value)
+            {
+                var percent = (int)(value.DownloadedBytes / (double)value.TotalBytes * 100);
 
                 if (percent > _lastPercent)
                 {
                     _lastPercent = percent;
-                    Console.Write($"\r[INFO] - Downloading FFmpeg {percent}%");
+                    _percentQueue.Enqueue(percent);
                 }
             }
+
+            public void Dispose()
+            {
+                _timer?.Dispose();
+                _percentQueue.Clear();
+            }
         }
     }
 }
diff --git a/TwitchDownloaderWPF/MainWindow.xaml.cs b/TwitchDownloaderWPF/MainWindow.xaml.cs
@@ -5,6 +5,7 @@
 using System.Net;
 using System.Windows;
 using TwitchDownloaderWPF.Properties;
+using Xabe.FFmpeg;
 using Xabe.FFmpeg.Downloader;
 
 namespace TwitchDownloaderWPF
@@ -69,11 +70,16 @@ private async void Window_Loaded(object sender, RoutedEventArgs e)
                 Settings.Default.Save();
             }
 
+            var currentVersion = Version.Parse("1.53.2");
+            Title = $"Twitch Downloader v{currentVersion}";
+
+            // TODO: extract FFmpeg handling to a dedicated service
             if (!File.Exists("ffmpeg.exe"))
             {
+                var oldTitle = Title;
                 try
                 {
-                    await FFmpegDownloader.GetLatestVersion(FFmpegVersion.Full);
+                    await FFmpegDownloader.GetLatestVersion(FFmpegVersion.Full, new FfmpegDownloadProgress());
                 }
                 catch (Exception ex)
                 {
@@ -88,10 +94,10 @@ private async void Window_Loaded(object sender, RoutedEventArgs e)
                         MessageBox.Show(ex.ToString(), Translations.Strings.VerboseErrorOutput, MessageBoxButton.OK, MessageBoxImage.Error);
                     }
                 }
+
+                Title = oldTitle;
             }
 
-            Version currentVersion = new Version("1.53.2");
-            Title = $"Twitch Downloader v{currentVersion}";
             AutoUpdater.InstalledVersion = currentVersion;
 #if !DEBUG
             if (AppContext.BaseDirectory.StartsWith(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile)))
@@ -102,5 +108,32 @@ private async void Window_Loaded(object sender, RoutedEventArgs e)
             AutoUpdater.Start("https://downloader-update.twitcharchives.workers.dev");
 #endif
         }
+
+        private class FfmpegDownloadProgress : IProgress<ProgressInfo>
+        {
+            private int _lastPercent = -1;
+
+            public void Report(ProgressInfo value)
+            {
+                var percent = (int)(value.DownloadedBytes / (double)value.TotalBytes * 100);
+
+                if (percent > _lastPercent)
+                {
+                    var window = Application.Current.MainWindow;
+                    if (window is null) return;
+
+                    _lastPercent = percent;
+
+                    var oldTitle = window.Title;
+                    if (oldTitle.IndexOf('-') == -1) oldTitle += " -";
+
+                    window.Title = string.Concat(
+                        oldTitle.AsSpan(0, oldTitle.IndexOf('-')),
+                        "- ",
+                        string.Format(Translations.Strings.StatusDownloaderFFmpeg, percent.ToString())
+                    );
+                }
+            }
+        }
     }
 }
diff --git a/TwitchDownloaderWPF/Translations/Strings.Designer.cs b/TwitchDownloaderWPF/Translations/Strings.Designer.cs
diff --git a/TwitchDownloaderWPF/Translations/Strings.es.resx b/TwitchDownloaderWPF/Translations/Strings.es.resx
@@ -775,4 +775,7 @@
   <data name="LabelVideosPerPage" xml:space="preserve">
     <value>Videos per page:</value>
   </data>
+  <data name="StatusDownloaderFFmpeg" xml:space="preserve">
+    <value>Downloading FFmpeg {0}%</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.fr.resx b/TwitchDownloaderWPF/Translations/Strings.fr.resx
@@ -774,4 +774,7 @@
   <data name="LabelVideosPerPage" xml:space="preserve">
     <value>Vidéos par page:</value>
   </data>
+  <data name="StatusDownloaderFFmpeg" xml:space="preserve">
+    <value>Downloading FFmpeg {0}%</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.pl.resx b/TwitchDownloaderWPF/Translations/Strings.pl.resx
@@ -774,4 +774,7 @@
   <data name="LabelVideosPerPage" xml:space="preserve">
     <value>Videos per page:</value>
   </data>
+  <data name="StatusDownloaderFFmpeg" xml:space="preserve">
+    <value>Downloading FFmpeg {0}%</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.resx b/TwitchDownloaderWPF/Translations/Strings.resx
@@ -773,4 +773,7 @@
   <data name="LabelVideosPerPage" xml:space="preserve">
     <value>Videos per page:</value>
   </data>
+  <data name="StatusDownloaderFFmpeg" xml:space="preserve">
+    <value>Downloading FFmpeg {0}%</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.ru.resx b/TwitchDownloaderWPF/Translations/Strings.ru.resx
@@ -774,4 +774,7 @@
   <data name="LabelVideosPerPage" xml:space="preserve">
     <value>Videos per page:</value>
   </data>
+  <data name="StatusDownloaderFFmpeg" xml:space="preserve">
+    <value>Downloading FFmpeg {0}%</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.tr.resx b/TwitchDownloaderWPF/Translations/Strings.tr.resx
@@ -775,4 +775,7 @@
   <data name="LabelVideosPerPage" xml:space="preserve">
     <value>Videos per page:</value>
   </data>
+  <data name="StatusDownloaderFFmpeg" xml:space="preserve">
+    <value>Downloading FFmpeg {0}%</value>
+  </data>
 </root>
diff --git a/TwitchDownloaderWPF/Translations/Strings.zh.resx b/TwitchDownloaderWPF/Translations/Strings.zh.resx
@@ -773,4 +773,7 @@
   <data name="LabelVideosPerPage" xml:space="preserve">
     <value>Videos per page:</value>
   </data>
+  <data name="StatusDownloaderFFmpeg" xml:space="preserve">
+    <value>Downloading FFmpeg {0}%</value>
+  </data>
 </root>