Add Java and Kotlin API for Supertonic TTS (#3289)

csukuangfj · web-flow · commit 3ca8943d615b · 2026-03-12T00:05:25.000+08:00
This pull request enhances the Text-to-Speech capabilities by integrating the Supertonic TTS model into the existing Java and Kotlin APIs. It provides developers with new tools and clear examples to generate speech from text using this model, expanding the range of available TTS options and simplifying their adoption within Java and Kotlin projects.
diff --git a/.github/workflows/run-java-test.yaml b/.github/workflows/run-java-test.yaml
@@ -339,6 +339,7 @@ jobs:
           cd ./java-api-examples
 
           ./run-pocket-tts.sh
+          ./run-supertonic-tts.sh
           ./run-non-streaming-tts-kitten-en.sh
           ./run-non-streaming-tts-kokoro-zh-en.sh
           ./run-non-streaming-tts-kokoro-en.sh
@@ -347,6 +348,7 @@ jobs:
           ls -lh
 
           rm -rf sherpa-onnx-pocket-tts-*
+          rm -rf sherpa-onnx-supertonic-tts-*
           rm -rf kitten-nano-en-*
           rm -rf kokoro-multi-*
           rm -rf kokoro-en-*
diff --git a/java-api-examples/NonStreamingSpeechEnhancementGtcrn.java b/java-api-examples/NonStreamingSpeechEnhancementGtcrn.java
@@ -23,16 +23,16 @@ public static void main(String[] args) {
     OfflineSpeechDenoiserConfig config =
         OfflineSpeechDenoiserConfig.builder().setModel(modelConfig).build();
 
-    OfflineSpeechDenoiser speech_denoiser = new OfflineSpeechDenoiser(config);
+    OfflineSpeechDenoiser speechDenoiser = new OfflineSpeechDenoiser(config);
 
     String testWaveFilename = "./inp_16k.wav";
     WaveReader reader = new WaveReader(testWaveFilename);
 
-    DenoisedAudio denoised = speech_denoiser.run(reader.getSamples(), reader.getSampleRate());
+    DenoisedAudio denoised = speechDenoiser.run(reader.getSamples(), reader.getSampleRate());
     String outFilename = "enhanced-16k.wav";
     WaveWriter.write(outFilename, denoised.getSamples(), denoised.getSampleRate());
     System.out.printf("Saved to %s\n", outFilename);
 
-    speech_denoiser.release();
+    speechDenoiser.release();
   }
 }
diff --git a/java-api-examples/NonStreamingTtsCoquiDe.java b/java-api-examples/NonStreamingTtsCoquiDe.java
@@ -35,13 +35,13 @@ public static void main(String[] args) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     String waveFilename = "tts-coqui-de.wav";
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/NonStreamingTtsKittenEn.java b/java-api-examples/NonStreamingTtsKittenEn.java
@@ -46,13 +46,13 @@ public static void main(String[] args) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     String waveFilename = "tts-kitten-en.wav";
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/NonStreamingTtsKokoroEn.java b/java-api-examples/NonStreamingTtsKokoroEn.java
@@ -45,13 +45,13 @@ public static void main(String[] args) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     String waveFilename = "tts-kokoro-en.wav";
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/NonStreamingTtsKokoroZhEn.java b/java-api-examples/NonStreamingTtsKokoroZhEn.java
@@ -47,13 +47,13 @@ public static void main(String[] args) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     String waveFilename = "tts-kokoro-zh-en.wav";
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/NonStreamingTtsMatchaEn.java b/java-api-examples/NonStreamingTtsMatchaEn.java
@@ -45,13 +45,13 @@ public static void main(String[] args) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     String waveFilename = "tts-matcha-en.wav";
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/NonStreamingTtsMatchaZh.java b/java-api-examples/NonStreamingTtsMatchaZh.java
@@ -49,13 +49,13 @@ public static void main(String[] args) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     String waveFilename = "tts-matcha-zh.wav";
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/NonStreamingTtsPiperEn.java b/java-api-examples/NonStreamingTtsPiperEn.java
@@ -43,13 +43,13 @@ public static void main(String[] args) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     String waveFilename = "tts-piper-en.wav";
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/NonStreamingTtsPiperEnWithCallback.java b/java-api-examples/NonStreamingTtsPiperEnWithCallback.java
@@ -164,7 +164,7 @@ public static void main(String[] args) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     try {
       playThread.join();
@@ -177,7 +177,7 @@ public static void main(String[] args) {
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/NonStreamingTtsVitsZh.java b/java-api-examples/NonStreamingTtsVitsZh.java
@@ -47,13 +47,13 @@ public static void main(String[] args) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     String waveFilename = "tts-vits-zh.wav";
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/PocketTts.java b/java-api-examples/PocketTts.java
@@ -117,13 +117,13 @@ public Integer invoke(float[] samples) {
     float timeElapsedSeconds = (stop - start) / 1000.0f;
 
     float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
-    float real_time_factor = timeElapsedSeconds / audioDuration;
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
 
     String waveFilename = "pocket-tts-bria.wav";
     audio.save(waveFilename);
     System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
     System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
-    System.out.printf("-- real-time factor (RTF): %.3f\n", real_time_factor);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
     System.out.printf("-- text: %s\n", text);
     System.out.printf("-- Saved to %s\n", waveFilename);
 
diff --git a/java-api-examples/SupertonicTts.java b/java-api-examples/SupertonicTts.java
@@ -0,0 +1,89 @@
+// Copyright 2026 Xiaomi Corporation
+
+// This file shows how to use a Supertonic TTS English model.
+import com.k2fsa.sherpa.onnx.*;
+import java.util.HashMap;
+import java.util.Map;
+
+public class SupertonicTts {
+  public static void main(String[] args) {
+    LibraryUtils.enableDebug();
+    // please visit
+    // https://k2-fsa.github.io/sherpa/onnx/tts/supertonic.html
+    // to download model files
+    String modelDir = "./sherpa-onnx-supertonic-tts-int8-2026-03-06";
+    String durationPredictor = modelDir + "/duration_predictor.int8.onnx";
+    String textEncoder = modelDir + "/text_encoder.int8.onnx";
+    String vectorEstimator = modelDir + "/vector_estimator.int8.onnx";
+    String vocoder = modelDir + "/vocoder.int8.onnx";
+    String ttsJson = modelDir + "/tts.json";
+    String unicodeIndexer = modelDir + "/unicode_indexer.bin";
+    String voiceStyle = modelDir + "/voice.bin";
+
+    String 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.";
+
+    OfflineTtsSupertonicModelConfig supertonicModelConfig =
+        OfflineTtsSupertonicModelConfig.builder()
+            .setDurationPredictor(durationPredictor)
+            .setTextEncoder(textEncoder)
+            .setVectorEstimator(vectorEstimator)
+            .setVocoder(vocoder)
+            .setTtsJson(ttsJson)
+            .setUnicodeIndexer(unicodeIndexer)
+            .setVoiceStyle(voiceStyle)
+            .build();
+
+    OfflineTtsModelConfig modelConfig =
+        OfflineTtsModelConfig.builder()
+            .setSupertonic(supertonicModelConfig)
+            .setNumThreads(2)
+            .setDebug(true)
+            .build();
+
+    OfflineTtsConfig config = OfflineTtsConfig.builder().setModel(modelConfig).build();
+    OfflineTts tts = new OfflineTts(config);
+
+    GenerationConfig genConfig = new GenerationConfig();
+    genConfig.setSid(6);
+    genConfig.setSpeed(1.25f);
+    genConfig.setNumSteps(5);
+
+    Map<String, String> extra = new HashMap<>();
+    extra.put("lang", "en");
+
+    genConfig.setExtra(extra);
+
+    long start = System.currentTimeMillis();
+    GeneratedAudio audio =
+        tts.generateWithConfigAndCallback(
+            text,
+            genConfig,
+            new OfflineTtsCallback() {
+              @Override
+              public Integer invoke(float[] samples) {
+                System.out.println("callback got called with " + samples.length + " samples");
+                return 1;
+              }
+            });
+
+    long stop = System.currentTimeMillis();
+
+    float timeElapsedSeconds = (stop - start) / 1000.0f;
+
+    float audioDuration = audio.getSamples().length / (float) audio.getSampleRate();
+    float realTimeFactor = timeElapsedSeconds / audioDuration;
+
+    String waveFilename = "supertonic-tts-en.wav";
+    audio.save(waveFilename);
+    System.out.printf("-- elapsed : %.3f seconds\n", timeElapsedSeconds);
+    System.out.printf("-- audio duration: %.3f seconds\n", audioDuration);
+    System.out.printf("-- real-time factor (RTF): %.3f\n", realTimeFactor);
+    System.out.printf("-- text: %s\n", text);
+    System.out.printf("-- Saved to %s\n", waveFilename);
+
+    tts.release();
+  }
+}
diff --git a/java-api-examples/run-supertonic-tts.sh b/java-api-examples/run-supertonic-tts.sh
@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+set -ex
+
+if [[ ! -f ../build/lib/libsherpa-onnx-jni.dylib  && ! -f ../build/lib/libsherpa-onnx-jni.so ]]; then
+  mkdir -p ../build
+  pushd ../build
+  cmake \
+    -DSHERPA_ONNX_ENABLE_PYTHON=OFF \
+    -DSHERPA_ONNX_ENABLE_TESTS=OFF \
+    -DSHERPA_ONNX_ENABLE_CHECK=OFF \
+    -DBUILD_SHARED_LIBS=ON \
+    -DSHERPA_ONNX_ENABLE_PORTAUDIO=OFF \
+    -DSHERPA_ONNX_ENABLE_JNI=ON \
+    ..
+
+  make -j4
+  ls -lh lib
+  popd
+fi
+
+if [ ! -f ../sherpa-onnx/java-api/build/sherpa-onnx.jar ]; then
+  pushd ../sherpa-onnx/java-api
+  make
+  popd
+fi
+
+# please visit
+# https://github.com/k2-fsa/sherpa-onnx/releases/tag/tts-models
+# to download more models
+
+if [ ! -f ./sherpa-onnx-supertonic-tts-int8-2026-03-06/duration_predictor.int8.onnx ]; then
+  curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/sherpa-onnx-supertonic-tts-int8-2026-03-06.tar.bz2
+  tar xvf sherpa-onnx-supertonic-tts-int8-2026-03-06.tar.bz2
+  rm sherpa-onnx-supertonic-tts-int8-2026-03-06.tar.bz2
+fi
+
+java \
+  -Djava.library.path=$PWD/../build/lib \
+  -cp ../sherpa-onnx/java-api/build/sherpa-onnx.jar \
+  SupertonicTts.java
diff --git a/kotlin-api-examples/run.sh b/kotlin-api-examples/run.sh
@@ -57,6 +57,26 @@ function testPocketTts() {
   java -Djava.library.path=../build/lib -jar $out_filename
 }
 
+function testSupertonicTts() {
+  if [ ! -f ./sherpa-onnx-supertonic-tts-int8-2026-03-06/duration_predictor.int8.onnx ]; then
+    curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/tts-models/sherpa-onnx-supertonic-tts-int8-2026-03-06.tar.bz2
+    tar xvf sherpa-onnx-supertonic-tts-int8-2026-03-06.tar.bz2
+    rm sherpa-onnx-supertonic-tts-int8-2026-03-06.tar.bz2
+  fi
+
+  out_filename=test_supertonic_tts.jar
+  kotlinc-jvm -include-runtime -d $out_filename \
+    test_supertonic_tts.kt \
+    Tts.kt \
+    WaveReader.kt \
+    faked-asset-manager.kt \
+    faked-log.kt
+
+  ls -lh $out_filename
+
+  java -Djava.library.path=../build/lib -jar $out_filename
+}
+
 function testSpeakerEmbeddingExtractor() {
   if [ ! -f ./3dspeaker_speech_eres2net_large_sv_zh-cn_3dspeaker_16k.onnx ]; then
     curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/speaker-recongition-models/3dspeaker_speech_eres2net_large_sv_zh-cn_3dspeaker_16k.onnx
@@ -649,6 +669,7 @@ testVersion
 testOfflineMoonshineAsrV2
 testOfflineFireRedAsrCtc
 testPocketTts
+testSupertonicTts
 testOfflineFunAsrNano
 testOfflineMedAsrCtc
 testOfflineOmnilingualAsrCtc
diff --git a/kotlin-api-examples/test_supertonic_tts.kt b/kotlin-api-examples/test_supertonic_tts.kt
diff --git a/sherpa-onnx/java-api/Makefile b/sherpa-onnx/java-api/Makefile
diff --git a/sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/OfflineTtsModelConfig.java b/sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/OfflineTtsModelConfig.java
diff --git a/sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/OfflineTtsSupertonicModelConfig.java b/sherpa-onnx/java-api/src/main/java/com/k2fsa/sherpa/onnx/OfflineTtsSupertonicModelConfig.java
diff --git a/sherpa-onnx/jni/offline-tts.cc b/sherpa-onnx/jni/offline-tts.cc
diff --git a/sherpa-onnx/kotlin-api/Tts.kt b/sherpa-onnx/kotlin-api/Tts.kt
