sherpa-onnx C API 1.0
Public C API and C++ wrapper for sherpa-onnx
Loading...
Searching...
No Matches
cxx-api.h
Go to the documentation of this file.
1// sherpa-onnx/c-api/cxx-api.h
2//
3// Copyright (c) 2024 Xiaomi Corporation
44#ifndef SHERPA_ONNX_C_API_CXX_API_H_
45#define SHERPA_ONNX_C_API_CXX_API_H_
46
47#include <functional>
48#include <memory>
49#include <string>
50#include <unordered_map>
51#include <vector>
52
54
56
57// ============================================================================
58// Streaming ASR
59// ============================================================================
63 std::string encoder;
65 std::string decoder;
67 std::string joiner;
68};
69
73 std::string encoder;
75 std::string decoder;
76};
77
81 std::string model;
82};
83
87 std::string model;
88};
89
93 std::string model;
94};
95
150
154 int32_t sample_rate = 16000;
156 int32_t feature_dim = 80;
157};
158
162 std::string graph;
164 int32_t max_active = 3000;
165};
166
170 std::string dict_dir;
172 std::string lexicon;
174 std::string rule_fsts;
175};
176
244
248 std::string text;
250 std::vector<std::string> tokens;
252 std::vector<float> timestamps;
254 std::string json;
255};
256
258struct Wave {
260 std::vector<float> samples;
262 int32_t sample_rate = 0;
263};
264
273SHERPA_ONNX_API Wave ReadWave(const std::string &filename);
274
282SHERPA_ONNX_API bool WriteWave(const std::string &filename, const Wave &wave);
283
290template <typename Derived, typename T>
292 public:
294 MoveOnly() = default;
296 explicit MoveOnly(const T *p) : p_(p) {}
297
299 ~MoveOnly() { Destroy(); }
300
301 MoveOnly(const MoveOnly &) = delete;
302
303 MoveOnly &operator=(const MoveOnly &) = delete;
304
305 MoveOnly(MoveOnly &&other) : p_(other.Release()) {}
306
308 if (&other == this) {
309 return *this;
310 }
311
312 Destroy();
313
314 p_ = other.Release();
315
316 return *this;
317 }
318
320 const T *Get() const { return p_; }
321
323 const T *Release() {
324 const T *p = p_;
325 p_ = nullptr;
326 return p;
327 }
328
329 private:
330 void Destroy() {
331 if (p_ == nullptr) {
332 return;
333 }
334
335 static_cast<Derived *>(this)->Destroy(p_);
336
337 p_ = nullptr;
338 }
339
340 protected:
341 const T *p_ = nullptr;
342};
343
345 : public MoveOnly<OnlineStream, SherpaOnnxOnlineStream> {
346 public:
349
351 void AcceptWaveform(int32_t sample_rate, const float *samples,
352 int32_t n) const;
353
355 void InputFinished() const;
356
358 void SetOption(const char *key, const char *value) const;
360 const char *GetOption(const char *key) const;
362 int32_t HasOption(const char *key) const;
363
365 void Destroy(const SherpaOnnxOnlineStream *p) const;
366};
367
385class SHERPA_ONNX_API OnlineRecognizer
386 : public MoveOnly<OnlineRecognizer, SherpaOnnxOnlineRecognizer> {
387 public:
389 static OnlineRecognizer Create(const OnlineRecognizerConfig &config);
390
393
396
398 OnlineStream CreateStream(const std::string &hotwords) const;
399
401 bool IsReady(const OnlineStream *s) const;
402
404 void Decode(const OnlineStream *s) const;
405
407 void Decode(const OnlineStream *ss, int32_t n) const;
408
411
413 void Reset(const OnlineStream *s) const;
414
416 bool IsEndpoint(const OnlineStream *s) const;
417
418 private:
419 explicit OnlineRecognizer(const SherpaOnnxOnlineRecognizer *p);
420};
421
422// ============================================================================
423// Non-streaming ASR
424// ============================================================================
428 std::string encoder;
430 std::string decoder;
432 std::string joiner;
433};
434
438 std::string model;
439};
440
444 std::string model;
445};
446
450 std::string encoder;
452 std::string decoder;
454 std::string language;
456 std::string task = "transcribe";
458 int32_t tail_paddings = -1;
463};
464
468 std::string encoder;
470 std::string decoder;
472 std::string src_lang;
474 std::string tgt_lang;
476 bool use_pnc = true;
477};
478
482 std::string encoder;
484 std::string decoder;
486 std::string language;
488 bool use_punct = true;
490 bool use_itn = true;
491};
492
496 std::string encoder;
498 std::string decoder;
499};
500
504 std::string model;
505};
506
510 std::string model;
511};
512
516 std::string model;
518 std::string language;
520 bool use_itn = false;
521};
522
526 std::string model;
527};
528
532 std::string model;
533};
534
538 std::string model;
539};
540
546
550 std::string model;
551};
552
556 std::string preprocessor;
558 std::string encoder;
560 std::string uncached_decoder;
562 std::string cached_decoder;
564 std::string merged_decoder;
565};
566
570 std::string encoder_adaptor;
572 std::string llm;
574 std::string embedding;
576 std::string tokenizer;
578 std::string system_prompt = "You are a helpful assistant.";
580 std::string user_prompt = "语音转写:";
582 int32_t max_new_tokens = 512;
584 float temperature = 1e-6f;
586 float top_p = 0.8f;
588 int32_t seed = 42;
590 std::string language;
592 bool itn = true;
594 std::string hotwords;
595};
596
600 std::string conv_frontend;
602 std::string encoder;
604 std::string decoder;
606 std::string tokenizer;
609 std::string hotwords;
611 int32_t max_total_len = 512;
613 int32_t max_new_tokens = 128;
615 float temperature = 1e-6f;
617 float top_p = 0.8f;
619 int32_t seed = 42;
620};
621
683
687 std::string model;
689 float scale = 1.0;
690};
691
695 std::string graph;
697 int32_t max_active = 3000;
698};
699
761
765 std::string text;
767 std::vector<float> timestamps;
769 std::vector<std::string> tokens;
771 std::string json;
773 std::string lang;
775 std::string emotion;
777 std::string event;
778
780 std::vector<float> durations;
781};
782
785 : public MoveOnly<OfflineStream, SherpaOnnxOfflineStream> {
786 public:
789
791 void AcceptWaveform(int32_t sample_rate, const float *samples,
792 int32_t n) const;
793
795 void SetOption(const char *key, const char *value) const;
797 const char *GetOption(const char *key) const;
799 int32_t HasOption(const char *key) const;
800
802 void Destroy(const SherpaOnnxOfflineStream *p) const;
803};
804
811class SHERPA_ONNX_API OfflineRecognizer
812 : public MoveOnly<OfflineRecognizer, SherpaOnnxOfflineRecognizer> {
813 public:
815 static OfflineRecognizer Create(const OfflineRecognizerConfig &config);
816
819
822
824 OfflineStream CreateStream(const std::string &hotwords) const;
825
827 void Decode(const OfflineStream *s) const;
828
830 void Decode(const OfflineStream *ss, int32_t n) const;
831
834
841 std::shared_ptr<OfflineRecognizerResult> GetResultPtr(
842 const OfflineStream *s) const;
843
845 void SetConfig(const OfflineRecognizerConfig &config) const;
846
847 private:
848 explicit OfflineRecognizer(const SherpaOnnxOfflineRecognizer *p);
849};
850
851// ============================================================================
852// Forced alignment
853// ============================================================================
854
863 float beam = 10.0f;
864
869 float retry_beam = 40.0f;
870
875 float transition_scale = 1.0f;
876
881 float self_loop_scale = 0.1f;
882
887 float acoustic_scale = 0.1f;
888};
889
910 std::string model_dir;
911
941 std::string lexicon;
942
948
953 bool debug = false;
954};
955
964 float start = 0.0f;
965
969 float end = 0.0f;
970
977 std::string text;
978};
979
987 std::string name;
988
992 std::vector<ForcedAlignmentInterval> intervals;
993};
994
1004 float duration = 0.0f;
1005
1011 std::string textgrid;
1012
1017 std::vector<ForcedAlignmentTier> tiers;
1018};
1019
1042class SHERPA_ONNX_API ForcedAligner
1043 : public MoveOnly<ForcedAligner, SherpaOnnxForcedAligner> {
1044 public:
1049 static ForcedAligner Create(const ForcedAlignerConfig &config);
1050
1054 void Destroy(const SherpaOnnxForcedAligner *p) const;
1055
1062
1077 const std::string &text) const;
1078
1079 private:
1080 explicit ForcedAligner(const SherpaOnnxForcedAligner *p);
1081};
1082
1083// ============================================================================
1084// Non-streaming TTS
1085// ============================================================================
1089 std::string model;
1091 std::string lexicon;
1093 std::string tokens;
1100 std::string data_dir;
1102 std::string dict_dir;
1103
1105 float noise_scale = 0.667;
1107 float noise_scale_w = 0.8;
1109 float length_scale = 1.0;
1110};
1111
1115 std::string acoustic_model;
1117 std::string vocoder;
1119 std::string lexicon;
1121 std::string tokens;
1128 std::string data_dir;
1130 std::string dict_dir;
1131
1133 float noise_scale = 0.667;
1135 float length_scale = 1.0;
1136};
1137
1141 std::string model;
1143 std::string voices;
1145 std::string tokens;
1152 std::string data_dir;
1154 std::string dict_dir;
1156 std::string lexicon;
1158 std::string lang;
1159
1161 float length_scale = 1.0;
1162};
1163
1167 std::string model;
1169 std::string voices;
1171 std::string tokens;
1178 std::string data_dir;
1179
1181 float length_scale = 1.0;
1182
1184 std::string lexicon;
1185};
1186
1190 std::string tokens;
1192 std::string encoder;
1194 std::string decoder;
1196 std::string vocoder;
1203 std::string data_dir;
1205 std::string lexicon;
1206
1208 float feat_scale = 0.1;
1210 float t_shift = 0.5;
1212 float target_rms = 0.1;
1214 float guidance_scale = 1.0;
1215};
1216
1220 std::string lm_flow;
1222 std::string lm_main;
1224 std::string encoder;
1226 std::string decoder;
1228 std::string text_conditioner;
1229
1231 std::string vocab_json;
1236};
1237
1243 std::string text_encoder;
1245 std::string vector_estimator;
1247 std::string vocoder;
1249 std::string tts_json;
1251 std::string unicode_indexer;
1253 std::string voice_style;
1254};
1255
1285
1289 float silence_scale = 0.2;
1291 float speed = 1.0;
1293 int32_t sid = 0;
1295 std::vector<float> reference_audio;
1299 std::string reference_text;
1301 int32_t num_steps = 5;
1302
1304 std::unordered_map<std::string, std::string> extra;
1305
1315 std::vector<std::vector<int32_t>> phoneme_codepoints;
1316
1325 std::vector<std::vector<std::string>> tokens;
1326};
1327
1341
1345 std::vector<float> samples;
1347 int32_t sample_rate = 0;
1348};
1349
1355using OfflineTtsCallback = int32_t (*)(const float *samples,
1356 int32_t num_samples, float progress,
1357 void *arg);
1358
1382class SHERPA_ONNX_API OfflineTts
1383 : public MoveOnly<OfflineTts, SherpaOnnxOfflineTts> {
1384 public:
1386 static OfflineTts Create(const OfflineTtsConfig &config);
1387
1389 void Destroy(const SherpaOnnxOfflineTts *p) const;
1390
1392 int32_t SampleRate() const;
1393
1395 int32_t NumSpeakers() const;
1396
1400 std::string Lang() const;
1401
1408 GeneratedAudio Generate(const std::string &text, int32_t sid = 0,
1409 float speed = 1.0,
1410 OfflineTtsCallback callback = nullptr,
1411 void *arg = nullptr) const;
1412
1414 GeneratedAudio Generate(const std::string &text,
1415 const GenerationConfig &config,
1416 OfflineTtsCallback callback = nullptr,
1417 void *arg = nullptr) const;
1418
1420 std::shared_ptr<GeneratedAudio> Generate2(
1421 const std::string &text, int32_t sid = 0, float speed = 1.0,
1422 OfflineTtsCallback callback = nullptr, void *arg = nullptr) const;
1423
1426 std::shared_ptr<GeneratedAudio> Generate2(
1427 const std::string &text, const GenerationConfig &config,
1428 OfflineTtsCallback callback = nullptr, void *arg = nullptr) const;
1429
1430 private:
1431 explicit OfflineTts(const SherpaOnnxOfflineTts *p);
1432};
1433
1434// ============================================================
1435// For Keyword Spotter
1436// ============================================================
1437
1441 std::string keyword;
1443 std::vector<std::string> tokens;
1445 std::vector<float> timestamps;
1447 float start_time = 0.0f;
1449 std::string json;
1450};
1451
1471
1473class SHERPA_ONNX_API KeywordSpotter
1474 : public MoveOnly<KeywordSpotter, SherpaOnnxKeywordSpotter> {
1475 public:
1477 static KeywordSpotter Create(const KeywordSpotterConfig &config);
1478
1480 void Destroy(const SherpaOnnxKeywordSpotter *p) const;
1481
1484
1487 OnlineStream CreateStream(const std::string &keywords) const;
1488
1490 bool IsReady(const OnlineStream *s) const;
1491
1493 void Decode(const OnlineStream *s) const;
1494
1496 void Decode(const OnlineStream *ss, int32_t n) const;
1497
1499 void Reset(const OnlineStream *s) const;
1500
1503
1504 private:
1505 explicit KeywordSpotter(const SherpaOnnxKeywordSpotter *p);
1506};
1507
1513
1521
1542
1563
1569
1573 std::vector<float> samples;
1575 int32_t sample_rate = 0;
1576};
1577
1579class SHERPA_ONNX_API OfflineSpeechDenoiser
1580 : public MoveOnly<OfflineSpeechDenoiser, SherpaOnnxOfflineSpeechDenoiser> {
1581 public:
1583 static OfflineSpeechDenoiser Create(
1584 const OfflineSpeechDenoiserConfig &config);
1585
1588
1590 DenoisedAudio Run(const float *samples, int32_t n, int32_t sample_rate) const;
1591
1593 int32_t GetSampleRate() const;
1594
1596 bool SetVoiceSample(const float *samples, int32_t n,
1597 int32_t sample_rate) const;
1598
1599 private:
1600 explicit OfflineSpeechDenoiser(const SherpaOnnxOfflineSpeechDenoiser *p);
1601};
1602
1608
1610class SHERPA_ONNX_API OnlineSpeechDenoiser
1611 : public MoveOnly<OnlineSpeechDenoiser, SherpaOnnxOnlineSpeechDenoiser> {
1612 public:
1614 static OnlineSpeechDenoiser Create(const OnlineSpeechDenoiserConfig &config);
1615
1618
1620 DenoisedAudio Run(const float *samples, int32_t n, int32_t sample_rate) const;
1621
1624
1626 void Reset() const;
1627
1629 bool SetVoiceSample(const float *samples, int32_t n,
1630 int32_t sample_rate) const;
1631
1633 int32_t GetSampleRate() const;
1634
1637 int32_t GetFrameShiftInSamples() const;
1638
1639 private:
1640 explicit OnlineSpeechDenoiser(const SherpaOnnxOnlineSpeechDenoiser *p);
1641};
1642
1643// ==============================
1644// VAD
1645// ==============================
1646
1650 std::string model;
1652 float threshold = 0.5;
1658 int32_t window_size = 512;
1661};
1662
1666 std::string model;
1668 float threshold = 0.5;
1674 int32_t window_size = 256;
1677};
1678
1690
1692 int32_t sample_rate = 16000;
1694 int32_t num_threads = 1;
1696 std::string provider = "cpu";
1698 bool debug = false;
1699};
1700
1707 int64_t start = 0;
1709 std::vector<float> samples;
1710};
1711
1713class SHERPA_ONNX_API CircularBuffer
1714 : public MoveOnly<CircularBuffer, SherpaOnnxCircularBuffer> {
1715 public:
1717 static CircularBuffer Create(int32_t capacity);
1718
1720 void Destroy(const SherpaOnnxCircularBuffer *p) const;
1721
1723 void Push(const float *p, int32_t n) const;
1724
1726 std::vector<float> Get(int64_t start_index, int32_t n) const;
1727
1729 void Pop(int32_t n) const;
1730
1732 int32_t Size() const;
1733
1735 int64_t Head() const;
1736
1738 void Reset() const;
1739
1740 private:
1741 explicit CircularBuffer(const SherpaOnnxCircularBuffer *p);
1742};
1743
1750class SHERPA_ONNX_API VoiceActivityDetector
1751 : public MoveOnly<VoiceActivityDetector, SherpaOnnxVoiceActivityDetector> {
1752 public:
1754 static VoiceActivityDetector Create(const VadModelConfig &config,
1755 float buffer_size_in_seconds);
1756
1759
1761 void AcceptWaveform(const float *samples, int32_t n) const;
1762
1764 bool IsEmpty() const;
1765
1767 bool IsDetected() const;
1768
1770 void Pop() const;
1771
1773 void Clear() const;
1774
1777
1779 std::shared_ptr<SpeechSegment> FrontPtr() const;
1780
1782 void Reset() const;
1783
1785 void Flush() const;
1786
1787 private:
1788 explicit VoiceActivityDetector(const SherpaOnnxVoiceActivityDetector *p);
1789};
1790
1793 : public MoveOnly<LinearResampler, SherpaOnnxLinearResampler> {
1794 public:
1796 LinearResampler() = default;
1798 static LinearResampler Create(int32_t samp_rate_in_hz,
1799 int32_t samp_rate_out_hz,
1800 float filter_cutoff_hz, int32_t num_zeros);
1801
1804
1806 void Reset() const;
1807
1809 std::vector<float> Resample(const float *input, int32_t input_dim,
1810 bool flush) const;
1811
1813 int32_t GetInputSamplingRate() const;
1815 int32_t GetOutputSamplingRate() const;
1816
1817 private:
1818 explicit LinearResampler(const SherpaOnnxLinearResampler *p);
1819};
1820
1830SHERPA_ONNX_API bool FileExists(const std::string &filename);
1831
1832// ============================================================================
1833// Offline Punctuation
1834// ============================================================================
1838 std::string ct_transformer;
1840 int32_t num_threads = 1;
1842 bool debug = false;
1844 std::string provider = "cpu";
1845};
1846
1852
1854class SHERPA_ONNX_API OfflinePunctuation
1855 : public MoveOnly<OfflinePunctuation, SherpaOnnxOfflinePunctuation> {
1856 public:
1858 static OfflinePunctuation Create(const OfflinePunctuationConfig &config);
1859
1862
1864 std::string AddPunctuation(const std::string &text) const;
1865
1866 private:
1867 explicit OfflinePunctuation(const SherpaOnnxOfflinePunctuation *p);
1868};
1869
1870// ============================================================================
1871// Online Punctuation
1872// ============================================================================
1876 std::string cnn_bilstm;
1878 std::string bpe_vocab;
1880 int32_t num_threads = 1;
1882 bool debug = false;
1884 std::string provider = "cpu";
1885};
1886
1892
1894class SHERPA_ONNX_API OnlinePunctuation
1895 : public MoveOnly<OnlinePunctuation, SherpaOnnxOnlinePunctuation> {
1896 public:
1898 static OnlinePunctuation Create(const OnlinePunctuationConfig &config);
1899
1902
1904 std::string AddPunctuation(const std::string &text) const;
1905
1906 private:
1907 explicit OnlinePunctuation(const SherpaOnnxOnlinePunctuation *p);
1908};
1909
1910// ============================================================================
1911// Audio tagging
1912// ============================================================================
1918
1937
1947
1951 std::string name;
1953 int32_t index;
1955 float prob;
1956};
1957
1959class SHERPA_ONNX_API AudioTagging
1960 : public MoveOnly<AudioTagging, SherpaOnnxAudioTagging> {
1961 public:
1963 static AudioTagging Create(const AudioTaggingConfig &config);
1964
1966 void Destroy(const SherpaOnnxAudioTagging *p) const;
1967
1976 std::vector<AudioEvent> Compute(const OfflineStream *s, int32_t top_k = -1);
1977
1980 std::shared_ptr<std::vector<AudioEvent>> ComputePtr(const OfflineStream *s,
1981 int32_t top_k = -1);
1982
1983 private:
1984 explicit AudioTagging(const SherpaOnnxAudioTagging *p);
1985};
1986
1987// ==============================
1988// Source Separation
1989// ==============================
1990
1998
2004
2022
2028
2032 std::vector<std::vector<float>> samples;
2033};
2034
2038 std::vector<SourceSeparationStem> stems;
2040 int32_t sample_rate = 0;
2041};
2042
2044class SHERPA_ONNX_API OfflineSourceSeparation
2045 : public MoveOnly<OfflineSourceSeparation,
2046 SherpaOnnxOfflineSourceSeparation> {
2047 public:
2049 static OfflineSourceSeparation Create(
2050 const OfflineSourceSeparationConfig &config);
2051
2054
2064 SourceSeparationOutput Process(const float *const *samples,
2065 int32_t num_channels, int32_t num_samples,
2066 int32_t sample_rate) const;
2067
2069 int32_t GetOutputSampleRate() const;
2070
2072 int32_t GetNumberOfStems() const;
2073
2074 private:
2075 explicit OfflineSourceSeparation(const SherpaOnnxOfflineSourceSeparation *p);
2076};
2077
2078// ============================================================================
2079// Spoken Language Identification
2080// ============================================================================
2081
2085 std::string encoder;
2087 std::string decoder;
2089 int32_t tail_paddings = 0;
2090};
2091
2103
2109
2111class SHERPA_ONNX_API SpokenLanguageIdentification
2112 : public MoveOnly<SpokenLanguageIdentification,
2113 SherpaOnnxSpokenLanguageIdentification> {
2114 public:
2116 static SpokenLanguageIdentification Create(
2118
2121
2124
2127
2128 private:
2129 explicit SpokenLanguageIdentification(
2131};
2132
2133// ============================================================================
2134// Speaker Embedding Extractor
2135// ============================================================================
2136
2140 std::string model;
2142 int32_t num_threads = 1;
2144 bool debug = false;
2146 std::string provider = "cpu";
2147};
2148
2150class SHERPA_ONNX_API SpeakerEmbeddingExtractor
2151 : public MoveOnly<SpeakerEmbeddingExtractor,
2152 SherpaOnnxSpeakerEmbeddingExtractor> {
2153 public:
2155 static SpeakerEmbeddingExtractor Create(
2156 const SpeakerEmbeddingExtractorConfig &config);
2157
2160
2162 int32_t Dim() const;
2163
2166
2168 bool IsReady(const OnlineStream *s) const;
2169
2171 std::vector<float> ComputeEmbedding(const OnlineStream *s) const;
2172
2173 private:
2174 explicit SpeakerEmbeddingExtractor(
2176};
2177
2178// ============================================================================
2179// Speaker Embedding Manager
2180// ============================================================================
2181
2185 float score;
2187 std::string name;
2188};
2189
2191class SHERPA_ONNX_API SpeakerEmbeddingManager
2192 : public MoveOnly<SpeakerEmbeddingManager,
2193 SherpaOnnxSpeakerEmbeddingManager> {
2194 public:
2196 static SpeakerEmbeddingManager Create(int32_t dim);
2197
2200
2202 bool Add(const std::string &name, const float *v) const;
2203
2205 bool AddList(const std::string &name, const float **v) const;
2206
2208 bool AddListFlattened(const std::string &name, const float *v,
2209 int32_t n) const;
2210
2212 bool Remove(const std::string &name) const;
2213
2215 std::string Search(const float *v, float threshold) const;
2216
2218 std::vector<SpeakerMatch> GetBestMatches(const float *v, float threshold,
2219 int32_t n) const;
2220
2222 bool Verify(const std::string &name, const float *v, float threshold) const;
2223
2225 bool Contains(const std::string &name) const;
2226
2228 int32_t NumSpeakers() const;
2229
2231 int32_t Dim() const;
2232
2234 std::vector<std::string> GetAllSpeakers() const;
2235
2237 std::vector<float> GetEmbedding(const std::string &name) const;
2238
2239 private:
2240 explicit SpeakerEmbeddingManager(const SherpaOnnxSpeakerEmbeddingManager *p);
2241};
2242
2243// ============================================================================
2244// Offline Speaker Diarization
2245// ============================================================================
2246
2254
2266
2271 int32_t num_clusters = 0;
2273 float threshold = 0.5;
2276};
2277
2291
2295 static constexpr float kUnavailableConfidence = -2.0f;
2296
2298 float start;
2300 float end;
2302 int32_t speaker;
2307};
2308
2315 std::function<void(int32_t, int32_t)>; // NOLINT
2316
2318class SHERPA_ONNX_API OfflineSpeakerDiarization
2319 : public MoveOnly<OfflineSpeakerDiarization,
2320 SherpaOnnxOfflineSpeakerDiarization> {
2321 public:
2323 static OfflineSpeakerDiarization Create(
2324 const OfflineSpeakerDiarizationConfig &config);
2325
2328
2330 int32_t GetSampleRate() const;
2331
2334
2336 std::vector<OfflineSpeakerDiarizationSegment> Process(
2337 const float *samples, int32_t n) const;
2338
2340 std::vector<OfflineSpeakerDiarizationSegment> Process(
2341 const float *samples, int32_t n,
2342 const OfflineSpeakerDiarizationProgressCallback &callback) const;
2343
2344 private:
2345 explicit OfflineSpeakerDiarization(
2347};
2348
2349// ============================================================================
2350// Offline Diacritization
2351// ============================================================================
2355 std::string catt_encoder;
2357 std::string catt_decoder;
2359 int32_t num_threads = 1;
2361 bool debug = false;
2363 std::string provider = "cpu";
2364};
2365
2371
2373class SHERPA_ONNX_API OfflineDiacritization
2374 : public MoveOnly<OfflineDiacritization, SherpaOnnxOfflineDiacritization> {
2375 public:
2377 static OfflineDiacritization Create(
2378 const OfflineDiacritizationConfig &config);
2379
2381 void Destroy(const SherpaOnnxOfflineDiacritization *diacrt) const;
2382
2384 std::string AddDiacritics(const std::string &text) const;
2385
2386 private:
2387 explicit OfflineDiacritization(const SherpaOnnxOfflineDiacritization *diacrt);
2388};
2389
2390} // namespace sherpa_onnx::cxx
2391
2392#endif // SHERPA_ONNX_C_API_CXX_API_H_
Public C API for sherpa-onnx.
struct SherpaOnnxSpokenLanguageIdentification SherpaOnnxSpokenLanguageIdentification
Opaque spoken-language identification handle.
Definition c-api.h:3393
struct SherpaOnnxOfflineSpeechDenoiser SherpaOnnxOfflineSpeechDenoiser
Opaque offline speech denoiser handle.
Definition c-api.h:4630
struct SherpaOnnxOfflineStream SherpaOnnxOfflineStream
Non-streaming decoding state for one utterance.
Definition c-api.h:1224
#define SHERPA_ONNX_API
Definition c-api.h:110
struct SherpaOnnxOnlineSpeechDenoiser SherpaOnnxOnlineSpeechDenoiser
Opaque online speech denoiser handle.
Definition c-api.h:4745
struct SherpaOnnxOnlineStream SherpaOnnxOnlineStream
Streaming decoding state for one utterance or stream.
Definition c-api.h:448
struct SherpaOnnxOfflineRecognizer SherpaOnnxOfflineRecognizer
Non-streaming recognizer handle.
Definition c-api.h:1221
struct SherpaOnnxSpeakerEmbeddingManager SherpaOnnxSpeakerEmbeddingManager
Opaque speaker embedding manager handle.
Definition c-api.h:3618
struct SherpaOnnxKeywordSpotter SherpaOnnxKeywordSpotter
Opaque keyword spotter handle.
Definition c-api.h:1732
struct SherpaOnnxOnlinePunctuation SherpaOnnxOnlinePunctuation
Opaque online punctuation handle.
Definition c-api.h:4121
struct SherpaOnnxOnlineRecognizer SherpaOnnxOnlineRecognizer
Streaming recognizer handle.
Definition c-api.h:446
struct SherpaOnnxCircularBuffer SherpaOnnxCircularBuffer
Opaque circular-buffer handle used by helper APIs.
Definition c-api.h:1988
struct SherpaOnnxOfflineTts SherpaOnnxOfflineTts
Opaque offline TTS handle.
Definition c-api.h:2566
struct SherpaOnnxLinearResampler SherpaOnnxLinearResampler
Opaque linear resampler handle.
Definition c-api.h:4170
struct SherpaOnnxOfflineSourceSeparation SherpaOnnxOfflineSourceSeparation
Opaque source-separation engine handle.
Definition c-api.h:4875
struct SherpaOnnxOfflineSpeakerDiarization SherpaOnnxOfflineSpeakerDiarization
Opaque offline speaker diarization handle.
Definition c-api.h:4348
struct SherpaOnnxForcedAligner SherpaOnnxForcedAligner
Opaque forced aligner object.
Definition c-api.h:2962
struct SherpaOnnxSpeakerEmbeddingExtractor SherpaOnnxSpeakerEmbeddingExtractor
Opaque speaker embedding extractor handle.
Definition c-api.h:3513
struct SherpaOnnxAudioTagging SherpaOnnxAudioTagging
Opaque audio tagger handle.
Definition c-api.h:3940
struct SherpaOnnxOfflinePunctuation SherpaOnnxOfflinePunctuation
Opaque offline punctuation handle.
Definition c-api.h:4044
struct SherpaOnnxVoiceActivityDetector SherpaOnnxVoiceActivityDetector
Opaque voice activity detector handle.
Definition c-api.h:2112
struct SherpaOnnxOfflineDiacritization SherpaOnnxOfflineDiacritization
Opaque offline diacritization handle.
Definition c-api.h:5201
std::vector< AudioEvent > Compute(const OfflineStream *s, int32_t top_k=-1)
Run audio tagging and return copied results.
OfflineStream CreateStream() const
Create an offline stream for tagging.
std::shared_ptr< std::vector< AudioEvent > > ComputePtr(const OfflineStream *s, int32_t top_k=-1)
Like Compute(), but returns the result vector in a shared pointer.
void Destroy(const SherpaOnnxAudioTagging *p) const
Destroy the wrapped C handle.
static AudioTagging Create(const AudioTaggingConfig &config)
Create an audio tagger.
static CircularBuffer Create(int32_t capacity)
Create a circular buffer with the given capacity in samples.
void Destroy(const SherpaOnnxCircularBuffer *p) const
Destroy the wrapped C handle.
int64_t Head() const
Return the current head index.
void Push(const float *p, int32_t n) const
Append samples to the buffer.
int32_t Size() const
Return the number of stored samples.
void Reset() const
Reset the buffer to empty.
void Pop(int32_t n) const
Remove samples from the head of the buffer.
std::vector< float > Get(int64_t start_index, int32_t n) const
Copy a contiguous span from the buffer.
void Destroy(const SherpaOnnxForcedAligner *p) const
Destroy the wrapped C handle.
OfflineStream CreateStream() const
Create an utterance stream.
static ForcedAligner Create(const ForcedAlignerConfig &config)
Create a forced aligner from a model directory and a pronunciation dictionary.
ForcedAlignmentResult Compute(const OfflineStream &stream, const std::string &text) const
Compute the alignment of one utterance.
OnlineStream CreateStream(const std::string &keywords) const
Create a keyword stream with inline extra or replacement keywords.
bool IsReady(const OnlineStream *s) const
Check whether the stream has enough data to decode.
void Decode(const OnlineStream *ss, int32_t n) const
Decode multiple ready streams in parallel.
void Destroy(const SherpaOnnxKeywordSpotter *p) const
Destroy the wrapped C handle.
OnlineStream CreateStream() const
Create a keyword stream using configured keywords.
void Decode(const OnlineStream *s) const
Decode one ready stream.
static KeywordSpotter Create(const KeywordSpotterConfig &config)
Create a keyword spotter from a config struct.
void Reset(const OnlineStream *s) const
Reset a stream after a keyword trigger.
KeywordResult GetResult(const OnlineStream *s) const
Return the copied keyword spotting result for a stream.
static LinearResampler Create(int32_t samp_rate_in_hz, int32_t samp_rate_out_hz, float filter_cutoff_hz, int32_t num_zeros)
Create a linear resampler.
LinearResampler()=default
Construct an empty wrapper.
int32_t GetInputSamplingRate() const
Return the input sample rate in Hz.
void Destroy(const SherpaOnnxLinearResampler *p) const
Destroy the wrapped C handle.
std::vector< float > Resample(const float *input, int32_t input_dim, bool flush) const
Resample one chunk of input audio.
int32_t GetOutputSamplingRate() const
Return the output sample rate in Hz.
void Reset() const
Reset the resampler state.
MoveOnly(const T *p)
Construct a wrapper from a raw C handle.
Definition cxx-api.h:296
const T * Release()
Release ownership of the wrapped raw pointer.
Definition cxx-api.h:323
MoveOnly(const MoveOnly &)=delete
~MoveOnly()
Destroy the wrapped handle if present.
Definition cxx-api.h:299
MoveOnly()=default
Construct an empty wrapper.
MoveOnly & operator=(const MoveOnly &)=delete
MoveOnly & operator=(MoveOnly &&other)
Definition cxx-api.h:307
MoveOnly(MoveOnly &&other)
Definition cxx-api.h:305
const T * Get() const
Return the wrapped raw pointer without transferring ownership.
Definition cxx-api.h:320
std::string AddDiacritics(const std::string &text) const
Add diacritics to a complete input text.
void Destroy(const SherpaOnnxOfflineDiacritization *diacrt) const
Destroy the wrapped C handle.
static OfflineDiacritization Create(const OfflineDiacritizationConfig &config)
Create an offline diacritization model.
static OfflinePunctuation Create(const OfflinePunctuationConfig &config)
Create an offline punctuation model.
std::string AddPunctuation(const std::string &text) const
Add punctuation to a complete input text.
void Destroy(const SherpaOnnxOfflinePunctuation *p) const
Destroy the wrapped C handle.
std::shared_ptr< OfflineRecognizerResult > GetResultPtr(const OfflineStream *s) const
Convenience wrapper that returns the result inside a shared pointer.
static OfflineRecognizer Create(const OfflineRecognizerConfig &config)
Create an offline recognizer from a config struct.
void Decode(const OfflineStream *ss, int32_t n) const
Decode multiple offline streams in parallel.
void Decode(const OfflineStream *s) const
Decode one offline stream.
OfflineRecognizerResult GetResult(const OfflineStream *s) const
Return the copied recognition result for one stream.
void SetConfig(const OfflineRecognizerConfig &config) const
Update recognizer runtime configuration after creation.
OfflineStream CreateStream() const
Create a stream using the recognizer's configured hotwords.
void Destroy(const SherpaOnnxOfflineRecognizer *p) const
Destroy the wrapped C handle.
OfflineStream CreateStream(const std::string &hotwords) const
Create a stream with inline hotwords.
void Destroy(const SherpaOnnxOfflineSourceSeparation *p) const
Destroy the wrapped C handle.
int32_t GetNumberOfStems() const
Return the number of stems produced.
int32_t GetOutputSampleRate() const
Return the output sample rate.
static OfflineSourceSeparation Create(const OfflineSourceSeparationConfig &config)
Create an offline source separation engine.
SourceSeparationOutput Process(const float *const *samples, int32_t num_channels, int32_t num_samples, int32_t sample_rate) const
Run source separation on multi-channel audio.
void SetConfig(const OfflineSpeakerDiarizationConfig &config) const
Update clustering-related settings.
int32_t GetSampleRate() const
Return the expected input sample rate.
void Destroy(const SherpaOnnxOfflineSpeakerDiarization *p) const
Destroy the wrapped C handle.
std::vector< OfflineSpeakerDiarizationSegment > Process(const float *samples, int32_t n) const
Run offline speaker diarization.
static OfflineSpeakerDiarization Create(const OfflineSpeakerDiarizationConfig &config)
Create an offline speaker diarization pipeline.
std::vector< OfflineSpeakerDiarizationSegment > Process(const float *samples, int32_t n, const OfflineSpeakerDiarizationProgressCallback &callback) const
Run offline speaker diarization with a progress callback.
DenoisedAudio Run(const float *samples, int32_t n, int32_t sample_rate) const
Run denoising on a complete waveform.
int32_t GetSampleRate() const
Return the expected input sample rate.
static OfflineSpeechDenoiser Create(const OfflineSpeechDenoiserConfig &config)
Create an offline speech denoiser.
void Destroy(const SherpaOnnxOfflineSpeechDenoiser *p) const
Destroy the wrapped C handle.
bool SetVoiceSample(const float *samples, int32_t n, int32_t sample_rate) const
Set a PCM voice sample for VoxLock.
RAII wrapper for an offline decoding stream.
Definition cxx-api.h:785
void SetOption(const char *key, const char *value) const
Set a per-stream string option.
const char * GetOption(const char *key) const
Get a per-stream string option.
void Destroy(const SherpaOnnxOfflineStream *p) const
Destroy the wrapped C handle.
void AcceptWaveform(int32_t sample_rate, const float *samples, int32_t n) const
Provide the complete waveform for offline decoding.
int32_t HasOption(const char *key) const
Check whether a per-stream option exists.
OfflineStream(const SherpaOnnxOfflineStream *p)
Wrap an existing C offline stream handle.
GeneratedAudio Generate(const std::string &text, int32_t sid=0, float speed=1.0, OfflineTtsCallback callback=nullptr, void *arg=nullptr) const
Generate speech using the simple speaker-id and speed interface.
GeneratedAudio Generate(const std::string &text, const GenerationConfig &config, OfflineTtsCallback callback=nullptr, void *arg=nullptr) const
Generate speech using the advanced generation configuration.
int32_t NumSpeakers() const
Return the number of supported speakers.
static OfflineTts Create(const OfflineTtsConfig &config)
Create an offline TTS engine.
std::string Lang() const
Return the language/voice of the model, e.g., "en-us".
std::shared_ptr< GeneratedAudio > Generate2(const std::string &text, const GenerationConfig &config, OfflineTtsCallback callback=nullptr, void *arg=nullptr) const
Like the advanced Generate() overload, but returns a shared pointer.
std::shared_ptr< GeneratedAudio > Generate2(const std::string &text, int32_t sid=0, float speed=1.0, OfflineTtsCallback callback=nullptr, void *arg=nullptr) const
Like Generate(), but returns a shared pointer to the result.
void Destroy(const SherpaOnnxOfflineTts *p) const
Destroy the wrapped C handle.
int32_t SampleRate() const
Return the output sample rate of generated audio.
void Destroy(const SherpaOnnxOnlinePunctuation *p) const
Destroy the wrapped C handle.
static OnlinePunctuation Create(const OnlinePunctuationConfig &config)
Create an online punctuation model.
std::string AddPunctuation(const std::string &text) const
Add punctuation to one input text chunk.
void Decode(const OnlineStream *s) const
Decode one ready stream.
OnlineRecognizerResult GetResult(const OnlineStream *s) const
Return the current recognition result for a stream.
static OnlineRecognizer Create(const OnlineRecognizerConfig &config)
Create a streaming recognizer from a config struct.
void Reset(const OnlineStream *s) const
Reset a stream after endpointing or utterance completion.
OnlineStream CreateStream(const std::string &hotwords) const
Create a stream with inline hotwords.
void Destroy(const SherpaOnnxOnlineRecognizer *p) const
Destroy the wrapped C handle.
bool IsReady(const OnlineStream *s) const
Check whether the given stream has enough data to decode.
bool IsEndpoint(const OnlineStream *s) const
Check whether endpointing has triggered for a stream.
OnlineStream CreateStream() const
Create a stream that uses the recognizer's configured hotwords.
void Decode(const OnlineStream *ss, int32_t n) const
Decode multiple ready streams in parallel.
int32_t GetFrameShiftInSamples() const
Return the recommended frame shift in samples for streaming input.
DenoisedAudio Flush() const
Flush buffered audio and reset the denoiser.
DenoisedAudio Run(const float *samples, int32_t n, int32_t sample_rate) const
Process one chunk of streaming audio.
bool SetVoiceSample(const float *samples, int32_t n, int32_t sample_rate) const
Set a PCM voice sample for VoxLock.
int32_t GetSampleRate() const
Return the expected input sample rate.
void Destroy(const SherpaOnnxOnlineSpeechDenoiser *p) const
Destroy the wrapped C handle.
void Reset() const
Reset the denoiser for a new stream.
static OnlineSpeechDenoiser Create(const OnlineSpeechDenoiserConfig &config)
Create an online speech denoiser.
void InputFinished() const
Indicate that no more input audio will be provided.
void AcceptWaveform(int32_t sample_rate, const float *samples, int32_t n) const
Append audio samples to the stream.
void Destroy(const SherpaOnnxOnlineStream *p) const
Destroy the wrapped C handle.
int32_t HasOption(const char *key) const
Check whether a per-stream option exists.
OnlineStream(const SherpaOnnxOnlineStream *p)
Wrap an existing C online stream handle.
void SetOption(const char *key, const char *value) const
Set a per-stream string option.
const char * GetOption(const char *key) const
Get a per-stream string option.
bool IsReady(const OnlineStream *s) const
Check whether enough audio has been provided.
void Destroy(const SherpaOnnxSpeakerEmbeddingExtractor *p) const
Destroy the wrapped C handle.
OnlineStream CreateStream() const
Create a stream for embedding extraction.
int32_t Dim() const
Return the embedding dimension.
static SpeakerEmbeddingExtractor Create(const SpeakerEmbeddingExtractorConfig &config)
Create a speaker embedding extractor.
std::vector< float > ComputeEmbedding(const OnlineStream *s) const
Compute the embedding for a stream.
bool Contains(const std::string &name) const
Check whether a speaker is enrolled.
bool AddListFlattened(const std::string &name, const float *v, int32_t n) const
Add multiple enrollment embeddings packed in one flat array.
std::vector< std::string > GetAllSpeakers() const
Return all enrolled speaker names.
bool Add(const std::string &name, const float *v) const
Add one enrollment embedding for a speaker.
int32_t NumSpeakers() const
Return the number of enrolled speakers.
std::vector< SpeakerMatch > GetBestMatches(const float *v, float threshold, int32_t n) const
Return up to n best matches above a similarity threshold.
bool Remove(const std::string &name) const
Remove a speaker from the manager.
bool AddList(const std::string &name, const float **v) const
Add multiple enrollment embeddings for one speaker.
void Destroy(const SherpaOnnxSpeakerEmbeddingManager *p) const
Destroy the wrapped C handle.
int32_t Dim() const
Return the embedding dimension.
std::vector< float > GetEmbedding(const std::string &name) const
Return a copy of the embedding of a speaker. Empty if missing.
std::string Search(const float *v, float threshold) const
Search for the best matching enrolled speaker.
bool Verify(const std::string &name, const float *v, float threshold) const
Verify whether a query embedding matches a named speaker.
static SpeakerEmbeddingManager Create(int32_t dim)
Create a speaker embedding manager.
OfflineStream CreateStream() const
Create an offline stream for identification.
static SpokenLanguageIdentification Create(const SpokenLanguageIdentificationConfig &config)
Create a spoken language identifier.
SpokenLanguageIdentificationResult Compute(const OfflineStream *s) const
Run spoken language identification on a stream.
void Destroy(const SherpaOnnxSpokenLanguageIdentification *p) const
Destroy the wrapped C handle.
void Clear() const
Remove all queued speech segments.
void Pop() const
Remove the front queued speech segment.
void Destroy(const SherpaOnnxVoiceActivityDetector *p) const
Destroy the wrapped C handle.
std::shared_ptr< SpeechSegment > FrontPtr() const
Like Front(), but returns the segment in a shared pointer.
static VoiceActivityDetector Create(const VadModelConfig &config, float buffer_size_in_seconds)
Create a VAD instance.
void AcceptWaveform(const float *samples, int32_t n) const
Feed more audio samples to the detector.
bool IsEmpty() const
Check whether no speech segments are currently queued.
bool IsDetected() const
Check whether speech is currently detected.
void Flush() const
Flush buffered context at end of input.
SpeechSegment Front() const
Return the front queued speech segment.
void Reset() const
Reset the detector state.
std::string GetGitSha1()
Return the build Git SHA1 as a C++ string.
std::string GetOnnxruntimeVersionStr()
Return the onnxruntime version string as a C++ string.
std::string GetVersionStr()
Return the sherpa-onnx version string as a C++ string.
std::function< void(int32_t, int32_t)> OfflineSpeakerDiarizationProgressCallback
Progress callback for offline speaker diarization.
Definition cxx-api.h:2314
Wave ReadWave(const std::string &filename)
Read a mono WAVE file into a C++ value object.
int32_t(*)(const float *samples, int32_t num_samples, float progress, void *arg) OfflineTtsCallback
TTS progress callback.
Definition cxx-api.h:1355
std::string GetGitDate()
Return the build Git date as a C++ string.
bool FileExists(const std::string &filename)
Return true if a file exists.
bool WriteWave(const std::string &filename, const Wave &wave)
Write a mono WAVE file from a C++ value object.
One audio-tagging event returned by the C++ wrapper.
Definition cxx-api.h:1949
Configuration for audio tagging.
Definition cxx-api.h:1939
AudioTaggingModelConfig model
Definition cxx-api.h:1941
Audio-tagging model configuration.
Definition cxx-api.h:1925
OfflineZipformerAudioTaggingModelConfig zipformer
Definition cxx-api.h:1927
Denoised waveform returned by speech enhancement wrappers.
Definition cxx-api.h:1571
std::vector< float > samples
Definition cxx-api.h:1573
Fast clustering configuration.
Definition cxx-api.h:2268
Feature extraction settings shared by ASR and KWS wrappers.
Definition cxx-api.h:152
Configuration of a forced aligner.
Definition cxx-api.h:893
ForcedAlignmentOptions options
Definition cxx-api.h:947
One aligned interval: a phone in the "phones" tier or a word in the "words" tier.
Definition cxx-api.h:960
Options of a forced aligner.
Definition cxx-api.h:858
The result of ForcedAligner::Compute().
Definition cxx-api.h:1000
std::vector< ForcedAlignmentTier > tiers
Definition cxx-api.h:1017
One tier of the alignment (phones or words).
Definition cxx-api.h:983
std::vector< ForcedAlignmentInterval > intervals
Definition cxx-api.h:992
Generated audio returned by the C++ TTS wrapper.
Definition cxx-api.h:1343
std::vector< float > samples
Definition cxx-api.h:1345
Generation-time options for advanced TTS synthesis.
Definition cxx-api.h:1287
std::unordered_map< std::string, std::string > extra
Definition cxx-api.h:1304
std::vector< std::vector< int32_t > > phoneme_codepoints
Definition cxx-api.h:1315
std::vector< float > reference_audio
Definition cxx-api.h:1295
std::vector< std::vector< std::string > > tokens
Definition cxx-api.h:1325
Homophone replacement resources used by some Chinese ASR setups.
Definition cxx-api.h:168
Current keyword spotting result copied into C++ containers.
Definition cxx-api.h:1439
std::vector< float > timestamps
Definition cxx-api.h:1445
std::vector< std::string > tokens
Definition cxx-api.h:1443
Configuration for the C++ keyword spotting wrapper.
Definition cxx-api.h:1453
Offline Canary model configuration.
Definition cxx-api.h:466
Offline Cohere Transcribe model configuration.
Definition cxx-api.h:480
Decoder graph configuration for offline CTC + FST decoding.
Definition cxx-api.h:693
Configuration for offline diacritization.
Definition cxx-api.h:2367
OfflineDiacritizationModelConfig model
Definition cxx-api.h:2369
Offline diacritization model configuration.
Definition cxx-api.h:2353
Offline Dolphin model file.
Definition cxx-api.h:524
Offline FireRed ASR CTC model file.
Definition cxx-api.h:502
Offline FireRed ASR model files.
Definition cxx-api.h:494
Offline FunASR Nano model configuration.
Definition cxx-api.h:568
Optional language-model rescoring configuration for offline ASR.
Definition cxx-api.h:685
Offline MedASR CTC model file.
Definition cxx-api.h:548
Acoustic model configuration for offline ASR.
Definition cxx-api.h:628
OfflineMedAsrCtcModelConfig medasr
Definition cxx-api.h:673
OfflineTdnnModelConfig tdnn
Definition cxx-api.h:638
OfflineParaformerModelConfig paraformer
Definition cxx-api.h:632
OfflineSenseVoiceModelConfig sense_voice
Definition cxx-api.h:657
OfflineZipformerCtcModelConfig zipformer_ctc
Definition cxx-api.h:665
OfflineFireRedAsrCtcModelConfig fire_red_asr_ctc
Definition cxx-api.h:677
OfflineMoonshineModelConfig moonshine
Definition cxx-api.h:659
OfflineCanaryModelConfig canary
Definition cxx-api.h:667
OfflineWhisperModelConfig whisper
Definition cxx-api.h:636
OfflineCohereTranscribeModelConfig cohere_transcribe
Definition cxx-api.h:681
OfflineDolphinModelConfig dolphin
Definition cxx-api.h:663
OfflineWenetCtcModelConfig wenet_ctc
Definition cxx-api.h:669
OfflineFunASRNanoModelConfig funasr_nano
Definition cxx-api.h:675
OfflineFireRedAsrModelConfig fire_red_asr
Definition cxx-api.h:661
OfflineTransducerModelConfig transducer
Definition cxx-api.h:630
OfflineNemoEncDecCtcModelConfig nemo_ctc
Definition cxx-api.h:634
OfflineQwen3ASRModelConfig qwen3_asr
Definition cxx-api.h:679
OfflineOmnilingualAsrCtcModelConfig omnilingual
Definition cxx-api.h:671
Offline Moonshine model configuration.
Definition cxx-api.h:554
Offline NeMo EncDec CTC model file.
Definition cxx-api.h:442
Offline omnilingual ASR CTC model file.
Definition cxx-api.h:542
Offline Paraformer model file.
Definition cxx-api.h:436
Configuration for offline punctuation.
Definition cxx-api.h:1848
OfflinePunctuationModelConfig model
Definition cxx-api.h:1850
Offline punctuation model configuration.
Definition cxx-api.h:1836
Offline Qwen3-ASR model configuration.
Definition cxx-api.h:598
Configuration for offline ASR.
Definition cxx-api.h:732
OfflineCtcFstDecoderConfig ctc_fst_decoder_config
Definition cxx-api.h:759
Offline ASR result copied into C++ containers.
Definition cxx-api.h:763
std::vector< std::string > tokens
Definition cxx-api.h:769
Offline SenseVoice model configuration.
Definition cxx-api.h:514
Configuration for offline source separation.
Definition cxx-api.h:2024
OfflineSourceSeparationModelConfig model
Definition cxx-api.h:2026
Source-separation model configuration.
Definition cxx-api.h:2010
OfflineSourceSeparationUvrModelConfig uvr
Definition cxx-api.h:2014
OfflineSourceSeparationSpleeterModelConfig spleeter
Definition cxx-api.h:2012
Spleeter source-separation model configuration.
Definition cxx-api.h:1992
UVR (MDX-Net) source-separation model configuration.
Definition cxx-api.h:2000
Configuration for offline speaker diarization.
Definition cxx-api.h:2279
OfflineSpeakerSegmentationModelConfig segmentation
Definition cxx-api.h:2281
SpeakerEmbeddingExtractorConfig embedding
Definition cxx-api.h:2283
Segmentation model configuration for offline speaker diarization.
Definition cxx-api.h:2256
OfflineSpeakerSegmentationPyannoteModelConfig pyannote
Definition cxx-api.h:2258
Pyannote segmentation model configuration.
Definition cxx-api.h:2248
Configuration for offline speech denoising.
Definition cxx-api.h:1565
OfflineSpeechDenoiserModelConfig model
Definition cxx-api.h:1567
DPDFNet speech denoiser model configuration.
Definition cxx-api.h:1515
GTCRN speech denoiser model configuration.
Definition cxx-api.h:1509
Speech denoiser model configuration.
Definition cxx-api.h:1549
OfflineSpeechDenoiserGtcrnModelConfig gtcrn
Definition cxx-api.h:1551
OfflineSpeechDenoiserVoxLockModelConfig voxlock
Definition cxx-api.h:1555
OfflineSpeechDenoiserDpdfNetModelConfig dpdfnet
Definition cxx-api.h:1553
VoxLock target-speaker voice isolation model configuration.
Definition cxx-api.h:1528
Offline transducer model files.
Definition cxx-api.h:426
Configuration for offline TTS.
Definition cxx-api.h:1329
OfflineTtsModelConfig model
Definition cxx-api.h:1331
Model configuration for offline TTS.
Definition cxx-api.h:1262
OfflineTtsKittenModelConfig kitten
Definition cxx-api.h:1270
OfflineTtsSupertonicModelConfig supertonic
Definition cxx-api.h:1276
OfflineTtsVitsModelConfig vits
Definition cxx-api.h:1264
OfflineTtsKokoroModelConfig kokoro
Definition cxx-api.h:1268
OfflineTtsMatchaModelConfig matcha
Definition cxx-api.h:1266
OfflineTtsPocketModelConfig pocket
Definition cxx-api.h:1274
OfflineTtsZipvoiceModelConfig zipvoice
Definition cxx-api.h:1272
Pocket TTS model configuration.
Definition cxx-api.h:1218
Supertonic model configuration.
Definition cxx-api.h:1239
Offline WeNet CTC model file.
Definition cxx-api.h:536
Offline Whisper model configuration.
Definition cxx-api.h:448
Zipformer audio-tagging model configuration.
Definition cxx-api.h:1914
Offline Zipformer CTC model file.
Definition cxx-api.h:530
Decoder graph configuration for online CTC + FST decoding.
Definition cxx-api.h:160
Acoustic model configuration for streaming ASR.
Definition cxx-api.h:121
OnlineNemoCtcModelConfig nemo_ctc
Definition cxx-api.h:129
OnlineZipformer2CtcModelConfig zipformer2_ctc
Definition cxx-api.h:127
OnlineToneCtcModelConfig t_one_ctc
Definition cxx-api.h:131
OnlineParaformerModelConfig paraformer
Definition cxx-api.h:125
OnlineTransducerModelConfig transducer
Definition cxx-api.h:123
Streaming NeMo CTC model file.
Definition cxx-api.h:85
Streaming Paraformer model files.
Definition cxx-api.h:71
Configuration for online punctuation.
Definition cxx-api.h:1888
OnlinePunctuationModelConfig model
Definition cxx-api.h:1890
Online punctuation model configuration.
Definition cxx-api.h:1874
Configuration for streaming ASR.
Definition cxx-api.h:200
OnlineCtcFstDecoderConfig ctc_fst_decoder_config
Definition cxx-api.h:231
Current streaming ASR result copied into C++ containers.
Definition cxx-api.h:246
std::vector< std::string > tokens
Definition cxx-api.h:250
Configuration for online speech denoising.
Definition cxx-api.h:1604
OfflineSpeechDenoiserModelConfig model
Definition cxx-api.h:1606
Streaming T-One CTC model file.
Definition cxx-api.h:91
Streaming transducer model files.
Definition cxx-api.h:61
Streaming Zipformer2 CTC model file.
Definition cxx-api.h:79
Silero VAD model configuration.
Definition cxx-api.h:1648
Output of a source-separation run.
Definition cxx-api.h:2036
std::vector< SourceSeparationStem > stems
Definition cxx-api.h:2038
A single stem (output track) with one or more channels.
Definition cxx-api.h:2030
std::vector< std::vector< float > > samples
Definition cxx-api.h:2032
Configuration for speaker embedding extraction.
Definition cxx-api.h:2138
One speaker match returned by the best-matches API.
Definition cxx-api.h:2183
One speech segment produced by the VAD wrapper.
Definition cxx-api.h:1702
std::vector< float > samples
Definition cxx-api.h:1709
Configuration for spoken language identification.
Definition cxx-api.h:2093
SpokenLanguageIdentificationWhisperConfig whisper
Definition cxx-api.h:2095
Result of spoken language identification.
Definition cxx-api.h:2105
Whisper model configuration for spoken language identification.
Definition cxx-api.h:2083
Ten VAD model configuration.
Definition cxx-api.h:1664
VAD model configuration.
Definition cxx-api.h:1685
SileroVadModelConfig silero_vad
Definition cxx-api.h:1687
Mono PCM waveform used by the helper I/O functions.
Definition cxx-api.h:258
std::vector< float > samples
Definition cxx-api.h:260