Obtaining PySceneDetect

PySceneDetect is completely free software, and can be downloaded from the links below. See the license and copyright information page for details. If you have trouble running PySceneDetect, ensure that you have all the required dependencies listed in the Installing Dependencies section below.

Download

Windows Build (64-bit Only)  

Latest Release: v0.4

  Release Date:  January 14, 2017

  Installer  (recommended)        Portable  .zip        Getting Started

The Windows distribution of PySceneDetect is bundled with all required dependencies. After installation, you can call PySceneDetect from any terminal/command prompt by typing scenedetect. Open a new command prompt (cmd.exe) and try running scenedetect --version to verify that everything was installed correctly. If using the portable distribution, you need to run the command from the location of the extracted files, where the scenedetect.exe executable is.

Source (All Platforms, Requires Python)      

Latest Release: v0.4

  Release Date:  January 14, 2017

  Source  .zip        Source  .tar.gz        Installation        Getting Started

Once you've downloaded the source archive, extract it to a location of your choice, and make sure you have the appropriate system requirements installed before continuing. PySceneDetect can be installed by running the following command in the location of the extracted files:

sudo python setup.py install

After installation, you can call PySceneDetect from any terminal/command prompt by typing scenedetect (try running scenedetect --version to verify that everything was installed correctly).


Installation

Start by downloading the latest release of PySceneDetect and extracting it to a location of your choice. Then, follow the instructions below under Installing Dependencies to ensure you have all the system requirements. Finally, run the commands in Installing PySceneDetect to install the program, allowing you to run the scenedetect command from any terminal/command prompt.

Note that if you are using a Windows distribution (i.e. you used the installer, or downloaded the portable .zip version), you do not need to install any dependencies on your computer, they are bundled with PySceneDetect.

Installing Dependencies

PySceneDetect requires Python 2 or 3 (tested on 2.7.X, untested but should work on 3.X) and the following third-party software:

  • OpenCV (compatible with both 2.X or 3.X), and the OpenCV cv2 Python module
  • Numpy, Python module
  • mkvmerge, part of mkvtoolnix, command-line tool, required to split video files

You can click here for a quick guide (OpenCV + Numpy on Windows & Linux) on installing the latest versions of OpenCV/Numpy on Windows (using pre-built binaries) and Linux (compiling from source). If the Python module that comes with OpenCV on Windows is incompatible with your system architecture or Python version, see this page to obtain a pre-compiled (unofficial) module.

Note that some Linux package managers still provide older, dated builds of OpenCV (pre-3.0). PySceneDetect is compatible with both versions, but if you want to ensure you have the latest version, it's recommended that you build and install OpenCV from source on Linux.

To ensure you have all the requirements installed, open a python interpreter, and ensure you can run import numpy and import cv2 without any errors. Once this is done, you're ready to install PySceneDetect.

Installing PySceneDetect

Go to the folder you extracted the PySceneDetect source code to, and run the following command (may require root):

python setup.py install

Once finished, PySceneDetect will be installed, and you should be able to run the scenedetect command. To verify that everything was installed properly, try calling the following command:

scenedetect --version

To get familiar with PySceneDetect, try running scenedetect --help, or continue onwards to the Getting Started: Basic Usage section. If you encounter any runtime errors while running PySceneDetect, ensure that you have all the required dependencies listed in the System Requirements section above (again, you should be able to import numpy and import cv2). PySceneDetect is still beta software, so feel free to report any bugs or share some feature requests/ideas and help make PySceneDetect even better.