Skip to content

Commit d12aa0e

Browse files
csukuangfjcsukuangfj
committed
Add Dart API for Zipformer CTC
1 parent 40bf3c3 commit d12aa0e

7 files changed

Lines changed: 260 additions & 1 deletion

File tree

‎.github/scripts/test-dart.sh‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ cd dart-api-examples
66

77
pushd non-streaming-asr
88

9+
echo '----------Zipformer CTC----------'
10+
./run-zipformer-ctc.sh
11+
rm -rf sherpa-onnx-*
12+
913
echo '----------SenseVoice----------'
1014
./run-sense-voice-with-hr.sh
1115
./run-sense-voice.sh
@@ -114,6 +118,10 @@ popd
114118

115119
pushd vad-with-non-streaming-asr
116120

121+
echo '----------Zipformer CTC----------'
122+
./run-zipformer-ctc.sh
123+
rm -rf sherpa-onnx-*
124+
117125
echo '----------Dolphin CTC----------'
118126
./run-dolphin-ctc.sh
119127
rm -rf sherpa-onnx-*

‎dart-api-examples/non-streaming-asr/bin/zipformer-ctc.dart‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
// Copyright (c) 2024 Xiaomi Corporation
2+
import 'dart:io';
3+
4+
import 'package:args/args.dart';
5+
import 'package:sherpa_onnx/sherpa_onnx.dart' as sherpa_onnx;
6+
7+
import './init.dart';
8+
9+
void main(List<String> arguments) async {
10+
await initSherpaOnnx();
11+
12+
final parser = ArgParser()
13+
..addOption('model', help: 'Path to the Zipformer CTC model')
14+
..addOption('tokens', help: 'Path to tokens.txt')
15+
..addOption('input-wav', help: 'Path to input.wav to transcribe');
16+
17+
final res = parser.parse(arguments);
18+
if (res['model'] == null ||
19+
res['tokens'] == null ||
20+
res['input-wav'] == null) {
21+
print(parser.usage);
22+
exit(1);
23+
}
24+
25+
final model = res['model'] as String;
26+
final tokens = res['tokens'] as String;
27+
final inputWav = res['input-wav'] as String;
28+
29+
final zipformerCtc = sherpa_onnx.OfflineZipformerCtcModelConfig(model: model);
30+
31+
final modelConfig = sherpa_onnx.OfflineModelConfig(
32+
zipformerCtc: zipformerCtc,
33+
tokens: tokens,
34+
debug: true,
35+
numThreads: 1,
36+
);
37+
final config = sherpa_onnx.OfflineRecognizerConfig(model: modelConfig);
38+
final recognizer = sherpa_onnx.OfflineRecognizer(config);
39+
40+
final waveData = sherpa_onnx.readWave(inputWav);
41+
final stream = recognizer.createStream();
42+
43+
stream.acceptWaveform(
44+
samples: waveData.samples, sampleRate: waveData.sampleRate);
45+
recognizer.decode(stream);
46+
47+
final result = recognizer.getResult(stream);
48+
print(result.text);
49+
50+
stream.free();
51+
recognizer.free();
52+
}

‎dart-api-examples/non-streaming-asr/run-zipformer-ctc.sh‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#!/usr/bin/env bash
2+
3+
set -ex
4+
5+
dart pub get
6+
7+
if [ ! -f ./sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03/tokens.txt ]; then
8+
curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03.tar.bz2
9+
10+
tar xvf sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03.tar.bz2
11+
rm sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03.tar.bz2
12+
fi
13+
14+
dart run \
15+
./bin/zipformer-ctc.dart \
16+
--model ./sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03/model.int8.onnx \
17+
--tokens ./sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03/tokens.txt \
18+
--input-wav ./sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03/test_wavs/0.wav

‎dart-api-examples/vad-with-non-streaming-asr/bin/zipformer-ctc.dart‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
// Copyright (c) 2024 Xiaomi Corporation
2+
import 'dart:io';
3+
import 'dart:typed_data';
4+
5+
import 'package:args/args.dart';
6+
import 'package:sherpa_onnx/sherpa_onnx.dart' as sherpa_onnx;
7+
8+
import './init.dart';
9+
10+
void main(List<String> arguments) async {
11+
await initSherpaOnnx();
12+
13+
final parser = ArgParser()
14+
..addOption('silero-vad', help: 'Path to silero_vad.onnx')
15+
..addOption('model', help: 'Path to the Zipformer CTC model')
16+
..addOption('tokens', help: 'Path to tokens.txt')
17+
..addOption('input-wav', help: 'Path to input.wav to transcribe');
18+
19+
final res = parser.parse(arguments);
20+
if (res['silero-vad'] == null ||
21+
res['model'] == null ||
22+
res['tokens'] == null ||
23+
res['input-wav'] == null) {
24+
print(parser.usage);
25+
exit(1);
26+
}
27+
28+
// create VAD
29+
final sileroVad = res['silero-vad'] as String;
30+
31+
final sileroVadConfig = sherpa_onnx.SileroVadModelConfig(
32+
model: sileroVad,
33+
minSilenceDuration: 0.25,
34+
minSpeechDuration: 0.5,
35+
maxSpeechDuration: 5.0,
36+
);
37+
38+
final vadConfig = sherpa_onnx.VadModelConfig(
39+
sileroVad: sileroVadConfig,
40+
numThreads: 1,
41+
debug: true,
42+
);
43+
44+
final vad = sherpa_onnx.VoiceActivityDetector(
45+
config: vadConfig, bufferSizeInSeconds: 10);
46+
47+
// create offline recognizer
48+
final model = res['model'] as String;
49+
final tokens = res['tokens'] as String;
50+
final inputWav = res['input-wav'] as String;
51+
52+
final zipformerCtc = sherpa_onnx.OfflineZipformerCtcModelConfig(model: model);
53+
54+
final modelConfig = sherpa_onnx.OfflineModelConfig(
55+
zipformerCtc: zipformerCtc,
56+
tokens: tokens,
57+
debug: true,
58+
numThreads: 1,
59+
);
60+
final config = sherpa_onnx.OfflineRecognizerConfig(model: modelConfig);
61+
final recognizer = sherpa_onnx.OfflineRecognizer(config);
62+
63+
final waveData = sherpa_onnx.readWave(inputWav);
64+
if (waveData.sampleRate != 16000) {
65+
print('Only 16000 Hz is supported. Given: ${waveData.sampleRate}');
66+
exit(1);
67+
}
68+
69+
int numSamples = waveData.samples.length;
70+
int numIter = numSamples ~/ vadConfig.sileroVad.windowSize;
71+
72+
for (int i = 0; i != numIter; ++i) {
73+
int start = i * vadConfig.sileroVad.windowSize;
74+
vad.acceptWaveform(Float32List.sublistView(
75+
waveData.samples, start, start + vadConfig.sileroVad.windowSize));
76+
77+
while (!vad.isEmpty()) {
78+
final samples = vad.front().samples;
79+
final startTime = vad.front().start.toDouble() / waveData.sampleRate;
80+
final endTime =
81+
startTime + samples.length.toDouble() / waveData.sampleRate;
82+
83+
final stream = recognizer.createStream();
84+
stream.acceptWaveform(samples: samples, sampleRate: waveData.sampleRate);
85+
recognizer.decode(stream);
86+
87+
final result = recognizer.getResult(stream);
88+
stream.free();
89+
print(
90+
'${startTime.toStringAsPrecision(5)} -- ${endTime.toStringAsPrecision(5)} : ${result.text}');
91+
92+
vad.pop();
93+
}
94+
}
95+
96+
vad.flush();
97+
98+
while (!vad.isEmpty()) {
99+
final samples = vad.front().samples;
100+
final startTime = vad.front().start.toDouble() / waveData.sampleRate;
101+
final endTime = startTime + samples.length.toDouble() / waveData.sampleRate;
102+
103+
final stream = recognizer.createStream();
104+
stream.acceptWaveform(samples: samples, sampleRate: waveData.sampleRate);
105+
recognizer.decode(stream);
106+
107+
final result = recognizer.getResult(stream);
108+
stream.free();
109+
print(
110+
'${startTime.toStringAsPrecision(5)} -- ${endTime.toStringAsPrecision(5)} : ${result.text}');
111+
112+
vad.pop();
113+
}
114+
115+
vad.free();
116+
117+
recognizer.free();
118+
}

‎dart-api-examples/vad-with-non-streaming-asr/run-zipformer-ctc.sh‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#!/usr/bin/env bash
2+
3+
set -ex
4+
5+
dart pub get
6+
7+
if [ ! -f ./sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03/tokens.txt ]; then
8+
curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03.tar.bz2
9+
10+
tar xvf sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03.tar.bz2
11+
rm sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03.tar.bz2
12+
fi
13+
14+
if [ ! -f ./lei-jun-test.wav ]; then
15+
curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/lei-jun-test.wav
16+
fi
17+
18+
if [[ ! -f ./silero_vad.onnx ]]; then
19+
curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/silero_vad.onnx
20+
fi
21+
22+
dart run \
23+
./bin/zipformer-ctc.dart \
24+
--silero-vad ./silero_vad.onnx \
25+
--model ./sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03/model.int8.onnx \
26+
--tokens ./sherpa-onnx-zipformer-ctc-zh-int8-2025-07-03/tokens.txt \
27+
--input-wav ./lei-jun-test.wav

‎flutter/sherpa_onnx/lib/src/offline_recognizer.dart‎

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,27 @@ class OfflineDolphinModelConfig {
104104
final String model;
105105
}
106106

107+
class OfflineZipformerCtcModelConfig {
108+
const OfflineZipformerCtcModelConfig({this.model = ''});
109+
110+
factory OfflineZipformerCtcModelConfig.fromJson(Map<String, dynamic> json) {
111+
return OfflineZipformerCtcModelConfig(
112+
model: json['model'] as String? ?? '',
113+
);
114+
}
115+
116+
@override
117+
String toString() {
118+
return 'OfflineZipformerCtcModelConfig(model: $model)';
119+
}
120+
121+
Map<String, dynamic> toJson() => {
122+
'model': model,
123+
};
124+
125+
final String model;
126+
}
127+
107128
class OfflineWhisperModelConfig {
108129
const OfflineWhisperModelConfig(
109130
{this.encoder = '',
@@ -288,6 +309,7 @@ class OfflineModelConfig {
288309
this.moonshine = const OfflineMoonshineModelConfig(),
289310
this.fireRedAsr = const OfflineFireRedAsrModelConfig(),
290311
this.dolphin = const OfflineDolphinModelConfig(),
312+
this.zipformerCtc = const OfflineZipformerCtcModelConfig(),
291313
required this.tokens,
292314
this.numThreads = 1,
293315
this.debug = true,
@@ -336,6 +358,10 @@ class OfflineModelConfig {
336358
? OfflineDolphinModelConfig.fromJson(
337359
json['dolphin'] as Map<String, dynamic>)
338360
: const OfflineDolphinModelConfig(),
361+
zipformerCtc: json['zipformerCtc'] != null
362+
? OfflineZipformerCtcModelConfig.fromJson(
363+
json['zipformerCtc'] as Map<String, dynamic>)
364+
: const OfflineZipformerCtcModelConfig(),
339365
tokens: json['tokens'] as String,
340366
numThreads: json['numThreads'] as int? ?? 1,
341367
debug: json['debug'] as bool? ?? true,
@@ -349,7 +375,7 @@ class OfflineModelConfig {
349375

350376
@override
351377
String toString() {
352-
return 'OfflineModelConfig(transducer: $transducer, paraformer: $paraformer, nemoCtc: $nemoCtc, whisper: $whisper, tdnn: $tdnn, senseVoice: $senseVoice, moonshine: $moonshine, fireRedAsr: $fireRedAsr, dolphin: $dolphin, tokens: $tokens, numThreads: $numThreads, debug: $debug, provider: $provider, modelType: $modelType, modelingUnit: $modelingUnit, bpeVocab: $bpeVocab, telespeechCtc: $telespeechCtc)';
378+
return 'OfflineModelConfig(transducer: $transducer, paraformer: $paraformer, nemoCtc: $nemoCtc, whisper: $whisper, tdnn: $tdnn, senseVoice: $senseVoice, moonshine: $moonshine, fireRedAsr: $fireRedAsr, dolphin: $dolphin, zipformerCtc: $zipformerCtc, tokens: $tokens, numThreads: $numThreads, debug: $debug, provider: $provider, modelType: $modelType, modelingUnit: $modelingUnit, bpeVocab: $bpeVocab, telespeechCtc: $telespeechCtc)';
353379
}
354380

355381
Map<String, dynamic> toJson() => {
@@ -362,6 +388,7 @@ class OfflineModelConfig {
362388
'moonshine': moonshine.toJson(),
363389
'fireRedAsr': fireRedAsr.toJson(),
364390
'dolphin': dolphin.toJson(),
391+
'zipformerCtc': zipformerCtc.toJson(),
365392
'tokens': tokens,
366393
'numThreads': numThreads,
367394
'debug': debug,
@@ -381,6 +408,7 @@ class OfflineModelConfig {
381408
final OfflineMoonshineModelConfig moonshine;
382409
final OfflineFireRedAsrModelConfig fireRedAsr;
383410
final OfflineDolphinModelConfig dolphin;
411+
final OfflineZipformerCtcModelConfig zipformerCtc;
384412

385413
final String tokens;
386414
final int numThreads;
@@ -578,6 +606,8 @@ class OfflineRecognizer {
578606
config.model.fireRedAsr.decoder.toNativeUtf8();
579607

580608
c.ref.model.dolphin.model = config.model.dolphin.model.toNativeUtf8();
609+
c.ref.model.zipformerCtc.model =
610+
config.model.zipformerCtc.model.toNativeUtf8();
581611

582612
c.ref.model.tokens = config.model.tokens.toNativeUtf8();
583613

@@ -623,6 +653,7 @@ class OfflineRecognizer {
623653
calloc.free(c.ref.model.modelType);
624654
calloc.free(c.ref.model.provider);
625655
calloc.free(c.ref.model.tokens);
656+
calloc.free(c.ref.model.zipformerCtc.model);
626657
calloc.free(c.ref.model.dolphin.model);
627658
calloc.free(c.ref.model.fireRedAsr.decoder);
628659
calloc.free(c.ref.model.fireRedAsr.encoder);

‎flutter/sherpa_onnx/lib/src/sherpa_onnx_bindings.dart‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,10 @@ final class SherpaOnnxOfflineDolphinModelConfig extends Struct {
266266
external Pointer<Utf8> model;
267267
}
268268

269+
final class SherpaOnnxOfflineZipformerCtcModelConfig extends Struct {
270+
external Pointer<Utf8> model;
271+
}
272+
269273
final class SherpaOnnxOfflineWhisperModelConfig extends Struct {
270274
external Pointer<Utf8> encoder;
271275
external Pointer<Utf8> decoder;
@@ -333,6 +337,7 @@ final class SherpaOnnxOfflineModelConfig extends Struct {
333337
external SherpaOnnxOfflineMoonshineModelConfig moonshine;
334338
external SherpaOnnxOfflineFireRedAsrModelConfig fireRedAsr;
335339
external SherpaOnnxOfflineDolphinModelConfig dolphin;
340+
external SherpaOnnxOfflineZipformerCtcModelConfig zipformerCtc;
336341
}
337342

338343
final class SherpaOnnxOfflineRecognizerConfig extends Struct {

0 commit comments

Comments
 (0)