n8n-nodes-tts-bigboss 1.0.2 → 1.0.4

package/dist/TTSBigBoss.node.js

@@ -47,6 +47,30 @@ const https = __importStar(require("https"));
 const stream = __importStar(require("stream"));
 const util_1 = require("util");
 const pipeline = (0, util_1.promisify)(stream.pipeline);
+const PIPER_MODELS = [
+    { name: 'Arabic (Jordan) - Kareem (Male) - Low', value: 'ar_JO-kareem-low' },
+    { name: 'Arabic (Jordan) - Kareem (Male) - Medium', value: 'ar_JO-kareem-medium' },
+    { name: 'English (US) - Lessac (Female) - Low', value: 'en_US-lessac-low' },
+    { name: 'English (US) - Lessac (Female) - Medium', value: 'en_US-lessac-medium' },
+    { name: 'English (US) - Lessac (Female) - High', value: 'en_US-lessac-high' },
+    { name: 'English (US) - Ryan (Male) - Low', value: 'en_US-ryan-low' },
+    { name: 'English (US) - Ryan (Male) - Medium', value: 'en_US-ryan-medium' },
+    { name: 'English (US) - Ryan (Male) - High', value: 'en_US-ryan-high' },
+    { name: 'English (US) - Amy (Female) - Low', value: 'en_US-amy-low' },
+    { name: 'English (US) - Amy (Female) - Medium', value: 'en_US-amy-medium' },
+    { name: 'English (US) - Kathleen (Female) - Low', value: 'en_US-kathleen-low' },
+    { name: 'English (UK) - Alan (Male) - Low', value: 'en_GB-alan-low' },
+    { name: 'English (UK) - Alan (Male) - Medium', value: 'en_GB-alan-medium' },
+    { name: 'English (UK) - Southern Female - Low', value: 'en_GB-southern_english_female-low' },
+    { name: 'French - Siwis (Female) - Low', value: 'fr_FR-siwis-low' },
+    { name: 'French - Siwis (Female) - Medium', value: 'fr_FR-siwis-medium' },
+    { name: 'Spanish (Spain) - Sharvard (Male) - Medium', value: 'es_ES-sharvard-medium' },
+    { name: 'Spanish (Mexico) - Aldone (Male) - Medium', value: 'es_MX-aldona-medium' },
+    { name: 'German - Eva (Female) - High', value: 'de_DE-eva_k-x_low' },
+    { name: 'German - Thorsten (Male) - High', value: 'de_DE-thorsten-high' },
+    { name: 'German - Thorsten (Male) - Medium', value: 'de_DE-thorsten-medium' },
+    { name: 'German - Thorsten (Male) - Low', value: 'de_DE-thorsten-low' },
+];
 const EDGE_URL = 'wss://speech.platform.bing.com/consumer/speech/synthesize/readaloud/edge/v1?TrustedClientToken=6A5AA1D4EAFF4E9FB37E23D68491D6F4';
 const EDGE_VOICES = [
     { name: 'Arabic (Egypt) - Salma', value: 'ar-EG-SalmaNeural' },
@@ -217,17 +241,35 @@ class TTSBigBoss {
                     description: 'Binary property name containing the reference audio for cloning. Use placeholder "{reference_audio}" in command.',
                 },
                 {
-                    displayName: 'Piper Voice Model (HF URL or Path)',
+                    displayName: 'Piper Voice Model',
                     name: 'piperModel',
-                    type: 'string',
+                    type: 'options',
+                    options: [
+                        ...PIPER_MODELS,
+                        { name: 'Custom (Enter URL)', value: 'custom' },
+                    ],
                     default: 'en_US-lessac-medium',
-                    description: 'Enter a known Piper model name (e.g. "en_US-lessac-medium") which will be auto-downloaded, OR a full URL to the .onnx file.',
                     displayOptions: {
                         show: {
                             engine: ['piper_local'],
                         },
                     },
-                }
+                    description: 'Select a voice model. It will be downloaded automatically. Note: Official Piper Arabic only has "Kareem" (Male). For Female Arabic, please use the "Edge TTS" engine.',
+                },
+                {
+                    displayName: 'Custom Model Name/URL',
+                    name: 'piperModelCustom',
+                    type: 'string',
+                    default: '',
+                    placeholder: 'e.g. en_US-bryce-medium',
+                    displayOptions: {
+                        show: {
+                            engine: ['piper_local'],
+                            piperModel: ['custom'],
+                        },
+                    },
+                    description: 'Name from Hugging Face (e.g. en_US-bryce-medium) or full URL to .onnx file.',
+                },
             ],
         };
     }
@@ -264,7 +306,10 @@ class TTSBigBoss {
                     }
                 }
                 else if (engine === 'piper_local') {
-                    const piperModel = this.getNodeParameter('piperModel', i);
+                    let piperModel = this.getNodeParameter('piperModel', i);
+                    if (piperModel === 'custom') {
+                        piperModel = this.getNodeParameter('piperModelCustom', i);
+                    }
                     const piperBinPath = await ensurePiperBinary(binDir);
                     const { modelPath, configPath } = await ensurePiperModel(binDir, piperModel);
                     const outFile = path.join(tempDir, `piper_out_${(0, uuid_1.v4)()}.wav`);
@@ -281,8 +326,12 @@ class TTSBigBoss {
                         piperProc.on('close', (code) => {
                             if (code === 0)
                                 resolve();
-                            else
+                            if (errData.includes('json.exception.parse_error')) {
+                                reject(new Error(`Piper Config Error: The downloaded JSON configuration for model '${piperModel}' seems corrupted (HTML instead of JSON?). Try deleting the file at ${configPath} and running again.`));
+                            }
+                            else {
                                 reject(new Error(`Piper failed (exit ${code}): ${errData}`));
+                            }
                         });
                         piperProc.on('error', (err) => reject(err));
                     });
@@ -522,30 +571,48 @@ async function ensurePiperBinary(binDir) {
     }
 }
 async function ensurePiperModel(binDir, modelNameOrUrl) {
+    let modelUrl = '';
+    let modelFilename = '';
     if (modelNameOrUrl.startsWith('http')) {
-        const fileName = path.basename(modelNameOrUrl);
-        const modelPath = path.join(binDir, fileName);
-        if (!fs.existsSync(modelPath)) {
-            await downloadFile(modelNameOrUrl, modelPath);
+        modelUrl = modelNameOrUrl;
+        modelFilename = path.basename(modelNameOrUrl);
+    }
+    else {
+        const parts = modelNameOrUrl.split('-');
+        if (parts.length >= 3) {
+            const langRegion = parts[0] + '_' + parts[1];
+            const voice = parts[2];
+            const quality = parts[3] || 'medium';
+            const lang = parts[0];
+            modelFilename = modelNameOrUrl + '.onnx';
+            modelUrl = `https://huggingface.co/rhasspy/piper-voices/resolve/main/${lang}/${langRegion}/${voice}/${quality}/${modelFilename}?download=true`;
         }
-        const configUrl = modelNameOrUrl + '.json';
-        const configPath = modelPath + '.json';
-        if (!fs.existsSync(configPath)) {
-            await downloadFile(configUrl, configPath);
+        else {
+            throw new Error(`Invalid model name format: ${modelNameOrUrl}. Use format lang_REGION-voice-quality`);
         }
-        return { modelPath, configPath };
     }
-    if (modelNameOrUrl === 'en_US-lessac-medium') {
-        const url = 'https://huggingface.co/rhasspy/piper-voices/resolve/main/en/en_US/lessac/medium/en_US-lessac-medium.onnx';
-        const modelPath = path.join(binDir, 'en_US-lessac-medium.onnx');
-        const configPath = path.join(binDir, 'en_US-lessac-medium.onnx.json');
-        if (!fs.existsSync(modelPath))
-            await downloadFile(url, modelPath);
-        if (!fs.existsSync(configPath))
-            await downloadFile(url + '.json', configPath);
-        return { modelPath, configPath };
+    const modelPath = path.join(binDir, modelFilename);
+    const configPath = modelPath + '.json';
+    if (!fs.existsSync(modelPath) || fs.statSync(modelPath).size < 1000) {
+        console.log(`Downloading Piper Model: ${modelUrl}`);
+        await downloadFile(modelUrl, modelPath);
+    }
+    if (!fs.existsSync(configPath) || fs.statSync(configPath).size < 10) {
+        const configUrl = modelUrl + '.json';
+        console.log(`Downloading Piper Config: ${configUrl}`);
+        await downloadFile(configUrl, configPath);
+        try {
+            const content = fs.readFileSync(configPath, 'utf8');
+            JSON.parse(content);
+        }
+        catch (e) {
+            fs.unlinkSync(configPath);
+            if (fs.existsSync(modelPath))
+                fs.unlinkSync(modelPath);
+            throw new Error(`Downloaded config for ${modelNameOrUrl} was not valid JSON. URL might be wrong: ${configUrl}. Content start: ${fs.readFileSync(configPath, 'utf8').substring(0, 50)}...`);
+        }
     }
-    return { modelPath: modelNameOrUrl, configPath: modelNameOrUrl + '.json' };
+    return { modelPath, configPath };
 }
 async function downloadFile(url, dest) {
     return new Promise((resolve, reject) => {

package/nodes/TTSBigBoss/TTSBigBoss.node.ts

@@ -17,6 +17,45 @@ import * as zlib from 'zlib'; // For extracting .tar.gz if needed, typically usa
 
 const pipeline = promisify(stream.pipeline);
 
+// Piper Models List (Curated High Quality)
+// Note: Official Piper repo currently only has 'kareem' (Male) for Arabic.
+// For Female Arabic voices, please use the 'Edge TTS' engine (Salma, Zariyah).
+const PIPER_MODELS = [
+    // Arabic
+    { name: 'Arabic (Jordan) - Kareem (Male) - Low', value: 'ar_JO-kareem-low' },
+    { name: 'Arabic (Jordan) - Kareem (Male) - Medium', value: 'ar_JO-kareem-medium' },
+
+    // English (US)
+    { name: 'English (US) - Lessac (Female) - Low', value: 'en_US-lessac-low' },
+    { name: 'English (US) - Lessac (Female) - Medium', value: 'en_US-lessac-medium' },
+    { name: 'English (US) - Lessac (Female) - High', value: 'en_US-lessac-high' },
+    { name: 'English (US) - Ryan (Male) - Low', value: 'en_US-ryan-low' },
+    { name: 'English (US) - Ryan (Male) - Medium', value: 'en_US-ryan-medium' },
+    { name: 'English (US) - Ryan (Male) - High', value: 'en_US-ryan-high' },
+    { name: 'English (US) - Amy (Female) - Low', value: 'en_US-amy-low' },
+    { name: 'English (US) - Amy (Female) - Medium', value: 'en_US-amy-medium' },
+    { name: 'English (US) - Kathleen (Female) - Low', value: 'en_US-kathleen-low' },
+
+    // English (UK)
+    { name: 'English (UK) - Alan (Male) - Low', value: 'en_GB-alan-low' },
+    { name: 'English (UK) - Alan (Male) - Medium', value: 'en_GB-alan-medium' },
+    { name: 'English (UK) - Southern Female - Low', value: 'en_GB-southern_english_female-low' },
+
+    // French
+    { name: 'French - Siwis (Female) - Low', value: 'fr_FR-siwis-low' },
+    { name: 'French - Siwis (Female) - Medium', value: 'fr_FR-siwis-medium' },
+
+    // Spanish
+    { name: 'Spanish (Spain) - Sharvard (Male) - Medium', value: 'es_ES-sharvard-medium' },
+    { name: 'Spanish (Mexico) - Aldone (Male) - Medium', value: 'es_MX-aldona-medium' },
+
+    // German
+    { name: 'German - Eva (Female) - High', value: 'de_DE-eva_k-x_low' },
+    { name: 'German - Thorsten (Male) - High', value: 'de_DE-thorsten-high' },
+    { name: 'German - Thorsten (Male) - Medium', value: 'de_DE-thorsten-medium' },
+    { name: 'German - Thorsten (Male) - Low', value: 'de_DE-thorsten-low' },
+];
+
 // Edge TTS Constants
 const EDGE_URL = 'wss://speech.platform.bing.com/consumer/speech/synthesize/readaloud/edge/v1?TrustedClientToken=6A5AA1D4EAFF4E9FB37E23D68491D6F4';
 const EDGE_VOICES = [
@@ -212,17 +251,35 @@ export class TTSBigBoss implements INodeType {
             // Local Piper Settings
             // ----------------------------------
             {
-                displayName: 'Piper Voice Model (HF URL or Path)',
+                displayName: 'Piper Voice Model',
                 name: 'piperModel',
-                type: 'string',
+                type: 'options',
+                options: [
+                    ...PIPER_MODELS,
+                    { name: 'Custom (Enter URL)', value: 'custom' },
+                ],
                 default: 'en_US-lessac-medium',
-                description: 'Enter a known Piper model name (e.g. "en_US-lessac-medium") which will be auto-downloaded, OR a full URL to the .onnx file.',
                 displayOptions: {
                     show: {
                         engine: ['piper_local'],
                     },
                 },
-            }
+                description: 'Select a voice model. It will be downloaded automatically. Note: Official Piper Arabic only has "Kareem" (Male). For Female Arabic, please use the "Edge TTS" engine.',
+            },
+            {
+                displayName: 'Custom Model Name/URL',
+                name: 'piperModelCustom',
+                type: 'string',
+                default: '',
+                placeholder: 'e.g. en_US-bryce-medium',
+                displayOptions: {
+                    show: {
+                        engine: ['piper_local'],
+                        piperModel: ['custom'],
+                    },
+                },
+                description: 'Name from Hugging Face (e.g. en_US-bryce-medium) or full URL to .onnx file.',
+            },
         ],
     };
 
@@ -271,7 +328,10 @@ export class TTSBigBoss implements INodeType {
                     // ----------------------------------
                     // PIPER LOCAL AUTOMATION
                     // ----------------------------------
-                    const piperModel = this.getNodeParameter('piperModel', i) as string;
+                    let piperModel = this.getNodeParameter('piperModel', i) as string;
+                    if (piperModel === 'custom') {
+                        piperModel = this.getNodeParameter('piperModelCustom', i) as string;
+                    }
 
                     // 1. Ensure Piper Binary
                     const piperBinPath = await ensurePiperBinary(binDir);
@@ -299,7 +359,12 @@ export class TTSBigBoss implements INodeType {
 
                         piperProc.on('close', (code) => {
                             if (code === 0) resolve();
-                            else reject(new Error(`Piper failed (exit ${code}): ${errData}`));
+                            // Check for the specific JSON error in stderr
+                            if (errData.includes('json.exception.parse_error')) {
+                                reject(new Error(`Piper Config Error: The downloaded JSON configuration for model '${piperModel}' seems corrupted (HTML instead of JSON?). Try deleting the file at ${configPath} and running again.`));
+                            } else {
+                                reject(new Error(`Piper failed (exit ${code}): ${errData}`));
+                            }
                         });
 
                         piperProc.on('error', (err) => reject(err));
@@ -641,42 +706,66 @@ async function ensurePiperBinary(binDir: string): Promise<string> {
 }
 
 async function ensurePiperModel(binDir: string, modelNameOrUrl: string): Promise<{ modelPath: string, configPath: string }> {
-    // If it's a known model name like "en_US-lessac-medium", construct URL
-    // https://huggingface.co/rhasspy/piper-voices/resolve/main/en/en_US/lessac/medium/en_US-lessac-medium.onnx
-    // This is tricky because directory structure varies.
-    // We'll rely on a direct URL or a simplied map for BigBoss defaults.
+    // Heuristic for HF URL construction
+    // https://huggingface.co/rhasspy/piper-voices/resolve/main/[lang_code]/[region]/[voice]/[quality]/[filename]
+    // Example: en_US-lessac-medium -> en/en_US/lessac/medium/en_US-lessac-medium.onnx
 
-    // If full URL provided
-    if (modelNameOrUrl.startsWith('http')) {
-        const fileName = path.basename(modelNameOrUrl);
-        const modelPath = path.join(binDir, fileName);
-        if (!fs.existsSync(modelPath)) {
-            await downloadFile(modelNameOrUrl, modelPath);
-        }
+    let modelUrl = '';
+    let modelFilename = '';
 
-        const configUrl = modelNameOrUrl + '.json';
-        const configPath = modelPath + '.json';
-        if (!fs.existsSync(configPath)) {
-            await downloadFile(configUrl, configPath);
+    if (modelNameOrUrl.startsWith('http')) {
+        modelUrl = modelNameOrUrl;
+        modelFilename = path.basename(modelNameOrUrl);
+    } else {
+        // Construct URL from name
+        const parts = modelNameOrUrl.split('-');
+        if (parts.length >= 3) {
+            const langRegion = parts[0] + '_' + parts[1]; // en_US
+            const voice = parts[2];
+            const quality = parts[3] || 'medium';
+            const lang = parts[0]; // en
+
+            // e.g. en_US-lessac-medium
+            // lang=en, region=en_US, voice=lessac, quality=medium
+            // url path: en/en_US/lessac/medium/en_US-lessac-medium.onnx
+
+            // Handle special case: ar_JO (no lang folder? check repo)
+            // Generally structure is: lang_short/lang_long/voice/quality/filename
+
+            modelFilename = modelNameOrUrl + '.onnx';
+            modelUrl = `https://huggingface.co/rhasspy/piper-voices/resolve/main/${lang}/${langRegion}/${voice}/${quality}/${modelFilename}?download=true`; // Add download=true to force direct link
+        } else {
+            throw new Error(`Invalid model name format: ${modelNameOrUrl}. Use format lang_REGION-voice-quality`);
         }
-        return { modelPath, configPath };
     }
 
-    // If short name provided, try a heuristic for common English voice
-    // We only support auto-download for "en_US-lessac-medium" easily for now.
-    if (modelNameOrUrl === 'en_US-lessac-medium') {
-        const url = 'https://huggingface.co/rhasspy/piper-voices/resolve/main/en/en_US/lessac/medium/en_US-lessac-medium.onnx';
-        const modelPath = path.join(binDir, 'en_US-lessac-medium.onnx');
-        const configPath = path.join(binDir, 'en_US-lessac-medium.onnx.json');
+    const modelPath = path.join(binDir, modelFilename);
+    const configPath = modelPath + '.json';
 
-        if (!fs.existsSync(modelPath)) await downloadFile(url, modelPath);
-        if (!fs.existsSync(configPath)) await downloadFile(url + '.json', configPath);
+    // Download if missing or seems incomplete (size < 1KB)
+    if (!fs.existsSync(modelPath) || fs.statSync(modelPath).size < 1000) {
+        console.log(`Downloading Piper Model: ${modelUrl}`);
+        await downloadFile(modelUrl, modelPath);
+    }
 
-        return { modelPath, configPath };
+    // Download config if missing or seems incomplete (size < 10 bytes)
+    if (!fs.existsSync(configPath) || fs.statSync(configPath).size < 10) {
+        const configUrl = modelUrl + '.json';
+        console.log(`Downloading Piper Config: ${configUrl}`);
+        await downloadFile(configUrl, configPath);
+
+        // Validate JSON
+        try {
+            const content = fs.readFileSync(configPath, 'utf8');
+            JSON.parse(content);
+        } catch (e) {
+            fs.unlinkSync(configPath); // Delete bad file
+            if (fs.existsSync(modelPath)) fs.unlinkSync(modelPath); // Delete model too as it might be bad
+            throw new Error(`Downloaded config for ${modelNameOrUrl} was not valid JSON. URL might be wrong: ${configUrl}. Content start: ${fs.readFileSync(configPath, 'utf8').substring(0, 50)}...`);
+        }
     }
 
-    // Assume local path if not url/special name
-    return { modelPath: modelNameOrUrl, configPath: modelNameOrUrl + '.json' };
+    return { modelPath, configPath };
 }
 
 async function downloadFile(url: string, dest: string): Promise<void> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-tts-bigboss",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "BigBoss TTS node with multi-engine support and automatic SRT generation",
   "keywords": [
     "n8n-community-node-package",