iamf/cli/codec/opus_encoder.h

/*
 * Copyright (c) 2023, Alliance for Open Media. All rights reserved
 *
 * This source code is subject to the terms of the BSD 3-Clause Clear License
 * and the Alliance for Open Media Patent License 1.0. If the BSD 3-Clause Clear
 * License was not distributed with this source code in the LICENSE file, you
 * can obtain it at www.aomedia.org/license/software-license/bsd-3-c-c. If the
 * Alliance for Open Media Patent License 1.0 was not distributed with this
 * source code in the PATENTS file, you can obtain it at
 * www.aomedia.org/license/patent.
 */
#ifndef CLI_OPUS_ENCODER_DECODER_H_
#define CLI_OPUS_ENCODER_DECODER_H_

#include <cstdint>
#include <memory>
#include <vector>

#include "absl/status/status.h"
#include "iamf/cli/audio_frame_with_data.h"
#include "iamf/cli/codec/encoder_base.h"
#include "iamf/cli/proto/codec_config.pb.h"
#include "iamf/obu/codec_config.h"
#include "iamf/obu/decoder_config/opus_decoder_config.h"
#include "include/opus.h"

namespace iamf_tools {

class OpusEncoder : public EncoderBase {
 public:
  OpusEncoder(
      const iamf_tools_cli_proto::OpusEncoderMetadata& opus_encoder_metadata,
      const CodecConfigObu& codec_config, int num_channels, int substream_id)
      : EncoderBase(codec_config, num_channels),
        encoder_metadata_(opus_encoder_metadata),
        decoder_config_(std::get<OpusDecoderConfig>(
            codec_config.GetCodecConfig().decoder_config)),
        substream_id_(substream_id) {}

  ~OpusEncoder() override;

 private:
  // The encoder from `libopus` is in the global namespace.
  typedef ::OpusEncoder LibOpusEncoder;

  /*!\brief Initializes the underlying encoder.
   *
   * \return `absl::OkStatus()` on success. A specific status on failure.
   */
  absl::Status InitializeEncoder() override;

  /*!\brief Initializes `required_samples_to_delay_at_start_`.
   *
   * `InitializeEncoder` is required to be called before calling this function.
   * This value may vary based on `encoder_metadata_`, num_channels_` or
   * settings in the associated Codec Config OBU.
   *
   * \param validate_codec_delay If true, validates `pre_skip` agrees with the
   *        encoder.
   * \return `absl::OkStatus()` on success. A specific status on failure.
   */
  absl::Status SetNumberOfSamplesToDelayAtStart(
      bool validate_codec_delay) override;

  /*!\brief Encodes an audio frame.
   *
   * \param input_bit_depth Ignored.
   * \param samples Samples arranged in (channel, time) axes. The samples are
   *        left-justified and stored in the upper `input_bit_depth` bits.
   * \param partial_audio_frame_with_data Unique pointer to take ownership of.
   *        The underlying `audio_frame_` is modified. All other fields are
   *        blindly passed along.
   * \return `absl::OkStatus()` on success. A specific status on failure.
   */
  absl::Status EncodeAudioFrame(
      int /*input_bit_depth*/, const std::vector<std::vector<int32_t>>& samples,
      std::unique_ptr<AudioFrameWithData> partial_audio_frame_with_data)
      override;

  /*!\brief Validates the underlying encoder.
   *
   * Configures the encoder based on the `encoder_metadata_`, the associated
   * Codec Config OBU, and IAMF requirements.
   *
   * \return `absl::OkStatus()` on success. A specific status on failure.
   */
  absl::Status ValidateEncoderInfo();

  const iamf_tools_cli_proto::OpusEncoderMetadata encoder_metadata_;
  const OpusDecoderConfig decoder_config_;
  const int substream_id_;

  LibOpusEncoder* encoder_ = nullptr;
};

}  // namespace iamf_tools

#endif  // CLI_OPUS_ENCODER_DECODER_H_