Multilingual demos (#85)

Author: albho

.github/workflows/dotnet-demos.yml

@@ -45,10 +45,21 @@ jobs:
       run: dotnet build -c StreamingDemo.Release
 
     - name: Run .NET file demo
-      run: dotnet run -c FileDemo.Release -- --access_key ${{secrets.PV_VALID_ACCESS_KEY}} --text "Hello, I am Orca!" --output_path ./tmp.wav
+      run: >
+        dotnet run -c FileDemo.Release --
+        --access_key ${{secrets.PV_VALID_ACCESS_KEY}}
+        --language en
+        --gender female
+        --text "Hello, I am Orca!"
+        --output_path ./tmp.wav
 
     - name: Run .NET streaming demo
-      run: dotnet run -c StreamingDemo.Release -- --access_key ${{secrets.PV_VALID_ACCESS_KEY}} --text_to_stream "Hello, I am Orca!"
+      run: >
+        dotnet run -c StreamingDemo.Release --
+        --access_key ${{secrets.PV_VALID_ACCESS_KEY}}
+        --language en
+        --gender female
+        --text_to_stream "Hello, I am Orca!"
 
   build-self-hosted:
     runs-on: ${{ matrix.machine }}
@@ -70,7 +81,18 @@ jobs:
       run: dotnet build -c StreamingDemo.Release
 
     - name: Run .NET file demo
-      run: dotnet run -c FileDemo.Release -- --access_key ${{secrets.PV_VALID_ACCESS_KEY}} --text "Hello, I am Orca!" --output_path ./tmp.wav
+      run: >
+        dotnet run -c FileDemo.Release --
+        --access_key ${{secrets.PV_VALID_ACCESS_KEY}}
+        --language en
+        --gender female
+        --text "Hello, I am Orca!"
+        --output_path ./tmp.wav
 
     - name: Run .NET streaming demo
-      run: dotnet run -c StreamingDemo.Release -- --access_key ${{secrets.PV_VALID_ACCESS_KEY}} --text_to_stream "Hello, I am Orca!"
+      run: >
+        dotnet run -c StreamingDemo.Release --
+        --access_key ${{secrets.PV_VALID_ACCESS_KEY}}
+        --language en
+        --gender female
+        --text_to_stream "Hello, I am Orca!"

.github/workflows/ios-demos.yml

@@ -26,11 +26,20 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: Build Demo
+      - name: Build English
         run: xcrun xcodebuild build
           -configuration Debug
           -project OrcaDemo.xcodeproj
           -sdk iphoneos
-          -scheme OrcaDemo
+          -scheme enFemaleDemo
           -derivedDataPath ddp
           CODE_SIGNING_ALLOWED=NO
+
+      - name: Build Other Language
+        run: xcrun xcodebuild build
+          -configuration Debug
+          -project OrcaDemo.xcodeproj
+          -sdk iphoneos
+          -scheme frMaleDemo
+          -derivedDataPath ddp
+          CODE_SIGNING_ALLOWED=NO

.github/workflows/nodejs-demos.yml

@@ -49,10 +49,10 @@ jobs:
           yarn install
 
       - name: Test streaming
-        run: yarn streaming -a ${{secrets.PV_VALID_ACCESS_KEY}} -t "Hello, I am Orca!"
+        run: yarn streaming -a ${{secrets.PV_VALID_ACCESS_KEY}} -m ../../lib/common/orca_params_en_female.pv -t "Hello, I am Orca!"
 
       - name: Test file
-        run: yarn file -a ${{secrets.PV_VALID_ACCESS_KEY}} -t "Hello, I am Orca!" -o "./tmp.wav"
+        run: yarn file -a ${{secrets.PV_VALID_ACCESS_KEY}} -m ../../lib/common/orca_params_en_female.pv -t "Hello, I am Orca!" -o "./tmp.wav"
 
   build-self-hosted:
     runs-on: ${{ matrix.machine }}
@@ -68,7 +68,7 @@ jobs:
         run: yarn install
 
       - name: Test streaming
-        run: yarn streaming -a ${{secrets.PV_VALID_ACCESS_KEY}} -t "Hello, I am Orca!"
+        run: yarn streaming -a ${{secrets.PV_VALID_ACCESS_KEY}} -m ../../lib/common/orca_params_en_female.pv -t "Hello, I am Orca!"
 
       - name: Test file
-        run: yarn file -a ${{secrets.PV_VALID_ACCESS_KEY}} -t "Hello, I am Orca!" -o "./tmp.wav"
+        run: yarn file -a ${{secrets.PV_VALID_ACCESS_KEY}} -m ../../lib/common/orca_params_en_female.pv -t "Hello, I am Orca!" -o "./tmp.wav"

.github/workflows/python-demo.yml

@@ -54,13 +54,15 @@ jobs:
           python3 orca_demo_streaming.py
           --access_key ${{secrets.PV_VALID_ACCESS_KEY}}
           --text_to_stream "Hello, I am Orca!"
+          --model_path ../../lib/common/orca_params_en_female.pv
 
       - name: Test single
         run: >
           python3 orca_demo.py
           --access_key ${{secrets.PV_VALID_ACCESS_KEY}}
           --text "Hello, I am Orca!"
           --output_path ./tmp.wav
+          --model_path ../../lib/common/orca_params_en_female.pv
 
   build-self-hosted:
     runs-on: ${{ matrix.machine }}
@@ -80,10 +82,12 @@ jobs:
           python3 orca_demo_streaming.py
           --access_key ${{secrets.PV_VALID_ACCESS_KEY}}
           --text_to_stream "Hello, I am Orca!"
+          --model_path ../../lib/common/orca_params_en_female.pv
 
       - name: Test single
         run: >
           python3 orca_demo.py
           --access_key ${{secrets.PV_VALID_ACCESS_KEY}}
           --text "Hello, I am Orca!"
           --output_path ./tmp.wav
+          --model_path ../../lib/common/orca_params_en_female.pv

README.md

@@ -145,16 +145,16 @@ pip3 install pvorcademo
 Run the streaming demo:
 
 ```console
-orca_demo_streaming --access_key ${ACCESS_KEY} --text_to_stream ${TEXT}
+orca_demo_streaming --access_key ${ACCESS_KEY} --model_path ${MODEL_PATH} --text_to_stream ${TEXT}
 ```
 
 Run the single synthesis demo:
 
 ```console
-orca_demo --access_key ${ACCESS_KEY} --text ${TEXT} --output_path ${WAV_OUTPUT_PATH}
+orca_demo --access_key ${ACCESS_KEY} --model_path ${MODEL_PATH} --text ${TEXT} --output_path ${WAV_OUTPUT_PATH}
 ```
 
-Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console, `${TEXT}` with the text to be synthesized, and
+Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console, `${MODEL_PATH}` with a path to any of the model files available under [lib/common](lib/common), `${TEXT}` with the text to be synthesized, and
 `${WAV_OUTPUT_PATH}` with a path to an output WAV file.
 
 For more information about Python demos go to [demo/python](demo/python).
@@ -170,13 +170,13 @@ dotnet build -c StreamingDemo.Release
 Run the streaming demo:
 
 ```console
-dotnet build -c StreamingDemo.Release -- --access_key ${ACCESS_KEY} --text_to_stream ${TEXT}
+dotnet build -c StreamingDemo.Release -- --access_key ${ACCESS_KEY} --language ${LANGUAGE} --gender ${GENDER} --text_to_stream ${TEXT}
 ```
 
 Run the single synthesis demo:
 
 ```console
-dotnet build -c FileDemo.Release -- --access_key ${ACCESS_KEY} --text ${TEXT} --output_path ${WAV_OUTPUT_PATH}
+dotnet build -c FileDemo.Release -- --access_key ${ACCESS_KEY} --language ${LANGUAGE} --gender ${GENDER} --text ${TEXT} --output_path ${WAV_OUTPUT_PATH}
 ```
 
 Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console, `${TEXT}` with the text to be synthesized, and
@@ -186,16 +186,11 @@ For more information about .NET demos go to [demo/dotnet](demo/dotnet).
 
 ### iOS Demo
 
-Run the following from [demo/ios](demo/ios) to install the Orca-iOS CocoaPod:
-
-```console
-pod install
-```
-
-Replace `let ACCESS_KEY = "..."` inside [ViewModel.swift](demo/ios/OrcaDemo/OrcaDemo/ViewModel.swift) with yours
-obtained from [Picovoice Console](https://console.picovoice.ai/).
-
-Then, using Xcode, open the generated OrcaDemo.xcworkspace and run the application.
+1. Open [OrcaDemo.xcodeproj](demo/ios/OrcaDemo/OrcaDemo.xcodeproj) in XCode.
+2. Replace `${YOUR_ACCESS_KEY_HERE}` in the file [`ViewModel.swift`](demo/ios/OrcaDemo/OrcaDemo/ViewModel.swift) with your `AccessKey`.
+3. Go to `Product > Scheme` and select the scheme for the language and gender you would like to run the demo in (e.g. `enFemaleDemo` -> English Demo with a female voice, `deMaleDemo` -> German demo with a male voice).
+4. Run the demo with a simulator or connected iOS device.
+5. Once the demo app has started, enter the text you wish to synthesize in the text box area, and press the `Synthesize` button to synthesize the text and play audio.
 
 For more information about iOS demos go to [demo/ios](demo/ios).
 
@@ -213,33 +208,45 @@ Run the demo:
 ./demo/c/build/orca_demo_streaming -l ${LIBRARY_PATH} -m ${MODEL_PATH} -a ${ACCESS_KEY} -t ${TEXT} -o ${OUTPUT_PATH}
 ```
 
+For more information about C demos go to [demo/c](demo/c).
+
 ### Web Demos
 
 From [demo/web](./demo/web) run the following in the terminal:
 
 ```console
 yarn
-yarn start
+yarn start ${LANGUAGE} ${GENDER}
 ```
 
 (or)
 
 ```console
 npm install
-npm run start
+npm run start ${LANGUAGE} ${GENDER}
 ```
 
+Replace `${LANGUAGE}` and `${GENDER}` with the language and gender you would like to run the demo in. 
+Available languages are `en`, `es`, `de`, `fr`, `ko`, `ja`, `it`, `pt`, and available genders are `male` and `female`.
+
 Open `http://localhost:5000` in your browser to try the demo.
 
+For more information about Web demos go to [demo/web](demo/web).
+
 ### Android Demo
 
-Using Android Studio, open [demo/android/OrcaDemo](./demo/android/OrcaDemo) as an Android project and then run the
-application.
+Using Android Studio, open [demo/android/OrcaDemo](./demo/android/OrcaDemo) as an Android project.
 
 Replace `"${YOUR_ACCESS_KEY_HERE}"` in the
 file [MainActivity.java](./demo/android/OrcaDemo/orca-demo-app/src/main/java/ai/picovoice/orcademo/MainActivity.java)
 with your `AccessKey`.
 
+Go to `Build > Select Build Variant...` and select the language and gender you would like to run the demo in (e.g. `enFemaleDebug` -> English Demo with a female voice, `deMaleRelease` -> German Demo with a male voice).
+
+Build and run on an installed simulator or a connected Android device.
+
+For more information about Android demos go to [demo/android](demo/android).
+
 ### Node.js Demos
 
 Install the demo package:
@@ -251,19 +258,18 @@ yarn global add @picovoice/orca-node-demo
 Run the streaming demo:
 
 ```console
-orca-streaming-demo --access_key ${ACCESS_KEY} --text_to_stream ${TEXT}
+orca-streaming-demo --access_key ${ACCESS_KEY} --model_file_path ${MODEL_FILE_PATH} --text_to_stream ${TEXT}
 ```
 
 Run the file demo:
 
 ```console
-orca-file-demo --access_key ${ACCESS_KEY} --text ${TEXT} --output_path ${AUDIO_PATH}
+orca-file-demo --access_key ${ACCESS_KEY} --model_file_path ${MODEL_FILE_PATH} --text ${TEXT} --output_path ${AUDIO_PATH}
 ```
 
-Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console, `${TEXT}` with the text to be synthesized, and
-`${AUDIO_PATH}` with a path to an output WAV file.
+Replace `${ACCESS_KEY}` with yours obtained from Picovoice Console, `${MODEL_FILE_PATH}` with a path to any of the model files available under [lib/common](lib/common), `${TEXT}` with your text to be synthesized, and `${WAV_OUTPUT_PATH}` with a path to a `.wav` file where the generated audio will be stored as a single-channel, 16-bit PCM `.wav` file.
 
-For more information about Node.js demos go to [demo/nodejs](./demo/nodejs).
+For more information about Node.js demos go to [demo/nodejs](demo/nodejs).
 
 ## SDKs
 

demo/android/OrcaDemo/README.md

@@ -9,16 +9,13 @@ Signup or Login to [Picovoice Console](https://console.picovoice.ai/) to get you
 
 ## Setup
 
-Replace `"${YOUR_ACCESS_KEY_HERE}"`
-inside [MainActivity.java](orca-demo-app/src/main/java/ai/picovoice/orcademo/MainActivity.java)
-with your AccessKey obtained from [Picovoice Console](https://console.picovoice.ai/).
-
 1. Open the project in Android Studio
-2. Build and run on an installed simulator or a connected Android device
+2. Replace `${YOUR_ACCESS_KEY_HERE}` in the file [MainActivity.java](./orca-demo-app/src/main/java/ai/picovoice/orcademo/MainActivity.java) with your `AccessKey`.
+3. Go to `Build > Select Build Variant...` and select the language and gender you would like to run the demo in (e.g. `enFemaleDebug` -> English Demo with a female voice, `deMaleRelease` -> German Demo with a male voice)
+4. Build and run on an installed simulator or a connected Android device
 
 ## Usage
 
 1. Choose between Streaming Synthesis and Single Synthesis using the switch at the top.
 2. Type a phrase that you'd like to synthesize into the textbox.
-3. Press the `Synthesize` button to hear the synthesized speech.
-
+3. Press the `Synthesize` button to hear the synthesized speech.

demo/android/OrcaDemo/orca-demo-app/build.gradle

@@ -1,3 +1,5 @@
+import groovy.json.JsonSlurper
+
 apply plugin: 'com.android.application'
 
 android {
@@ -20,6 +22,51 @@ android {
         }
     }
 
+    def testDataFile = file('../../../../resources/.test/test_data.json')
+    def parsedJson = new JsonSlurper().parseText(testDataFile.text)
+    def models = []
+    parsedJson.tests.sentence_tests.each { test ->
+        test.models.each { m ->
+            def (language, gender) = m.replace("orca_params_", "").replace(".pv", "").split("_")
+            def flavor = "${language}${gender.capitalize()}"
+            models.add(flavor)
+        }
+    }
+
+    flavorDimensions "model"
+    productFlavors {
+        if (agpVersion.tokenize('.')[0].toInteger() >= 7) {
+            enFemale {
+                getIsDefault().set(true)
+            }
+        }
+
+        models.each { model ->
+            "$model" {
+                applicationIdSuffix ".$model"
+            }
+        }
+
+        all { flavor ->
+            delete fileTree("$projectDir/src/main/assets") {
+                exclude '**/.gitkeep'
+            }
+
+            def language = flavor.name.substring(0, 2)
+            def gender = flavor.name.substring(2)
+            def modelName = "orca_params_" + language + "_" + gender.toLowerCase() + ".pv"
+            def modelFile = file("$projectDir/../../../../lib/common/$modelName")
+
+            if (modelFile.exists()) {
+                task("${flavor.name}CopyParams", type: Copy) {
+                    from(modelFile.parent)
+                    include(modelName)
+                    into("$projectDir/src/${flavor.name}/assets/models")
+                }
+            }
+        }
+    }
+
     buildFeatures {
         buildConfig true
     }
@@ -42,10 +89,34 @@ dependencies {
     implementation 'ai.picovoice:orca-android:1.1.1'
 }
 
-tasks.register('copyParams', Copy) {
-    from("${rootDir}/../../../lib/common")
-    include('orca_params_en_female.pv')
-    into("${rootDir}/orca-demo-app/src/main/assets")
-}
+afterEvaluate {
+    android.productFlavors.all {
+        flavor ->
+            tasks."merge${flavor.name.capitalize()}DebugAssets".dependsOn "${flavor.name}CopyParams"
+            tasks."merge${flavor.name.capitalize()}ReleaseAssets".dependsOn "${flavor.name}CopyParams"
 
-preBuild.dependsOn(copyParams)
+            def generateDebugLintReportModelTask = tasks.findByName(
+                    "generate${flavor.name.capitalize()}DebugLintReportModel")
+            if (generateDebugLintReportModelTask) {
+                generateDebugLintReportModelTask.dependsOn "${flavor.name}CopyParams"
+            }
+
+            def generateReleaseLintVitalReportModelTask = tasks.findByName(
+                    "generate${flavor.name.capitalize()}ReleaseLintVitalReportModel")
+            if (generateReleaseLintVitalReportModelTask) {
+                generateReleaseLintVitalReportModelTask.dependsOn "${flavor.name}CopyParams"
+            }
+
+            def lintAnalyzeDebugTask = tasks.findByName(
+                    "lintAnalyze${flavor.name.capitalize()}Debug")
+            if (lintAnalyzeDebugTask) {
+                lintAnalyzeDebugTask.dependsOn "${flavor.name}CopyParams"
+            }
+
+            def lintVitalAnalyzeReleaseTask = tasks.findByName(
+                    "lintVitalAnalyze${flavor.name.capitalize()}Release")
+            if (lintVitalAnalyzeReleaseTask) {
+                lintVitalAnalyzeReleaseTask.dependsOn "${flavor.name}CopyParams"
+            }
+    }
+}