better-ffmpeg-progress 2.2.0__tar.gz → 2.2.2__tar.gz

{better_ffmpeg_progress-2.2.0 → better_ffmpeg_progress-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.2.0
+Version: 2.2.2
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -80,9 +80,9 @@ process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "out
 
 # Use the run method to run the FFmpeg command.
 process.run(
-    output_file="ffmpeg_output.txt",
     progress_bar_description="Converting file...",
     progress_handler=handle_progress_info,
+    log_file="ffmpeg_log.txt",
     success_handler=handle_success,
     error_handler=handle_error,
 )
@@ -103,7 +103,7 @@ The `run` method takes the following **optional** arguments:
 
     The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.
 
-- `output_file` - A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename `[<input_filename>].txt`.
+- `log_file` -  The filepath to save the FFmpeg log to.
 
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 
@@ -157,3 +157,9 @@ The `run` method takes the following **optional** arguments:
 [20/10/2024]
 - [v2.1.9] Do not clear the terminal before showing the progress bar.
 - [v2.2.0] Add the ability to set a custom description for the progress bar.
+
+[22/10/2024]
+- [v2.2.1] Only create a log file if the `log_file` parameter is specified and always create a log file if the FFmpeg process fails.
+
+[28/10/2024]
+- [v2.2.2] Make printing the detected duration of the input file optional.

{better_ffmpeg_progress-2.2.0 → better_ffmpeg_progress-2.2.2}/README.md

@@ -63,9 +63,9 @@ process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "out
 
 # Use the run method to run the FFmpeg command.
 process.run(
-    output_file="ffmpeg_output.txt",
     progress_bar_description="Converting file...",
     progress_handler=handle_progress_info,
+    log_file="ffmpeg_log.txt",
     success_handler=handle_success,
     error_handler=handle_error,
 )
@@ -86,7 +86,7 @@ The `run` method takes the following **optional** arguments:
 
     The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.
 
-- `output_file` - A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename `[<input_filename>].txt`.
+- `log_file` -  The filepath to save the FFmpeg log to.
 
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 
@@ -140,3 +140,9 @@ The `run` method takes the following **optional** arguments:
 [20/10/2024]
 - [v2.1.9] Do not clear the terminal before showing the progress bar.
 - [v2.2.0] Add the ability to set a custom description for the progress bar.
+
+[22/10/2024]
+- [v2.2.1] Only create a log file if the `log_file` parameter is specified and always create a log file if the FFmpeg process fails.
+
+[28/10/2024]
+- [v2.2.2] Make printing the detected duration of the input file optional.

{better_ffmpeg_progress-2.2.0 → better_ffmpeg_progress-2.2.2}/better_ffmpeg_progress/better_ffmpeg_progress.py

@@ -42,13 +42,19 @@ class FfmpegProcess:
 
     WANTED_METRICS = frozenset({"out_time_ms", "total_size", "speed"})
 
-    def __init__(self, command: List[str], ffmpeg_loglevel: str = "verbose"):
+    def __init__(
+        self,
+        command: List[str],
+        ffmpeg_loglevel: str = "verbose",
+        print_detected_duration: bool = True,
+    ):
         if "-i" not in command:
             raise ValueError("FFmpeg command must include '-i'")
 
         self._ffmpeg_args = command + ["-hide_banner", "-loglevel", ffmpeg_loglevel]
         self._ffmpeg_stderr: List[str] = []
         self._output_filepath = Path(command[-1])
+        self._print_detected_duration = print_detected_duration
         self._metrics = Metrics()
         self._duration_secs: Optional[float] = None
         self._current_size: int = 0
@@ -64,9 +70,12 @@ class FfmpegProcess:
             self._duration_secs = float(
                 probe(self._input_filepath)["format"]["duration"]
             )
-            print(
-                f"The duration of {self._input_filepath.name} has been detected as {self._duration_secs} seconds"
-            )
+
+            if self._print_detected_duration:
+                print(
+                    f"The duration of {self._input_filepath.name} has been detected as {self._duration_secs} seconds"
+                )
+
             # -progress pipe:1 sends progress metrics to stdout AND -stats_period sets the period at which encoding progress/statistics are updated
             # -nostats disables encoding progress/statistics in stderr
             self._ffmpeg_args.extend(
@@ -143,24 +152,23 @@ class FfmpegProcess:
             pipe.close()
 
     def _write_ffmpeg_output(
-        self, stderr_output: str, output_file: Optional[Union[str, Path]]
+        self,
+        stderr_output: str,
+        log_file: Optional[Union[str, Path]],
+        is_error: bool = False,
     ) -> None:
         """Write FFmpeg stderr to a txt file."""
-        output_dir = Path("ffmpeg_output")
-        output_dir.mkdir(exist_ok=True)
+        Path(log_file).write_text(stderr_output)
 
-        log_file = output_file or output_dir / f"[{self._input_filepath.name}].txt"
-        log_file = Path(log_file)
+        if is_error:
+            return
 
-        log_file.write_text(stderr_output)
-        print(f"Done! FFmpeg log file: {log_file}")
+        print(f"FFmpeg log written to: {log_file}")
 
     def _start_process(
         self,
         progress_bar: Optional[Progress],
         task_id: Optional[int],
-        success_handler: Optional[Callable],
-        error_handler: Optional[Callable],
         progress_handler: Optional[Callable],
     ) -> None:
         process = subprocess.Popen(
@@ -213,18 +221,11 @@ class FfmpegProcess:
             except Empty:
                 pass
 
-        if process.returncode != 0:
-            if error_handler:
-                error_handler()
-            else:
-                sys.exit("\nFFmpeg process failed")
-
-        if success_handler:
-            success_handler()
+        return process.returncode
 
     def run(
         self,
-        output_file: Optional[Union[str, Path]] = None,
+        log_file: Optional[Union[str, Path]] = None,
         progress_bar_description: str = None,
         progress_handler: Optional[Callable] = None,
         success_handler: Optional[Callable] = None,
@@ -232,7 +233,7 @@ class FfmpegProcess:
     ) -> None:
         """
         Args:
-            output_file: Optional filepath to write FFmpeg output to
+            log_file: Optional filepath to write FFmpeg output to
             progress_bar_description: Optional string to set a custom description for the progress bar
             progress_handler: Optional function which receives progress metrics
             success_handler: Optional function to handle successful completion of the FFmpeg process
@@ -260,20 +261,41 @@ class FfmpegProcess:
                     total=self._duration_secs,
                 )
 
-                self._start_process(
+                return_code = self._start_process(
                     progress_bar,
                     task_id,
-                    success_handler,
-                    error_handler,
-                    progress_handler,
+                    None,
                 )
         else:
-            self._start_process(
+            return_code = self._start_process(
                 None,
                 None,
-                success_handler,
-                error_handler,
                 progress_handler,
             )
 
-        self._write_ffmpeg_output("\n".join(self._ffmpeg_stderr), output_file)
+        self._handle_process_ended(
+            return_code, error_handler, success_handler, log_file
+        )
+
+    def _handle_process_ended(
+        self, return_code, error_handler, success_handler, log_file
+    ):
+        if return_code != 0:
+            if error_handler:
+                error_handler()
+
+            ffmpeg_log_file = "ffmpeg_log.txt"
+
+            self._write_ffmpeg_output(
+                "\n".join(self._ffmpeg_stderr), ffmpeg_log_file, is_error=True
+            )
+
+            sys.exit(f"FFmpeg process failed. Check out {ffmpeg_log_file} for details")
+
+        if log_file:
+            self._write_ffmpeg_output("\n".join(self._ffmpeg_stderr), log_file)
+
+        if success_handler:
+            success_handler()
+        else:
+            print("FFmpeg process completed.")

{better_ffmpeg_progress-2.2.0 → better_ffmpeg_progress-2.2.2}/better_ffmpeg_progress.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.2.0
+Version: 2.2.2
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -80,9 +80,9 @@ process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "out
 
 # Use the run method to run the FFmpeg command.
 process.run(
-    output_file="ffmpeg_output.txt",
     progress_bar_description="Converting file...",
     progress_handler=handle_progress_info,
+    log_file="ffmpeg_log.txt",
     success_handler=handle_success,
     error_handler=handle_error,
 )
@@ -103,7 +103,7 @@ The `run` method takes the following **optional** arguments:
 
     The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.
 
-- `output_file` - A string path to define where you want the output of FFmpeg to be saved. By default, this is saved in a folder named "ffmpeg_output", with the filename `[<input_filename>].txt`.
+- `log_file` -  The filepath to save the FFmpeg log to.
 
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 
@@ -157,3 +157,9 @@ The `run` method takes the following **optional** arguments:
 [20/10/2024]
 - [v2.1.9] Do not clear the terminal before showing the progress bar.
 - [v2.2.0] Add the ability to set a custom description for the progress bar.
+
+[22/10/2024]
+- [v2.2.1] Only create a log file if the `log_file` parameter is specified and always create a log file if the FFmpeg process fails.
+
+[28/10/2024]
+- [v2.2.2] Make printing the detected duration of the input file optional.

{better_ffmpeg_progress-2.2.0 → better_ffmpeg_progress-2.2.2}/setup.py

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