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 Standalone (64-bit Only)  

Latest Release: v0.4 [OLD]

  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.

Python Installer (All Platforms, Requires Python)      

Latest Release: v0.5

  Release Date:  August 31, 2018

  Source  .zip        Source  .tar.gz        Installation        Getting Started

To install PySceneDetect using pip, make sure you have the appropriate system requirements installed before installing the scenedetect package:

pip install scenedetect

Otherwise, if installing from source, download and extract the latest release 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 (don't forget sudo):

python setup.py install

After installation, you can call PySceneDetect from any terminal/command prompt by typing scenedetect (try running scenedetect version, or scenedetect --version in v0.4 and prior, 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 and the following third-party software:

  • OpenCV (compatible with both 2.X or 3.X), and the OpenCV cv2 Python module
  • Numpy, Python module
  • tqdm, optional. Used to show progress bar and estimated time remaining (can usually install via pip install tqdm).

For video splitting support, you also need:

  • ffmpeg, part of mkvtoolnix, command-line tool, required to split video files in precise/high-quality mode (split-video or split-video -h/--high-quality)
  • mkvmerge, part of mkvtoolnix, command-line tool, required to split video files in copy mode (split-video -c/--copy)

  Additionally, 64-bit Windows users installing PySceneDetect from source can download ffmpeg.exe and mkvmerge.exe from here.

After extracting the files, the executables can be placed same folder as the scenedetect.exe file created after running python setup.py install, or somewhere else in your PATH variable. The scenedetect.exe file is usually installed in the folder C:\PythonXY\Scripts, where XY is your Python version (e.g. 27, 36).

The ffmpeg and/or mkvmerge command must be available system wide (e.g. in a directory in PATH, so it can be used from any terminal/console by typing the command), or alternatively, placed in the same directory where PySceneDetect is installed.

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. For video splitting support, also and ensure you can run the ffmpeg and/or mkvmerge from a terminal/console.

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). If you encounter any issues or want to make a feature request, feel free to report any bugs or share some feature requests/ideas on the issue tracker and help make PySceneDetect even better.