Skip to content

Add Flutter/Dart Web support via WebAssembly #3842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csukuangfj merged 18 commits into from
Aug 6, 2026
Merged

Add Flutter/Dart Web support via WebAssembly #3842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
1d6fb66
Remove pthread support from WebAssembly.
csukuangfj Aug 3, 2026
ee3425b
Update emsdk to 4.0.23
csukuangfj Aug 3, 2026
cbe8e9a
Add Dart Web support
csukuangfj Aug 5, 2026
ce59eb5
Refactor
csukuangfj Aug 5, 2026
63d00d3
Refactor
csukuangfj Aug 5, 2026
16a386e
More refactor
csukuangfj Aug 5, 2026
bc7d1be
Remove duplicate code
csukuangfj Aug 5, 2026
bb67c4c
Fix bugs with num_threads>1
csukuangfj Aug 6, 2026
2c281d3
First working version
csukuangfj Aug 6, 2026
8096ed4
Support pocket tts
csukuangfj Aug 6, 2026
5db1e93
Refactor
csukuangfj Aug 6, 2026
c838fed
Refactor CI
csukuangfj Aug 6, 2026
41c9cfa
Add missing directory
csukuangfj Aug 6, 2026
895b22d
Fix CI
csukuangfj Aug 6, 2026
242830f
Small fixes
csukuangfj Aug 6, 2026
496df68
Fix CI
csukuangfj Aug 6, 2026
840bc82
Merge remote-tracking branch 'dan/master' into dart-wasm
csukuangfj Aug 6, 2026
f89f865
Fixes after review
csukuangfj Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/flutter-android.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ concurrency:

jobs:
asr:
if: false
name: asr ${{ matrix.index }}/${{ matrix.total }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -272,6 +273,7 @@ jobs:
git push https://csukuangfj2:$HF_TOKEN@huggingface.co/csukuangfj2/sherpa-onnx-flutter main

tts:
if: false
name: tts ${{ matrix.index }}/${{ matrix.total }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/flutter-linux.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ env:

jobs:
asr:
if: false
name: asr ${{ matrix.arch }} ${{ matrix.index }}/${{ matrix.total }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -151,6 +152,7 @@ jobs:
git push https://csukuangfj2:$HF_TOKEN@huggingface.co/csukuangfj2/sherpa-onnx-flutter main

tts:
if: false
name: tts ${{ matrix.arch }} ${{ matrix.index }}/${{ matrix.total }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/flutter-macos.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ concurrency:

jobs:
asr:
if: false

@coderabbitai coderabbitai Bot Aug 6, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Restore the disabled build and release jobs.

if: false skips every listed matrix. This prevents these jobs from building and publishing macOS and Windows artifacts.

  • .github/workflows/flutter-macos.yaml#L19-L19: Remove the unconditional guard from the ASR job.
  • .github/workflows/flutter-macos.yaml#L133-L133: Remove the unconditional guard from the TTS job.
  • .github/workflows/flutter-windows-x64.yaml#L19-L19: Remove the unconditional guard from the ASR job.
  • .github/workflows/flutter-windows-x64.yaml#L125-L125: Remove the unconditional guard from the TTS job.
🧰 Tools
🪛 actionlint (1.7.12)

[error] 19-19: constant expression "false" in condition. remove the if: section

(if-cond)

📍 Affects 2 files
  • .github/workflows/flutter-macos.yaml#L19-L19 (this comment)
  • .github/workflows/flutter-macos.yaml#L133-L133
  • .github/workflows/flutter-windows-x64.yaml#L19-L19
  • .github/workflows/flutter-windows-x64.yaml#L125-L125
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/flutter-macos.yaml at line 19, Restore the macOS and
Windows build/release jobs by removing the unconditional if: false guards from
the ASR and TTS jobs in .github/workflows/flutter-macos.yaml at lines 19-19 and
133-133, and .github/workflows/flutter-windows-x64.yaml at lines 19-19 and
125-125.

Source: Linters/SAST tools

name: asr ${{ matrix.arch }}/${{ matrix.total }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -129,6 +130,7 @@ jobs:
git push https://csukuangfj2:$HF_TOKEN@huggingface.co/csukuangfj2/sherpa-onnx-flutter main
tts:
if: false
name: tts ${{ matrix.arch }} ${{ matrix.index }}/${{ matrix.total }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/flutter-windows-x64.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ concurrency:

jobs:
asr:
if: false
name: asr ${{ matrix.index }}/${{ matrix.total }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down Expand Up @@ -121,6 +122,7 @@ jobs:
git push https://csukuangfj2:$HF_TOKEN@huggingface.co/csukuangfj2/sherpa-onnx-flutter main

tts:
if: false
name: tts ${{ matrix.index }}/${{ matrix.total }}
runs-on: ${{ matrix.os }}
strategy:
Expand Down
235 changes: 234 additions & 1 deletion .github/workflows/release-dart-package.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,18 @@ jobs:

- uses: dart-lang/setup-dart@v1

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx_linux.zip to_be_published
ls -lh /tmp/sherpa_onnx_linux.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx_linux
path: /tmp/sherpa_onnx_linux.zip

- name: Release
shell: bash
run: |
Expand Down Expand Up @@ -285,6 +297,11 @@ jobs:

git status

- name: Remove .gitignore so xcframework files are included in package
shell: bash
run: |
rm -fv flutter/sherpa_onnx_macos/macos/.gitignore

- name: Download pre-built xcframework
shell: bash
run: |
Expand Down Expand Up @@ -317,6 +334,18 @@ jobs:

- uses: dart-lang/setup-dart@v1

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx_macos.zip to_be_published
ls -lh /tmp/sherpa_onnx_macos.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx_macos
path: /tmp/sherpa_onnx_macos.zip

- name: Release
shell: bash
run: |
Expand Down Expand Up @@ -408,6 +437,18 @@ jobs:

- uses: dart-lang/setup-dart@v1

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx_windows.zip to_be_published
ls -lh /tmp/sherpa_onnx_windows.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx_windows
path: /tmp/sherpa_onnx_windows.zip

- name: Release
shell: bash
run: |
Expand Down Expand Up @@ -504,6 +545,18 @@ jobs:

- uses: dart-lang/setup-dart@v1

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx_android_arm64.zip to_be_published
ls -lh /tmp/sherpa_onnx_android_arm64.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx_android_arm64
path: /tmp/sherpa_onnx_android_arm64.zip

- name: Release
shell: bash
run: |
Expand Down Expand Up @@ -602,6 +655,18 @@ jobs:

- uses: dart-lang/setup-dart@v1

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx_android_armeabi.zip to_be_published
ls -lh /tmp/sherpa_onnx_android_armeabi.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx_android_armeabi
path: /tmp/sherpa_onnx_android_armeabi.zip

- name: Release
shell: bash
run: |
Expand Down Expand Up @@ -700,6 +765,18 @@ jobs:

- uses: dart-lang/setup-dart@v1

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx_android_x86.zip to_be_published
ls -lh /tmp/sherpa_onnx_android_x86.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx_android_x86
path: /tmp/sherpa_onnx_android_x86.zip

- name: Release
shell: bash
run: |
Expand Down Expand Up @@ -798,6 +875,18 @@ jobs:

- uses: dart-lang/setup-dart@v1

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx_android_x86_64.zip to_be_published
ls -lh /tmp/sherpa_onnx_android_x86_64.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx_android_x86_64
path: /tmp/sherpa_onnx_android_x86_64.zip

- name: Release
shell: bash
run: |
Expand Down Expand Up @@ -851,6 +940,11 @@ jobs:

git status

- name: Remove .gitignore so xcframework files are included in package
shell: bash
run: |
rm -fv flutter/sherpa_onnx_ios/ios/.gitignore

- name: Download pre-built xcframework
shell: bash
run: |
Expand Down Expand Up @@ -880,6 +974,133 @@ jobs:

- uses: dart-lang/setup-dart@v1

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx_ios.zip to_be_published
ls -lh /tmp/sherpa_onnx_ios.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx_ios
path: /tmp/sherpa_onnx_ios.zip

- name: Release
shell: bash
run: |
cd /tmp/to_be_published
du -h -d1 .
flutter pub get
flutter pub publish --dry-run
flutter pub publish --force

sherpa_onnx_web:
# if: false
permissions:
id-token: write # Required for authentication using OIDC
name: sherpa_onnx_web
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

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

- name: ccache
uses: hendrikmuhs/ccache-action@v1.2
with:
key: release-wasm-web

- name: Install Emscripten
uses: mymindstorm/setup-emsdk@v14
with:
version: 4.0.23

- name: Build WASM module
shell: bash
run: |
export CMAKE_CXX_COMPILER_LAUNCHER=ccache
export CMAKE_C_COMPILER_LAUNCHER=ccache
export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
./build-wasm-simd-web.sh

- name: Copy WASM assets
shell: bash
run: |
cp build-wasm-simd-web/install/bin/wasm/web/sherpa-onnx-wasm-web.js \
flutter/sherpa_onnx_web/assets/
cp build-wasm-simd-web/install/bin/wasm/web/sherpa-onnx-wasm-web.wasm \
flutter/sherpa_onnx_web/assets/

# Copy JS wrappers from their source directories (not symlinks).
cp wasm/tts/sherpa-onnx-tts.js flutter/sherpa_onnx_web/assets/
cp wasm/asr/sherpa-onnx-asr.js flutter/sherpa_onnx_web/assets/
cp wasm/vad/sherpa-onnx-vad.js flutter/sherpa_onnx_web/assets/
cp wasm/kws/sherpa-onnx-kws.js flutter/sherpa_onnx_web/assets/
cp wasm/nodejs/sherpa-onnx-punctuation.js flutter/sherpa_onnx_web/assets/
cp wasm/speaker-diarization/sherpa-onnx-speaker-diarization.js flutter/sherpa_onnx_web/assets/
cp wasm/speech-enhancement/sherpa-onnx-speech-enhancement.js flutter/sherpa_onnx_web/assets/

ls -lh flutter/sherpa_onnx_web/assets/

- name: Remove .gitignore so WASM files are included in package
shell: bash
run: |
rm -f flutter/sherpa_onnx_web/.gitignore

- name: Fix version
shell: bash
run: |
SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" ./CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)

src_dir=$PWD/flutter/sherpa_onnx_web
pushd $src_dir
v="version: $SHERPA_ONNX_VERSION"
echo "v: $v"
sed -i.bak s"/^version: .*/$v/" ./pubspec.yaml
rm *.bak
git status
git diff

- name: Copy extra files
shell: bash
run: |
dst=flutter/sherpa_onnx_web

cp -v LICENSE $dst/
cp -v CHANGELOG.md $dst/

git status

mv -v flutter/sherpa_onnx_web /tmp/to_be_published

ls -lh /tmp/to_be_published

- name: Setup Flutter SDK
uses: flutter-actions/setup-flutter@v3
with:
channel: stable
version: latest

- uses: dart-lang/setup-dart@v1

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx_web.zip to_be_published
ls -lh /tmp/sherpa_onnx_web.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx_web
path: /tmp/sherpa_onnx_web.zip

- name: Release
shell: bash
run: |
Expand All @@ -890,7 +1111,7 @@ jobs:
flutter pub publish --force

sherpa_onnx:
needs: [sherpa_onnx_linux, sherpa_onnx_macos, sherpa_onnx_windows, sherpa_onnx_android_arm64, sherpa_onnx_android_armeabi, sherpa_onnx_android_x86, sherpa_onnx_android_x86_64, sherpa_onnx_ios]
needs: [sherpa_onnx_linux, sherpa_onnx_macos, sherpa_onnx_windows, sherpa_onnx_android_arm64, sherpa_onnx_android_armeabi, sherpa_onnx_android_x86, sherpa_onnx_android_x86_64, sherpa_onnx_ios, sherpa_onnx_web]
# if: false
permissions:
id-token: write # Required for authentication using OIDC
Expand Down Expand Up @@ -944,6 +1165,18 @@ jobs:

ls -lh /tmp/to_be_published

- name: Zip package for inspection
shell: bash
run: |
cd /tmp
zip -r /tmp/sherpa_onnx.zip to_be_published
ls -lh /tmp/sherpa_onnx.zip

- uses: actions/upload-artifact@v4
with:
name: package-sherpa_onnx
path: /tmp/sherpa_onnx.zip

- name: Release
shell: bash
run: |
Expand Down
Loading
Loading