@drakulavich/parakeet-cli 0.7.2 → 0.7.4

package/README.md

@@ -59,6 +59,25 @@ Parakeet (CoreML):      1.9s  ██
 
 Full results with transcripts: [BENCHMARK.md](BENCHMARK.md)
 
+## Supported Audio Formats
+
+Any format that ffmpeg can decode works with parakeet:
+
+| Format | Extension |
+|---|---|
+| WAV | `.wav` |
+| MP3 | `.mp3` |
+| OGG Vorbis | `.ogg` |
+| FLAC | `.flac` |
+| AAC / M4A | `.aac`, `.m4a` |
+| Opus | `.opus` |
+| WMA | `.wma` |
+| WebM | `.webm` |
+| MP4 (audio track) | `.mp4` |
+| AIFF | `.aiff` |
+
+CoreML backend tries native decoding first, falls back to ffmpeg for unsupported formats. ONNX backend always converts via ffmpeg.
+
 ## Supported Languages
 
 :bulgaria: Bulgarian, :croatia: Croatian, :czech_republic: Czech, :denmark: Danish, :netherlands: Dutch, :gb: English, :estonia: Estonian, :finland: Finnish, :fr: French, :de: German, :greece: Greek, :hungary: Hungarian, :it: Italian, :latvia: Latvian, :lithuania: Lithuanian, :malta: Maltese, :poland: Polish, :portugal: Portuguese, :romania: Romanian, :ru: Russian, :slovakia: Slovak, :slovenia: Slovenian, :es: Spanish, :sweden: Swedish, :ukraine: Ukrainian

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drakulavich/parakeet-cli",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "description": "Fast local speech-to-text CLI. CoreML on Apple Silicon, ONNX on CPU. 25 languages.",
   "type": "module",
   "bin": {

package/src/__tests__/audio.test.ts

@@ -0,0 +1,36 @@
+import { describe, test, expect } from "bun:test";
+import { getFfmpegInstallHint, assertFfmpegExists, resetFfmpegCheck } from "../audio";
+
+describe("getFfmpegInstallHint", () => {
+  test("returns a non-empty string", () => {
+    const hint = getFfmpegInstallHint();
+    expect(hint).toBeTruthy();
+    expect(typeof hint).toBe("string");
+  });
+
+  test("contains install keyword", () => {
+    const hint = getFfmpegInstallHint();
+    expect(hint).toMatch(/install|ffmpeg\.org/i);
+  });
+});
+
+describe("assertFfmpegExists", () => {
+  test("includes install hint when ffmpeg is missing", () => {
+    // Save and override Bun.which to simulate missing ffmpeg
+    const originalWhich = Bun.which;
+    Bun.which = ((cmd: string) => {
+      if (cmd === "ffmpeg") return null;
+      return originalWhich(cmd);
+    }) as typeof Bun.which;
+
+    // Reset the cached check so assertFfmpegExists re-checks
+    resetFfmpegCheck();
+
+    try {
+      expect(() => assertFfmpegExists()).toThrow(/Install it:/);
+    } finally {
+      Bun.which = originalWhich;
+      resetFfmpegCheck();
+    }
+  });
+});

package/src/audio.ts

@@ -61,10 +61,40 @@ async function convertAudioWithFfmpeg(
   return tmpPath;
 }
 
-function assertFfmpegExists(): void {
+export function getFfmpegInstallHint(): string {
+  const platform = process.platform;
+
+  if (platform === "darwin") {
+    if (Bun.which("brew")) return "  brew install ffmpeg";
+    if (Bun.which("port")) return "  sudo port install ffmpeg";
+  }
+
+  if (platform === "linux") {
+    if (Bun.which("apt")) return "  sudo apt install ffmpeg";
+    if (Bun.which("dnf")) return "  sudo dnf install ffmpeg-free";
+    if (Bun.which("pacman")) return "  sudo pacman -S ffmpeg";
+  }
+
+  if (platform === "win32") {
+    if (Bun.which("choco")) return "  choco install ffmpeg";
+    if (Bun.which("scoop")) return "  scoop install ffmpeg";
+    if (Bun.which("winget")) return "  winget install ffmpeg";
+  }
+
+  return "  https://ffmpeg.org/download.html";
+}
+
+export function assertFfmpegExists(): void {
   if (ffmpegChecked) return;
   if (!Bun.which("ffmpeg")) {
-    throw new Error("ffmpeg not found in PATH");
+    const hint = getFfmpegInstallHint();
+    throw new Error(
+      `ffmpeg is required but not found in PATH.\n\nInstall it:\n${hint}`
+    );
   }
   ffmpegChecked = true;
 }
+
+export function resetFfmpegCheck(): void {
+  ffmpegChecked = false;
+}