@remotion/install-whisper-cpp 4.0.124 → 4.0.126

package/dist/download-model.d.ts

@@ -0,0 +1,11 @@
+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 downloadWhisperModel: ({ model, folder, printOutput, onProgress, }: {
+    model: WhisperModel;
+    folder: string;
+    printOutput?: boolean | undefined;
+    onProgress?: ((downloadedBytes: number, totalBytes: number) => void) | undefined;
+}) => Promise<{
+    alreadyExisted: boolean;
+}>;
+export {};

package/dist/download-model.js

@@ -0,0 +1,89 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadWhisperModel = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importStar(require("fs"));
+const promises_1 = require("node:stream/promises");
+const node_stream_1 = require("node:stream");
+const models = [
+    "tiny",
+    "tiny.en",
+    "base",
+    "base.en",
+    "small",
+    "small.en",
+    "medium",
+    "medium.en",
+    "large-v1",
+    "large-v2",
+    "large-v3",
+];
+const downloadWhisperModel = async ({ model, folder, printOutput = true, onProgress, }) => {
+    if (!models.includes(model)) {
+        throw new Error(`Invalid whisper model ${model}. Available: ${models.join(", ")}`);
+    }
+    const filePath = path_1.default.join(folder, `ggml-${model}.bin`);
+    if ((0, fs_1.existsSync)(filePath)) {
+        if (printOutput) {
+            console.log(`Model already exists at ${filePath}`);
+        }
+        return Promise.resolve({ alreadyExisted: true });
+    }
+    const baseModelUrl = `https://huggingface.co/ggerganov/whisper.cpp/resolve/main/ggml-${model}.bin`;
+    if (printOutput) {
+        console.log(`Downloading whisper model ${model} from ${baseModelUrl}`);
+    }
+    const fileStream = fs_1.default.createWriteStream(filePath);
+    const { body, headers } = await fetch(baseModelUrl);
+    const contentLength = headers.get("content-length");
+    if (body === null) {
+        throw new Error("Failed to download whisper model");
+    }
+    if (contentLength === null) {
+        throw new Error("Content-Length header not found");
+    }
+    let downloaded = 0;
+    let lastPrinted = 0;
+    const readable = node_stream_1.Readable.fromWeb(body);
+    readable.on("data", (chunk) => {
+        downloaded += chunk.length;
+        if (printOutput) {
+            if (downloaded - lastPrinted > 1024 * 1024 * 10) {
+                console.log(`Downloaded ${downloaded} of ${contentLength} bytes (${((downloaded / Number(contentLength)) *
+                    100).toFixed(2)}%)`);
+                lastPrinted = downloaded;
+            }
+        }
+        fileStream.write(chunk);
+        onProgress === null || onProgress === void 0 ? void 0 : onProgress(downloaded, parseInt(contentLength, 10));
+    });
+    await (0, promises_1.finished)(readable);
+    return { alreadyExisted: false };
+};
+exports.downloadWhisperModel = downloadWhisperModel;

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

@@ -1,6 +1,7 @@
 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 type OnProgress = (downloadedBytes: number, totalBytes: number) => void;
+export declare const getModelPath: (folder: string, model: WhisperModel) => string;
 export declare const downloadWhisperModel: ({ model, folder, printOutput, onProgress, }: {
     model: WhisperModel;
     folder: string;

package/dist/download-whisper-model.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadWhisperModel = void 0;
+exports.downloadWhisperModel = exports.getModelPath = void 0;
 const fs_1 = __importStar(require("fs"));
 const node_stream_1 = require("node:stream");
 const path_1 = __importDefault(require("path"));
@@ -43,11 +43,15 @@ const models = [
     'large-v2',
     'large-v3',
 ];
+const getModelPath = (folder, model) => {
+    return path_1.default.join(folder, `ggml-${model}.bin`);
+};
+exports.getModelPath = getModelPath;
 const downloadWhisperModel = async ({ model, folder, printOutput = true, onProgress, }) => {
     if (!models.includes(model)) {
         throw new Error(`Invalid whisper model ${model}. Available: ${models.join(', ')}`);
     }
-    const filePath = path_1.default.join(folder, `ggml-${model}.bin`);
+    const filePath = (0, exports.getModelPath)(folder, model);
     if ((0, fs_1.existsSync)(filePath)) {
         if (printOutput) {
             console.log(`Model already exists at ${filePath}`);

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { downloadWhisperModel, OnProgress, WhisperModel, } from './download-whisper-model';
 export { installWhisperCpp } from './install-whisper-cpp';
+export { transcribe } from './transcribe';

package/dist/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.installWhisperCpp = exports.downloadWhisperModel = void 0;
+exports.transcribe = exports.installWhisperCpp = exports.downloadWhisperModel = void 0;
 var download_whisper_model_1 = require("./download-whisper-model");
 Object.defineProperty(exports, "downloadWhisperModel", { enumerable: true, get: function () { return download_whisper_model_1.downloadWhisperModel; } });
 var install_whisper_cpp_1 = require("./install-whisper-cpp");
 Object.defineProperty(exports, "installWhisperCpp", { enumerable: true, get: function () { return install_whisper_cpp_1.installWhisperCpp; } });
+var transcribe_1 = require("./transcribe");
+Object.defineProperty(exports, "transcribe", { enumerable: true, get: function () { return transcribe_1.transcribe; } });

package/dist/install-whisper.d.ts

@@ -0,0 +1,7 @@
+export declare const installWhisper: ({ version, to, printOutput, }: {
+    version: string;
+    to: string;
+    printOutput?: boolean | undefined;
+}) => Promise<{
+    alreadyExisted: boolean;
+}>;

package/dist/install-whisper.js

@@ -0,0 +1,81 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.installWhisper = void 0;
+const fs_1 = __importStar(require("fs"));
+const node_child_process_1 = require("node:child_process");
+const node_stream_1 = require("node:stream");
+const promises_1 = require("node:stream/promises");
+const path_1 = __importDefault(require("path"));
+const installForWindows = async ({ version, to, printOutput, }) => {
+    const url = `https://github.com/ggerganov/whisper.cpp/releases/download/v${version}/whisper-bin-x64.zip`;
+    const filePath = path_1.default.join(process.cwd(), "whisper-bin-x64.zip");
+    const fileStream = fs_1.default.createWriteStream(filePath);
+    const { body } = await fetch(url);
+    if (body === null) {
+        throw new Error("Failed to download whisper binary");
+    }
+    await (0, promises_1.finished)(node_stream_1.Readable.fromWeb(body).pipe(fileStream));
+    (0, node_child_process_1.execSync)(`Expand-Archive -Force ${filePath} ${to}`, {
+        shell: "powershell",
+        stdio: printOutput ? "inherit" : "ignore",
+    });
+    (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,
+    });
+    (0, node_child_process_1.execSync)(`git checkout v${version}`, {
+        stdio,
+        cwd: to,
+    });
+    (0, node_child_process_1.execSync)(`make`, {
+        cwd: to,
+        stdio,
+    });
+};
+const installWhisper = async ({ version, to, printOutput = true, }) => {
+    if ((0, fs_1.existsSync)(to)) {
+        if (printOutput) {
+            console.log(`Whisper already exists at ${to}`);
+        }
+        return Promise.resolve({ alreadyExisted: true });
+    }
+    if (process.platform === "darwin" || process.platform === "linux") {
+        installWhisperForUnix({ version, to, printOutput });
+        return Promise.resolve({ alreadyExisted: false });
+    }
+    if (process.platform === "win32") {
+        await installForWindows({ version, to, printOutput });
+        return Promise.resolve({ alreadyExisted: false });
+    }
+    throw new Error(`Unsupported platform: ${process.platform}`);
+};
+exports.installWhisper = installWhisper;

package/dist/transcribe.d.ts

@@ -0,0 +1,56 @@
+import type { WhisperModel } from './download-whisper-model';
+type Timestamps = {
+    from: string;
+    to: string;
+};
+type Offsets = {
+    from: number;
+    to: number;
+};
+type TranscriptionItem = {
+    timestamps: Timestamps;
+    offsets: Offsets;
+    text: string;
+};
+type Model = {
+    type: string;
+    multilingual: boolean;
+    vocab: number;
+    audio: {
+        ctx: number;
+        state: number;
+        head: number;
+        layer: number;
+    };
+    text: {
+        ctx: number;
+        state: number;
+        head: number;
+        layer: number;
+    };
+    mels: number;
+    ftype: number;
+};
+type Params = {
+    model: string;
+    language: string;
+    translate: boolean;
+};
+type Result = {
+    language: string;
+};
+export type TranscriptionJson = {
+    systeminfo: string;
+    model: Model;
+    params: Params;
+    result: Result;
+    transcription: TranscriptionItem[];
+};
+export declare const transcribe: ({ inputPath, whisperPath, model, modelFolder, translateToEnglish, }: {
+    inputPath: string;
+    whisperPath: string;
+    model: WhisperModel;
+    modelFolder?: string | undefined;
+    translateToEnglish?: boolean | undefined;
+}) => Promise<TranscriptionJson>;
+export {};

package/dist/transcribe.js

@@ -0,0 +1,89 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transcribe = void 0;
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = __importStar(require("node:fs"));
+const node_os_1 = __importDefault(require("node:os"));
+const node_path_1 = __importDefault(require("node:path"));
+const node_util_1 = __importDefault(require("node:util"));
+const download_whisper_model_1 = require("./download-whisper-model");
+const isWavFile = (inputPath) => {
+    const splitted = inputPath.split('.');
+    if (!splitted) {
+        return false;
+    }
+    return splitted[splitted.length - 1] === 'wav';
+};
+const readJson = async (jsonPath) => {
+    const data = await node_fs_1.default.promises.readFile(jsonPath, 'utf8');
+    const jsonData = await JSON.parse(data);
+    return jsonData;
+};
+const transcribeToTempJSON = async ({ fileToTranscribe, whisperPath, model, tmpJSONPath, modelFolder, translate, }) => {
+    const promisifiedExec = node_util_1.default.promisify(node_child_process_1.exec);
+    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 downloadWhisperMode() API at https://www.remotion.dev/docs/install-whisper-cpp/download-whisper-model to see how to install whisper models`);
+    }
+    const executable = node_os_1.default.platform() === 'win32'
+        ? node_path_1.default.join(whisperPath, 'main.exe')
+        : node_path_1.default.join(whisperPath, './main');
+    const modelOption = model ? `-m ${modelPath}` : '';
+    const translateOption = translate ? `-tr ` : '';
+    await promisifiedExec(`${executable} -f ${fileToTranscribe} --output-file ${tmpJSONPath} --output-json --max-len 1 ${modelOption} ${translateOption}`, { cwd: whisperPath }).then(({ stderr }) => {
+        if (stderr.includes('error')) {
+            throw new Error('An error occured while transcribing: ' + stderr);
+        }
+    });
+};
+const transcribe = async ({ inputPath, whisperPath, model, modelFolder, translateToEnglish = false, }) => {
+    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.`);
+    }
+    if (!(0, node_fs_1.existsSync)(inputPath)) {
+        throw new Error(`Input file does not exist at ${inputPath}`);
+    }
+    if (!isWavFile(inputPath)) {
+        throw new Error('Invalid inputFile type. The provided file is not a wav file!');
+    }
+    const tmpJSONDir = node_path_1.default.join(process.cwd(), 'tmp');
+    await transcribeToTempJSON({
+        fileToTranscribe: inputPath,
+        whisperPath,
+        model,
+        tmpJSONPath: tmpJSONDir,
+        modelFolder: modelFolder !== null && modelFolder !== void 0 ? modelFolder : null,
+        translate: translateToEnglish,
+    });
+    const tmpJSONPath = `${tmpJSONDir}.json`;
+    const json = (await readJson(tmpJSONPath));
+    node_fs_1.default.unlinkSync(tmpJSONPath);
+    return json;
+};
+exports.transcribe = transcribe;

package/package.json

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