ffmpeg-progress 0.0.0 → 1.0.0

package/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) [2023], [Beeno Tung (Tung Cheung Leong)]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,95 @@
+# ffmpeg-progress
+
+Extract progress from ffmpeg child_process
+
+[![npm Package Version](https://img.shields.io/npm/v/ffmpeg-progress)](https://www.npmjs.com/package/ffmpeg-progress)
+
+## Installation
+
+```bash
+npm install ffmpeg-progress
+```
+
+## Usage Example
+
+**Get video duration**:
+
+```typescript
+import { scanVideo } from 'ffmpeg-progress'
+
+console.log(await scanVideo('test/in.mp4'))
+// { duration: '00:52:04.78', seconds: 3124.78 }
+```
+
+**Convert video and monitor progress**:
+
+```typescript
+import { startTimer } from '@beenotung/tslib/timer'
+import { convertFile, parseToSeconds } from 'ffmpeg-progress'
+
+let timer = startTimer('estimate duration')
+await convertFile({
+  inFile: 'test/in.mp4',
+  outFile: 'test/out.mp4',
+  onDuration(duration) {
+    timer.next('convert video')
+    timer.setEstimateProgress(parseToSeconds(duration))
+  },
+  onProgress(args) {
+    timer.tick(args.deltaSeconds)
+  },
+})
+timer.end()
+```
+
+## Typescript Types
+
+```typescript
+import { ChildProcessWithoutNullStreams } from 'child_process'
+
+export function parseToSeconds(str: string): number
+
+export function scanVideo(file: string): Promise<ScanVideoResult>
+
+export type ScanVideoResult = {
+  duration: string
+  seconds: number
+}
+
+export type ProgressArgs = {
+  onData?: (chunk: Buffer) => void
+  onDuration?: (duration: string) => void
+  onTime?: (time: string) => void
+  onProgress?: (args: {
+    deltaSeconds: number
+    currentSeconds: number
+    totalSeconds: number
+    time: string
+    duration: string
+  }) => void
+}
+
+export function convertFile(
+  args: {
+    inFile: string
+    outFile: string
+  } & ProgressArgs,
+): Promise<void>
+
+export function attachChildProcess(
+  args: {
+    childProcess: ChildProcessWithoutNullStreams
+  } & ProgressArgs,
+): Promise<void>
+```
+
+## License
+
+This project is licensed with [BSD-2-Clause](./LICENSE)
+
+This is free, libre, and open-source software. It comes down to four essential freedoms [[ref]](https://seirdy.one/2021/01/27/whatsapp-and-the-domestication-of-users.html#fnref:2):
+
+- 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

package/core.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { ChildProcessWithoutNullStreams } from 'child_process';
+export declare function parseTime(str: string): number;
+export type ScanVideoResult = {
+    duration: string;
+    seconds: number;
+};
+export declare function scanVideo(file: string): Promise<ScanVideoResult>;
+export type ProgressArgs = {
+    onData?: (chunk: Buffer) => void;
+    onDuration?: (duration: string) => void;
+    onTime?: (time: string) => void;
+    onProgress?: (args: {
+        deltaSeconds: number;
+        currentSeconds: number;
+        totalSeconds: number;
+        time: string;
+        duration: string;
+    }) => void;
+};
+export declare function convertFile(args: {
+    inFile: string;
+    outFile: string;
+} & ProgressArgs): Promise<void>;
+export declare function attachChildProcess(args: {
+    childProcess: ChildProcessWithoutNullStreams;
+} & ProgressArgs): Promise<void>;

package/core.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.attachChildProcess = exports.convertFile = exports.scanVideo = exports.parseTime = void 0;
+const child_process_1 = require("child_process");
+function parseTime(str) {
+    let parts = str.split(':');
+    let h = +parts[0];
+    let m = +parts[1];
+    let s = +parts[2];
+    return (h * 60 + m) * 60 + s;
+}
+exports.parseTime = parseTime;
+function scanVideo(file) {
+    return new Promise((resolve, reject) => {
+        (0, child_process_1.exec)(`ffmpeg -i ${JSON.stringify(file)} 2>&1`, (err, stdout, stderr) => {
+            let match = stdout.match(/Duration: ([0-9:.]+),/);
+            if (match) {
+                let duration = match[1];
+                let seconds = parseTime(duration);
+                resolve({ duration, seconds });
+                return;
+            }
+            let error = new Error('failed to find video duration');
+            error.cause = err;
+            Object.assign(error, { stdout });
+            reject(error);
+        });
+    });
+}
+exports.scanVideo = scanVideo;
+async function convertFile(args) {
+    let childProcess = (0, child_process_1.spawn)('ffmpeg', ['-y', '-i', args.inFile, args.outFile]);
+    return attachChildProcess({ childProcess, ...args });
+}
+exports.convertFile = convertFile;
+async function attachChildProcess(args) {
+    let { code, signal } = await new Promise((resolve, reject) => {
+        let { childProcess } = args;
+        let duration = '';
+        let time = '';
+        let totalSeconds = 0;
+        let lastSeconds = 0;
+        if (args.onData) {
+            childProcess.stdout.on('data', args.onData);
+        }
+        childProcess.stderr.on('data', (data) => {
+            let str = data.toString();
+            let match = str.match(/Duration: ([0-9:.]+),/);
+            if (match) {
+                duration = match[1];
+                totalSeconds = parseTime(duration);
+                if (args.onDuration) {
+                    args.onDuration(duration);
+                }
+                return;
+            }
+            match = str.match(/frame=\s*\d+\s+fps=.*time=([0-9:.]+)\s/);
+            if (match) {
+                time = match[1];
+                if (args.onTime) {
+                    args.onTime(time);
+                }
+                if (args.onProgress) {
+                    let currentSeconds = parseTime(time);
+                    let deltaSeconds = currentSeconds - lastSeconds;
+                    lastSeconds = currentSeconds;
+                    args.onProgress({
+                        deltaSeconds,
+                        currentSeconds,
+                        totalSeconds,
+                        time,
+                        duration,
+                    });
+                }
+            }
+        });
+        childProcess.on('exit', (code, signal) => {
+            resolve({ code, signal });
+        });
+    });
+    if (code == 0)
+        return;
+    throw new Error(`ffmpeg exit abnormally, exit code: ${code}, signal: ${signal}`);
+}
+exports.attachChildProcess = attachChildProcess;

package/package.json

@@ -1,11 +1,49 @@
 {
   "name": "ffmpeg-progress",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
+  "version": "1.0.0",
+  "description": "Extract progress from ffmpeg child_process",
+  "keywords": [
+    "ffmpeg",
+    "progress",
+    "child_process",
+    "typescript",
+    "video",
+    "convert",
+    "scan",
+    "duration"
+  ],
+  "author": {
+    "name": "Beeno Tung",
+    "email": "aabbcc1241@yahoo.com.hk",
+    "url": "https://beeno-tung.surge.sh"
+  },
+  "license": "BSD-2-Clause",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/beenotung/ffmpeg-progress.git"
+  },
+  "homepage": "https://github.com/beenotung/ffmpeg-progress#readme",
+  "bugs": {
+    "url": "https://github.com/beenotung/ffmpeg-progress/issues"
+  },
+  "main": "core.js",
+  "types": "./core.d.ts",
+  "directories": {
+    "test": "test"
+  },
+  "files": [
+    "core.d.ts",
+    "core.js"
+  ],
   "scripts": {
+    "test": "tsc --noEmit",
+    "build": "tsc -p ."
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC"
+  "devDependencies": {
+    "@beenotung/tslib": "^22.1.1",
+    "@types/node": "^18.18.5",
+    "ts-node": "^10.9.1",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.2.2"
+  }
 }