macos.yaml

name: macos

on:
  push:
    branches:
      - master
    tags:
      - 'v[0-9]+.[0-9]+.[0-9]+*'
    paths:
      - '.github/scripts/test-offline-speech-denoiser.sh'
      - '.github/workflows/macos.yaml'
      - '.github/scripts/test-kws.sh'
      - '.github/scripts/test-online-transducer.sh'
      - '.github/scripts/test-online-paraformer.sh'
      - '.github/scripts/test-offline-cohere-transcribe.sh'
      - '.github/scripts/test-offline-transducer.sh'
      - '.github/scripts/test-offline-ctc.sh'
      - '.github/scripts/test-offline-tts.sh'
      - '.github/scripts/test-online-ctc.sh'
      - '.github/scripts/test-audio-tagging.sh'
      - '.github/scripts/test-offline-diacritization.sh'
      - '.github/scripts/test-offline-punctuation.sh'
      - '.github/scripts/test-online-punctuation.sh'
      - '.github/scripts/test-speaker-diarization.sh'
      - '.github/scripts/test-c-api.sh'
      - '.github/scripts/test-cxx-api.sh'
      - 'cmake/**'
      - 'sherpa-onnx/csrc/*'
      - 'sherpa-onnx/c-api/*'
  pull_request:
    branches:
      - master
    paths:
      - '.github/scripts/test-offline-speech-denoiser.sh'
      - '.github/workflows/macos.yaml'
      - '.github/scripts/test-kws.sh'
      - '.github/scripts/test-online-transducer.sh'
      - '.github/scripts/test-online-paraformer.sh'
      - '.github/scripts/test-offline-cohere-transcribe.sh'
      - '.github/scripts/test-offline-transducer.sh'
      - '.github/scripts/test-offline-ctc.sh'
      - '.github/scripts/test-offline-tts.sh'
      - '.github/scripts/test-online-ctc.sh'
      - '.github/scripts/test-audio-tagging.sh'
      - '.github/scripts/test-offline-diacritization.sh'
      - '.github/scripts/test-offline-punctuation.sh'
      - '.github/scripts/test-online-punctuation.sh'
      - '.github/scripts/test-speaker-diarization.sh'
      - '.github/scripts/test-c-api.sh'
      - '.github/scripts/test-cxx-api.sh'
      - 'cmake/**'
      - 'sherpa-onnx/csrc/*'
      - 'sherpa-onnx/c-api/*'

  workflow_dispatch:

concurrency:
  group: macos-${{ github.ref }}
  cancel-in-progress: true

jobs:
  macos:
    runs-on: ${{ matrix.os }}
    name: ${{ matrix.build_type }} ${{ matrix.lib_type }} tts-${{ matrix.with_tts }} ${{ matrix.os }} ${{ matrix.arch }}
    strategy:
      fail-fast: false
      matrix:
        os: [macos-latest]
        build_type: [Release, Debug]
        lib_type: [static, shared]
        with_tts: [ON, OFF]
        arch: ["arm64;x86_64"]

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Update version
        shell: bash
        run: |
          ./new-release.sh
          git diff .

      - name: ccache
        uses: hendrikmuhs/ccache-action@v1.2
        with:
          key: ${{ matrix.os }}-${{ matrix.build_type }}-${{ matrix.lib_type }}-tts-${{ matrix.with_tts }}

      - 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
          lib_type=${{ matrix.lib_type }}
          if [[ $lib_type == "static" ]]; then
            BUILD_SHARED_LIBS=OFF
          else
            BUILD_SHARED_LIBS=ON
          fi

          arch="${{ matrix.arch }}"

          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="$arch" \
            -D CMAKE_INSTALL_PREFIX=./install \
            ..

      - name: Build sherpa-onnx for macos
        shell: bash
        run: |
          export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"

          cd build
          make -j2
          make install

          ls -lh lib
          ls -lh bin

          file ./bin/sherpa-onnx

          rm -fv ./install/include/cargs.h
          rm -fv ./install/lib/cargs.h
          rm -fv ./install/lib/libcargs.dylib
          rm -fv ./install/lib/libcargs.a
          rm -rfv ./install/lib/pkgconfig

      - name: Display dependencies of sherpa-onnx for macos
        shell: bash
        run: |
          file bin/sherpa-onnx
          otool -L build/bin/sherpa-onnx
          otool -l build/bin/sherpa-onnx

      - name: Copy files
        if: matrix.build_type == 'Release'
        shell: bash
        run: |
          thin_macos_tree() {
            src_dir="$1"
            dst_dir="$2"
            arch="$3"

            cp -a "$src_dir" "$dst_dir"

            while IFS= read -r -d '' f; do
              tmp="${f}.thin"
              lipo -thin "$arch" "$f" -output "$tmp"
              mv "$tmp" "$f"
            done < <(find "$dst_dir" -type f \( -path "$dst_dir/bin/*" -o -path "$dst_dir/lib/*.dylib*" -o -path "$dst_dir/lib/*.a" \) -print0)
          }

          SHERPA_ONNX_VERSION=v$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt  | cut -d " " -f 2  | cut -d '"' -f 2)

          if [[ ${{ matrix.with_tts }} == ON ]]; then
            dst=sherpa-onnx-${SHERPA_ONNX_VERSION}-osx-universal2-${{ matrix.lib_type }}
          else
            dst=sherpa-onnx-${SHERPA_ONNX_VERSION}-osx-universal2-${{ matrix.lib_type }}-no-tts
          fi
          mkdir $dst

          cp -a build/install/bin $dst/
          if [[ ${{ matrix.lib_type }} == shared ]]; then
            mkdir $dst/lib
            cp -a build/install/lib/*.dylib* $dst/lib/
          else
            cp -a build/install/lib $dst/
          fi
          cp -a build/install/include $dst/

          brew install tree
          tree $dst

          tar cjvf ${dst}.tar.bz2 $dst

          lib_dst=${dst}-lib
          mkdir -p ${lib_dst}/lib
          if [[ ${{ matrix.lib_type }} == shared ]]; then
            cp -av build/install/lib/lib*.dylib* ${lib_dst}/lib/
            rm -f ${lib_dst}/lib/libcargs.dylib ${lib_dst}/lib/libcargs*.dylib
          else
            cp -av build/install/lib/lib*.a ${lib_dst}/lib/
            rm -f ${lib_dst}/lib/libcargs.a
          fi
          tree ${lib_dst}
          tar cjvf ${lib_dst}.tar.bz2 ${lib_dst}

          for arch in x86_64 arm64; do
            if [[ "$arch" == "x86_64" ]]; then
              arch_name=x64
            else
              arch_name=arm64
            fi

            arch_dst=${dst/osx-universal2/osx-${arch_name}}
            thin_macos_tree "$dst" "$arch_dst" "$arch"
            tree "$arch_dst"
            tar cjvf ${arch_dst}.tar.bz2 ${arch_dst}

            arch_lib_dst=${lib_dst/osx-universal2/osx-${arch_name}}
            thin_macos_tree "$lib_dst" "$arch_lib_dst" "$arch"
            tree "$arch_lib_dst"
            tar cjvf ${arch_lib_dst}.tar.bz2 ${arch_lib_dst}
          done

      - name: Release pre-compiled binaries and libs for macOS
        if: github.repository_owner == 'csukuangfj' && github.event_name == 'push' && contains(github.ref, 'refs/tags/') && matrix.build_type == 'Release'
        uses: svenstaro/upload-release-action@v2
        with:
          file_glob: true
          overwrite: true
          file: sherpa-onnx-*.tar.bz2
          repo_name: k2-fsa/sherpa-onnx
          repo_token: ${{ secrets.UPLOAD_GH_SHERPA_ONNX_TOKEN }}
          tag: v1.12.31

      - name: Release pre-compiled binaries and libs for macOS
        if: github.repository_owner == 'k2-fsa' && github.event_name == 'push' && contains(github.ref, 'refs/tags/') && matrix.build_type == 'Release'
        uses: svenstaro/upload-release-action@v2
        with:
          file_glob: true
          overwrite: true
          file: sherpa-onnx-*.tar.bz2

      - name: Test offline Cohere Transcribe
        if: matrix.build_type != 'Debug' && !startsWith(github.ref, 'refs/tags/')
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline

          .github/scripts/test-offline-cohere-transcribe.sh

      - name: Test offline FireRedASR
        if: matrix.build_type != 'Debug' && !startsWith(github.ref, 'refs/tags/')
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline

          .github/scripts/test-offline-fire-red-asr.sh

      - name: Test offline CTC
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline

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

      - name: Test offline speech denoiser
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          du -h -d1 .
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline-denoiser

          .github/scripts/test-offline-speech-denoiser.sh

      - name: Test offline TTS
        if: matrix.with_tts == 'ON' && !startsWith(github.ref, 'refs/tags/')
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline-tts

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

      - name: Test offline Moonshine
        if: matrix.build_type != 'Debug' && !startsWith(github.ref, 'refs/tags/')
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline

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

      - name: Test C++ API
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          du -h -d1 .
          export PATH=$PWD/build/bin:$PATH
          export CXX_STREAMING_ZIPFORMER_EXE=streaming-zipformer-cxx-api
          export CXX_WHISPER_EXE=whisper-cxx-api
          export CXX_SENSE_VOICE_EXE=sense-voice-cxx-api

          .github/scripts/test-cxx-api.sh
          du -h -d1 .

      - name: Test offline speaker diarization
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          du -h -d1 .
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline-speaker-diarization

          .github/scripts/test-speaker-diarization.sh

      - name: Test offline transducer
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline

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

      - name: Test online punctuation
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-online-punctuation

          .github/scripts/test-online-punctuation.sh

      - name: Test online CTC
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx

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

      - name: Test offline punctuation
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline-punctuation

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

      - name: Test offline diacritization
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline-diacritization

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

      - name: Test C API
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export SLID_EXE=spoken-language-identification-c-api
          export SID_EXE=speaker-identification-c-api
          export AT_EXE=audio-tagging-c-api
          export PUNCT_EXE=add-punctuation-c-api

          .github/scripts/test-c-api.sh

      - name: Test Audio tagging
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline-audio-tagging

          .github/scripts/test-audio-tagging.sh

      - name: Test spoken language identification (C++ API)
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline-language-identification

          .github/scripts/test-spoken-language-identification.sh

      - name: Test transducer kws
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-keyword-spotter

          .github/scripts/test-kws.sh

      - name: Test online paraformer
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx

          .github/scripts/test-online-paraformer.sh

      - name: Test offline Whisper
        if: matrix.build_type != 'Debug' && !startsWith(github.ref, 'refs/tags/')
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx-offline

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

      - name: Test online transducer
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=sherpa-onnx

          .github/scripts/test-online-transducer.sh

      - name: Test online transducer (C API)
        if: ${{ !startsWith(github.ref, 'refs/tags/') }}
        shell: bash
        run: |
          export PATH=$PWD/build/bin:$PATH
          export EXE=decode-file-c-api

          .github/scripts/test-online-transducer.sh