clippr 0.1.1 - Docs.rs

clippr converts MP4 screen recordings into chunked GIFs that fit under GitHub's file size limits. It automatically splits long videos into 3-second segments and iteratively compresses each chunk to stay under the target size.

Prerequisites

ffmpeg and ffprobe must be installed and available in your PATH.

Quick Start

clippr demo.mp4

This produces demo_001.gif, demo_002.gif, etc. — one per 3-second chunk, each under 10MB.

Usage

clippr demo.mp4                         # Outputs chunked GIFs, auto-sized to <10MB each

clippr demo.mp4 -o out.gif              # Custom output base name

clippr demo.mp4 --max-size-mb 5         # Custom size target per chunk

clippr demo.mp4 --width 640 --fps 20    # Override starting parameters

clippr demo.mp4 --chunk-secs 5          # 5-second chunks instead of 3

If the video is 3 seconds or shorter, a single demo.gif is produced without a numeric suffix.

Options

Flag	Default	Description
`-o, --output`	Input filename	Output base path (extension stripped, chunks get `_001`, `_002`, etc.)
`--max-size-mb`	`10`	Maximum file size per chunk in MB
`--width`	`480`	Starting width in pixels (capped at source width)
`--fps`	`15`	Starting frames per second (capped at source framerate)
`--colors`	`256`	Starting palette color count
`--chunk-secs`	`3.0`	Duration of each chunk in seconds
`--gui`		Launch the graphical interface (requires `gui` feature)

How It Works

Probe the input video with ffprobe to get dimensions, framerate, and duration
Split the video into chunks of --chunk-secs duration
Encode each chunk as a GIF using ffmpeg's single-pass palettegen/paletteuse pipeline with lanczos scaling and Floyd-Steinberg dithering
Auto-size — if a chunk exceeds the target size, iteratively reduce parameters and re-encode:
- Width first (sqrt of ratio, since pixel count is quadratic) — minimum 240px
- FPS second — minimum 8fps
- Colors last (256 → 128 → 64 → 32) — minimum 32
Fail with a clear error if the target is unreachable after 5 attempts

The source video is never modified.

Example Output

$ clippr recording.mp4
input: 802x632, 30.0fps, 10.9s

segment: 0.0s - 3.0s (3.0s)
  -> 4.75 MB (fits at full quality)

segment: 3.0s - 6.0s (3.0s)
  -> 5.03 MB (fits at full quality)

segment: 6.0s - 9.0s (3.0s)
  -> 3.04 MB (fits at full quality)

segment: 9.0s - 10.9s (1.9s)
  -> 1.12 MB (fits at full quality)

done — 4 chunk(s) written:
  recording_001.gif
  recording_002.gif
  recording_003.gif
  recording_004.gif

GUI

clippr includes an optional native GUI for selecting a video, configuring parameters, and running the conversion with live progress output. Enable it with the gui feature:

cargo install clippr --features gui

clippr --gui

When compiled with the gui feature, running clippr with no arguments also launches the GUI.

License

Dual-licensed under MIT (LICENSE-MIT) or Apache 2.0 (LICENSE-APACHE).