@remotion/install-whisper-cpp/dist/transcribe.d.ts

Helpers for installing and using Whisper.cpp

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 {};