Skip to main content

CLI tool to remove video backgrounds with rembg and OpenCV

Project description

Video Background Remover CLI

Header image

Python 3.10+ OpenCV 4.x rembg

English Japanese

A Python CLI tool that removes backgrounds from videos using rembg and OpenCV. It supports full video export, transparent frame extraction, and animated WebP / GIF generation.

Features

  • Split a video into frames, remove the background, and rebuild it as a video
  • Export transparent webp / png frames at fixed intervals
  • Generate transparent animated webp / gif
  • Replace the removed background with a solid color or background image
  • Switch between isnet-general-use, u2net, u2netp, u2net_human_seg, and silueta

Requirements

  • Python 3.10 or later
  • FFmpeg is not required
  • The model is downloaded on first run

Install

From PyPI

pip install video-background-remover

Local development

pip install -e ".[dev]"

With uv

uv sync --extra dev

Quick Start

1. Export a video with a white background

video-background-remover assets/onizuka_idle_motion.mp4 output/output_white.mp4 --bg-color white

2. Export a transparent animated WebP

video-background-remover assets/onizuka_idle_motion.mp4 output/output_animated.webp --animated webp --webp-fps 10

3. Export transparent frames every second

video-background-remover assets/onizuka_idle_motion.mp4 output/frames --interval 1 --format webp

Usage

video-background-remover INPUT OUTPUT [options]

If you are running directly from the repository, python main.py ... and python -m video_background_remover_cli ... still work.

Full video export

video-background-remover input.mp4 output.mp4 --bg-color white
video-background-remover input.mp4 output.mp4 --bg-image background.jpg
video-background-remover input.mp4 output.mp4 --fps 30

Regular video output does not preserve alpha transparency. If you want a visible background, pass --bg-color or --bg-image.

Transparent frame export

video-background-remover input.mp4 output/frames --interval 0.5 --format webp
video-background-remover input.mp4 output/frames --interval 1 --format png

When --interval is set, OUTPUT is treated as a directory name instead of a file path.

Animated WebP / GIF export

video-background-remover input.mp4 output/output_animated.webp --animated webp
video-background-remover input.mp4 output/output.gif --animated gif --webp-fps 8
video-background-remover input.mp4 output/output --animated both --webp-fps 8 --max-frames 120

With --animated both, the tool writes both .webp and .gif using the same base name.

Options

Option Description
--model Background removal model. Default: isnet-general-use
--fps FPS for regular video output. Defaults to the input video's FPS
--bg-color Background color. Supports white, black, green, blue, red, gray, transparent, or 255,128,0
--bg-image Path to a background image
--keep-frames Keep intermediate frames instead of deleting them
--work-dir Working directory for extracted frames
--interval Export frames every N seconds
--format Output format for --interval mode: webp or png
--animated Animated output mode: webp, gif, or both
--webp-fps FPS for animated output
--max-frames Maximum number of frames for animated output

Models

Model Description
isnet-general-use General-purpose default model
u2net Good for salient object extraction
u2netp Lightweight variant of u2net
u2net_human_seg Optimized for human segmentation
silueta Higher quality but slower

Fire Effect Comparison

Test clip: assets/onizuka_fire_motion.mp4

Test settings:

video-background-remover assets/onizuka_fire_motion.mp4 output/model.webp --animated webp --webp-fps 8 --model <model>
Model Preview Notes
isnet-general-use isnet-general-use preview Keeps some effect detail, but halo noise remains around the subject
u2net u2net preview Stable silhouette, but removes most of the fire aura
u2netp u2netp preview Fastest, but quality drops on complex fire frames
u2net_human_seg u2net_human_seg preview Not suitable for this effect-heavy clip
silueta silueta preview Best overall balance for this sample

Experiment Summary

  • silueta gave the best overall balance on this clip.
  • u2net was the cleanest fallback when you prefer a stable silhouette.
  • u2net_human_seg was not suitable for this stylized, effect-heavy sample.

Visual Comparison

Comparison sheet

Mask comparison

Re-run This Experiment

The tracked experiment definition lives in experiments/onizuka_fire_motion/.

  • Script: experiments/onizuka_fire_motion/run_experiment.py
  • Config: experiments/onizuka_fire_motion/experiment_config.json
  • Notes: experiments/onizuka_fire_motion/README.md
  • Generated files: output/model_experiments/onizuka_fire_motion/

Run it again from the repository root:

python experiments/onizuka_fire_motion/run_experiment.py

To test an additional model later, add it to the models array in experiments/onizuka_fire_motion/experiment_config.json and run the same command again.

The script regenerates:

  • <model>_anim.webp
  • <model>_anim_frames/
  • results.csv
  • alpha_stats.csv
  • comparison_sheet.png
  • comparison_masks.png

Output Examples

  • Input video: assets/onizuka_idle_motion.mp4
  • Animated WebP: example/output_animated.webp
  • GIF: output/output.gif
  • Comparison GIF: example/onizuka_walk_motion.gif
  • Comparison WebP: example/onizuka_walk_motion.webp
  • Transparent frames: output_frames_webp/

GIF / WebP Comparison

GIF WebP
GIF comparison WebP comparison

Notes

  • The initial model load can take some time
  • Long videos exported as --animated gif can become large
  • If you need transparency, prefer --animated webp or --interval output instead of regular video export

Documentation Color Map

Base BG #F2EFEB Accent 1 #F22233 Accent 2 #F28705 Accent 3 #F25D27 Accent 4 #F20505

Docs Development

  • The social card image is published at docs/public/ogp.jpg.
  • Social card metadata is configured in docs/.vitepress/config.ts.
  • To verify the current card after a docs change or deployment, open https://www.opengraphs.com/tools/og-debugger and test https://sunwood-ai-labs.github.io/video-background-remover-cli/.

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

video_background_remover-0.1.2.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

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

video_background_remover-0.1.2-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file video_background_remover-0.1.2.tar.gz.

File metadata

  • Download URL: video_background_remover-0.1.2.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for video_background_remover-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1a533414c9ffddabb836236ec3c8d1ec7fef22724caaa2cdda6e72d89148da1b
MD5 9d5bf251dab128246e0e236634ad885f
BLAKE2b-256 11eaac407131d894ede1a5cd20dd85b7a6c205c168e04408d7788f98bed9436e

See more details on using hashes here.

Provenance

The following attestation bundles were made for video_background_remover-0.1.2.tar.gz:

Publisher: publish-pypi.yml on Sunwood-ai-labs/video-background-remover-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file video_background_remover-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for video_background_remover-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 42ff7e6792653fb01dfea8044568ac097136a1cc543a2f93b3bb101c1bc7c1d2
MD5 506806dacadf0d8f98a81b99b7c0552c
BLAKE2b-256 cb33cad5013a690aa2025517f65e812b4263e0e6dd3da0d71a0f2a8c61e1ec48

See more details on using hashes here.

Provenance

The following attestation bundles were made for video_background_remover-0.1.2-py3-none-any.whl:

Publisher: publish-pypi.yml on Sunwood-ai-labs/video-background-remover-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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