Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove Windows installer links from Download page.
- Loading branch information
1 parent
266b33a
commit 7744084
Showing
4 changed files
with
38 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,98 +1,72 @@ | ||
|
|
||
| # Obtaining PySceneDetect | ||
|
|
||
| PySceneDetect is completely free software, and can be downloaded from the links below. See the [license and copyright information](copyright.md) page for details. If you have trouble running PySceneDetect, ensure that you have all the required dependencies listed in the [Installing Dependencies](#installing-dependencies) section below. | ||
| PySceneDetect is completely free software, and can be downloaded from the links below. See the [license and copyright information](copyright.md) page for details. If you have trouble running PySceneDetect, ensure that you have all the required dependencies listed in the [Dependencies](#dependencies) section below. | ||
|
|
||
| PySceneDetect is compatible with both Python 2 and 3. Note that Python 3 usually provides better performance. | ||
|
|
||
| ## Download | ||
| ## Download and Installation | ||
|
|
||
| ### Windows Standalone (64-bit Only) <span class="wy-text-neutral"><span class="fa fa-windows"></span></span> | ||
| ### Install via pip <span class="wy-text-neutral"><span class="fa fa-windows"></span> <span class="fa fa-linux"></span> <span class="fa fa-apple"></span></span></h3> | ||
|
|
||
| <div class="important"> | ||
| <h3 class="wy-text-neutral"><span class="fa fa-forward wy-text-info"></span> Latest Release: <b class="wy-text-neutral">v0.4</b> <i>[OLD]</i></h3> | ||
| <h4 class="wy-text-neutral"><span class="fa fa-calendar wy-text-info"></span> Release Date: <b>January 14, 2017</b></h4> | ||
| <a href="https://github.com/Breakthrough/PySceneDetect/releases/download/v0.4/PySceneDetect-0.4-win64.msi" class="btn btn-success" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span> <b>Installer</b> (recommended)</a> <a href="https://github.com/Breakthrough/PySceneDetect/releases/download/v0.4/PySceneDetect-0.4-win64-portable.zip" class="btn btn-success" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span> <b>Portable</b> .zip</a> <a href="../examples/usage/" class="btn btn-danger" style="margin-bottom:8px;" role="button"><span class="fa fa-book"></span> <b>Getting Started</b></a> | ||
| <h3 class="wy-text-neutral"><span class="fa fa-forward wy-text-info"></span> <tt>pip install scenedetect</tt></h3> | ||
| </div> | ||
|
|
||
| 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) <span class="wy-text-neutral"><span class="fa fa-windows"></span> <span class="fa fa-linux"></span> <span class="fa fa-apple"></span></span></h3> | ||
| PySceneDetect is available via `pip` as [the `scenedetect` package](https://pypi.org/project/scenedetect/). | ||
|
|
||
| ### Python Installer (All Platforms) <span class="wy-text-neutral"><span class="fa fa-windows"></span> <span class="fa fa-linux"></span> <span class="fa fa-apple"></span></span></h3> | ||
|
|
||
| <div class="important"> | ||
| <h3 class="wy-text-neutral"><span class="fa fa-forward wy-text-info"></span> Latest Release: <b class="wy-text-neutral">v0.5</b></h3> | ||
| <h4 class="wy-text-neutral"><span class="fa fa-calendar wy-text-info"></span> Release Date: <b>August 31, 2018</b></h4> | ||
| <a href="https://github.com/Breakthrough/PySceneDetect/archive/v0.5.zip" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span> <b>Source</b> .zip</a> <a href="https://github.com/Breakthrough/PySceneDetect/archive/v0.5.tar.gz" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span> <b>Source</b> .tar.gz</a> <a href="#installation" class="btn btn-warning" style="margin-bottom:8px;" role="button"><span class="fa fa-gear"></span> <b>Installation</b></a> <a href="../examples/usage/" class="btn btn-danger" style="margin-bottom:8px;" role="button"><span class="fa fa-book"></span> <b>Getting Started</b></a> | ||
| <a href="https://github.com/Breakthrough/PySceneDetect/archive/v0.5.zip" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span> <b>Source</b> .zip</a> <a href="https://github.com/Breakthrough/PySceneDetect/archive/v0.5.tar.gz" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span> <b>Source</b> .tar.gz</a> <a href="../examples/usage/" class="btn btn-success" style="margin-bottom:8px;" role="button"><span class="fa fa-book"></span> <b>Getting Started</b></a> | ||
| </div> | ||
|
|
||
| To install PySceneDetect using `pip`, make sure you have the appropriate [system requirements](#installing-dependencies) installed **before** installing the `scenedetect` package: | ||
| ```md | ||
| 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](#installing-dependencies) installed before continuing. PySceneDetect can be installed by running the following command in the location of the extracted files (don't forget `sudo`): | ||
| To install from source, download and extract the latest release to a location of your choice, and make sure you have the appropriate [system requirements](#dependencies) installed before continuing. PySceneDetect can be installed by running the following command in the location of the extracted files (don't forget `sudo` if you're installing system-wide): | ||
|
|
||
| ```md | ||
| 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). | ||
|
|
||
|
|
||
| ------------------------------------------------ | ||
| ### Post Installation | ||
|
|
||
| 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](#installing-dependencies) to ensure you have all the system requirements. Finally, run the commands in [Installing PySceneDetect](#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. | ||
| To get familiar with PySceneDetect, try running `scenedetect help`, or continue onwards to the [Getting Started: Basic Usage](examples/usage.md) 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 (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](contributing.md) on the [issue tracker](https://github.com/Breakthrough/PySceneDetect/issues) and help make PySceneDetect even better. | ||
|
|
||
|
|
||
| ### Installing Dependencies | ||
| ## Dependencies | ||
|
|
||
| PySceneDetect requires [Python 2 or 3](https://www.python.org/) and the following third-party software: | ||
|
|
||
| - [OpenCV](http://opencv.org/) (compatible with both 2.X or 3.X), and the OpenCV `cv2` Python module | ||
| - [Numpy](http://sourceforge.net/projects/numpy/), Python module | ||
| - [tqdm](https://github.com/tqdm/tqdm), optional. Used to show progress bar and estimated time remaining (can usually install via `pip install tqdm`). | ||
| - [OpenCV](http://opencv.org/) (compatible with 2/3), can install via `pip install opencv` | ||
| - [Numpy](http://sourceforge.net/projects/numpy/), can install via `pip install numpy` | ||
| - [tqdm](https://github.com/tqdm/tqdm), optional, can install via `pip install tqdm`. Used to show progress bar and estimated time remaining. | ||
|
|
||
| ### Video Splitting Support | ||
|
|
||
| For video splitting support, you also need: | ||
| For video splitting support, you need to have the following tools available: | ||
|
|
||
| - [ffmpeg](https://ffmpeg.org/download.html), 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](https://mkvtoolnix.download/), part of mkvtoolnix, command-line tool, required to split video files in copy mode (`split-video -c/--copy`) | ||
|
|
||
| Note that Linux users should use a package manager if possible (e.g. `sudo apt-get install ffmpeg`). Windows users may require additional steps in order for PySceneDetect to detect `ffmpeg` - see the section Manually Enabling `split-video` Support below for details. | ||
|
|
||
| <div class="important"> | ||
| <h4 class="wy-text-neutral"><span class="fa fa-info-circle wy-text-info"></span> Additionally, 64-bit Windows users installing PySceneDetect from source can download <a href="https://github.com/Breakthrough/PySceneDetect/blob/resources/third-party/split-video-progams-win64.7z?raw=true">ffmpeg.exe and mkvmerge.exe from here</a>.</h4> After extracting the files, the executables can be placed same folder as the <tt>scenedetect.exe</tt> file created after running <tt>python setup.py install</tt>, or somewhere else in your PATH variable. The <tt>scenedetect.exe</tt> file is <i>usually</i> installed in the folder <tt>C:\PythonXY\Scripts</tt>, where <tt>XY</tt> is your Python version (e.g. 27, 36). | ||
| </div> | ||
|
|
||
| Additionally, 64-bit Windows users installing PySceneDetect from source can download [ffmpeg.exe and mkvmerge.exe from here](https://github.com/Breakthrough/PySceneDetect/blob/resources/third-party/split-video-progams-win64.7z?raw=true). 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](http://breakthrough.github.io/Installing-OpenCV/) for a quick guide (OpenCV + Numpy on Windows & Linux) on installing the latest versions of OpenCV/Numpy on [Windows (using pre-built binaries)](http://breakthrough.github.io/Installing-OpenCV/#installing-on-windows-pre-built-binaries) and [Linux (compiling from source)](http://breakthrough.github.io/Installing-OpenCV/#installing-on-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](http://www.lfd.uci.edu/~gohlke/pythonlibs/#opencv) 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](http://breakthrough.github.io/Installing-OpenCV/#installing-on-linux-compiling-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. | ||
| If you have trouble getting PySceneDetect to find `ffmpeg` or `mkvmerge`, see the section on Manually Enabling `split-video` Support on [Getting Started: Video Splitting Support Requirements](examples/video-splitting). | ||
|
|
||
| Once this is done, you're ready to install PySceneDetect. | ||
| ### Installing Latest Version of OpenCV (optional) | ||
|
|
||
| If you have installed OpenCV using `pip`, you will need to uninstall it before continuing on. | ||
|
|
||
| ### Installing PySceneDetect | ||
|
|
||
| Go to the folder you extracted the PySceneDetect source code to, and run the following command (may require root): | ||
|
|
||
| ```md | ||
| 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: | ||
| You can [click here](http://breakthrough.github.io/Installing-OpenCV/) for a quick guide (OpenCV + Numpy on Windows & Linux) on installing the latest versions of OpenCV/Numpy on [Windows (using pre-built binaries)](http://breakthrough.github.io/Installing-OpenCV/#installing-on-windows-pre-built-binaries) and [Linux (compiling from source)](http://breakthrough.github.io/Installing-OpenCV/#installing-on-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](http://www.lfd.uci.edu/~gohlke/pythonlibs/#opencv) to obtain a pre-compiled (unofficial) module. | ||
|
|
||
| ```md | ||
| scenedetect version | ||
| ``` | ||
| 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](http://breakthrough.github.io/Installing-OpenCV/#installing-on-linux-compiling-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. | ||
|
|
||
| To get familiar with PySceneDetect, try running `scenedetect help`, or continue onwards to the [Getting Started: Basic Usage](examples/usage.md) 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](contributing.md) on the [issue tracker](https://github.com/Breakthrough/PySceneDetect/issues) and help make PySceneDetect even better. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters