add new model

runtime/android/build.gradle

+buildscript {
+    repositories {
+        google()
+        jcenter()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:4.1.3'
+    }
+}
+
+allprojects {
+    repositories {
+        google()
+        jcenter()
+        maven { url 'https://jitpack.io' }
+    }
+}
+
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}
\ No newline at end of file

runtime/android/gradle.properties

+# Project-wide Gradle settings.
+# IDE (e.g. Android Studio) users:
+# Gradle settings configured through the IDE *will override*
+# any settings specified in this file.
+# For more details on how to configure your build environment visit
+# http://www.gradle.org/docs/current/userguide/build_environment.html
+# Specifies the JVM arguments used for the daemon process.
+# The setting is particularly useful for tweaking memory settings.
+org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
+# When configured, Gradle will run in incubating parallel mode.
+# This option should only be used with decoupled projects. More details, visit
+# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
+# org.gradle.parallel=true
+# AndroidX package structure to make it clearer which packages are bundled with the
+# Android operating system, and which are packaged with your app"s APK
+# https://developer.android.com/topic/libraries/support-library/androidx-rn
+android.useAndroidX=true
+# Automatically convert third-party libraries to use AndroidX
+android.enableJetifier=true
\ No newline at end of file

runtime/android/gradle/wrapper/gradle-wrapper.properties

+#Tue Jan 12 17:33:20 CST 2021
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-bin.zip

runtime/android/gradlew

+#!/usr/bin/env sh
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"

runtime/android/gradlew.bat

+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS=
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto init
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto init
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:init
+@rem Get command-line arguments, handling Windows variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

runtime/android/settings.gradle

+include ':app'
+rootProject.name = "wenet"
\ No newline at end of file

runtime/binding/python/CMakeLists.txt

+cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+
+project(wenet VERSION 0.1)
+
+set(TORCH ON)  # Use torch for binding backend
+set(ONNX OFF)  # ONNX is not used
+set(CXX11_ABI OFF)
+set(FST_HAVE_BIN OFF)
+set(CMAKE_VERBOSE_MAKEFILE OFF)
+
+include(FetchContent)
+set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_EXTENSIONS OFF)
+set(FETCHCONTENT_QUIET OFF)
+get_filename_component(fc_base "fc_base" REALPATH BASE_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
+set(FETCHCONTENT_BASE_DIR ${fc_base})
+
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
+
+if(NOT MSVC)
+  # Keep the same with openfst, -fPIC or -fpic
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14 -pthread -fPIC")
+else()
+  set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
+  add_compile_options("$<$<CXX_COMPILER_ID:MSVC>:/utf-8>")
+endif()
+
+include(libtorch)
+include(openfst)
+include(pybind11)
+
+include_directories(
+  ${CMAKE_CURRENT_SOURCE_DIR}
+  ${CMAKE_CURRENT_SOURCE_DIR}/kaldi
+)
+
+add_subdirectory(utils)
+add_subdirectory(frontend)
+add_subdirectory(post_processor)
+add_subdirectory(kaldi)  # kaldi: wfst based decoder
+add_subdirectory(decoder)
+add_subdirectory(api)
+
+# wenet api
+pybind11_add_module(_wenet cpp/binding.cc)
+target_link_libraries(_wenet PRIVATE wenet_api)

runtime/binding/python/MANIFEST.in

+include README.md
+recursive-include py *.*

runtime/binding/python/README.md

+# WeNet Python Binding
+
+This is a python binding of WeNet.
+
+WeNet is a production first and production ready end-to-end speech recognition toolkit.
+
+The best things of the binding are:
+
+1. Multiple languages supports, including English, Chinese. Other languages are in development.
+2. Non-streaming and streaming API
+3. N-best, contextual biasing, and timestamp supports, which are very important for speech productions.
+4. Alignment support. You can get phone level alignments this tool, on developing.
+
+## Install
+
+Python 3.6+ is required.
+
+``` sh
+pip3 install wenetruntime
+```
+
+## Usage
+
+Note:
+
+1. For macOS, wenetruntime packed `libtorch.so`, so we can't import torch and wenetruntime at the same time.
+2. For Windows and Linux, wenetruntime depends on torch. Please install and import the same version `torch` as wenetruntime.
+
+### Non-streaming Usage
+
+``` python
+import sys
+import torch
+import wenetruntime as wenet
+
+wav_file = sys.argv[1]
+decoder = wenet.Decoder(lang='chs')
+ans = decoder.decode_wav(wav_file)
+print(ans)
+```
+
+You can also specify the following parameter in `wenet.Decoder`
+
+* `lang` (str): The language you used, `chs` for Chinese, and `en` for English.
+* `model_dir` (str): is the `Runtime Model` directory, it contains the following files.
+   If not provided, official model for specific `lang` will be downloaded automatically.
+
+  * `final.zip`: runtime TorchScript ASR model.
+  * `units.txt`: modeling units file
+  * `TLG.fst`: optional, it means decoding with LM when `TLG.fst` is given.
+  * `words.txt`: optional, word level symbol table for decoding with `TLG.fst`
+
+  Please refer https://github.com/wenet-e2e/wenet/blob/main/docs/pretrained_models.md for the details of `Runtime Model`.
+
+* `nbest` (int): Output the top-n best result.
+* `enable_timestamp` (bool): Whether to enable the word level timestamp.
+* `context` (List[str]): a list of context biasing words.
+* `context_score` (float): context bonus score.
+* `continuous_decoding` (bool): Whether to enable continuous(long) decoding.
+
+For example:
+``` python
+decoder = wenet.Decoder(model_dir,
+                        lang='chs',
+                        nbest=5,
+                        enable_timestamp=True,
+                        context=['不忘初心', '牢记使命'],
+                        context_score=3.0)
+```
+
+### Streaming Usage
+
+``` python
+import sys
+import torch
+import wave
+import wenetruntime as wenet
+
+test_wav = sys.argv[1]
+
+with wave.open(test_wav, 'rb') as fin:
+    assert fin.getnchannels() == 1
+    wav = fin.readframes(fin.getnframes())
+
+decoder = wenet.Decoder(lang='chs')
+# We suppose the wav is 16k, 16bits, and decode every 0.5 seconds
+interval = int(0.5 * 16000) * 2
+for i in range(0, len(wav), interval):
+    last = False if i + interval < len(wav) else True
+    chunk_wav = wav[i: min(i + interval, len(wav))]
+    ans = decoder.decode(chunk_wav, last)
+    print(ans)
+```
+
+You can use the same parameters as we introduced above to control the behavior of `wenet.Decoder`
+
+
+## Build on Your Local Machine
+
+``` sh
+git clone https://github.com/wenet-e2e/wenet.git
+cd wenet/runtime/binding/python
+python setup.py install
+```
+

runtime/binding/python/api

+../../core/api
\ No newline at end of file

runtime/binding/python/cmake

+../../core/cmake
\ No newline at end of file

runtime/binding/python/cpp/binding.cc

+// Copyright (c) 2022  Binbin Zhang(binbzha@qq.com)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <pybind11/pybind11.h>
+
+#include "api/wenet_api.h"
+
+namespace py = pybind11;
+
+
+PYBIND11_MODULE(_wenet, m) {
+  m.doc() = "wenet pybind11 plugin";  // optional module docstring
+  m.def("wenet_init", &wenet_init, py::return_value_policy::reference,
+        "wenet init");
+  m.def("wenet_free", &wenet_free, "wenet free");
+  m.def("wenet_reset", &wenet_reset, "wenet reset");
+  m.def("wenet_decode", &wenet_decode, "wenet decode");
+  m.def("wenet_get_result", &wenet_get_result, py::return_value_policy::copy,
+        "wenet get result");
+  m.def("wenet_set_log_level", &wenet_set_log_level, "set log level");
+  m.def("wenet_set_nbest", &wenet_set_nbest, "set nbest");
+  m.def("wenet_set_timestamp", &wenet_set_timestamp, "set timestamp flag");
+  m.def("wenet_add_context", &wenet_add_context, "add one context word");
+  m.def("wenet_set_context_score", &wenet_set_context_score,
+        "set context bonus score");
+  m.def("wenet_set_language", &wenet_set_language, "set language");
+  m.def("wenet_set_continuous_decoding", &wenet_set_continuous_decoding,
+        "enable continuous decoding or not");
+}

runtime/binding/python/decoder

+../../core/decoder
\ No newline at end of file

runtime/binding/python/frontend

+../../core/frontend
\ No newline at end of file

runtime/binding/python/kaldi

+../../core/kaldi
\ No newline at end of file

runtime/binding/python/patch

+../../core/patch
\ No newline at end of file

runtime/binding/python/post_processor

+../../core/post_processor
\ No newline at end of file

runtime/binding/python/py/__init__.py

+from .decoder import Decoder  # noqa
+from _wenet import wenet_set_log_level as set_log_level  # noqa

runtime/binding/python/py/decoder.py

+# Copyright (c) 2022  Binbin Zhang(binbzha@qq.com)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import List, Optional
+
+import _wenet
+
+from .hub import Hub
+
+
+class Decoder:
+
+    def __init__(self,
+                 model_dir: Optional[str] = None,
+                 lang: str = 'chs',
+                 nbest: int = 1,
+                 enable_timestamp: bool = False,
+                 context: Optional[List[str]] = None,
+                 context_score: float = 3.0,
+                 continuous_decoding: bool = False):
+        """ Init WeNet decoder
+        Args:
+            lang: language type of the model
+            nbest: nbest number for the final result
+            enable_timestamp: whether to enable word level timestamp
+               for the final result
+            context: context words
+            context_score: bonus score when the context is matched
+            continuous_decoding: enable countinous decoding or not
+        """
+        if model_dir is None:
+            model_dir = Hub.get_model_by_lang(lang)
+
+        self.d = _wenet.wenet_init(model_dir)
+
+        self.set_language(lang)
+        self.set_nbest(nbest)
+        self.enable_timestamp(enable_timestamp)
+        if context is not None:
+            self.add_context(context)
+            self.set_context_score(context_score)
+        self.set_continuous_decoding(continuous_decoding)
+
+    def __del__(self):
+        _wenet.wenet_free(self.d)
+
+    def reset(self):
+        """ Reset status for next decoding """
+        _wenet.wenet_reset(self.d)
+
+    def set_nbest(self, n: int):
+        assert n >= 1
+        assert n <= 10
+        _wenet.wenet_set_nbest(self.d, n)
+
+    def enable_timestamp(self, flag: bool):
+        tag = 1 if flag else 0
+        _wenet.wenet_set_timestamp(self.d, tag)
+
+    def add_context(self, contexts: List[str]):
+        for c in contexts:
+            assert isinstance(c, str)
+            _wenet.wenet_add_context(self.d, c)
+
+    def set_context_score(self, score: float):
+        _wenet.wenet_set_context_score(self.d, score)
+
+    def set_language(self, lang: str):
+        assert lang in ['chs', 'en']
+        _wenet.wenet_set_language(self.d, lang)
+
+    def set_continuous_decoding(self, continuous_decoding: bool):
+        flag = 1 if continuous_decoding else 0
+        _wenet.wenet_set_continuous_decoding(self.d, flag)
+
+    def decode(self, pcm: bytes, last: bool = True) -> str:
+        """ Decode the input data
+
+        Args:
+            pcm: wav pcm
+            last: if it is the last package of the data
+        """
+        assert isinstance(pcm, bytes)
+        finish = 1 if last else 0
+        _wenet.wenet_decode(self.d, pcm, len(pcm), finish)
+        result = _wenet.wenet_get_result(self.d)
+        if last:  # Reset status for next decoding automatically
+            self.reset()
+        return result
+
+    def decode_wav(self, wav_file: str) -> str:
+        """ Decode wav file, we only support:
+            1. 16k sample rate
+            2. mono channel
+            3. sample widths is 16 bits / 2 bytes
+        """
+        import wave
+        with wave.open(wav_file, 'rb') as fin:
+            assert fin.getnchannels() == 1
+            assert fin.getsampwidth() == 2
+            assert fin.getframerate() == 16000
+            wav = fin.readframes(fin.getnframes())
+        return self.decode(wav, True)