iamf/cli/obu_sequencer_iamf.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_OBU_SEQUENCER_IAMF_H_
#define CLI_OBU_SEQUENCER_IAMF_H_

#include <cstdint>
#include <fstream>
#include <optional>
#include <string>

#include "absl/status/status.h"
#include "absl/types/span.h"
#include "iamf/cli/obu_sequencer_base.h"
#include "iamf/common/leb_generator.h"
#include "iamf/common/write_bit_buffer.h"

namespace iamf_tools {

/*!\brief OBU sequencer for standalone .iamf files.
 *
 * Used via the abstract `ObuSequencerBase` interface.
 */
class ObuSequencerIamf : public ObuSequencerBase {
 public:
  /*!\brief Constructor.
   * \param iamf_filename Name of the output standalone .iamf file or an empty
   *        string to disable output.
   * \param include_temporal_delimiters Whether the serialized data should
   *        include a temporal delimiter.
   * \param leb_generator Leb generator to use when writing OBUs.
   */
  ObuSequencerIamf(const std::string& iamf_filename,
                   bool include_temporal_delimiters,
                   const LebGenerator& leb_generator);

  ~ObuSequencerIamf() override = default;

 private:
  /*!\brief Pushes the descriptor OBUs to some output.
   *
   * \param common_samples_per_frame Ignored.
   * \param common_sample_rate Ignored.
   * \param common_bit_depth Ignored.
   * \param first_untrimmed_timestamp Ignored.
   * \param num_channels Ignored..
   * \param descriptor_obus Serialized descriptor OBUs to write.
   * \return `absl::OkStatus()` on success. A specific status on failure.
   */
  absl::Status PushSerializedDescriptorObus(
      uint32_t /*common_samples_per_frame*/, uint32_t /*common_sample_rate*/,
      uint8_t /*common_bit_depth*/,
      std::optional<int64_t> /*first_untrimmed_timestamp*/,
      int /*num_channels*/, absl::Span<const uint8_t> descriptor_obus) override;

  /*!\brief Pushes a single temporal unit to some output.
   *
   * \param timestamp Ignored.
   * \param num_samples Ignored.
   * \param temporal_unit Temporal unit to push.
   * \return `absl::OkStatus()` on success. A specific status on failure.
   */
  absl::Status PushSerializedTemporalUnit(
      int64_t /*timestamp*/, int /*num_samples*/,
      absl::Span<const uint8_t> temporal_unit) override;

  /*!\brief Pushes the finalized descriptor OBUs to the IAMF file.
   *
   * \param descriptor_obus Serialized finalized descriptor OBUs to push.
   * \return `absl::OkStatus()` on success. A specific status on failure.
   */
  absl::Status PushFinalizedDescriptorObus(
      absl::Span<const uint8_t> descriptor_obus) override;

  /*!\brief Signals that no more data is coming. */
  void CloseDerived() override;

  /*!\brief Aborts writing the output.
   *
   * Cleans up the output file if it exists.
   */
  void AbortDerived() override;

  const std::string iamf_filename_;
  std::optional<std::fstream> output_iamf_;
  // Reusable write buffer between calls.
  WriteBitBuffer wb_;
};

}  // namespace iamf_tools

#endif  // CLI_OBU_SEQUENCER_H_