TTS: VITS Piper (English)

Generate speech with the VITS Piper English (GB, cori-medium) model. VITS is a popular end-to-end TTS architecture. It supports both synchronous and asynchronous generation.

For model documentation, see VITS Piper.

Source files

• Sync: test_tts_non_streaming_vits_piper_en.js

• Async: test_tts_non_streaming_vits_piper_en_async.js

Synchronous generation

// Copyright (c)  2024  Xiaomi Corporation
//
// Text-to-speech with the VITS Piper English (GB) model.
//
// Usage:
//   node tts_vits_piper_en.js
//
const sherpa_onnx = require('sherpa-onnx-node');

function createOfflineTts() {
  const config = {
    model: {
      vits: {
        model: './vits-piper-en_GB-cori-medium/en_GB-cori-medium.onnx',
        tokens: './vits-piper-en_GB-cori-medium/tokens.txt',
        dataDir: './vits-piper-en_GB-cori-medium/espeak-ng-data',
      },
      debug: true,
      numThreads: 1,
      provider: 'cpu',
    },
    maxNumSentences: 1,
  };
  return new sherpa_onnx.OfflineTts(config);
}

const tts = createOfflineTts();

const text =
    'Today as always, men fall into two groups: slaves and free men. Whoever does not have two-thirds of his day for himself, is a slave, whatever he may be: a statesman, a businessman, an official, or a scholar.';

const generationConfig = new sherpa_onnx.GenerationConfig({
  sid: 0,
  speed: 1.0,
  silenceScale: 0.2,
});

let start = Date.now();
const audio = tts.generate({text: text, generationConfig});
let stop = Date.now();
const elapsed_seconds = (stop - start) / 1000;
const duration = audio.samples.length / audio.sampleRate;
const real_time_factor = elapsed_seconds / duration;
console.log('Wave duration', duration.toFixed(3), 'seconds');
console.log('Elapsed', elapsed_seconds.toFixed(3), 'seconds');
console.log(
    `RTF = ${elapsed_seconds.toFixed(3)}/${duration.toFixed(3)} =`,
    real_time_factor.toFixed(3));

const filename = 'test-vits-piper-en.wav';
sherpa_onnx.writeWave(
    filename, {samples: audio.samples, sampleRate: audio.sampleRate});

console.log(`Saved to ${filename}`);

Asynchronous generation

// Copyright (c)  2026  Xiaomi Corporation
//
// Asynchronous text-to-speech with the VITS Piper English model.
//
// Usage:
//   node tts_vits_piper_en_async.js
//
const sherpa_onnx = require('sherpa-onnx-node');

async function createOfflineTts() {
  const config = {
    model: {
      vits: {
        model: './vits-piper-en_GB-cori-medium/en_GB-cori-medium.onnx',
        tokens: './vits-piper-en_GB-cori-medium/tokens.txt',
        dataDir: './vits-piper-en_GB-cori-medium/espeak-ng-data',
      },
      debug: false,
      numThreads: 1,
      provider: 'cpu',
    },
    maxNumSentences: 1,
  };
  return await sherpa_onnx.OfflineTts.createAsync(config);
}

async function main() {
  const tts = await createOfflineTts();

  const text =
      'Today as always, men fall into two groups: slaves and free men. Whoever does not have two-thirds of his day for himself, is a slave, whatever he may be: a statesman, a businessman, an official, or a scholar.';

  const generationConfig = new sherpa_onnx.GenerationConfig({
    sid: 0,
    speed: 1.0,
    silenceScale: 0.2,
  });

  const start = Date.now();
  const audio = await tts.generateAsync({
    text,
    enableExternalBuffer: true,
    generationConfig,
    onProgress: ({samples, progress}) => {
      process.stdout.write(
          `Progress: ${(progress * 100).toFixed(1)}%, ` +
          `Samples: ${samples.length}\r`);
      return 1;
    },
  });

  console.log('');
  const stop = Date.now();
  const elapsed_seconds = (stop - start) / 1000;
  const duration = audio.samples.length / audio.sampleRate;
  const real_time_factor = elapsed_seconds / duration;
  console.log('Wave duration', duration.toFixed(3), 'seconds');
  console.log('Elapsed', elapsed_seconds.toFixed(3), 'seconds');
  console.log(
      `RTF = ${elapsed_seconds.toFixed(3)}/${duration.toFixed(3)} =`,
      real_time_factor.toFixed(3));

  const filename = 'test-vits-piper-en-async.wav';
  sherpa_onnx.writeWave(
      filename, {samples: audio.samples, sampleRate: audio.sampleRate});
  console.log(`Saved to ${filename}`);
}

main().catch((err) => {
  console.error('Error:', err);
});

How to run

1. Install the package:

   npm install sherpa-onnx-node
   

2. Download the model:

   curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/vits-piper-en_US-amy-low.tar.bz2
   tar xf vits-piper-en_US-amy-low.tar.bz2
   

3. Set the library path and run:

   # macOS
   export DYLD_LIBRARY_PATH=$(npm root)/sherpa-onnx-node/lib:$DYLD_LIBRARY_PATH
   
   # Linux
   export LD_LIBRARY_PATH=$(npm root)/sherpa-onnx-node/lib:$LD_LIBRARY_PATH
   
   # Choose one:
   node tts_vits_piper_en.js
   node tts_vits_piper_en_async.js
   

Notes

• The config key is vits with fields: model, tokens, dataDir.

• VITS models from Piper are self-contained (no separate vocoder needed).

• dataDir points to the espeak-ng data directory for phoneme conversion.

• The sync API uses new sherpa_onnx.OfflineTts(config) and tts.generate({text, generationConfig}).

• The async API uses OfflineTts.createAsync() and tts.generateAsync() with an onProgress callback.