Build sherpa-onnx as a single shared library (#1078)

When `-D BUILD_SHARED_LIBS=ON` is passed to `cmake`, it builds a single shared library. Specifically, - For C APIs, it builds `libsherpa-onnx-c-api.so` - For Python APIs, it builds `_sherpa_onnx.cpython-xx-xx.so` - For Kotlin and Java APIs, it builds `libsherpa-onnx-jni.so` There is no `libsherpa-onnx-core.so` any longer. Note it affects only shared libraries.
k2-fsa · Jul 6, 2024 · a250751 · a250751
1 parent 55decb7
commit a250751
Show file tree

Hide file tree

Showing 69 changed files with 570 additions and 323 deletions.
diff --git a/.github/scripts/test-dart.sh b/.github/scripts/test-dart.sh
@@ -6,17 +6,6 @@ cd dart-api-examples
 
 pushd non-streaming-asr
 
-echo '----------paraformer itn----------'
-./run-paraformer-itn.sh
-
-echo '----------paraformer----------'
-./run-paraformer.sh
-rm -rf sherpa-onnx-*
-
-echo '----------VAD with paraformer----------'
-./run-vad-with-paraformer.sh
-rm -rf sherpa-onnx-*
-
 echo '----------NeMo transducer----------'
 ./run-nemo-transducer.sh
 rm -rf sherpa-onnx-*
@@ -37,6 +26,17 @@ echo '----------zipformer transducer----------'
 ./run-zipformer-transducer.sh
 rm -rf sherpa-onnx-*
 
+echo '----------paraformer itn----------'
+./run-paraformer-itn.sh
+
+echo '----------paraformer----------'
+./run-paraformer.sh
+rm -rf sherpa-onnx-*
+
+echo '----------VAD with paraformer----------'
+./run-vad-with-paraformer.sh
+rm -rf sherpa-onnx-*
+
 popd # non-streaming-asr
 
 pushd tts

diff --git a/.github/workflows/flutter-linux.yaml b/.github/workflows/flutter-linux.yaml
@@ -32,6 +32,7 @@ concurrency:
 
 jobs:
   flutter_linux:
+    if: false
     name: linux
     runs-on: ${{ matrix.os }}
     container: ubuntu:18.04
@@ -49,7 +50,7 @@ jobs:
         shell: bash
         run: |
           apt-get update -y
-          apt-get install -y build-essential jq git cmake 
+          apt-get install -y build-essential jq git cmake
           apt-get install -y curl
 
       - name: Setup Flutter SDK

diff --git a/.github/workflows/jni.yaml b/.github/workflows/jni.yaml
@@ -37,7 +37,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, macos-14]
+        os: [ubuntu-latest, macos-latest, macos-13]
 
     steps:
       - uses: actions/checkout@v4

diff --git a/.github/workflows/linux-gpu.yaml b/.github/workflows/linux-gpu.yaml
@@ -72,7 +72,12 @@ jobs:
 
           mkdir build
           cd build
-          cmake -D CMAKE_BUILD_TYPE=${{ matrix.build_type }} -DCMAKE_INSTALL_PREFIX=./install -DBUILD_SHARED_LIBS=ON -DSHERPA_ONNX_ENABLE_GPU=ON ..
+          cmake \
+            -D CMAKE_BUILD_TYPE=${{ matrix.build_type }} \
+            -D CMAKE_INSTALL_PREFIX=./install \
+            -D BUILD_SHARED_LIBS=ON \
+            -D SHERPA_ONNX_ENABLE_GPU=ON \
+            ..
 
       - name: Build sherpa-onnx for ubuntu
         shell: bash
@@ -86,6 +91,12 @@ jobs:
           ls -lh lib
           ls -lh bin
 
+          echo "----"
+          ls -lh install/lib
+
+          echo "----"
+          ls -lh install/bin
+
       - name: Display dependencies of sherpa-onnx for linux
         shell: bash
         run: |

diff --git a/.github/workflows/linux-jni.yaml b/.github/workflows/linux-jni.yaml
@@ -95,7 +95,13 @@ jobs:
               mkdir build
               cd build
 
-              cmake -DSHERPA_ONNX_ENABLE_TTS=ON -D CMAKE_BUILD_TYPE=Release -D BUILD_SHARED_LIBS=ON -DCMAKE_INSTALL_PREFIX=./install -DSHERPA_ONNX_ENABLE_JNI=ON ..
+              cmake \
+                -D SHERPA_ONNX_ENABLE_TTS=ON \
+                -D CMAKE_BUILD_TYPE=Release \
+                -D BUILD_SHARED_LIBS=ON \
+                -D CMAKE_INSTALL_PREFIX=./install \
+                -D SHERPA_ONNX_ENABLE_JNI=ON \
+                ..
 
               make -j2
               make install
@@ -105,6 +111,12 @@ jobs:
               rm -rf ./install/pkgconfig
               rm -rf ./install/share
 
+              echo "----"
+              ls -lh install/lib
+
+              echo "----"
+              ls -lh install/bin
+
       - name: Display dependencies of sherpa-onnx for linux
         shell: bash
         run: |

diff --git a/.github/workflows/linux.yaml b/.github/workflows/linux.yaml
@@ -99,14 +99,25 @@ jobs:
               mkdir build
               cd build
 
-              cmake -DSHERPA_ONNX_ENABLE_TTS=${{ matrix.with_tts }} -D CMAKE_BUILD_TYPE=${{ matrix.build_type }} -D BUILD_SHARED_LIBS=${{ matrix.shared_lib }} -DCMAKE_INSTALL_PREFIX=./install ..
+              cmake \
+                -D SHERPA_ONNX_ENABLE_TTS=${{ matrix.with_tts }} \
+                -D CMAKE_BUILD_TYPE=${{ matrix.build_type }} \
+                -D BUILD_SHARED_LIBS=${{ matrix.shared_lib }} \
+                -D CMAKE_INSTALL_PREFIX=./install \
+                ..
 
               make -j2
               make install
 
               ls -lh lib
               ls -lh bin
 
+              echo "----"
+              ls -lh install/lib
+
+              echo "----"
+              ls -lh install/bin
+
       - name: Display dependencies of sherpa-onnx for linux
         shell: bash
         run: |

diff --git a/.github/workflows/macos-jni.yaml b/.github/workflows/macos-jni.yaml
@@ -52,8 +52,8 @@ jobs:
           cmake \
             -D BUILD_SHARED_LIBS=ON \
             -D CMAKE_BUILD_TYPE=Release \
-            -DCMAKE_OSX_ARCHITECTURES=$arch \
-            -DSHERPA_ONNX_ENABLE_JNI=ON \
+            -D CMAKE_OSX_ARCHITECTURES=$arch \
+            -D SHERPA_ONNX_ENABLE_JNI=ON \
             -DCMAKE_INSTALL_PREFIX=./install \
             ..
 

diff --git a/.github/workflows/macos.yaml b/.github/workflows/macos.yaml
@@ -84,7 +84,13 @@ jobs:
             BUILD_SHARED_LIBS=ON
           fi
 
-          cmake -DSHERPA_ONNX_ENABLE_TTS=${{ matrix.with_tts }} -D BUILD_SHARED_LIBS=$BUILD_SHARED_LIBS -D CMAKE_BUILD_TYPE=${{ matrix.build_type }} -DCMAKE_OSX_ARCHITECTURES='arm64;x86_64' -DCMAKE_INSTALL_PREFIX=./install ..
+          cmake \
+            -DSHERPA_ONNX_ENABLE_TTS=${{ matrix.with_tts }} \
+            -D BUILD_SHARED_LIBS=$BUILD_SHARED_LIBS \
+            -D CMAKE_BUILD_TYPE=${{ matrix.build_type }} \
+            -D CMAKE_OSX_ARCHITECTURES='arm64;x86_64' \
+            -D CMAKE_INSTALL_PREFIX=./install \
+            ..
 
       - name: Build sherpa-onnx for macos
         shell: bash

diff --git a/.github/workflows/release-dart-package.yaml b/.github/workflows/release-dart-package.yaml
@@ -93,17 +93,12 @@ jobs:
               make install
 
               ls -lh ./install/lib
+              rm -v ./install/lib/libonnxruntime.so
 
       - name: Copy pre-built libs
         shell: bash
         run: |
           cp -v build/install/lib/lib*.so* flutter/sherpa_onnx_linux/linux/
-          pushd flutter/sherpa_onnx_linux/linux/
-
-          rm libonnxruntime.so
-          ln -s libonnxruntime.so.* ./libonnxruntime.so
-
-          popd
 
           mv -v flutter/sherpa_onnx_linux /tmp/to_be_published
 
@@ -197,27 +192,19 @@ jobs:
           cd build
           make -j2 install
 
-          ls -lh install/lib/libsherpa-onnx-core.dylib
-          file install/lib/libsherpa-onnx-core.dylib
+          ls -lh install/lib/libsherpa-onnx-c-api.dylib
+          file install/lib/libsherpa-onnx-c-api.dylib
+          rm -v install/lib/libonnxruntime.dylib
 
       - name: Copy pre-built libs
         shell: bash
         run: |
           cp -v build/install/lib/lib*.dylib* flutter/sherpa_onnx_macos/macos/
 
-
           mv -v flutter/sherpa_onnx_macos /tmp/to_be_published
 
           ls -lh /tmp/to_be_published/macos
 
-          pushd /tmp/to_be_published/macos
-
-          rm libonnxruntime.dylib
-
-          ls -lh
-
-          popd
-
       - name: Release
         shell: bash
         run: |
@@ -283,7 +270,7 @@ jobs:
         shell: bash
         run: |
           cd build
-          cmake --build . --target install --config Release
+          cmake --build . --target install --config Release -- -m:2
 
           ls -lh install/lib/*.dll
 

diff --git a/.github/workflows/riscv64-linux.yaml b/.github/workflows/riscv64-linux.yaml
@@ -123,8 +123,16 @@ jobs:
           ls -lh build-riscv64-linux-gnu/bin
           ls -lh build-riscv64-linux-gnu/lib
 
+          echo "---install/lib---"
+          ls -lh build-riscv64-linux-gnu/install/lib
+
+          echo "---install/bin---"
+          ls -lh build-riscv64-linux-gnu/install/bin
+
           file build-riscv64-linux-gnu/bin/sherpa-onnx
 
+          readelf -d build-riscv64-linux-gnu/bin/sherpa-onnx
+
       - name: Test sherpa-onnx
         shell: bash
         run: |

diff --git a/.github/workflows/run-python-test-macos.yaml b/.github/workflows/run-python-test-macos.yaml
@@ -78,7 +78,7 @@ jobs:
       - name: Install Python dependencies
         shell: bash
         run: |
-          python3 -m pip install --upgrade pip numpy pypinyin sentencepiece>=0.1.96 soundfile
+          python3 -m pip install --upgrade pip numpy pypinyin sentencepiece>=0.1.96 soundfile setuptools wheel
 
       - name: Install sherpa-onnx
         shell: bash
@@ -87,7 +87,7 @@ jobs:
           export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
           cmake --version
 
-          python3 setup.py install
+          python3 -m pip install .
 
       - name: Test sherpa-onnx
         shell: bash

diff --git a/.github/workflows/swift.yaml b/.github/workflows/swift.yaml
@@ -39,7 +39,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-latest, macos-14]
+        os: [macos-latest, macos-13]
 
     steps:
       - uses: actions/checkout@v4

diff --git a/.github/workflows/test-build-wheel.yaml b/.github/workflows/test-build-wheel.yaml
@@ -110,10 +110,20 @@ jobs:
           python3 setup.py bdist_wheel
           ls -lh dist
 
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel-${{ matrix.os }}-${{ matrix.python-version }}
+          path: ./dist/*.whl
+
       - name: Display wheel
         shell: bash
         run: |
           ls -lh dist
+          cd dist
+
+          mkdir t
+          cd t
+          unzip ../*.whl
 
       - name: Install wheel
         shell: bash

diff --git a/.github/workflows/test-dart.yaml b/.github/workflows/test-dart.yaml
@@ -70,7 +70,7 @@ jobs:
           cd build
 
           cmake \
-            -D BUILD_SHARED_LIBS=ON \
+            -DBUILD_SHARED_LIBS=ON \
             -DSHERPA_ONNX_ENABLE_PORTAUDIO=OFF \
             -DSHERPA_ONNX_ENABLE_WEBSOCKET=OFF \
             -DBUILD_ESPEAK_NG_EXE=OFF \

diff --git a/.github/workflows/test-go-package.yaml b/.github/workflows/test-go-package.yaml
@@ -26,8 +26,10 @@ jobs:
         include:
           - os: ubuntu-latest
             arch: amd64
-          - os: macos-latest
+          - os: macos-13
             arch: amd64
+          - os: macos-14
+            arch: arm64
           - os: windows-latest
             arch: x64
           - os: windows-latest