Refactor C API to prefix each API with SherpaOnnx. (#1171)

k2-fsa · Jul 26, 2024 · 4e6aeff · 4e6aeff
1 parent 994c3e7
commit 4e6aeff
Show file tree

Hide file tree

Showing 47 changed files with 667 additions and 618 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.10.19
+
+* Prefix all C API functions with SherpaOnnx
+
 ## 1.10.18
 
 * Fix the case when recognition results contain the symbol `"`. It caused

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -11,7 +11,7 @@ project(sherpa-onnx)
 # ./nodejs-addon-examples
 # ./dart-api-examples/
 # ./CHANGELOG.md
-set(SHERPA_ONNX_VERSION "1.10.18")
+set(SHERPA_ONNX_VERSION "1.10.19")
 
 # Disable warning about
 #

diff --git a/c-api-examples/asr-microphone-example/c-api-alsa.cc b/c-api-examples/asr-microphone-example/c-api-alsa.cc
@@ -189,10 +189,11 @@ int32_t main(int32_t argc, char *argv[]) {
   }
 
   const SherpaOnnxOnlineRecognizer *recognizer =
-      CreateOnlineRecognizer(&config);
-  const SherpaOnnxOnlineStream *stream = CreateOnlineStream(recognizer);
+      SherpaOnnxCreateOnlineRecognizer(&config);
+  const SherpaOnnxOnlineStream *stream =
+      SherpaOnnxCreateOnlineStream(recognizer);
 
-  const SherpaOnnxDisplay *display = CreateDisplay(50);
+  const SherpaOnnxDisplay *display = SherpaOnnxCreateDisplay(50);
   int32_t segment_id = 0;
 
   const char *device_name = argv[context.index];
@@ -218,17 +219,17 @@ int32_t main(int32_t argc, char *argv[]) {
 
   while (!stop) {
     const std::vector<float> &samples = alsa.Read(chunk);
-    AcceptWaveform(stream, expected_sample_rate, samples.data(),
-                   samples.size());
-    while (IsOnlineStreamReady(recognizer, stream)) {
-      DecodeOnlineStream(recognizer, stream);
+    SherpaOnnxOnlineStreamAcceptWaveform(stream, expected_sample_rate,
+                                         samples.data(), samples.size());
+    while (SherpaOnnxIsOnlineStreamReady(recognizer, stream)) {
+      SherpaOnnxDecodeOnlineStream(recognizer, stream);
     }
 
     const SherpaOnnxOnlineRecognizerResult *r =
-        GetOnlineStreamResult(recognizer, stream);
+        SherpaOnnxGetOnlineStreamResult(recognizer, stream);
 
     std::string text = r->text;
-    DestroyOnlineRecognizerResult(r);
+    SherpaOnnxDestroyOnlineRecognizerResult(r);
 
     if (!text.empty() && last_text != text) {
       last_text = text;
@@ -240,18 +241,18 @@ int32_t main(int32_t argc, char *argv[]) {
       fflush(stderr);
     }
 
-    if (IsEndpoint(recognizer, stream)) {
+    if (SherpaOnnxOnlineStreamIsEndpoint(recognizer, stream)) {
       if (!text.empty()) {
         ++segment_index;
       }
-      Reset(recognizer, stream);
+      SherpaOnnxOnlineStreamReset(recognizer, stream);
     }
   }
 
   // free allocated resources
-  DestroyDisplay(display);
-  DestroyOnlineStream(stream);
-  DestroyOnlineRecognizer(recognizer);
+  SherpaOnnxDestroyDisplay(display);
+  SherpaOnnxDestroyOnlineStream(stream);
+  SherpaOnnxDestroyOnlineRecognizer(recognizer);
   fprintf(stderr, "\n");
 
   return 0;

diff --git a/c-api-examples/audio-tagging-c-api.c b/c-api-examples/audio-tagging-c-api.c
@@ -54,8 +54,8 @@ int32_t main() {
   const SherpaOnnxOfflineStream *stream =
       SherpaOnnxAudioTaggingCreateOfflineStream(tagger);
 
-  AcceptWaveformOffline(stream, wave->sample_rate, wave->samples,
-                        wave->num_samples);
+  SherpaOnnxAcceptWaveformOffline(stream, wave->sample_rate, wave->samples,
+                                  wave->num_samples);
 
   int32_t top_k = 5;
   const SherpaOnnxAudioEvent *const *results =
@@ -71,7 +71,7 @@ int32_t main() {
   fprintf(stderr, "--------------------------------------------------\n");
 
   SherpaOnnxAudioTaggingFreeResults(results);
-  DestroyOfflineStream(stream);
+  SherpaOnnxDestroyOfflineStream(stream);
   SherpaOnnxFreeWave(wave);
   SherpaOnnxDestroyAudioTagging(tagger);
 

diff --git a/c-api-examples/decode-file-c-api.c b/c-api-examples/decode-file-c-api.c
@@ -163,10 +163,11 @@ int32_t main(int32_t argc, char *argv[]) {
   }
 
   const SherpaOnnxOnlineRecognizer *recognizer =
-      CreateOnlineRecognizer(&config);
-  const SherpaOnnxOnlineStream *stream = CreateOnlineStream(recognizer);
+      SherpaOnnxCreateOnlineRecognizer(&config);
+  const SherpaOnnxOnlineStream *stream =
+      SherpaOnnxCreateOnlineStream(recognizer);
 
-  const SherpaOnnxDisplay *display = CreateDisplay(50);
+  const SherpaOnnxDisplay *display = SherpaOnnxCreateDisplay(50);
   int32_t segment_id = 0;
 
   const char *wav_filename = argv[context.index];
@@ -190,52 +191,53 @@ int32_t main(int32_t argc, char *argv[]) {
         (start + N > wave->num_samples) ? wave->num_samples : (start + N);
     k += N;
 
-    AcceptWaveform(stream, wave->sample_rate, wave->samples + start,
-                   end - start);
-    while (IsOnlineStreamReady(recognizer, stream)) {
-      DecodeOnlineStream(recognizer, stream);
+    SherpaOnnxOnlineStreamAcceptWaveform(stream, wave->sample_rate,
+                                         wave->samples + start, end - start);
+    while (SherpaOnnxIsOnlineStreamReady(recognizer, stream)) {
+      SherpaOnnxDecodeOnlineStream(recognizer, stream);
     }
 
     const SherpaOnnxOnlineRecognizerResult *r =
-        GetOnlineStreamResult(recognizer, stream);
+        SherpaOnnxGetOnlineStreamResult(recognizer, stream);
 
     if (strlen(r->text)) {
       SherpaOnnxPrint(display, segment_id, r->text);
     }
 
-    if (IsEndpoint(recognizer, stream)) {
+    if (SherpaOnnxOnlineStreamIsEndpoint(recognizer, stream)) {
       if (strlen(r->text)) {
         ++segment_id;
       }
-      Reset(recognizer, stream);
+      SherpaOnnxOnlineStreamReset(recognizer, stream);
     }
 
-    DestroyOnlineRecognizerResult(r);
+    SherpaOnnxDestroyOnlineRecognizerResult(r);
   }
 
   // add some tail padding
   float tail_paddings[4800] = {0};  // 0.3 seconds at 16 kHz sample rate
-  AcceptWaveform(stream, wave->sample_rate, tail_paddings, 4800);
+  SherpaOnnxOnlineStreamAcceptWaveform(stream, wave->sample_rate, tail_paddings,
+                                       4800);
 
   SherpaOnnxFreeWave(wave);
 
-  InputFinished(stream);
-  while (IsOnlineStreamReady(recognizer, stream)) {
-    DecodeOnlineStream(recognizer, stream);
+  SherpaOnnxOnlineStreamInputFinished(stream);
+  while (SherpaOnnxIsOnlineStreamReady(recognizer, stream)) {
+    SherpaOnnxDecodeOnlineStream(recognizer, stream);
   }
 
   const SherpaOnnxOnlineRecognizerResult *r =
-      GetOnlineStreamResult(recognizer, stream);
+      SherpaOnnxGetOnlineStreamResult(recognizer, stream);
 
   if (strlen(r->text)) {
     SherpaOnnxPrint(display, segment_id, r->text);
   }
 
-  DestroyOnlineRecognizerResult(r);
+  SherpaOnnxDestroyOnlineRecognizerResult(r);
 
-  DestroyDisplay(display);
-  DestroyOnlineStream(stream);
-  DestroyOnlineRecognizer(recognizer);
+  SherpaOnnxDestroyDisplay(display);
+  SherpaOnnxDestroyOnlineStream(stream);
+  SherpaOnnxDestroyOnlineRecognizer(recognizer);
   fprintf(stderr, "\n");
 
   return 0;

diff --git a/c-api-examples/sense-voice-c-api.c b/c-api-examples/sense-voice-c-api.c
@@ -59,27 +59,27 @@ int32_t main() {
   recognizer_config.model_config = offline_model_config;
 
   SherpaOnnxOfflineRecognizer *recognizer =
-      CreateOfflineRecognizer(&recognizer_config);
+      SherpaOnnxCreateOfflineRecognizer(&recognizer_config);
 
   if (recognizer == NULL) {
     fprintf(stderr, "Please check your config!\n");
     SherpaOnnxFreeWave(wave);
     return -1;
   }
 
-  SherpaOnnxOfflineStream *stream = CreateOfflineStream(recognizer);
+  SherpaOnnxOfflineStream *stream = SherpaOnnxCreateOfflineStream(recognizer);
 
-  AcceptWaveformOffline(stream, wave->sample_rate, wave->samples,
-                        wave->num_samples);
-  DecodeOfflineStream(recognizer, stream);
+  SherpaOnnxAcceptWaveformOffline(stream, wave->sample_rate, wave->samples,
+                                  wave->num_samples);
+  SherpaOnnxDecodeOfflineStream(recognizer, stream);
   const SherpaOnnxOfflineRecognizerResult *result =
-      GetOfflineStreamResult(stream);
+      SherpaOnnxGetOfflineStreamResult(stream);
 
   fprintf(stderr, "Decoded text: %s\n", result->text);
 
-  DestroyOfflineRecognizerResult(result);
-  DestroyOfflineStream(stream);
-  DestroyOfflineRecognizer(recognizer);
+  SherpaOnnxDestroyOfflineRecognizerResult(result);
+  SherpaOnnxDestroyOfflineStream(stream);
+  SherpaOnnxDestroyOfflineRecognizer(recognizer);
   SherpaOnnxFreeWave(wave);
 
   return 0;

diff --git a/c-api-examples/speaker-identification-c-api.c b/c-api-examples/speaker-identification-c-api.c
@@ -37,8 +37,9 @@ static const float *ComputeEmbedding(
   const SherpaOnnxOnlineStream *stream =
       SherpaOnnxSpeakerEmbeddingExtractorCreateStream(ex);
 
-  AcceptWaveform(stream, wave->sample_rate, wave->samples, wave->num_samples);
-  InputFinished(stream);
+  SherpaOnnxOnlineStreamAcceptWaveform(stream, wave->sample_rate, wave->samples,
+                                       wave->num_samples);
+  SherpaOnnxOnlineStreamInputFinished(stream);
 
   if (!SherpaOnnxSpeakerEmbeddingExtractorIsReady(ex, stream)) {
     fprintf(stderr, "The input wave file %s is too short!\n", wav_filename);
@@ -49,7 +50,7 @@ static const float *ComputeEmbedding(
   const float *v =
       SherpaOnnxSpeakerEmbeddingExtractorComputeEmbedding(ex, stream);
 
-  DestroyOnlineStream(stream);
+  SherpaOnnxDestroyOnlineStream(stream);
   SherpaOnnxFreeWave(wave);
 
   // Remeber to free v to avoid memory leak

diff --git a/c-api-examples/spoken-language-identification-c-api.c b/c-api-examples/spoken-language-identification-c-api.c
@@ -50,8 +50,8 @@ int32_t main() {
   SherpaOnnxOfflineStream *stream =
       SherpaOnnxSpokenLanguageIdentificationCreateOfflineStream(slid);
 
-  AcceptWaveformOffline(stream, wave->sample_rate, wave->samples,
-                        wave->num_samples);
+  SherpaOnnxAcceptWaveformOffline(stream, wave->sample_rate, wave->samples,
+                                  wave->num_samples);
 
   const SherpaOnnxSpokenLanguageIdentificationResult *result =
       SherpaOnnxSpokenLanguageIdentificationCompute(slid, stream);
@@ -60,7 +60,7 @@ int32_t main() {
   fprintf(stderr, "Detected language: %s\n", result->lang);
 
   SherpaOnnxDestroySpokenLanguageIdentificationResult(result);
-  DestroyOfflineStream(stream);
+  SherpaOnnxDestroyOfflineStream(stream);
   SherpaOnnxFreeWave(wave);
   SherpaOnnxDestroySpokenLanguageIdentification(slid);
 

diff --git a/c-api-examples/streaming-hlg-decode-file-c-api.c b/c-api-examples/streaming-hlg-decode-file-c-api.c
@@ -45,15 +45,16 @@ int32_t main() {
   config.model_config.debug = 0;
   config.ctc_fst_decoder_config.graph = graph;
   const SherpaOnnxOnlineRecognizer *recognizer =
-      CreateOnlineRecognizer(&config);
+      SherpaOnnxCreateOnlineRecognizer(&config);
   if (!recognizer) {
     fprintf(stderr, "Failed to create recognizer");
     exit(-1);
   }
 
-  const SherpaOnnxOnlineStream *stream = CreateOnlineStream(recognizer);
+  const SherpaOnnxOnlineStream *stream =
+      SherpaOnnxCreateOnlineStream(recognizer);
 
-  const SherpaOnnxDisplay *display = CreateDisplay(50);
+  const SherpaOnnxDisplay *display = SherpaOnnxCreateDisplay(50);
   int32_t segment_id = 0;
 
   const SherpaOnnxWave *wave = SherpaOnnxReadWave(wav_filename);
@@ -76,52 +77,53 @@ int32_t main() {
         (start + N > wave->num_samples) ? wave->num_samples : (start + N);
     k += N;
 
-    AcceptWaveform(stream, wave->sample_rate, wave->samples + start,
-                   end - start);
-    while (IsOnlineStreamReady(recognizer, stream)) {
-      DecodeOnlineStream(recognizer, stream);
+    SherpaOnnxOnlineStreamAcceptWaveform(stream, wave->sample_rate,
+                                         wave->samples + start, end - start);
+    while (SherpaOnnxIsOnlineStreamReady(recognizer, stream)) {
+      SherpaOnnxDecodeOnlineStream(recognizer, stream);
     }
 
     const SherpaOnnxOnlineRecognizerResult *r =
-        GetOnlineStreamResult(recognizer, stream);
+        SherpaOnnxGetOnlineStreamResult(recognizer, stream);
 
     if (strlen(r->text)) {
       SherpaOnnxPrint(display, segment_id, r->text);
     }
 
-    if (IsEndpoint(recognizer, stream)) {
+    if (SherpaOnnxOnlineStreamIsEndpoint(recognizer, stream)) {
       if (strlen(r->text)) {
         ++segment_id;
       }
-      Reset(recognizer, stream);
+      SherpaOnnxOnlineStreamReset(recognizer, stream);
     }
 
-    DestroyOnlineRecognizerResult(r);
+    SherpaOnnxDestroyOnlineRecognizerResult(r);
   }
 
   // add some tail padding
   float tail_paddings[4800] = {0};  // 0.3 seconds at 16 kHz sample rate
-  AcceptWaveform(stream, wave->sample_rate, tail_paddings, 4800);
+  SherpaOnnxOnlineStreamAcceptWaveform(stream, wave->sample_rate, tail_paddings,
+                                       4800);
 
   SherpaOnnxFreeWave(wave);
 
-  InputFinished(stream);
-  while (IsOnlineStreamReady(recognizer, stream)) {
-    DecodeOnlineStream(recognizer, stream);
+  SherpaOnnxOnlineStreamInputFinished(stream);
+  while (SherpaOnnxIsOnlineStreamReady(recognizer, stream)) {
+    SherpaOnnxDecodeOnlineStream(recognizer, stream);
   }
 
   const SherpaOnnxOnlineRecognizerResult *r =
-      GetOnlineStreamResult(recognizer, stream);
+      SherpaOnnxGetOnlineStreamResult(recognizer, stream);
 
   if (strlen(r->text)) {
     SherpaOnnxPrint(display, segment_id, r->text);
   }
 
-  DestroyOnlineRecognizerResult(r);
+  SherpaOnnxDestroyOnlineRecognizerResult(r);
 
-  DestroyDisplay(display);
-  DestroyOnlineStream(stream);
-  DestroyOnlineRecognizer(recognizer);
+  SherpaOnnxDestroyDisplay(display);
+  SherpaOnnxDestroyOnlineStream(stream);
+  SherpaOnnxDestroyOnlineRecognizer(recognizer);
   fprintf(stderr, "\n");
 
   return 0;

diff --git a/c-api-examples/whisper-c-api.c b/c-api-examples/whisper-c-api.c
@@ -59,7 +59,7 @@ int32_t main() {
   recognizer_config.model_config = offline_model_config;
 
   SherpaOnnxOfflineRecognizer *recognizer =
-      CreateOfflineRecognizer(&recognizer_config);
+      SherpaOnnxCreateOfflineRecognizer(&recognizer_config);
 
   if (recognizer == NULL) {
     fprintf(stderr, "Please check your config!\n");
@@ -69,19 +69,19 @@ int32_t main() {
     return -1;
   }
 
-  SherpaOnnxOfflineStream *stream = CreateOfflineStream(recognizer);
+  SherpaOnnxOfflineStream *stream = SherpaOnnxCreateOfflineStream(recognizer);
 
-  AcceptWaveformOffline(stream, wave->sample_rate, wave->samples,
-                        wave->num_samples);
-  DecodeOfflineStream(recognizer, stream);
+  SherpaOnnxAcceptWaveformOffline(stream, wave->sample_rate, wave->samples,
+                                  wave->num_samples);
+  SherpaOnnxDecodeOfflineStream(recognizer, stream);
   const SherpaOnnxOfflineRecognizerResult *result =
-      GetOfflineStreamResult(stream);
+      SherpaOnnxGetOfflineStreamResult(stream);
 
   fprintf(stderr, "Decoded text: %s\n", result->text);
 
-  DestroyOfflineRecognizerResult(result);
-  DestroyOfflineStream(stream);
-  DestroyOfflineRecognizer(recognizer);
+  SherpaOnnxDestroyOfflineRecognizerResult(result);
+  SherpaOnnxDestroyOfflineStream(stream);
+  SherpaOnnxDestroyOfflineRecognizer(recognizer);
   SherpaOnnxFreeWave(wave);
 
   return 0;