@larkup/tool-video-audio 0.2.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://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

package/README.md

@@ -0,0 +1,55 @@
+# Video & Audio
+
+> Index video and audio files with AI-powered transcription and frame analysis.
+
+## What It Does
+
+This tool processes video and audio files for your knowledge base:
+
+- **Video**: Combines multilingual transcription, adaptive visual sampling, OCR, and timestamped evidence
+- **Audio**: Transcribes speech to text with timestamped segments
+- **YouTube**: Import videos directly from YouTube URLs
+
+## Requirements
+
+- **ffmpeg** must be installed on your system
+  - macOS: `brew install ffmpeg`
+  - Ubuntu/Debian: `sudo apt install ffmpeg`
+  - Windows: Download from [ffmpeg.org](https://ffmpeg.org/download.html)
+- **yt-dlp is only required for YouTube URLs** (local files and direct URLs do not require it)
+
+## How It Works
+
+### Video Pipeline
+
+1. **Extract audio** → WAV (16kHz mono) via ffmpeg
+2. **Transcribe audio** → Timestamped text via the selected audio provider
+3. **Extract frames** → Duration-aware anchors, scene changes, and a frame-budget-reserved dense ending pass
+4. **Analyze sequences** → A vision LLM connects actions, OCR, state changes, and results
+5. **Index** → A whole-media summary and independent timestamped evidence become searchable
+
+### Audio Pipeline
+
+1. **Transcribe** → Speech-to-text via OpenAI, Groq, Deepgram, ElevenLabs, or local Whisper; large API inputs are split into ≤10-minute uploads
+2. **Chunk** → Split into 30-second segments with timestamps
+3. **Index** → A complete-recording summary plus timestamped evidence becomes searchable
+
+## Transcription Options
+
+| Method                 | Pros                       | Cons                                               |
+| ---------------------- | -------------------------- | -------------------------------------------------- |
+| **Audio Provider API** | Fast, accurate, easy setup | Requires that provider's API key, costs per minute |
+| **Local Whisper**      | Free, offline, private     | Slower, requires ~75MB model download              |
+
+The Audio Provider is required and independent from the chat/vision and embedding providers; the
+tool never silently falls back to OpenAI. With Deepgram, `auto` uses known source language, infers
+Arabic from an Arabic media title, and otherwise enables provider language detection; set an
+explicit code such as `ar`, `ar-EG`, `en`, or `de` when needed.
+
+## Configuration
+
+| Setting        | Default | Description                                                                      |
+| -------------- | ------- | -------------------------------------------------------------------------------- |
+| Frame interval | 10s     | Baseline cadence; adaptive scene and reserved ending frames are added separately |
+| Audio provider | None    | OpenAI, Groq, Deepgram, ElevenLabs, or Local Whisper                             |
+| Audio language | `auto`  | Infer Arabic from the title, detect supported languages, or use an explicit code |

package/dist/audio-processor.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Audio processing pipeline.
+ *
+ * Transcription strategies:
+ * 1. Explicitly selected Audio Provider API (OpenAI, Groq, Deepgram, or ElevenLabs)
+ * 2. Local Whisper.cpp — fully offline via nodejs-whisper (optional)
+ *
+ * The transcription is split into timestamped chunks for granular
+ * retrieval in the RAG pipeline.
+ */
+export interface TranscriptChunk {
+    text: string;
+    startSecs: number;
+    endSecs: number;
+}
+export interface TranscriptionOrigin {
+    kind: 'youtube-manual' | 'youtube-auto' | 'provider-stt' | 'local-stt';
+    provider?: string;
+    language?: string;
+}
+export interface TranscriptionResult {
+    /** Full transcript text */
+    fullText: string;
+    /** Timestamped chunks for granular indexing */
+    chunks: TranscriptChunk[];
+    /** Detected language */
+    language?: string;
+    /** Duration of the audio in seconds */
+    durationSecs: number;
+    /** How the transcript was produced, so callers can judge source authority. */
+    origin?: TranscriptionOrigin;
+}
+export interface TranscriptionOptions {
+    /** The provider name (e.g. 'openai', 'deepgram', 'local') */
+    provider?: string;
+    /** The API key to use */
+    apiKey?: string;
+    /** Chunk duration in seconds for splitting transcript (default: 30) */
+    chunkDurationSecs?: number;
+    /** Language hint (e.g., "en", "de") */
+    language?: string;
+    /** Short context such as the media title, used to preserve names and infer Arabic. */
+    context?: string;
+    /** Reports completed transcription work and its current unit. */
+    onProgress?: (current: number, total: number, message: string, unit?: string) => void | Promise<void>;
+}
+/**
+ * Infer only languages that cannot reliably use Deepgram's automatic language
+ * detection. Other text intentionally returns undefined so the provider can
+ * perform its own detection.
+ */
+export declare function inferLanguageHintFromText(text?: string): string | undefined;
+/**
+ * Build the Deepgram request URL without reading environment or provider state,
+ * making provider routing and language behavior straightforward to test.
+ */
+export declare function buildDeepgramTranscriptionUrl(options?: Pick<TranscriptionOptions, 'language' | 'context'>): string;
+/**
+ * Transcribe an audio file and return timestamped chunks.
+ */
+export declare function transcribeAudio(audioPath: string, options?: TranscriptionOptions): Promise<TranscriptionResult>;
+/**
+ * Full pipeline: transcribe + chunk for an audio file.
+ */
+export declare function processAudio(audioPath: string, options?: TranscriptionOptions): Promise<TranscriptionResult>;