ffmpeg-progress-stream

Generate a stream of progress events from the stderr stream of ffmpeg

Installation

This module is installed via npm:

1$ npm install ffmpeg-progress-stream

Example Usage

Render some images into an mp4 file and see the progress stream of the rendering process:

1var ffmpegBin = require('ffmpeg-static'),
2    progressStream = require('ffmpeg-progress-stream');
3var params = [
4  '-y',
5  '-r', 30,
6  '-i', './files/frames*.jpg',
7  '-pix_fmt', 'yuv420p',
8  '-r', 30,
9  '/tmp/out.mp4'
10];
11
12var ffmpeg = spawn(ffmpegBin.path, params);
13ffmpeg.stderr
14  .pipe(progressStream(120))
15  .on('data', console.log);
16
17/**
18  { frame: '56',
19    fps: '0.0',
20    q: '29.0',
21    size: '58kB',
22    time: '00:00:00.13',
23    bitrate: '3586.4kbits/s',
24    progress: 46.666666666666664,
25    remaining: 0.6045714285714285 },
26  { frame: '78',
27    fps: '75',
28    q: '29.0',
29    size: '238kB',
30    time: '00:00:00.86',
31    bitrate: '2248.1kbits/s',
32    progress: 65,
33    remaining: 0.5713076923076923 },
34  { frame: '99',
35    fps: '64',
36    q: '29.0',
37    size: '405kB',
38    time: '00:00:01.56',
39    bitrate: '2116.6kbits/s',
40    progress: 82.5,
41    remaining: 0.33281818181818185 },
42  { frame: '120',
43    fps: '39',
44    q: '-1.0',
45    Lsize: '935kB',
46    time: '00:00:03.93',
47    bitrate: '1946.7kbits/s',
48    progress: 100,
49    remaining: 0 }
50  { frame: '120',
51    fps: '39',
52    q: '-1.0',
53    Lsize: '935kB',
54    time: '00:00:03.93',
55    bitrate: '1946.7kbits/s',
56    size: '935kB',
57    progress: 100,
58    remaining: 0 }
59*/

API

progressStream(total)

• total - total number of frames to expect. If this is present then the progress and remaining keys will be present on the progress stream.

The data events emitted look like this:

1{ frame: '99',
2    fps: '64',
3    q: '29.0',
4    size: '405kB',
5    time: '00:00:01.56',
6    bitrate: '2116.6kbits/s',
7    progress: 82.5,
8    remaining: 0.33281818181818185 }

The progress is a percentage, and remaining is an estimate of the remaining time in seconds.

NB: The last event has a key called Lsize instead of size. This is copied over to the size field for convenience.