Add C++ API for streaming zipformer ASR on RK NPU (#1908)

2025-02-24 19:07:37 +08:00
parent bafd1103d0
commit 4d79e6a007
73 changed files with 1909 additions and 120 deletions
--- a/.github/workflows/aarch64-linux-gnu-shared.yaml
+++ b/.github/workflows/aarch64-linux-gnu-shared.yaml
@@ -199,6 +199,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -207,9 +208,10 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://csukuangfj:$HF_TOKEN@huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p aarch64
+            dst=aarch64/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*-shared*.tar.bz2 ./aarch64
+            cp -v ../sherpa-onnx-*-shared*.tar.bz2 $dst/

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/aarch64-linux-gnu-static.yaml
+++ b/.github/workflows/aarch64-linux-gnu-static.yaml
@@ -124,6 +124,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -132,9 +133,10 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://csukuangfj:$HF_TOKEN@huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p aarch64
+            dst=aarch64/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*-static.tar.bz2 ./aarch64
+            cp -v ../sherpa-onnx-*-static.tar.bz2 $dst/

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/android-static.yaml
+++ b/.github/workflows/android-static.yaml
@@ -140,6 +140,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"
            du -h -d1 .
@@ -150,8 +151,10 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://csukuangfj:$HF_TOKEN@huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
+            dst=$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*-android*.tar.bz2 ./
+            cp -v ../sherpa-onnx-*-android*.tar.bz2 $dst/

            git status
            git lfs track "*.bz2"
@@ -263,6 +266,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"
            du -h -d1 .
@@ -273,7 +277,7 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://csukuangfj:$HF_TOKEN@huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            dst=android/aar
+            dst=android/aar/$SHERPA_ONNX_VERSION
            mkdir -p $dst

            cp -v ../*.aar $dst
--- a/.github/workflows/arm-linux-gnueabihf.yaml
+++ b/.github/workflows/arm-linux-gnueabihf.yaml
@@ -199,6 +199,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -206,9 +207,10 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://csukuangfj:$HF_TOKEN@huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p arm32
+            dst=arm32/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*.tar.bz2 ./arm32
+            cp -v ../sherpa-onnx-*.tar.bz2 $dst/

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/dot-net.yaml
+++ b/.github/workflows/dot-net.yaml
@@ -83,6 +83,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -95,9 +96,10 @@ jobs:
            cd huggingface
            git fetch
            git pull
-            mkdir -p windows-for-dotnet
+            dst=windows-for-dotnet/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*.tar.bz2 ./windows-for-dotnet
+            cp -v ../sherpa-onnx-*.tar.bz2 $dst/

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/linux-jni-aarch64.yaml
+++ b/.github/workflows/linux-jni-aarch64.yaml
@@ -138,6 +138,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -146,10 +147,11 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p jni
+            dst=jni/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*.tar.bz2 ./jni
-            cp -v ../*.jar ./jni
+            cp -v ../sherpa-onnx-*.tar.bz2 $dst/
+            cp -v ../*.jar $dst/

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/linux-jni.yaml
+++ b/.github/workflows/linux-jni.yaml
@@ -197,6 +197,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -205,10 +206,11 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p jni
+            dst=jni/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*.tar.bz2 ./jni
-            cp -v ../*.jar ./jni
+            cp -v ../sherpa-onnx-*.tar.bz2 $dst/
+            cp -v ../*.jar $dst/

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/macos-jni.yaml
+++ b/.github/workflows/macos-jni.yaml
@@ -113,6 +113,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -121,9 +122,10 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p jni
+            dst=jni/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*.tar.bz2 ./jni
+            cp -v ../sherpa-onnx-*.tar.bz2 $dst

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/riscv64-linux.yaml
+++ b/.github/workflows/riscv64-linux.yaml
@@ -239,6 +239,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -248,9 +249,10 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p riscv64
+            dst=riscv64/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*-shared.tar.bz2 ./riscv64
+            cp -v ../sherpa-onnx-*-shared.tar.bz2 $dst/

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/rknn-linux-aarch64.yaml
+++ b/.github/workflows/rknn-linux-aarch64.yaml
@@ -0,0 +1,241 @@
+name: rknn-linux-aarch64
+
+on:
+  push:
+    branches:
+      - master
+      - rknn-c-api-2
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+*'
+    paths:
+      - '.github/workflows/rknn-linux-aarch64.yaml'
+      - 'cmake/**'
+      - 'sherpa-onnx/csrc/*'
+      - 'sherpa-onnx/csrc/rknn/*'
+      - 'sherpa-onnx/c-api/*'
+      - 'toolchains/aarch64-linux-gnu.toolchain.cmake'
+  pull_request:
+    branches:
+      - master
+    paths:
+      - '.github/workflows/rknn-linux-aarch64.yaml'
+      - 'cmake/**'
+      - 'sherpa-onnx/csrc/*'
+      - 'sherpa-onnx/csrc/rknn/*'
+      - 'sherpa-onnx/c-api/*'
+      - 'toolchains/aarch64-linux-gnu.toolchain.cmake'
+
+  workflow_dispatch:
+
+concurrency:
+  group: aarch64-linux-gnu-shared-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  rknn_linux_aarch64:
+    runs-on: ${{ matrix.os }}
+    name: rknn shared ${{ matrix.shared }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-22.04-arm
+            shared: ON
+          - os: ubuntu-22.04-arm
+            shared: OFF
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ matrix.os }}-${{ matrix.shared }}-rknn-linux-aarch64
+
+      - name: Download rknn-toolkit2
+        shell: bash
+        run: |
+          git clone --depth 1 https://github.com/airockchip/rknn-toolkit2
+
+      - name: Build sherpa-onnx
+        shell: bash
+        run: |
+          export CMAKE_CXX_COMPILER_LAUNCHER=ccache
+          export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+          cmake --version
+
+          echo "config: ${{ matrix.config }}"
+          uname -a
+          which gcc
+
+          gcc --version
+          g++ --version
+
+          echo "pwd"
+
+          ls -lh
+
+          git clone --depth 1 --branch v1.2.12 https://github.com/alsa-project/alsa-lib
+          pushd alsa-lib
+          ./gitcompile
+          popd
+
+          export SHERPA_ONNX_RKNN_TOOLKIT2_PATH=$PWD/rknn-toolkit2
+          export SHERPA_ONNX_RKNN_TOOLKIT2_LIB_DIR=$SHERPA_ONNX_RKNN_TOOLKIT2_PATH/rknpu2/runtime/Linux/librknn_api/aarch64
+          export CPLUS_INCLUDE_PATH=$SHERPA_ONNX_RKNN_TOOLKIT2_PATH/rknpu2/runtime/Linux/librknn_api/include:$CPLUS_INCLUDE_PATH
+          export CPLUS_INCLUDE_PATH=$PWD/alsa-lib/include:$CPLUS_INCLUDE_PATH
+          export SHERPA_ONNX_ALSA_LIB_DIR=$PWD/alsa-lib/src/.libs
+
+          mkdir build
+          cd build
+
+          BUILD_SHARED_LIBS=${{ matrix.shared }}
+
+          cmake \
+            -DBUILD_SHARED_LIBS=ON \
+            -DCMAKE_INSTALL_PREFIX=./install \
+            -DSHERPA_ONNX_ENABLE_RKNN=ON \
+            -DBUILD_SHARED_LIBS=$BUILD_SHARED_LIBS \
+            ..
+
+          make -j4 install
+
+          rm -rf install/lib/pkgconfig
+          rm -fv install/lib/cargs.h
+          rm -fv install/lib/libcargs.so
+
+      - name: Display system info
+        shell: bash
+        run: |
+          uname -a
+          gcc --version
+          g++ --version
+
+      - name: Display generated files
+        shell: bash
+        run: |
+          export SHERPA_ONNX_RKNN_TOOLKIT2_PATH=$PWD/rknn-toolkit2
+          export LD_LIBRARY_PATH=$SHERPA_ONNX_RKNN_TOOLKIT2_PATH/rknpu2/runtime/Linux/librknn_api/aarch64:$LD_LIBRARY_PATH
+
+          cd build/install
+
+          ls -lh bin
+
+          echo "---"
+
+          ls -lh lib
+
+          file bin/sherpa-onnx
+
+          readelf -d bin/sherpa-onnx
+
+          ldd bin/sherpa-onnx
+
+          ./bin/sherpa-onnx --help
+
+      - name: Copy files
+        shell: bash
+        run: |
+          SHERPA_ONNX_VERSION=v$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
+
+          if [[ ${{ matrix.shared }} == ON ]]; then
+            suffix=shared
+          else
+            suffix=static
+          fi
+
+          dst=sherpa-onnx-${SHERPA_ONNX_VERSION}-rknn-linux-aarch64-$suffix
+          mkdir $dst
+
+          cp -a build/install/bin $dst/
+
+          if [[ ${{ matrix.shared }} == ON ]]; then
+            cp -v build/install/lib/lib*.so $dst/
+          fi
+
+          ls -lh build/install/lib
+          ls -lh build/install/bin
+
+          ls -lh $dst/bin/
+          echo "strip"
+          strip $dst/bin/*
+
+          echo "after strip"
+          ls -lh $dst/bin/
+
+          tree $dst
+
+          tar cjvf ${dst}.tar.bz2 $dst
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sherpa-onnx-linux-linux-aarch64-shared-${{ matrix.shared }}
+          path: sherpa-onnx-*linux-aarch64*.tar.bz2
+
+      # https://huggingface.co/docs/hub/spaces-github-actions
+      - name: Publish to huggingface
+        if: (github.repository_owner == 'csukuangfj' || github.repository_owner == 'k2-fsa') && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        uses: nick-fields/retry@v3
+        with:
+          max_attempts: 20
+          timeout_seconds: 200
+          shell: bash
+          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
+
+            git config --global user.email "csukuangfj@gmail.com"
+            git config --global user.name "Fangjun Kuang"
+
+            rm -rf huggingface
+            export GIT_CLONE_PROTECTION_ACTIVE=false
+            GIT_LFS_SKIP_SMUDGE=1 git clone https://csukuangfj:$HF_TOKEN@huggingface.co/csukuangfj/sherpa-onnx-libs huggingface
+
+            cd huggingface
+            dst=rknn-linux-aarch64/$SHERPA_ONNX_VERSION
+            mkdir -p $dst
+
+            cp -v ../sherpa-onnx-*rknn*-*.tar.bz2 $dst
+
+            git status
+            git lfs track "*.bz2"
+
+            git add .
+
+            git commit -m "upload sherpa-onnx-${SHERPA_ONNX_VERSION}-rknn-linux-aarch64.tar.bz2"
+
+            git push https://csukuangfj:$HF_TOKEN@huggingface.co/csukuangfj/sherpa-onnx-libs main
+
+      - name: Release pre-compiled binaries and libs for rknn linux aarch64
+        if: github.repository_owner == 'k2-fsa' && github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+        uses: svenstaro/upload-release-action@v2
+        with:
+          file_glob: true
+          overwrite: true
+          file: sherpa-onnx-*linux-aarch64*.tar.bz2
+
+      - name: Release pre-compiled binaries and libs for rknn linux aarch64
+        # if: github.repository_owner == 'csukuangfj' && github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+        uses: svenstaro/upload-release-action@v2
+        with:
+          file_glob: true
+          overwrite: true
+          file: sherpa-onnx-*linux-aarch64*.tar.bz2
+          repo_name: k2-fsa/sherpa-onnx
+          repo_token: ${{ secrets.UPLOAD_GH_SHERPA_ONNX_TOKEN }}
+          tag: v1.10.45
+
+      - name: Test offline Moonshine
+        if: matrix.build_type != 'Debug'
+        shell: bash
+        run: |
+          du -h -d1 .
+          export PATH=$PWD/build/install/bin:$PATH
+          export EXE=sherpa-onnx-offline
+
+          readelf -d build/bin/sherpa-onnx-offline
+
+          .github/scripts/test-offline-moonshine.sh
--- a/.github/workflows/windows-x64-jni.yaml
+++ b/.github/workflows/windows-x64-jni.yaml
@@ -92,6 +92,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -100,9 +101,10 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p jni
+            dst=jni/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*.tar.bz2 ./jni
+            cp -v ../sherpa-onnx-*.tar.bz2 $dst

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/windows-x64.yaml
+++ b/.github/workflows/windows-x64.yaml
@@ -128,6 +128,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -136,9 +137,10 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p win64
+            dst=win64/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

-            cp -v ../sherpa-onnx-*.tar.bz2 ./win64
+            cp -v ../sherpa-onnx-*.tar.bz2 $dst

            git status
            git lfs track "*.bz2"
--- a/.github/workflows/windows-x86.yaml
+++ b/.github/workflows/windows-x86.yaml
@@ -131,6 +131,7 @@ jobs:
          timeout_seconds: 200
          shell: bash
          command: |
+            SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)
            git config --global user.email "csukuangfj@gmail.com"
            git config --global user.name "Fangjun Kuang"

@@ -139,7 +140,8 @@ jobs:
            GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/csukuangfj/sherpa-onnx-libs huggingface

            cd huggingface
-            mkdir -p win32
+            dst=win32/$SHERPA_ONNX_VERSION
+            mkdir -p $dst

            cp -v ../sherpa-onnx-*.tar.bz2 ./win32