ffmpeg-progress 1.0.1 → 1.1.0

package/README.md

@@ -52,21 +52,28 @@ export function parseToSeconds(str: string): number
 export function scanVideo(file: string): Promise<ScanVideoResult>
 
 export type ScanVideoResult = {
+  /** @description e.g. "00:03:00.03" */
   duration: string
+  /** @description e.g. 180.03 */
   seconds: number
+  /** @description e.g. "4032x3024" */
+  resolution: string
 }
 
 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
+  onProgress?: (args: OnProgressArgs) => void
+}
+
+export type OnProgressArgs = {
+  deltaSeconds: number
+  currentSeconds: number
+  totalSeconds: number
+  time: string
+  duration: string
+  abort: () => void
 }
 
 export function convertFile(

package/core.d.ts

@@ -1,23 +1,27 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { ChildProcessWithoutNullStreams } from 'child_process';
 export declare function parseToSeconds(str: string): number;
 export type ScanVideoResult = {
+    /** @description e.g. "00:03:00.03" */
     duration: string;
+    /** @description e.g. 180.03 */
     seconds: number;
+    /** @description e.g. "4032x3024" */
+    resolution: string;
 };
 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;
+    onProgress?: (args: OnProgressArgs) => void;
+};
+export type OnProgressArgs = {
+    deltaSeconds: number;
+    currentSeconds: number;
+    totalSeconds: number;
+    time: string;
+    duration: string;
+    abort: () => void;
 };
 export declare function convertFile(args: {
     inFile: string;
@@ -26,3 +30,9 @@ export declare function convertFile(args: {
 export declare function attachChildProcess(args: {
     childProcess: ChildProcessWithoutNullStreams;
 } & ProgressArgs): Promise<void>;
+export declare function estimateOutSize(args: {
+    inSize: number;
+    currentOutSize: number;
+    currentSeconds: number;
+    totalSeconds: number;
+}): number;

package/core.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.attachChildProcess = exports.convertFile = exports.scanVideo = exports.parseToSeconds = void 0;
+exports.parseToSeconds = parseToSeconds;
+exports.scanVideo = scanVideo;
+exports.convertFile = convertFile;
+exports.attachChildProcess = attachChildProcess;
+exports.estimateOutSize = estimateOutSize;
 const child_process_1 = require("child_process");
 function parseToSeconds(str) {
     let parts = str.split(':');
@@ -9,30 +13,38 @@ function parseToSeconds(str) {
     let s = +parts[2];
     return (h * 60 + m) * 60 + s;
 }
-exports.parseToSeconds = parseToSeconds;
 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) {
+            try {
+                let match = stdout.match(/Duration: ([0-9:.]+),/);
+                if (!match) {
+                    throw new Error('failed to find video duration');
+                }
                 let duration = match[1];
                 let seconds = parseToSeconds(duration);
-                resolve({ duration, seconds });
-                return;
+                match = stdout.match(/Stream #0:\d.+: Video: .+ (\d+x\d+),/);
+                if (!match) {
+                    throw new Error('failed to find video resolution');
+                }
+                let resolution = match[1];
+                resolve({ duration, seconds, resolution });
+            }
+            catch (e) {
+                let error = e instanceof Error ? e : new Error(String(e));
+                if (err) {
+                    error.cause = err;
+                }
+                Object.assign(error, { stdout });
+                reject(error);
             }
-            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;
@@ -40,6 +52,9 @@ async function attachChildProcess(args) {
         let time = '';
         let totalSeconds = 0;
         let lastSeconds = 0;
+        function abort() {
+            childProcess.kill('SIGKILL');
+        }
         if (args.onData) {
             childProcess.stdout.on('data', args.onData);
         }
@@ -70,6 +85,7 @@ async function attachChildProcess(args) {
                         totalSeconds,
                         time,
                         duration,
+                        abort,
                     });
                 }
             }
@@ -82,4 +98,9 @@ async function attachChildProcess(args) {
         return;
     throw new Error(`ffmpeg exit abnormally, exit code: ${code}, signal: ${signal}`);
 }
-exports.attachChildProcess = attachChildProcess;
+function estimateOutSize(args) {
+    let estimatedRate = args.currentOutSize / args.currentSeconds;
+    let remindSeconds = args.totalSeconds - args.currentSeconds;
+    let estimatedOutSize = args.currentOutSize + estimatedRate * remindSeconds;
+    return estimatedOutSize;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffmpeg-progress",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Extract progress from ffmpeg child_process",
   "keywords": [
     "ffmpeg",
@@ -41,10 +41,10 @@
     "build": "tsc -p ."
   },
   "devDependencies": {
-    "@beenotung/tslib": "^22.1.1",
-    "@types/node": "^18.18.5",
-    "ts-node": "^10.9.1",
+    "@beenotung/tslib": "^24.1.0",
+    "@types/node": "^22.9.0",
+    "ts-node": "^10.9.2",
     "ts-node-dev": "^2.0.0",
-    "typescript": "^5.2.2"
+    "typescript": "^5.6.3"
   }
 }