sherpa_onnx.go
66.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
/*
Speech recognition with [Next-gen Kaldi].
[sherpa-onnx] is an open-source speech recognition framework for [Next-gen Kaldi].
It depends only on [onnxruntime], supporting both streaming and non-streaming
speech recognition.
It does not need to access the network during recognition and everything
runs locally.
It supports a variety of platforms, such as Linux (x86_64, aarch64, arm),
Windows (x86_64, x86), macOS (x86_64, arm64), etc.
Usage examples:
1. Real-time speech recognition from a microphone
Please see
https://github.com/k2-fsa/sherpa-onnx/tree/master/go-api-examples/real-time-speech-recognition-from-microphone
2. Decode files using a non-streaming model
Please see
https://github.com/k2-fsa/sherpa-onnx/tree/master/go-api-examples/non-streaming-decode-files
3. Decode files using a streaming model
Please see
https://github.com/k2-fsa/sherpa-onnx/tree/master/go-api-examples/streaming-decode-files
4. Convert text to speech using a non-streaming model
Please see
https://github.com/k2-fsa/sherpa-onnx/tree/master/go-api-examples/non-streaming-tts
[sherpa-onnx]: https://github.com/k2-fsa/sherpa-onnx
[onnxruntime]: https://github.com/microsoft/onnxruntime
[Next-gen Kaldi]: https://github.com/k2-fsa/
*/
package sherpa_onnx
// #include <stdlib.h>
// #include "c-api.h"
// extern int32_t _cgoGeneratedAudioCallback(float *samples,int32_t n,void *arg);
// extern int32_t _cgoGeneratedAudioProgressCallback(float *samples, int32_t n, float p, void *arg);
import "C"
import (
"runtime/cgo"
"unsafe"
)
// Configuration for online/streaming transducer models
//
// Please refer to
// https://k2-fsa.github.io/sherpa/onnx/pretrained_models/online-transducer/index.html
// to download pre-trained models
type OnlineTransducerModelConfig struct {
Encoder string // Path to the encoder model, e.g., encoder.onnx or encoder.int8.onnx
Decoder string // Path to the decoder model.
Joiner string // Path to the joiner model.
}
// Configuration for online/streaming paraformer models
//
// Please refer to
// https://k2-fsa.github.io/sherpa/onnx/pretrained_models/online-paraformer/index.html
// to download pre-trained models
type OnlineParaformerModelConfig struct {
Encoder string // Path to the encoder model, e.g., encoder.onnx or encoder.int8.onnx
Decoder string // Path to the decoder model.
}
// Please refer to
// https://k2-fsa.github.io/sherpa/onnx/pretrained_models/online-ctc/index.html
// to download pre-trained models
type OnlineZipformer2CtcModelConfig struct {
Model string // Path to the onnx model
}
type OnlineNemoCtcModelConfig struct {
Model string // Path to the onnx model
}
// Configuration for online/streaming models
//
// Please refer to
// https://k2-fsa.github.io/sherpa/onnx/pretrained_models/online-transducer/index.html
// https://k2-fsa.github.io/sherpa/onnx/pretrained_models/online-paraformer/index.html
// to download pre-trained models
type OnlineModelConfig struct {
Transducer OnlineTransducerModelConfig
Paraformer OnlineParaformerModelConfig
Zipformer2Ctc OnlineZipformer2CtcModelConfig
NemoCtc OnlineNemoCtcModelConfig
Tokens string // Path to tokens.txt
NumThreads int // Number of threads to use for neural network computation
Provider string // Optional. Valid values are: cpu, cuda, coreml
Debug int // 1 to show model meta information while loading it.
ModelType string // Optional. You can specify it for faster model initialization
ModelingUnit string // Optional. cjkchar, bpe, cjkchar+bpe
BpeVocab string // Optional.
TokensBuf string // Optional.
TokensBufSize int // Optional.
}
// Configuration for the feature extractor
type FeatureConfig struct {
// Sample rate expected by the model. It is 16000 for all
// pre-trained models provided by us
SampleRate int
// Feature dimension expected by the model. It is 80 for all
// pre-trained models provided by us
FeatureDim int
}
type OnlineCtcFstDecoderConfig struct {
Graph string
MaxActive int
}
type HomophoneReplacerConfig struct {
DictDir string
Lexicon string
RuleFsts string
}
// Configuration for the online/streaming recognizer.
type OnlineRecognizerConfig struct {
FeatConfig FeatureConfig
ModelConfig OnlineModelConfig
// Valid decoding methods: greedy_search, modified_beam_search
DecodingMethod string
// Used only when DecodingMethod is modified_beam_search. It specifies
// the maximum number of paths to keep during the search
MaxActivePaths int
EnableEndpoint int // 1 to enable endpoint detection.
// Please see
// https://k2-fsa.github.io/sherpa/ncnn/endpoint.html
// for the meaning of Rule1MinTrailingSilence, Rule2MinTrailingSilence
// and Rule3MinUtteranceLength.
Rule1MinTrailingSilence float32
Rule2MinTrailingSilence float32
Rule3MinUtteranceLength float32
HotwordsFile string
HotwordsScore float32
BlankPenalty float32
CtcFstDecoderConfig OnlineCtcFstDecoderConfig
RuleFsts string
RuleFars string
HotwordsBuf string
HotwordsBufSize int
Hr HomophoneReplacerConfig
}
// It contains the recognition result for a online stream.
type OnlineRecognizerResult struct {
Text string
}
// The online recognizer class. It wraps a pointer from C.
type OnlineRecognizer struct {
impl *C.struct_SherpaOnnxOnlineRecognizer
}
// The online stream class. It wraps a pointer from C.
type OnlineStream struct {
impl *C.struct_SherpaOnnxOnlineStream
}
// Free the internal pointer inside the recognizer to avoid memory leak.
func DeleteOnlineRecognizer(recognizer *OnlineRecognizer) {
C.SherpaOnnxDestroyOnlineRecognizer(recognizer.impl)
recognizer.impl = nil
}
// The user is responsible to invoke [DeleteOnlineRecognizer]() to free
// the returned recognizer to avoid memory leak
func NewOnlineRecognizer(config *OnlineRecognizerConfig) *OnlineRecognizer {
c := C.struct_SherpaOnnxOnlineRecognizerConfig{}
c.feat_config.sample_rate = C.int(config.FeatConfig.SampleRate)
c.feat_config.feature_dim = C.int(config.FeatConfig.FeatureDim)
c.model_config.transducer.encoder = C.CString(config.ModelConfig.Transducer.Encoder)
defer C.free(unsafe.Pointer(c.model_config.transducer.encoder))
c.model_config.transducer.decoder = C.CString(config.ModelConfig.Transducer.Decoder)
defer C.free(unsafe.Pointer(c.model_config.transducer.decoder))
c.model_config.transducer.joiner = C.CString(config.ModelConfig.Transducer.Joiner)
defer C.free(unsafe.Pointer(c.model_config.transducer.joiner))
c.model_config.paraformer.encoder = C.CString(config.ModelConfig.Paraformer.Encoder)
defer C.free(unsafe.Pointer(c.model_config.paraformer.encoder))
c.model_config.paraformer.decoder = C.CString(config.ModelConfig.Paraformer.Decoder)
defer C.free(unsafe.Pointer(c.model_config.paraformer.decoder))
c.model_config.zipformer2_ctc.model = C.CString(config.ModelConfig.Zipformer2Ctc.Model)
defer C.free(unsafe.Pointer(c.model_config.zipformer2_ctc.model))
c.model_config.nemo_ctc.model = C.CString(config.ModelConfig.NemoCtc.Model)
defer C.free(unsafe.Pointer(c.model_config.nemo_ctc.model))
c.model_config.tokens = C.CString(config.ModelConfig.Tokens)
defer C.free(unsafe.Pointer(c.model_config.tokens))
c.model_config.tokens_buf = C.CString(config.ModelConfig.TokensBuf)
defer C.free(unsafe.Pointer(c.model_config.tokens_buf))
c.model_config.tokens_buf_size = C.int(config.ModelConfig.TokensBufSize)
c.model_config.num_threads = C.int(config.ModelConfig.NumThreads)
c.model_config.provider = C.CString(config.ModelConfig.Provider)
defer C.free(unsafe.Pointer(c.model_config.provider))
c.model_config.debug = C.int(config.ModelConfig.Debug)
c.model_config.model_type = C.CString(config.ModelConfig.ModelType)
defer C.free(unsafe.Pointer(c.model_config.model_type))
c.model_config.modeling_unit = C.CString(config.ModelConfig.ModelingUnit)
defer C.free(unsafe.Pointer(c.model_config.modeling_unit))
c.model_config.bpe_vocab = C.CString(config.ModelConfig.BpeVocab)
defer C.free(unsafe.Pointer(c.model_config.bpe_vocab))
c.decoding_method = C.CString(config.DecodingMethod)
defer C.free(unsafe.Pointer(c.decoding_method))
c.max_active_paths = C.int(config.MaxActivePaths)
c.enable_endpoint = C.int(config.EnableEndpoint)
c.rule1_min_trailing_silence = C.float(config.Rule1MinTrailingSilence)
c.rule2_min_trailing_silence = C.float(config.Rule2MinTrailingSilence)
c.rule3_min_utterance_length = C.float(config.Rule3MinUtteranceLength)
c.hotwords_file = C.CString(config.HotwordsFile)
defer C.free(unsafe.Pointer(c.hotwords_file))
c.hotwords_buf = C.CString(config.HotwordsBuf)
defer C.free(unsafe.Pointer(c.hotwords_buf))
c.hotwords_buf_size = C.int(config.HotwordsBufSize)
c.hotwords_score = C.float(config.HotwordsScore)
c.blank_penalty = C.float(config.BlankPenalty)
c.rule_fsts = C.CString(config.RuleFsts)
defer C.free(unsafe.Pointer(c.rule_fsts))
c.rule_fars = C.CString(config.RuleFars)
defer C.free(unsafe.Pointer(c.rule_fars))
c.ctc_fst_decoder_config.graph = C.CString(config.CtcFstDecoderConfig.Graph)
defer C.free(unsafe.Pointer(c.ctc_fst_decoder_config.graph))
c.ctc_fst_decoder_config.max_active = C.int(config.CtcFstDecoderConfig.MaxActive)
c.hr.dict_dir = C.CString(config.Hr.DictDir)
defer C.free(unsafe.Pointer(c.hr.dict_dir))
c.hr.lexicon = C.CString(config.Hr.Lexicon)
defer C.free(unsafe.Pointer(c.hr.lexicon))
c.hr.rule_fsts = C.CString(config.Hr.RuleFsts)
defer C.free(unsafe.Pointer(c.hr.rule_fsts))
impl := C.SherpaOnnxCreateOnlineRecognizer(&c)
if impl == nil {
return nil
}
recognizer := &OnlineRecognizer{}
recognizer.impl = impl
return recognizer
}
// Delete the internal pointer inside the stream to avoid memory leak.
func DeleteOnlineStream(stream *OnlineStream) {
C.SherpaOnnxDestroyOnlineStream(stream.impl)
stream.impl = nil
}
// The user is responsible to invoke [DeleteOnlineStream]() to free
// the returned stream to avoid memory leak
func NewOnlineStream(recognizer *OnlineRecognizer) *OnlineStream {
stream := &OnlineStream{}
stream.impl = C.SherpaOnnxCreateOnlineStream(recognizer.impl)
return stream
}
// Input audio samples for the stream.
//
// sampleRate is the actual sample rate of the input audio samples. If it
// is different from the sample rate expected by the feature extractor, we will
// do resampling inside.
//
// samples contains audio samples. Each sample is in the range [-1, 1]
func (s *OnlineStream) AcceptWaveform(sampleRate int, samples []float32) {
C.SherpaOnnxOnlineStreamAcceptWaveform(s.impl, C.int(sampleRate), (*C.float)(&samples[0]), C.int(len(samples)))
}
// Signal that there will be no incoming audio samples.
// After calling this function, you cannot call [OnlineStream.AcceptWaveform] any longer.
//
// The main purpose of this function is to flush the remaining audio samples
// buffered inside for feature extraction.
func (s *OnlineStream) InputFinished() {
C.SherpaOnnxOnlineStreamInputFinished(s.impl)
}
// Check whether the stream has enough feature frames for decoding.
// Return true if this stream is ready for decoding. Return false otherwise.
//
// You will usually use it like below:
//
// for recognizer.IsReady(s) {
// recognizer.Decode(s)
// }
func (recognizer *OnlineRecognizer) IsReady(s *OnlineStream) bool {
return C.SherpaOnnxIsOnlineStreamReady(recognizer.impl, s.impl) == 1
}
// Return true if an endpoint is detected.
//
// You usually use it like below:
//
// if recognizer.IsEndpoint(s) {
// // do your own stuff after detecting an endpoint
//
// recognizer.Reset(s)
// }
func (recognizer *OnlineRecognizer) IsEndpoint(s *OnlineStream) bool {
return C.SherpaOnnxOnlineStreamIsEndpoint(recognizer.impl, s.impl) == 1
}
// After calling this function, the internal neural network model states
// are reset and IsEndpoint(s) would return false. GetResult(s) would also
// return an empty string.
func (recognizer *OnlineRecognizer) Reset(s *OnlineStream) {
C.SherpaOnnxOnlineStreamReset(recognizer.impl, s.impl)
}
// Decode the stream. Before calling this function, you have to ensure
// that recognizer.IsReady(s) returns true. Otherwise, you will be SAD.
//
// You usually use it like below:
//
// for recognizer.IsReady(s) {
// recognizer.Decode(s)
// }
func (recognizer *OnlineRecognizer) Decode(s *OnlineStream) {
C.SherpaOnnxDecodeOnlineStream(recognizer.impl, s.impl)
}
// Decode multiple streams in parallel, i.e., in batch.
// You have to ensure that each stream is ready for decoding. Otherwise,
// you will be SAD.
func (recognizer *OnlineRecognizer) DecodeStreams(s []*OnlineStream) {
ss := make([]*C.struct_SherpaOnnxOnlineStream, len(s))
for i, v := range s {
ss[i] = v.impl
}
C.SherpaOnnxDecodeMultipleOnlineStreams(recognizer.impl, &ss[0], C.int(len(s)))
}
// Get the current result of stream since the last invoke of Reset()
func (recognizer *OnlineRecognizer) GetResult(s *OnlineStream) *OnlineRecognizerResult {
p := C.SherpaOnnxGetOnlineStreamResult(recognizer.impl, s.impl)
defer C.SherpaOnnxDestroyOnlineRecognizerResult(p)
result := &OnlineRecognizerResult{}
result.Text = C.GoString(p.text)
return result
}
// Configuration for offline/non-streaming transducer.
//
// Please refer to
// https://k2-fsa.github.io/sherpa/onnx/pretrained_models/offline-transducer/index.html
// to download pre-trained models
type OfflineTransducerModelConfig struct {
Encoder string // Path to the encoder model, i.e., encoder.onnx or encoder.int8.onnx
Decoder string // Path to the decoder model
Joiner string // Path to the joiner model
}
// Configuration for offline/non-streaming paraformer.
//
// please refer to
// https://k2-fsa.github.io/sherpa/onnx/pretrained_models/offline-paraformer/index.html
// to download pre-trained models
type OfflineParaformerModelConfig struct {
Model string // Path to the model, e.g., model.onnx or model.int8.onnx
}
// Configuration for offline/non-streaming NeMo CTC models.
//
// Please refer to
// https://k2-fsa.github.io/sherpa/onnx/pretrained_models/offline-ctc/index.html
// to download pre-trained models
type OfflineNemoEncDecCtcModelConfig struct {
Model string // Path to the model, e.g., model.onnx or model.int8.onnx
}
type OfflineZipformerCtcModelConfig struct {
Model string // Path to the model, e.g., model.onnx or model.int8.onnx
}
type OfflineDolphinModelConfig struct {
Model string // Path to the model, e.g., model.onnx or model.int8.onnx
}
type OfflineWhisperModelConfig struct {
Encoder string
Decoder string
Language string
Task string
TailPaddings int
}
type OfflineCanaryModelConfig struct {
Encoder string
Decoder string
SrcLang string
TgtLang string
UsePnc int
}
type OfflineFireRedAsrModelConfig struct {
Encoder string
Decoder string
}
type OfflineMoonshineModelConfig struct {
Preprocessor string
Encoder string
UncachedDecoder string
CachedDecoder string
}
type OfflineTdnnModelConfig struct {
Model string
}
type OfflineSenseVoiceModelConfig struct {
Model string
Language string
UseInverseTextNormalization int
}
// Configuration for offline LM.
type OfflineLMConfig struct {
Model string // Path to the model
Scale float32 // scale for LM score
}
type OfflineModelConfig struct {
Transducer OfflineTransducerModelConfig
Paraformer OfflineParaformerModelConfig
NemoCTC OfflineNemoEncDecCtcModelConfig
Whisper OfflineWhisperModelConfig
Tdnn OfflineTdnnModelConfig
SenseVoice OfflineSenseVoiceModelConfig
Moonshine OfflineMoonshineModelConfig
FireRedAsr OfflineFireRedAsrModelConfig
Dolphin OfflineDolphinModelConfig
ZipformerCtc OfflineZipformerCtcModelConfig
Canary OfflineCanaryModelConfig
Tokens string // Path to tokens.txt
// Number of threads to use for neural network computation
NumThreads int
// 1 to print model meta information while loading
Debug int
// Optional. Valid values: cpu, cuda, coreml
Provider string
// Optional. Specify it for faster model initialization.
ModelType string
ModelingUnit string // Optional. cjkchar, bpe, cjkchar+bpe
BpeVocab string // Optional.
TeleSpeechCtc string // Optional.
}
// Configuration for the offline/non-streaming recognizer.
type OfflineRecognizerConfig struct {
FeatConfig FeatureConfig
ModelConfig OfflineModelConfig
LmConfig OfflineLMConfig
// Valid decoding method: greedy_search, modified_beam_search
DecodingMethod string
// Used only when DecodingMethod is modified_beam_search.
MaxActivePaths int
HotwordsFile string
HotwordsScore float32
BlankPenalty float32
RuleFsts string
RuleFars string
Hr HomophoneReplacerConfig
}
// It wraps a pointer from C
type OfflineRecognizer struct {
impl *C.struct_SherpaOnnxOfflineRecognizer
}
// It wraps a pointer from C
type OfflineStream struct {
impl *C.struct_SherpaOnnxOfflineStream
}
// It contains recognition result of an offline stream.
type OfflineRecognizerResult struct {
Text string
Tokens []string
Timestamps []float32
Durations []float32
Lang string
Emotion string
Event string
}
func newCOfflineRecognizerConfig(config *OfflineRecognizerConfig) *C.struct_SherpaOnnxOfflineRecognizerConfig {
c := C.struct_SherpaOnnxOfflineRecognizerConfig{}
c.feat_config.sample_rate = C.int(config.FeatConfig.SampleRate)
c.feat_config.feature_dim = C.int(config.FeatConfig.FeatureDim)
c.model_config.transducer.encoder = C.CString(config.ModelConfig.Transducer.Encoder)
c.model_config.transducer.decoder = C.CString(config.ModelConfig.Transducer.Decoder)
c.model_config.transducer.joiner = C.CString(config.ModelConfig.Transducer.Joiner)
c.model_config.paraformer.model = C.CString(config.ModelConfig.Paraformer.Model)
c.model_config.nemo_ctc.model = C.CString(config.ModelConfig.NemoCTC.Model)
c.model_config.whisper.encoder = C.CString(config.ModelConfig.Whisper.Encoder)
c.model_config.whisper.decoder = C.CString(config.ModelConfig.Whisper.Decoder)
c.model_config.whisper.language = C.CString(config.ModelConfig.Whisper.Language)
c.model_config.whisper.task = C.CString(config.ModelConfig.Whisper.Task)
c.model_config.whisper.tail_paddings = C.int(config.ModelConfig.Whisper.TailPaddings)
c.model_config.tdnn.model = C.CString(config.ModelConfig.Tdnn.Model)
c.model_config.sense_voice.model = C.CString(config.ModelConfig.SenseVoice.Model)
c.model_config.sense_voice.language = C.CString(config.ModelConfig.SenseVoice.Language)
c.model_config.sense_voice.use_itn = C.int(config.ModelConfig.SenseVoice.UseInverseTextNormalization)
c.model_config.moonshine.preprocessor = C.CString(config.ModelConfig.Moonshine.Preprocessor)
c.model_config.moonshine.encoder = C.CString(config.ModelConfig.Moonshine.Encoder)
c.model_config.moonshine.uncached_decoder = C.CString(config.ModelConfig.Moonshine.UncachedDecoder)
c.model_config.moonshine.cached_decoder = C.CString(config.ModelConfig.Moonshine.CachedDecoder)
c.model_config.fire_red_asr.encoder = C.CString(config.ModelConfig.FireRedAsr.Encoder)
c.model_config.fire_red_asr.decoder = C.CString(config.ModelConfig.FireRedAsr.Decoder)
c.model_config.dolphin.model = C.CString(config.ModelConfig.Dolphin.Model)
c.model_config.zipformer_ctc.model = C.CString(config.ModelConfig.ZipformerCtc.Model)
c.model_config.canary.encoder = C.CString(config.ModelConfig.Canary.Encoder)
c.model_config.canary.decoder = C.CString(config.ModelConfig.Canary.Decoder)
c.model_config.canary.src_lang = C.CString(config.ModelConfig.Canary.SrcLang)
c.model_config.canary.tgt_lang = C.CString(config.ModelConfig.Canary.TgtLang)
c.model_config.canary.use_pnc = C.int(config.ModelConfig.Canary.UsePnc)
c.model_config.tokens = C.CString(config.ModelConfig.Tokens)
c.model_config.num_threads = C.int(config.ModelConfig.NumThreads)
c.model_config.debug = C.int(config.ModelConfig.Debug)
c.model_config.provider = C.CString(config.ModelConfig.Provider)
c.model_config.model_type = C.CString(config.ModelConfig.ModelType)
c.model_config.modeling_unit = C.CString(config.ModelConfig.ModelingUnit)
c.model_config.bpe_vocab = C.CString(config.ModelConfig.BpeVocab)
c.model_config.telespeech_ctc = C.CString(config.ModelConfig.TeleSpeechCtc)
c.lm_config.model = C.CString(config.LmConfig.Model)
c.lm_config.scale = C.float(config.LmConfig.Scale)
c.decoding_method = C.CString(config.DecodingMethod)
c.max_active_paths = C.int(config.MaxActivePaths)
c.hotwords_file = C.CString(config.HotwordsFile)
c.hotwords_score = C.float(config.HotwordsScore)
c.blank_penalty = C.float(config.BlankPenalty)
c.rule_fsts = C.CString(config.RuleFsts)
c.rule_fars = C.CString(config.RuleFars)
c.hr.dict_dir = C.CString(config.Hr.DictDir)
c.hr.lexicon = C.CString(config.Hr.Lexicon)
c.hr.rule_fsts = C.CString(config.Hr.RuleFsts)
return &c
}
func freeCOfflineRecognizerConfig(c *C.struct_SherpaOnnxOfflineRecognizerConfig) {
if c.model_config.transducer.encoder != nil {
C.free(unsafe.Pointer(c.model_config.transducer.encoder))
c.model_config.transducer.encoder = nil
}
if c.model_config.transducer.decoder != nil {
C.free(unsafe.Pointer(c.model_config.transducer.decoder))
c.model_config.transducer.decoder = nil
}
if c.model_config.transducer.joiner != nil {
C.free(unsafe.Pointer(c.model_config.transducer.joiner))
c.model_config.transducer.joiner = nil
}
if c.model_config.paraformer.model != nil {
C.free(unsafe.Pointer(c.model_config.paraformer.model))
c.model_config.paraformer.model = nil
}
if c.model_config.nemo_ctc.model != nil {
C.free(unsafe.Pointer(c.model_config.nemo_ctc.model))
c.model_config.nemo_ctc.model = nil
}
if c.model_config.whisper.encoder != nil {
C.free(unsafe.Pointer(c.model_config.whisper.encoder))
c.model_config.whisper.encoder = nil
}
if c.model_config.whisper.decoder != nil {
C.free(unsafe.Pointer(c.model_config.whisper.decoder))
c.model_config.whisper.decoder = nil
}
if c.model_config.whisper.language != nil {
C.free(unsafe.Pointer(c.model_config.whisper.language))
c.model_config.whisper.language = nil
}
if c.model_config.whisper.task != nil {
C.free(unsafe.Pointer(c.model_config.whisper.task))
c.model_config.whisper.task = nil
}
if c.model_config.tdnn.model != nil {
C.free(unsafe.Pointer(c.model_config.tdnn.model))
c.model_config.tdnn.model = nil
}
if c.model_config.sense_voice.model != nil {
C.free(unsafe.Pointer(c.model_config.sense_voice.model))
c.model_config.sense_voice.model = nil
}
if c.model_config.sense_voice.language != nil {
C.free(unsafe.Pointer(c.model_config.sense_voice.language))
c.model_config.sense_voice.language = nil
}
if c.model_config.moonshine.preprocessor != nil {
C.free(unsafe.Pointer(c.model_config.moonshine.preprocessor))
c.model_config.moonshine.preprocessor = nil
}
if c.model_config.moonshine.encoder != nil {
C.free(unsafe.Pointer(c.model_config.moonshine.encoder))
c.model_config.moonshine.encoder = nil
}
if c.model_config.moonshine.uncached_decoder != nil {
C.free(unsafe.Pointer(c.model_config.moonshine.uncached_decoder))
c.model_config.moonshine.uncached_decoder = nil
}
if c.model_config.moonshine.cached_decoder != nil {
C.free(unsafe.Pointer(c.model_config.moonshine.cached_decoder))
c.model_config.moonshine.cached_decoder = nil
}
if c.model_config.fire_red_asr.encoder != nil {
C.free(unsafe.Pointer(c.model_config.fire_red_asr.encoder))
c.model_config.fire_red_asr.encoder = nil
}
if c.model_config.fire_red_asr.decoder != nil {
C.free(unsafe.Pointer(c.model_config.fire_red_asr.decoder))
c.model_config.fire_red_asr.decoder = nil
}
if c.model_config.dolphin.model != nil {
C.free(unsafe.Pointer(c.model_config.dolphin.model))
c.model_config.dolphin.model = nil
}
if c.model_config.zipformer_ctc.model != nil {
C.free(unsafe.Pointer(c.model_config.zipformer_ctc.model))
c.model_config.zipformer_ctc.model = nil
}
if c.model_config.canary.encoder != nil {
C.free(unsafe.Pointer(c.model_config.canary.encoder))
c.model_config.canary.encoder = nil
}
if c.model_config.canary.decoder != nil {
C.free(unsafe.Pointer(c.model_config.canary.decoder))
c.model_config.canary.decoder = nil
}
if c.model_config.canary.src_lang != nil {
C.free(unsafe.Pointer(c.model_config.canary.src_lang))
c.model_config.canary.src_lang = nil
}
if c.model_config.canary.tgt_lang != nil {
C.free(unsafe.Pointer(c.model_config.canary.tgt_lang))
c.model_config.canary.tgt_lang = nil
}
if c.model_config.tokens != nil {
C.free(unsafe.Pointer(c.model_config.tokens))
c.model_config.tokens = nil
}
if c.model_config.provider != nil {
C.free(unsafe.Pointer(c.model_config.provider))
c.model_config.provider = nil
}
if c.model_config.model_type != nil {
C.free(unsafe.Pointer(c.model_config.model_type))
c.model_config.model_type = nil
}
if c.model_config.modeling_unit != nil {
C.free(unsafe.Pointer(c.model_config.modeling_unit))
c.model_config.modeling_unit = nil
}
if c.model_config.bpe_vocab != nil {
C.free(unsafe.Pointer(c.model_config.bpe_vocab))
c.model_config.bpe_vocab = nil
}
if c.model_config.telespeech_ctc != nil {
C.free(unsafe.Pointer(c.model_config.telespeech_ctc))
c.model_config.telespeech_ctc = nil
}
if c.lm_config.model != nil {
C.free(unsafe.Pointer(c.lm_config.model))
c.lm_config.model = nil
}
if c.decoding_method != nil {
C.free(unsafe.Pointer(c.decoding_method))
c.decoding_method = nil
}
if c.hotwords_file != nil {
C.free(unsafe.Pointer(c.hotwords_file))
c.hotwords_file = nil
}
if c.rule_fsts != nil {
C.free(unsafe.Pointer(c.rule_fsts))
c.rule_fsts = nil
}
if c.rule_fars != nil {
C.free(unsafe.Pointer(c.rule_fars))
c.rule_fars = nil
}
if c.hr.dict_dir != nil {
C.free(unsafe.Pointer(c.hr.dict_dir))
c.hr.dict_dir = nil
}
if c.hr.lexicon != nil {
C.free(unsafe.Pointer(c.hr.lexicon))
c.hr.lexicon = nil
}
if c.hr.rule_fsts != nil {
C.free(unsafe.Pointer(c.hr.rule_fsts))
c.hr.rule_fsts = nil
}
}
// Frees the internal pointer of the recognition to avoid memory leak.
func DeleteOfflineRecognizer(recognizer *OfflineRecognizer) {
C.SherpaOnnxDestroyOfflineRecognizer(recognizer.impl)
recognizer.impl = nil
}
// The user is responsible to invoke [DeleteOfflineRecognizer]() to free
// the returned recognizer to avoid memory leak
func NewOfflineRecognizer(config *OfflineRecognizerConfig) *OfflineRecognizer {
c := newCOfflineRecognizerConfig(config)
defer freeCOfflineRecognizerConfig(c)
impl := C.SherpaOnnxCreateOfflineRecognizer(c)
if impl == nil {
return nil
}
recognizer := &OfflineRecognizer{}
recognizer.impl = impl
return recognizer
}
// Set new config to replace
func (r *OfflineRecognizer) SetConfig(config *OfflineRecognizerConfig) {
c := newCOfflineRecognizerConfig(config)
defer freeCOfflineRecognizerConfig(c)
C.SherpaOnnxOfflineRecognizerSetConfig(r.impl, c)
}
// Frees the internal pointer of the stream to avoid memory leak.
func DeleteOfflineStream(stream *OfflineStream) {
C.SherpaOnnxDestroyOfflineStream(stream.impl)
stream.impl = nil
}
// The user is responsible to invoke [DeleteOfflineStream]() to free
// the returned stream to avoid memory leak
func NewOfflineStream(recognizer *OfflineRecognizer) *OfflineStream {
stream := &OfflineStream{}
stream.impl = C.SherpaOnnxCreateOfflineStream(recognizer.impl)
return stream
}
// Input audio samples for the offline stream.
// Please only call it once. That is, input all samples at once.
//
// sampleRate is the sample rate of the input audio samples. If it is different
// from the value expected by the feature extractor, we will do resampling inside.
//
// samples contains the actual audio samples. Each sample is in the range [-1, 1].
func (s *OfflineStream) AcceptWaveform(sampleRate int, samples []float32) {
C.SherpaOnnxAcceptWaveformOffline(s.impl, C.int(sampleRate), (*C.float)(&samples[0]), C.int(len(samples)))
}
// Decode the offline stream.
func (recognizer *OfflineRecognizer) Decode(s *OfflineStream) {
C.SherpaOnnxDecodeOfflineStream(recognizer.impl, s.impl)
}
// Decode multiple streams in parallel, i.e., in batch.
func (recognizer *OfflineRecognizer) DecodeStreams(s []*OfflineStream) {
ss := make([]*C.struct_SherpaOnnxOfflineStream, len(s))
for i, v := range s {
ss[i] = v.impl
}
C.SherpaOnnxDecodeMultipleOfflineStreams(recognizer.impl, &ss[0], C.int(len(s)))
}
// Get the recognition result of the offline stream.
func (s *OfflineStream) GetResult() *OfflineRecognizerResult {
p := C.SherpaOnnxGetOfflineStreamResult(s.impl)
defer C.SherpaOnnxDestroyOfflineRecognizerResult(p)
n := int(p.count)
if n == 0 {
return nil
}
result := &OfflineRecognizerResult{}
result.Text = C.GoString(p.text)
result.Lang = C.GoString(p.lang)
result.Emotion = C.GoString(p.emotion)
result.Event = C.GoString(p.event)
result.Tokens = make([]string, n)
tokens := unsafe.Slice(p.tokens_arr, n)
for i := 0; i < n; i++ {
result.Tokens[i] = C.GoString(tokens[i])
}
if p.timestamps != nil {
result.Timestamps = make([]float32, n)
timestamps := unsafe.Slice(p.timestamps, n)
for i := 0; i < n; i++ {
result.Timestamps[i] = float32(timestamps[i])
}
}
if p.durations != nil {
result.Durations = make([]float32, n)
durations := unsafe.Slice(p.durations, n)
for i := 0; i < n; i++ {
result.Durations[i] = float32(durations[i])
}
}
return result
}
// Configuration for offline/non-streaming text-to-speech (TTS).
//
// Please refer to
// https://k2-fsa.github.io/sherpa/onnx/tts/pretrained_models/index.html
// to download pre-trained models
type OfflineTtsVitsModelConfig struct {
Model string // Path to the VITS onnx model
Lexicon string // Path to lexicon.txt
Tokens string // Path to tokens.txt
DataDir string // Path to espeak-ng-data directory
NoiseScale float32 // noise scale for vits models. Please use 0.667 in general
NoiseScaleW float32 // noise scale for vits models. Please use 0.8 in general
LengthScale float32 // Please use 1.0 in general. Smaller -> Faster speech speed. Larger -> Slower speech speed
DictDir string // Path to dict directory for jieba (used only in Chinese tts)
}
type OfflineTtsMatchaModelConfig struct {
AcousticModel string // Path to the acoustic model for MatchaTTS
Vocoder string // Path to the vocoder model for MatchaTTS
Lexicon string // Path to lexicon.txt
Tokens string // Path to tokens.txt
DataDir string // Path to espeak-ng-data directory
NoiseScale float32 // noise scale for vits models. Please use 0.667 in general
LengthScale float32 // Please use 1.0 in general. Smaller -> Faster speech speed. Larger -> Slower speech speed
DictDir string // Path to dict directory for jieba (used only in Chinese tts)
}
type OfflineTtsKokoroModelConfig struct {
Model string // Path to the model for kokoro
Voices string // Path to the voices.bin for kokoro
Tokens string // Path to tokens.txt
DataDir string // Path to espeak-ng-data directory
DictDir string // Path to dict directory
Lexicon string // Path to lexicon files
Lang string // Example: es for Spanish, fr-fr for French. Can be empty
LengthScale float32 // Please use 1.0 in general. Smaller -> Faster speech speed. Larger -> Slower speech speed
}
type OfflineTtsKittenModelConfig struct {
Model string // Path to the model for kitten
Voices string // Path to the voices.bin for kitten
Tokens string // Path to tokens.txt
DataDir string // Path to espeak-ng-data directory
LengthScale float32 // Please use 1.0 in general. Smaller -> Faster speech speed. Larger -> Slower speech speed
}
type OfflineTtsModelConfig struct {
Vits OfflineTtsVitsModelConfig
Matcha OfflineTtsMatchaModelConfig
Kokoro OfflineTtsKokoroModelConfig
Kitten OfflineTtsKittenModelConfig
// Number of threads to use for neural network computation
NumThreads int
// 1 to print model meta information while loading
Debug int
// Optional. Valid values: cpu, cuda, coreml
Provider string
}
type OfflineTtsConfig struct {
Model OfflineTtsModelConfig
RuleFsts string
RuleFars string
MaxNumSentences int
SilenceScale float32
}
type GeneratedAudio struct {
// Normalized samples in the range [-1, 1]
Samples []float32
SampleRate int
}
// The offline tts class. It wraps a pointer from C.
type OfflineTts struct {
impl *C.struct_SherpaOnnxOfflineTts
}
type sherpaOnnxGeneratedAudioCallbackWithArg func(samples []float32)
//export _cgoGeneratedAudioCallback
func _cgoGeneratedAudioCallback(samples *C.float, n C.int32_t, arg unsafe.Pointer) C.int32_t {
h := *(*cgo.Handle)(arg)
val := h.Value().(sherpaOnnxGeneratedAudioCallbackWithArg)
all := make([]float32, n)
arr := unsafe.Slice(samples, n)
for i := 0; i < int(n); i++ {
all[i] = float32(arr[i])
}
val(all)
return 1
}
type sherpaOnnxGeneratedAudioProgressCallbackWithArg func(samples []float32, p float32)
//export _cgoGeneratedAudioProgressCallback
func _cgoGeneratedAudioProgressCallback(samples *C.float, n C.int32_t, p C.float, arg unsafe.Pointer) C.int32_t {
h := *(*cgo.Handle)(arg)
val := h.Value().(sherpaOnnxGeneratedAudioProgressCallbackWithArg)
all := make([]float32, n)
arr := unsafe.Slice(samples, n)
for i := 0; i < int(n); i++ {
all[i] = float32(arr[i])
}
val(all, float32(p))
return 1
}
// Free the internal pointer inside the tts to avoid memory leak.
func DeleteOfflineTts(tts *OfflineTts) {
C.SherpaOnnxDestroyOfflineTts(tts.impl)
tts.impl = nil
}
// The user is responsible to invoke [DeleteOfflineTts]() to free
// the returned tts to avoid memory leak
func NewOfflineTts(config *OfflineTtsConfig) *OfflineTts {
c := C.struct_SherpaOnnxOfflineTtsConfig{}
c.rule_fsts = C.CString(config.RuleFsts)
defer C.free(unsafe.Pointer(c.rule_fsts))
c.rule_fars = C.CString(config.RuleFars)
defer C.free(unsafe.Pointer(c.rule_fars))
c.max_num_sentences = C.int(config.MaxNumSentences)
c.silence_scale = C.float(config.SilenceScale)
// vits
c.model.vits.model = C.CString(config.Model.Vits.Model)
defer C.free(unsafe.Pointer(c.model.vits.model))
c.model.vits.lexicon = C.CString(config.Model.Vits.Lexicon)
defer C.free(unsafe.Pointer(c.model.vits.lexicon))
c.model.vits.tokens = C.CString(config.Model.Vits.Tokens)
defer C.free(unsafe.Pointer(c.model.vits.tokens))
c.model.vits.data_dir = C.CString(config.Model.Vits.DataDir)
defer C.free(unsafe.Pointer(c.model.vits.data_dir))
c.model.vits.noise_scale = C.float(config.Model.Vits.NoiseScale)
c.model.vits.noise_scale_w = C.float(config.Model.Vits.NoiseScaleW)
c.model.vits.length_scale = C.float(config.Model.Vits.LengthScale)
c.model.vits.dict_dir = C.CString(config.Model.Vits.DictDir)
defer C.free(unsafe.Pointer(c.model.vits.dict_dir))
// matcha
c.model.matcha.acoustic_model = C.CString(config.Model.Matcha.AcousticModel)
defer C.free(unsafe.Pointer(c.model.matcha.acoustic_model))
c.model.matcha.vocoder = C.CString(config.Model.Matcha.Vocoder)
defer C.free(unsafe.Pointer(c.model.matcha.vocoder))
c.model.matcha.lexicon = C.CString(config.Model.Matcha.Lexicon)
defer C.free(unsafe.Pointer(c.model.matcha.lexicon))
c.model.matcha.tokens = C.CString(config.Model.Matcha.Tokens)
defer C.free(unsafe.Pointer(c.model.matcha.tokens))
c.model.matcha.data_dir = C.CString(config.Model.Matcha.DataDir)
defer C.free(unsafe.Pointer(c.model.matcha.data_dir))
c.model.matcha.noise_scale = C.float(config.Model.Matcha.NoiseScale)
c.model.matcha.length_scale = C.float(config.Model.Matcha.LengthScale)
c.model.matcha.dict_dir = C.CString(config.Model.Matcha.DictDir)
defer C.free(unsafe.Pointer(c.model.matcha.dict_dir))
// kokoro
c.model.kokoro.model = C.CString(config.Model.Kokoro.Model)
defer C.free(unsafe.Pointer(c.model.kokoro.model))
c.model.kokoro.voices = C.CString(config.Model.Kokoro.Voices)
defer C.free(unsafe.Pointer(c.model.kokoro.voices))
c.model.kokoro.tokens = C.CString(config.Model.Kokoro.Tokens)
defer C.free(unsafe.Pointer(c.model.kokoro.tokens))
c.model.kokoro.data_dir = C.CString(config.Model.Kokoro.DataDir)
defer C.free(unsafe.Pointer(c.model.kokoro.data_dir))
c.model.kokoro.dict_dir = C.CString(config.Model.Kokoro.DictDir)
defer C.free(unsafe.Pointer(c.model.kokoro.dict_dir))
c.model.kokoro.lexicon = C.CString(config.Model.Kokoro.Lexicon)
defer C.free(unsafe.Pointer(c.model.kokoro.lexicon))
c.model.kokoro.lang = C.CString(config.Model.Kokoro.Lang)
defer C.free(unsafe.Pointer(c.model.kokoro.lang))
c.model.kokoro.length_scale = C.float(config.Model.Kokoro.LengthScale)
// kitten
c.model.kitten.model = C.CString(config.Model.Kitten.Model)
defer C.free(unsafe.Pointer(c.model.kitten.model))
c.model.kitten.voices = C.CString(config.Model.Kitten.Voices)
defer C.free(unsafe.Pointer(c.model.kitten.voices))
c.model.kitten.tokens = C.CString(config.Model.Kitten.Tokens)
defer C.free(unsafe.Pointer(c.model.kitten.tokens))
c.model.kitten.data_dir = C.CString(config.Model.Kitten.DataDir)
defer C.free(unsafe.Pointer(c.model.kitten.data_dir))
c.model.kitten.length_scale = C.float(config.Model.Kitten.LengthScale)
c.model.num_threads = C.int(config.Model.NumThreads)
c.model.debug = C.int(config.Model.Debug)
c.model.provider = C.CString(config.Model.Provider)
defer C.free(unsafe.Pointer(c.model.provider))
impl := C.SherpaOnnxCreateOfflineTts(&c)
if impl == nil {
return nil
}
tts := &OfflineTts{}
tts.impl = impl
return tts
}
func (tts *OfflineTts) Generate(text string, sid int, speed float32) *GeneratedAudio {
s := C.CString(text)
defer C.free(unsafe.Pointer(s))
audio := C.SherpaOnnxOfflineTtsGenerate(tts.impl, s, C.int(sid), C.float(speed))
defer C.SherpaOnnxDestroyOfflineTtsGeneratedAudio(audio)
ans := &GeneratedAudio{}
ans.SampleRate = int(audio.sample_rate)
n := int(audio.n)
ans.Samples = make([]float32, n)
// see https://stackoverflow.com/questions/48756732/what-does-1-30c-yourtype-do-exactly-in-cgo
// :n:n means 0:n:n, means low:high:capacity
samples := unsafe.Slice(audio.samples, n)
for i := 0; i < n; i++ {
ans.Samples[i] = float32(samples[i])
}
return ans
}
func (tts *OfflineTts) GenerateWithCallback(text string, sid int, speed float32, cb sherpaOnnxGeneratedAudioCallbackWithArg) {
s := C.CString(text)
defer C.free(unsafe.Pointer(s))
h := cgo.NewHandle(cb)
defer h.Delete()
audio := C.SherpaOnnxOfflineTtsGenerateWithCallbackWithArg(tts.impl, s, C.int(sid), C.float(speed), C.SherpaOnnxGeneratedAudioCallbackWithArg(C._cgoGeneratedAudioCallback), unsafe.Pointer(&h))
defer C.SherpaOnnxDestroyOfflineTtsGeneratedAudio(audio)
}
func (tts *OfflineTts) GenerateWithProgressCallback(text string, sid int, speed float32, cb sherpaOnnxGeneratedAudioProgressCallbackWithArg) {
s := C.CString(text)
defer C.free(unsafe.Pointer(s))
h := cgo.NewHandle(cb)
defer h.Delete()
audio := C.SherpaOnnxOfflineTtsGenerateWithProgressCallbackWithArg(tts.impl, s, C.int(sid), C.float(speed), C.SherpaOnnxGeneratedAudioProgressCallbackWithArg(C._cgoGeneratedAudioProgressCallback), unsafe.Pointer(&h))
defer C.SherpaOnnxDestroyOfflineTtsGeneratedAudio(audio)
}
func (audio *GeneratedAudio) Save(filename string) bool {
s := C.CString(filename)
defer C.free(unsafe.Pointer(s))
ok := int(C.SherpaOnnxWriteWave((*C.float)(&audio.Samples[0]), C.int(len(audio.Samples)), C.int(audio.SampleRate), s))
return ok == 1
}
// ============================================================
// For VAD
// ============================================================
type SileroVadModelConfig struct {
Model string
Threshold float32
MinSilenceDuration float32
MinSpeechDuration float32
WindowSize int
MaxSpeechDuration float32
}
type TenVadModelConfig struct {
Model string
Threshold float32
MinSilenceDuration float32
MinSpeechDuration float32
WindowSize int
MaxSpeechDuration float32
}
type VadModelConfig struct {
SileroVad SileroVadModelConfig
TenVad TenVadModelConfig
SampleRate int
NumThreads int
Provider string
Debug int
}
type CircularBuffer struct {
impl *C.struct_SherpaOnnxCircularBuffer
}
func DeleteCircularBuffer(buffer *CircularBuffer) {
C.SherpaOnnxDestroyCircularBuffer(buffer.impl)
buffer.impl = nil
}
func NewCircularBuffer(capacity int) *CircularBuffer {
circularBuffer := &CircularBuffer{}
circularBuffer.impl = C.SherpaOnnxCreateCircularBuffer(C.int(capacity))
return circularBuffer
}
func (buffer *CircularBuffer) Push(samples []float32) {
C.SherpaOnnxCircularBufferPush(buffer.impl, (*C.float)(&samples[0]), C.int(len(samples)))
}
func (buffer *CircularBuffer) Get(start int, n int) []float32 {
samples := C.SherpaOnnxCircularBufferGet(buffer.impl, C.int(start), C.int(n))
defer C.SherpaOnnxCircularBufferFree(samples)
result := make([]float32, n)
p := unsafe.Slice(samples, n)
for i := 0; i < n; i++ {
result[i] = float32(p[i])
}
return result
}
func (buffer *CircularBuffer) Pop(n int) {
C.SherpaOnnxCircularBufferPop(buffer.impl, C.int(n))
}
func (buffer *CircularBuffer) Size() int {
return int(C.SherpaOnnxCircularBufferSize(buffer.impl))
}
func (buffer *CircularBuffer) Head() int {
return int(C.SherpaOnnxCircularBufferHead(buffer.impl))
}
func (buffer *CircularBuffer) Reset() {
C.SherpaOnnxCircularBufferReset(buffer.impl)
}
type SpeechSegment struct {
Start int
Samples []float32
}
type VoiceActivityDetector struct {
impl *C.struct_SherpaOnnxVoiceActivityDetector
}
func NewVoiceActivityDetector(config *VadModelConfig, bufferSizeInSeconds float32) *VoiceActivityDetector {
c := C.struct_SherpaOnnxVadModelConfig{}
c.silero_vad.model = C.CString(config.SileroVad.Model)
defer C.free(unsafe.Pointer(c.silero_vad.model))
c.silero_vad.threshold = C.float(config.SileroVad.Threshold)
c.silero_vad.min_silence_duration = C.float(config.SileroVad.MinSilenceDuration)
c.silero_vad.min_speech_duration = C.float(config.SileroVad.MinSpeechDuration)
c.silero_vad.window_size = C.int(config.SileroVad.WindowSize)
c.silero_vad.max_speech_duration = C.float(config.SileroVad.MaxSpeechDuration)
c.ten_vad.model = C.CString(config.TenVad.Model)
defer C.free(unsafe.Pointer(c.ten_vad.model))
c.ten_vad.threshold = C.float(config.TenVad.Threshold)
c.ten_vad.min_silence_duration = C.float(config.TenVad.MinSilenceDuration)
c.ten_vad.min_speech_duration = C.float(config.TenVad.MinSpeechDuration)
c.ten_vad.window_size = C.int(config.TenVad.WindowSize)
c.ten_vad.max_speech_duration = C.float(config.TenVad.MaxSpeechDuration)
c.sample_rate = C.int(config.SampleRate)
c.num_threads = C.int(config.NumThreads)
c.provider = C.CString(config.Provider)
defer C.free(unsafe.Pointer(c.provider))
c.debug = C.int(config.Debug)
impl := C.SherpaOnnxCreateVoiceActivityDetector(&c, C.float(bufferSizeInSeconds))
if impl == nil {
return nil
}
vad := &VoiceActivityDetector{}
vad.impl = impl
return vad
}
func DeleteVoiceActivityDetector(vad *VoiceActivityDetector) {
C.SherpaOnnxDestroyVoiceActivityDetector(vad.impl)
vad.impl = nil
}
func (vad *VoiceActivityDetector) AcceptWaveform(samples []float32) {
C.SherpaOnnxVoiceActivityDetectorAcceptWaveform(vad.impl, (*C.float)(&samples[0]), C.int(len(samples)))
}
func (vad *VoiceActivityDetector) IsEmpty() bool {
return int(C.SherpaOnnxVoiceActivityDetectorEmpty(vad.impl)) == 1
}
func (vad *VoiceActivityDetector) IsSpeech() bool {
return int(C.SherpaOnnxVoiceActivityDetectorDetected(vad.impl)) == 1
}
func (vad *VoiceActivityDetector) Pop() {
C.SherpaOnnxVoiceActivityDetectorPop(vad.impl)
}
func (vad *VoiceActivityDetector) Clear() {
C.SherpaOnnxVoiceActivityDetectorClear(vad.impl)
}
func (vad *VoiceActivityDetector) Front() *SpeechSegment {
f := C.SherpaOnnxVoiceActivityDetectorFront(vad.impl)
defer C.SherpaOnnxDestroySpeechSegment(f)
ans := &SpeechSegment{}
ans.Start = int(f.start)
n := int(f.n)
ans.Samples = make([]float32, n)
samples := unsafe.Slice(f.samples, n)
for i := 0; i < n; i++ {
ans.Samples[i] = float32(samples[i])
}
return ans
}
func (vad *VoiceActivityDetector) Reset() {
C.SherpaOnnxVoiceActivityDetectorReset(vad.impl)
}
func (vad *VoiceActivityDetector) Flush() {
C.SherpaOnnxVoiceActivityDetectorFlush(vad.impl)
}
// Spoken language identification
type SpokenLanguageIdentificationWhisperConfig struct {
Encoder string
Decoder string
TailPaddings int
}
type SpokenLanguageIdentificationConfig struct {
Whisper SpokenLanguageIdentificationWhisperConfig
NumThreads int
Debug int
Provider string
}
type SpokenLanguageIdentification struct {
impl *C.struct_SherpaOnnxSpokenLanguageIdentification
}
type SpokenLanguageIdentificationResult struct {
Lang string
}
func NewSpokenLanguageIdentification(config *SpokenLanguageIdentificationConfig) *SpokenLanguageIdentification {
c := C.struct_SherpaOnnxSpokenLanguageIdentificationConfig{}
c.whisper.encoder = C.CString(config.Whisper.Encoder)
defer C.free(unsafe.Pointer(c.whisper.encoder))
c.whisper.decoder = C.CString(config.Whisper.Decoder)
defer C.free(unsafe.Pointer(c.whisper.decoder))
c.whisper.tail_paddings = C.int(config.Whisper.TailPaddings)
c.num_threads = C.int(config.NumThreads)
c.debug = C.int(config.Debug)
c.provider = C.CString(config.Provider)
defer C.free(unsafe.Pointer(c.provider))
slid := &SpokenLanguageIdentification{}
slid.impl = C.SherpaOnnxCreateSpokenLanguageIdentification(&c)
return slid
}
func DeleteSpokenLanguageIdentification(slid *SpokenLanguageIdentification) {
C.SherpaOnnxDestroySpokenLanguageIdentification(slid.impl)
slid.impl = nil
}
// The user has to invoke DeleteOfflineStream() to free the returned value
// to avoid memory leak
func (slid *SpokenLanguageIdentification) CreateStream() *OfflineStream {
stream := &OfflineStream{}
stream.impl = C.SherpaOnnxSpokenLanguageIdentificationCreateOfflineStream(slid.impl)
return stream
}
func (slid *SpokenLanguageIdentification) Compute(stream *OfflineStream) *SpokenLanguageIdentificationResult {
r := C.SherpaOnnxSpokenLanguageIdentificationCompute(slid.impl, stream.impl)
// defer C.SherpaOnnxDestroySpokenLanguageIdentificationResult(r)
ans := &SpokenLanguageIdentificationResult{}
ans.Lang = C.GoString(r.lang)
return ans
}
// ============================================================
// For speaker embedding extraction
// ============================================================
type SpeakerEmbeddingExtractorConfig struct {
Model string
NumThreads int
Debug int
Provider string
}
type SpeakerEmbeddingExtractor struct {
impl *C.struct_SherpaOnnxSpeakerEmbeddingExtractor
}
// The user has to invoke [DeleteSpeakerEmbeddingExtractor]() to free the returned value
// to avoid memory leak
func NewSpeakerEmbeddingExtractor(config *SpeakerEmbeddingExtractorConfig) *SpeakerEmbeddingExtractor {
c := C.struct_SherpaOnnxSpeakerEmbeddingExtractorConfig{}
c.model = C.CString(config.Model)
defer C.free(unsafe.Pointer(c.model))
c.num_threads = C.int(config.NumThreads)
c.debug = C.int(config.Debug)
c.provider = C.CString(config.Provider)
defer C.free(unsafe.Pointer(c.provider))
impl := C.SherpaOnnxCreateSpeakerEmbeddingExtractor(&c)
if impl == nil {
return nil
}
ex := &SpeakerEmbeddingExtractor{}
ex.impl = impl
return ex
}
func DeleteSpeakerEmbeddingExtractor(ex *SpeakerEmbeddingExtractor) {
C.SherpaOnnxDestroySpeakerEmbeddingExtractor(ex.impl)
ex.impl = nil
}
func (ex *SpeakerEmbeddingExtractor) Dim() int {
return int(C.SherpaOnnxSpeakerEmbeddingExtractorDim(ex.impl))
}
// The user is responsible to invoke [DeleteOnlineStream]() to free
// the returned stream to avoid memory leak
func (ex *SpeakerEmbeddingExtractor) CreateStream() *OnlineStream {
stream := &OnlineStream{}
stream.impl = C.SherpaOnnxSpeakerEmbeddingExtractorCreateStream(ex.impl)
return stream
}
func (ex *SpeakerEmbeddingExtractor) IsReady(stream *OnlineStream) bool {
return int(C.SherpaOnnxSpeakerEmbeddingExtractorIsReady(ex.impl, stream.impl)) == 1
}
func (ex *SpeakerEmbeddingExtractor) Compute(stream *OnlineStream) []float32 {
embedding := C.SherpaOnnxSpeakerEmbeddingExtractorComputeEmbedding(ex.impl, stream.impl)
defer C.SherpaOnnxSpeakerEmbeddingExtractorDestroyEmbedding(embedding)
n := ex.Dim()
ans := make([]float32, n)
// see https://stackoverflow.com/questions/48756732/what-does-1-30c-yourtype-do-exactly-in-cgo
// :n:n means 0:n:n, means low:high:capacity
c := unsafe.Slice(embedding, n)
for i := 0; i < n; i++ {
ans[i] = float32(c[i])
}
return ans
}
type SpeakerEmbeddingManager struct {
impl *C.struct_SherpaOnnxSpeakerEmbeddingManager
}
// The user has to invoke [DeleteSpeakerEmbeddingManager]() to free the returned
// value to avoid memory leak
func NewSpeakerEmbeddingManager(dim int) *SpeakerEmbeddingManager {
impl := C.SherpaOnnxCreateSpeakerEmbeddingManager(C.int(dim))
if impl == nil {
return nil
}
m := &SpeakerEmbeddingManager{}
m.impl = impl
return m
}
func DeleteSpeakerEmbeddingManager(m *SpeakerEmbeddingManager) {
C.SherpaOnnxDestroySpeakerEmbeddingManager(m.impl)
m.impl = nil
}
func (m *SpeakerEmbeddingManager) Register(name string, embedding []float32) bool {
s := C.CString(name)
defer C.free(unsafe.Pointer(s))
return C.int(C.SherpaOnnxSpeakerEmbeddingManagerAdd(m.impl, s, (*C.float)(&embedding[0]))) == 1
}
func (m *SpeakerEmbeddingManager) RegisterV(name string, embeddings [][]float32) bool {
s := C.CString(name)
defer C.free(unsafe.Pointer(s))
if len(embeddings) == 0 {
return false
}
dim := len(embeddings[0])
v := make([]float32, 0, dim*len(embeddings))
for _, embedding := range embeddings {
v = append(v, embedding...)
}
return C.int(C.SherpaOnnxSpeakerEmbeddingManagerAddListFlattened(m.impl, s, (*C.float)(&v[0]), C.int(len(embeddings)))) == 1
}
func (m *SpeakerEmbeddingManager) Remove(name string) bool {
s := C.CString(name)
defer C.free(unsafe.Pointer(s))
return C.int(C.SherpaOnnxSpeakerEmbeddingManagerRemove(m.impl, s)) == 1
}
func (m *SpeakerEmbeddingManager) Search(embedding []float32, threshold float32) string {
var s string
name := C.SherpaOnnxSpeakerEmbeddingManagerSearch(m.impl, (*C.float)(&embedding[0]), C.float(threshold))
defer C.SherpaOnnxSpeakerEmbeddingManagerFreeSearch(name)
if name != nil {
s = C.GoString(name)
}
return s
}
func (m *SpeakerEmbeddingManager) Verify(name string, embedding []float32, threshold float32) bool {
s := C.CString(name)
defer C.free(unsafe.Pointer(s))
return C.int(C.SherpaOnnxSpeakerEmbeddingManagerVerify(m.impl, s, (*C.float)(&embedding[0]), C.float(threshold))) == 1
}
func (m *SpeakerEmbeddingManager) Contains(name string) bool {
s := C.CString(name)
defer C.free(unsafe.Pointer(s))
return C.int(C.SherpaOnnxSpeakerEmbeddingManagerContains(m.impl, s)) == 1
}
func (m *SpeakerEmbeddingManager) NumSpeakers() int {
return int(C.SherpaOnnxSpeakerEmbeddingManagerNumSpeakers(m.impl))
}
func (m *SpeakerEmbeddingManager) AllSpeakers() []string {
all_speakers := C.SherpaOnnxSpeakerEmbeddingManagerGetAllSpeakers(m.impl)
defer C.SherpaOnnxSpeakerEmbeddingManagerFreeAllSpeakers(all_speakers)
n := m.NumSpeakers()
if n == 0 {
return nil
}
// https://stackoverflow.com/questions/62012070/convert-array-of-strings-from-cgo-in-go
p := unsafe.Slice(all_speakers, n)
ans := make([]string, n)
for i := 0; i < n; i++ {
ans[i] = C.GoString(p[i])
}
return ans
}
// Wave
// single channel wave
type Wave = GeneratedAudio
func ReadWave(filename string) *Wave {
s := C.CString(filename)
defer C.free(unsafe.Pointer(s))
w := C.SherpaOnnxReadWave(s)
defer C.SherpaOnnxFreeWave(w)
if w == nil {
return nil
}
n := int(w.num_samples)
if n == 0 {
return nil
}
ans := &Wave{}
ans.SampleRate = int(w.sample_rate)
samples := unsafe.Slice(w.samples, n)
ans.Samples = make([]float32, n)
for i := 0; i < n; i++ {
ans.Samples[i] = float32(samples[i])
}
return ans
}
// ============================================================
// For offline speaker diarization
// ============================================================
type OfflineSpeakerSegmentationPyannoteModelConfig struct {
Model string
}
type OfflineSpeakerSegmentationModelConfig struct {
Pyannote OfflineSpeakerSegmentationPyannoteModelConfig
NumThreads int
Debug int
Provider string
}
type FastClusteringConfig struct {
NumClusters int
Threshold float32
}
type OfflineSpeakerDiarizationConfig struct {
Segmentation OfflineSpeakerSegmentationModelConfig
Embedding SpeakerEmbeddingExtractorConfig
Clustering FastClusteringConfig
MinDurationOn float32
MinDurationOff float32
}
type OfflineSpeakerDiarization struct {
impl *C.struct_SherpaOnnxOfflineSpeakerDiarization
}
func DeleteOfflineSpeakerDiarization(sd *OfflineSpeakerDiarization) {
C.SherpaOnnxDestroyOfflineSpeakerDiarization(sd.impl)
sd.impl = nil
}
func NewOfflineSpeakerDiarization(config *OfflineSpeakerDiarizationConfig) *OfflineSpeakerDiarization {
c := C.struct_SherpaOnnxOfflineSpeakerDiarizationConfig{}
c.segmentation.pyannote.model = C.CString(config.Segmentation.Pyannote.Model)
defer C.free(unsafe.Pointer(c.segmentation.pyannote.model))
c.segmentation.num_threads = C.int(config.Segmentation.NumThreads)
c.segmentation.debug = C.int(config.Segmentation.Debug)
c.segmentation.provider = C.CString(config.Segmentation.Provider)
defer C.free(unsafe.Pointer(c.segmentation.provider))
c.embedding.model = C.CString(config.Embedding.Model)
defer C.free(unsafe.Pointer(c.embedding.model))
c.embedding.num_threads = C.int(config.Embedding.NumThreads)
c.embedding.debug = C.int(config.Embedding.Debug)
c.embedding.provider = C.CString(config.Embedding.Provider)
defer C.free(unsafe.Pointer(c.embedding.provider))
c.clustering.num_clusters = C.int(config.Clustering.NumClusters)
c.clustering.threshold = C.float(config.Clustering.Threshold)
c.min_duration_on = C.float(config.MinDurationOn)
c.min_duration_off = C.float(config.MinDurationOff)
p := C.SherpaOnnxCreateOfflineSpeakerDiarization(&c)
if p == nil {
return nil
}
sd := &OfflineSpeakerDiarization{}
sd.impl = p
return sd
}
func (sd *OfflineSpeakerDiarization) SampleRate() int {
return int(C.SherpaOnnxOfflineSpeakerDiarizationGetSampleRate(sd.impl))
}
// only config.Clustering is used. All other fields are ignored
func (sd *OfflineSpeakerDiarization) SetConfig(config *OfflineSpeakerDiarizationConfig) {
c := C.struct_SherpaOnnxOfflineSpeakerDiarizationConfig{}
c.clustering.num_clusters = C.int(config.Clustering.NumClusters)
c.clustering.threshold = C.float(config.Clustering.Threshold)
C.SherpaOnnxOfflineSpeakerDiarizationSetConfig(sd.impl, &c)
}
type OfflineSpeakerDiarizationSegment struct {
Start float32
End float32
Speaker int
}
func (sd *OfflineSpeakerDiarization) Process(samples []float32) []OfflineSpeakerDiarizationSegment {
r := C.SherpaOnnxOfflineSpeakerDiarizationProcess(sd.impl, (*C.float)(&samples[0]), C.int(len(samples)))
defer C.SherpaOnnxOfflineSpeakerDiarizationDestroyResult(r)
n := int(C.SherpaOnnxOfflineSpeakerDiarizationResultGetNumSegments(r))
if n == 0 {
return nil
}
s := C.SherpaOnnxOfflineSpeakerDiarizationResultSortByStartTime(r)
defer C.SherpaOnnxOfflineSpeakerDiarizationDestroySegment(s)
ans := make([]OfflineSpeakerDiarizationSegment, n)
p := unsafe.Slice(s, n)
for i := 0; i < n; i++ {
ans[i].Start = float32(p[i].start)
ans[i].End = float32(p[i].end)
ans[i].Speaker = int(p[i].speaker)
}
return ans
}
// ============================================================
// For punctuation
// ============================================================
type OfflinePunctuationModelConfig struct {
CtTransformer string
NumThreads C.int
Debug C.int // true to print debug information of the model
Provider string
}
type OfflinePunctuationConfig struct {
Model OfflinePunctuationModelConfig
}
type OfflinePunctuation struct {
impl *C.struct_SherpaOnnxOfflinePunctuation
}
func NewOfflinePunctuation(config *OfflinePunctuationConfig) *OfflinePunctuation {
cfg := C.struct_SherpaOnnxOfflinePunctuationConfig{}
cfg.model.ct_transformer = C.CString(config.Model.CtTransformer)
defer C.free(unsafe.Pointer(cfg.model.ct_transformer))
cfg.model.num_threads = config.Model.NumThreads
cfg.model.debug = config.Model.Debug
cfg.model.provider = C.CString(config.Model.Provider)
defer C.free(unsafe.Pointer(cfg.model.provider))
impl := C.SherpaOnnxCreateOfflinePunctuation(&cfg)
if impl == nil {
return nil
}
punc := &OfflinePunctuation{}
punc.impl = impl
return punc
}
func DeleteOfflinePunc(punc *OfflinePunctuation) {
C.SherpaOnnxDestroyOfflinePunctuation(punc.impl)
punc.impl = nil
}
func (punc *OfflinePunctuation) AddPunct(text string) string {
p := C.SherpaOfflinePunctuationAddPunct(punc.impl, C.CString(text))
defer C.SherpaOfflinePunctuationFreeText(p)
text_with_punct := C.GoString(p)
return text_with_punct
}
// Configuration for the online/streaming recognizer.
type KeywordSpotterConfig struct {
FeatConfig FeatureConfig
ModelConfig OnlineModelConfig
MaxActivePaths int
KeywordsFile string
KeywordsScore float32
KeywordsThreshold float32
KeywordsBuf string
KeywordsBufSize int
}
type KeywordSpotterResult struct {
Keyword string
}
type KeywordSpotter struct {
impl *C.struct_SherpaOnnxKeywordSpotter
}
// Free the internal pointer inside the recognizer to avoid memory leak.
func DeleteKeywordSpotter(spotter *KeywordSpotter) {
C.SherpaOnnxDestroyKeywordSpotter(spotter.impl)
spotter.impl = nil
}
// The user is responsible to invoke [DeleteKeywordSpotter]() to free
// the returned spotter to avoid memory leak
func NewKeywordSpotter(config *KeywordSpotterConfig) *KeywordSpotter {
c := C.struct_SherpaOnnxKeywordSpotterConfig{}
c.feat_config.sample_rate = C.int(config.FeatConfig.SampleRate)
c.feat_config.feature_dim = C.int(config.FeatConfig.FeatureDim)
c.model_config.transducer.encoder = C.CString(config.ModelConfig.Transducer.Encoder)
defer C.free(unsafe.Pointer(c.model_config.transducer.encoder))
c.model_config.transducer.decoder = C.CString(config.ModelConfig.Transducer.Decoder)
defer C.free(unsafe.Pointer(c.model_config.transducer.decoder))
c.model_config.transducer.joiner = C.CString(config.ModelConfig.Transducer.Joiner)
defer C.free(unsafe.Pointer(c.model_config.transducer.joiner))
c.model_config.paraformer.encoder = C.CString(config.ModelConfig.Paraformer.Encoder)
defer C.free(unsafe.Pointer(c.model_config.paraformer.encoder))
c.model_config.paraformer.decoder = C.CString(config.ModelConfig.Paraformer.Decoder)
defer C.free(unsafe.Pointer(c.model_config.paraformer.decoder))
c.model_config.zipformer2_ctc.model = C.CString(config.ModelConfig.Zipformer2Ctc.Model)
defer C.free(unsafe.Pointer(c.model_config.zipformer2_ctc.model))
c.model_config.nemo_ctc.model = C.CString(config.ModelConfig.NemoCtc.Model)
defer C.free(unsafe.Pointer(c.model_config.nemo_ctc.model))
c.model_config.tokens = C.CString(config.ModelConfig.Tokens)
defer C.free(unsafe.Pointer(c.model_config.tokens))
c.model_config.num_threads = C.int(config.ModelConfig.NumThreads)
c.model_config.provider = C.CString(config.ModelConfig.Provider)
defer C.free(unsafe.Pointer(c.model_config.provider))
c.model_config.debug = C.int(config.ModelConfig.Debug)
c.model_config.model_type = C.CString(config.ModelConfig.ModelType)
defer C.free(unsafe.Pointer(c.model_config.model_type))
c.model_config.modeling_unit = C.CString(config.ModelConfig.ModelingUnit)
defer C.free(unsafe.Pointer(c.model_config.modeling_unit))
c.model_config.bpe_vocab = C.CString(config.ModelConfig.BpeVocab)
defer C.free(unsafe.Pointer(c.model_config.bpe_vocab))
c.model_config.tokens_buf = C.CString(config.ModelConfig.TokensBuf)
defer C.free(unsafe.Pointer(c.model_config.tokens_buf))
c.model_config.tokens_buf_size = C.int(config.ModelConfig.TokensBufSize)
c.max_active_paths = C.int(config.MaxActivePaths)
c.keywords_file = C.CString(config.KeywordsFile)
defer C.free(unsafe.Pointer(c.keywords_file))
c.keywords_score = C.float(config.KeywordsScore)
c.keywords_threshold = C.float(config.KeywordsThreshold)
c.keywords_buf = C.CString(config.KeywordsBuf)
defer C.free(unsafe.Pointer(c.keywords_buf))
c.keywords_buf_size = C.int(config.KeywordsBufSize)
impl := C.SherpaOnnxCreateKeywordSpotter(&c)
if impl == nil {
return nil
}
spotter := &KeywordSpotter{}
spotter.impl = impl
return spotter
}
// The user is responsible to invoke [DeleteOnlineStream]() to free
// the returned stream to avoid memory leak
func NewKeywordStream(spotter *KeywordSpotter) *OnlineStream {
stream := &OnlineStream{}
stream.impl = C.SherpaOnnxCreateKeywordStream(spotter.impl)
return stream
}
// The user is responsible to invoke [DeleteOnlineStream]() to free
// the returned stream to avoid memory leak
func NewKeywordStreamWithKeywords(spotter *KeywordSpotter, keywords string) *OnlineStream {
stream := &OnlineStream{}
s := C.CString(keywords)
defer C.free(unsafe.Pointer(s))
stream.impl = C.SherpaOnnxCreateKeywordStreamWithKeywords(spotter.impl, s)
return stream
}
// Check whether the stream has enough feature frames for decoding.
// Return true if this stream is ready for decoding. Return false otherwise.
//
// You will usually use it like below:
//
// for spotter.IsReady(s) {
// spotter.Decode(s)
// }
func (spotter *KeywordSpotter) IsReady(s *OnlineStream) bool {
return C.SherpaOnnxIsKeywordStreamReady(spotter.impl, s.impl) == 1
}
// Decode the stream. Before calling this function, you have to ensure
// that spotter.IsReady(s) returns true. Otherwise, you will be SAD.
//
// You usually use it like below:
//
// for spotter.IsReady(s) {
// spotter.Decode(s)
// }
func (spotter *KeywordSpotter) Decode(s *OnlineStream) {
C.SherpaOnnxDecodeKeywordStream(spotter.impl, s.impl)
}
// You MUST call it right after detecting a keyword
func (spotter *KeywordSpotter) Reset(s *OnlineStream) {
C.SherpaOnnxResetKeywordStream(spotter.impl, s.impl)
}
// Get the current result of stream since the last invoke of Reset()
func (spotter *KeywordSpotter) GetResult(s *OnlineStream) *KeywordSpotterResult {
p := C.SherpaOnnxGetKeywordResult(spotter.impl, s.impl)
defer C.SherpaOnnxDestroyKeywordResult(p)
result := &KeywordSpotterResult{}
result.Keyword = C.GoString(p.keyword)
return result
}
// Configuration for the audio tagging.
type OfflineZipformerAudioTaggingModelConfig struct {
Model string
}
type AudioTaggingModelConfig struct {
Zipformer OfflineZipformerAudioTaggingModelConfig
Ced string
NumThreads int32
Debug int32
Provider string
}
type AudioTaggingConfig struct {
Model AudioTaggingModelConfig
Labels string
TopK int32
}
type AudioTagging struct {
impl *C.struct_SherpaOnnxAudioTagging
}
type AudioEvent struct {
Name string
Index int
Prob float32
}
func DeleteAudioTagging(tagging *AudioTagging) {
C.SherpaOnnxDestroyAudioTagging(tagging.impl)
tagging.impl = nil
}
// The user is responsible to invoke [DeleteAudioTagging]() to free
// the returned tagger to avoid memory leak
func NewAudioTagging(config *AudioTaggingConfig) *AudioTagging {
c := C.struct_SherpaOnnxAudioTaggingConfig{}
c.model.zipformer.model = C.CString(config.Model.Zipformer.Model)
defer C.free(unsafe.Pointer(c.model.zipformer.model))
c.model.ced = C.CString(config.Model.Ced)
defer C.free(unsafe.Pointer(c.model.ced))
c.model.num_threads = C.int(config.Model.NumThreads)
c.model.provider = C.CString(config.Model.Provider)
defer C.free(unsafe.Pointer(c.model.provider))
c.model.debug = C.int(config.Model.Debug)
c.labels = C.CString(config.Labels)
defer C.free(unsafe.Pointer(c.labels))
c.top_k = C.int(config.TopK)
impl := C.SherpaOnnxCreateAudioTagging(&c)
if impl == nil {
return nil
}
tagging := &AudioTagging{}
tagging.impl = impl
return tagging
}
// The user is responsible to invoke [DeleteOfflineStream]() to free
// the returned stream to avoid memory leak
func NewAudioTaggingStream(tagging *AudioTagging) *OfflineStream {
stream := &OfflineStream{}
stream.impl = C.SherpaOnnxAudioTaggingCreateOfflineStream(tagging.impl)
return stream
}
func (tagging *AudioTagging) Compute(s *OfflineStream, topK int32) []AudioEvent {
r := C.SherpaOnnxAudioTaggingCompute(tagging.impl, s.impl, C.int(topK))
defer C.SherpaOnnxAudioTaggingFreeResults(r)
result := make([]AudioEvent, 0)
p := (*[1 << 25]*C.struct_SherpaOnnxAudioEvent)(unsafe.Pointer(r))
i := 0
for {
if p[i] == nil {
break
}
result = append(result, AudioEvent{
Name: C.GoString(p[i].name),
Index: int(p[i].index),
Prob: float32(p[i].prob),
})
i += 1
}
return result
}
type OfflineSpeechDenoiserGtcrnModelConfig struct {
Model string
}
type OfflineSpeechDenoiserModelConfig struct {
Gtcrn OfflineSpeechDenoiserGtcrnModelConfig
NumThreads int32
Debug int32
Provider string
}
type OfflineSpeechDenoiserConfig struct {
Model OfflineSpeechDenoiserModelConfig
}
type OfflineSpeechDenoiser struct {
impl *C.struct_SherpaOnnxOfflineSpeechDenoiser
}
type DenoisedAudio struct {
// Normalized samples in the range [-1, 1]
Samples []float32
SampleRate int
}
// Free the internal pointer inside the OfflineSpeechDenoiser to avoid memory leak.
func DeleteOfflineSpeechDenoiser(sd *OfflineSpeechDenoiser) {
C.SherpaOnnxDestroyOfflineSpeechDenoiser(sd.impl)
sd.impl = nil
}
// The user is responsible to invoke [DeleteOfflineSpeechDenoiser]() to free
// the returned tts to avoid memory leak
func NewOfflineSpeechDenoiser(config *OfflineSpeechDenoiserConfig) *OfflineSpeechDenoiser {
c := C.struct_SherpaOnnxOfflineSpeechDenoiserConfig{}
c.model.gtcrn.model = C.CString(config.Model.Gtcrn.Model)
defer C.free(unsafe.Pointer(c.model.gtcrn.model))
c.model.num_threads = C.int(config.Model.NumThreads)
c.model.debug = C.int(config.Model.Debug)
c.model.provider = C.CString(config.Model.Provider)
defer C.free(unsafe.Pointer(c.model.provider))
impl := C.SherpaOnnxCreateOfflineSpeechDenoiser(&c)
if impl == nil {
return nil
}
sd := &OfflineSpeechDenoiser{}
sd.impl = impl
return sd
}
func (sd *OfflineSpeechDenoiser) Run(samples []float32, sampleRate int) *DenoisedAudio {
audio := C.SherpaOnnxOfflineSpeechDenoiserRun(sd.impl, (*C.float)(&samples[0]), C.int(len(samples)), C.int(sampleRate))
defer C.SherpaOnnxDestroyDenoisedAudio(audio)
ans := &DenoisedAudio{}
ans.SampleRate = int(audio.sample_rate)
n := int(audio.n)
ans.Samples = make([]float32, n)
denoisedSamples := unsafe.Slice(audio.samples, n)
for i := 0; i < n; i++ {
ans.Samples[i] = float32(denoisedSamples[i])
}
return ans
}
func (audio *DenoisedAudio) Save(filename string) bool {
s := C.CString(filename)
defer C.free(unsafe.Pointer(s))
ok := int(C.SherpaOnnxWriteWave((*C.float)(&audio.Samples[0]), C.int(len(audio.Samples)), C.int(audio.SampleRate), s))
return ok == 1
}
func (sd *OfflineSpeechDenoiser) SampleRate() int {
return int(C.SherpaOnnxOfflineSpeechDenoiserGetSampleRate(sd.impl))
}
func GetVersion() string {
return C.GoString(C.SherpaOnnxGetVersionStr())
}
func GetGitSha1() string {
return C.GoString(C.SherpaOnnxGetGitSha1())
}
func GetGitDate() string {
return C.GoString(C.SherpaOnnxGetGitDate())
}