@fraziym/axoniz 0.1.0

package/dist/voice/tts.d.ts

@@ -0,0 +1,168 @@
+/**
+ * src/voice/tts.ts
+ * =================
+ * BERU Text-to-Speech — offline-first, best quality available.
+ *
+ * Python provider priority (preserved by `_detectBackend()`):
+ *   1. kokoro-onnx — 82M params, Apache 2.0
+ *   2. mms         — local VITS (transformers + torch)
+ *   2b. piper      — fastest CPU TTS (`piper` module or `piper` binary)
+ *   3. edge-tts    — free Microsoft cloud TTS (needs internet)
+ *   4. pyttsx3     — offline COM/espeak fallback
+ *   5. print       — last resort
+ *
+ * ── Node reality ─────────────────────────────────────────────────────────────
+ * `kokoro-onnx`, `piper`, `pyttsx3`, `sounddevice`, `soundfile` and `transformers`
+ * are Python-only and not installable here. `edge-tts`'s Node equivalent
+ * **`msedge-tts` IS installed** (MIT, Microsoft Edge Read Aloud API) and is the
+ * primary working path. The offline `pyttsx3` slot is preserved but implemented
+ * as a clearly-marked unimplemented backend that returns a descriptive error.
+ *
+ * WAV output is written by hand (44-byte RIFF/PCM header, `node:fs`) — see
+ * `src/voice/wav.ts`. No `soundfile` package is used anywhere.
+ *
+ * Model files (kokoro, searched cwd → ~/.axoniz/voice_models → ~/Downloads):
+ *   kokoro-v1.0.int8.onnx   (88MB  — recommended, CPU-optimized)
+ *   kokoro-v1.0.onnx        (310MB — full quality)
+ *   voices-v1.0.bin         (voice embeddings, always required)
+ */
+export declare const KOKORO_VOICE: string;
+export declare const KOKORO_SPEED: number;
+export declare const PIPER_VOICE: string;
+export declare const EDGE_VOICE: string;
+export declare const EDGE_RATE: string;
+/** Kokoro native sample rate. */
+export declare const SAMPLE_RATE = 24000;
+/** `os.path.dirname(os.path.dirname(abspath(__file__)))` → the `src/` directory. */
+export declare const PROJECT_ROOT: string;
+export declare const MMS_MODEL_PATH: string;
+export declare const VOICE_MODELS: string;
+/**
+ * Search common locations for Kokoro model files.
+ * Returns `[onnxPath, voicesPath]`, each `null` when not found.
+ */
+export declare function _find_kokoro_models(): [string | null, string | null];
+/** Actionable error text for the unimplemented offline (pyttsx3) slot. */
+export declare const OFFLINE_TTS_ERROR: string;
+export declare const TTS_UNAVAILABLE_ERROR: string;
+export interface TTSBackend {
+    /** Human readable name shown by `info()`. */
+    readonly name: string;
+    /** True when this backend can actually synthesize right now. */
+    available(): boolean;
+    /** Synthesize `text` to `filePath`. Returns true on success. */
+    synthesize(text: string, filePath: string, engine: TTSEngine): Promise<boolean>;
+    /** Optional: play directly without a temp file. */
+    speak?(text: string, engine: TTSEngine): Promise<boolean>;
+}
+/** Register (or replace) a TTS backend at runtime. */
+export declare function registerTTSBackend(name: string, backend: TTSBackend): void;
+export declare function unregisterTTSBackend(name: string): void;
+export interface TTSInfo {
+    backend: string;
+    voice: string;
+    rate: string;
+    available: boolean;
+    kokoro_onnx: string | null;
+}
+export declare class TTSEngine {
+    /** BERU's voice output engine — offline-first, highest quality available. */
+    rate: string;
+    volume: string;
+    speed: number;
+    provider: string;
+    voice: string;
+    private _backend;
+    private _model;
+    private _onnxPath;
+    private _voicesPath;
+    private _lastError;
+    constructor(voice?: string | null, rate?: string, volume?: string, provider?: string, speed?: number);
+    private _detect_backend;
+    private _default_voice;
+    get backend(): string;
+    /** Last `[ERROR] …` string produced by a degraded path. */
+    get lastError(): string;
+    get is_available(): boolean;
+    get isAvailable(): boolean;
+    /** Speak `text` aloud. Returns true when something handled it. */
+    speak(text: string): Promise<boolean>;
+    /** Fire-and-forget speak (replaces `threading.Thread(target=self.speak, daemon=True)`). */
+    speakAsync(text: string): void;
+    /**
+     * Synthesize `text` to `filePath`.
+     *
+     * `filePath` should end in `.mp3` for edge (the only live engine) — the edge
+     * API cannot emit WAV. When the requested extension is `.wav` and a
+     * WAV-capable backend (kokoro/piper/mms) is unavailable, a clear
+     * `[ERROR] …` is stored in `lastError` and false is returned.
+     */
+    synthesize_to_file(text: string, filePath: string): Promise<boolean>;
+    synthesizeToFile(text: string, filePath: string): Promise<boolean>;
+    synthesize_to_bytes(text: string): Promise<Buffer | null>;
+    synthesizeToBytes(text: string): Promise<Buffer | null>;
+    /**
+     * TODO(port): Python loaded a local VITS model via `transformers` + `torch`
+     * (`VitsModel.from_pretrained`). `@huggingface/transformers` is NOT installed
+     * on this machine and its install repeatedly failed. Recommended replacement:
+     * `@huggingface/transformers` (VITS/MMS ONNX) once reachable.
+     */
+    private _get_mms_model;
+    private _speak_mms;
+    private _mms_to_file;
+    /**
+     * TODO(port): Python used `kokoro_onnx.Kokoro`. `kokoro-js` is NOT installed
+     * and cannot be installed on this machine's npm connection. The model-file
+     * discovery logic is fully ported and `_GLOBAL_KOKORO` stays as the singleton
+     * slot; `registerTTSBackend("kokoro", …)` is the runtime hook.
+     */
+    private _get_kokoro;
+    private _speak_kokoro;
+    /**
+     * Write Kokoro output to a real RIFF WAV using the hand-rolled header in
+     * `src/voice/wav.ts` — the Python `soundfile.write` equivalent.
+     */
+    private _kokoro_to_file;
+    /**
+     * TODO(port): Python used the `piper` module (or the `piper` binary).
+     * No Node binding is installed. The binary path is still honoured: if
+     * `piper`/`piper-tts` is on PATH we shell out exactly like `_speak_piper_bin`.
+     */
+    private _speak_piper;
+    private _speak_piper_bin;
+    private _speak_edge;
+    private _edge_to_file;
+    private _speak_pyttsx3;
+    info(): TTSInfo;
+    set_voice(voice: string): void;
+    setVoice(voice: string): void;
+    set_speed(speed: number): void;
+    setSpeed(speed: number): void;
+    /** Record an `[ERROR] …` string and log it. Never throws. */
+    storeLastError(msg: string): void;
+    private _speakBackend;
+}
+/**
+ * Play an audio file through the registered audio-output driver.
+ *
+ * TODO(port): Python tried `soundfile`+`sounddevice`, then `winsound`/`afplay`/
+ * `mpg123`/`ffplay`. There is no in-process Node audio dependency here, so this
+ * shells out to an OS player (see `getAudioOutputDriver()` in src/voice/wav.ts).
+ */
+export declare function _play_file(filePath: string): Promise<boolean>;
+export declare function _which(name: string): string | null;
+/**
+ * Speak text with the module singleton. Ports the module-level `_speak()` in
+ * `light_daemon.py` so the daemon has a one-call path to the engine.
+ */
+export declare function speakWithFallback(text: string): Promise<boolean>;
+export declare function get_tts(provider?: string, kwargs?: {
+    voice?: string | null;
+    rate?: string;
+    speed?: number;
+}): TTSEngine;
+/** camelCase alias of `get_tts`. */
+export declare const getTts: typeof get_tts;
+/** Test/DI hook — replace the singleton. */
+export declare function setTts(engine: TTSEngine | null): void;
+//# sourceMappingURL=tts.d.ts.map

package/dist/voice/tts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tts.d.ts","sourceRoot":"","sources":["../../src/voice/tts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAoBH,eAAO,MAAM,YAAY,QAA6C,CAAC;AACvE,eAAO,MAAM,YAAY,QAA6D,CAAC;AACvF,eAAO,MAAM,WAAW,QAAwD,CAAC;AACjF,eAAO,MAAM,UAAU,QAAmD,CAAC;AAC3E,eAAO,MAAM,SAAS,QAAuC,CAAC;AAC9D,iCAAiC;AACjC,eAAO,MAAM,WAAW,QAAS,CAAC;AAElC,oFAAoF;AACpF,eAAO,MAAM,YAAY,QAAmE,CAAC;AAC7F,eAAO,MAAM,cAAc,QAAyC,CAAC;AAQrE,eAAO,MAAM,YAAY,QAAyC,CAAC;AAiBnE;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,CA8BpE;AAID,0EAA0E;AAC1E,eAAO,MAAM,iBAAiB,QAIgB,CAAC;AAE/C,eAAO,MAAM,qBAAqB,QAGkC,CAAC;AAErE,MAAM,WAAW,UAAU;IACzB,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,gEAAgE;IAChE,SAAS,IAAI,OAAO,CAAC;IACrB,gEAAgE;IAChE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAChF,mDAAmD;IACnD,KAAK,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3D;AAID,sDAAsD;AACtD,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI,CAE1E;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAEvD;AA6HD,MAAM,WAAW,OAAO;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,qBAAa,SAAS;IACpB,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IAEd,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,SAAS,CAAuB;IACxC,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,UAAU,CAAM;IAExB,YACE,KAAK,GAAE,MAAM,GAAG,IAAW,EAC3B,IAAI,GAAE,MAAkB,EACxB,MAAM,SAAQ,EACd,QAAQ,SAAS,EACjB,KAAK,GAAE,MAAqB,EAW7B;IAID,OAAO,CAAC,eAAe;IAwBvB,OAAO,CAAC,cAAc;IAatB,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,2DAA2D;IAC3D,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED,IAAI,WAAW,IAAI,OAAO,CAEzB;IAID,kEAAkE;IAC5D,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAoB1C;IAED,2FAA2F;IAC3F,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAI7B;IAED;;;;;;;OAOG;IACG,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAoBzE;IAEK,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAEvE;IAEK,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAY9D;IAEK,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAE5D;IAID;;;;;OAKG;YACW,cAAc;YAYd,UAAU;YAUV,YAAY;IAkB1B;;;;;OAKG;YACW,WAAW;YAyBX,aAAa;IAgB3B;;;OAGG;YACW,eAAe;IA0B7B;;;;OAIG;YACW,YAAY;YAQZ,gBAAgB;YA8BhB,WAAW;YAcX,aAAa;YAQb,cAAc;IAM5B,IAAI,IAAI,OAAO,CASd;IAED,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAG7B;IAED,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAE5B;IAED,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAE7B;IAED,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAE5B;IAED,6DAA6D;IAC7D,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAGhC;YAIa,aAAa;CA6B5B;AAID;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAanE;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAElD;AAID;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAMtE;AAwBD,wBAAgB,OAAO,CACrB,QAAQ,SAAS,EACjB,MAAM,GAAE;IAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAO,GACpE,SAAS,CAYX;AAED,oCAAoC;AACpC,eAAO,MAAM,MAAM,gBAAU,CAAC;AAE9B,4CAA4C;AAC5C,wBAAgB,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI,CAErD"}