frameloom/README.md

49 lines
1.3 KiB
Markdown

# frameloom
Node script to generate flicker videos by interweaving frames from multiple videos
--------
## Requirements
This script relies on `ffmpeg` to export and stitch video back together
Installation instructions for ffmpeg here: https://github.com/adaptlearning/adapt_authoring/wiki/Installing-FFmpeg
## Installation
```
git clone https://github.com/sixteenmillimeter/frameloom.git
cd frameloom
npm install
chmod +x frameloom
```
## Basic Usage
```./frameloom -i /path/to/video1:/path/to/video2 -o /path/to/output```
## Options
Run `./frameloom -h` to display help screen.
```
Usage: frameloom [options]
Options:
-V, --version output the version number
-i, --input [files] Specify input videos with paths seperated by colon
-o, --output [file] Specify output path of video
-p, --pattern [pattern] Specify a pattern for the flicker 1:1 is standard
-r, --realtime Specify if videos should preserve realtime speed
-t, --tmp [dir] Specify tmp directory for exporting frames
-a, --avconv Specify avconv if preferred to ffmpeg
-R, --random Randomize frames. Ignores pattern if included
-h, --help output usage information
```
## TODO
* Generate example videos automatically
* Publish example videos