Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (
Help us improve Python packaging - Donate today!

Convert videos into a format readable by theWhitewater Video Decoder Javascript library.

Project Description

Whitewater Encoder

A command line utility that converts short videos into the Whitewater format.


Together, Whitewater Encoder and Whitewater Player give you the ability to play inline video in mobile web browsers complete with programatic playback controls and events.


From PyPI

$ pip install whitewater

Manual installation

Download the package and run the setup script:

$ cd path/to/module
$ python install


Command Line

The Whitewater package contains a simple command line interface.

$ whitewater <file> [options]
$ whitewater (-h | --help | --version)

Basic Example

$ whitewater path/to/video.mp4


The script can take a handful of options:

-d, --debug          Turn on debug mode.
--blocksize <size>   The width/height of a single grid cell when
                     checking one frame against the previous one.
--grid <size>        The size of the diffmap images in rows and
                     columns, not absolute pixels.
--quality <percent>  JPEG quality setting.
--threshold <rms>    RMS threshold for determining whether a
                     single cell of a frame is different from
                     the previous one.
--format <filetype>  File format to save diffmap images as.

For a full explanation of what these do and when you might want to use them, check the documentation.

Python Module

Whitewater can also be used as a module in your own Python scripts. The Whitewater() class and its options are described in detail in the full documentation.

from whitewater import Whitewater

video = Whitewater('path/to/video.mp4')

Full Documentation

Check out the wiki.


Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

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

File Name & Hash SHA256 Hash Help Version File Type Upload Date
(9.7 kB) Copy SHA256 Hash SHA256
Source Jun 3, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting