modules/audio_processing/aec_dump/aec_dump_factory.h

/*
 *  Copyright (c) 2017 The WebRTC project authors. All Rights Reserved.
 *
 *  Use of this source code is governed by a BSD-style license
 *  that can be found in the LICENSE file in the root of the source
 *  tree. An additional intellectual property rights grant can be found
 *  in the file PATENTS.  All contributing project authors may
 *  be found in the AUTHORS file in the root of the source tree.
 */

#ifndef MODULES_AUDIO_PROCESSING_AEC_DUMP_AEC_DUMP_FACTORY_H_
#define MODULES_AUDIO_PROCESSING_AEC_DUMP_AEC_DUMP_FACTORY_H_

#include <cstdint>
#include <cstdio>
#include <memory>

#include "absl/base/nullability.h"
#include "absl/strings/string_view.h"
#include "api/task_queue/task_queue_base.h"
#include "modules/audio_processing/include/aec_dump.h"
#include "rtc_base/system/file_wrapper.h"
#include "rtc_base/system/rtc_export.h"

namespace webrtc {

class RTC_EXPORT AecDumpFactory {
 public:
  // The `worker_queue` must outlive the created AecDump instance.
  // `max_log_size_bytes == -1` means the log size will be unlimited.
  // The AecDump takes responsibility for `handle` and closes it in the
  // destructor. A non-null return value indicates that the file has been
  // sucessfully opened.
  static absl_nullable std::unique_ptr<AecDump> Create(
      FileWrapper file,
      int64_t max_log_size_bytes,
      TaskQueueBase* absl_nonnull worker_queue);
  static absl_nullable std::unique_ptr<AecDump> Create(
      absl::string_view file_name,
      int64_t max_log_size_bytes,
      TaskQueueBase* absl_nonnull worker_queue);
  static absl_nullable std::unique_ptr<AecDump> Create(
      FILE* absl_nonnull handle,
      int64_t max_log_size_bytes,
      TaskQueueBase* absl_nonnull worker_queue);
};

}  // namespace webrtc

#endif  // MODULES_AUDIO_PROCESSING_AEC_DUMP_AEC_DUMP_FACTORY_H_