ffmpeg-progress 1.0.0 → 1.0.2

package/README.md

@@ -1,6 +1,6 @@
 # ffmpeg-progress
 
-Extract progress from ffmpeg child_process
+Extract progress from ffmpeg child_process output stream
 
 [![npm Package Version](https://img.shields.io/npm/v/ffmpeg-progress)](https://www.npmjs.com/package/ffmpeg-progress)
 
@@ -60,13 +60,16 @@ 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,7 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { ChildProcessWithoutNullStreams } from 'child_process';
-export declare function parseTime(str: string): number;
+export declare function parseToSeconds(str: string): number;
 export type ScanVideoResult = {
     duration: string;
     seconds: number;
@@ -11,13 +9,15 @@ 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 +26,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,22 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.attachChildProcess = exports.convertFile = exports.scanVideo = exports.parseTime = 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 parseTime(str) {
+function parseToSeconds(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);
+                let seconds = parseToSeconds(duration);
                 resolve({ duration, seconds });
                 return;
             }
@@ -27,12 +30,10 @@ function scanVideo(file) {
         });
     });
 }
-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 +41,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);
         }
@@ -48,7 +52,7 @@ async function attachChildProcess(args) {
             let match = str.match(/Duration: ([0-9:.]+),/);
             if (match) {
                 duration = match[1];
-                totalSeconds = parseTime(duration);
+                totalSeconds = parseToSeconds(duration);
                 if (args.onDuration) {
                     args.onDuration(duration);
                 }
@@ -61,7 +65,7 @@ async function attachChildProcess(args) {
                     args.onTime(time);
                 }
                 if (args.onProgress) {
-                    let currentSeconds = parseTime(time);
+                    let currentSeconds = parseToSeconds(time);
                     let deltaSeconds = currentSeconds - lastSeconds;
                     lastSeconds = currentSeconds;
                     args.onProgress({
@@ -70,6 +74,7 @@ async function attachChildProcess(args) {
                         totalSeconds,
                         time,
                         duration,
+                        abort,
                     });
                 }
             }
@@ -82,4 +87,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,11 +1,12 @@
 {
   "name": "ffmpeg-progress",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Extract progress from ffmpeg child_process",
   "keywords": [
     "ffmpeg",
     "progress",
     "child_process",
+    "stream",
     "typescript",
     "video",
     "convert",
@@ -40,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"
   }
 }