Add Android TTS demo (#383)

.github/workflows/apk.yaml

@@ -38,6 +38,7 @@ jobs:
         shell: bash
         run: |
           export ANDROID_NDK=$ANDROID_NDK_LATEST_HOME
+          ./build-apk-tts.sh
           ./build-apk-vad.sh
           ./build-apk-two-pass.sh
           ./build-apk.sh

android/SherpaOnnxTts/.gitignore

@@ -0,0 +1,15 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties

android/SherpaOnnxTts/app/.gitignore

@@ -0,0 +1 @@
+/build

android/SherpaOnnxTts/app/build.gradle

@@ -0,0 +1,44 @@
+plugins {
+    id 'com.android.application'
+    id 'org.jetbrains.kotlin.android'
+}
+
+android {
+    namespace 'com.k2fsa.sherpa.onnx'
+    compileSdk 32
+
+    defaultConfig {
+        applicationId "com.k2fsa.sherpa.onnx"
+        minSdk 21
+        targetSdk 32
+        versionCode 1
+        versionName "1.0"
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
+}
+
+dependencies {
+
+    implementation 'com.android.support.constraint:constraint-layout:1.1.3'
+    implementation 'androidx.core:core-ktx:1.7.0'
+    implementation 'com.google.android.material:material:1.9.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
+    testImplementation 'junit:junit:4.13.2'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.5'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
+}

android/SherpaOnnxTts/app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

android/SherpaOnnxTts/app/src/androidTest/java/com/k2fsa/sherpa/onnx/ExampleInstrumentedTest.kt

@@ -0,0 +1,24 @@
+package com.k2fsa.sherpa.onnx
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+    @Test
+    fun useAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        assertEquals("com.k2fsa.sherpa.onnx", appContext.packageName)
+    }
+}

android/SherpaOnnxTts/app/src/main/.gitignore

@@ -0,0 +1,2 @@
+vits-zh-aishell3
+vits-vctk

android/SherpaOnnxTts/app/src/main/AndroidManifest.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
+
+    <application
+        android:allowBackup="true"
+        android:dataExtractionRules="@xml/data_extraction_rules"
+        android:fullBackupContent="@xml/backup_rules"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/Theme.SherpaOnnxTts"
+        tools:targetApi="31">
+        <activity
+            android:name=".MainActivity"
+            android:exported="true">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+
+            <meta-data
+                android:name="android.app.lib_name"
+                android:value="" />
+        </activity>
+    </application>
+
+</manifest>

android/SherpaOnnxTts/app/src/main/java/com/k2fsa/sherpa/onnx/MainActivity.kt

@@ -0,0 +1,113 @@
+package com.k2fsa.sherpa.onnx
+
+import android.media.MediaPlayer
+import android.net.Uri
+import android.os.Bundle
+import android.util.Log
+import android.widget.Button
+import android.widget.EditText
+import android.widget.Toast
+import androidx.appcompat.app.AppCompatActivity
+import java.io.File
+
+const val TAG = "sherpa-onnx"
+
+class MainActivity : AppCompatActivity() {
+    private lateinit var tts: OfflineTts
+    private lateinit var text: EditText
+    private lateinit var sid: EditText
+    private lateinit var speed: EditText
+    private lateinit var generate: Button
+    private lateinit var play: Button
+    private var hasFile: Boolean = false
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_main)
+
+        Log.i(TAG, "Start to initialize TTS")
+        initTts()
+        Log.i(TAG, "Finish initializing TTS")
+
+        text = findViewById(R.id.text)
+        sid = findViewById(R.id.sid)
+        speed = findViewById(R.id.speed)
+
+        generate = findViewById(R.id.generate)
+        play = findViewById(R.id.play)
+
+        generate.setOnClickListener { onClickGenerate() }
+        play.setOnClickListener { onClickPlay() }
+
+        sid.setText("0")
+        speed.setText("1.0")
+
+        // we will change sampleText here in the CI
+        val sampleText = ""
+        text.setText(sampleText)
+
+        play.isEnabled = false;
+    }
+
+    fun onClickGenerate() {
+        val sidInt = sid.text.toString().toIntOrNull()
+        if (sidInt == null || sidInt < 0) {
+            Toast.makeText(
+                applicationContext,
+                "Please input a non-negative integer for speaker ID!",
+                Toast.LENGTH_SHORT
+            ).show()
+            return
+        }
+
+        val speedFloat = speed.text.toString().toFloatOrNull()
+        if (speedFloat == null || speedFloat <= 0) {
+            Toast.makeText(
+                applicationContext,
+                "Please input a positive number for speech speed!",
+                Toast.LENGTH_SHORT
+            ).show()
+            return
+        }
+
+        val textStr = text.text.toString().trim()
+        if (textStr.isBlank() || textStr.isEmpty()) {
+            Toast.makeText(applicationContext, "Please input a non-empty text!", Toast.LENGTH_SHORT)
+                .show()
+            return
+        }
+
+        Toast.makeText(applicationContext, "Generating...Please wait", Toast.LENGTH_LONG).show()
+        val audio = tts.generate(text = textStr, sid = sidInt, speed = speedFloat)
+
+        val filename = application.filesDir.absolutePath + "/generated.wav"
+        val ok = audio.samples.size > 0 && audio.save(filename)
+        if (ok) {
+            play.isEnabled = true
+            Toast.makeText(
+                applicationContext,
+                "Generated! Please click play to listen to it",
+                Toast.LENGTH_LONG
+            ).show()
+        } else {
+            play.isEnabled = false
+        }
+    }
+
+    fun onClickPlay() {
+        val filename = application.filesDir.absolutePath + "/generated.wav"
+        val mediaPlayer = MediaPlayer.create(
+            applicationContext,
+            Uri.fromFile(File(filename))
+        )
+        mediaPlayer.start()
+    }
+
+    fun initTts() {
+        // 0 - vits-vctk (multi-speaker, English)
+        // 1 - vits-zh-aishell3 (multi-speaker, Chinese)
+        val type = 0
+        val config = getOfflineTtsConfig(type = type, debug = true)!!
+        tts = OfflineTts(assetManager = application.assets, config = config)
+    }
+}