Prepare v1.3 release.

README.md

@@ -1,7 +1,7 @@
 # ![DVR-Scan Logo](https://raw.githubusercontent.com/Breakthrough/DVR-Scan/master/docs/img/dvr-scan-logo_small.png)
 :vhs: Tool for extracting scenes with motion from security camera/DVR footage.  Written in Python, depends on OpenCV.
 
-**Latest Release:** [v1.2 (March 10, 2021)](http://dvr-scan.readthedocs.io/en/latest/changelog/)
+**Latest Release:** [v1.3 (May 23, 2021)](http://dvr-scan.readthedocs.io/en/latest/changelog/)
 
 ------------------------------------------------
 

docs/changelog.md

@@ -4,7 +4,7 @@ DVR-Scan Changelog
 
 ## DVR-Scan 1.0
 
-### 1.3 (In Progress)
+### 1.3 (May 23, 2021) &nbsp;<span class="fa fa-tags"></span>
 
 #### Release Notes
 
@@ -22,7 +22,7 @@ This version of DVR-Scan includes a new, faster background subtraction algorithm
  * Variable framerate videos (VFR) are not fully supported, and will yield incorrect timestamps ([#20](https://github.com/Breakthrough/DVR-Scan/issues/20))
 
 
-### 1.2 (March 10, 2021) &nbsp;<span class="fa fa-tags"></span>
+### 1.2 (March 10, 2021)
 
 #### Changelog
 

docs/download.md

@@ -23,17 +23,17 @@ DVR-Scan is available via `pip` as [the `dvr-scan` package](https://pypi.org/pro
 ### Windows Build (64-bit Only) &nbsp; <span class="wy-text-neutral"><span class="fa fa-windows"></span></span>
 
 <div class="important">
-<h3 class="wy-text-neutral"><span class="fa fa-forward wy-text-info"></span> Latest Release: <b class="wy-text-neutral">v1.2</b></h3>
-<h4 class="wy-text-neutral"><span class="fa fa-calendar wy-text-info"></span>&nbsp; Release Date:&nbsp; <b>March 10, 2021</b></h4>
-<a href="https://github.com/Breakthrough/DVR-Scan/releases/download/v1.2/dvr-scan-1.2-win64.exe" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span>&nbsp; <b>Installer</b>&nbsp;&nbsp;(recommended)</a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://github.com/Breakthrough/DVR-Scan/releases/download/v1.2/dvr-scan-1.2-win64-portable.zip" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span>&nbsp; <b>Portable .zip</b></a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="../guide/examples/" class="btn btn-success" style="margin-bottom:8px;" role="button"><span class="fa fa-book"></span>&nbsp; <b>Getting Started</b></a>
+<h3 class="wy-text-neutral"><span class="fa fa-forward wy-text-info"></span> Latest Release: <b class="wy-text-neutral">v1.3</b></h3>
+<h4 class="wy-text-neutral"><span class="fa fa-calendar wy-text-info"></span>&nbsp; Release Date:&nbsp; <b>May 23, 2021</b></h4>
+<a href="https://github.com/Breakthrough/DVR-Scan/releases/download/v1.3/dvr-scan-1.3-win64.exe" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span>&nbsp; <b>Installer</b>&nbsp;&nbsp;(recommended)</a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://github.com/Breakthrough/DVR-Scan/releases/download/v1.3/dvr-scan-1.3-win64-portable.zip" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span>&nbsp; <b>Portable .zip</b></a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="../guide/examples/" class="btn btn-success" style="margin-bottom:8px;" role="button"><span class="fa fa-book"></span>&nbsp; <b>Getting Started</b></a>
 </div>
 
 ### Python Installer (All Platforms) &nbsp; <span class="wy-text-neutral"><span class="fa fa-windows"></span> &nbsp; <span class="fa fa-linux"></span> &nbsp; <span class="fa fa-apple"></span></span></h3>
 
 <div class="important">
-<h4 class="wy-text-neutral"><span class="fa fa-forward wy-text-info"></span> Latest Release: <b class="wy-text-neutral">v1.2</b></h4>
-<h4 class="wy-text-neutral"><span class="fa fa-calendar wy-text-info"></span>&nbsp; Release Date:&nbsp; <b>March 10, 2021</b></h4>
-<a href="https://github.com/Breakthrough/DVR-Scan/archive/v1.2.zip" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span>&nbsp; <b>Source</b>&nbsp;&nbsp;.zip</a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://github.com/Breakthrough/DVR-Scan/archive/v1.2.tar.gz" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span>&nbsp; <b>Source</b>&nbsp;&nbsp;.tar.gz</a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="../examples/usage/" class="btn btn-success" style="margin-bottom:8px;" role="button"><span class="fa fa-book"></span>&nbsp; <b>Getting Started</b></a>
+<h4 class="wy-text-neutral"><span class="fa fa-forward wy-text-info"></span> Latest Release: <b class="wy-text-neutral">v1.3</b></h4>
+<h4 class="wy-text-neutral"><span class="fa fa-calendar wy-text-info"></span>&nbsp; Release Date:&nbsp; <b>May 23, 2021</b></h4>
+<a href="https://github.com/Breakthrough/DVR-Scan/archive/v1.3.zip" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span>&nbsp; <b>Source</b>&nbsp;&nbsp;.zip</a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="https://github.com/Breakthrough/DVR-Scan/archive/v1.3.tar.gz" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span>&nbsp; <b>Source</b>&nbsp;&nbsp;.tar.gz</a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="../examples/usage/" class="btn btn-success" style="margin-bottom:8px;" role="button"><span class="fa fa-book"></span>&nbsp; <b>Getting Started</b></a>
 </div>
 
 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.  DVR-Scan 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):

docs/guide/faq.md

@@ -19,6 +19,14 @@ Windows users can also try downloading a binary/portable distribution, which inc
 ----------------------------------------------------------
 
 
+### How can I improve the performance of DVR-Scan?
+
+On the Getting Started & Examples page, see the [Performance section](examples.md#performance) under Motion Detection Parameters.  Additional performance improvements are being worked on for future versions (parallel processing, utilization of GPU, etc...).
+
+
+----------------------------------------------------------
+
+
 ### How can I join/concatenate two or more video files for processing?
 
 If you have a series of video clips from the same source, you can append subsequent video clips to the DVR-Scan input by including another `-i` flag for each file.  For example, to process three videos sequentially:

docs/guide/installing.md

@@ -25,7 +25,7 @@ Start by downloading the latest release of DVR-Scan and extracting it to a locat
 
 If installing from source, DVR-Scan requires [Python 2 or 3](https://www.python.org/) (tested on 3.X, untested but should work on 2.X) and the following libraries ([quick install guide](http://breakthrough.github.io/Installing-OpenCV/)):
 
- - [OpenCV](http://opencv.org/) (requires version 3.0 and above) and the Python module (`cv2` - can find on Pypi as `opencv-python`)
+ - [OpenCV](http://opencv.org/) (requires version 3.0 and above) the Python module (`pip install opencv-python`) as well as `opencv-contrib-python` is required for some features (e.g. `-b CNT`)
  - [Numpy](http://sourceforge.net/projects/numpy/) Python module (`numpy`)
  - [tqdm](https://pypi.python.org/pypi/tqdm), *optional* Python module (`tqdm`) for displaying progress bar and estimated time remaining
 
@@ -35,7 +35,7 @@ Note that some Linux package managers still provide older, dated builds of OpenC
 
 ### Installing DVR-Scan
 
-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 (optionally, if you installed tqdm, run `import tqdm` as well).
+To ensure you have all the requirements installed, open a `python` interpreter, and ensure you can run `import numpy` and `import cv2.bgsegm` without any errors (optionally, if you installed tqdm, run `import tqdm` as well).
 
 DVR-Scan can then be installed by running the following command in the location of the extracted files:
 

docs/index.md

@@ -2,7 +2,7 @@
 <h4 class="wy-text-info" style="margin-top:-1em;">Find and extract motion events in videos.</h4>
 
 <div class="important">
-<h3 class="wy-text-neutral"><span class="fa fa-info-circle wy-text-info"></span>&nbsp; Latest Release: <b>v1.2</b> (March 10, 2021)</h3>
+<h3 class="wy-text-neutral"><span class="fa fa-info-circle wy-text-info"></span>&nbsp; Latest Release: <b>v1.3</b> (May 23, 2021)</h3>
 <a href="download/" class="btn btn-info" style="margin-bottom:8px;" role="button"><span class="fa fa-download"></span>&nbsp; <b>Download</b>&nbsp;&nbsp;(all platforms)</a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="guide/installing/" class="btn btn-success" style="margin-bottom:8px;" role="button"><span class="fa fa-gear"></span>&nbsp; <b>Installation</b></a> &nbsp;&nbsp;&nbsp;&nbsp; <a href="guide/examples/" class="btn btn-warning" style="margin-bottom:8px;" role="button"><span class="fa fa-book"></span>&nbsp; <b>Getting Started</b></a>
 </div>
 

dvr_scan/__init__.py

@@ -49,7 +49,7 @@
 
 
 # Used for module identification and when printing copyright & version info.
-__version__ = 'v1.2.2'
+__version__ = 'v1.3'
 
 # About & copyright message string shown for the -v/--version CLI argument.
 ABOUT_STRING = """-----------------------------------------------

setup.py

@@ -56,7 +56,7 @@ def get_extra_requires():
 
 setup(
     name='dvr-scan',
-    version='1.2.2',
+    version='1.3',
     description="Tool for finding and extracting motion events in video files"
                 "(e.g. security camera footage).",
     long_description=open('package-info.rst').read(),