Support piper-phonemize (#452)

.github/scripts/test-offline-ctc.sh

@@ -19,10 +19,10 @@ log "------------------------------------------------------------"
 wenet_models=(
 sherpa-onnx-zh-wenet-aishell
 sherpa-onnx-zh-wenet-aishell2
-sherpa-onnx-zh-wenet-wenetspeech
+# sherpa-onnx-zh-wenet-wenetspeech
 sherpa-onnx-zh-wenet-multi-cn
 sherpa-onnx-en-wenet-librispeech
-sherpa-onnx-en-wenet-gigaspeech
+# sherpa-onnx-en-wenet-gigaspeech
 )
 for name in ${wenet_models[@]}; do
   repo_url=https://huggingface.co/csukuangfj/$name

.github/workflows/arm-linux-gnueabihf.yaml

@@ -168,6 +168,9 @@ jobs:
           lib_type=${{ matrix.lib_type }}
           if [[ $lib_type == "shared" ]]; then
             cp -a build-arm-linux-gnueabihf/install/lib $dst/
+            rm -v $dst/lib/libasound.so
+            rm -v $dst/lib/libonnxruntime.so
+            rm -v $dst/lib/libsherpa-onnx-fst.so
           fi
 
           tree $dst

.github/workflows/test-piper-phonemize.yaml

@@ -0,0 +1,82 @@
+name: test-piper-phonemize
+on:
+  push:
+    branches:
+      - master
+
+  workflow_dispatch:
+
+concurrency:
+  group: test-piper-phonemize-${{ github.ref }}
+  cancel-in-progress: true
+
+
+jobs:
+  test_piper_phonemize:
+    name: ${{ matrix.os }} ${{ matrix.build_type }} ${{ matrix.shared_lib }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        build_type: [Release, Debug]
+        shared_lib: [ON, OFF]
+        exclude:
+          - os: windows-latest
+            build_type: Debug
+            shared_lib: OFF
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: ccache
+        uses: hendrikmuhs/[email protected]
+        with:
+          key: ${{ matrix.os }}-${{ matrix.build_type }}-shared-${{ matrix.shared_lib }}
+
+      - name: Configure CMake
+        shell: bash
+        run: |
+          export CMAKE_CXX_COMPILER_LAUNCHER=ccache
+          export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+          cmake --version
+
+          mkdir build
+          cd build
+          cmake -DCMAKE_VERBOSE_MAKEFILE=ON -D SHERPA_ONNX_ENABLE_TESTS=ON -D CMAKE_BUILD_TYPE=${{ matrix.build_type }} -D BUILD_SHARED_LIBS=${{ matrix.shared_lib }} -DCMAKE_INSTALL_PREFIX=./install ..
+
+      - name: Build
+        shell: bash
+        run: |
+          export CMAKE_CXX_COMPILER_LAUNCHER=ccache
+          export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+          cmake --version
+
+          cd build
+          cmake --build . --target install --config ${{ matrix.build_type }}
+
+      - name: run test
+        if: matrix.os != 'windows-latest'
+        shell: bash
+        run: |
+          cd build
+
+          ls -lh install/
+          ls -lh install/share
+          ls -lh install/share/espeak-ng-data/
+
+          ./bin/piper-phonemize-test
+
+      - name: run test
+        if: matrix.os == 'windows-latest'
+        shell: bash
+        run: |
+          cd build
+
+          ls -lh install/
+          ls -lh install/share
+          ls -lh install/share/espeak-ng-data/
+
+          ./bin/${{ matrix.build_type }}/piper-phonemize-test

CMakeLists.txt

@@ -159,6 +159,8 @@ endif()
 include(kaldi-native-fbank)
 include(kaldi-decoder)
 include(onnxruntime)
+set(ONNXRUNTIME_DIR ${onnxruntime_SOURCE_DIR})
+message(STATUS "ONNXRUNTIME_DIR: ${ONNXRUNTIME_DIR}")
 
 if(SHERPA_ONNX_ENABLE_PORTAUDIO)
   include(portaudio)
@@ -178,6 +180,11 @@ if(SHERPA_ONNX_ENABLE_WEBSOCKET)
   include(asio)
 endif()
 
+include(espeak-ng-for-piper)
+set(ESPEAK_NG_DIR ${espeak_ng_SOURCE_DIR})
+message(STATUS "ESPEAK_NG_DIR: ${ESPEAK_NG_DIR}")
+include(piper-phonemize)
+
 add_subdirectory(sherpa-onnx)
 
 if(SHERPA_ONNX_ENABLE_C_API)

build-aarch64-linux-gnu.sh

@@ -45,6 +45,10 @@ if [[ x"$BUILD_SHARED_LIBS" == x"" ]]; then
 fi
 
 cmake \
+  -DBUILD_PIPER_PHONMIZE_EXE=OFF \
+  -DBUILD_PIPER_PHONMIZE_TESTS=OFF \
+  -DBUILD_ESPEAK_NG_EXE=OFF \
+  -DBUILD_ESPEAK_NG_TESTS=OFF \
   -DCMAKE_INSTALL_PREFIX=./install \
   -DCMAKE_BUILD_TYPE=Release \
   -DBUILD_SHARED_LIBS=$BUILD_SHARED_LIBS \

build-android-arm64-v8a.sh

@@ -72,6 +72,10 @@ echo "SHERPA_ONNXRUNTIME_LIB_DIR: $SHERPA_ONNXRUNTIME_LIB_DIR"
 echo "SHERPA_ONNXRUNTIME_INCLUDE_DIR $SHERPA_ONNXRUNTIME_INCLUDE_DIR"
 
 cmake -DCMAKE_TOOLCHAIN_FILE="$ANDROID_NDK/build/cmake/android.toolchain.cmake" \
+    -DBUILD_PIPER_PHONMIZE_EXE=OFF \
+    -DBUILD_PIPER_PHONMIZE_TESTS=OFF \
+    -DBUILD_ESPEAK_NG_EXE=OFF \
+    -DBUILD_ESPEAK_NG_TESTS=OFF \
     -DCMAKE_BUILD_TYPE=Release \
     -DBUILD_SHARED_LIBS=ON \
     -DSHERPA_ONNX_ENABLE_PYTHON=OFF \

build-android-armv7-eabi.sh

@@ -73,6 +73,10 @@ echo "SHERPA_ONNXRUNTIME_LIB_DIR: $SHERPA_ONNXRUNTIME_LIB_DIR"
 echo "SHERPA_ONNXRUNTIME_INCLUDE_DIR $SHERPA_ONNXRUNTIME_INCLUDE_DIR"
 
 cmake -DCMAKE_TOOLCHAIN_FILE="$ANDROID_NDK/build/cmake/android.toolchain.cmake" \
+    -DBUILD_PIPER_PHONMIZE_EXE=OFF \
+    -DBUILD_PIPER_PHONMIZE_TESTS=OFF \
+    -DBUILD_ESPEAK_NG_EXE=OFF \
+    -DBUILD_ESPEAK_NG_TESTS=OFF \
     -DCMAKE_BUILD_TYPE=Release \
     -DBUILD_SHARED_LIBS=ON \
     -DSHERPA_ONNX_ENABLE_PYTHON=OFF \

build-android-x86-64.sh

@@ -73,6 +73,10 @@ echo "SHERPA_ONNXRUNTIME_LIB_DIR: $SHERPA_ONNXRUNTIME_LIB_DIR"
 echo "SHERPA_ONNXRUNTIME_INCLUDE_DIR $SHERPA_ONNXRUNTIME_INCLUDE_DIR"
 
 cmake -DCMAKE_TOOLCHAIN_FILE="$ANDROID_NDK/build/cmake/android.toolchain.cmake" \
+    -DBUILD_PIPER_PHONMIZE_EXE=OFF \
+    -DBUILD_PIPER_PHONMIZE_TESTS=OFF \
+    -DBUILD_ESPEAK_NG_EXE=OFF \
+    -DBUILD_ESPEAK_NG_TESTS=OFF \
     -DCMAKE_BUILD_TYPE=Release \
     -DBUILD_SHARED_LIBS=ON \
     -DSHERPA_ONNX_ENABLE_PYTHON=OFF \

build-android-x86.sh

@@ -73,6 +73,10 @@ echo "SHERPA_ONNXRUNTIME_LIB_DIR: $SHERPA_ONNXRUNTIME_LIB_DIR"
 echo "SHERPA_ONNXRUNTIME_INCLUDE_DIR $SHERPA_ONNXRUNTIME_INCLUDE_DIR"
 
 cmake -DCMAKE_TOOLCHAIN_FILE="$ANDROID_NDK/build/cmake/android.toolchain.cmake" \
+    -DBUILD_PIPER_PHONMIZE_EXE=OFF \
+    -DBUILD_PIPER_PHONMIZE_TESTS=OFF \
+    -DBUILD_ESPEAK_NG_EXE=OFF \
+    -DBUILD_ESPEAK_NG_TESTS=OFF \
     -DCMAKE_BUILD_TYPE=Release \
     -DBUILD_SHARED_LIBS=ON \
     -DSHERPA_ONNX_ENABLE_PYTHON=OFF \

build-arm-linux-gnueabihf.sh

@@ -40,6 +40,10 @@ if [[ x"$BUILD_SHARED_LIBS" == x"" ]]; then
 fi
 
 cmake \
+  -DBUILD_PIPER_PHONMIZE_EXE=OFF \
+  -DBUILD_PIPER_PHONMIZE_TESTS=OFF \
+  -DBUILD_ESPEAK_NG_EXE=OFF \
+  -DBUILD_ESPEAK_NG_TESTS=OFF \
   -DCMAKE_INSTALL_PREFIX=./install \
   -DCMAKE_BUILD_TYPE=Release \
   -DBUILD_SHARED_LIBS=$BUILD_SHARED_LIBS \

build-ios.sh

@@ -51,6 +51,10 @@ echo "SHERPA_ONNXRUNTIME_INCLUDE_DIR $SHERPA_ONNXRUNTIME_INCLUDE_DIR"
 #
 
 cmake \
+  -DBUILD_PIPER_PHONMIZE_EXE=OFF \
+  -DBUILD_PIPER_PHONMIZE_TESTS=OFF \
+  -DBUILD_ESPEAK_NG_EXE=OFF \
+  -DBUILD_ESPEAK_NG_TESTS=OFF \
   -S .. \
   -DCMAKE_TOOLCHAIN_FILE=./toolchains/ios.toolchain.cmake \
   -DPLATFORM=SIMULATOR64 \
@@ -74,6 +78,10 @@ cmake --build build/simulator_x86_64 -j 4 --verbose
 echo "Building for simulator (arm64)"
 
 cmake \
+  -DBUILD_PIPER_PHONMIZE_EXE=OFF \
+  -DBUILD_PIPER_PHONMIZE_TESTS=OFF \
+  -DBUILD_ESPEAK_NG_EXE=OFF \
+  -DBUILD_ESPEAK_NG_TESTS=OFF \
   -S .. \
   -DCMAKE_TOOLCHAIN_FILE=./toolchains/ios.toolchain.cmake \
   -DPLATFORM=SIMULATORARM64 \
@@ -101,6 +109,10 @@ export SHERPA_ONNXRUNTIME_LIB_DIR=$PWD/ios-onnxruntime/onnxruntime.xcframework/i
 
 
 cmake \
+  -DBUILD_PIPER_PHONMIZE_EXE=OFF \
+  -DBUILD_PIPER_PHONMIZE_TESTS=OFF \
+  -DBUILD_ESPEAK_NG_EXE=OFF \
+  -DBUILD_ESPEAK_NG_TESTS=OFF \
   -S .. \
   -DCMAKE_TOOLCHAIN_FILE=./toolchains/ios.toolchain.cmake \
   -DPLATFORM=OS64 \

cmake/espeak-ng-for-piper.cmake

@@ -0,0 +1,127 @@
+function(download_espeak_ng_for_piper)
+  include(FetchContent)
+
+  set(espeak_ng_URL  "https://github.com/csukuangfj/espeak-ng/archive/c58d2a4a88e9a291ca448f046e15c6188cbd3b3a.zip")
+  set(espeak_ng_URL2 "")
+  set(espeak_ng_HASH "SHA256=8a48251e6926133dd91fcf6cb210c7c2e290a9b578d269446e2d32d710b0dfa0")
+
+  set(USE_ASYNC OFF CACHE BOOL "" FORCE)
+  set(USE_MBROLA OFF CACHE BOOL "" FORCE)
+  set(USE_LIBSONIC OFF CACHE BOOL "" FORCE)
+  set(USE_LIBPCAUDIO OFF CACHE BOOL "" FORCE)
+  set(USE_KLATT OFF CACHE BOOL "" FORCE)
+  set(USE_SPEECHPLAYER OFF CACHE BOOL "" FORCE)
+  set(EXTRA_cmn ON CACHE BOOL "" FORCE)
+  set(EXTRA_ru ON CACHE BOOL "" FORCE)
+
+  # If you don't have access to the Internet,
+  # please pre-download kaldi-decoder
+  set(possible_file_locations
+    $ENV{HOME}/Downloads/espeak-ng-c58d2a4a88e9a291ca448f046e15c6188cbd3b3a.zip
+    ${PROJECT_SOURCE_DIR}/espeak-ng-c58d2a4a88e9a291ca448f046e15c6188cbd3b3a.zip
+    ${PROJECT_BINARY_DIR}/espeak-ng-c58d2a4a88e9a291ca448f046e15c6188cbd3b3a.zip
+    /tmp/espeak-ng-c58d2a4a88e9a291ca448f046e15c6188cbd3b3a.zip
+    /star-fj/fangjun/download/github/espeak-ng-c58d2a4a88e9a291ca448f046e15c6188cbd3b3a.zip
+  )
+
+  foreach(f IN LISTS possible_file_locations)
+    if(EXISTS ${f})
+      set(espeak_ng_URL  "${f}")
+      file(TO_CMAKE_PATH "${espeak_ng_URL}" espeak_ng_URL)
+      message(STATUS "Found local downloaded espeak-ng: ${espeak_ng_URL}")
+      set(espeak_ng_URL2 )
+      break()
+    endif()
+  endforeach()
+
+  FetchContent_Declare(espeak_ng
+    URL
+      ${espeak_ng_URL}
+      ${espeak_ng_URL2}
+    URL_HASH          ${espeak_ng_HASH}
+  )
+
+  FetchContent_GetProperties(espeak_ng)
+  if(NOT espeak_ng_POPULATED)
+    message(STATUS "Downloading espeak-ng from ${espeak_ng_URL}")
+    FetchContent_Populate(espeak_ng)
+  endif()
+  message(STATUS "espeak-ng is downloaded to ${espeak_ng_SOURCE_DIR}")
+  message(STATUS "espeak-ng binary dir is ${espeak_ng_BINARY_DIR}")
+
+  add_subdirectory(${espeak_ng_SOURCE_DIR} ${espeak_ng_BINARY_DIR})
+  set(espeak_ng_SOURCE_DIR ${espeak_ng_SOURCE_DIR} PARENT_SCOPE)
+
+  if(WIN32 AND MSVC)
+    target_compile_options(ucd PUBLIC
+      /wd4309
+    )
+
+    target_compile_options(espeak-ng PUBLIC
+      /wd4005
+      /wd4018
+      /wd4067
+      /wd4068
+      /wd4090
+      /wd4101
+      /wd4244
+      /wd4267
+      /wd4996
+    )
+
+    if(TARGET espeak-ng-bin)
+      target_compile_options(espeak-ng-bin PRIVATE
+        /wd4244
+        /wd4024
+        /wd4047
+        /wd4067
+        /wd4267
+        /wd4996
+      )
+    endif()
+  endif()
+
+  if(UNIX AND NOT APPLE)
+    target_compile_options(espeak-ng PRIVATE
+      -Wno-unused-result
+      -Wno-format-overflow
+      -Wno-format-truncation
+      -Wno-maybe-uninitialized
+      -Wno-format
+    )
+
+    if(TARGET espeak-ng-bin)
+      target_compile_options(espeak-ng-bin PRIVATE
+        -Wno-unused-result
+      )
+    endif()
+  endif()
+
+  target_include_directories(espeak-ng
+    INTERFACE
+      ${espeak_ng_SOURCE_DIR}/src/include
+      ${espeak_ng_SOURCE_DIR}/src/ucd-tools/src/include
+  )
+
+  if(SHERPA_ONNX_ENABLE_PYTHON AND WIN32)
+    install(TARGETS
+      espeak-ng
+    DESTINATION ..)
+  else()
+    install(TARGETS
+      espeak-ng
+    DESTINATION lib)
+  endif()
+
+  if(NOT BUILD_SHARED_LIBS)
+    install(TARGETS ucd DESTINATION lib)
+  endif()
+
+  if(WIN32 AND BUILD_SHARED_LIBS)
+    install(TARGETS
+      espeak-ng
+    DESTINATION bin)
+  endif()
+endfunction()
+
+download_espeak_ng_for_piper()

cmake/kaldi-decoder.cmake

@@ -47,6 +47,13 @@ function(download_kaldi_decoder)
   include_directories(${kaldi_decoder_SOURCE_DIR})
   add_subdirectory(${kaldi_decoder_SOURCE_DIR} ${kaldi_decoder_BINARY_DIR} EXCLUDE_FROM_ALL)
 
+  if(WIN32 AND MSVC)
+    target_compile_options(kaldi-decoder-core PUBLIC
+      /wd4018
+      /wd4291
+    )
+  endif()
+
   target_include_directories(kaldi-decoder-core
     INTERFACE
       ${kaldi-decoder_SOURCE_DIR}/

cmake/onnxruntime.cmake

@@ -94,6 +94,7 @@ function(download_onnxruntime)
     message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
     message(FATAL_ERROR "Only support Linux, macOS, and Windows at present. Will support other OSes later")
   endif()
+  set(onnxruntime_SOURCE_DIR ${onnxruntime_SOURCE_DIR} PARENT_SCOPE)
 endfunction()
 
 # First, we try to locate the header and the lib if the use has already