peg-this 3.0.2__py3-none-any.whl → 4.1.0__py3-none-any.whl

peg_this/utils/ffmpeg_utils.py

@@ -0,0 +1,129 @@
+
+import subprocess
+import logging
+import sys
+
+import ffmpeg
+from rich.console import Console
+from rich.progress import Progress, SpinnerColumn, BarColumn, TextColumn
+
+console = Console()
+
+
+def check_ffmpeg_ffprobe():
+    """
+    Checks if ffmpeg and ffprobe executables are available in the system's PATH.
+    ffmpeg-python requires this.
+    """
+    try:
+        # The library does this internally, but we can provide a clearer error message.
+        subprocess.check_call(['ffmpeg', '-version'], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+        subprocess.check_call(['ffprobe', '-version'], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+    except FileNotFoundError:
+        console.print("[bold red]Error: ffmpeg and ffprobe not found.[/bold red]")
+        if sys.platform == "win32":
+            console.print("You can install it using Chocolatey: [bold]choco install ffmpeg[/bold]")
+            console.print("Or Scoop: [bold]scoop install ffmpeg[/bold]")
+        elif sys.platform == "darwin":
+            console.print("You can install it using Homebrew: [bold]brew install ffmpeg[/bold]")
+        else:
+            console.print("You can install it using your system's package manager, e.g., [bold]sudo apt update && sudo apt install ffmpeg[/bold] on Debian/Ubuntu.")
+        console.print("Please ensure its location is in your system's PATH.")
+        sys.exit(1)
+
+
+def run_command(stream_spec, description="Processing...", show_progress=False):
+    """
+    Runs an ffmpeg command using ffmpeg-python.
+    - For simple commands, it runs directly.
+    - For commands with a progress bar, it generates the ffmpeg arguments,
+      runs them as a subprocess, and parses stderr to show progress.
+    Returns True on success, False on failure.
+    """
+    console.print(f"[bold cyan]{description}[/bold cyan]")
+    
+    args = stream_spec.get_args()
+    full_command = ['ffmpeg'] + args
+    logging.info(f"Executing command: {' '.join(full_command)}")
+
+    if not show_progress:
+        try:
+            # Use ffmpeg.run() for simple, non-progress tasks. It's cleaner.
+            ffmpeg.run(stream_spec, capture_stdout=True, capture_stderr=True, quiet=True)
+            logging.info("Command successful (no progress bar).")
+            return True
+        except ffmpeg.Error as e:
+            error_message = e.stderr.decode('utf-8')
+            console.print("[bold red]An error occurred:[/bold red]")
+            console.print(error_message)
+            logging.error(f"ffmpeg error:{error_message}")
+            return False
+    else:
+        # For the progress bar, we must run ffmpeg as a subprocess and parse stderr.
+        duration = 0
+        try:
+            input_file_path = None
+            for i, arg in enumerate(full_command):
+                if arg == '-i' and i + 1 < len(full_command):
+                    input_file_path = full_command[i+1]
+                    break
+            
+            if input_file_path:
+                probe_info = ffmpeg.probe(input_file_path)
+                duration = float(probe_info['format']['duration'])
+            else:
+                logging.warning("Could not find input file in command to determine duration for progress bar.")
+
+        except (ffmpeg.Error, KeyError) as e:
+            console.print(f"[bold yellow]Warning: Could not determine video duration for progress bar.[/bold yellow]")
+            logging.warning(f"Could not probe for duration: {e}")
+
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            BarColumn(),
+            TextColumn("[progress.percentage]{task.percentage:>3.0f}%"),
+            console=console,
+        ) as progress:
+            task = progress.add_task(description, total=100)
+            
+            process = subprocess.Popen(
+                full_command,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                universal_newlines=True,
+                encoding='utf-8'
+            )
+
+            for line in process.stderr:
+                logging.debug(f"ffmpeg stderr: {line.strip()}")
+                if "time=" in line and duration > 0:
+                    try:
+                        time_str = line.split("time=")[1].split(" ")[0].strip()
+                        h, m, s_parts = time_str.split(':')
+                        s = float(s_parts)
+                        elapsed_time = int(h) * 3600 + int(m) * 60 + s
+                        percent_complete = (elapsed_time / duration) * 100
+                        progress.update(task, completed=min(percent_complete, 100))
+                    except Exception:
+                        pass
+
+            process.wait()
+            progress.update(task, completed=100)
+            
+            if process.returncode != 0:
+                log_file = logging.getLogger().handlers[0].baseFilename
+                console.print(f"[bold red]An error occurred during processing. Check {log_file} for details.[/bold red]")
+                return False
+        
+        logging.info("Command successful (with progress bar).")
+        return True
+
+
+def has_audio_stream(file_path):
+    """Check if the media file has an audio stream."""
+    try:
+        probe = ffmpeg.probe(file_path, select_streams='a')
+        return 'streams' in probe and len(probe['streams']) > 0
+    except ffmpeg.Error:
+        return False

peg_this/utils/ui_utils.py

@@ -0,0 +1,52 @@
+
+import os
+from pathlib import Path
+
+import questionary
+from rich.console import Console
+
+try:
+    import tkinter as tk
+    from tkinter import filedialog
+except ImportError:
+    tk = None
+
+console = Console()
+
+
+def get_media_files():
+    """Scan the current directory for media files."""
+    media_extensions = [
+        # Video
+        ".mkv", ".mp4", ".avi", ".mov", ".webm", ".flv", ".wmv", 
+        # Audio
+        ".mp3", ".flac", ".wav", ".ogg", 
+        # GIF
+        ".gif",
+        # Image
+        ".jpg", ".jpeg", ".png", ".webp", ".bmp", ".tiff"
+    ]
+    files = [f for f in os.listdir('.') if os.path.isfile(f) and Path(f).suffix.lower() in media_extensions]
+    return files
+
+
+def select_media_file():
+    """Display a menu to select a media file, or open a file picker."""
+    media_files = get_media_files()
+    if not media_files:
+        console.print("[bold yellow]No media files found in this directory.[/bold yellow]")
+        if tk and questionary.confirm("Would you like to select a file from another location?").ask():
+            root = tk.Tk()
+            root.withdraw()
+            file_path = filedialog.askopenfilename(
+                title="Select a media file",
+                filetypes=[("Media Files", "*.mkv *.mp4 *.avi *.mov *.webm *.flv *.wmv *.mp3 *.flac *.wav *.ogg *.gif *.jpg *.jpeg *.png *.webp *.bmp *.tiff"), ("All Files", "*.*")]
+            )
+            return file_path if file_path else None
+        return None
+
+    choices = media_files + [questionary.Separator(), "Back"]
+    file = questionary.select("Select a media file to process:", choices=choices, use_indicator=True).ask()
+    
+    # Return the absolute path to prevent "file not found" errors
+    return os.path.abspath(file) if file and file != "Back" else None

peg_this/utils/validation.py

@@ -0,0 +1,228 @@
+import os
+import re
+import shutil
+from pathlib import Path
+
+import ffmpeg
+import questionary
+from rich.console import Console
+
+console = Console()
+
+
+def check_file_exists(file_path):
+    if not os.path.exists(file_path):
+        console.print("[bold red]Error: File not found.[/bold red]")
+        return False
+    return True
+
+
+def check_file_readable(file_path):
+    if not os.access(file_path, os.R_OK):
+        console.print("[bold red]Error: Cannot read file. Check permissions.[/bold red]")
+        return False
+    return True
+
+
+def check_write_permission(directory):
+    if not os.access(directory, os.W_OK):
+        console.print("[bold red]Error: Cannot write to this location. Check permissions.[/bold red]")
+        return False
+    return True
+
+
+def validate_input_file(file_path):
+    if not check_file_exists(file_path):
+        return False
+    if not check_file_readable(file_path):
+        return False
+    return True
+
+
+def check_output_file(output_path, file_type="file"):
+    if not os.path.exists(output_path):
+        return 'proceed', output_path
+
+    console.print(f"[yellow]Warning: {file_type} already exists:[/yellow]")
+    console.print(f"[dim]{output_path}[/dim]")
+
+    choice = questionary.select(
+        "What would you like to do?",
+        choices=["Overwrite existing file", "Save with a new name", "Cancel operation"]
+    ).ask()
+
+    if not choice or "Cancel" in choice:
+        return 'cancel', None
+    elif "Overwrite" in choice:
+        return 'overwrite', output_path
+    else:
+        path = Path(output_path)
+        counter = 1
+        while True:
+            new_name = f"{path.stem}_{counter}{path.suffix}"
+            new_path = path.with_name(new_name)
+            if not os.path.exists(new_path):
+                console.print(f"[cyan]Will save as: {new_path.name}[/cyan]")
+                return 'rename', str(new_path)
+            counter += 1
+
+
+def check_disk_space(file_path, multiplier=2):
+    try:
+        input_size = os.path.getsize(file_path)
+        required_space = input_size * multiplier
+        total, used, free = shutil.disk_usage(Path(file_path).parent)
+        if free < required_space:
+            free_gb = free / (1024**3)
+            required_gb = required_space / (1024**3)
+            console.print(f"[yellow]Warning: Low disk space![/yellow]")
+            console.print(f"[dim]Available: {free_gb:.1f} GB, Estimated needed: {required_gb:.1f} GB[/dim]")
+            if not questionary.confirm("Continue anyway?", default=False).ask():
+                return False
+        return True
+    except Exception:
+        return True
+
+
+def get_video_duration(file_path):
+    try:
+        probe = ffmpeg.probe(file_path)
+        return float(probe['format'].get('duration', 0))
+    except Exception:
+        return 0
+
+
+def format_duration(seconds):
+    if seconds < 60:
+        return f"{int(seconds)} seconds"
+    elif seconds < 3600:
+        mins = int(seconds // 60)
+        secs = int(seconds % 60)
+        return f"{mins}m {secs}s"
+    else:
+        hours = int(seconds // 3600)
+        mins = int((seconds % 3600) // 60)
+        return f"{hours}h {mins}m"
+
+
+def parse_time_to_seconds(time_str):
+    time_str = time_str.strip()
+
+    # Already in seconds (numeric)
+    if re.match(r'^\d+(\.\d+)?$', time_str):
+        return float(time_str)
+
+    # HH:MM:SS or MM:SS format
+    if re.match(r'^\d{1,2}:\d{2}(:\d{2})?(\.\d+)?$', time_str):
+        parts = time_str.split(':')
+        if len(parts) == 2:
+            mins, secs = parts
+            return int(mins) * 60 + float(secs)
+        elif len(parts) == 3:
+            hours, mins, secs = parts
+            return int(hours) * 3600 + int(mins) * 60 + float(secs)
+
+    return None
+
+
+def validate_time_input(time_str, max_duration=None, field_name="Time"):
+    seconds = parse_time_to_seconds(time_str)
+
+    if seconds is None:
+        console.print(f"[bold red]Invalid {field_name.lower()} format. Use HH:MM:SS, MM:SS, or seconds.[/bold red]")
+        return None
+
+    if seconds < 0:
+        console.print(f"[bold red]{field_name} cannot be negative.[/bold red]")
+        return None
+
+    if max_duration and seconds > max_duration:
+        console.print(f"[bold red]{field_name} ({format_duration(seconds)}) exceeds video duration ({format_duration(max_duration)}).[/bold red]")
+        return None
+
+    return seconds
+
+
+def validate_time_range(start_str, end_str, duration):
+    start = validate_time_input(start_str, duration, "Start time")
+    if start is None:
+        return None, None
+
+    end = validate_time_input(end_str, duration, "End time")
+    if end is None:
+        return None, None
+
+    if end <= start:
+        console.print("[bold red]End time must be greater than start time.[/bold red]")
+        return None, None
+
+    clip_duration = end - start
+    console.print(f"[dim]Clip duration: {format_duration(clip_duration)}[/dim]")
+
+    return start, end
+
+
+def check_has_video_stream(file_path):
+    try:
+        probe = ffmpeg.probe(file_path, select_streams='v')
+        return len(probe.get('streams', [])) > 0
+    except Exception:
+        return False
+
+
+def check_has_audio_stream(file_path):
+    try:
+        probe = ffmpeg.probe(file_path, select_streams='a')
+        return len(probe.get('streams', [])) > 0
+    except Exception:
+        return False
+
+
+def warn_long_operation(duration, threshold=300, operation="This operation"):
+    if duration > threshold:
+        console.print(f"[yellow]Note: {operation} may take a while for this {format_duration(duration)} video.[/yellow]")
+        if not questionary.confirm("Continue?", default=True).ask():
+            return False
+    return True
+
+
+def warn_reencode(operation="This operation"):
+    console.print(f"[dim]{operation} requires re-encoding and may take a while...[/dim]")
+
+
+def handle_keyboard_interrupt():
+    console.print("\n[yellow]Operation cancelled by user.[/yellow]")
+
+
+def generate_output_path(input_path, suffix, new_extension=None):
+    p = Path(input_path)
+    ext = new_extension if new_extension else p.suffix
+    return str(p.with_name(f"{p.stem}_{suffix}{ext}"))
+
+
+def get_file_size_mb(file_path):
+    try:
+        size = os.path.getsize(file_path)
+        return size / (1024 * 1024)
+    except Exception:
+        return 0
+
+
+def validate_positive_integer(value, field_name="Value"):
+    try:
+        num = int(value)
+        if num <= 0 and num != -1:  # -1 is valid for "auto" in some contexts
+            console.print(f"[bold red]{field_name} must be a positive number.[/bold red]")
+            return None
+        return num
+    except ValueError:
+        console.print(f"[bold red]{field_name} must be a valid number.[/bold red]")
+        return None
+
+
+def confirm_operation(message, default=True):
+    return questionary.confirm(message, default=default).ask()
+
+
+def press_continue():
+    questionary.press_any_key_to_continue().ask()

peg_this-4.1.0.dist-info/METADATA

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: peg_this
+Version: 4.1.0
+Summary: A powerful and intuitive command-line video editor, built on FFmpeg.
+Author-email: Hariharen S S <thisishariharen@gmail.com>
+Maintainer-email: Hariharen S S <thisishariharen@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/hariharen9/ffmpeg-this
+Project-URL: Documentation, https://github.com/hariharen9/ffmpeg-this/blob/main/README.md
+Project-URL: Repository, https://github.com/hariharen9/ffmpeg-this
+Project-URL: Changelog, https://github.com/hariharen9/ffmpeg-this/releases
+Project-URL: Bug Tracker, https://github.com/hariharen9/ffmpeg-this/issues
+Project-URL: Funding, https://www.buymeacoffee.com/hariharen
+Project-URL: Sponsor, https://github.com/sponsors/hariharen9
+Keywords: ffmpeg,video,audio,media,converter,editor,cli,subtitles,whisper,transcription,trim,crop,compress,gif,batch
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Multimedia
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Multimedia :: Video :: Conversion
+Classifier: Topic :: Multimedia :: Video :: Non-Linear Editor
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Sound/Audio :: Conversion
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ffmpeg-python==0.2.0
+Requires-Dist: questionary>=2.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: Pillow>=9.0.0
+Requires-Dist: faster-whisper>=1.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+<h1 align="center">FFm<u><i>PEG</i></u>-this</h1>
+
+<p align="center">
+    <a href="https://pypi.org/project/peg-this/">
+        <img src="https://img.shields.io/pypi/v/peg_this?color=blue&label=version" alt="PyPI Version">
+    </a>
+    <a href="https://pypi.org/project/peg-this/">
+        <img src="https://img.shields.io/pypi/pyversions/peg_this.svg" alt="PyPI Python Versions">
+    </a>
+    <a href="https://github.com/hariharen9/ffmpeg-this/blob/main/LICENSE">
+        <img src="https://img.shields.io/github/license/hariharen9/ffmpeg-this" alt="License">
+    </a>
+    <a href="https://pepy.tech/project/peg-this">
+        <img src="https://static.pepy.tech/badge/peg-this" alt="Downloads">
+    </a>
+</p>
+
+<p align="center"><b>Your Editor within CLI</b></p>
+
+A powerful and user-friendly Python CLI tool for converting, manipulating, and inspecting media files using the power of FFmpeg. This tool provides a simple command-line menu to perform common audio and video tasks without needing to memorize complex FFmpeg commands.
+
+<p align="center">
+    <img src="/assets/peg.gif" width="720">
+</p>
+
+## Features at a Glance
+
+| Category | Feature | Description |
+|----------|---------|-------------|
+| **Inspect** | Media Properties | View detailed codec, resolution, frame rate, bitrate, and stream information |
+| **Convert** | Video Formats | Convert to MP4, MKV, MOV, AVI, WebM with quality presets (CRF 18/23/28) |
+| | Audio Formats | Convert to MP3 (128k-320k bitrate), FLAC, WAV |
+| | GIF Creation | Convert video clips to animated GIFs with optimized palette |
+| | Image Formats | Convert between JPG, PNG, WebP, BMP, TIFF with quality control |
+| **Subtitles** | AI Transcription | Generate subtitles using Whisper AI (7 model sizes available) |
+| | Sidecar Export | Save as `.srt`, `.vtt`, `.txt`, or `.lrc` files |
+| | Soft Subtitles | Embed toggleable subtitle track into video |
+| | Hard Subtitles | Burn permanent subtitles directly into video |
+| | Multi-language | Support for 99+ languages with auto-detection |
+| **Edit** | Trim/Cut | Extract video segments by start/end time (lossless, no re-encoding) |
+| | Visual Crop | Interactive GUI to select crop area on video/image |
+| | Join/Concatenate | Merge multiple videos with automatic resolution matching |
+| **Audio** | Extract Audio | Rip audio track to MP3, FLAC, or WAV |
+| | Remove Audio | Create silent version of video (keeps video intact) |
+| **Image** | Resize | Scale images with aspect ratio preservation |
+| | Rotate | Rotate 90°, 180°, or 270° |
+| | Flip | Flip horizontally or vertically |
+| | Crop | Visual cropping with click-and-drag selection |
+| **Batch** | Batch Convert | Convert all media files in directory at once |
+
+## Detailed Feature Breakdown
+
+### Video Operations
+
+| Operation | Input | Output | Method | Re-encoding |
+|-----------|-------|--------|--------|-------------|
+| **Convert** | Any video | MP4, MKV, MOV, AVI, WebM | FFmpeg transcode | Yes (CRF quality) |
+| **Trim** | Any video | Same format | Stream copy | No (lossless) |
+| **Crop** | Any video | Same format | Visual selection + crop filter | Yes |
+| **Join** | Multiple videos | Single MP4 | Concat filter + normalize | Yes |
+| **To GIF** | Any video | Animated GIF | 2-pass palette optimization | Yes |
+
+### Audio Operations
+
+| Operation | Input | Output | Notes |
+|-----------|-------|--------|-------|
+| **Extract** | Video with audio | MP3, FLAC, WAV | Preserves original quality for FLAC/WAV |
+| **Remove** | Video with audio | Silent video | Stream copy (fast, no re-encoding) |
+| **Convert** | Audio file | MP3, FLAC, WAV | Bitrate selection for MP3 |
+
+### Subtitle Generation
+
+| Model | Size | Speed | Accuracy | Languages |
+|-------|------|-------|----------|-----------|
+| `tiny.en` | ~75 MB | Fastest | Good | English only |
+| `base.en` | ~150 MB | Fast | Better | English only |
+| `small.en` | ~500 MB | Balanced | Great | English only |
+| `medium.en` | ~1.5 GB | Slower | Excellent | English only |
+| `small` | ~500 MB | Balanced | Great | 99+ languages |
+| `medium` | ~1.5 GB | Slower | Excellent | 99+ languages |
+| `large-v3` | ~3 GB | Slowest | Best | 99+ languages |
+
+**Output Options:**
+| Type | File Extension | Description |
+|------|----------------|-------------|
+| Sidecar | `.srt` | SubRip - most compatible format |
+| Sidecar | `.vtt` | WebVTT - for web/HTML5 players |
+| Sidecar | `.txt` | Plain text transcript |
+| Sidecar | `.lrc` | Lyrics format with timestamps |
+| Soft Subs | `.mp4/.mkv` | Embedded, toggleable in players |
+| Hard Subs | `.mp4/.mkv` | Burned in, always visible |
+
+### Image Operations
+
+| Operation | Options | Notes |
+|-----------|---------|-------|
+| **Convert** | JPG, PNG, WebP, BMP, TIFF | Quality presets (95%, 80%, 60%) |
+| **Resize** | Custom width/height | Use `-1` to preserve aspect ratio |
+| **Rotate** | 90° CW, 90° CCW, 180° | Lossless rotation |
+| **Flip** | Horizontal, Vertical | Mirror image |
+| **Crop** | Visual selection | Interactive GUI with preview |
+
+### Supported Formats
+
+| Type | Supported Formats |
+|------|-------------------|
+| **Video Input** | `.mp4`, `.mkv`, `.avi`, `.mov`, `.webm`, `.flv`, `.wmv`, `.gif` |
+| **Video Output** | `.mp4`, `.mkv`, `.mov`, `.avi`, `.webm`, `.gif` |
+| **Audio Input** | `.mp3`, `.flac`, `.wav`, `.ogg`, `.aac`, `.m4a` |
+| **Audio Output** | `.mp3`, `.flac`, `.wav` |
+| **Image Input** | `.jpg`, `.jpeg`, `.png`, `.webp`, `.bmp`, `.tiff` |
+| **Image Output** | `.jpg`, `.png`, `.webp`, `.bmp`, `.tiff` |
+| **Subtitle Output** | `.srt`, `.vtt`, `.txt`, `.lrc` |
+
+## Usage
+
+### Prerequisite: Install FFmpeg
+
+> [!NOTE]
+> `peg_this` uses a library called `ffmpeg-python` which acts as a controller for the main FFmpeg program. It does not include FFmpeg itself. Therefore, you must have FFmpeg installed on your system and available in your terminal's PATH.
+
+For **macOS** users, the easiest way to install it is with [Homebrew](https://brew.sh/):
+```bash
+brew install ffmpeg
+```
+
+For **Windows** users, you can use a package manager like [Chocolatey](https://chocolatey.org/) or [Scoop](https://scoop.sh/):
+```bash
+# Using Chocolatey
+choco install ffmpeg
+
+# Using Scoop
+scoop install ffmpeg
+```
+
+For other systems, please see the official download page: **[ffmpeg.org/download.html](https://ffmpeg.org/download.html)**
+
+There are three ways to use `peg_this`:
+
+### 1. Pip Install (Recommended)
+This is the easiest way to get started. This will install the tool and all its dependencies.
+
+```bash
+pip install peg_this
+```
+
+Once installed, you can run the tool from your terminal:
+
+```bash
+peg_this
+```
+
+### 2. Download from Release
+If you prefer not to install the package, you can download a pre-built executable from the [Releases](https://github.com/hariharen9/ffmpeg-this/releases/latest) page.
+
+1.  Download the executable for your operating system (Windows, macOS, or Linux).
+2.  Place it in a directory with your media files.
+3.  Run the executable directly from your terminal.
+
+### 3. Run from Source
+If you want to run the tool directly from the source code:
+
+1.  **Clone the repository:**
+    ```bash
+    git clone https://github.com/hariharen9/ffmpeg-this.git
+    cd ffmpeg-this
+    ```
+2.  **Install dependencies:**
+    ```bash
+    pip install -r requirements.txt
+    ```
+3.  **Run the tool:**
+    ```bash
+    python -m src.peg_this.peg_this
+    ```
+
+## Subtitle Generation
+
+The subtitle feature uses [faster-whisper](https://github.com/SYSTRAN/faster-whisper), a fast and accurate speech-to-text engine powered by OpenAI's Whisper model.
+
+### How it works
+
+1. Select a video file
+2. Choose "Generate Subtitles (Whisper)"
+3. Pick a model size (tiny to large-v3)
+4. Select processing mode (Fast or Accurate)
+5. Choose output type:
+   - **Sidecar file**: Export as `.srt`, `.vtt`, `.txt`, or `.lrc`
+   - **Soft subtitles**: Embed into video (can be toggled on/off in players)
+   - **Hard subtitles**: Burn into video (permanent, always visible)
+
+### Supported Languages
+
+Using multilingual models (`small`, `medium`, `large-v3`), you can transcribe audio in 99+ languages including English, Spanish, French, German, Chinese, Japanese, Korean, Hindi, Arabic, and many more.
+
+## Star History
+
+<p align="center">
+  <a href="https://star-history.com/#hariharen9/ffmpeg-this&Date">
+    <img src="https://api.star-history.com/svg?repos=hariharen9/ffmpeg-this&type=Date" alt="Star History Chart">
+  </a>
+</p>
+
+## Sponsor
+
+<p align="center">
+    <a href="https://github.com/sponsors/hariharen9">
+        <img src="https://img.shields.io/github/sponsors/hariharen9?style=for-the-badge&logo=github&color=white" alt="GitHub Sponsors">
+    </a>
+    <a href="https://www.buymeacoffee.com/hariharen">
+        <img src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black" alt="Buy Me a Coffee">
+    </a>
+</p>
+
+## Contributors
+
+<a href="https://github.com/hariharen9/ffmpeg-this/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=hariharen9/ffmpeg-this" />
+</a>
+
+## Contributing
+
+Contributions are welcome! Please see the [Contributing Guidelines](CONTRIBUTING.md) for more information.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+<p align="center">
+    Made with ❤️ by <a href="https://hariharen.site">Hariharen</a>
+</p>