better-ffmpeg-progress 3.1.0__tar.gz → 3.2.1__tar.gz

{better_ffmpeg_progress-3.1.0 → better_ffmpeg_progress-3.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 3.1.0
+Version: 3.2.1
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -15,6 +15,7 @@ License-File: LICENSE
 Requires-Dist: ffmpeg-python
 Requires-Dist: psutil
 Requires-Dist: rich
+Requires-Dist: tqdm
 
 <div align="center">
 
@@ -25,6 +26,8 @@ Requires-Dist: rich
 
 # Better FFmpeg Progress
 Runs an FFmpeg command and shows a progress bar with percentage progress, time elapsed and ETA.
+
+The [Rich](https://github.com/Textualize/rich) library is used for the progress bar by default, [tqdm](https://github.com/tqdm/tqdm) will be used if you pass `use_tqdm=True` to the `run` method.
 </div>
 
 FFmpeg outputs something like:
@@ -38,7 +41,7 @@ Better FFmpeg Progress outputs something like:
 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.
+- `0:00:04` is the time elapsed.
 - `00:15` is the estimated time until the FFmpeg process completes.
 
 As you can see, the output of Better FFmpeg Progress is much more useful.
@@ -56,24 +59,17 @@ Here's a simple example:
 from better_ffmpeg_progress import FfmpegProcess
 
 process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:v", "libx265", "output.mp4"])
-
-# return_code will be 0 if the process was successful
+# return_code will be 0 if the process completed successfully, otherwise it will be 1
 return_code = process.run()
-
-if return_code == 0:
-    # Code to run if the process was successful
-    pass
-else:
-    # Code to run if the process was unsuccessful
-    pass
 ```
 ## Optional Arguments
 An instance of the `FfmpegProcess` class takes the following **optional** arguments:
 
 - `ffmpeg_log_level` - Desired FFmpeg log level. Default: `"verbose"`
-- `ffmpeg_log_file` - The filepath to save the FFmpeg log to.
-- `print_detected_duration` - Print the detected duration of the input file. Default: `True`
+- `ffmpeg_log_file` - The filepath to save the FFmpeg log to. Default: `<input filename>_log.txt`
+- `print_detected_duration` - Print the detected duration of the input file. Default: `False`
 - `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`
 
-The `run` method takes the following **optional** argument:
+The `run` method takes the following **optional** arguments:
 - `print_command` - Print the FFmpeg command being executed. Default: `False`
+- `use_tqdm` - Use [tqdm](https://github.com/tqdm/tqdm) instead of [Rich](https://github.com/Textualize/rich) for the progress bar. Default: `False`

{better_ffmpeg_progress-3.1.0 → better_ffmpeg_progress-3.2.1}/README.md

@@ -7,6 +7,8 @@
 
 # Better FFmpeg Progress
 Runs an FFmpeg command and shows a progress bar with percentage progress, time elapsed and ETA.
+
+The [Rich](https://github.com/Textualize/rich) library is used for the progress bar by default, [tqdm](https://github.com/tqdm/tqdm) will be used if you pass `use_tqdm=True` to the `run` method.
 </div>
 
 FFmpeg outputs something like:
@@ -20,7 +22,7 @@ Better FFmpeg Progress outputs something like:
 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.
+- `0:00:04` is the time elapsed.
 - `00:15` is the estimated time until the FFmpeg process completes.
 
 As you can see, the output of Better FFmpeg Progress is much more useful.
@@ -38,24 +40,17 @@ Here's a simple example:
 from better_ffmpeg_progress import FfmpegProcess
 
 process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:v", "libx265", "output.mp4"])
-
-# return_code will be 0 if the process was successful
+# return_code will be 0 if the process completed successfully, otherwise it will be 1
 return_code = process.run()
-
-if return_code == 0:
-    # Code to run if the process was successful
-    pass
-else:
-    # Code to run if the process was unsuccessful
-    pass
 ```
 ## Optional Arguments
 An instance of the `FfmpegProcess` class takes the following **optional** arguments:
 
 - `ffmpeg_log_level` - Desired FFmpeg log level. Default: `"verbose"`
-- `ffmpeg_log_file` - The filepath to save the FFmpeg log to.
-- `print_detected_duration` - Print the detected duration of the input file. Default: `True`
+- `ffmpeg_log_file` - The filepath to save the FFmpeg log to. Default: `<input filename>_log.txt`
+- `print_detected_duration` - Print the detected duration of the input file. Default: `False`
 - `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`
 
-The `run` method takes the following **optional** argument:
-- `print_command` - Print the FFmpeg command being executed. Default: `False`
+The `run` method takes the following **optional** arguments:
+- `print_command` - Print the FFmpeg command being executed. Default: `False`
+- `use_tqdm` - Use [tqdm](https://github.com/tqdm/tqdm) instead of [Rich](https://github.com/Textualize/rich) for the progress bar. Default: `False`

{better_ffmpeg_progress-3.1.0 → better_ffmpeg_progress-3.2.1}/better_ffmpeg_progress/better_ffmpeg_progress.py

@@ -2,10 +2,11 @@ from enum import Enum
 import os
 from pathlib import Path
 import psutil
-from queue import Empty, Queue
+from queue import Queue
 import shutil
 import subprocess
 from threading import Thread
+from time import sleep
 from typing import List, Optional, Union
 
 from ffmpeg import probe
@@ -18,6 +19,7 @@ from rich.progress import (
     TimeElapsedColumn,
     SpinnerColumn,
 )
+from tqdm import tqdm
 
 
 class FfmpegLogLevel(Enum):
@@ -33,8 +35,6 @@ class FfmpegLogLevel(Enum):
 
 
 class FfmpegProcess:
-    TIME_MS_PREFIX = "out_time_ms="
-
     @staticmethod
     def _read_pipe(pipe: subprocess.PIPE, queue: Queue, stdout: bool = False) -> None:
         """Read from pipe and put lines into queue."""
@@ -119,7 +119,7 @@ class FfmpegProcess:
             probe_data = probe(self._input_filepath)
             self._duration_secs = float(probe_data["format"]["duration"])
             if self._print_detected_duration:
-                print(f"Detected duration: {self._duration_secs:.2f} seconds")
+                print(f"Detected duration: {self._duration_secs} seconds")
         except Exception:
             self._duration_secs = None
 
@@ -130,8 +130,6 @@ class FfmpegProcess:
             self._ffmpeg_log_level,
             "-progress",
             "pipe:1",
-            "-stats_period",
-            "0.1",
             "-nostats",
             *command[1:],
         ]
@@ -149,7 +147,119 @@ class FfmpegProcess:
             print(f"Error writing to log file: {e}")
             self.return_code = 1
 
-    def run(self, print_command: bool = False) -> int:
+    def _use_rich(self, process, stdout_queue, stderr_queue) -> int:
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            BarColumn(),
+            TaskProgressColumn(),
+            TimeElapsedColumn(),
+            TimeRemainingColumn(compact=True),
+            refresh_per_second=10,
+        ) as progress_bar:
+            task_id = None
+
+            if self._duration_secs:
+                task_id = progress_bar.add_task(
+                    f"Processing {self._input_filepath.name}",
+                    total=self._duration_secs,
+                )
+
+            while process.poll() is None:
+                # FFmpeg only updates encoding progress/statistics every 0.5 seconds
+                sleep(0.5)
+                # stdout
+                if task_id is not None and not stdout_queue.empty():
+                    line = stdout_queue.get()
+                    try:
+                        value = int(line.split("=")[1]) / 1_000_000
+                        if value <= self._duration_secs:
+                            progress_bar.update(task_id, completed=value)
+                    except ValueError:
+                        pass
+                # stderr
+                if not stderr_queue.empty():
+                    self._process_stderr(stderr_queue.get())
+
+            if process.returncode == 0 and task_id is not None:
+                progress_bar.update(task_id, completed=self._duration_secs)
+                progress_bar.columns = (
+                    TextColumn("[progress.description]{task.description}"),
+                    BarColumn(),
+                    TaskProgressColumn(),
+                )
+                progress_bar.update(
+                    task_id,
+                    description=f"✓ Processed {self._input_filepath.name}",
+                )
+
+            # Process remaining stderr
+            while not stderr_queue.empty():
+                self._process_stderr(stderr_queue.get())
+
+            if process.returncode != 0:
+                progress_bar.update(
+                    task_id,
+                    description=f"The FFmpeg process did not complete successfully. Check out {self._ffmpeg_log_file} for details.",
+                )
+                return 1
+
+            return 0
+
+    def _use_tqdm(self, process, stdout_queue, stderr_queue) -> int:
+        pbar = None
+        width, _ = os.get_terminal_size()
+
+        if self._duration_secs:
+            pbar = tqdm(
+                total=self._duration_secs,
+                desc=f"Processing {self._input_filepath.name}",
+                ncols=80,
+                dynamic_ncols=True if width < 80 else False,
+                bar_format="{desc} {bar} {percentage:.1f}% {elapsed} {remaining}",
+            )
+
+        while process.poll() is None:
+            # FFmpeg only updates encoding progress/statistics every 0.5 seconds
+            sleep(0.5)
+            # stdout
+            if pbar and not stdout_queue.empty():
+                line = stdout_queue.get()
+                try:
+                    value = int(line.split("=")[1]) / 1_000_000
+                    if value <= self._duration_secs:
+                        pbar.n = value
+                        pbar.refresh()
+                except ValueError:
+                    pass
+            # stderr
+            if not stderr_queue.empty():
+                self._process_stderr(stderr_queue.get())
+
+        if process.returncode == 0 and pbar:
+            pbar.n = self._duration_secs
+            pbar.set_description(f"✓ Processed {self._input_filepath.name}")
+
+        if pbar:
+            pbar.close()
+
+        # Process remaining stderr
+        while not stderr_queue.empty():
+            self._process_stderr(stderr_queue.get())
+
+        if process.returncode != 0:
+            print(
+                f"The FFmpeg process did not complete successfully. Check out {self._ffmpeg_log_file} for details."
+            )
+            return 1
+
+        return 0
+
+    def run(
+        self,
+        print_command: bool = False,
+        use_tqdm: bool = False,
+    ) -> int:
         if hasattr(self, "return_code") and self.return_code != 0:
             return 1
 
@@ -206,72 +316,13 @@ class FfmpegProcess:
         ).start()
 
         try:
-            with Progress(
-                SpinnerColumn(),
-                TextColumn("[progress.description]{task.description}"),
-                BarColumn(),
-                TaskProgressColumn(),
-                TimeElapsedColumn(),
-                TimeRemainingColumn(compact=True),
-                refresh_per_second=10,
-            ) as progress_bar:
-                task_id = None
-                if self._duration_secs:
-                    task_id = progress_bar.add_task(
-                        f"Processing {self._input_filepath.name}",
-                        total=self._duration_secs,
-                    )
-
-                while process.poll() is None:
-                    # stdout
-                    if task_id is not None and not stdout_queue.empty():
-                        try:
-                            line = stdout_queue.get_nowait()
-                            if line.startswith(self.TIME_MS_PREFIX):
-                                try:
-                                    value = int(line.split("=")[1]) / 1_000_000
-                                    if value <= self._duration_secs:
-                                        progress_bar.update(task_id, completed=value)
-                                except ValueError:
-                                    pass
-                        except Empty:
-                            pass
-
-                    # stderr
-                    if not stderr_queue.empty():
-                        try:
-                            self._process_stderr(stderr_queue.get_nowait())
-                        except Empty:
-                            pass
-
-                # Process remaining stderr
-                while not stderr_queue.empty():
-                    try:
-                        self._process_stderr(stderr_queue.get_nowait())
-                    except Empty:
-                        break
-
-                progress_bar.columns = (
-                    TextColumn("[progress.description]{task.description}"),
-                )
-
-                if process.returncode != 0:
-                    progress_bar.update(
-                        task_id,
-                        description=f"The FFmpeg process did not complete successfully. Check out {self._ffmpeg_log_file} for details.",
-                    )
-                    return 1
-
-                progress_bar.update(
-                    task_id,
-                    description=f"✓ Processed {self._input_filepath.name}",
-                )
-
+            if use_tqdm:
+                return self._use_tqdm(process, stdout_queue, stderr_queue)
+            else:
+                return self._use_rich(process, stdout_queue, stderr_queue)
         except KeyboardInterrupt:
             try:
                 psutil.Process(process.pid).terminate()
             except psutil.NoSuchProcess:
                 pass
             return 1
-
-        return 0 if process.returncode == 0 else 1

{better_ffmpeg_progress-3.1.0 → better_ffmpeg_progress-3.2.1}/better_ffmpeg_progress.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: better-ffmpeg-progress
-Version: 3.1.0
+Version: 3.2.1
 Summary: Run FFmpeg & see percentage progress + ETA.
 Home-page: https://github.com/CrypticSignal/better-ffmpeg-progress
 Author: GitHub.com/CrypticSignal
@@ -15,6 +15,7 @@ License-File: LICENSE
 Requires-Dist: ffmpeg-python
 Requires-Dist: psutil
 Requires-Dist: rich
+Requires-Dist: tqdm
 
 <div align="center">
 
@@ -25,6 +26,8 @@ Requires-Dist: rich
 
 # Better FFmpeg Progress
 Runs an FFmpeg command and shows a progress bar with percentage progress, time elapsed and ETA.
+
+The [Rich](https://github.com/Textualize/rich) library is used for the progress bar by default, [tqdm](https://github.com/tqdm/tqdm) will be used if you pass `use_tqdm=True` to the `run` method.
 </div>
 
 FFmpeg outputs something like:
@@ -38,7 +41,7 @@ Better FFmpeg Progress outputs something like:
 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.
+- `0:00:04` is the time elapsed.
 - `00:15` is the estimated time until the FFmpeg process completes.
 
 As you can see, the output of Better FFmpeg Progress is much more useful.
@@ -56,24 +59,17 @@ Here's a simple example:
 from better_ffmpeg_progress import FfmpegProcess
 
 process = FfmpegProcess(["ffmpeg", "-i", "input.mp4", "-c:v", "libx265", "output.mp4"])
-
-# return_code will be 0 if the process was successful
+# return_code will be 0 if the process completed successfully, otherwise it will be 1
 return_code = process.run()
-
-if return_code == 0:
-    # Code to run if the process was successful
-    pass
-else:
-    # Code to run if the process was unsuccessful
-    pass
 ```
 ## Optional Arguments
 An instance of the `FfmpegProcess` class takes the following **optional** arguments:
 
 - `ffmpeg_log_level` - Desired FFmpeg log level. Default: `"verbose"`
-- `ffmpeg_log_file` - The filepath to save the FFmpeg log to.
-- `print_detected_duration` - Print the detected duration of the input file. Default: `True`
+- `ffmpeg_log_file` - The filepath to save the FFmpeg log to. Default: `<input filename>_log.txt`
+- `print_detected_duration` - Print the detected duration of the input file. Default: `False`
 - `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`
 
-The `run` method takes the following **optional** argument:
+The `run` method takes the following **optional** arguments:
 - `print_command` - Print the FFmpeg command being executed. Default: `False`
+- `use_tqdm` - Use [tqdm](https://github.com/tqdm/tqdm) instead of [Rich](https://github.com/Textualize/rich) for the progress bar. Default: `False`

{better_ffmpeg_progress-3.1.0 → better_ffmpeg_progress-3.2.1}/better_ffmpeg_progress.egg-info/requires.txt

@@ -1,3 +1,4 @@
 ffmpeg-python
 psutil
 rich
+tqdm

{better_ffmpeg_progress-3.1.0 → better_ffmpeg_progress-3.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="3.1.0",
+    version="3.2.1",
     author="GitHub.com/CrypticSignal",
     author_email="theaudiophile@outlook.com",
     description="Run FFmpeg & see percentage progress + ETA.",
@@ -13,7 +13,7 @@ setuptools.setup(
     long_description_content_type="text/markdown",
     url="https://github.com/CrypticSignal/better-ffmpeg-progress",
     packages=["better_ffmpeg_progress"],
-    install_requires=["ffmpeg-python", "psutil", "rich"],
+    install_requires=["ffmpeg-python", "psutil", "rich", "tqdm"],
     python_requires=">=3.7",
     keywords=["ffmpeg", "progress"],
     classifiers=[