@mcut/transcription-local 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,187 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+(50%) or more of the outstanding shares, or (iii) beneficial ownership of
+such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as a
+whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or
+merely link (or bind by name) to the interfaces of, the Work and Derivative
+Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the
+purposes of this definition, "submitted" means any form of electronic,
+verbal, or written communication sent to the Licensor or its representatives,
+including but not limited to communication on electronic mailing lists,
+source code control systems, and issue tracking systems that are managed by,
+or on behalf of, the Licensor for the purpose of discussing and improving the
+Work, but excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import,
+and otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily infringed
+by their Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You institute
+patent litigation against any entity (including a cross-claim or counterclaim
+in a lawsuit) alleging that the Work or a Contribution incorporated within
+the Work constitutes direct or contributory patent infringement, then any
+patent licenses granted to You under this License for that Work shall
+terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a
+copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from
+the Source form of the Work, excluding those notices that do not pertain to
+any part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy of
+the attribution notices contained within such NOTICE file, excluding those
+notices that do not pertain to any part of the Derivative Works, in at least
+one of the following places: within a NOTICE text file distributed as part of
+the Derivative Works; within the Source form or documentation, if provided
+along with the Derivative Works; or, within a display generated by the
+Derivative Works, if and wherever such third-party notices normally appear.
+The contents of the NOTICE file are for informational purposes only and do
+not modify the License. You may add Your own attribution notices within
+Derivative Works that You distribute, alongside or as an addendum to the
+NOTICE text from the Work, provided that such additional attribution notices
+cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, or for any such
+Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in
+this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein
+shall supersede or modify the terms of any separate license agreement you may
+have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the
+Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to
+in writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability
+to use the Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all other
+commercial damages or losses), even if such Contributor has been advised of
+the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work
+or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification
+within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,11 @@
+# @mcut/transcription-local
+
+On-device Whisper transcription provider for mcut.
+
+```sh
+bun add @mcut/transcription-local @mcut/transcription
+```
+
+This package runs local transcription through Transformers.js in a browser
+worker. It includes chunk planning, repetition guards, VAD helpers, and a
+self-contained worker bundle for WebGPU-capable browser environments.

package/dist/index.d.ts

@@ -0,0 +1,174 @@
+import { TranscriptResult, TranscriptSegment, TranscriptWord, TranscriptionProvider } from "@mcut/transcription";
+
+//#region src/protocol.d.ts
+/** Wire protocol between the provider façade and the Whisper worker. */
+/** Quantization levels the worker accepts (transformers.js DataType subset). */
+type WhisperDtype = 'auto' | 'fp32' | 'fp16' | 'q8' | 'int8' | 'uint8' | 'q4' | 'q4f16';
+interface WhisperWorkerConfig {
+  /** HF model id, e.g. "onnx-community/whisper-base". */
+  model: string;
+  device: 'webgpu' | 'wasm';
+  /** Quantization, e.g. "q8". */
+  dtype: WhisperDtype;
+}
+interface WhisperTranscribeRequest {
+  type: 'transcribe';
+  id: number;
+  config: WhisperWorkerConfig;
+  /** Mono PCM at 16kHz (transferred). */
+  audio: Float32Array;
+  language?: string;
+}
+type WhisperWorkerRequest = WhisperTranscribeRequest;
+type WhisperWorkerResponse = {
+  type: 'ready';
+} | {
+  type: 'progress';
+  id: number; /** 0–1 within the phase. */
+  progress: number; /** Model download/load vs. actual transcription. */
+  phase: 'model' | 'transcribe';
+} | {
+  type: 'result';
+  id: number;
+  result: TranscriptResult;
+} | {
+  type: 'error';
+  id: number;
+  message: string;
+};
+//#endregion
+//#region src/chunking.d.ts
+/**
+ * Chunked-streaming plan for long audio: fixed windows with overlap, merged
+ * back together on word timestamps. Whisper's native receptive field is 30s;
+ * processing window-by-window keeps the tab responsive (progress per chunk)
+ * and lets the worker skip non-speech windows and retry hallucinating ones
+ * without redoing the whole file.
+ */
+interface AudioChunk {
+  /** Window start in the source audio, seconds. */
+  startS: number;
+  /** Window end (exclusive), seconds. */
+  endS: number;
+}
+declare const CHUNK_WINDOW_S = 30;
+declare const CHUNK_OVERLAP_S = 5;
+/** Split a duration into overlapping windows (last window may be shorter). */
+declare function planChunks(durationS: number, windowS?: number, overlapS?: number): AudioChunk[];
+interface ChunkResult {
+  chunk: AudioChunk;
+  /** Words with ABSOLUTE timestamps (chunk offset already applied), ms. */
+  words: TranscriptWord[];
+}
+interface ChunkSegmentResult {
+  chunk: AudioChunk;
+  /** Segments with ABSOLUTE timestamps (chunk offset already applied), ms. */
+  segments: TranscriptSegment[];
+}
+/**
+ * Merge consecutive chunk transcripts on word timestamps rather than
+ * concatenating: inside each overlap the cut lands on the largest silence
+ * between the incoming chunk's words (falling back to the overlap midpoint),
+ * the outgoing chunk keeps words before the cut, the incoming one after.
+ * This absorbs the timestamp drift Whisper accumulates near window edges.
+ */
+declare function mergeChunkWords(results: ChunkResult[]): TranscriptWord[];
+/** Same overlap-cut strategy as {@link mergeChunkWords}, for segment-timed models. */
+declare function mergeChunkSegments(results: ChunkSegmentResult[]): TranscriptSegment[];
+//#endregion
+//#region src/repetition.d.ts
+/**
+ * Whisper's classic failure mode on silence/noise: the decoder locks into a
+ * loop and emits the same phrase over and over. Detect n-gram repetition so
+ * the worker can drop the chunk and retry with a temperature bump.
+ */
+interface RepetitionOptions {
+  /** Longest phrase length (in tokens) checked for looping. Default 4. */
+  maxNgram?: number;
+  /** Consecutive repeats that count as a loop. Default 4 (3 for bigrams+). */
+  minRepeats?: number;
+}
+/** True when the token stream ends up looping the same n-gram. */
+declare function hasRepetitionLoop(tokens: readonly string[], options?: RepetitionOptions): boolean;
+/** Convenience for plain text output. */
+declare function textHasRepetitionLoop(text: string, options?: RepetitionOptions): boolean;
+//#endregion
+//#region src/vad.d.ts
+/**
+ * Lightweight energy-based voice activity pre-pass: windows that are
+ * essentially silent never reach the model, which is where Whisper
+ * hallucinates text. Deliberately conservative — it only skips clear
+ * silence, anything ambiguous (music, low speech) still gets transcribed.
+ * The seam is shaped so a silero-vad WASM pass can replace it later.
+ */
+interface SpeechActivity {
+  /** Fraction of frames above the activity threshold (0–1). */
+  activeFraction: number;
+  /** Peak frame RMS. */
+  peakRms: number;
+}
+declare function measureActivity(samples: Float32Array, sampleRate: number): SpeechActivity;
+/** Whether a window plausibly contains any speech at all. */
+declare function hasSpeech(samples: Float32Array, sampleRate: number): boolean;
+//#endregion
+//#region src/wav.d.ts
+/**
+ * Minimal WAV reader → 16kHz mono Float32Array (Whisper's input format).
+ * The editor extracts clip audio as 16kHz WAV already (`extractAudioToWav`),
+ * so this covers the hot path without any AudioContext — it runs in workers
+ * and tests alike. Non-WAV input falls back to decodeAudioData upstream.
+ */
+declare const WHISPER_SAMPLE_RATE = 16000;
+interface DecodedAudio {
+  samples: Float32Array;
+  sampleRate: number;
+}
+/** Parse a PCM/float WAV file. Returns null when it isn't one. */
+declare function parseWav(buffer: ArrayBuffer): DecodedAudio | null;
+/** Linear-interpolation resample (fine for speech models). */
+declare function resampleTo(audio: DecodedAudio, targetRate: number): Float32Array;
+//#endregion
+//#region src/index.d.ts
+/**
+ * On-device Whisper provider (Transformers.js in a dedicated worker).
+ * Reliability over flash: capability-gated hard (WebGPU + enough memory),
+ * chunked with per-window progress, VAD + repetition guards in the worker.
+ * On-device is OFFERED, never forced — keep a server provider as the
+ * default and let users opt in (the model is a 40–150MB one-time download,
+ * cached by the browser after that).
+ */
+/** Built-in model choices (ONNX community builds of OpenAI Whisper). */
+declare const WHISPER_MODELS: {
+  /** Multilingual, ~145MB at q8 — the WebGPU default. */readonly base: "onnx-community/whisper-base"; /** English-only, ~40MB — the low-memory default. */
+  readonly 'tiny.en': "onnx-community/whisper-tiny.en";
+};
+/**
+ * Hard capability gate: WebGPU plus ≥4GB device memory. Browsers that don't
+ * report `deviceMemory` (Safari/Firefox) pass on WebGPU alone — the spec
+ * caps reported values at 8 anyway.
+ */
+declare function isLocalTranscriptionSupported(): boolean;
+/** whisper-base on roomy machines, whisper-tiny.en when memory is tight. */
+declare function pickDefaultModel(): string;
+interface LocalWhisperProgress {
+  /** 'model' while downloading/loading weights, then 'transcribe'. */
+  phase: 'model' | 'transcribe';
+  /** 0–1 within the phase. */
+  progress: number;
+}
+interface CreateLocalWhisperProviderOptions {
+  /** A {@link WHISPER_MODELS} key or any HF ASR model id. Default {@link pickDefaultModel}. */
+  model?: keyof typeof WHISPER_MODELS | (string & {});
+  /** Inference device. Default 'webgpu'. */
+  device?: 'webgpu' | 'wasm';
+  /** Quantization. Default 'q8'. */
+  dtype?: WhisperDtype;
+  /** Model download + transcription progress. */
+  onProgress?: (progress: LocalWhisperProgress) => void;
+  /** Override worker creation (custom bundling setups). */
+  createWorker?: () => Worker;
+  id?: string;
+}
+declare function createLocalWhisperProvider(options?: CreateLocalWhisperProviderOptions): TranscriptionProvider;
+//#endregion
+export { type AudioChunk, CHUNK_OVERLAP_S, CHUNK_WINDOW_S, type ChunkResult, type ChunkSegmentResult, CreateLocalWhisperProviderOptions, type DecodedAudio, LocalWhisperProgress, type RepetitionOptions, type SpeechActivity, WHISPER_MODELS, WHISPER_SAMPLE_RATE, type WhisperDtype, type WhisperWorkerConfig, type WhisperWorkerRequest, type WhisperWorkerResponse, createLocalWhisperProvider, hasRepetitionLoop, hasSpeech, isLocalTranscriptionSupported, measureActivity, mergeChunkSegments, mergeChunkWords, parseWav, pickDefaultModel, planChunks, resampleTo, textHasRepetitionLoop };