Scenedetect

You can install via `pip`:

pip install scenedetect

There is now a manual published at [manual.scenedetect.com](http://manual.scenedetect.com). See the [main project page](http://www.scenedetect.com) for details on installing dependencies.

The Windows build should be released within a week or so.

Changelog
==============================

* major release, includes stable Python API with examples and updated documentation
* numerous changes to command-line interface with addition of sub-commands (see the new manual for updated usage information)
* [feature] videos are now split using ffmpeg by default, resulting in frame-perfect cuts (can still use mkvmerge by specifying the -c/--copy argument to the split-video command)
* [enhance] image filename numbers are now consistent with those of split video scenes (PR 39, thanks e271828-)
* [enhance] 5-10% improvement in processing performance due to reduced memory copy operations (PR 40, thanks [elcombato] (https://github.com/Breakthrough/PySceneDetect/pull/40))
* [enhance] updated exception handling to raise proper standard exceptions (PR 37, thanks talkain)
* several fixes to the documentation, including improper dates and outdated CLI arguments (PR 26 and , thanks [elcombato] (https://github.com/Breakthrough/PySceneDetect/pull/26), and colelawrence)
* numerous other PRs and issues/bug reports that have been fixed - there are too many to list individually here, so I want to extend a big thank you to everyone who contributed to making this release better
* [enhance] add Sphinx-generated API documentation (available at: http://manual.scenedetect.com)
* [project] move from BSD 2-clause to 3-clause license

Updated beta release, only bugfixes to API, several modifications/changes to CLI commands. Summary of major API changes:

- Modify definition of end timecode returned by `scenedetect.SceneManager.get_scene_list()` method from `N`, where `N` is the last frame shown in the scene, to `N+1`. This now means that the end timecode/frame **equals** the start timecode/frame of the next adjacent scene. Also note that this is also the definition expected from the external tools used to export video when specifying the `split-video` command, improving compatibility with third-party tools.
- If the `frame_skip` option is specified to be greater than 0 when using a `scenedetect.SceneManager`, it is now explicitly **disallowed** to use a `scenedetect.StatsManager` with the `SceneManager`. If quicker processing speed is required, users should set the `downscale_factor` via `set_downscale_factor(downscale_factor=None)`. If no `downscale_factor` is passed (i.e. `downscale_factor` is `None`), the downscale factor will be computed automatically based on the resolution of the source material, which provides a balance of performance and accuracy for most videos.
- Removed unnecessary `new_time` argument from `FrameTimecode` object, and modify second argument `fps` so it can also be a `FrameTimecode` object from which the framerate is copied, allowing creation of new timecodes from existing ones to follow a much more intuitive syntax.

Beta release of PySceneDetect v0.5 with significantly refactored API and CLI. **Users are encouraged to upgrade to the v0.5-beta as soon as possible. The release of v0.5 will break existing scripts/programs; both the command-line interface and Python API have changed significantly to support future development.**

Try `scenedetect help` or `scenedetect help all` to get started. See the updated README.md for updated quickstart information.

When the final version of v0.5 is released, beta users can upgrade seamlessly. The final release distribution of PySceneDetect v0.5 will be made available some time this month, including source/binary distributions.

This is a source-only distribution, and can only be run locally via the `scenedetect.py` script. To install the beta, download [v0.5-beta-1](https://github.com/Breakthrough/PySceneDetect/releases/tag/v0.5-beta-1) or newer (via setup.py install - the version will show up as `v0.5-dev`). Requires `ffmpeg` or `mkvmerge` to enable support for the `split-video` command.

Includes unit tests using pytest (to run, type `pytest -v`).

This latest release includes integrated video splitting via `mkvmerge` if installed on the system (included with Windows builds). Note, this update changes the behaviour of the `-o` / `--output` option. Overview of changes:
- specifying `-o OUTPUT_FILE.mkv` will now automatically split the input video, generating a new video clip for each detected scene in sequence, starting with `OUTPUT_FILE-001.mkv`
- CSV file output is now specified with the `-co` / `--csv-output` option (_note, used to be `-o` in versions of PySceneDetect < 0.4_)

The specific components distributed with the Windows binaries are Python 3.4.4, OpenCV 3.1.0, Numpy 1.11.2, and mkvmerge 9.7.1.

This release includes some performance improvements, internal application structure changes, and a new lightweight installer for Windows that doesn't require an existing Python environment (a portable version is also available). The recommended installation method for Linux and Mac users is to download the source distribution and run `sudo setup.py install` in the location of the extracted files (once you have installed the prerequisite OpenCV and Numpy packages for Python).
- [enhance] speed improvement when using `--frameskip` option
- [internal] moved application state and shared objects to a consistent interface (the `SceneManager` object) to greatly reduce the number of required arguments for certain API functions
- [enhance] added installer for Windows builds (64-bit only currently)

The specific components distributed with the Windows binaries are Python 3.4.4, OpenCV 3.1.0, and Numpy 1.11.2.

This release includes some minor bug-fixes, as well as includes a portable build for 64-bit Windows users that don't want to install a Python environment (download `PySceneDetect-XYZ-win64.zip` and run `scenedetect.exe` from a command prompt; note you may need to add the folder to your `%PATH%` variable manually.).
- [enhance] initial release of portable build for Windows (64-bit only), including all dependencies
- [bugfix] fix unrelated exception thrown when video could not be loaded
- [internal] fix variable name typo in API documentation

The specific components distributed with the Windows binaries are Python 3.4.4, OpenCV 3.1.0, and Numpy 1.11.2.