FFMPEG Progress Wrapper

Wraps your ffmpeg raw command line with a nice progress interface

---

Installation

$ npm install ffmpeg-progress-wrapper $ yarn ffmpeg-progress-wrapper

Use cases

• Provides a progress status for your video without you having to guess the frame count
• Provides duration and bitrate of the file

---

Usage

Constructor

1import {FFMpegProgress} from 'ffmpeg-progress-wrapper';
2new FFMpegProgress(args, options);

• args: string[] - List of string arguments
• options?: object - optional
  • cmd?: string - path to ffmpeg (defaults to ffmpeg from PATH)
  • cwd?: string - working dir (defaults to current working dir)
  • env?: ProcessEnv - environment vars (defaults to process.env)
  • duration?: number - output duration in seconds (default is determined from file)
    useful when using complex filters and the input time differs from output
  • hideFFConfig?: boolean - hide ffmpeg config from stderr (default false)
  • maxMemory?: number - max amount of bytes allowed by the process to use before killing for OOM (default unset)

FFMpegProgress.on('progress')

• progressData: object
  • eta: number | null - time left to process in seconds
  • speed: number | null - processed output time / real time (2x - twice realtime, 0.5x - half realtime)
  • fps: number | null
  • time: number | null - current output time in seconds
  • frame: number | null - current output frame
  • progress: number | null - progress percentage (from 0 to 1)
  • drop: number - dropped frames
  • dup: number - duplicated frames
  • quality: number[][] - stream quality per frame, per stream
  • psnr: { y: number | null, u: number | null, v: number | null, all: number | null }[][] - stream psnr per file, per stream, per channel (enabled via -psnr ffmpeg arg)
  • size: number | null - output file size
  • bitrate: number | null - output file bitrate in bytes

FFMpegProgress.on('raw') - Fires whenever ffmpeg outputs text - very volatile

• raw: string

FFMpegProgress.on('details') - Fires once per command, at the beginning

• details: object
  • duration: number - video duration in seconds
  • bitrate: number - video bitrate in bytes
  • start: number - video's first frame time in seconds

---

Example

1const {FFMpegProgress} = require('ffmpeg-progress-wrapper');
2// or
3import {FFMpegProgress} from 'ffmpeg-progress-wrapper';
4
5(async () => {
6  
7    const process = new FFMpegProgress(['-i', 'test.mov' ,'test output.mp4']);
8    
9    process.on('raw', console.log);
10    
11    process.once('details', (details) => console.log(JSON.stringify(details));
12    
13    process.on('progress', (progress) => console.log(JSON.stringify(progress));
14    
15    process.once('end', console.log.bind(console, 'Conversion finished and exited with code'));
16    
17    process.done(console.log);
18    
19    await process.onDone();
20
21})();
22/**
23{
24  duration: 216,
25  bitrate: 36864,
26  start: 0,
27  resolution: { width: 320, height: 240 },
28  fps: 25
29}
30{
31  drop: 0,
32  dup: 0,
33  frame: 1366,
34  time: 52.480078,
35  speed: 105,
36  fps: 0,
37  eta: 1.5573325904761905,
38  progress: 0.24296332407407406,
39  quality: [ [ 28 ] ],
40  psnr: [ [ { y: NaN, u: NaN, v: NaN, all: NaN } ] ],
41  size: 36,
42  bitrate: 0
43}
44{
45  drop: 0,
46  dup: 0,
47  frame: 2700,
48  time: 105.840078,
49  speed: 106,
50  fps: 2696.44,
51  eta: 1.0392445471698113,
52  progress: 0.4900003611111111,
53  quality: [ [ 28 ] ],
54  psnr: [ [ { y: NaN, u: NaN, v: NaN, all: NaN } ] ],
55  size: 262180,
56  bitrate: 20275.2
57}
58{
59  drop: 0,
60  dup: 0,
61  frame: 4138,
62  time: 163.360078,
63  speed: 109,
64  fps: 2756.01,
65  eta: 0.4829350642201836,
66  progress: 0.7562966574074074,
67  quality: [ [ 28 ] ],
68  psnr: [ [ { y: NaN, u: NaN, v: NaN, all: NaN } ] ],
69  size: 524324,
70  bitrate: 26316.8
71}
72{
73  drop: 0,
74  dup: 0,
75  frame: 5423,
76  time: 216.800078,
77  speed: 110,
78  fps: 2747.61,
79  eta: 0,
80  progress: 1.0037040648148148,
81  quality: [ [ -1 ] ],
82  psnr: [ [ { y: Infinity, u: Infinity, v: Infinity, all: Infinity } ] ],
83  size: 977469,
84  bitrate: 36966.4
85}
86Conversion finished and exited with code 0 null
87*/