Skip to content

Commit

Permalink
Update doc about C API for sherpa-onnx (#636)
Browse files Browse the repository at this point in the history
  • Loading branch information
@csukuangfj
csukuangfj authored Aug 20, 2024
1 parent d97d823 commit 1de064e
Showing 1 changed file with 135 additions and 76 deletions.
211 changes: 135 additions & 76 deletions docs/source/onnx/c-api/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,66 +55,77 @@ You should find the following files inside ``/tmp/sherpa-onnx/shared``:
$ tree /tmp/sherpa-onnx/shared/
/tmp/sherpa-onnx/shared/
/tmp/sherpa-onnx/shared
├── bin
│   ├── sherpa-onnx
│   ├── sherpa-onnx-keyword-spotter
│   ├── sherpa-onnx-keyword-spotter-microphone
│   ├── sherpa-onnx-microphone
│   ├── sherpa-onnx-microphone-offline
│   ├── sherpa-onnx-microphone-offline-audio-tagging
│   ├── sherpa-onnx-microphone-offline-speaker-identification
│   ├── sherpa-onnx-offline
│   ├── sherpa-onnx-offline-audio-tagging
│   ├── sherpa-onnx-offline-language-identification
│   ├── sherpa-onnx-offline-parallel
│   ├── sherpa-onnx-offline-punctuation
│   ├── sherpa-onnx-offline-tts
│   ├── sherpa-onnx-offline-tts-play
│   ├── sherpa-onnx-offline-websocket-server
│   ├── sherpa-onnx-online-punctuation
│   ├── sherpa-onnx-online-websocket-client
│   └── sherpa-onnx-online-websocket-server
│   ├── sherpa-onnx-online-websocket-server
│   ├── sherpa-onnx-vad-microphone
│   └── sherpa-onnx-vad-microphone-offline-asr
├── include
│   ├── cargs.h
│   └── sherpa-onnx
│   └── c-api
│   └── c-api.h
├── lib
│   ├── cargs.h
│   ├── libcargs.dylib
│   ├── libkaldi-native-fbank-core.dylib
│   ├── libonnxruntime.1.15.1.dylib
│   ├── libonnxruntime.dylib -> libonnxruntime.1.15.1.dylib
│   ├── libsherpa-onnx-c-api.dylib
│   ├── libsherpa-onnx-core.dylib
│   └── libsherpa-onnx-portaudio.dylib
│   ├── libonnxruntime.1.17.1.dylib
│   ├── libonnxruntime.dylib -> libonnxruntime.1.17.1.dylib
│   └── libsherpa-onnx-c-api.dylib
└── sherpa-onnx.pc
5 directories, 18 files
5 directories, 25 files
.. tab:: Linux

.. code-block:: bash
$ tree /tmp/sherpa-onnx/shared/
/tmp/sherpa-onnx/shared/
|-- bin
| |-- sherpa-onnx
| |-- sherpa-onnx-alsa
| |-- sherpa-onnx-microphone
| |-- sherpa-onnx-microphone-offline
| |-- sherpa-onnx-offline
| |-- sherpa-onnx-offline-websocket-server
| |-- sherpa-onnx-online-websocket-client
| `-- sherpa-onnx-online-websocket-server
|-- include
| |-- cargs.h
| `-- sherpa-onnx
| `-- c-api
| `-- c-api.h
|-- lib
| |-- cargs.h
| |-- libcargs.so
| |-- libkaldi-native-fbank-core.so
| |-- libonnxruntime.so -> libonnxruntime.so.1.15.1
| |-- libonnxruntime.so.1.15.1
| |-- libsherpa-onnx-c-api.so
| |-- libsherpa-onnx-core.so
| `-- libsherpa-onnx-portaudio.so
`-- sherpa-onnx.pc
5 directories, 19 files
/tmp/sherpa-onnx/shared
├── bin
│   ├── sherpa-onnx
│   ├── sherpa-onnx-alsa
│   ├── sherpa-onnx-alsa-offline
│   ├── sherpa-onnx-alsa-offline-audio-tagging
│   ├── sherpa-onnx-alsa-offline-speaker-identification
│   ├── sherpa-onnx-keyword-spotter
│   ├── sherpa-onnx-keyword-spotter-alsa
│   ├── sherpa-onnx-offline
│   ├── sherpa-onnx-offline-audio-tagging
│   ├── sherpa-onnx-offline-language-identification
│   ├── sherpa-onnx-offline-parallel
│   ├── sherpa-onnx-offline-punctuation
│   ├── sherpa-onnx-offline-tts
│   ├── sherpa-onnx-offline-tts-play-alsa
│   ├── sherpa-onnx-offline-websocket-server
│   ├── sherpa-onnx-online-punctuation
│   ├── sherpa-onnx-online-websocket-client
│   ├── sherpa-onnx-online-websocket-server
│   └── sherpa-onnx-vad-alsa
├── include
│   └── sherpa-onnx
│   └── c-api
│   └── c-api.h
├── lib
│   ├── libonnxruntime.so
│   └── libsherpa-onnx-c-api.so
└── sherpa-onnx.pc
6 directories, 23 files
Build static libraries
Expand Down Expand Up @@ -150,67 +161,107 @@ You should find the following files in ``/tmp/sherpa-onnx/static``:
$ tree /tmp/sherpa-onnx/static/
/tmp/sherpa-onnx//static/
/tmp/sherpa-onnx/static
├── bin
│   ├── sherpa-onnx
│   ├── sherpa-onnx-keyword-spotter
│   ├── sherpa-onnx-keyword-spotter-microphone
│   ├── sherpa-onnx-microphone
│   ├── sherpa-onnx-microphone-offline
│   ├── sherpa-onnx-microphone-offline-audio-tagging
│   ├── sherpa-onnx-microphone-offline-speaker-identification
│   ├── sherpa-onnx-offline
│   ├── sherpa-onnx-offline-audio-tagging
│   ├── sherpa-onnx-offline-language-identification
│   ├── sherpa-onnx-offline-parallel
│   ├── sherpa-onnx-offline-punctuation
│   ├── sherpa-onnx-offline-tts
│   ├── sherpa-onnx-offline-tts-play
│   ├── sherpa-onnx-offline-websocket-server
│   ├── sherpa-onnx-online-punctuation
│   ├── sherpa-onnx-online-websocket-client
│   └── sherpa-onnx-online-websocket-server
│   ├── sherpa-onnx-online-websocket-server
│   ├── sherpa-onnx-vad-microphone
│   └── sherpa-onnx-vad-microphone-offline-asr
├── include
│   ├── cargs.h
│   └── sherpa-onnx
│   └── c-api
│   └── c-api.h
├── lib
│   ├── cargs.h
│   ├── libcargs.a
│   ├── libespeak-ng.a
│   ├── libkaldi-decoder-core.a
│   ├── libkaldi-native-fbank-core.a
│   ├── libonnxruntime.1.15.1.dylib
│   ├── libonnxruntime.dylib -> libonnxruntime.1.15.1.dylib
│   ├── libonnxruntime.a
│   ├── libpiper_phonemize.a
│   ├── libsherpa-onnx-c-api.a
│   ├── libsherpa-onnx-core.a
│   └── libsherpa-onnx-portaudio_static.a
│   ├── libsherpa-onnx-fst.a
│   ├── libsherpa-onnx-fstfar.a
│   ├── libsherpa-onnx-kaldifst-core.a
│   ├── libsherpa-onnx-portaudio_static.a
│   ├── libssentencepiece_core.a
│   └── libucd.a
└── sherpa-onnx.pc
5 directories, 18 files
5 directories, 35 files
.. tab:: Linux

.. code-block:: bash
$ tree /tmp/sherpa-onnx/static/
/tmp/sherpa-onnx/static/
|-- bin
| |-- sherpa-onnx
| |-- sherpa-onnx-alsa
| |-- sherpa-onnx-microphone
| |-- sherpa-onnx-microphone-offline
| |-- sherpa-onnx-offline
| |-- sherpa-onnx-offline-websocket-server
| |-- sherpa-onnx-online-websocket-client
| `-- sherpa-onnx-online-websocket-server
|-- include
| |-- cargs.h
| `-- sherpa-onnx
| `-- c-api
| `-- c-api.h
|-- lib
| |-- cargs.h
| |-- libcargs.a
| |-- libkaldi-native-fbank-core.a
| |-- libonnxruntime.so -> libonnxruntime.so.1.15.1
| |-- libonnxruntime.so.1.15.1
| |-- libsherpa-onnx-c-api.a
| |-- libsherpa-onnx-core.a
| `-- libsherpa-onnx-portaudio_static.a
`-- sherpa-onnx.pc
5 directories, 19 files
/tmp/sherpa-onnx/static
├── bin
│   ├── sherpa-onnx
│   ├── sherpa-onnx-alsa
│   ├── sherpa-onnx-alsa-offline
│   ├── sherpa-onnx-alsa-offline-audio-tagging
│   ├── sherpa-onnx-alsa-offline-speaker-identification
│   ├── sherpa-onnx-keyword-spotter
│   ├── sherpa-onnx-keyword-spotter-alsa
│   ├── sherpa-onnx-keyword-spotter-microphone
│   ├── sherpa-onnx-microphone
│   ├── sherpa-onnx-microphone-offline
│   ├── sherpa-onnx-microphone-offline-audio-tagging
│   ├── sherpa-onnx-microphone-offline-speaker-identification
│   ├── sherpa-onnx-offline
│   ├── sherpa-onnx-offline-audio-tagging
│   ├── sherpa-onnx-offline-language-identification
│   ├── sherpa-onnx-offline-parallel
│   ├── sherpa-onnx-offline-punctuation
│   ├── sherpa-onnx-offline-tts
│   ├── sherpa-onnx-offline-tts-play
│   ├── sherpa-onnx-offline-tts-play-alsa
│   ├── sherpa-onnx-offline-websocket-server
│   ├── sherpa-onnx-online-punctuation
│   ├── sherpa-onnx-online-websocket-client
│   ├── sherpa-onnx-online-websocket-server
│   ├── sherpa-onnx-vad-alsa
│   ├── sherpa-onnx-vad-microphone
│   └── sherpa-onnx-vad-microphone-offline-asr
├── include
│   └── sherpa-onnx
│   └── c-api
│   └── c-api.h
├── lib
│   ├── libespeak-ng.a
│   ├── libkaldi-decoder-core.a
│   ├── libkaldi-native-fbank-core.a
│   ├── libonnxruntime.a
│   ├── libpiper_phonemize.a
│   ├── libsherpa-onnx-c-api.a
│   ├── libsherpa-onnx-core.a
│   ├── libsherpa-onnx-fst.a
│   ├── libsherpa-onnx-fstfar.a
│   ├── libsherpa-onnx-kaldifst-core.a
│   ├── libsherpa-onnx-portaudio_static.a
│   ├── libssentencepiece_core.a
│   └── libucd.a
└── sherpa-onnx.pc
6 directories, 42 files
Build decode-file-c-api.c with generated files
----------------------------------------------
Expand Down Expand Up @@ -245,6 +296,14 @@ We can use:
./decode-file-c-api --help
.. warning::

The order of linking the libraries matters. Please see

- Static link without TTS: `<https://github.com/k2-fsa/sherpa-onnx/blob/master/cmake/sherpa-onnx-static-no-tts.pc.in>`_
- Static link with TTS: `<https://github.com/k2-fsa/sherpa-onnx/blob/master/cmake/sherpa-onnx-static.pc.in>`_
- Dynamic link: `<https://github.com/k2-fsa/sherpa-onnx/blob/master/cmake/sherpa-onnx-shared.pc.in>`_

colab
-----

Expand Down

0 comments on commit 1de064e

Please sign in to comment.