Skip to main content

Video reduction tool

Project description

Video Encoder Utility

PyPI - Version Python package

Overview

jelly_coder scans a folder for supported videos (.mkv, .mp4, .wmv, .mwv, .avi, .webm) and re-encodes them with size-aware defaults. It keeps subtitles/metadata, flips containers when MP4 constraints are violated, and preserves a mirrored directory tree when you choose not to overwrite in place.

Key capabilities:

  • Automatic encoder selection with hardware-first preference (NVENC → QSV → AMF → x264) and explicit backend override flags.
  • Height presets (auto, 1080p, 720p, 480p, 360p) with bitrate scaling so smaller outputs also shrink file size.
  • Smart audio handling: copies compatible streams, forces stereo when sources are mono or pseudo-mono (e.g., WMV files with only one active channel), and warns about downmixing.
  • Hardware fallbacks: if a chosen hardware encoder fails to create a session, the tool transparently repeats the job with libx264 so the batch continues.

Prerequisites

  • Windows PowerShell 5.1 (default shell for the repo scripts).
  • Python 3.11+ with virtual environment support.
  • ffmpeg and ffprobe in PATH.
    • Hardware backends require vendor drivers and an ffmpeg build with NVENC/QSV/AMF enabled.

Installation

python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install --upgrade pip
pip install -e .

Usage

# Show CLI help
python -m jelly_coder --help

# Reduce a folder, mirror outputs under ./output/<dir>, auto-select backend
python -m jelly_coder D:\media --quality 720p

# Force Intel QSV, enable overwrite, run at debug verbosity
python -m jelly_coder D:\media --backend qsv --overwrite --log-level debug

# Change the display aspect ratio to 16:9
python -m jelly_coder D:\media --aspect 16:9

# Legacy wrapper remains available
python encode_videos.py D:\media

Key Flags

  • PATH (positional): Directory scanned recursively for supported video extensions.
  • --backend BACKEND: auto (default), nvenc, x264, qsv, or amf.
  • --codec CODEC: Hint h264 or hevc; respected when the backend supports it.
  • --quality PRESET: Downscale preset (auto, 1080p, 720p, 480p, 360p).
  • --aspect W:H: Set the output display aspect ratio (e.g. 16:9, 4:3).
  • --max-workers N: Concurrent encodes (default 1; hardware encoders generally behave best at 1).
  • --overwrite: Replace sources in place. When omitted, outputs land in ./output/<input-folder>.
  • --output PATH: Custom output directory root when not overwriting.
  • --log-level LEVEL: info (default), debug, warning, etc.

Output Behavior

  • MP4 targets convert SubRip/ASS to mov_text automatically; incompatible streams trigger a fallback to MKV.
  • Attached artwork, metadata, and subtitle tracks are propagated.
  • When the output is larger than the input, a warning is emitted so you can review or delete the file.
  • Audio streams are copied when safe; otherwise they are re-encoded to AAC 192k stereo, duplicating the dominant channel if the source is effectively mono.

Encoder Backends

  • Auto: Queries ffmpeg encoders and picks the best available hardware backend (NVENC → QSV → AMF → x264).
  • NVENC/QSV/AMF: Uses vendor hardware. Hardware decode fallbacks are attempted before giving up.
  • x264: Software-only; always available.
  • If a hardware backend exhausts its attempts (e.g., Error creating a MFX session: -9 on QSV), the utility logs a warning and re-runs the encode with libx264 automatically.

Audio Handling

  • ffprobe insights drive copy-or-transcode decisions.
  • WMV inputs and other stereo tracks with severe channel imbalance trigger a sampling step; if only one channel has meaningful signal, the tool duplicates it so the result plays on both speakers.
  • Mono and surround sources are converted to stereo with informative log messages about the change.

Development

  • Run python -m pytest and flake8 before committing; coverage is enforced at 100%.
  • python -m jelly_coder --help verifies CLI wiring after refactors.
  • VS Code launchers in .vscode/launch.json provide ready-to-run debug sessions.

Troubleshooting

  • Validate ffmpeg exposes the expected encoders: ffmpeg -hide_banner -encoders | Select-String nvenc.
  • Hardware backends may need up-to-date GPU/Media drivers; keep Windows and vendor packages current.
  • Delete partial outputs in output/ if you want to re-run without --overwrite.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jellycoder-1.2.0.tar.gz (65.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jellycoder-1.2.0-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file jellycoder-1.2.0.tar.gz.

File metadata

  • Download URL: jellycoder-1.2.0.tar.gz
  • Upload date:
  • Size: 65.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for jellycoder-1.2.0.tar.gz
Algorithm Hash digest
SHA256 3b5b1420686b652bad92b2ee7f4179805dd2c79f8b211cf4b9b661676b54c3db
MD5 986a9cd80a80a6c62ccbab3056f82093
BLAKE2b-256 1f1dd9d83a17450dababec8af9c25e9cae339eb83c657e27dd25be14c678dc4e

See more details on using hashes here.

File details

Details for the file jellycoder-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: jellycoder-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 41.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for jellycoder-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d62f54722ef0da3b1998d8281fd61dce88dd8573b63101a9629d372bd5b1970e
MD5 d1a7e556ac55826022fa52f0249b6df5
BLAKE2b-256 10e8d3ebb02c05161231296b6e40e9b4cdae4feb070fde293f3805d54aa2ad50

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page