@remotion/install-whisper-cpp 4.0.155 → 4.0.156

package/dist/download-whisper-model.d.ts

@@ -2,9 +2,10 @@ import { type OnProgress } from './download';
 declare const models: readonly ["tiny", "tiny.en", "base", "base.en", "small", "small.en", "medium", "medium.en", "large-v1", "large-v2", "large-v3"];
 export type WhisperModel = (typeof models)[number];
 export declare const getModelPath: (folder: string, model: WhisperModel) => string;
-export declare const downloadWhisperModel: ({ model, folder, printOutput, onProgress, }: {
+export declare const downloadWhisperModel: ({ model, folder, printOutput, onProgress, signal, }: {
     model: WhisperModel;
     folder: string;
+    signal?: AbortSignal | undefined;
     printOutput?: boolean | undefined;
     onProgress?: OnProgress | undefined;
 }) => Promise<{

package/dist/download-whisper-model.js

@@ -43,20 +43,40 @@ const models = [
     'large-v2',
     'large-v3',
 ];
+const modelSizes = {
+    'medium.en': 1533774781,
+    'base.en': 147964211,
+    'large-v1': 3094623691,
+    'large-v2': 3094623691,
+    'large-v3': 3095033483,
+    small: 487601967,
+    tiny: 77691713,
+    'small.en': 487614201,
+    'tiny.en': 77704715,
+    base: 147951465,
+    medium: 1533774781,
+};
 const getModelPath = (folder, model) => {
     return path_1.default.join(folder, `ggml-${model}.bin`);
 };
 exports.getModelPath = getModelPath;
-const downloadWhisperModel = async ({ model, folder, printOutput = true, onProgress, }) => {
+const downloadWhisperModel = async ({ model, folder, printOutput = true, onProgress, signal, }) => {
     if (!models.includes(model)) {
         throw new Error(`Invalid whisper model ${model}. Available: ${models.join(', ')}`);
     }
     const filePath = (0, exports.getModelPath)(folder, model);
     if ((0, fs_1.existsSync)(filePath)) {
+        const { size } = fs_1.default.statSync(filePath);
+        if (size === modelSizes[model]) {
+            if (printOutput) {
+                console.log(`Model already exists at ${filePath}`);
+            }
+            return Promise.resolve({ alreadyExisted: true });
+        }
         if (printOutput) {
-            console.log(`Model already exists at ${filePath}`);
+            throw new Error(`Model ${model} already exists at ${filePath}, but the size is ${size} bytes (expected ${modelSizes[model]} bytes). Delete ${filePath} and try again.`);
         }
-        return Promise.resolve({ alreadyExisted: true });
+        return Promise.resolve({ alreadyExisted: false });
     }
     const baseModelUrl = `https://huggingface.co/ggerganov/whisper.cpp/resolve/main/ggml-${model}.bin`;
     if (printOutput) {
@@ -68,6 +88,7 @@ const downloadWhisperModel = async ({ model, folder, printOutput = true, onProgr
         url: baseModelUrl,
         printOutput,
         onProgress,
+        signal: signal !== null && signal !== void 0 ? signal : null,
     });
     return { alreadyExisted: false };
 };

package/dist/download.d.ts

@@ -6,9 +6,10 @@
 /// <reference types="bun-types" />
 /// <reference types="bun-types" />
 export type OnProgress = (downloadedBytes: number, totalBytes: number) => void;
-export declare const downloadFile: ({ fileStream, url, printOutput, onProgress, }: {
+export declare const downloadFile: ({ fileStream, url, printOutput, onProgress, signal, }: {
     fileStream: NodeJS.WritableStream;
     url: string;
     printOutput: boolean;
     onProgress: OnProgress | undefined;
+    signal: AbortSignal | null;
 }) => Promise<void>;

package/dist/download.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.downloadFile = void 0;
-const downloadFile = async ({ fileStream, url, printOutput, onProgress, }) => {
-    const { body, headers } = await fetch(url);
+const downloadFile = async ({ fileStream, url, printOutput, onProgress, signal, }) => {
+    const { body, headers } = await fetch(url, {
+        signal,
+    });
     const contentLength = headers.get('content-length');
     if (body === null) {
         throw new Error('Failed to download whisper model');

package/dist/index.d.ts

@@ -3,4 +3,4 @@ export type { OnProgress } from './download';
 export { WhisperModel, downloadWhisperModel } from './download-whisper-model';
 export { installWhisperCpp } from './install-whisper-cpp';
 export type { Language } from './languages';
-export { TranscriptionJson, transcribe } from './transcribe';
+export { TranscribeOnProgress, TranscriptionJson, transcribe, } from './transcribe';

package/dist/install-whisper-cpp.d.ts

@@ -1,7 +1,8 @@
 export declare const getWhisperExecutablePath: (whisperPath: string) => string;
-export declare const installWhisperCpp: ({ version, to, printOutput, }: {
+export declare const installWhisperCpp: ({ version, to, printOutput, signal, }: {
     version: string;
     to: string;
+    signal?: AbortSignal | null | undefined;
     printOutput?: boolean | undefined;
 }) => Promise<{
     alreadyExisted: boolean;

package/dist/install-whisper-cpp.js

@@ -27,15 +27,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.installWhisperCpp = exports.getWhisperExecutablePath = void 0;
+const child_process_1 = require("child_process");
 const fs_1 = __importStar(require("fs"));
-const node_child_process_1 = require("node:child_process");
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const download_1 = require("./download");
 const getIsSemVer = (str) => {
     return /^[\d]{1}\.[\d]{1,2}\.+/.test(str);
 };
-const installForWindows = async ({ version, to, printOutput, }) => {
+const execute = ({ command, printOutput, signal, cwd, shell, }) => {
+    const stdio = printOutput ? 'inherit' : 'ignore';
+    return new Promise((resolve, reject) => {
+        const [bin, ...args] = command.split(' ');
+        const child = (0, child_process_1.spawn)(bin, args, {
+            stdio,
+            signal: signal !== null && signal !== void 0 ? signal : undefined,
+            cwd: cwd !== null && cwd !== void 0 ? cwd : undefined,
+            shell: shell !== null && shell !== void 0 ? shell : undefined,
+        });
+        child.on('exit', (code, exitSignal) => {
+            if (code !== 0) {
+                reject(new Error(`Error while executing ${command}. Exit code: ${code}, signal: ${exitSignal}`));
+                return;
+            }
+            resolve();
+        });
+    });
+};
+const installForWindows = async ({ version, to, printOutput, signal, }) => {
     if (!getIsSemVer(version)) {
         throw new Error(`Non-semantic version provided. Only releases of Whisper.cpp are supported on Windows (e.g., 1.5.4). Provided version:
 		${version}. See https://www.remotion.dev/docs/install-whisper-cpp/install-whisper-cpp#version for more information.`);
@@ -50,26 +69,39 @@ const installForWindows = async ({ version, to, printOutput, }) => {
         printOutput,
         url,
         onProgress: undefined,
+        signal,
     });
-    (0, node_child_process_1.execSync)(`Expand-Archive -Force ${filePath} ${to}`, {
+    execute({
+        command: `Expand-Archive -Force ${filePath} ${to}`,
         shell: 'powershell',
-        stdio: printOutput ? 'inherit' : 'ignore',
+        printOutput,
+        signal,
+        cwd: null,
     });
     (0, fs_1.rmSync)(filePath);
 };
-const installWhisperForUnix = ({ version, to, printOutput, }) => {
-    const stdio = printOutput ? 'inherit' : 'ignore';
-    (0, node_child_process_1.execSync)(`git clone https://github.com/ggerganov/whisper.cpp.git ${to}`, {
-        stdio,
+const installWhisperForUnix = async ({ version, to, printOutput, signal, }) => {
+    await execute({
+        command: `git clone https://github.com/ggerganov/whisper.cpp.git ${to}`,
+        printOutput,
+        signal,
+        cwd: null,
+        shell: null,
     });
     const ref = getIsSemVer(version) ? `v${version}` : version;
-    (0, node_child_process_1.execSync)(`git checkout ${ref}`, {
-        stdio,
+    await execute({
+        command: `git checkout ${ref}`,
+        printOutput,
         cwd: to,
+        signal,
+        shell: null,
     });
-    (0, node_child_process_1.execSync)(`make`, {
+    await execute({
+        command: 'make',
         cwd: to,
-        stdio,
+        signal,
+        printOutput,
+        shell: null,
     });
 };
 const getWhisperExecutablePath = (whisperPath) => {
@@ -78,11 +110,11 @@ const getWhisperExecutablePath = (whisperPath) => {
         : path_1.default.join(whisperPath, './main');
 };
 exports.getWhisperExecutablePath = getWhisperExecutablePath;
-const installWhisperCpp = async ({ version, to, printOutput = true, }) => {
+const installWhisperCpp = async ({ version, to, printOutput = true, signal, }) => {
     if ((0, fs_1.existsSync)(to)) {
         if (!(0, fs_1.existsSync)((0, exports.getWhisperExecutablePath)(to))) {
             if (printOutput) {
-                console.log(`Whisper folder exists but the executable (${to}) is missing. Delete ${to} and try again.`);
+                throw new Error(`Whisper folder ${to} exists but the executable (${(0, exports.getWhisperExecutablePath)(to)}) is missing. Delete ${to} and try again.`);
             }
             return Promise.resolve({ alreadyExisted: false });
         }
@@ -92,11 +124,16 @@ const installWhisperCpp = async ({ version, to, printOutput = true, }) => {
         return Promise.resolve({ alreadyExisted: true });
     }
     if (process.platform === 'darwin' || process.platform === 'linux') {
-        installWhisperForUnix({ version, to, printOutput });
+        await installWhisperForUnix({
+            version,
+            to,
+            printOutput,
+            signal: signal !== null && signal !== void 0 ? signal : null,
+        });
         return Promise.resolve({ alreadyExisted: false });
     }
     if (process.platform === 'win32') {
-        await installForWindows({ version, to, printOutput });
+        await installForWindows({ version, to, printOutput, signal: signal !== null && signal !== void 0 ? signal : null });
         return Promise.resolve({ alreadyExisted: false });
     }
     throw new Error(`Unsupported platform: ${process.platform}`);

package/dist/transcribe.d.ts

@@ -58,7 +58,8 @@ export type TranscriptionJson<WithTokenLevelTimestamp extends boolean> = {
     result: Result;
     transcription: true extends WithTokenLevelTimestamp ? TranscriptionItemWithTimestamp[] : TranscriptionItem[];
 };
-export declare const transcribe: <HasTokenLevelTimestamps extends boolean>({ inputPath, whisperPath, model, modelFolder, translateToEnglish, tokenLevelTimestamps, printOutput, tokensPerItem, language, }: {
+export type TranscribeOnProgress = (progress: number) => void;
+export declare const transcribe: <HasTokenLevelTimestamps extends boolean>({ inputPath, whisperPath, model, modelFolder, translateToEnglish, tokenLevelTimestamps, printOutput, tokensPerItem, language, signal, onProgress, }: {
     inputPath: string;
     whisperPath: string;
     model: WhisperModel;
@@ -68,5 +69,7 @@ export declare const transcribe: <HasTokenLevelTimestamps extends boolean>({ inp
     printOutput?: boolean | undefined;
     tokensPerItem?: (true extends HasTokenLevelTimestamps ? never : number | null) | undefined;
     language?: Language | null | undefined;
+    signal?: AbortSignal | undefined;
+    onProgress?: TranscribeOnProgress | undefined;
 }) => Promise<TranscriptionJson<HasTokenLevelTimestamps>>;
 export {};

package/dist/transcribe.js

@@ -43,7 +43,7 @@ const readJson = async (jsonPath) => {
     const data = await node_fs_1.default.promises.readFile(jsonPath, 'utf8');
     return JSON.parse(data);
 };
-const transcribeToTempJSON = async ({ fileToTranscribe, whisperPath, model, tmpJSONPath, modelFolder, translate, tokenLevelTimestamps, printOutput, tokensPerItem, language, }) => {
+const transcribeToTemporaryFile = async ({ fileToTranscribe, whisperPath, model, tmpJSONPath, modelFolder, translate, tokenLevelTimestamps, printOutput, tokensPerItem, language, signal, onProgress, }) => {
     const modelPath = (0, download_whisper_model_1.getModelPath)(modelFolder !== null && modelFolder !== void 0 ? modelFolder : whisperPath, model);
     if (!node_fs_1.default.existsSync(modelPath)) {
         throw new Error(`Error: Model ${model} does not exist at ${modelFolder ? modelFolder : modelPath}. Check out the downloadWhisperModel() API at https://www.remotion.dev/docs/install-whisper-cpp/download-whisper-model to see how to install whisper models`);
@@ -59,6 +59,7 @@ const transcribeToTempJSON = async ({ fileToTranscribe, whisperPath, model, tmpJ
         '-ojf', // Output full JSON
         tokenLevelTimestamps ? ['--dtw', model] : null,
         model ? [`-m`, `${modelPath}`] : null,
+        ['-pp'], // print progress
         translate ? '-tr' : null,
         language ? ['-l', language.toLowerCase()] : null,
     ]
@@ -67,11 +68,17 @@ const transcribeToTempJSON = async ({ fileToTranscribe, whisperPath, model, tmpJ
     const outputPath = await new Promise((resolve, reject) => {
         const task = (0, node_child_process_1.spawn)(executable, args, {
             cwd: whisperPath,
+            signal: signal !== null && signal !== void 0 ? signal : undefined,
         });
         const predictedPath = `${tmpJSONPath}.json`;
         let output = '';
         const onData = (data) => {
             const str = data.toString('utf-8');
+            const hasProgress = str.includes('progress =');
+            if (hasProgress) {
+                const progress = parseFloat(str.split('progress =')[1].trim());
+                onProgress === null || onProgress === void 0 ? void 0 : onProgress(progress / 100);
+            }
             output += str;
             // Sometimes it hangs here
             if (str.includes('ggml_metal_free: deallocating')) {
@@ -92,15 +99,16 @@ const transcribeToTempJSON = async ({ fileToTranscribe, whisperPath, model, tmpJ
         };
         task.stdout.on('data', onStdout);
         task.stderr.on('data', onStderr);
-        task.on('exit', (code, signal) => {
+        task.on('exit', (code, exitSignal) => {
             // Whisper sometimes files also with error code 0
             // https://github.com/ggerganov/whisper.cpp/pull/1952/files
             if ((0, node_fs_1.existsSync)(predictedPath)) {
                 resolve(predictedPath);
+                onProgress === null || onProgress === void 0 ? void 0 : onProgress(1);
                 return;
             }
-            if (signal) {
-                reject(new Error(`Process was killed with signal ${signal}: ${output}`));
+            if (exitSignal) {
+                reject(new Error(`Process was killed with signal ${exitSignal}: ${output}`));
                 return;
             }
             reject(new Error(`No transcription was created (process exited with code ${code}): ${output}`));
@@ -108,7 +116,7 @@ const transcribeToTempJSON = async ({ fileToTranscribe, whisperPath, model, tmpJ
     });
     return { outputPath };
 };
-const transcribe = async ({ inputPath, whisperPath, model, modelFolder, translateToEnglish = false, tokenLevelTimestamps, printOutput = true, tokensPerItem, language, }) => {
+const transcribe = async ({ inputPath, whisperPath, model, modelFolder, translateToEnglish = false, tokenLevelTimestamps, printOutput = true, tokensPerItem, language, signal, onProgress, }) => {
     if (!(0, node_fs_1.existsSync)(whisperPath)) {
         throw new Error(`Whisper does not exist at ${whisperPath}. Double-check the passed whisperPath. If you havent installed whisper, check out the installWhisperCpp() API at https://www.remotion.dev/docs/install-whisper-cpp/install-whisper-cpp to see how to install whisper programatically.`);
     }
@@ -119,7 +127,7 @@ const transcribe = async ({ inputPath, whisperPath, model, modelFolder, translat
         throw new Error('Invalid inputFile type. The provided file is not a wav file!');
     }
     const tmpJSONDir = node_path_1.default.join(process.cwd(), 'tmp');
-    const { outputPath: tmpJSONPath } = await transcribeToTempJSON({
+    const { outputPath: tmpJSONPath } = await transcribeToTemporaryFile({
         fileToTranscribe: inputPath,
         whisperPath,
         model,
@@ -129,7 +137,9 @@ const transcribe = async ({ inputPath, whisperPath, model, modelFolder, translat
         tokenLevelTimestamps,
         printOutput,
         tokensPerItem: tokenLevelTimestamps ? 1 : tokensPerItem !== null && tokensPerItem !== void 0 ? tokensPerItem : 1,
-        language,
+        language: language !== null && language !== void 0 ? language : null,
+        signal: signal !== null && signal !== void 0 ? signal : null,
+        onProgress: onProgress !== null && onProgress !== void 0 ? onProgress : null,
     });
     const json = (await readJson(tmpJSONPath));
     node_fs_1.default.unlinkSync(tmpJSONPath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotion/install-whisper-cpp",
-  "version": "4.0.155",
+  "version": "4.0.156",
   "description": "Install helper for Whisper.cpp",
   "main": "dist/index.js",
   "sideEffects": false,