@remotion/install-whisper-cpp 4.0.115

package/LICENSE.md

@@ -0,0 +1,45 @@
+# Remotion License
+
+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 © 2024 [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/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

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

package/dist/download-whisper-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 fs_1 = __importStar(require("fs"));
+const node_stream_1 = require("node:stream");
+const promises_1 = require("node:stream/promises");
+const path_1 = __importDefault(require("path"));
+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/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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; } });

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

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

package/dist/install-whisper-cpp.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.installWhisperCpp = 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 installWhisperCpp = 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.installWhisperCpp = installWhisperCpp;

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/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@remotion/install-whisper-cpp",
+  "version": "4.0.115",
+  "description": "Install helper for Whisper.cpp",
+  "main": "dist/index.js",
+  "sideEffects": false,
+  "repository": {
+    "url": "https://github.com/remotion-dev/remotion"
+  },
+  "bugs": {
+    "url": "https://github.com/remotion-dev/remotion/issues"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Jonny Burger <jonny@remotion.dev>",
+  "license": "SEE LICENSE IN LICENSE.md",
+  "dependencies": {},
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
+  },
+  "devDependencies": {
+    "@jonny/eslint-config": "3.0.276",
+    "@types/node": "18.14.6",
+    "eslint": "8.42.0",
+    "eslint-plugin-10x": "1.5.2",
+    "eslint-plugin-react": "7.32.2",
+    "eslint-plugin-react-hooks": "4.4.0",
+    "prettier": "3.1.1",
+    "prettier-plugin-organize-imports": "3.2.4",
+    "vitest": "0.31.1"
+  },
+  "keywords": [
+    "remotion",
+    "openai",
+    "whisper"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "formatting": "prettier src --check",
+    "lint": "eslint src --ext ts,tsx",
+    "build": "tsc -d",
+    "watch": "tsc -w"
+  }
+}