better-ffmpeg-progress 2.5.7__tar.gz → 2.6.0__tar.gz

{better_ffmpeg_progress-2.5.7 → better_ffmpeg_progress-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.5.7
+Version: 2.6.0
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -91,11 +91,12 @@ process.run(
 ## Optional Arguments
 An instance of the `FfmpegProcess` class takes the following **optional** arguments:
 
-- `ffmpeg_loglevel`: Desired FFmpeg log level. Default: "verbose"
+- `ffmpeg_loglevel`: Desired FFmpeg log level. Default: `"verbose"`
 - `print_stderr_new_line`: If better progress information cannot be shown, print FFmpeg stderr in a new line instead of replacing the current line in the terminal. Default: False
 - `print_detected_duration`: Print the detected duration of the input file. Default: True
 
 The `run` method takes the following **optional** arguments:
+- `print_command` - Print the FFmpeg command being executed. Default: `False`
 - `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`
   - You can create a function if you would like to do something with the following values:
@@ -110,72 +111,3 @@ The `run` method takes the following **optional** arguments:
 - `log_file` -  The filepath to save the FFmpeg log to.
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 - `error_handler` - A function to run if the FFmpeg process encounters an error.
-
-## Changelog
-[19/09/2022]
-- Add the ability to specify a `success_handler` argument, a function to run if the FFmpeg process completes successfully.
-- Add 0.001 to tqdm's `total` parameter to prevent the chance of getting `TqdmWarning: clamping frac to range [0, 1]`
-
-[21/12/2022]
-- [v2.0.7] Fix `'estimated_size' referenced before assignment` error.
-- [v2.0.7] The progress bar now uses 1 decimal place for seconds processed and total duration.
-
-[22/12/2022]
-- [v2.0.8] Add the ability to specify an `error_handler` argument, a function to run if the FFmpeg process encounters an error.
-- [v2.0.9] Fix a typo (commit [da45a84](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/da45a8416856ab7d3c7b748db5703fa3dbc65f60))
-
-[07/02/2022]
-- [v2.1.0] [Update function name](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/572fe8a0d71957d00b833134a4d35170630203fa) to fix `'process_complete_handler' is not defined` error.
-
-[05/11/2023]
-- [v2.1.2] [Do not exit the Python interpreter after the FFmpeg process is complete](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/0a358810773835297faae688689c6e0d8a5859ae)
-
-[22/04/2024]
-- [v2.1.3] Fix issue [#20](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/20)
-
-[28/04/2024]
-- [v2.1.4] Fix issue [#21](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/21)
-
-[02/05/2024]
-- [v2.1.5] Fix issue [#23](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/23) and make an error message more specific. [Here](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/a6ef7f26d080b684144021301f3b2aa5e0834dae) is the relevant commit.
-
-[18/10/2024]
-- [v2.1.6] Notify the user if the input filepath or filename is incorrect.
-- [v2.1.7] Refactor to use threads and queues.
-
-[19/10/2024]
-- [v2.1.8] Use [Rich](https://github.com/Textualize/rich) instead of [tqdm](https://github.com/tqdm/tqdm) and format code with [Ruff](https://github.com/astral-sh/ruff).
-
-[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.
-
-[29/10/2024]
-- [v2.3.0] Set `shell=True` to support piping.
-- [v2.3.1] Kill FFmpeg process(es) on KeyboardInterrupt
-
-[31/10/2024]
-- [v2.4.0] Print FFmpeg stderr if better progress information cannot be shown.
-- [v2.4.0] Flush the stream when printing FFmpeg stderr to ensure that it is printed immediately.
-- [v2.5.0] Add an option to print FFmpeg stderr on a new line if better progress information cannot be shown.
-
-[11/11/2024]
-- [v2.5.1] Print the correct log file.
-
-[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.
-
-[13/11/2024]
-- [v2.5.6] Detect a wider range of errors.
-
-[18/11/2024]
-- [v2.5.7] Fix syntax. Should fix issue #26

{better_ffmpeg_progress-2.5.7 → better_ffmpeg_progress-2.6.0}/README.md

@@ -73,11 +73,12 @@ process.run(
 ## Optional Arguments
 An instance of the `FfmpegProcess` class takes the following **optional** arguments:
 
-- `ffmpeg_loglevel`: Desired FFmpeg log level. Default: "verbose"
+- `ffmpeg_loglevel`: Desired FFmpeg log level. Default: `"verbose"`
 - `print_stderr_new_line`: If better progress information cannot be shown, print FFmpeg stderr in a new line instead of replacing the current line in the terminal. Default: False
 - `print_detected_duration`: Print the detected duration of the input file. Default: True
 
 The `run` method takes the following **optional** arguments:
+- `print_command` - Print the FFmpeg command being executed. Default: `False`
 - `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`
   - You can create a function if you would like to do something with the following values:
@@ -91,73 +92,4 @@ The `run` method takes the following **optional** arguments:
 
 - `log_file` -  The filepath to save the FFmpeg log to.
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
-- `error_handler` - A function to run if the FFmpeg process encounters an error.
-
-## Changelog
-[19/09/2022]
-- Add the ability to specify a `success_handler` argument, a function to run if the FFmpeg process completes successfully.
-- Add 0.001 to tqdm's `total` parameter to prevent the chance of getting `TqdmWarning: clamping frac to range [0, 1]`
-
-[21/12/2022]
-- [v2.0.7] Fix `'estimated_size' referenced before assignment` error.
-- [v2.0.7] The progress bar now uses 1 decimal place for seconds processed and total duration.
-
-[22/12/2022]
-- [v2.0.8] Add the ability to specify an `error_handler` argument, a function to run if the FFmpeg process encounters an error.
-- [v2.0.9] Fix a typo (commit [da45a84](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/da45a8416856ab7d3c7b748db5703fa3dbc65f60))
-
-[07/02/2022]
-- [v2.1.0] [Update function name](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/572fe8a0d71957d00b833134a4d35170630203fa) to fix `'process_complete_handler' is not defined` error.
-
-[05/11/2023]
-- [v2.1.2] [Do not exit the Python interpreter after the FFmpeg process is complete](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/0a358810773835297faae688689c6e0d8a5859ae)
-
-[22/04/2024]
-- [v2.1.3] Fix issue [#20](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/20)
-
-[28/04/2024]
-- [v2.1.4] Fix issue [#21](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/21)
-
-[02/05/2024]
-- [v2.1.5] Fix issue [#23](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/23) and make an error message more specific. [Here](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/a6ef7f26d080b684144021301f3b2aa5e0834dae) is the relevant commit.
-
-[18/10/2024]
-- [v2.1.6] Notify the user if the input filepath or filename is incorrect.
-- [v2.1.7] Refactor to use threads and queues.
-
-[19/10/2024]
-- [v2.1.8] Use [Rich](https://github.com/Textualize/rich) instead of [tqdm](https://github.com/tqdm/tqdm) and format code with [Ruff](https://github.com/astral-sh/ruff).
-
-[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.
-
-[29/10/2024]
-- [v2.3.0] Set `shell=True` to support piping.
-- [v2.3.1] Kill FFmpeg process(es) on KeyboardInterrupt
-
-[31/10/2024]
-- [v2.4.0] Print FFmpeg stderr if better progress information cannot be shown.
-- [v2.4.0] Flush the stream when printing FFmpeg stderr to ensure that it is printed immediately.
-- [v2.5.0] Add an option to print FFmpeg stderr on a new line if better progress information cannot be shown.
-
-[11/11/2024]
-- [v2.5.1] Print the correct log file.
-
-[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.
-
-[13/11/2024]
-- [v2.5.6] Detect a wider range of errors.
-
-[18/11/2024]
-- [v2.5.7] Fix syntax. Should fix issue #26
+- `error_handler` - A function to run if the FFmpeg process encounters an error.

{better_ffmpeg_progress-2.5.7 → better_ffmpeg_progress-2.6.0}/better_ffmpeg_progress/better_ffmpeg_progress.py

@@ -7,6 +7,8 @@ import sys
 from threading import Thread
 from typing import Callable, List, Optional, Union
 
+from .utils import line, print_with_prefix
+
 from ffmpeg import probe
 import psutil
 from rich.progress import (
@@ -60,6 +62,7 @@ class FfmpegProcess:
         # -stats_period sets the period at which encoding progress/statistics are updated
         command.extend(
             [
+                "-hide_banner",
                 "-loglevel",
                 ffmpeg_loglevel,
                 "-progress",
@@ -74,11 +77,10 @@ class FfmpegProcess:
         self._print_detected_duration = print_detected_duration
         self._print_stderr_new_line = print_stderr_new_line
         self._metrics = Metrics()
-        self._duration_secs: Optional[float] = None
+        self._duration_secs: Optional[float]
         self._current_size: int = 0
         self._ffmpeg_log_file: Optional[Path] = None
         self._error_messages: list[str] = []
-
         self._get_input_file_duration()
 
     def _get_input_file_duration(self) -> None:
@@ -92,16 +94,20 @@ class FfmpegProcess:
             )
 
             if self._print_detected_duration:
+                line()
                 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"])
+                line()
+
+            # -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",
             )
+            self._duration_secs = None
 
     def _check_output_exists(self) -> bool:
         """Check if output file exists and handle overwrite prompt."""
@@ -235,6 +241,7 @@ class FfmpegProcess:
                 if self._duration_secs is not None:
                     try:
                         stdout = stdout_queue.get_nowait()
+
                         if stdout:
                             metric, value = stdout.split("=")
                             if (
@@ -260,6 +267,7 @@ class FfmpegProcess:
 
                 try:
                     stderr = stderr_queue.get_nowait()
+
                     if stderr:
                         self._write_to_log_file(stderr)
 
@@ -277,10 +285,8 @@ class FfmpegProcess:
 
         except KeyboardInterrupt:
             self._kill_process_and_children(process.pid)
-            self._write_to_log_file("\n[KeyboardInterrupt] FFmpeg process(es) killed.")
-            sys.exit(
-                f"{'\n' if self._duration_secs is None else ''}[KeyboardInterrupt] FFmpeg process(es) killed."
-            )
+            self._write_to_log_file("\n[KeyboardInterrupt] FFmpeg process killed.")
+            sys.exit("\n[KeyboardInterrupt] FFmpeg process killed.")
 
         # After the process ends, drain any remaining stderr
         while True:
@@ -306,6 +312,7 @@ class FfmpegProcess:
     def run(
         self,
         log_file: Optional[Union[str, Path]] = "ffmpeg_log.txt",
+        print_command=False,
         progress_bar_description: str = None,
         progress_handler: Optional[Callable] = None,
         success_handler: Optional[Callable] = None,
@@ -314,6 +321,7 @@ class FfmpegProcess:
         """
         Args:
             log_file: Optional filepath to write FFmpeg output to
+            print_command: Print the FFmpeg command being executed. Default: False
             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
@@ -327,9 +335,10 @@ class FfmpegProcess:
         with open(self._ffmpeg_log_file, "w"):
             pass
 
-        print(
-            f"Executing: {' '.join(self._ffmpeg_command)}{'\n' if self._duration_secs is None else ''}"
-        )
+        if print_command:
+            line()
+
+            print(f"Executing: {' '.join(self._ffmpeg_command)}")
 
         if self._duration_secs and not progress_handler:
             with Progress(
@@ -353,6 +362,16 @@ class FfmpegProcess:
                     task_id,
                     None,
                 )
+
+                if return_code == 0:
+                    progress_bar.columns = (
+                        TextColumn("[progress.description]{task.description}"),
+                    )
+                    progress_bar.update(
+                        task_id,
+                        description=f"✓ Processed 100% of {self._input_filepath.name}",
+                    )
+
         else:
             return_code = self._start_process(
                 None,
@@ -360,6 +379,12 @@ class FfmpegProcess:
                 progress_handler,
             )
 
+            if return_code == 0:
+                print_with_prefix(
+                    "FFmpeg process completed.",
+                    "\n" if self._duration_secs is None else "",
+                )
+
         self._handle_process_ended(return_code, error_handler, success_handler)
 
     def _handle_process_ended(
@@ -372,17 +397,17 @@ class FfmpegProcess:
         if return_code != 0:
             if error_handler:
                 error_handler()
+                sys.exit(
+                    "\nThe FFmpeg process encounted an error. Custom error handler executed."
+                )
 
-            sys.exit(
-                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."
-            )
+            print(f"FFmpeg process failed with return code {return_code}.\nError(s):")
+            print("\n".join(self._error_messages))
+            print(f"Check out '{self._ffmpeg_log_file}' for more details.")
+            sys.exit(1)
 
         if success_handler:
             success_handler()
-        else:
-            print(
-                f"{'\n' if self._duration_secs is None else ''}FFmpeg process completed."
-            )
 
     def _kill_process_and_children(self, proc_pid: int) -> None:
         """Kill the FFmpeg process and its children."""

better_ffmpeg_progress-2.6.0/better_ffmpeg_progress/utils.py

@@ -0,0 +1,10 @@
+import os
+
+
+def line():
+    width, _ = os.get_terminal_size()
+    print("-" * width)
+
+
+def print_with_prefix(message, prefix):
+    print(f"{prefix}{message}")

{better_ffmpeg_progress-2.5.7 → better_ffmpeg_progress-2.6.0}/better_ffmpeg_progress.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 2.5.7
+Version: 2.6.0
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -91,11 +91,12 @@ process.run(
 ## Optional Arguments
 An instance of the `FfmpegProcess` class takes the following **optional** arguments:
 
-- `ffmpeg_loglevel`: Desired FFmpeg log level. Default: "verbose"
+- `ffmpeg_loglevel`: Desired FFmpeg log level. Default: `"verbose"`
 - `print_stderr_new_line`: If better progress information cannot be shown, print FFmpeg stderr in a new line instead of replacing the current line in the terminal. Default: False
 - `print_detected_duration`: Print the detected duration of the input file. Default: True
 
 The `run` method takes the following **optional** arguments:
+- `print_command` - Print the FFmpeg command being executed. Default: `False`
 - `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`
   - You can create a function if you would like to do something with the following values:
@@ -110,72 +111,3 @@ The `run` method takes the following **optional** arguments:
 - `log_file` -  The filepath to save the FFmpeg log to.
 - `success_handler` - A function to run if the FFmpeg process completes successfully.
 - `error_handler` - A function to run if the FFmpeg process encounters an error.
-
-## Changelog
-[19/09/2022]
-- Add the ability to specify a `success_handler` argument, a function to run if the FFmpeg process completes successfully.
-- Add 0.001 to tqdm's `total` parameter to prevent the chance of getting `TqdmWarning: clamping frac to range [0, 1]`
-
-[21/12/2022]
-- [v2.0.7] Fix `'estimated_size' referenced before assignment` error.
-- [v2.0.7] The progress bar now uses 1 decimal place for seconds processed and total duration.
-
-[22/12/2022]
-- [v2.0.8] Add the ability to specify an `error_handler` argument, a function to run if the FFmpeg process encounters an error.
-- [v2.0.9] Fix a typo (commit [da45a84](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/da45a8416856ab7d3c7b748db5703fa3dbc65f60))
-
-[07/02/2022]
-- [v2.1.0] [Update function name](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/572fe8a0d71957d00b833134a4d35170630203fa) to fix `'process_complete_handler' is not defined` error.
-
-[05/11/2023]
-- [v2.1.2] [Do not exit the Python interpreter after the FFmpeg process is complete](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/0a358810773835297faae688689c6e0d8a5859ae)
-
-[22/04/2024]
-- [v2.1.3] Fix issue [#20](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/20)
-
-[28/04/2024]
-- [v2.1.4] Fix issue [#21](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/21)
-
-[02/05/2024]
-- [v2.1.5] Fix issue [#23](https://github.com/CrypticSignal/better-ffmpeg-progress/issues/23) and make an error message more specific. [Here](https://github.com/CrypticSignal/better-ffmpeg-progress/commit/a6ef7f26d080b684144021301f3b2aa5e0834dae) is the relevant commit.
-
-[18/10/2024]
-- [v2.1.6] Notify the user if the input filepath or filename is incorrect.
-- [v2.1.7] Refactor to use threads and queues.
-
-[19/10/2024]
-- [v2.1.8] Use [Rich](https://github.com/Textualize/rich) instead of [tqdm](https://github.com/tqdm/tqdm) and format code with [Ruff](https://github.com/astral-sh/ruff).
-
-[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.
-
-[29/10/2024]
-- [v2.3.0] Set `shell=True` to support piping.
-- [v2.3.1] Kill FFmpeg process(es) on KeyboardInterrupt
-
-[31/10/2024]
-- [v2.4.0] Print FFmpeg stderr if better progress information cannot be shown.
-- [v2.4.0] Flush the stream when printing FFmpeg stderr to ensure that it is printed immediately.
-- [v2.5.0] Add an option to print FFmpeg stderr on a new line if better progress information cannot be shown.
-
-[11/11/2024]
-- [v2.5.1] Print the correct log file.
-
-[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.
-
-[13/11/2024]
-- [v2.5.6] Detect a wider range of errors.
-
-[18/11/2024]
-- [v2.5.7] Fix syntax. Should fix issue #26

{better_ffmpeg_progress-2.5.7 → better_ffmpeg_progress-2.6.0}/better_ffmpeg_progress.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 setup.py
 better_ffmpeg_progress/__init__.py
 better_ffmpeg_progress/better_ffmpeg_progress.py
+better_ffmpeg_progress/utils.py
 better_ffmpeg_progress.egg-info/PKG-INFO
 better_ffmpeg_progress.egg-info/SOURCES.txt
 better_ffmpeg_progress.egg-info/dependency_links.txt

{better_ffmpeg_progress-2.5.7 → better_ffmpeg_progress-2.6.0}/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.7",
+    version="2.6.0",
     author="GitHub.com/CrypticSignal",
     author_email="theaudiophile@outlook.com",
     description="Run FFmpeg & see percentage progress + ETA.",