ffmpeg-on-progress

Utility for robustly reporting ffmpeg command progress with fluent-ffmpeg.

Some ffmpeg commands aren't capable fo producing progress events, such as when the input is a stream or when using multiple inputs. This simple utility allows you to accurately report progress in these cases by looking at the number of frames ffmpeg has processed with the caveat that you need to know the expected output's duration ahead of time.

In cases where fluent-ffmpeg produces a valid progress event, this module is a noop.

Install

1npm install --save ffmpeg-on-progress-ts
2# or
3yarn add ffmpeg-on-progress-ts

Usage

1import ffmpeg from 'fluent-ffmpeg'
2import ffmpegOnProgress from 'ffmpeg-on-progress-ts'
3import type { ProgressFunction } from 'ffmpeg-on-progress-ts'
4
5const logProgress: ProgressFunction = (progress, event) => {
6  // progress is a floating point number from 0 to 1
7  console.log('progress', (progress * 100).toFixed())
8}
9
10// estimated duration of output in milliseconds
11const durationEstimate = 4000
12
13const cmd = ffmpeg('input.avi')
14  .output('output.mp4')
15  .on('progress', ffmpegOnProgress(logProgress, durationEstimate))
16  .run()

Related

• ffmpeg-on-progress - The JS version
• fluent-ffmpeg
• awesome-ffmpeg - A curated list of awesome ffmpeg resources with a focus on JavaScript.