🖥️ About

Welcome to the HandbrakeCLI Batch Compressor project!

This application is designed to compress video files in bulk using the HandbrakeCLI. It offers many features to customize the compression process such as:

• deletion of original files
• show statistics during and after the compression
• smart filtering and skipping of files based on your specified rules (see usage)

📑 Table of Contents

• 🖥️ About
  • 📑 Table of Contents
  • ✨ Features
  • 📸 Screenshots
  • 🛠️ Installation
  • 🚀 Usage and Examples
    • ⚙️ Advanced Usage
  • 🧠 Smart Filters
  • 📜 License

✨ Features

• Bulk Compression: Compress multiple video files at once using HandbrakeCLI.
• Custom Compression Options: Pass any options available in HandbrakeCLI, like encoders and quality settings.
• File Management: Automatically detect compressed and incomplete files if your process is interrupted.
• Filter Features: Smart filters allow skipping videos that don't meet your criteria (e.g., resolution, bitrate, or frame rate).
• Statistics: Optionally display compression stats during and after the process.
• Replace Original Files: Automatically delete original files if they are successfully compressed.
• Automatic Installation: Automatically install HandbrakeCLI and dependencies if not already installed.

📸 Screenshots

🛠️ Installation

1. Install python:

   • Window:

     winget install Python.Python.3.12
     

   • Linux:

     sudo apt-get install python3
     

   • macOS:

     brew install python
     

2. Install the handbrake-batch-compressor package:

   pip install handbrake-batch-compressor
   

3. Run the application:

   handbrake-batch-compressor --help
   

🚀 Usage and Examples

Highly recommended to see both --help and --guide before compression.

⚙️ Advanced Usage

You can specify more options such as HandbrakeCLI settings, file extensions, and whether to delete the originals after processing.

python main.py -t ./videos -o "--encoder x264 --quality 20" \
    --progress-extension c \
    --complete-extension x \
    --show-stats \
    --effective-compression-behavior delete_original \
    --ineffective-compression-behavior delete_compressed

🧠 Smart Filters

Smart filters allow you to apply conditions that control which videos will be processed based on their characteristics.

• Minimum Bitrate: Skips videos with a bitrate lower than the specified value.
• Minimum Frame Rate: Skips videos with a frame rate lower than the specified value.
• Minimum Resolution: Skips videos with a resolution lower than the specified threshold.

These filters help avoid unnecessary processing of low-quality videos.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.