Release v1.12.24

[csukuangfj]

Summary by CodeRabbit

Release Notes - Version 1.12.24

• New Features

  • Added new APIs and language bindings
  • Added BPE tokenizer support
  • Enabled text-to-speech streaming on CPU

• Bug Fixes

  • Fixed UnicodeDecodeError issue

• Improvements

  • Enhanced UI components and user interface
  • Improved build performance and optimization
  • Extended platform compatibility

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request is a routine version bump from 1.12.23 to 1.12.24 across the sherpa-onnx project. It updates version strings in build configurations, package manifests, documentation links, changelog entries, and embedded version constants consistently throughout Android, Flutter, Dart, iOS, HarmonyOS, Python, and Node.js package files.

Changes

Cohort / File(s)	Summary
Changelog and Core Build CHANGELOG.md, CMakeLists.txt, sherpa-onnx/csrc/version.cc	Added v1.12.24 changelog section and updated project version constant and embedded version strings (date, SHA1, version).
Documentation and Scripts README.md, build-ios-shared.sh, new-release.sh, jitpack.yml, mfc-examples/README.md, harmony-os/SherpaOnnxVadAsr/entry/README.md, harmony-os/SherpaOnnxHar/sherpa_onnx/README.md	Updated version references in documentation and build scripts, including iOS plist generation, release automation script parameters, and example download URLs.
Android Application Build Configs android/SherpaOnnx*/app/build.gradle*, android/SherpaOnnxAudioTagging*/app/build.gradle.kts, android/SherpaOnnxJavaDemo/app/build.gradle, android/SherpaOnnxSimulateStreamingAsr*/app/build.gradle.kts, android/SherpaOnnxSpeakerDiarization/app/build.gradle.kts, android/SherpaOnnxSpeakerIdentification/app/build.gradle.kts, android/SherpaOnnxSpokenLanguageIdentification/app/build.gradle.kts, android/SherpaOnnxTtsEngine/app/build.gradle.kts, android/SherpaOnnxVadAsr/app/build.gradle, android/SherpaOnnxWebSocket/app/build.gradle	Updated versionCode (from 20260115 to 20260210) and versionName (from 1.12.23 to 1.12.24) across all Android demo and example apps. Some files also updated sherpa-onnx dependency references.
Android AAR and Other Configurations android/SherpaOnnxAar/README.md, pom.xml	Updated AAR artifact references and Maven POM version from 1.12.23 to 1.12.24.
Dart Examples dart-api-examples/*/pubspec.yaml	Updated sherpa_onnx dependency from ^1.12.23 to ^1.12.24 across all Dart example projects.
Flutter Packages and Examples flutter/sherpa_onnx/pubspec.yaml, flutter/sherpa_onnx_ios/ios/sherpa_onnx_ios.podspec, flutter/sherpa_onnx_macos/macos/sherpa_onnx_macos.podspec, flutter-examples/*/pubspec.yaml	Bumped package version and sherpa_onnx dependencies to 1.12.24; updated iOS and macOS podspec versions.
HarmonyOS Packages harmony-os/SherpaOnnx*/entry/oh-package.json5, harmony-os/SherpaOnnxHar/sherpa_onnx/BuildProfile.ets, harmony-os/SherpaOnnxHar/sherpa_onnx/oh-package.json5	Updated sherpa_onnx HAR dependency and package versions from 1.12.23 to 1.12.24 across all HarmonyOS example projects and core package metadata.
Python Packages scripts/wheel/sherpa-onnx-bin/setup.py, scripts/wheel/sherpa-onnx-core/setup.py, setup.py	Updated package version and sherpa-onnx core dependency references from 1.12.23 to 1.12.24 in wheel and main setup configurations.
Node.js Packages nodejs-addon-examples/package.json, nodejs-examples/package.json	Updated sherpa-onnx-node dependency from ^1.12.23 to ^1.12.24.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• Release v1.12.13 #2593: Sequential release-version bump that modifies identical file types and version constants.
• Release v1.12.23 #3057: Prior release bump updating the same manifest files and embedded version strings.
• Release v1.12.9 #2501: Earlier version bump following the same update pattern across CHANGELOG, CMakeLists, and csrc version.cc.

Suggested labels

size:M

Poem

🐰 Hops of joy for point-two-four!
Version bumps forevermore,
From one-twelve-three, a hop we go,
Let it build and let it flow! ✨

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Summary of Changes

Hello @csukuangfj, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This release, v1.12.24, significantly enhances the sherpa-onnx project by expanding its Text-to-Speech (TTS) capabilities with broad multi-language API support for PocketTTS. It also integrates new Automatic Speech Recognition (ASR) models and introduces advanced ASR features. The update includes crucial bug fixes and build system refinements, particularly for Windows and Android, ensuring improved stability and broader compatibility across various development environments.

Highlights

• PocketTTS Expansion: Added comprehensive API support for PocketTTS across numerous languages and platforms, including C++, Python, Java/Kotlin, Swift, Node.js, Go, Pascal, C#, Dart, and WebAssembly, significantly broadening its accessibility.
• New ASR Model Integrations: Introduced support for several new Automatic Speech Recognition (ASR) models, such as WenetSpeech-Wu u2pp, Meta Omnilingual ASR v2, and Vietnamese ASR models, along with a Vosk model.
• ASR Feature Enhancements: Implemented new ASR functionalities including BPE tokenizer support, hotword detection for FunASR-Nano, and advanced NeMo transducer decoder options like ys_log_probs and modified beam search.
• Platform Stability and Fixes: Addressed critical build issues and improved stability across platforms, notably fixing MSVC CRT support for various Windows architectures and optimizing Android UI updates and model initialization.
• Security Vulnerability Resolution: Resolved a high-severity Python vulnerability related to dangerous system calls with tainted environment arguments.

Changelog

• CHANGELOG.md
  • Updated with release notes for version 1.12.24, detailing numerous fixes, new features, and API additions.

Activity

• No human activity has been recorded on this pull request since its creation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request is for the v1.12.24 release. It primarily consists of version bumps across numerous files, including build configurations, package manifests, and documentation. The CHANGELOG.md has also been updated with a comprehensive list of changes for this release. The modifications appear to be systematically applied, likely by the new-release.sh script, and are consistent across the repository. The changes are appropriate for a release, and I found no issues.

[Copilot]

Pull request overview

Release bump to v1.12.24, updating version references across the C++ core, Python wheels, Android/Flutter/Dart examples, Node examples, HarmonyOS packages, and release metadata.

Changes:

• Bump version strings from 1.12.23 → 1.12.24 across build/packaging manifests (CMake, Python, Maven, Gradle, Podspec, pubspec, npm, ohpm).
• Update Android versionCode to 20260210 and refresh git date/sha in version.cc.
• Add CHANGELOG entry for 1.12.24 and update a README link target for the Flutter streaming ASR APK section.

Reviewed changes

Copilot reviewed 58 out of 58 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
sherpa-onnx/csrc/version.cc	Updates embedded git date/sha and library version string to 1.12.24.
setup.py	Pins split-package dependency to sherpa-onnx-core==1.12.24.
scripts/wheel/sherpa-onnx-core/setup.py	Bumps sherpa-onnx-core wheel version to 1.12.24.
scripts/wheel/sherpa-onnx-bin/setup.py	Bumps sherpa-onnx-bin wheel version and core dependency to 1.12.24.
pom.xml	Bumps Android Maven artifact version to 1.12.24.
nodejs-examples/package.json	Updates example dependency to sherpa-onnx ^1.12.24.
nodejs-addon-examples/package.json	Updates example dependency to sherpa-onnx-node ^1.12.24.
new-release.sh	Advances old/new version + versionCode pair for the release script.
mfc-examples/README.md	Updates pre-built EXE download URLs to v1.12.24.
jitpack.yml	Updates downloaded AAR and installed Maven version to 1.12.24.
harmony-os/SherpaOnnxVadAsr/entry/oh-package.json5	Bumps HarmonyOS dependency version to 1.12.24.
harmony-os/SherpaOnnxVadAsr/entry/README.md	Updates referenced HAR filename to v1.12.24.
harmony-os/SherpaOnnxTts/entry/oh-package.json5	Bumps HarmonyOS dependency version to 1.12.24.
harmony-os/SherpaOnnxStreamingAsr/entry/oh-package.json5	Bumps HarmonyOS dependency version to 1.12.24.
harmony-os/SherpaOnnxSpeakerIdentification/entry/oh-package.json5	Bumps HarmonyOS dependency version to 1.12.24.
harmony-os/SherpaOnnxSpeakerDiarization/entry/oh-package.json5	Bumps HarmonyOS dependency version to 1.12.24.
harmony-os/SherpaOnnxHar/sherpa_onnx/oh-package.json5	Bumps HAR package version to 1.12.24.
harmony-os/SherpaOnnxHar/sherpa_onnx/README.md	Updates dependency snippet to 1.12.24.
harmony-os/SherpaOnnxHar/sherpa_onnx/BuildProfile.ets	Updates HAR_VERSION constant to 1.12.24.
flutter/sherpa_onnx_macos/macos/sherpa_onnx_macos.podspec	Bumps CocoaPods spec version to 1.12.24.
flutter/sherpa_onnx_ios/ios/sherpa_onnx_ios.podspec	Bumps CocoaPods spec version to 1.12.24.
flutter/sherpa_onnx/pubspec.yaml	Bumps Flutter plugin + platform package dependency versions to 1.12.24.
flutter-examples/tts/pubspec.yaml	Bumps example app version + sherpa_onnx dependency to 1.12.24.
flutter-examples/streaming_asr/pubspec.yaml	Bumps example app version + sherpa_onnx dependency to 1.12.24.
flutter-examples/non_streaming_vad_asr/pubspec.yaml	Bumps example app version + sherpa_onnx dependency to 1.12.24.
dart-api-examples/vad/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/vad-with-non-streaming-asr/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/tts/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/streaming-asr/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/spoken-language-identification/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/speech-enhancement-gtcrn/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/speaker-identification/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/speaker-diarization/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/non-streaming-asr/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/keyword-spotter/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/audio-tagging/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
dart-api-examples/add-punctuations/pubspec.yaml	Bumps sherpa_onnx dependency to 1.12.24.
build-ios-shared.sh	Updates iOS framework short version string to 1.12.24.
android/SherpaOnnxWebSocket/app/build.gradle	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxVadAsr/app/build.gradle	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxVad/app/build.gradle	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxTtsEngine/app/build.gradle.kts	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxTts/app/build.gradle	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxSpokenLanguageIdentification/app/build.gradle.kts	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxSpeakerIdentification/app/build.gradle.kts	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxSpeakerDiarization/app/build.gradle.kts	Bumps Android app versionCode/versionName and updates Maven dependency tag to v1.12.24.
android/SherpaOnnxSimulateStreamingAsrWearOs/app/build.gradle.kts	Bumps Android app versionCode/versionName and updates Maven dependency tag to v1.12.24.
android/SherpaOnnxSimulateStreamingAsr/app/build.gradle.kts	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxKws/app/build.gradle	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxJavaDemo/app/build.gradle	Bumps Android app versionCode/versionName and updates Maven dependency tag to v1.12.24.
android/SherpaOnnxAudioTaggingWearOs/app/build.gradle.kts	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxAudioTagging/app/build.gradle.kts	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnxAar/README.md	Updates Android tarball/AAR filenames to v1.12.24.
android/SherpaOnnx2Pass/app/build.gradle	Bumps Android app versionCode/versionName to the new release.
android/SherpaOnnx/app/build.gradle	Bumps Android app versionCode/versionName to the new release.
README.md	Updates Flutter streaming ASR pre-built app link references.
CMakeLists.txt	Updates canonical SHERPA_ONNX_VERSION to 1.12.24.
CHANGELOG.md	Adds release notes section for 1.12.24.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

apk-flutter-streaming-asr-cn now points to the exact same URL as apk-flutter-streaming-asr. If there is no separate CN page anymore, consider removing/renaming the -cn reference (and/or updating the table label) to avoid implying a different Chinese-specific link; otherwise, point it at the intended CN URL.

Suggested change

	[apk-flutter-streaming-asr-cn]: https://k2-fsa.github.io/sherpa/onnx/flutter/pre-built-app.html#streaming-speech-recognition-stt-asr
	[apk-flutter-streaming-asr-cn]: https://k2-fsa.github.io/sherpa/onnx/flutter/pre-built-app-cn.html#streaming-speech-recognition-stt-asr