Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/breakthrough/pyscenedetect

:movie_camera: Python and OpenCV-based scene cut/transition detection program & library.
https://github.com/breakthrough/pyscenedetect

analysis image-processing opencv python python-opencv scene-detection scene-recognition video video-processing

Last synced: 7 days ago
JSON representation

:movie_camera: Python and OpenCV-based scene cut/transition detection program & library.

Host: GitHub
URL: https://github.com/breakthrough/pyscenedetect
Owner: Breakthrough
License: other
Created: 2014-06-04T04:43:21.000Z (over 10 years ago)
Default Branch: main
Last Pushed: 2024-05-01T02:27:57.000Z (6 months ago)
Last Synced: 2024-05-01T18:46:41.748Z (6 months ago)
Topics: analysis, image-processing, opencv, python, python-opencv, scene-detection, scene-recognition, video, video-processing
Language: Python
Homepage: http://scenedetect.com
Size: 150 MB
Stars: 2,804
Watchers: 69
Forks: 362
Open Issues: 44
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        
![PySceneDetect](https://raw.githubusercontent.com/Breakthrough/PySceneDetect/main/website/pages/img/pyscenedetect_logo_small.png)

==========================================================

Video Cut Detection and Analysis Tool

----------------------------------------------------------

[![Build Status](https://img.shields.io/github/actions/workflow/status/Breakthrough/PySceneDetect/build.yml)](https://github.com/Breakthrough/PySceneDetect/actions)

[![PyPI Status](https://img.shields.io/pypi/status/scenedetect.svg)](https://pypi.python.org/pypi/scenedetect/)

[![PyPI Version](https://img.shields.io/pypi/v/scenedetect?color=blue)](https://pypi.python.org/pypi/scenedetect/)

[![PyPI License](https://img.shields.io/pypi/l/scenedetect.svg)](https://scenedetect.com/copyright/)

----------------------------------------------------------

### Latest Release: v0.6.4 (June 10, 2024)

**Website**:  [scenedetect.com](https://www.scenedetect.com)

**Quickstart Example**: [scenedetect.com/cli/](https://www.scenedetect.com/cli/)

**Documentation**:  [scenedetect.com/docs/](https://www.scenedetect.com/docs/)

**Discord**: https://discord.gg/H83HbJngk7

----------------------------------------------------------

**Quick Install**:

    pip install scenedetect[opencv] --upgrade

Requires ffmpeg/mkvmerge for video splitting support. Windows builds (MSI installer/portable ZIP) can be found on [the download page](https://scenedetect.com/download/).

----------------------------------------------------------

**Quick Start (Command Line)**:

Split input video on each fast cut using `ffmpeg`:

    scenedetect -i video.mp4 split-video

Save some frames from each cut:

    scenedetect -i video.mp4 save-images

Skip the first 10 seconds of the input video:

    scenedetect -i video.mp4 time -s 10s

More examples can be found throughout [the documentation](https://www.scenedetect.com/docs/latest/cli.html).

**Quick Start (Python API)**:

To get started, there is a high level function in the library that performs content-aware scene detection on a video (try it from a Python prompt):

```python

from scenedetect import detect, ContentDetector

scene_list = detect('my_video.mp4', ContentDetector())

```

`scene_list` will now be a list containing the start/end times of all scenes found in the video.  There also exists a two-pass version `AdaptiveDetector` which handles fast camera movement better, and `ThresholdDetector` for handling fade out/fade in events.

Try calling `print(scene_list)`, or iterating over each scene:

```python

from scenedetect import detect, ContentDetector

scene_list = detect('my_video.mp4', ContentDetector())

for i, scene in enumerate(scene_list):

    print('    Scene %2d: Start %s / Frame %d, End %s / Frame %d' % (

        i+1,

        scene[0].get_timecode(), scene[0].get_frames(),

        scene[1].get_timecode(), scene[1].get_frames(),))

```

We can also split the video into each scene if `ffmpeg` is installed (`mkvmerge` is also supported):

```python

from scenedetect import detect, ContentDetector, split_video_ffmpeg

scene_list = detect('my_video.mp4', ContentDetector())

split_video_ffmpeg('my_video.mp4', scene_list)

```

For more advanced usage, the API is highly configurable, and can easily integrate with any pipeline. This includes using different detection algorithms, splitting the input video, and much more. The following example shows how to implement a function similar to the above, but using [the `scenedetect` API](https://www.scenedetect.com/docs/latest/api.html):

```python

from scenedetect import open_video, SceneManager, split_video_ffmpeg

from scenedetect.detectors import ContentDetector

from scenedetect.video_splitter import split_video_ffmpeg

def split_video_into_scenes(video_path, threshold=27.0):

    # Open our video, create a scene manager, and add a detector.

    video = open_video(video_path)

    scene_manager = SceneManager()

    scene_manager.add_detector(

        ContentDetector(threshold=threshold))

    scene_manager.detect_scenes(video, show_progress=True)

    scene_list = scene_manager.get_scene_list()

    split_video_ffmpeg(video_path, scene_list, show_progress=True)

```

See [the documentation](https://www.scenedetect.com/docs/latest/api.html) for more examples.

## Reference

 - [Documentation](https://www.scenedetect.com/docs/) (covers application and Python API)

 - [CLI Example](https://www.scenedetect.com/cli/)

 - [Config File](https://www.scenedetect.com/docs/0.6.4/cli/config_file.html)

## Help & Contributing

Please submit any bugs/issues or feature requests to [the Issue Tracker](https://github.com/Breakthrough/PySceneDetect/issues). Before submission, ensure you search through existing issues (both open and closed) to avoid creating duplicate entries.

Pull requests are welcome and encouraged.  PySceneDetect is released under the BSD 3-Clause license, and submitted code should be compliant.

For help or other issues, you can join [the official PySceneDetect Discord Server](https://discord.gg/H83HbJngk7), submit an issue/bug report [here on Github](https://github.com/Breakthrough/PySceneDetect/issues), or contact me via [my website](http://www.bcastell.com/about/).

## Code Signing

This program uses free code signing provided by [SignPath.io](https://signpath.io?utm_source=foundation&utm_medium=github&utm_campaign=PySceneDetect), and a free code signing certificate by the [SignPath Foundation](https://signpath.org?utm_source=foundation&utm_medium=github&utm_campaign=PySceneDetect)

## License

BSD-3-Clause; see [`LICENSE`](LICENSE) and [`THIRD-PARTY.md`](THIRD-PARTY.md) for details.

----------------------------------------------------------

Copyright (C) 2014-2024 Brandon Castellano.

All rights reserved.