Flutter demo for real-time speech recognition (#1042)

This commit is contained in:
Fangjun Kuang
2024-06-23 13:29:13 +08:00
committed by GitHub
parent 9dd0e03568
commit 169c9bf627
67 changed files with 4056 additions and 235 deletions

1
scripts/flutter/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
!*.sh.in

View File

@@ -0,0 +1,74 @@
#!/usr/bin/env bash
set -ex
log() {
# This function is from espnet
local fname=${BASH_SOURCE[1]##*/}
echo -e "$(date '+%Y-%m-%d %H:%M:%S') (${fname}:${BASH_LINENO[0]}:${FUNCNAME[1]}) $*"
}
SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
SHERPA_ONNX_DIR=$(cd $SCRIPT_DIR/../.. && pwd)
log "SCRIPT_DIR: $SCRIPT_DIR"
log "SHERPA_ONNX_DIR: $SHERPA_ONNX_DIR"
SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" $SHERPA_ONNX_DIR/CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)
log "SHERPA_ONNX_VERSION: $SHERPA_ONNX_VERSION"
if [ -z $arch ]; then
arch=x86_64
fi
log "arch: $arch"
{% for model in model_list %}
pushd $SHERPA_ONNX_DIR/flutter-examples/streaming_asr/
model_name={{ model.model_name }}
lang={{ model.lang }}
type={{ model.idx }}
short_name={{ model.short_name }}
pushd assets
curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/${model_name}.tar.bz2
tar xvf ${model_name}.tar.bz2
{{ model.cmd }}
rm -rf *.tar.bz2
ls -lh $model_name
popd
git checkout ./
sed -i.bak "s| - assets/$| - assets/\n - assets/$model_name/|g" ./pubspec.yaml
sed -i.bak "s/final type = .*;$/final type = $type;/g" ./lib/streaming_asr.dart
{% if model.rule_fsts %}
rule_fsts={{ model.rule_fsts }}
sed -i.bak "s|ruleFsts: ''|ruleFsts: await copyAssetFile(\'assets/$rule_fsts\')|g" ./lib/streaming_asr.dart
{% endif %}
git diff .
flutter pub get
export FLUTTER_XCODE_ARCHS=$arch
log "FLUTTER_XCODE_ARCHS: $FLUTTER_XCODE_ARCHS"
flutter build macos
pushd build/macos/Build/Products/Release/
ls -lh
app=sherpa-onnx-$SHERPA_ONNX_VERSION-osx-$arch-asr-$lang-$short_name.app
mv streaming_asr.app $app
tar cjfv $app.tar.bz2 $app
ls -lh
mv $app.tar.bz2 $SHERPA_ONNX_DIR
popd
popd
{% endfor %}

View File

@@ -0,0 +1,65 @@
#!/usr/bin/env bash
set -ex
log() {
# This function is from espnet
local fname=${BASH_SOURCE[1]##*/}
echo -e "$(date '+%Y-%m-%d %H:%M:%S') (${fname}:${BASH_LINENO[0]}:${FUNCNAME[1]}) $*"
}
SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
SHERPA_ONNX_DIR=$(cd $SCRIPT_DIR/../.. && pwd)
log "SCRIPT_DIR: $SCRIPT_DIR"
log "SHERPA_ONNX_DIR: $SHERPA_ONNX_DIR"
SHERPA_ONNX_VERSION=$(grep "SHERPA_ONNX_VERSION" $SHERPA_ONNX_DIR/CMakeLists.txt | cut -d " " -f 2 | cut -d '"' -f 2)
log "SHERPA_ONNX_VERSION: $SHERPA_ONNX_VERSION"
{% for model in model_list %}
pushd $SHERPA_ONNX_DIR/flutter-examples/streaming_asr/
model_name={{ model.model_name }}
lang={{ model.lang }}
type={{ model.idx }}
short_name={{ model.short_name }}
pushd assets
curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/${model_name}.tar.bz2
tar xvf ${model_name}.tar.bz2
{{ model.cmd }}
rm -rf *.tar.bz2
ls -lh $model_name
popd
git checkout ./
sed -i.bak "s| - assets/$| - assets/\n - assets/$model_name/|g" ./pubspec.yaml
sed -i.bak "s/final type = .*;$/final type = $type;/g" ./lib/streaming_asr.dart
{% if model.rule_fsts %}
rule_fsts={{ model.rule_fsts }}
sed -i.bak "s|ruleFsts: ''|ruleFsts: await copyAssetFile(\'assets/$rule_fsts\')|g" ./lib/streaming_asr.dart
{% endif %}
git diff .
flutter pub get
flutter build windows
pushd build/windows/x64/runner/
ls -lh
dst=sherpa-onnx-$SHERPA_ONNX_VERSION-win-x64-asr-$lang-$short_name
mv Release $dst
tar cjfv $dst.tar.bz2 ./$dst
mv $dst.tar.bz2 $SHERPA_ONNX_DIR
popd
popd
{% endfor %}

View File

@@ -0,0 +1,193 @@
#!/usr/bin/env python3
import argparse
from dataclasses import dataclass
import jinja2
def get_args():
parser = argparse.ArgumentParser()
parser.add_argument(
"--total",
type=int,
default=1,
help="Number of runners",
)
parser.add_argument(
"--index",
type=int,
default=0,
help="Index of the current runner",
)
return parser.parse_args()
@dataclass
class Model:
# We will download
# https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/{model_name}.tar.bz2
model_name: str
# The type of the model, e..g, 0, 1, 2. It is hardcoded in the flutter code
# See flutter-example/streaming_asr/lib/online_model.dart
idx: int
# e.g., zh, en, zh_en
lang: str
# e.g., whisper, paraformer, zipformer
short_name: str = ""
# cmd is used to remove extra files from the model directory
cmd: str = ""
rule_fsts: str = ""
def get_models():
models = [
Model(
model_name="sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20",
idx=0,
lang="bilingual_zh_en",
short_name="zipformer",
rule_fsts="itn_zh_number.fst",
cmd="""
if [ ! -f itn_zh_number.fst ]; then
curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/itn_zh_number.fst
fi
pushd $model_name
rm -fv encoder-epoch-99-avg-1.onnx
rm -fv decoder-epoch-99-avg-1.int8.onnx
rm -fv joiner-epoch-99-avg-1.int8.onnx
rm -fv *.sh
rm -fv bpe.model
rm -fv README.md
rm -fv .gitattributes
rm -fv *state*
rm -rfv test_wavs
ls -lh
popd
""",
),
Model(
model_name="sherpa-onnx-streaming-zipformer-en-2023-06-26",
idx=1,
lang="en",
short_name="zipformer2",
cmd="""
pushd $model_name
rm -fv encoder-epoch-99-avg-1-chunk-16-left-128.onnx
rm -fv decoder-epoch-99-avg-1-chunk-16-left-128.int8.onnx
rm -fv joiner-epoch-99-avg-1-chunk-16-left-128.int8.onnx
rm -fv README.md
rm -fv bpe.model
rm -rfv test_wavs
ls -lh
popd
""",
),
Model(
model_name="icefall-asr-zipformer-streaming-wenetspeech-20230615",
idx=2,
lang="zh",
short_name="zipformer2",
rule_fsts="itn_zh_number.fst",
cmd="""
if [ ! -f itn_zh_number.fst ]; then
curl -SL -O https://github.com/k2-fsa/sherpa-onnx/releases/download/asr-models/itn_zh_number.fst
fi
pushd $model_name
rm -fv exp/encoder-epoch-12-avg-4-chunk-16-left-128.onnx
rm -fv exp/decoder-epoch-12-avg-4-chunk-16-left-128.int8.onnx
rm -fv exp/joiner-epoch-12-avg-4-chunk-16-left-128.int8.onnx
rm -fv data/lang_char/lexicon.txt
rm -fv data/lang_char/words.txt
rm -rfv test_wavs
rm -fv README.md
ls -lh exp/
ls -lh data/lang_char
popd
""",
),
Model(
model_name="sherpa-onnx-streaming-zipformer-fr-2023-04-14",
idx=3,
lang="fr",
short_name="zipformer",
cmd="""
pushd $model_name
rm -fv encoder-epoch-29-avg-9-with-averaged-model.onnx
rm -fv decoder-epoch-29-avg-9-with-averaged-model.int8.onnx
rm -fv joiner-epoch-29-avg-9-with-averaged-model.int8.onnx
rm -fv *.sh
rm -rfv test_wavs
rm README.md
ls -lh
popd
""",
),
]
return models
def main():
args = get_args()
index = args.index
total = args.total
assert 0 <= index < total, (index, total)
all_model_list = get_models()
num_models = len(all_model_list)
num_per_runner = num_models // total
if num_per_runner <= 0:
raise ValueError(f"num_models: {num_models}, num_runners: {total}")
start = index * num_per_runner
end = start + num_per_runner
remaining = num_models - args.total * num_per_runner
print(f"{index}/{total}: {start}-{end}/{num_models}")
d = dict()
d["model_list"] = all_model_list[start:end]
if index < remaining:
s = args.total * num_per_runner + index
d["model_list"].append(all_model_list[s])
print(f"{s}/{num_models}")
filename_list = [
"./build-macos-streaming-asr.sh",
"./build-windows-streaming-asr.sh",
]
for filename in filename_list:
environment = jinja2.Environment()
with open(f"{filename}.in") as f:
s = f.read()
template = environment.from_string(s)
s = template.render(**d)
with open(filename, "w") as f:
print(s, file=f)
if __name__ == "__main__":
main()