Skip to content

feat: add punctuation C++ API #2510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csukuangfj merged 6 commits into from
Aug 19, 2025
Merged

feat: add punctuation C++ API #2510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c052ba7
feat: add punctuation C++ API
Aug 19, 2025
4134ab2
fix: use parameter p instead of p_ in Destroy method
Aug 19, 2025
0de3192
how to use punctuation cpp api
Aug 19, 2025
44255d9
remove unused headers
Aug 19, 2025
abb746f
add to CMakeLists.txt and update punctuation example
Aug 19, 2025
9281e48
correct CMakeLists typo
Aug 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cxx-api-examples/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ target_link_libraries(sense-voice-cxx-api sherpa-onnx-cxx-api)
add_executable(nemo-canary-cxx-api ./nemo-canary-cxx-api.cc)
target_link_libraries(nemo-canary-cxx-api sherpa-onnx-cxx-api)

add_executable(punctuation-cxx-api ./punctuation-cxx-api.cc)
target_link_libraries(punctuation-cxx-api sherpa-onnx-cxx-api)

if(SHERPA_ONNX_ENABLE_PORTAUDIO)
add_executable(sense-voice-simulate-streaming-microphone-cxx-api
./sense-voice-simulate-streaming-microphone-cxx-api.cc
Expand Down
35 changes: 35 additions & 0 deletions cxx-api-examples/punctuation-cxx-api.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// cxx-api-examples/punctuation-cxx-api.cc
// Copyright (c) 2025 Xiaomi Corporation

// To use punctuation model:
// wget https://github.com/k2-fsa/sherpa-onnx/releases/download/punctuation-models/sherpa-onnx-punct-ct-transformer-zh-en-vocab272727-2024-04-12.tar.bz2
// tar xvf sherpa-onnx-punct-ct-transformer-zh-en-vocab272727-2024-04-12.tar.bz2
// rm sherpa-onnx-punct-ct-transformer-zh-en-vocab272727-2024-04-12.tar.bz2

#include <iostream>
#include <string>

#include "sherpa-onnx/c-api/cxx-api.h"

int32_t main() {

@coderabbitai coderabbitai Bot Aug 19, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Use standard-conforming int main(); int32_t main() may fail without .

C++ requires main to return int. Using int32_t can be non-portable and requires <cstdint> to be included. Simplest fix: use int.

-int32_t main() {
+int main() {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
int32_t main() {
int main() {
🤖 Prompt for AI Agents 
In cxx-api-examples/punctuation-cxx-api.cc around line 21, the main function is
declared as int32_t main(), which is non-standard and can fail without including
<cstdint>; change the signature to int main() (and adjust any return statements
if necessary, e.g., return 0) so the program uses the standard-conforming return
type and no extra header is required.

using namespace sherpa_onnx::cxx; // NOLINT

OfflinePunctuationConfig punctuation_config;
punctuation_config.model.ct_transformer = "./sherpa-onnx-punct-ct-transformer-zh-en-vocab272727-2024-04-12/model.onnx";
punctuation_config.model.num_threads = 1;
punctuation_config.model.debug = false;
punctuation_config.model.provider = "cpu";

OfflinePunctuation punct = OfflinePunctuation::Create(punctuation_config);
if (!punct.Get()) {
std::cerr << "Failed to create punctuation model. Please check your config\n";
return -1;
}

std::string text = "你好吗how are you Fantasitic 谢谢我很好你怎么样呢";
std::string text_with_punct = punct.AddPunctuation(text);
std::cout << "Original text: " << text << std::endl;
std::cout << "With punctuation: " << text_with_punct << std::endl;

return 0;
}
29 changes: 29 additions & 0 deletions sherpa-onnx/c-api/cxx-api.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -821,4 +821,33 @@ bool FileExists(const std::string &filename) {
return SherpaOnnxFileExists(filename.c_str());
}

// ============================================================
// For Offline Punctuation
// ============================================================
OfflinePunctuation OfflinePunctuation::Create(const OfflinePunctuationConfig &config) {
struct SherpaOnnxOfflinePunctuationConfig c;
memset(&c, 0, sizeof(c));
c.model.ct_transformer = config.model.ct_transformer.c_str();
c.model.num_threads = config.model.num_threads;
c.model.debug = config.model.debug;
c.model.provider = config.model.provider.c_str();

const SherpaOnnxOfflinePunctuation *punct = SherpaOnnxCreateOfflinePunctuation(&c);
return OfflinePunctuation(punct);
}

OfflinePunctuation::OfflinePunctuation(const SherpaOnnxOfflinePunctuation *p)
: MoveOnly<OfflinePunctuation, SherpaOnnxOfflinePunctuation>(p) {}

void OfflinePunctuation::Destroy(const SherpaOnnxOfflinePunctuation *p) const {

Copilot AI Aug 19, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Destroy method ignores the parameter p and uses the member variable p_ instead. This could lead to incorrect cleanup if the parameter doesn't match the instance's pointer. Either use the parameter p or remove it from the method signature.

Suggested change
void OfflinePunctuation::Destroy(const SherpaOnnxOfflinePunctuation *p) const {
void OfflinePunctuation::Destroy() const {

Copilot uses AI. Check for mistakes.
SherpaOnnxDestroyOfflinePunctuation(p);
}

std::string OfflinePunctuation::AddPunctuation(const std::string &text) const {
const char *result = SherpaOfflinePunctuationAddPunct(p_, text.c_str());
std::string ans(result);
SherpaOfflinePunctuationFreeText(result);
return ans;
}

} // namespace sherpa_onnx::cxx
28 changes: 28 additions & 0 deletions sherpa-onnx/c-api/cxx-api.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,34 @@ SHERPA_ONNX_API std::string GetGitSha1();
SHERPA_ONNX_API std::string GetGitDate();
SHERPA_ONNX_API bool FileExists(const std::string &filename);

// ============================================================================
// Offline Punctuation
// ============================================================================
struct OfflinePunctuationModelConfig {
std::string ct_transformer;
int32_t num_threads = 1;
bool debug = false;
std::string provider = "cpu";
};

struct OfflinePunctuationConfig {
OfflinePunctuationModelConfig model;
};

class SHERPA_ONNX_API OfflinePunctuation
: public MoveOnly<OfflinePunctuation, SherpaOnnxOfflinePunctuation> {
public:
static OfflinePunctuation Create(const OfflinePunctuationConfig &config);

void Destroy(const SherpaOnnxOfflinePunctuation *p) const;

// Add punctuations to the input text and return it.
std::string AddPunctuation(const std::string &text) const;

private:
explicit OfflinePunctuation(const SherpaOnnxOfflinePunctuation *p);
};

} // namespace sherpa_onnx::cxx

#endif // SHERPA_ONNX_C_API_CXX_API_H_