Editly

Slick, declarative command line video editing & API

Video

mifi/editly editly

README

Editly is a tool and framework for declarative NLE (non-linear video editing) using Node.js and ffmpeg. Editly allows you to easily and programmatically create a video from a set of clips, images, audio and titles, with smooth transitions and music overlaid.

Editly has a simple CLI for quickly assembling a video from a set of clips or images, or you can use its more flexible JavaScript API.

Inspired by ffmpeg-concat, editly is much faster and doesn't require much storage because it usesstreaming editing. Editly aims to be very extensible and feature rich with a pluggable interface for adding new dynamic content.

This GIF / YouTube was created with this command: "editly commonFeatures.json5". See more examples here.

Features

- Edit videos with code! 🤓

- Declarative API with fun defaults

- Create colorful videos with random colors generated from aesthetically pleasing palettes and random effects

- Supports any input size, e.g. 4K video and DSLR photos

- Can output to any dimensions and aspect ratio, e.g. Instagram post (1:1), Instagram story (9:16), YouTube (16:9), or any other dimensions you like.

- Content is scaled and letterboxed automatically, even if the input aspect ratio is not the same and the framerate will be converted.

- Speed up / slow down videos automatically to match the cutFrom/cutTo segment length with each clip's duration

- Overlay text and subtitles on videos, images or backgrounds

- Accepts custom HTML5 Canvas / Fabric.js JavaScript code for custom screens or dynamic overlays

- Render custom GL shaders (for example from shadertoy)

- Can output GIF

- Overlay transparent images or even videos with alpha channel

- Show different sub-clips for parts of a clips duration (B-roll)

- Picture-in-picture

- Vignette

- Preserve/mix multiple audio sources

- Automatic audio crossfading

- Automatic audio ducking and normalization

Use cases

- Create a slideshow from a set of pictures with text overlay

- Create a fast-paced trailer or promo video

- Create a tutorial video with help text

- Create news stories

- Create an animated GIF

- Resize video to any size or framerate and with automatic letterboxing/cropping (e.g. if you need to upload a video somewhere but the site complains Video must be 1337x1000 30fps)

- Create a podcast with multiple mixed tracks

See examples

Requirements

- Windows, MacOS or Linux

- Node.js installed (Use of the latest LTS version is recommended, v12.16.2 or newer on MacOS.)

- ffmpeg (and ffprobe) installed and available inPATH

- (Linux) may require some extra steps. See headless-gl.

- Editly is now ESM only

Installing

npm i -g editly

Usage: Command line video editor

Run editly --help for usage

Create a simple randomized video edit from videos, images and text with an audio track:

```sh
editly \
title:'My video' \
clip1.mov \
clip2.mov \
title:'My slideshow' \
img1.jpg \
img2.jpg \
title:'THE END' \
--fast \
--audio-file-path /path/to/music.mp3
```

Or create an MP4 (or GIF) from a JSON or JSON5 edit spec (JSON5 is just a more user friendly JSON format):

```sh
editly my-spec.json5 --fast --keep-source-audio --out output.gif
```

For examples of how to make a JSON edit spec, see below or examples.

Without --fast, it will default to using the width, height and frame rate from the first input video. All other clips will be converted to these dimensions. You can of course override any or all of these parameters.

- TIP: Use this tool in conjunction with LosslessCut

- TIP: If you need catchy music for your video, have a look at this YouTube or the YouTube audio library. Then use youtube-dl to download the video, and then point--audio-file-path at the video file. Be sure to respect their license!

JavaScript library

``` js
import editly from 'editly';
// See editSpec documentation
await editly(editSpec)
```

Edit spec

Edit specs are JavaScript / JSON objects describing the whole edit operation with the following structure:

``` js
{
outPath,
width,
height,
fps,
allowRemoteRequests: false,
defaults: {
duration: 4,
transition: {
duration: 0.5,
name: 'random',
audioOutCurve: 'tri',
audioInCurve: 'tri',
},
layer: {
fontPath,
// ...more layer defaults
},
layerType: {
'fill-color': {
color: '#ff6666',
}
// ...more per-layer-type defaults
},
},
clips: [
{
transition,
duration,
layers: [
{
type,
// ...more layer-specific options
}
// ...more layers
],
}
// ...more clips
],
audioFilePath,
loopAudio: false,
keepSourceAudio: false,
clipsAudioVolume: 1,
outputVolume: 1,
audioTracks: [
{
path,
mixVolume: 1,
cutFrom: 0,
cutTo,
start: 0,
},
// ...more audio tracks
],
audioNorm: {
enable: false,
gaussSize: 5,
maxGain: 30,
}
// Testing options:
enableFfmpegLog: false,
verbose: false,
fast: false,
}
```

Parameters

Parameter	CLI	Description	Default	\|
\|-\|-\|-\|-\|-\|
`outPath`	`--out`	Output	\|
`width`	`--width`	Width	`640`	\|
`height`	`--height`	Height	auto	\|
`fps`	`--fps`	FPS	First	\|
`customOutputArgs`	\|	auto	\|
`allowRemoteRequests`	`--allow-remote-requests`	Allow	`false`	\|
`fast`	`--fast`,	Fast	`false`	\|
`defaults.layer.fontPath`	`--font-path`	Set	System	\|
`defaults.layer.*`	\|	\|
`defaults.duration`	`--clip-duration`	Set	`4`	sec
`defaults.transition`	\|	\|
`defaults.transition.duration`	`--transition-duration`	Default	`0.5`	sec
`defaults.transition.name`	`--transition-name`	Default	`random`	\|
`defaults.transition.audioOutCurve`	\|	`tri`	\|
`defaults.transition.audioInCurve`	\|	`tri`	\|
`clips[]`	\|	\|
`clips[].duration`	\|	`defaults.duration`	\|
`clips[].transition`	\|	`defaults.transition`	\|
`clips[].layers[]`	\|	\|
`clips[].layers[].type`	\|	\|
`clips[].layers[].start`	\|	\|
`clips[].layers[].stop`	\|	\|
`audioTracks[]`	\|	`[]`	\|
`audioFilePath`	`--audio-file-path`	Set	\|
`loopAudio`	`--loop-audio`	Loop	`false`	\|
`keepSourceAudio`	`--keep-source-audio`	Keep	`false`	\|
`clipsAudioVolume`	\|	`1`	\|
`outputVolume`	`--output-volume`	Adjust	`1`	e.g.
`audioNorm.enable`	\|	`false`	\|
`audioNorm.gaussSize`	\|	`5`	\|
`audioNorm.maxGain`	\|	`30`	\|

Transition types

transition.name can be any of gl-transitions, or any of the following:directional-left, directional-right, directional-up, directional-down, random or dummy.

Layer types

See examples and commonFeatures.json5

Layer type 'video'

For video layers, if parent clip.duration is specified, the video will be slowed/sped-up to match clip.duration. If cutFrom/cutTo is set, the resulting segment (cutTo-cutFrom) will be slowed/sped-up to fit clip.duration. If the layer has audio, it will be kept (and mixed with other audio layers if present.)

Parameter	Description	Default	\|
\|-\|-\|-\|-\|
`path`	Path	\|
`resizeMode`	See	\|
`cutFrom`	Time	`0`	sec
`cutTo`	Time	*end	sec
`width`	Width	`1`	`0`
`height`	Height	`1`	`0`
`left`	X-position	`0`	`0`
`top`	Y-position	`0`	`0`
`originX`	X	`left`	`left`
`originY`	Y	`top`	`top`
`mixVolume`	Relative	`1`	\|

Layer type 'audio'

Audio layers will be mixed together. If cutFrom/cutTo is set, the resulting segment (cutTo-cutFrom) will be slowed/sped-up to fit clip.duration. The slow down/speed-up operation is limited to values between 0.5x and 100x.

Parameter	Description	Default	\|
\|-\|-\|-\|-\|
`path`	Path	\|
`cutFrom`	Time	`0`	sec
`cutTo`	Time	`clip.duration`	sec
`mixVolume`	Relative	`1`	\|

Layer type 'detached-audio'

This is a special case of audioTracks that makes it easier to start the audio relative to clips start times without having to calculate global start times.

detached-audio has the exact same properties as audioTracks, exceptstart time is relative to the clip's start.

Example of detached audio tracks

Layer type 'image'

Full screen image

Parameter	Description	Default
\|-\|-\|-\|-\|
`path`	Path	\|
`resizeMode`	See	\|

Layer type 'image-overlay'

Image overlay with a custom position and size on the screen. NOTE: If you want to use animated GIFs use video instead.

Parameter	Description	Default
\|-\|-\|-\|-\|
`path`	Path	\|
`position`	See	\|
`width`	Width	\|
`height`	Height	\|

Layer type 'title'

- fontPath - See defaults.layer.fontPath

- text - Title text to show, keep it short

- textColor - default #ffffff

- position - See Position parameter

Layer type 'subtitle'

- fontPath - See defaults.layer.fontPath

- text - Subtitle text to show

- textColor - default #ffffff

Layer type 'title-background'

Title with background

- text - See type title

- textColor - See type title

- background - { type, ... } - See type radial-gradient, linear-gradient or fill-color

- fontPath - See type title

Layer type 'news-title'

- fontPath - See defaults.layer.fontPath

- text

- textColor - default #ffffff

- backgroundColor - default #d02a42

- position - See Position parameter

Layer type 'slide-in-text'

- fontPath - See defaults.layer.fontPath

- text

- fontSize

- charSpacing

- color

- position - See Position parameter

Layer type 'fill-color', 'pause'

- color - Color to fill background, default: randomize

Layer type 'radial-gradient'

- colors - Array of two colors, default: randomize

Layer type 'linear-gradient'

- colors - Array of two colors, default: randomize

Layer type 'rainbow-colors'

🌈🌈🌈

Layer type 'canvas'

See customCanvas.js

- func - Custom JavaScript function

Layer type 'fabric'

See customFabric.js

- func - Custom JavaScript function

Layer type 'gl'

Loads a GLSL shader. See gl.json5 and rainbow-colors.frag

- fragmentPath

- vertexPath (optional)

Arbitrary audio tracks

audioTracks property can optionally contain a list of objects which specify audio tracks that can be started at arbitrary times in the final video. These tracks will be mixed together (mixVolume specifying a relative number for how loud each track is compared to the other tracks). Because audio from clips will be mixed separately from audioTracks, clipsAudioVolume specifies the volume of the combined audio from clips relative to the volume of each of the audio tracks from audioTracks.

Parameter	Description	Default	\|
\|-\|-\|-\|-\|
`audioTracks[].path`	File	\|
`audioTracks[].mixVolume`	Relative	`1`	\|
`audioTracks[].cutFrom`	Time	`0`	sec
`audioTracks[].cutTo`	Time	\|
`audioTracks[].start`	How	`0`	sec

The difference between audioTracks and Layer type 'audio' is that audioTracks will continue to play across multiple clips and can start and stop whenever needed.

See audioTracks example

Audio normalization

You can enable audio normalization of the final output audio. This is useful if you want to achieve Audio Ducking (e.g. automatically lower volume of all other tracks when voice-over speaks).

audioNorm parameters are documented here.

Example of audio ducking

Resize modes

resizeMode - How to fit image to screen. Can be one of:

- contain - All the video will be contained within the frame and letterboxed

- contain-blur - Like contain, but with a blurred copy as the letterbox

- cover - Video be cropped to cover the whole screen (aspect ratio preserved)

- stretch - Video will be stretched to cover the whole screen (aspect ratio ignored).

Default contain-blur.

See:

- image.json5

- videos.json5

Position parameter

Certain layers support the position parameter

position can be one of either:

- top, bottom center, top-left, top-right, center-left, center-right, bottom-left, bottom-right

- An object { x, y, originX = 'left', originY = 'top' }, where { x: 0, y: 0 } is the upper left corner of the screen, and { x: 1, y: 1 } is the lower right corner, x is relative to video width, y to video height. originX and originY are optional, and specify the position's origin (anchor position) of the object.

See position.json5

Ken Burns parameters

Parameter	Description	Default	\|
\|-\|-\|-\|-\|
`zoomDirection`	Zoom	\|
`zoomAmount`	Zoom	`0.1`	\|

Docker

This should help you use editly as a containerized CLI, without worrying about

getting all the right versions of dependencies on your system.

``` sh
$ git clone https://github.com/mifi/editly.git
$ cd editly/examples
$ git clone https://github.com/mifi/editly-assets.git assets
$ cd ..
$ docker-compose up
$ docker-compose run editly bash -c "cd examples && editly audio1.json5 --out /outputs/audio1.mp4"
$ docker cp editly:/outputs/audio1.mp4 .
```

Troubleshooting

- If you get Error: The specified module could not be found., try: npm un -g editly && npm i -g --build-from-source editly (see #15)

- If you get an error about gl returning null, see Requirements.

- If you get an error /bin/sh: pkg-config: command not found, try to use newest Node.js LTS version

Donate 🙏

This project is maintained by me alone. The project will always remain free and open source, but if it's useful for you, consider supporting me. :) It will give me extra motivation to improve it.

Paypal

Thanks

This package would not exist without the support and help from all the contributors and sponsors!

Special thanks to:

- Patrick Connolly - docker-compose support

- Skayo - Typescript support

Videos made by you

Submit a PR if you want to share your videos or project created with editly here.

- https://www.youtube.com/channel/UCDUauYxuY5Cv1Z6AuD3UGDw?view_as=subscriber

Made with ❤️ in 🇳🇴

More apps by mifi.no

Follow me on GitHub, YouTube, IG, Twitter for more awesome content!

Editly

README

Features

Use cases

Requirements

Installing

Usage: Command line video editor

JavaScript library

Edit spec

Parameters

Transition types

Layer types

Layer type 'video'

Layer type 'audio'

Layer type 'detached-audio'

Layer type 'image'

Layer type 'image-overlay'

Layer type 'title'

Layer type 'subtitle'

Layer type 'title-background'

Layer type 'news-title'

Layer type 'slide-in-text'

Layer type 'fill-color', 'pause'

Layer type 'radial-gradient'

Layer type 'linear-gradient'

Layer type 'rainbow-colors'

Layer type 'canvas'

Layer type 'fabric'

Layer type 'gl'

Arbitrary audio tracks

Audio normalization

Resize modes

Position parameter

Ken Burns parameters

Docker

Troubleshooting

Donate 🙏

Thanks

See also

Videos made by you

关注公众号