vidtoolz-highlights

Make highlights from videos. Stitch videos to music

Installation

First install vidtoolz.

pip install vidtoolz

Then install this plugin in the same environment as your vidtoolz application.

vidtoolz install vidtoolz-highlights

Usage

type vid highlights --help to get help

usage: vid highlights [-h] [-ct CLIP_TIME] [-t THRESHOLD] [-vt {L,NL}]
                      [-p PREFIX] [-fps FPS] [-foout FADEOUT] [-af AFADEOUT]
                      [-aaf AUDFILE] [-st STARTAT]
                      filename

Make highlights from videos

positional arguments:
  filename              File(s) containing the list of files (can specify multiple)

optional arguments:
  -h, --help            show this help message and exit
  -ct CLIP_TIME, --clip-time CLIP_TIME
                        Clip Time (default: None)
  -t THRESHOLD, --threshold THRESHOLD
                        Clip Time (default: 0.3)
  -vt {L,NL}, --vtype {L,NL}
                        Vtype Linear or Non Linear (default: L)
  -p PREFIX, --prefix PREFIX
                        Filename Prefix (default: IMG)
  -fps FPS, --fps FPS   Video FPS (default: 60)
  -foout FADEOUT, --fadeout FADEOUT
                        Video fadeout (default: 1.0)
  -af AFADEOUT, --afadeout AFADEOUT
                        Audio fadeout (default: 2.0)
  -aaf AUDFILE, --audfile AUDFILE
                        mp3 Audio file (default: None)
  -st STARTAT, --startat STARTAT
                        Audio startat (default: 0.0)

type vid stitch --help to get help

usage: vid stitch [-h] [-t THRESHOLD] [-p PREFIX] [-fps FPS] [-foout FADEOUT]
                  [-af AFADEOUT] [-d] [-aaf AUDFILE] [-st STARTAT]
                  [-hm HOWMANY]
                  filename

Stitch videos using music

positional arguments:
  filename              File(s) containing the list of files (can specify multiple)

optional arguments:
  -h, --help            show this help message and exit
  -t THRESHOLD, --threshold THRESHOLD
                        Beats amplitude (default: 0.3)
  -p PREFIX, --prefix PREFIX
                        Filename Prefix (default: IMG)
  -fps FPS, --fps FPS   Video FPS (default: 60)
  -foout FADEOUT, --fadeout FADEOUT
                        Video fadeout (default: 0)
  -af AFADEOUT, --afadeout AFADEOUT
                        Audio FPS (default: 2.0)
  -d, --debug           Debug this (default: False)
  -aaf AUDFILE, --audfile AUDFILE
                        mp3 Audio file (default: None)
  -st STARTAT, --startat STARTAT
                        Audio startat (default: 0.0)
  -hm HOWMANY, --howmany HOWMANY
                        How many clips to take (default: 15)

Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd vidtoolz-highlights
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

python -m pytest