better-ffmpeg-progress 2.5.3__tar.gz → 2.5.5__tar.gz

{better_ffmpeg_progress-2.5.3 → better_ffmpeg_progress-2.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.5.3
+Version: 2.5.5
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -171,3 +171,5 @@ The `run` method takes the following **optional** arguments:
 [12/11/2024]
 - [v2.5.2] Drain any remaining FFmpeg stderr after the process ends.
 - [v2.5.3] Write FFmpeg stderr to the log file in real time.
+- [v2.5.4] Include progress info in stderr if the duration of the input file cannot be detected.
+- [v2.5.5] Print detected errors in the terminal and only set `shell=True` if shell operators are detected.

{better_ffmpeg_progress-2.5.3 → better_ffmpeg_progress-2.5.5}/README.md

@@ -152,4 +152,6 @@ The `run` method takes the following **optional** arguments:
 
 [12/11/2024]
 - [v2.5.2] Drain any remaining FFmpeg stderr after the process ends.
-- [v2.5.3] Write FFmpeg stderr to the log file in real time.
+- [v2.5.3] Write FFmpeg stderr to the log file in real time.
+- [v2.5.4] Include progress info in stderr if the duration of the input file cannot be detected.
+- [v2.5.5] Print detected errors in the terminal and only set `shell=True` if shell operators are detected.

{better_ffmpeg_progress-2.5.3 → better_ffmpeg_progress-2.5.5}/better_ffmpeg_progress/better_ffmpeg_progress.py

@@ -58,8 +58,6 @@ class FfmpegProcess:
 
         # -progress pipe:1 sends progress metrics to stdout
         # -stats_period sets the period at which encoding progress/statistics are updated
-        # -nostats ensures that progress information is not sent to stderr as this info is not needed in the log file, e.g.
-        # frame= 1381 fps=254 q=18.0 size=   46592KiB time=00:00:46.07 bitrate=8283.1kbits/s speed=8.47x
         command.extend(
             [
                 "-loglevel",
@@ -68,7 +66,6 @@ class FfmpegProcess:
                 "pipe:1",
                 "-stats_period",
                 "0.1",
-                "-nostats",
             ]
         )
 
@@ -80,6 +77,7 @@ class FfmpegProcess:
         self._duration_secs: Optional[float] = None
         self._current_size: int = 0
         self._ffmpeg_log_file: Optional[Path] = None
+        self._error_messages: list[str] = []
 
         self._get_input_file_duration()
 
@@ -97,6 +95,9 @@ class FfmpegProcess:
                 print(
                     f"The duration of {self._input_filepath.name} has been detected as {self._duration_secs} seconds"
                 )
+                # -nostats ensures that progress information is not sent to stderr as this info is not needed in the log file, e.g.
+                # frame= 1381 fps=254 q=18.0 size=   46592KiB time=00:00:46.07 bitrate=8283.1kbits/s speed=8.47x
+                self._ffmpeg_command.extend(["-nostats"])
         except Exception:
             print(
                 f"Could not detect the duration of '{self._input_filepath.name}'. Percentage progress, ETA and estimated filesize will be unavailable.\n",
@@ -166,6 +167,11 @@ class FfmpegProcess:
         finally:
             pipe.close()
 
+    def _contains_shell_operators(self, command: List[str]) -> bool:
+        """Check if the command contains shell operators."""
+        shell_operators = {"|", ">", "<", ">>", "&&", "||"}
+        return any(op in command for op in shell_operators)
+
     def _start_process(
         self,
         progress_bar: Optional[Progress],
@@ -174,16 +180,22 @@ class FfmpegProcess:
     ) -> int:
         creationflags = subprocess.CREATE_NEW_PROCESS_GROUP if os.name == "nt" else 0
 
+        # If command contains shell operators, turn the list into a string.
+        if self._contains_shell_operators(self._ffmpeg_command):
+            final_command = " ".join(self._ffmpeg_command)
+        else:
+            final_command = self._ffmpeg_command
+
         self._write_to_log_file(
-            f"This file contains the log for the following command:\n{' '.join(self._ffmpeg_command)}\n",
+            f"This file contains the log for the following command:\n{final_command if isinstance(final_command, str) else ' '.join(final_command)}\n",
         )
 
         process = subprocess.Popen(
-            self._ffmpeg_command,
+            final_command,
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
             text=True,
-            shell=True,
+            shell=isinstance(final_command, str),
             creationflags=creationflags,
         )
 
@@ -195,15 +207,22 @@ class FfmpegProcess:
             target=self._handle_pipe, args=(process.stderr, stderr_queue), daemon=True
         ).start()
 
+        error_words = [
+            "error",
+            "failed",
+            "invalid",
+            "trailing",
+            "unable",
+            "unknown",
+        ]
+
         try:
             while process.poll() is None:
                 if self._duration_secs is not None:
                     try:
                         stdout = stdout_queue.get_nowait()
-
                         if stdout:
                             metric, value = stdout.split("=")
-
                             if (
                                 metric in self.WANTED_METRICS
                                 and value
@@ -212,7 +231,6 @@ class FfmpegProcess:
                                 self._update_metrics(
                                     stdout, metric, value, progress_handler
                                 )
-
                                 if (
                                     metric == "out_time_ms"
                                     and progress_bar
@@ -228,10 +246,12 @@ class FfmpegProcess:
 
                 try:
                     stderr = stderr_queue.get_nowait()
-
                     if stderr:
                         self._write_to_log_file(stderr)
 
+                        if any(keyword in stderr.lower() for keyword in error_words):
+                            self._error_messages.append(stderr)
+
                         if self._duration_secs is None:
                             print(
                                 stderr,
@@ -252,10 +272,12 @@ class FfmpegProcess:
         while True:
             try:
                 stderr = stderr_queue.get_nowait()
-
                 if stderr:
                     self._write_to_log_file(stderr)
 
+                    if any(keyword in stderr.lower() for keyword in error_words):
+                        self._error_messages.append(stderr)
+
                     if self._duration_secs is None:
                         print(
                             stderr,
@@ -338,7 +360,7 @@ class FfmpegProcess:
                 error_handler()
 
             sys.exit(
-                f"FFmpeg process failed. Check out '{self._ffmpeg_log_file}' for details."
+                f"FFmpeg process failed with return code {return_code}.\nError(s):\n{"\n".join(self._error_messages)}\nCheck out '{self._ffmpeg_log_file}' for more details."
             )
 
         if success_handler:

{better_ffmpeg_progress-2.5.3 → better_ffmpeg_progress-2.5.5}/better_ffmpeg_progress.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.5.3
+Version: 2.5.5
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -171,3 +171,5 @@ The `run` method takes the following **optional** arguments:
 [12/11/2024]
 - [v2.5.2] Drain any remaining FFmpeg stderr after the process ends.
 - [v2.5.3] Write FFmpeg stderr to the log file in real time.
+- [v2.5.4] Include progress info in stderr if the duration of the input file cannot be detected.
+- [v2.5.5] Print detected errors in the terminal and only set `shell=True` if shell operators are detected.

{better_ffmpeg_progress-2.5.3 → better_ffmpeg_progress-2.5.5}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as f:
 
 setuptools.setup(
     name="better-ffmpeg-progress",
-    version="2.5.3",
+    version="2.5.5",
     author="GitHub.com/CrypticSignal",
     author_email="theaudiophile@outlook.com",
     description="Run FFmpeg & see percentage progress + ETA.",