// sherpa-onnx/csrc/offline-tts-vits-impl.h // // Copyright (c) 2023 Xiaomi Corporation #ifndef SHERPA_ONNX_CSRC_OFFLINE_TTS_VITS_IMPL_H_ #define SHERPA_ONNX_CSRC_OFFLINE_TTS_VITS_IMPL_H_ #include #include #include #include #include #include "fst/extensions/far/far.h" #include "kaldifst/csrc/kaldi-fst-io.h" #include "kaldifst/csrc/text-normalizer.h" #include "sherpa-onnx/csrc/jieba-lexicon.h" #include "sherpa-onnx/csrc/lexicon.h" #include "sherpa-onnx/csrc/macros.h" #include "sherpa-onnx/csrc/melo-tts-lexicon.h" #include "sherpa-onnx/csrc/offline-tts-character-frontend.h" #include "sherpa-onnx/csrc/offline-tts-frontend.h" #include "sherpa-onnx/csrc/offline-tts-impl.h" #include "sherpa-onnx/csrc/offline-tts-vits-model.h" #include "sherpa-onnx/csrc/onnx-utils.h" #include "sherpa-onnx/csrc/piper-phonemize-lexicon.h" #include "sherpa-onnx/csrc/text-utils.h" namespace sherpa_onnx { class OfflineTtsVitsImpl : public OfflineTtsImpl { public: explicit OfflineTtsVitsImpl(const OfflineTtsConfig &config) : config_(config), model_(std::make_unique(config.model)) { InitFrontend(); if (!config.rule_fsts.empty()) { std::vector files; SplitStringToVector(config.rule_fsts, ",", false, &files); tn_list_.reserve(files.size()); for (const auto &f : files) { if (config.model.debug) { #if __OHOS__ SHERPA_ONNX_LOGE("rule fst: %{public}s", f.c_str()); #else SHERPA_ONNX_LOGE("rule fst: %s", f.c_str()); #endif } tn_list_.push_back(std::make_unique(f)); } } if (!config.rule_fars.empty()) { if (config.model.debug) { SHERPA_ONNX_LOGE("Loading FST archives"); } std::vector files; SplitStringToVector(config.rule_fars, ",", false, &files); tn_list_.reserve(files.size() + tn_list_.size()); for (const auto &f : files) { if (config.model.debug) { #if __OHOS__ SHERPA_ONNX_LOGE("rule far: %{public}s", f.c_str()); #else SHERPA_ONNX_LOGE("rule far: %s", f.c_str()); #endif } std::unique_ptr> reader( fst::FarReader::Open(f)); for (; !reader->Done(); reader->Next()) { std::unique_ptr r( fst::CastOrConvertToConstFst(reader->GetFst()->Copy())); tn_list_.push_back( std::make_unique(std::move(r))); } } if (config.model.debug) { SHERPA_ONNX_LOGE("FST archives loaded!"); } } } template OfflineTtsVitsImpl(Manager *mgr, const OfflineTtsConfig &config) : config_(config), model_(std::make_unique(mgr, config.model)) { InitFrontend(mgr); if (!config.rule_fsts.empty()) { std::vector files; SplitStringToVector(config.rule_fsts, ",", false, &files); tn_list_.reserve(files.size()); for (const auto &f : files) { if (config.model.debug) { #if __OHOS__ SHERPA_ONNX_LOGE("rule fst: %{public}s", f.c_str()); #else SHERPA_ONNX_LOGE("rule fst: %s", f.c_str()); #endif } auto buf = ReadFile(mgr, f); std::istrstream is(buf.data(), buf.size()); tn_list_.push_back(std::make_unique(is)); } } if (!config.rule_fars.empty()) { std::vector files; SplitStringToVector(config.rule_fars, ",", false, &files); tn_list_.reserve(files.size() + tn_list_.size()); for (const auto &f : files) { if (config.model.debug) { #if __OHOS__ SHERPA_ONNX_LOGE("rule far: %{public}s", f.c_str()); #else SHERPA_ONNX_LOGE("rule far: %s", f.c_str()); #endif } auto buf = ReadFile(mgr, f); std::unique_ptr s( new std::istrstream(buf.data(), buf.size())); std::unique_ptr> reader( fst::FarReader::Open(std::move(s))); for (; !reader->Done(); reader->Next()) { std::unique_ptr r( fst::CastOrConvertToConstFst(reader->GetFst()->Copy())); tn_list_.push_back( std::make_unique(std::move(r))); } // for (; !reader->Done(); reader->Next()) } // for (const auto &f : files) } // if (!config.rule_fars.empty()) } int32_t SampleRate() const override { return model_->GetMetaData().sample_rate; } int32_t NumSpeakers() const override { return model_->GetMetaData().num_speakers; } GeneratedAudio Generate( const std::string &_text, int64_t sid = 0, float speed = 1.0, GeneratedAudioCallback callback = nullptr) const override { const auto &meta_data = model_->GetMetaData(); int32_t num_speakers = meta_data.num_speakers; if (num_speakers == 0 && sid != 0) { #if __OHOS__ SHERPA_ONNX_LOGE( "This is a single-speaker model and supports only sid 0. Given sid: " "%{public}d. sid is ignored", static_cast(sid)); #else SHERPA_ONNX_LOGE( "This is a single-speaker model and supports only sid 0. Given sid: " "%d. sid is ignored", static_cast(sid)); #endif } if (num_speakers != 0 && (sid >= num_speakers || sid < 0)) { #if __OHOS__ SHERPA_ONNX_LOGE( "This model contains only %{public}d speakers. sid should be in the " "range [%{public}d, %{public}d]. Given: %{public}d. Use sid=0", num_speakers, 0, num_speakers - 1, static_cast(sid)); #else SHERPA_ONNX_LOGE( "This model contains only %d speakers. sid should be in the range " "[%d, %d]. Given: %d. Use sid=0", num_speakers, 0, num_speakers - 1, static_cast(sid)); #endif sid = 0; } std::string text = _text; if (config_.model.debug) { #if __OHOS__ SHERPA_ONNX_LOGE("Raw text: %{public}s", text.c_str()); #else SHERPA_ONNX_LOGE("Raw text: %s", text.c_str()); #endif } if (!tn_list_.empty()) { for (const auto &tn : tn_list_) { text = tn->Normalize(text); if (config_.model.debug) { #if __OHOS__ SHERPA_ONNX_LOGE("After normalizing: %{public}s", text.c_str()); #else SHERPA_ONNX_LOGE("After normalizing: %s", text.c_str()); #endif } } } std::vector token_ids = frontend_->ConvertTextToTokenIds(text, meta_data.voice); if (token_ids.empty() || (token_ids.size() == 1 && token_ids[0].tokens.empty())) { SHERPA_ONNX_LOGE("Failed to convert %s to token IDs", text.c_str()); return {}; } std::vector> x; std::vector> tones; x.reserve(token_ids.size()); for (auto &i : token_ids) { x.push_back(std::move(i.tokens)); } if (!token_ids[0].tones.empty()) { tones.reserve(token_ids.size()); for (auto &i : token_ids) { tones.push_back(std::move(i.tones)); } } // TODO(fangjun): add blank inside the frontend, not here if (meta_data.add_blank && config_.model.vits.data_dir.empty() && meta_data.frontend != "characters") { for (auto &k : x) { k = AddBlank(k); } for (auto &k : tones) { k = AddBlank(k); } } int32_t x_size = static_cast(x.size()); if (config_.max_num_sentences <= 0 || x_size <= config_.max_num_sentences) { auto ans = Process(x, tones, sid, speed); if (callback) { callback(ans.samples.data(), ans.samples.size(), 1.0); } return ans; } // the input text is too long, we process sentences within it in batches // to avoid OOM. Batch size is config_.max_num_sentences std::vector> batch_x; std::vector> batch_tones; int32_t batch_size = config_.max_num_sentences; batch_x.reserve(config_.max_num_sentences); batch_tones.reserve(config_.max_num_sentences); int32_t num_batches = x_size / batch_size; if (config_.model.debug) { #if __OHOS__ SHERPA_ONNX_LOGE( "Text is too long. Split it into %{public}d batches. batch size: " "%{public}d. Number of sentences: %{public}d", num_batches, batch_size, x_size); #else SHERPA_ONNX_LOGE( "Text is too long. Split it into %d batches. batch size: %d. Number " "of sentences: %d", num_batches, batch_size, x_size); #endif } GeneratedAudio ans; int32_t should_continue = 1; int32_t k = 0; for (int32_t b = 0; b != num_batches && should_continue; ++b) { batch_x.clear(); batch_tones.clear(); for (int32_t i = 0; i != batch_size; ++i, ++k) { batch_x.push_back(std::move(x[k])); if (!tones.empty()) { batch_tones.push_back(std::move(tones[k])); } } auto audio = Process(batch_x, batch_tones, sid, speed); ans.sample_rate = audio.sample_rate; ans.samples.insert(ans.samples.end(), audio.samples.begin(), audio.samples.end()); if (callback) { should_continue = callback(audio.samples.data(), audio.samples.size(), (b + 1) * 1.0 / num_batches); // Caution(fangjun): audio is freed when the callback returns, so users // should copy the data if they want to access the data after // the callback returns to avoid segmentation fault. } } batch_x.clear(); batch_tones.clear(); while (k < static_cast(x.size()) && should_continue) { batch_x.push_back(std::move(x[k])); if (!tones.empty()) { batch_tones.push_back(std::move(tones[k])); } ++k; } if (!batch_x.empty()) { auto audio = Process(batch_x, batch_tones, sid, speed); ans.sample_rate = audio.sample_rate; ans.samples.insert(ans.samples.end(), audio.samples.begin(), audio.samples.end()); if (callback) { callback(audio.samples.data(), audio.samples.size(), 1.0); // Caution(fangjun): audio is freed when the callback returns, so users // should copy the data if they want to access the data after // the callback returns to avoid segmentation fault. } } return ans; } private: template void InitFrontend(Manager *mgr) { const auto &meta_data = model_->GetMetaData(); if (meta_data.frontend == "characters") { frontend_ = std::make_unique( mgr, config_.model.vits.tokens, meta_data); } else if (meta_data.jieba && !config_.model.vits.dict_dir.empty() && meta_data.is_melo_tts) { frontend_ = std::make_unique( mgr, config_.model.vits.lexicon, config_.model.vits.tokens, config_.model.vits.dict_dir, model_->GetMetaData(), config_.model.debug); } else if (meta_data.jieba && !config_.model.vits.dict_dir.empty()) { frontend_ = std::make_unique( mgr, config_.model.vits.lexicon, config_.model.vits.tokens, config_.model.vits.dict_dir, config_.model.debug); } else if (meta_data.is_melo_tts && meta_data.language == "English") { frontend_ = std::make_unique( mgr, config_.model.vits.lexicon, config_.model.vits.tokens, model_->GetMetaData(), config_.model.debug); } else if ((meta_data.is_piper || meta_data.is_coqui || meta_data.is_icefall) && !config_.model.vits.data_dir.empty()) { frontend_ = std::make_unique( mgr, config_.model.vits.tokens, config_.model.vits.data_dir, meta_data); } else { if (config_.model.vits.lexicon.empty()) { SHERPA_ONNX_LOGE( "Not a model using characters as modeling unit. Please provide " "--vits-lexicon if you leave --vits-data-dir empty"); exit(-1); } frontend_ = std::make_unique( mgr, config_.model.vits.lexicon, config_.model.vits.tokens, meta_data.punctuations, meta_data.language, config_.model.debug); } } void InitFrontend() { const auto &meta_data = model_->GetMetaData(); if (meta_data.jieba && config_.model.vits.dict_dir.empty()) { SHERPA_ONNX_LOGE( "Please provide --vits-dict-dir for Chinese TTS models using jieba"); exit(-1); } if (!meta_data.jieba && !config_.model.vits.dict_dir.empty()) { SHERPA_ONNX_LOGE( "Current model is not using jieba but you provided --vits-dict-dir"); exit(-1); } if (meta_data.frontend == "characters") { frontend_ = std::make_unique( config_.model.vits.tokens, meta_data); } else if (meta_data.jieba && !config_.model.vits.dict_dir.empty() && meta_data.is_melo_tts) { frontend_ = std::make_unique( config_.model.vits.lexicon, config_.model.vits.tokens, config_.model.vits.dict_dir, model_->GetMetaData(), config_.model.debug); } else if (meta_data.is_melo_tts && meta_data.language == "English") { frontend_ = std::make_unique( config_.model.vits.lexicon, config_.model.vits.tokens, model_->GetMetaData(), config_.model.debug); } else if (meta_data.jieba && !config_.model.vits.dict_dir.empty()) { frontend_ = std::make_unique( config_.model.vits.lexicon, config_.model.vits.tokens, config_.model.vits.dict_dir, config_.model.debug); } else if ((meta_data.is_piper || meta_data.is_coqui || meta_data.is_icefall) && !config_.model.vits.data_dir.empty()) { frontend_ = std::make_unique( config_.model.vits.tokens, config_.model.vits.data_dir, model_->GetMetaData()); } else { if (config_.model.vits.lexicon.empty()) { SHERPA_ONNX_LOGE( "Not a model using characters as modeling unit. Please provide " "--vits-lexicon if you leave --vits-data-dir empty"); exit(-1); } frontend_ = std::make_unique( config_.model.vits.lexicon, config_.model.vits.tokens, meta_data.punctuations, meta_data.language, config_.model.debug); } } GeneratedAudio Process(const std::vector> &tokens, const std::vector> &tones, int32_t sid, float speed) const { int32_t num_tokens = 0; for (const auto &k : tokens) { num_tokens += k.size(); } std::vector x; x.reserve(num_tokens); for (const auto &k : tokens) { x.insert(x.end(), k.begin(), k.end()); } std::vector tone_list; if (!tones.empty()) { tone_list.reserve(num_tokens); for (const auto &k : tones) { tone_list.insert(tone_list.end(), k.begin(), k.end()); } } auto memory_info = Ort::MemoryInfo::CreateCpu(OrtDeviceAllocator, OrtMemTypeDefault); std::array x_shape = {1, static_cast(x.size())}; Ort::Value x_tensor = Ort::Value::CreateTensor( memory_info, x.data(), x.size(), x_shape.data(), x_shape.size()); Ort::Value tones_tensor{nullptr}; if (!tones.empty()) { tones_tensor = Ort::Value::CreateTensor(memory_info, tone_list.data(), tone_list.size(), x_shape.data(), x_shape.size()); } Ort::Value audio{nullptr}; if (tones.empty()) { audio = model_->Run(std::move(x_tensor), sid, speed); } else { audio = model_->Run(std::move(x_tensor), std::move(tones_tensor), sid, speed); } std::vector audio_shape = audio.GetTensorTypeAndShapeInfo().GetShape(); int64_t total = 1; // The output shape may be (1, 1, total) or (1, total) or (total,) for (auto i : audio_shape) { total *= i; } const float *p = audio.GetTensorData(); GeneratedAudio ans; ans.sample_rate = model_->GetMetaData().sample_rate; ans.samples = std::vector(p, p + total); return ans; } private: OfflineTtsConfig config_; std::unique_ptr model_; std::vector> tn_list_; std::unique_ptr frontend_; }; } // namespace sherpa_onnx #endif // SHERPA_ONNX_CSRC_OFFLINE_TTS_VITS_IMPL_H_