better-ffmpeg-progress 2.1.9__tar.gz → 2.2.1__tar.gz

{better_ffmpeg_progress-2.1.9 → better_ffmpeg_progress-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.1.9
+Version: 2.2.1
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -30,11 +30,11 @@ Runs an FFmpeg command and uses [Rich](https://github.com/Textualize/rich) to sh
 ## Example:
 
 ```
-⠏ Processing... ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
+⠏ Processing abc.webm ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
 ```
 
 Where:
-
+- `Processing abc.webm` is the description of the progresss bar.
 - `23%` is the percentage progress.
 - `0:00:04` is the time (H:MM:SS) elapsed.
 - `00:15` is the estimated time until the FFmpeg process completes.
@@ -78,13 +78,18 @@ def handle_error():
 # Pass a list of FFmpeg arguments, like you would if using subprocess.run()
 process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "output.mp3"])
 
-ffmpeg_output_path = 'ffmpeg_output.txt'
-
 # Use the run method to run the FFmpeg command.
-process.run(progress_handler=handle_progress_info, ffmpeg_output_file=ffmpeg_output_path, success_handler=handle_success, error_handler=handle_error)
+process.run(
+    log_file="ffmpeg_output.txt",
+    progress_bar_description="Converting file...",
+    progress_handler=handle_progress_info,
+    success_handler=handle_success,
+    error_handler=handle_error,
+)
 ```
 
 The `run` method takes the following **optional** arguments:
+- `progress_bar_description` - An optional string to set a custom description for the progress bar. The default description is `Processing <file>`. This can be an empty string if you don't want the progress bar to have a description.
 
 - `progress_handler`
 
@@ -96,9 +101,9 @@ The `run` method takes the following **optional** arguments:
     - Estimated output filesize in bytes. [float]
       - _Note: This is not accurate. Please take the value with a grain of salt._
 
-    The values will be `None` if unknown. The function will receive the aforementioned metrics as arguments, about two times per second.
+    The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.
 
-- `ffmpeg_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`.
+- `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`.
 
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 
@@ -151,3 +156,7 @@ 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/2020]
+- [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.

{better_ffmpeg_progress-2.1.9 → better_ffmpeg_progress-2.2.1}/README.md

@@ -13,11 +13,11 @@ Runs an FFmpeg command and uses [Rich](https://github.com/Textualize/rich) to sh
 ## Example:
 
 ```
-⠏ Processing... ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
+⠏ Processing abc.webm ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
 ```
 
 Where:
-
+- `Processing abc.webm` is the description of the progresss bar.
 - `23%` is the percentage progress.
 - `0:00:04` is the time (H:MM:SS) elapsed.
 - `00:15` is the estimated time until the FFmpeg process completes.
@@ -61,13 +61,18 @@ def handle_error():
 # Pass a list of FFmpeg arguments, like you would if using subprocess.run()
 process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "output.mp3"])
 
-ffmpeg_output_path = 'ffmpeg_output.txt'
-
 # Use the run method to run the FFmpeg command.
-process.run(progress_handler=handle_progress_info, ffmpeg_output_file=ffmpeg_output_path, success_handler=handle_success, error_handler=handle_error)
+process.run(
+    log_file="ffmpeg_output.txt",
+    progress_bar_description="Converting file...",
+    progress_handler=handle_progress_info,
+    success_handler=handle_success,
+    error_handler=handle_error,
+)
 ```
 
 The `run` method takes the following **optional** arguments:
+- `progress_bar_description` - An optional string to set a custom description for the progress bar. The default description is `Processing <file>`. This can be an empty string if you don't want the progress bar to have a description.
 
 - `progress_handler`
 
@@ -79,9 +84,9 @@ The `run` method takes the following **optional** arguments:
     - Estimated output filesize in bytes. [float]
       - _Note: This is not accurate. Please take the value with a grain of salt._
 
-    The values will be `None` if unknown. The function will receive the aforementioned metrics as arguments, about two times per second.
+    The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.
 
-- `ffmpeg_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`.
+- `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`.
 
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 
@@ -134,3 +139,7 @@ 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/2020]
+- [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.

{better_ffmpeg_progress-2.1.9 → better_ffmpeg_progress-2.2.1}/better_ffmpeg_progress/better_ffmpeg_progress.py

@@ -143,24 +143,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,25 +212,20 @@ 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,
         error_handler: Optional[Callable] = None,
     ) -> 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
             error_handler: Optional function for FFmpeg process error handling
@@ -252,23 +246,47 @@ class FfmpegProcess:
                 refresh_per_second=10,
             ) as progress_bar:
                 task_id = progress_bar.add_task(
-                    f"Processing {self._input_filepath.name}", total=self._duration_secs
+                    progress_bar_description
+                    if progress_bar_description is not None
+                    else f"Processing {self._input_filepath.name}",
+                    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.1.9 → better_ffmpeg_progress-2.2.1}/better_ffmpeg_progress.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.1.9
+Version: 2.2.1
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -30,11 +30,11 @@ Runs an FFmpeg command and uses [Rich](https://github.com/Textualize/rich) to sh
 ## Example:
 
 ```
-⠏ Processing... ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
+⠏ Processing abc.webm ━━━━━━━━━╺━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━  23% 0:00:04 00:15
 ```
 
 Where:
-
+- `Processing abc.webm` is the description of the progresss bar.
 - `23%` is the percentage progress.
 - `0:00:04` is the time (H:MM:SS) elapsed.
 - `00:15` is the estimated time until the FFmpeg process completes.
@@ -78,13 +78,18 @@ def handle_error():
 # Pass a list of FFmpeg arguments, like you would if using subprocess.run()
 process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:a", "libmp3lame", "output.mp3"])
 
-ffmpeg_output_path = 'ffmpeg_output.txt'
-
 # Use the run method to run the FFmpeg command.
-process.run(progress_handler=handle_progress_info, ffmpeg_output_file=ffmpeg_output_path, success_handler=handle_success, error_handler=handle_error)
+process.run(
+    log_file="ffmpeg_output.txt",
+    progress_bar_description="Converting file...",
+    progress_handler=handle_progress_info,
+    success_handler=handle_success,
+    error_handler=handle_error,
+)
 ```
 
 The `run` method takes the following **optional** arguments:
+- `progress_bar_description` - An optional string to set a custom description for the progress bar. The default description is `Processing <file>`. This can be an empty string if you don't want the progress bar to have a description.
 
 - `progress_handler`
 
@@ -96,9 +101,9 @@ The `run` method takes the following **optional** arguments:
     - Estimated output filesize in bytes. [float]
       - _Note: This is not accurate. Please take the value with a grain of salt._
 
-    The values will be `None` if unknown. The function will receive the aforementioned metrics as arguments, about two times per second.
+    The values will be `None` if unknown. The function will receive the current values of these metrics as arguments, every 0.1s.
 
-- `ffmpeg_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`.
+- `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`.
 
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 
@@ -151,3 +156,7 @@ 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/2020]
+- [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.

{better_ffmpeg_progress-2.1.9 → better_ffmpeg_progress-2.2.1}/setup.py

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