@remotion/whisper-web 4.0.364 → 4.0.366

package/src/constants.ts

@@ -1,232 +0,0 @@
-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',
-] as const;
-
-export type WhisperWebModel = (typeof MODELS)[number];
-
-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',
-] as const;
-
-export type WhisperWebLanguage = (typeof LANGUAGES)[number];
-
-export const SIZES: {[key in WhisperWebModel]: number} = {
-	tiny: 77691713,
-	'tiny.en': 77704715,
-	base: 147951465,
-	'base.en': 147964211,
-	small: 487601967,
-	'small.en': 487614201,
-};

package/src/db/delete-object.ts

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

package/src/db/get-object-from-db.ts

@@ -1,43 +0,0 @@
-import {openDb} from './open-db';
-
-export const getObjectFromObjectStore = ({
-	objectStore,
-	key,
-}: {
-	objectStore: IDBObjectStore;
-	key: string;
-}) => {
-	return new Promise<Uint8Array>((resolve, reject) => {
-		const request = objectStore.get(key);
-		request.onsuccess = () => {
-			resolve(request.result as Uint8Array);
-		};
-
-		request.onerror = () => {
-			reject(request.error);
-		};
-	});
-};
-
-export const getKeysFromObjectStore = ({
-	objectStore,
-}: {
-	objectStore: IDBObjectStore;
-}) => {
-	return new Promise<IDBValidKey[]>((resolve, reject) => {
-		const request = objectStore.getAllKeys();
-		request.onsuccess = () => {
-			resolve(request.result as IDBValidKey[]);
-		};
-
-		request.onerror = () => {
-			reject(request.error);
-		};
-	});
-};
-
-export const getObject = async ({key}: {key: string}) => {
-	const objectStore = await openDb('readonly');
-
-	return getObjectFromObjectStore({objectStore, key});
-};

package/src/db/open-db.ts

@@ -1,62 +0,0 @@
-import {DB_NAME, DB_OBJECT_STORE_NAME, DB_VERSION} from '../constants';
-
-export const openDb = (transactionMode: IDBTransactionMode) => {
-	return new Promise<IDBObjectStore>((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 as IDBOpenDBRequest;
-					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 = () => {
-			const error = rq.error?.message ?? 'Unknown error';
-			reject(new Error(`Failed to open IndexedDB: ${error}`));
-		};
-
-		rq.onblocked = () => {
-			reject(new Error('Database is blocked by another connection'));
-		};
-	});
-};

package/src/db/put-object.ts

@@ -1,27 +0,0 @@
-import {openDb} from './open-db';
-
-export const putObject = async ({
-	key,
-	value,
-}: {
-	key: string;
-	value: Uint8Array;
-}) => {
-	const objectStore = await openDb('readwrite');
-
-	return new Promise<void>((resolve, reject) => {
-		try {
-			const putRq = objectStore.put(value, key);
-
-			putRq.onsuccess = () => {
-				resolve();
-			};
-
-			putRq.onerror = () => {
-				reject(new Error(`Failed to store "${key}" in IndexedDB`));
-			};
-		} catch (e) {
-			reject(new Error(`Failed to store "${key}" in IndexedDB: ${e}`));
-		}
-	});
-};

package/src/delete-model.ts

@@ -1,8 +0,0 @@
-import type {WhisperWebModel} from './constants';
-import {deleteObject} from './db/delete-object';
-import {getModelUrl} from './get-model-url';
-
-export const deleteModel = async (model: WhisperWebModel) => {
-	const url = getModelUrl(model);
-	await deleteObject({key: url});
-};

package/src/download-model.ts

@@ -1,52 +0,0 @@
-export const fetchRemote = async ({
-	url,
-	onProgress,
-	expectedLength,
-}: {
-	url: string;
-	onProgress: (progress: number) => void;
-	expectedLength: number;
-}) => {
-	//  start the fetch
-	const response = await fetch(url, {method: 'get'});
-	if (!response.ok || !response.body) {
-		throw new Error(`failed to fetch: ${url}`);
-	}
-
-	const contentLength = response.headers.get('content-length') as string;
-	//  hugging face servers do include this header
-	const total = parseInt(contentLength, 10);
-	if (total !== expectedLength) {
-		throw new Error(
-			`Content-Length header is ${total} for ${url} but expected ${expectedLength}`,
-		);
-	}
-
-	const reader = response.body.getReader();
-
-	const chunks: Uint8Array[] = [];
-	let receivedLength = 0;
-
-	while (true) {
-		const {done, value} = await reader.read();
-
-		if (done) {
-			break;
-		}
-
-		chunks.push(value);
-		receivedLength += value.length;
-
-		onProgress(receivedLength);
-	}
-
-	let position = 0;
-	const chunksAll = new Uint8Array(receivedLength);
-
-	for (const chunk of chunks) {
-		chunksAll.set(chunk, position);
-		position += chunk.length;
-	}
-
-	return chunksAll;
-};

package/src/download-whisper-model.ts

@@ -1,86 +0,0 @@
-import {canUseWhisperWeb} from './can-use-whisper-web';
-import {MODELS, SIZES, type WhisperWebModel} from './constants';
-import {getObject} from './db/get-object-from-db';
-import {putObject} from './db/put-object';
-import {fetchRemote} from './download-model';
-import {getModelUrl} from './get-model-url';
-
-export type DownloadWhisperModelProgress = {
-	downloadedBytes: number;
-	totalBytes: number;
-	progress: number;
-};
-
-export type DownloadWhisperModelOnProgress = (
-	progress: DownloadWhisperModelProgress,
-) => void;
-
-export interface DownloadWhisperModelParams {
-	model: WhisperWebModel;
-	onProgress: DownloadWhisperModelOnProgress;
-}
-
-export type DownloadWhisperModelResult = {
-	alreadyDownloaded: boolean;
-};
-
-export const downloadWhisperModel = async ({
-	model,
-	onProgress,
-}: DownloadWhisperModelParams): Promise<DownloadWhisperModelResult> => {
-	if (!model || !MODELS.includes(model)) {
-		throw new Error(
-			`Invalid model name: ${model}. Supported models: ${MODELS.join(', ')}.`,
-		);
-	}
-
-	const usabilityCheck = await canUseWhisperWeb(model);
-
-	if (!usabilityCheck.supported) {
-		return Promise.reject(
-			new Error(
-				`Whisper.wasm is not supported in this environment. Reason: ${usabilityCheck.detailedReason}`,
-			),
-		);
-	}
-
-	const url = getModelUrl(model);
-	const modelSize = SIZES[model];
-
-	const existingModel = await getObject({key: url});
-	if (existingModel) {
-		onProgress({
-			downloadedBytes: modelSize,
-			totalBytes: modelSize,
-			progress: 1,
-		});
-
-		return {
-			alreadyDownloaded: true,
-		};
-	}
-
-	const data = await fetchRemote({
-		url,
-		onProgress: (bytes) => {
-			onProgress({
-				downloadedBytes: bytes,
-				progress: bytes / modelSize,
-				totalBytes: modelSize,
-			});
-		},
-		expectedLength: modelSize,
-	});
-
-	onProgress({
-		downloadedBytes: modelSize,
-		totalBytes: modelSize,
-		progress: 1,
-	});
-
-	await putObject({key: url, value: data});
-
-	return {
-		alreadyDownloaded: false,
-	};
-};

package/src/get-available-models.ts

@@ -1,17 +0,0 @@
-import {MODELS, SIZES, type WhisperWebModel} from './constants';
-
-export type AvailableModel = {
-	name: WhisperWebModel;
-	downloadSize: number;
-};
-
-/**
- * Returns an array of all available Whisper models with their download sizes.
- * @returns An array of objects containing model name and download size in bytes
- */
-export const getAvailableModels = (): AvailableModel[] => {
-	return MODELS.map((model) => ({
-		name: model,
-		downloadSize: SIZES[model],
-	}));
-};

package/src/get-loaded-models.ts

@@ -1,22 +0,0 @@
-import type {WhisperWebModel} from './constants';
-import {MODELS} from './constants';
-import {getKeysFromObjectStore} from './db/get-object-from-db';
-import {openDb} from './db/open-db';
-import {getModelUrl} from './get-model-url';
-
-export const getLoadedModels = async (): Promise<WhisperWebModel[]> => {
-	const objectStore = await openDb('readonly');
-	const loadedModels: WhisperWebModel[] = [];
-
-	const result = await getKeysFromObjectStore({
-		objectStore,
-	});
-
-	for (const model of MODELS) {
-		if (result.includes(getModelUrl(model))) {
-			loadedModels.push(model);
-		}
-	}
-
-	return loadedModels;
-};

package/src/get-model-url.ts

@@ -1,13 +0,0 @@
-import type {WhisperWebModel} from './constants';
-
-export const getModelUrl = (model: WhisperWebModel) => {
-	return `https://huggingface.co/ggerganov/whisper.cpp/resolve/main/ggml-${model}.bin`;
-};
-
-export const sizes = {
-	tiny: 74_000_000,
-	base: 244_000_000,
-	small: 769_000_000,
-	medium: 1550_000_000,
-	large: 3050_000_000,
-};

package/src/index.module.ts

@@ -1,12 +0,0 @@
-export {canUseWhisperWeb} from './can-use-whisper-web';
-export {deleteModel} from './delete-model';
-export {
-	DownloadWhisperModelParams,
-	DownloadWhisperModelResult,
-	downloadWhisperModel,
-} from './download-whisper-model';
-export {AvailableModel, getAvailableModels} from './get-available-models';
-export {getLoadedModels} from './get-loaded-models';
-export {resampleTo16Khz} from './resample-to-16khz';
-export {toCaptions} from './to-captions';
-export {TranscribeParams, transcribe} from './transcribe';

package/src/index.ts

@@ -1,93 +0,0 @@
-import type {
-	CanUseWhisperWebResult,
-	canUseWhisperWeb as originalCanUseWhisperWeb,
-	WhisperWebUnsupportedReason,
-} from './can-use-whisper-web';
-import type {WhisperWebLanguage, WhisperWebModel} from './constants';
-import type {deleteModel as originalDeleteModel} from './delete-model';
-import type {
-	DownloadWhisperModelOnProgress,
-	DownloadWhisperModelParams,
-	DownloadWhisperModelProgress,
-	DownloadWhisperModelResult,
-	downloadWhisperModel as originalDownloadWhisperModel,
-} from './download-whisper-model';
-import type {
-	AvailableModel,
-	getAvailableModels as originalGetAvailableModels,
-} from './get-available-models';
-import type {getLoadedModels as originalGetLoadedModels} from './get-loaded-models';
-import type {
-	resampleTo16Khz as originalResampleTo16Khz,
-	ResampleTo16KhzParams,
-} from './resample-to-16khz';
-import type {TranscriptionItemWithTimestamp, TranscriptionJson} from './result';
-import type {toCaptions as originalToCaptions} from './to-captions';
-import type {
-	transcribe as originalTranscribe,
-	TranscribeParams,
-} from './transcribe';
-
-export const transcribe: typeof originalTranscribe = () => {
-	throw new Error(
-		'Loading this module from CommonJS is not supported. Load the ESM version of @remotion/whisper-web.',
-	);
-};
-
-export const downloadWhisperModel: typeof originalDownloadWhisperModel = () => {
-	throw new Error(
-		'Loading this module from CommonJS is not supported. Load the ESM version of @remotion/whisper-web.',
-	);
-};
-
-export const getLoadedModels: typeof originalGetLoadedModels = () => {
-	throw new Error(
-		'Loading this module from CommonJS is not supported. Load the ESM version of @remotion/whisper-web.',
-	);
-};
-
-export const getAvailableModels: typeof originalGetAvailableModels = () => {
-	throw new Error(
-		'Loading this module from CommonJS is not supported. Load the ESM version of @remotion/whisper-web.',
-	);
-};
-
-export const deleteModel: typeof originalDeleteModel = () => {
-	throw new Error(
-		'Loading this module from CommonJS is not supported. Load the ESM version of @remotion/whisper-web.',
-	);
-};
-
-export const canUseWhisperWeb: typeof originalCanUseWhisperWeb = () => {
-	throw new Error(
-		'Loading this module from CommonJS is not supported. Load the ESM version of @remotion/whisper-web.',
-	);
-};
-
-export const resampleTo16Khz: typeof originalResampleTo16Khz = () => {
-	throw new Error(
-		'Loading this module from CommonJS is not supported. Load the ESM version of @remotion/whisper-web.',
-	);
-};
-
-export const toCaptions: typeof originalToCaptions = () => {
-	throw new Error(
-		'Loading this module from CommonJS is not supported. Load the ESM version of @remotion/whisper-web.',
-	);
-};
-
-export type {
-	AvailableModel,
-	CanUseWhisperWebResult,
-	DownloadWhisperModelOnProgress,
-	DownloadWhisperModelParams,
-	DownloadWhisperModelProgress,
-	DownloadWhisperModelResult,
-	ResampleTo16KhzParams,
-	TranscribeParams,
-	TranscriptionItemWithTimestamp,
-	TranscriptionJson,
-	WhisperWebLanguage,
-	WhisperWebModel,
-	WhisperWebUnsupportedReason,
-};