libtorch-runtime/post_processor/post_processor.h

// Copyright (c) 2021 Xingchen Song sxc19@mails.tsinghua.edu.cn
//               2023 Jing Du (thuduj12@163.com)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License

#ifndef POST_PROCESSOR_POST_PROCESSOR_H_
#define POST_PROCESSOR_POST_PROCESSOR_H_

#include <memory>
#include <string>
#include <utility>
#include "utils/utils.h"

namespace wenet {

enum LanguageType {
  // spaces between **mandarin words** should be removed.
  // cases of processing spaces with mandarin-only, english-only
  // and mandarin-english code-switch can be found in post_processor_test.cc
  kMandarinEnglish = 0x00,
  // spaces should be kept for most of the
  // Indo-European languages (i.e., deutsch or english-deutsch code-switch).
  // cases of those languages can be found in post_processor_test.cc
  kIndoEuropean = 0x01
};

struct PostProcessOptions {
  // space options
  // The decoded result may contain spaces (' ' or '_'),
  // we will process those spaces according to language_type. More details can
  // be found in
  // https://github.com/wenet-e2e/wenet/issues/583#issuecomment-907994058
  LanguageType language_type = kMandarinEnglish;
  // whether lowercase letters are required
  bool lowercase = true;
  bool itn = false;
};

// TODO(xcsong): add punctuation related resource

// Post Processor
class PostProcessor {
 public:
  explicit PostProcessor(PostProcessOptions&& opts) : opts_(std::move(opts)) {}
  explicit PostProcessor(const PostProcessOptions& opts) : opts_(opts) {}
  // call other functions to do post processing
  std::string Process(const std::string& str, bool finish);
  // process spaces according to configurations
  std::string ProcessSpace(const std::string& str);
  std::string ProcessSymbols(const std::string& str);
  // TODO(xcsong): add punctuation
  // void Punctuate(const std::string& str);

  void InitITNResource(const std::string& tagger_path,
                       const std::string& verbalizer_path);
  private:
    const PostProcessOptions opts_;
  public:
  WENET_DISALLOW_COPY_AND_ASSIGN(PostProcessor);
};

}  // namespace wenet

#endif  // POST_PROCESSOR_POST_PROCESSOR_H_