@junwan666/remotion-install-whisper-cpp 4.0.448-zh.0

package/README.md

@@ -0,0 +1,18 @@
+# @remotion/install-whisper-cpp
+
+Helpers for installing and using Whisper.cpp
+
+[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/install-whisper-cpp.svg?style=flat&color=black&label=Downloads)](https://npmcharts.com/compare/@remotion/install-whisper-cpp?minimal=true)
+
+## Installation
+
+```bash
+npm install @remotion/install-whisper-cpp --save-exact
+```
+
+When installing a Remotion package, make sure to align the version of all `remotion` and `@remotion/*` packages to the same version.
+Remove the `^` character from the version number to use the exact version.
+
+## Usage
+
+See the [documentation](https://www.remotion.dev/docs/install-whisper-cpp) for more information.

package/dist/convert-to-captions.d.ts

@@ -0,0 +1,11 @@
+import type { TranscriptionJson } from './transcribe';
+export type ConvertToCaptionCaption = {
+    text: string;
+    startInSeconds: number;
+};
+export declare function convertToCaptions({ transcription, combineTokensWithinMilliseconds }: {
+    transcription: TranscriptionJson<true>['transcription'];
+    combineTokensWithinMilliseconds: number;
+}): {
+    captions: ConvertToCaptionCaption[];
+};

package/dist/convert-to-captions.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToCaptions = convertToCaptions;
+/*
+ * @description Converts the JSON transcription data into captions with start times based on the defined millisecond threshold.
+ * @see [Documentation](https://remotion.dev/docs/install-whisper-cpp/convert-to-captions)
+ */
+function convertToCaptions({ transcription, combineTokensWithinMilliseconds, }) {
+    const merged = [];
+    let currentText = '';
+    let currentFrom = 0;
+    let currentTo = 0;
+    let currentTokenLevelTimestamp = 0;
+    transcription.forEach((item, index) => {
+        const { text } = item;
+        // If text starts with a space, push the currentText (if it exists) and start a new one
+        if (text.startsWith(' ') &&
+            currentTo - currentFrom > combineTokensWithinMilliseconds) {
+            if (currentText !== '') {
+                merged.push({
+                    text: currentText,
+                    startInSeconds: currentTokenLevelTimestamp / 100,
+                });
+            }
+            // Start a new sentence
+            currentText = text.trimStart();
+            currentFrom = item.offsets.from;
+            currentTo = item.offsets.to;
+            currentTokenLevelTimestamp = item.tokens[0].t_dtw;
+        }
+        else {
+            // Continuation or start of a new sentence without leading space
+            if (currentText === '') {
+                // It's the start of the document or after a sentence that started with a space
+                currentFrom = item.offsets.from;
+                currentTokenLevelTimestamp = item.tokens[0].t_dtw;
+            }
+            currentText += text;
+            currentText = currentText.trimStart();
+            currentTo = item.offsets.to;
+        }
+        // Ensure the last sentence is added
+        if (index === transcription.length - 1 && currentText !== '') {
+            merged.push({
+                text: currentText,
+                startInSeconds: currentTokenLevelTimestamp / 100,
+            });
+        }
+    });
+    return { captions: merged };
+}

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

@@ -0,0 +1,14 @@
+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", "large-v3-turbo"];
+export type WhisperModel = (typeof models)[number];
+export declare const getModelPath: (folder: string, model: "base" | "base.en" | "large-v1" | "large-v2" | "large-v3" | "large-v3-turbo" | "medium" | "medium.en" | "small" | "small.en" | "tiny" | "tiny.en") => string;
+export declare const downloadWhisperModel: ({ model, folder, printOutput, onProgress, signal, }: {
+    model: "base" | "base.en" | "large-v1" | "large-v2" | "large-v3" | "large-v3-turbo" | "medium" | "medium.en" | "small" | "small.en" | "tiny" | "tiny.en";
+    folder: string;
+    signal?: AbortSignal | undefined;
+    printOutput?: boolean | undefined;
+    onProgress?: OnProgress | undefined;
+}) => Promise<{
+    alreadyExisted: boolean;
+}>;
+export {};

package/dist/download-whisper-model.js

@@ -0,0 +1,108 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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 = exports.getModelPath = void 0;
+/* eslint-disable no-console */
+const fs_1 = __importStar(require("fs"));
+const path_1 = __importDefault(require("path"));
+const download_1 = require("./download");
+const models = [
+    'tiny',
+    'tiny.en',
+    'base',
+    'base.en',
+    'small',
+    'small.en',
+    'medium',
+    'medium.en',
+    'large-v1',
+    'large-v2',
+    'large-v3',
+    'large-v3-turbo',
+];
+const modelSizes = {
+    'medium.en': 1533774781,
+    'base.en': 147964211,
+    'large-v1': 3094623691,
+    'large-v2': 3094623691,
+    'large-v3': 3095033483,
+    'large-v3-turbo': 1624555275,
+    small: 487601967,
+    tiny: 77691713,
+    'small.en': 487614201,
+    'tiny.en': 77704715,
+    base: 147951465,
+    medium: 1533763059,
+};
+const getModelPath = (folder, model) => {
+    return path_1.default.join(path_1.default.resolve(process.cwd(), folder), `ggml-${model}.bin`);
+};
+exports.getModelPath = getModelPath;
+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) {
+            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: false });
+    }
+    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);
+    await (0, download_1.downloadFile)({
+        fileStream,
+        url: baseModelUrl,
+        printOutput,
+        onProgress,
+        signal: signal !== null && signal !== void 0 ? signal : null,
+    });
+    return { alreadyExisted: false };
+};
+exports.downloadWhisperModel = downloadWhisperModel;

package/dist/download.d.ts

@@ -0,0 +1,8 @@
+export type OnProgress = (downloadedBytes: number, totalBytes: number) => void;
+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

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadFile = void 0;
+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');
+    }
+    if (contentLength === null) {
+        throw new Error('Content-Length header not found');
+    }
+    let downloaded = 0;
+    let lastPrinted = 0;
+    const totalFileSize = parseInt(contentLength, 10);
+    const reader = body.getReader();
+    // eslint-disable-next-line no-async-promise-executor
+    await new Promise(async (resolve, reject) => {
+        try {
+            while (true) {
+                const { done, value } = await reader.read();
+                if (value) {
+                    downloaded += value.length;
+                    if (printOutput &&
+                        (downloaded - lastPrinted > 1024 * 1024 * 10 ||
+                            downloaded === totalFileSize)) {
+                        console.log(`Downloaded ${downloaded} of ${contentLength} bytes (${((downloaded / Number(contentLength)) *
+                            100).toFixed(2)}%)`);
+                        lastPrinted = downloaded;
+                    }
+                    fileStream.write(value, () => {
+                        onProgress === null || onProgress === void 0 ? void 0 : onProgress(downloaded, totalFileSize);
+                        if (downloaded === totalFileSize) {
+                            fileStream.end();
+                            resolve();
+                        }
+                    });
+                }
+                if (done) {
+                    break;
+                }
+            }
+        }
+        catch (e) {
+            reject(e);
+        }
+    });
+};
+exports.downloadFile = downloadFile;

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+export { ConvertToCaptionCaption } from './convert-to-captions';
+export type { OnProgress } from './download';
+export { downloadWhisperModel, WhisperModel } from './download-whisper-model';
+export { installWhisperCpp } from './install-whisper-cpp';
+export type { Language } from './languages';
+export { toCaptions } from './to-captions';
+export { transcribe, TranscribeOnProgress, TranscriptionJson, } from './transcribe';
+import { convertToCaptions as deprecatedConvertToCaptions } from './convert-to-captions';
+/**
+ *
+ * @deprecated convertToCaptions() has been deprecated as of Remotion v4.0.216.
+ * Use the toCaptions() function instead.
+ */
+export declare const convertToCaptions: typeof deprecatedConvertToCaptions;

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToCaptions = exports.transcribe = exports.toCaptions = exports.installWhisperCpp = exports.downloadWhisperModel = void 0;
+const download_whisper_model_1 = require("./download-whisper-model");
+Object.defineProperty(exports, "downloadWhisperModel", { enumerable: true, get: function () { return download_whisper_model_1.downloadWhisperModel; } });
+const install_whisper_cpp_1 = require("./install-whisper-cpp");
+Object.defineProperty(exports, "installWhisperCpp", { enumerable: true, get: function () { return install_whisper_cpp_1.installWhisperCpp; } });
+const to_captions_1 = require("./to-captions");
+Object.defineProperty(exports, "toCaptions", { enumerable: true, get: function () { return to_captions_1.toCaptions; } });
+const transcribe_1 = require("./transcribe");
+Object.defineProperty(exports, "transcribe", { enumerable: true, get: function () { return transcribe_1.transcribe; } });
+const convert_to_captions_1 = require("./convert-to-captions");
+/**
+ *
+ * @deprecated convertToCaptions() has been deprecated as of Remotion v4.0.216.
+ * Use the toCaptions() function instead.
+ */
+exports.convertToCaptions = convert_to_captions_1.convertToCaptions;

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

@@ -0,0 +1,9 @@
+export declare const getWhisperExecutablePath: (whisperPath: string, whisperCppVersion: string) => string;
+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

@@ -0,0 +1,168 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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.installWhisperCpp = exports.getWhisperExecutablePath = void 0;
+/* eslint-disable no-console */
+const child_process_1 = require("child_process");
+const fs_1 = __importStar(require("fs"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const download_1 = require("./download");
+const utils_1 = require("./utils");
+const getIsSemVer = (str) => {
+    return /^[\d]{1}\.[\d]{1,2}\.+/.test(str);
+};
+const execute = ({ printOutput, signal, cwd, shell, args, bin, }) => {
+    const stdio = printOutput ? 'inherit' : 'ignore';
+    return new Promise((resolve, reject) => {
+        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 ${bin} ${args.join(' ')}. 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.`);
+    }
+    const url = version === '1.5.5'
+        ? 'https://remotion-ffmpeg-binaries.s3.eu-central-1.amazonaws.com/whisper-bin-x64-1-5-5.zip'
+        : `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);
+    await (0, download_1.downloadFile)({
+        fileStream,
+        printOutput,
+        url,
+        onProgress: undefined,
+        signal,
+    });
+    await execute({
+        shell: 'powershell',
+        printOutput,
+        signal,
+        cwd: null,
+        bin: 'Expand-Archive',
+        args: ['-Force', filePath, to],
+    });
+    (0, fs_1.rmSync)(filePath);
+};
+const installWhisperForUnix = async ({ version, to, printOutput, signal, }) => {
+    await execute({
+        bin: 'git',
+        args: ['clone', 'https://github.com/ggerganov/whisper.cpp.git', to],
+        printOutput,
+        signal,
+        cwd: null,
+        shell: null,
+    });
+    const ref = getIsSemVer(version) ? `v${version}` : version;
+    await execute({
+        bin: 'git',
+        args: ['checkout', ref],
+        printOutput,
+        cwd: to,
+        signal,
+        shell: null,
+    });
+    await execute({
+        args: [],
+        bin: 'make',
+        cwd: to,
+        signal,
+        printOutput,
+        shell: null,
+    });
+};
+const getWhisperExecutablePath = (whisperPath, whisperCppVersion) => {
+    // INFO: 'main.exe' is deprecated.
+    let cppBin = ['main'];
+    let cppFolder = [];
+    if ((0, utils_1.compareVersions)(whisperCppVersion, '1.7.4') >= 0) {
+        cppBin = ['whisper-cli'];
+        cppFolder = ['build', 'bin'];
+    }
+    return os_1.default.platform() === 'win32'
+        ? path_1.default.join(path_1.default.resolve(process.cwd(), whisperPath), ...cppFolder, `${cppBin}.exe`)
+        : path_1.default.join(path_1.default.resolve(process.cwd(), whisperPath), ...cppFolder, `./${cppBin}`);
+};
+exports.getWhisperExecutablePath = getWhisperExecutablePath;
+const installWhisperCpp = async ({ version, to, printOutput = true, signal, }) => {
+    if ((0, fs_1.existsSync)(to)) {
+        if (!(0, fs_1.existsSync)((0, exports.getWhisperExecutablePath)(to, version))) {
+            if (printOutput) {
+                throw new Error(`Whisper folder ${to} exists but the executable (${(0, exports.getWhisperExecutablePath)(to, version)}) is missing. Delete ${to} and try again.`);
+            }
+            return Promise.resolve({ alreadyExisted: false });
+        }
+        if (printOutput) {
+            console.log(`Whisper already exists at ${to}`);
+        }
+        return Promise.resolve({ alreadyExisted: true });
+    }
+    if (process.platform === 'darwin' || process.platform === 'linux') {
+        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,
+            signal: signal !== null && signal !== void 0 ? signal : null,
+        });
+        return Promise.resolve({ alreadyExisted: false });
+    }
+    throw new Error(`Unsupported platform: ${process.platform}`);
+};
+exports.installWhisperCpp = installWhisperCpp;

package/dist/languages.d.ts

@@ -0,0 +1,5 @@
+/**
+ * List of supported languages of Whispher.
+ * https://github.com/ggerganov/whisper.cpp/blob/8f253ef3af1c62c04316ba4afa7145fc4d701a8c/whisper.cpp#L424
+ */
+export type Language = 'Afrikaans' | 'Albanian' | 'Amharic' | 'Arabic' | 'Armenian' | 'Assamese' | 'Azerbaijani' | 'Bashkir' | 'Basque' | 'Belarusian' | 'Bengali' | 'Bosnian' | 'Breton' | 'Bulgarian' | 'Burmese' | 'Castilian' | 'Catalan' | 'Chinese' | 'Croatian' | 'Czech' | 'Danish' | 'Dutch' | 'English' | 'Estonian' | 'Faroese' | 'Finnish' | 'Flemish' | 'French' | 'Galician' | 'Georgian' | 'German' | 'Greek' | 'Gujarati' | 'Haitian' | 'Haitian Creole' | 'Hausa' | 'Hawaiian' | 'Hebrew' | 'Hindi' | 'Hungarian' | 'Icelandic' | 'Indonesian' | 'Italian' | 'Japanese' | 'Javanese' | 'Kannada' | 'Kazakh' | 'Khmer' | 'Korean' | 'Lao' | 'Latin' | 'Latvian' | 'Letzeburgesch' | 'Lingala' | 'Lithuanian' | 'Luxembourgish' | 'Macedonian' | 'Malagasy' | 'Malay' | 'Malayalam' | 'Maltese' | 'Maori' | 'Marathi' | 'Moldavian' | 'Moldovan' | 'Mongolian' | 'Myanmar' | 'Nepali' | 'Norwegian' | 'Nynorsk' | 'Occitan' | 'Panjabi' | 'Pashto' | 'Persian' | 'Polish' | 'Portuguese' | 'Punjabi' | 'Pushto' | 'Romanian' | 'Russian' | 'Sanskrit' | 'Serbian' | 'Shona' | 'Sindhi' | 'Sinhala' | 'Sinhalese' | 'Slovak' | 'Slovenian' | 'Somali' | 'Spanish' | 'Sundanese' | 'Swahili' | 'Swedish' | 'Tagalog' | 'Tajik' | 'Tamil' | 'Tatar' | 'Telugu' | 'Thai' | 'Tibetan' | 'Turkish' | 'Turkmen' | 'Ukrainian' | 'Urdu' | 'Uzbek' | 'Valencian' | 'Vietnamese' | 'Welsh' | 'Yiddish' | 'Yoruba' | 'Zulu' | 'auto' | 'af' | 'am' | 'ar' | 'as' | 'az' | 'ba' | 'be' | 'bg' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'en' | 'es' | 'et' | 'eu' | 'fa' | 'fi' | 'fo' | 'fr' | 'gl' | 'gu' | 'ha' | 'haw' | 'he' | 'hi' | 'hr' | 'ht' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'jw' | 'ka' | 'kk' | 'km' | 'kn' | 'ko' | 'la' | 'lb' | 'ln' | 'lo' | 'lt' | 'lv' | 'mg' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'ne' | 'nl' | 'nn' | 'no' | 'oc' | 'pa' | 'pl' | 'ps' | 'pt' | 'ro' | 'ru' | 'sa' | 'sd' | 'si' | 'sk' | 'sl' | 'sn' | 'so' | 'sq' | 'sr' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'tk' | 'tl' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'vi' | 'yi' | 'yo' | 'zh';

package/dist/languages.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * List of supported languages of Whispher.
+ * https://github.com/ggerganov/whisper.cpp/blob/8f253ef3af1c62c04316ba4afa7145fc4d701a8c/whisper.cpp#L424
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/to-captions.d.ts

@@ -0,0 +1,10 @@
+import type { Caption } from '@remotion/captions';
+import type { TranscriptionJson } from './transcribe';
+type ToCaptionsInput = {
+    whisperCppOutput: TranscriptionJson<true>;
+};
+type ToCaptionsOutput = {
+    captions: Caption[];
+};
+export declare const toCaptions: (input: ToCaptionsInput) => ToCaptionsOutput;
+export {};

package/dist/to-captions.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCaptions = void 0;
+const toCaptions = (input) => {
+    const { transcription } = input.whisperCppOutput;
+    const captions = [];
+    for (const item of transcription) {
+        if (item.text === '') {
+            continue;
+        }
+        captions.push({
+            text: captions.length === 0 ? item.text.trimStart() : item.text,
+            startMs: item.offsets.from,
+            endMs: item.offsets.to,
+            timestampMs: item.tokens[0].t_dtw === -1 ? null : item.tokens[0].t_dtw * 10,
+            confidence: item.tokens[0].p,
+        });
+    }
+    return { captions };
+};
+exports.toCaptions = toCaptions;

package/dist/transcribe.d.ts

@@ -0,0 +1,80 @@
+import type { Language } from './languages';
+type Timestamps = {
+    from: string;
+    to: string;
+};
+type Offsets = {
+    from: number;
+    to: number;
+};
+type WordLevelToken = {
+    t_dtw: number;
+    text: string;
+    timestamps: Timestamps;
+    offsets: Offsets;
+    id: number;
+    p: number;
+};
+type TranscriptionItem = {
+    timestamps: Timestamps;
+    offsets: Offsets;
+    text: string;
+};
+type TranscriptionItemWithTimestamp = TranscriptionItem & {
+    tokens: WordLevelToken[];
+};
+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;
+};
+type AdditionalArgs = string[] | [string, string][];
+export type TranscriptionJson<WithTokenLevelTimestamp extends boolean> = {
+    systeminfo: string;
+    model: Model;
+    params: Params;
+    result: Result;
+    transcription: true extends WithTokenLevelTimestamp ? TranscriptionItemWithTimestamp[] : TranscriptionItem[];
+};
+export type TranscribeOnProgress = (progress: number) => void;
+export declare const modelToDtw: (model: "base" | "base.en" | "large-v1" | "large-v2" | "large-v3" | "large-v3-turbo" | "medium" | "medium.en" | "small" | "small.en" | "tiny" | "tiny.en") => string;
+export declare const transcribe: <HasTokenLevelTimestamps extends boolean>({ inputPath, whisperPath, whisperCppVersion, model, modelFolder, translateToEnglish, tokenLevelTimestamps, printOutput, tokensPerItem, language, splitOnWord, signal, onProgress, flashAttention, additionalArgs, }: {
+    inputPath: string;
+    whisperPath: string;
+    whisperCppVersion: string;
+    model: "base" | "base.en" | "large-v1" | "large-v2" | "large-v3" | "large-v3-turbo" | "medium" | "medium.en" | "small" | "small.en" | "tiny" | "tiny.en";
+    tokenLevelTimestamps: HasTokenLevelTimestamps;
+    modelFolder?: string | undefined;
+    translateToEnglish?: boolean | undefined;
+    printOutput?: boolean | undefined;
+    tokensPerItem?: (true extends HasTokenLevelTimestamps ? never : number | null) | undefined;
+    language?: Language | null | undefined;
+    splitOnWord?: boolean | undefined;
+    signal?: AbortSignal | undefined;
+    onProgress?: TranscribeOnProgress | undefined;
+    flashAttention?: boolean | undefined;
+    additionalArgs?: AdditionalArgs | undefined;
+}) => Promise<TranscriptionJson<HasTokenLevelTimestamps>>;
+export {};

package/dist/transcribe.js

@@ -0,0 +1,189 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __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 = exports.modelToDtw = void 0;
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = __importStar(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+const download_whisper_model_1 = require("./download-whisper-model");
+const install_whisper_cpp_1 = require("./install-whisper-cpp");
+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');
+    return JSON.parse(data);
+};
+// https://github.com/ggerganov/whisper.cpp/blob/fe36c909715e6751277ddb020e7892c7670b61d4/examples/main/main.cpp#L989-L999
+// https://github.com/remotion-dev/remotion/issues/4168
+const modelToDtw = (model) => {
+    if (model === 'large-v3-turbo') {
+        return 'large.v3.turbo';
+    }
+    if (model === 'large-v3') {
+        return 'large.v3';
+    }
+    if (model === 'large-v2') {
+        return 'large.v2';
+    }
+    if (model === 'large-v1') {
+        return 'large.v1';
+    }
+    return model;
+};
+exports.modelToDtw = modelToDtw;
+const transcribeToTemporaryFile = async ({ fileToTranscribe, whisperPath, whisperCppVersion, model, tmpJSONPath, modelFolder, translate, tokenLevelTimestamps, printOutput, tokensPerItem, language, splitOnWord, signal, onProgress, flashAttention, additionalArgs, }) => {
+    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`);
+    }
+    const executable = (0, install_whisper_cpp_1.getWhisperExecutablePath)(whisperPath, whisperCppVersion);
+    const args = [
+        '-f',
+        fileToTranscribe,
+        '--output-file',
+        tmpJSONPath,
+        '--output-json',
+        tokensPerItem ? ['--max-len', tokensPerItem] : null,
+        '-ojf', // Output full JSON
+        tokenLevelTimestamps ? ['--dtw', (0, exports.modelToDtw)(model)] : null,
+        model ? [`-m`, `${modelPath}`] : null,
+        ['-pp'], // print progress
+        translate ? '-tr' : null,
+        language ? ['-l', language.toLowerCase()] : null,
+        splitOnWord ? ['--split-on-word', splitOnWord] : null,
+        flashAttention ? ['--flash-attn', 'true'] : null,
+        ...(additionalArgs !== null && additionalArgs !== void 0 ? additionalArgs : []),
+    ]
+        .flat(1)
+        .filter(Boolean);
+    const outputPath = await new Promise((resolve, reject) => {
+        const task = (0, node_child_process_1.spawn)(executable, args, {
+            cwd: node_path_1.default.resolve(process.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')) {
+                task.kill();
+            }
+        };
+        let stderr = '';
+        const onStderr = (data) => {
+            onData(data);
+            const utf8 = data.toString('utf-8');
+            stderr += utf8;
+            if (printOutput) {
+                process.stderr.write(utf8);
+            }
+        };
+        const onStdout = (data) => {
+            onData(data);
+            if (printOutput) {
+                process.stdout.write(data.toString('utf-8'));
+            }
+        };
+        task.stdout.on('data', onStdout);
+        task.stderr.on('data', onStderr);
+        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 (exitSignal) {
+                reject(new Error(`Process was killed with signal ${exitSignal}: ${output}`));
+                return;
+            }
+            if (stderr.includes('must be 16 kHz')) {
+                reject(new Error('wav file must be 16 kHz - See https://www.remotion.dev/docs/webcodecs/resample-audio-16khz#on-the-server on how to convert your audio to a 16-bit, 16KHz, WAVE file'));
+            }
+            reject(new Error(`No transcription was created (process exited with code ${code}): ${output}`));
+        });
+    });
+    return { outputPath };
+};
+const transcribe = async ({ inputPath, whisperPath, whisperCppVersion, model, modelFolder, translateToEnglish = false, tokenLevelTimestamps, printOutput = true, tokensPerItem, language, splitOnWord, signal, onProgress, flashAttention, additionalArgs, }) => {
+    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! Convert the file to a 16KHz wav file first: "ffmpeg -i input.mp4 -ar 16000 output.wav -y"');
+    }
+    const tmpJSONDir = node_path_1.default.join(process.cwd(), 'tmp');
+    const { outputPath: tmpJSONPath } = await transcribeToTemporaryFile({
+        fileToTranscribe: inputPath,
+        whisperPath,
+        whisperCppVersion,
+        model,
+        tmpJSONPath: tmpJSONDir,
+        modelFolder: modelFolder !== null && modelFolder !== void 0 ? modelFolder : null,
+        translate: translateToEnglish,
+        tokenLevelTimestamps,
+        printOutput,
+        tokensPerItem: tokenLevelTimestamps ? 1 : (tokensPerItem !== null && tokensPerItem !== void 0 ? tokensPerItem : 1),
+        language: language !== null && language !== void 0 ? language : null,
+        signal: signal !== null && signal !== void 0 ? signal : null,
+        splitOnWord: splitOnWord !== null && splitOnWord !== void 0 ? splitOnWord : null,
+        onProgress: onProgress !== null && onProgress !== void 0 ? onProgress : null,
+        flashAttention,
+        additionalArgs,
+    });
+    const json = (await readJson(tmpJSONPath));
+    node_fs_1.default.unlinkSync(tmpJSONPath);
+    return json;
+};
+exports.transcribe = transcribe;

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Compares two version strings.
+ *
+ * @param version1 - The first version string.
+ * @param version2 - The second version string.
+ * @returns 1 if version1 > version2, -1 if version1 < version2, 0 if they are equal.
+ * @throws {Error} If either version is not a valid string or has an invalid format.
+ */
+export declare function compareVersions(version1: string, version2: string): number;

package/dist/utils.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareVersions = compareVersions;
+/**
+ * Compares two version strings.
+ *
+ * @param version1 - The first version string.
+ * @param version2 - The second version string.
+ * @returns 1 if version1 > version2, -1 if version1 < version2, 0 if they are equal.
+ * @throws {Error} If either version is not a valid string or has an invalid format.
+ */
+function compareVersions(version1, version2) {
+    const parseVersion = (version) => {
+        const parts = version.split('.').map((part) => Number(part));
+        if (parts.some(isNaN)) {
+            throw new Error('Invalid version format. Expected x.x.x');
+        }
+        return parts;
+    };
+    if (typeof version1 !== 'string' || typeof version2 !== 'string') {
+        throw new Error('Both inputs should be strings. Expected x.x.x');
+    }
+    const v1Parts = parseVersion(version1);
+    const v2Parts = parseVersion(version2);
+    // Ensure both versions have the same number of parts
+    const maxLength = Math.max(v1Parts.length, v2Parts.length);
+    while (v1Parts.length < maxLength)
+        v1Parts.push(0);
+    while (v2Parts.length < maxLength)
+        v2Parts.push(0);
+    for (let i = 0; i < maxLength; i++) {
+        if (v1Parts[i] > v2Parts[i])
+            return 1; // Version1 is greater
+        if (v1Parts[i] < v2Parts[i])
+            return -1; // Version2 is greater
+    }
+    return 0; // Versions are equal
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+	"repository": {
+		"url": "https://github.com/JunWan666/remotion-zh/tree/main/packages/install-whisper-cpp"
+	},
+	"name": "@junwan666/remotion-install-whisper-cpp",
+	"version": "4.0.448-zh.0",
+	"description": "Helpers for installing and using Whisper.cpp",
+	"main": "dist/index.js",
+	"sideEffects": false,
+	"bugs": {
+		"url": "https://github.com/remotion-dev/remotion/issues"
+	},
+	"scripts": {
+		"formatting": "oxfmt src --check",
+		"format": "oxfmt src",
+		"lint": "eslint src",
+		"test": "bun test src",
+		"make": "tsgo -d"
+	},
+	"author": "Jonny Burger <jonny@remotion.dev>",
+	"license": "SEE LICENSE IN LICENSE.md",
+	"dependencies": {
+		"@remotion/captions": "npm:@junwan666/remotion-captions@4.0.448-zh.0"
+	},
+	"peerDependencies": {},
+	"devDependencies": {
+		"@remotion/eslint-config-internal": "npm:@junwan666/remotion-eslint-config-internal@4.0.448-zh.0",
+		"eslint": "9.19.0",
+		"@typescript/native-preview": "7.0.0-dev.20260217.1"
+	},
+	"keywords": [
+		"remotion",
+		"openai",
+		"whisper"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"homepage": "https://www.remotion.dev/docs/install-whisper-cpp"
+}