ffmpeg-progress

Extract progress from ffmpeg child_process output stream

Installation

1npm install ffmpeg-progress

Usage Example

Get video duration:

1import { scanVideo } from 'ffmpeg-progress'
2
3console.log(await scanVideo('test/in.mp4'))
4// { duration: '00:52:04.78', seconds: 3124.78 }

Convert video and monitor progress:

1import { startTimer } from '@beenotung/tslib/timer'
2import { convertFile, parseToSeconds } from 'ffmpeg-progress'
3
4let timer = startTimer('estimate duration')
5await convertFile({
6  inFile: 'test/in.mp4',
7  outFile: 'test/out.mp4',
8  onDuration(duration) {
9    timer.next('convert video')
10    timer.setEstimateProgress(parseToSeconds(duration))
11  },
12  onProgress(args) {
13    timer.tick(args.deltaSeconds)
14  },
15})
16timer.end()

Get video resolution:

1import { getVideoResolution } from 'ffmpeg-progress'
2
3console.log(await getVideoResolution('test/rotate.mp4'))
4// { width: 3024, height: 4032 }

Typescript Types

1import { ChildProcessWithoutNullStreams } from 'child_process'
2
3export function parseToSeconds(str: string): number
4
5export function scanVideo(file: string): Promise<ScanVideoResult>
6
7export type ScanVideoResult = {
8  /** @description e.g. "00:03:00.03" */
9  duration: string
10  /** @description e.g. 180.03 */
11  seconds: number
12  /** @description e.g. "4032x3024" */
13  resolution: string
14}
15
16export type ProgressArgs = {
17  onData?: (chunk: Buffer) => void
18  onDuration?: (duration: string) => void
19  onTime?: (time: string) => void
20  onProgress?: (args: OnProgressArgs) => void
21}
22
23export type OnProgressArgs = {
24  deltaSeconds: number
25  currentSeconds: number
26  totalSeconds: number
27  time: string
28  duration: string
29  abort: () => void
30}
31
32export function convertFile(
33  args: {
34    inFile: string
35    outFile: string
36  } & ProgressArgs,
37): Promise<void>
38
39export function attachChildProcess(
40  args: {
41    childProcess: ChildProcessWithoutNullStreams
42  } & ProgressArgs,
43): Promise<void>
44
45/**
46 * take a image frame from the video,
47 * this is more accurate than parsing the resolution string in ffmpeg,
48 * because the video has rotation metadata.
49 */
50export function getVideoResolution(video_file: string): Promise<{
51  width: number
52  height: number
53}>

License

This project is licensed with BSD-2-Clause

This is free, libre, and open-source software. It comes down to four essential freedoms [ref]:

• The freedom to run the program as you wish, for any purpose
• The freedom to study how the program works, and change it so it does your computing as you wish
• The freedom to redistribute copies so you can help others
• The freedom to distribute copies of your modified versions to others