iamf/cli/wav_sample_provider.h

/*
 * Copyright (c) 2024, 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_WAV_SAMPLE_PROVIDER_H_
#define CLI_WAV_SAMPLE_PROVIDER_H_

#include <cstdint>
#include <string>
#include <utility>
#include <vector>

#include "absl/container/flat_hash_map.h"
#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "absl/strings/string_view.h"
#include "iamf/cli/audio_element_with_data.h"
#include "iamf/cli/channel_label.h"
#include "iamf/cli/demixing_module.h"
#include "iamf/cli/proto/audio_frame.pb.h"
#include "iamf/cli/wav_reader.h"
#include "iamf/obu/types.h"
#include "src/google/protobuf/repeated_ptr_field.h"

namespace iamf_tools {

class WavSampleProvider {
 public:
  /*!\brief Factory function.
   *
   * \param audio_frame_metadata Input audio frame metadata.
   * \param input_wav_directory Directory containing the input WAV files.
   * \param audio_elements Input Audio Element OBUs with data.
   * \return `absl::OkStatus()` on success. A specific status on failure.
   */
  static absl::StatusOr<WavSampleProvider> Create(
      const ::google::protobuf::RepeatedPtrField<
          iamf_tools_cli_proto::AudioFrameObuMetadata>& audio_frame_metadata,
      absl::string_view input_wav_directory,
      const absl::flat_hash_map<DecodedUleb128, AudioElementWithData>&
          audio_elements);

  /*!\brief Read frames from WAV files corresponding to an Audio Element.
   *
   * \param audio_element_id ID of the Audio Element whose corresponding frames
   *        are to be read from WAV files.
   * \param labeled_samples Output samples organized by their channel labels.
   * \param finished_reading Whether the reading is finished.
   * \return `absl::OkStatus()` on success. A specific status on failure.
   */
  absl::Status ReadFrames(DecodedUleb128 audio_element_id,
                          LabelSamplesMap& labeled_samples,
                          bool& finished_reading);

 private:
  /*!\brief Constructor.
   *
   * Used only by factory function. Moves from all input arguments.
   *
   * \param wav_readers Mapping from Audio Element ID to `WavReader`.
   * \param audio_element_id_to_channel_ids Mapping from Audio Element ID to
   *        channel IDs.
   * \param audio_element_id_to_labels Mapping from Audio Element ID to channel
   *        labels.
   */
  WavSampleProvider(
      absl::flat_hash_map<DecodedUleb128, WavReader>&& wav_readers,
      absl::flat_hash_map<DecodedUleb128, std::vector<uint32_t>>&&
          audio_element_id_to_channel_ids,
      absl::flat_hash_map<DecodedUleb128, std::vector<ChannelLabel::Label>>&&
          audio_element_id_to_labels);

  // Mapping from Audio Element ID to `WavReader`.
  absl::flat_hash_map<DecodedUleb128, WavReader> wav_readers_;

  // Mapping from Audio Element ID to channel IDs.
  const absl::flat_hash_map<DecodedUleb128, std::vector<uint32_t>>
      audio_element_id_to_channel_ids_;

  // Mapping from Audio Element ID to channel labels.
  const absl::flat_hash_map<DecodedUleb128, std::vector<ChannelLabel::Label>>
      audio_element_id_to_labels_;
};

}  // namespace iamf_tools

#endif  // CLI_WAV_SAMPLE_PROVIDER_H_