Deno FFMPEG

FFmpeg is really nice to use and quite handy for alot of applications But we didn't have any easy wrapper for it in Deno, so now we do :D

List of features

• Video bitrate(VBR and CBR)
• FFMPEG Filters
• Easy to use
• All methods are chainable
• Frequently updated and maintained by me

V2 information

denoFFMPEG v2 is alot different from v1
it breaks alot of stuff that used to work.

please read the doc's below to see what changed

Basic example

save() is used to start the render process.

you should always use save() or saveWithProgress() as last option
you should always specify the ffmpegDir in the constructor or via the setFfmpegPath() method!

import { ffmpeg } from "./mod.ts";
let videoRender = ffmpeg({ input: "./dev/video0", ffmpegDir: "./dev/ffmpeg" });
await videoRender.videoBitrate(1000).save("./output.mp4");

Documentation

Creating a new instance of ffmpeg

The denoFFMPEG module returns a constructor that you can use to instanciate FFmpeg commands. you should always specify the ffmpegDir in the constructor or via the setFfmpegPath() method!

import { ffmpeg } from "./mod.ts";
let render = ffmpeg();

//or use ffmpeg class
import { FfmpegClass } from "./mod.ts";
let render = new FfmpegClass();

Global Methods

save(outputPath: string)

save() returns a Promise that get's voided once ffmpeg is done rendering

import { ffmpeg } from "./mod.ts";

await ffmpeg().save("video.mp4");

//or like this
let render = ffmpeg().save("video.mp4");
await render;

saveWithProgress(outputPath: String)

saveWithProgress() returns an asyncGenerator with an object with 2 keys in it.

ETA: which is the estimated time the render is done
percentage: The percentage of how far the render is

import { ffmpeg } from "./mod.ts";

let render = ffmpeg().saveWithProgress("video.mp4");

//this will await the yield to be finished
for await (const obj of render) {
  console.log(obj);
}

setFfmpegPath(path: string)

setFfmpegPath() will set the ffmpeg path if this is not set in the constructor

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().setFfmpegPath("./path/to/binary");
await render.save("video.mp4");

threads(threadcount: number)

threads() let's you set a custom number of threads to use for encoding

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().threads(5);
await render.save("video.mp4");

Video Methods

addInput(path: string)

addInput() will add an input to the list of input's (you need to map them yourself)

this means that the first input is input 0 so on and so on
path can be a url aswell

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().addInput("./path/to/file");
await render.save("video.mp4");

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().addInput("./path/to/file"); // this is input 0
render.addInput("./path/to/file"); // this is input 1
await render.save("video.mp4");

setWidth(w: number)

setWidth() let's you adjust video width

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().setWidth(1920);
await render.save("video.mp4");

setHeight(h: number)

setHeight() let's you adjust video height

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().setHeight(1080);
await render.save("video.mp4");

outputFPS(fps: number)

outputFPS() let's you adjust the framerate of the video

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().outputFPS(24);
await render.save("video.mp4");

noVideo()

noVideo() will just disable video and remove all video settings

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().noVideo();
await render.save("video.mp4");

videoCodec(codec: string, options?: Object)

videoCodec() let's you specify which video codec & options to use
options should only be used if you know what you are doing

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().videoCodec("libx264");
await render.save("video.mp4");

videoBitrate(bitrate: string|number, constantBitrate: boolean)

videoBitrate() let's you specify the video bitrate(default is kbps) and if this should be cbr(default) or vbr

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().videoBitrate(1050);
await render.save("video.mp4");

import { ffmpeg } from "./mod.ts";

// set the second parameter to false if you want to use VBR
let render = ffmpeg().videoBitrate("1050k", false);
await render.save("video.mp4");

Audio Methods

noAudio()

noAudio() will just disable audio and remove all audio settings

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().noAudio();
await render.save("video.mp4");

audioCodec(codec: string, options?: Object)

audioCodec() let's you specify which audio codec & options to use
options should only be used if you know what you are doing

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().audioCodec("lib3lame");
await render.save("video.mp4");

audioBitrate(bitrate: number)

audioBitrate() let's you specify the audio bitrate in kbps

import { ffmpeg } from "./mod.ts";
let render = ffmpeg().audioBitrate(128);
await render.save("video.mp4");

Filters

videoFilters(...Filter: Filters[])

videoFilters() let's you use the videofilters
-vf drawtext=text=cool guy:fontsize:60 will be like this

const filters = {
  filterName: "drawtext",
  options: {
    text: "cool guy",
    fontsize: 60,
  },
};

import { ffmpeg } from "./mod.ts";

let render = ffmpeg().videoFilters(
  {
    filterName: "drawtext",
    options: {
      text: "cool guy",
      fontsize: 60,
    },
  },
);
await render.save("video.mp4");

audioFilters(...Filter: Filters[])

audioFilters() let's you use the audio filters
this is a audio counterpart of videoFilters()
it works the same way but for audio filters

-vf afade=type=in: duration=10: curve=log will be like this

const filters = {
  filterName: "afade",
  options: {
    type: "in",
    duration: 10,
    curve: "log",
  },
};

import { ffmpeg } from "./mod.ts";

let render = ffmpeg().audioFilters(
  {
    filterName: "afade",
    options: {
      type: "in",
      duration: 10,
      curve: "log",
    },
  },
);
await render.save("video.mp4");

complexFilters(...Filter: Filters[])

complex() let's you use complex video and or audio filters
-filter_complex overlay=x=10:y=60 will be like this

const filters = {
  filterName: "overlay",
  options: {
    x: 10,
    y: 60,
  },
};

import { ffmpeg } from "./mod.ts";

let render = ffmpeg().complexFilters(
  {
    filterName: "overlay",
    options: {
      x: 10,
      y: 60,
    },
  },
);
await render.save("video.mp4");

Releases

Currently I have 2 branches.
Dev which will get all the latest pushes and commit's after v2.1
and I have main which will be all official releases like v2.1 and v2.2 etc.
The dev branch might be unstable or broken but it will have the latest features.
These features may not be documented yet!

Authors & Acknowledgments

• Skyler "MierenMans" van Boheemen - Author

License

Copyright 2021 Skyler "MierenMans" van Boheemen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.