@remotion/whisper-web 4.0.302

package/.turbo/turbo-make.log

@@ -0,0 +1,6 @@
+
+
+> @remotion/whisper-web@4.0.302 make /Users/jonathanburger/remotion/packages/whisper-web
+> tsc -d && bun --env-file=../.env.bundle bundle.ts
+
+[8.64ms] Generated.

package/LICENSE.md

@@ -0,0 +1,49 @@
+# Remotion License
+
+In Remotion 5.0, the license will slightly change. [View the changes here](https://github.com/remotion-dev/remotion/pull/3750).
+
+---
+
+Depending on the type of your legal entity, you are granted permission to use Remotion for your project. Individuals and small companies are allowed to use Remotion to create videos for free (even commercial), while a company license is required for for-profit organizations of a certain size. This two-tier system was designed to ensure funding for this project while still allowing the source code to be available and the program to be free for most. Read below for the exact terms of use.
+
+- [Free license](#free-license)
+- [Company license](#company-license)
+
+## Free license
+
+Copyright © 2025 [Remotion](https://www.remotion.dev)
+
+### Eligibility
+
+You are eligible to use Remotion for free if you are:
+
+- an individual
+- a for-profit organization with up to 3 employees
+- a non-profit or not-for-profit organization
+- evaluating whether Remotion is a good fit, and are not yet using it in a commercial way
+
+### Allowed use cases
+
+Permission is hereby granted, free of charge, to any person eligible for the "Free license", to use the software non-commercially or commercially for the purpose of creating videos and images and to modify the software to their own liking, for the purpose of fulfilling their custom use case or to contribute bug fixes or improvements back to Remotion.
+
+### Disallowed use cases
+
+It is not allowed to copy or modify Remotion code for the purpose of selling, renting, licensing, relicensing, or sublicensing your own derivate of Remotion.
+
+### Warranty notice
+
+The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the author or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.
+
+### Support
+
+Support is provided on a best-we-can-do basis via GitHub Issues and Discord.
+
+## Company license
+
+You are required to obtain a company license to use Remotion if you are not within the group of entities eligible for a free license. This license will enable you to use Remotion for the allowed use cases specified in the free license, and give you access to prioritized support (read the [Support Policy](https://www.remotion.dev/docs/support)).
+
+Visit [remotion.pro](https://www.remotion.pro/license) for pricing and to buy a license.
+
+### FAQs
+
+Are you not sure whether you need a company license because of an edge case? Here are some [frequently asked questions](https://www.remotion.pro/faq).

package/README.md

@@ -0,0 +1,18 @@
+# @remotion/whisper-web
+ 
+Helpers for using Whisper.cpp in browser using WASM
+ 
+[![NPM Downloads](https://img.shields.io/npm/dm/@remotion/whisper-web.svg?style=flat&color=black&label=Downloads)](https://npmcharts.com/compare/@remotion/whisper-web?minimal=true)
+ 
+## Installation
+ 
+```bash
+npm install @remotion/whisper-web --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/whisper-web) for more information.

package/build-wasm.ts

@@ -0,0 +1,117 @@
+import {$} from 'bun';
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+
+const randomDir = os.tmpdir();
+
+const wasmDir = path.join(randomDir, 'whisper-web');
+
+if (fs.existsSync(wasmDir)) {
+	fs.rmSync(wasmDir, {recursive: true});
+}
+
+fs.mkdirSync(wasmDir, {recursive: true});
+
+const cwd = path.join(wasmDir, 'build-em');
+
+await $`git clone https://github.com/ggerganov/whisper.cpp ${wasmDir}`;
+await $`git checkout v1.7.4`.cwd(wasmDir);
+
+fs.mkdirSync(cwd);
+
+const cmakeListsFile = path.join(
+	wasmDir,
+	'examples',
+	'whisper.wasm',
+	'CMakeLists.txt',
+);
+
+const file = fs.readFileSync(cmakeListsFile, 'utf8');
+
+// Disable Node.JS target, compile with assertions to get stack trace
+const lines = file.split('\n').map((line) => {
+	if (line.includes('-s FORCE_FILESYSTEM=1 \\')) {
+		return `-s FORCE_FILESYSTEM=1 -s ENVIRONMENT='web,worker' -s ASSERTIONS=1 \\`;
+	}
+
+	return line;
+});
+
+fs.writeFileSync(
+	cmakeListsFile,
+	[
+		...lines,
+		// Generate a .d.ts file
+		`set(CMAKE_CXX_FLAGS "$\{CMAKE_CXX_FLAGS\} -lembind --emit-tsd $\{CMAKE_CURRENT_BINARY_DIR\}/interface.d.ts")`,
+	].join('\n'),
+);
+
+const emscriptenFilePath = path.join(
+	wasmDir,
+	'examples',
+	'whisper.wasm',
+	'emscripten.cpp',
+);
+//now get our version
+const modifiedVersion = fs.readFileSync('./emscripten.cpp', 'utf8');
+fs.writeFileSync(emscriptenFilePath, modifiedVersion);
+
+// brew install emscripten if necessary
+await $`emcmake cmake ..`.cwd(cwd);
+await $`make -j`.cwd(cwd);
+
+const mainJsFile = path.join(cwd, 'bin', 'whisper.wasm', 'main.js');
+
+let content = fs.readFileSync(mainJsFile, 'utf8');
+
+// pass our handlers
+content = content.replace(
+	'var moduleOverrides=Object.assign({},Module);',
+	'var moduleOverrides=Object.assign({},Module);if (typeof window !== "undefined") {Object.assign(Module, window.remotion_wasm_moduleOverrides);};',
+);
+
+// assert changes have been made
+if (!content.includes('window.remotion_wasm_moduleOverrides')) {
+	throw new Error('Changes have not been made');
+}
+
+// Modify the Worker path
+const mainContent =
+	content.replace(
+		'new Worker(pthreadMainJs',
+		`new Worker(new URL('./worker.js', import.meta.url)`,
+	) +
+	'\n' +
+	'export default Module;' +
+	'\n';
+
+// assert changes have been made
+if (!mainContent.includes('new Worker(new URL(')) {
+	throw new Error('Changes have not been made');
+}
+
+const workerContent =
+	content.replace(
+		'worker=new Worker(pthreadMainJs)',
+		`throw new Error('Already is in worker')`,
+	) +
+	'\n' +
+	'export default Module;' +
+	'\n';
+
+// Write the modified content directly to the destination
+fs.writeFileSync(path.join(__dirname, 'main.js'), mainContent, 'utf8');
+fs.writeFileSync(path.join(__dirname, 'worker.js'), workerContent, 'utf8');
+
+const dTsFile = path.join(
+	wasmDir,
+	'build-em',
+	'examples',
+	'whisper.wasm',
+	'interface.d.ts',
+);
+
+fs.copyFileSync(dTsFile, path.join(__dirname, 'main.d.ts'));
+
+fs.rmSync(wasmDir, {recursive: true});

package/bundle.ts

@@ -0,0 +1,15 @@
+import {buildPackage} from '../.monorepo/builder';
+
+await buildPackage({
+	formats: {
+		cjs: 'use-tsc',
+		esm: 'build',
+	},
+	external: ['./main.js', './worker.js'],
+	entrypoints: [
+		{
+			path: 'src/index.module.ts',
+			target: 'browser',
+		},
+	],
+});

package/dist/can-use-whisper-web.d.ts

@@ -0,0 +1,18 @@
+import type { WhisperWebModel } from './constants';
+export declare enum WhisperWebUnsupportedReason {
+    WindowUndefined = "window-undefined",
+    IndexedDbUnavailable = "indexed-db-unavailable",
+    NavigatorStorageUnavailable = "navigator-storage-unavailable",
+    StorageEstimationApiUnavailable = "storage-estimation-api-unavailable",
+    QuotaUndefined = "quota-undefined",
+    UsageUndefined = "usage-undefined",
+    NotEnoughSpace = "not-enough-space",
+    ErrorEstimatingStorage = "error-estimating-storage",
+    NotCrossOriginIsolated = "not-cross-origin-isolated"
+}
+export interface CanUseWhisperWebResult {
+    supported: boolean;
+    reason?: WhisperWebUnsupportedReason;
+    detailedReason?: string;
+}
+export declare const canUseWhisperWeb: (model: WhisperWebModel) => Promise<CanUseWhisperWebResult>;

package/dist/can-use-whisper-web.js

@@ -0,0 +1,80 @@
+import { SIZES } from './constants';
+export var WhisperWebUnsupportedReason;
+(function (WhisperWebUnsupportedReason) {
+    WhisperWebUnsupportedReason["WindowUndefined"] = "window-undefined";
+    WhisperWebUnsupportedReason["IndexedDbUnavailable"] = "indexed-db-unavailable";
+    WhisperWebUnsupportedReason["NavigatorStorageUnavailable"] = "navigator-storage-unavailable";
+    WhisperWebUnsupportedReason["StorageEstimationApiUnavailable"] = "storage-estimation-api-unavailable";
+    WhisperWebUnsupportedReason["QuotaUndefined"] = "quota-undefined";
+    WhisperWebUnsupportedReason["UsageUndefined"] = "usage-undefined";
+    WhisperWebUnsupportedReason["NotEnoughSpace"] = "not-enough-space";
+    WhisperWebUnsupportedReason["ErrorEstimatingStorage"] = "error-estimating-storage";
+    WhisperWebUnsupportedReason["NotCrossOriginIsolated"] = "not-cross-origin-isolated";
+})(WhisperWebUnsupportedReason || (WhisperWebUnsupportedReason = {}));
+export const canUseWhisperWeb = async (model) => {
+    if (typeof window === 'undefined') {
+        return {
+            supported: false,
+            reason: WhisperWebUnsupportedReason.WindowUndefined,
+            detailedReason: '`window` is not defined. This module can only be used in a browser environment.',
+        };
+    }
+    if (!window.crossOriginIsolated) {
+        return {
+            supported: false,
+            reason: WhisperWebUnsupportedReason.NotCrossOriginIsolated,
+            detailedReason: 'The document is not cross-origin isolated (window.crossOriginIsolated = false). This prevents the usage of SharedArrayBuffer, which is required by `@remotion/whisper-web`. Make sure the document is served with the HTTP header `Cross-Origin-Opener-Policy: same-origin` and `Cross-Origin-Embedder-Policy: require-corp`: https://developer.mozilla.org/en-US/docs/Web/API/Window/crossOriginIsolated',
+        };
+    }
+    if (!window.indexedDB) {
+        return {
+            supported: false,
+            reason: WhisperWebUnsupportedReason.IndexedDbUnavailable,
+            detailedReason: 'IndexedDB is not available in this environment.',
+        };
+    }
+    if (!(navigator === null || navigator === void 0 ? void 0 : navigator.storage) || !(navigator === null || navigator === void 0 ? void 0 : navigator.storage.estimate)) {
+        return {
+            supported: false,
+            reason: WhisperWebUnsupportedReason.NavigatorStorageUnavailable,
+            detailedReason: '`navigator.storage.estimate()` API is not available in this environment.',
+        };
+    }
+    try {
+        const estimate = await navigator.storage.estimate();
+        if (estimate.quota === undefined) {
+            return {
+                supported: false,
+                reason: WhisperWebUnsupportedReason.QuotaUndefined,
+                detailedReason: 'navigator.storage.estimate() API returned undefined quota.',
+            };
+        }
+        if (estimate.usage === undefined) {
+            return {
+                supported: false,
+                reason: WhisperWebUnsupportedReason.UsageUndefined,
+                detailedReason: 'navigator.storage.estimate() API returned undefined usage.',
+            };
+        }
+        const remaining = estimate.quota - estimate.usage;
+        const modelSize = SIZES[model];
+        if (remaining < modelSize) {
+            return {
+                supported: false,
+                reason: WhisperWebUnsupportedReason.NotEnoughSpace,
+                detailedReason: `Not enough space to download the model. Required: ${modelSize} bytes, Available: ${remaining} bytes.`,
+            };
+        }
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        return {
+            supported: false,
+            reason: WhisperWebUnsupportedReason.ErrorEstimatingStorage,
+            detailedReason: `Error estimating storage: ${errorMessage}`,
+        };
+    }
+    return {
+        supported: true,
+    };
+};

package/dist/constants.d.ts

@@ -0,0 +1,10 @@
+export declare const DB_NAME = "whisper-web";
+export declare const DB_VERSION = 1;
+export declare const DB_OBJECT_STORE_NAME = "models";
+export declare const MODELS: readonly ["tiny", "tiny.en", "base", "base.en", "small", "small.en"];
+export type WhisperWebModel = (typeof MODELS)[number];
+export declare const LANGUAGES: readonly ["auto", "en", "zh", "de", "es", "ru", "ko", "fr", "ja", "pt", "tr", "pl", "ca", "nl", "ar", "sv", "it", "id", "hi", "fi", "vi", "he", "uk", "el", "ms", "cs", "ro", "da", "hu", "ta", "no", "th", "ur", "hr", "bg", "lt", "la", "mi", "ml", "cy", "sk", "te", "fa", "lv", "bn", "sr", "az", "sl", "kn", "et", "mk", "br", "eu", "is", "hy", "ne", "mn", "bs", "kk", "sq", "sw", "gl", "mr", "pa", "si", "km", "sn", "yo", "so", "af", "oc", "ka", "be", "tg", "sd", "gu", "am", "yi", "lo", "uz", "fo", "ht", "ps", "tk", "nn", "mt", "sa", "lb", "my", "bo", "tl", "mg", "as", "tt", "haw", "ln", "ha", "ba", "jw", "su", "yue", "english", "chinese", "german", "spanish", "russian", "korean", "french", "japanese", "portuguese", "turkish", "polish", "catalan", "dutch", "arabic", "swedish", "italian", "indonesian", "hindi", "finnish", "vietnamese", "hebrew", "ukrainian", "greek", "malay", "czech", "romanian", "danish", "hungarian", "tamil", "norwegian", "thai", "urdu", "croatian", "bulgarian", "lithuanian", "latin", "maori", "malayalam", "welsh", "slovak", "telugu", "persian", "latvian", "bengali", "serbian", "azerbaijani", "slovenian", "kannada", "estonian", "macedonian", "breton", "basque", "icelandic", "armenian", "nepali", "mongolian", "bosnian", "kazakh", "albanian", "swahili", "galician", "marathi", "punjabi", "sinhala", "khmer", "shona", "yoruba", "somali", "afrikaans", "occitan", "georgian", "belarusian", "tajik", "sindhi", "gujarati", "amharic", "yiddish", "lao", "uzbek", "faroese", "haitian creole", "pashto", "turkmen", "nynorsk", "maltese", "sanskrit", "luxembourgish", "myanmar", "tibetan", "tagalog", "malagasy", "assamese", "tatar", "hawaiian", "lingala", "hausa", "bashkir", "javanese", "sundanese", "cantonese"];
+export type WhisperWebLanguage = (typeof LANGUAGES)[number];
+export declare const SIZES: {
+    [key in WhisperWebModel]: number;
+};

package/dist/constants.js

@@ -0,0 +1,225 @@
+export const DB_NAME = 'whisper-web';
+export const DB_VERSION = 1;
+export const DB_OBJECT_STORE_NAME = 'models';
+export const MODELS = [
+    'tiny',
+    'tiny.en',
+    'base',
+    'base.en',
+    'small',
+    'small.en',
+];
+export const LANGUAGES = [
+    // whisper allows passing 'auto' to auto-detect the language
+    'auto',
+    // short codes
+    'en',
+    'zh',
+    'de',
+    'es',
+    'ru',
+    'ko',
+    'fr',
+    'ja',
+    'pt',
+    'tr',
+    'pl',
+    'ca',
+    'nl',
+    'ar',
+    'sv',
+    'it',
+    'id',
+    'hi',
+    'fi',
+    'vi',
+    'he',
+    'uk',
+    'el',
+    'ms',
+    'cs',
+    'ro',
+    'da',
+    'hu',
+    'ta',
+    'no',
+    'th',
+    'ur',
+    'hr',
+    'bg',
+    'lt',
+    'la',
+    'mi',
+    'ml',
+    'cy',
+    'sk',
+    'te',
+    'fa',
+    'lv',
+    'bn',
+    'sr',
+    'az',
+    'sl',
+    'kn',
+    'et',
+    'mk',
+    'br',
+    'eu',
+    'is',
+    'hy',
+    'ne',
+    'mn',
+    'bs',
+    'kk',
+    'sq',
+    'sw',
+    'gl',
+    'mr',
+    'pa',
+    'si',
+    'km',
+    'sn',
+    'yo',
+    'so',
+    'af',
+    'oc',
+    'ka',
+    'be',
+    'tg',
+    'sd',
+    'gu',
+    'am',
+    'yi',
+    'lo',
+    'uz',
+    'fo',
+    'ht',
+    'ps',
+    'tk',
+    'nn',
+    'mt',
+    'sa',
+    'lb',
+    'my',
+    'bo',
+    'tl',
+    'mg',
+    'as',
+    'tt',
+    'haw',
+    'ln',
+    'ha',
+    'ba',
+    'jw',
+    'su',
+    'yue',
+    // aliases
+    'english',
+    'chinese',
+    'german',
+    'spanish',
+    'russian',
+    'korean',
+    'french',
+    'japanese',
+    'portuguese',
+    'turkish',
+    'polish',
+    'catalan',
+    'dutch',
+    'arabic',
+    'swedish',
+    'italian',
+    'indonesian',
+    'hindi',
+    'finnish',
+    'vietnamese',
+    'hebrew',
+    'ukrainian',
+    'greek',
+    'malay',
+    'czech',
+    'romanian',
+    'danish',
+    'hungarian',
+    'tamil',
+    'norwegian',
+    'thai',
+    'urdu',
+    'croatian',
+    'bulgarian',
+    'lithuanian',
+    'latin',
+    'maori',
+    'malayalam',
+    'welsh',
+    'slovak',
+    'telugu',
+    'persian',
+    'latvian',
+    'bengali',
+    'serbian',
+    'azerbaijani',
+    'slovenian',
+    'kannada',
+    'estonian',
+    'macedonian',
+    'breton',
+    'basque',
+    'icelandic',
+    'armenian',
+    'nepali',
+    'mongolian',
+    'bosnian',
+    'kazakh',
+    'albanian',
+    'swahili',
+    'galician',
+    'marathi',
+    'punjabi',
+    'sinhala',
+    'khmer',
+    'shona',
+    'yoruba',
+    'somali',
+    'afrikaans',
+    'occitan',
+    'georgian',
+    'belarusian',
+    'tajik',
+    'sindhi',
+    'gujarati',
+    'amharic',
+    'yiddish',
+    'lao',
+    'uzbek',
+    'faroese',
+    'haitian creole',
+    'pashto',
+    'turkmen',
+    'nynorsk',
+    'maltese',
+    'sanskrit',
+    'luxembourgish',
+    'myanmar',
+    'tibetan',
+    'tagalog',
+    'malagasy',
+    'assamese',
+    'tatar',
+    'hawaiian',
+    'lingala',
+    'hausa',
+    'bashkir',
+    'javanese',
+    'sundanese',
+    'cantonese',
+];
+export const SIZES = {
+    tiny: 77691713,
+    'tiny.en': 77704715,
+    base: 147951465,
+    'base.en': 147964211,
+    small: 487601967,
+    'small.en': 487614201,
+};

package/dist/db/delete-object.d.ts

@@ -0,0 +1,3 @@
+export declare const deleteObject: ({ key }: {
+    key: string;
+}) => Promise<void>;

package/dist/db/delete-object.js

@@ -0,0 +1,13 @@
+import { openDb } from './open-db';
+export const deleteObject = async ({ key }) => {
+    const objectStore = await openDb('readwrite');
+    return new Promise((resolve, reject) => {
+        const request = objectStore.delete(key);
+        request.onsuccess = () => {
+            resolve();
+        };
+        request.onerror = () => {
+            reject(request.error);
+        };
+    });
+};

package/dist/db/get-object-from-db.d.ts

@@ -0,0 +1,10 @@
+export declare const getObjectFromObjectStore: ({ objectStore, key, }: {
+    objectStore: IDBObjectStore;
+    key: string;
+}) => Promise<Uint8Array<ArrayBufferLike>>;
+export declare const getKeysFromObjectStore: ({ objectStore, }: {
+    objectStore: IDBObjectStore;
+}) => Promise<IDBValidKey[]>;
+export declare const getObject: ({ key }: {
+    key: string;
+}) => Promise<Uint8Array<ArrayBufferLike>>;

package/dist/db/get-object-from-db.js

@@ -0,0 +1,27 @@
+import { openDb } from './open-db';
+export const getObjectFromObjectStore = ({ objectStore, key, }) => {
+    return new Promise((resolve, reject) => {
+        const request = objectStore.get(key);
+        request.onsuccess = () => {
+            resolve(request.result);
+        };
+        request.onerror = () => {
+            reject(request.error);
+        };
+    });
+};
+export const getKeysFromObjectStore = ({ objectStore, }) => {
+    return new Promise((resolve, reject) => {
+        const request = objectStore.getAllKeys();
+        request.onsuccess = () => {
+            resolve(request.result);
+        };
+        request.onerror = () => {
+            reject(request.error);
+        };
+    });
+};
+export const getObject = async ({ key }) => {
+    const objectStore = await openDb('readonly');
+    return getObjectFromObjectStore({ objectStore, key });
+};

package/dist/db/open-db.d.ts

@@ -0,0 +1 @@
+export declare const openDb: (transactionMode: IDBTransactionMode) => Promise<IDBObjectStore>;

package/dist/db/open-db.js

@@ -0,0 +1,53 @@
+import { DB_NAME, DB_OBJECT_STORE_NAME, DB_VERSION } from '../constants';
+export const openDb = (transactionMode) => {
+    return new Promise((resolve, reject) => {
+        const rq = indexedDB.open(DB_NAME, DB_VERSION);
+        rq.onupgradeneeded = (event) => {
+            try {
+                const db = rq.result;
+                if (event.oldVersion < DB_VERSION) {
+                    db.createObjectStore(DB_OBJECT_STORE_NAME, { autoIncrement: false });
+                }
+                else {
+                    const { transaction } = event.currentTarget;
+                    if (!transaction) {
+                        throw new Error('No transaction available during upgrade');
+                    }
+                    const objectStore = transaction.objectStore(DB_OBJECT_STORE_NAME);
+                    if (!objectStore) {
+                        throw new Error('Could not access object store during upgrade');
+                    }
+                    objectStore.clear();
+                }
+            }
+            catch (err) {
+                reject(new Error(`Failed to upgrade database: ${err}`));
+            }
+        };
+        rq.onsuccess = () => {
+            try {
+                const db = rq.result;
+                const transaction = db.transaction([DB_OBJECT_STORE_NAME], transactionMode);
+                transaction.onerror = () => {
+                    reject(new Error('Transaction failed'));
+                };
+                transaction.onabort = () => {
+                    reject(new Error('Transaction aborted'));
+                };
+                const objectStore = transaction.objectStore(DB_OBJECT_STORE_NAME);
+                resolve(objectStore);
+            }
+            catch (err) {
+                reject(new Error(`Failed to open database: ${err}`));
+            }
+        };
+        rq.onerror = () => {
+            var _a, _b;
+            const error = (_b = (_a = rq.error) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : 'Unknown error';
+            reject(new Error(`Failed to open IndexedDB: ${error}`));
+        };
+        rq.onblocked = () => {
+            reject(new Error('Database is blocked by another connection'));
+        };
+    });
+};

package/dist/db/put-object.d.ts

@@ -0,0 +1,4 @@
+export declare const putObject: ({ key, value, }: {
+    key: string;
+    value: Uint8Array;
+}) => Promise<void>;