mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-13 13:50:40 +01:00
a9bba047b7
Add an API to pass AudioFrameProcessor as a unique_ptr. Bug: webrtc:15111 Change-Id: I4cefa35399c05c6e81c496e0b0387b95809bd8f8 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/301984 Reviewed-by: Olga Sharonova <olka@webrtc.org> Reviewed-by: Markus Handell <handellm@webrtc.org> Reviewed-by: Henrik Andreassson <henrika@webrtc.org> Commit-Queue: Peter Hanspers <peterhanspers@webrtc.org> Cr-Commit-Position: refs/heads/main@{#40187}
109 lines
4.5 KiB
C++
109 lines
4.5 KiB
C++
/*
|
|
* Copyright (c) 2020 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_ASYNC_AUDIO_PROCESSING_ASYNC_AUDIO_PROCESSING_H_
|
|
#define MODULES_ASYNC_AUDIO_PROCESSING_ASYNC_AUDIO_PROCESSING_H_
|
|
|
|
#include <memory>
|
|
|
|
#include "api/audio/audio_frame_processor.h"
|
|
#include "rtc_base/ref_count.h"
|
|
#include "rtc_base/task_queue.h"
|
|
|
|
namespace webrtc {
|
|
|
|
class AudioFrame;
|
|
class TaskQueueFactory;
|
|
|
|
// Helper class taking care of interactions with AudioFrameProcessor
|
|
// in asynchronous manner. Offloads AudioFrameProcessor::Process calls
|
|
// to a dedicated task queue. Makes sure that it's always safe for
|
|
// AudioFrameProcessor to pass processed frames back to its sink.
|
|
class AsyncAudioProcessing final {
|
|
public:
|
|
// Helper class passing AudioFrameProcessor and TaskQueueFactory into
|
|
// AsyncAudioProcessing constructor.
|
|
class Factory : public rtc::RefCountInterface {
|
|
public:
|
|
Factory(const Factory&) = delete;
|
|
Factory& operator=(const Factory&) = delete;
|
|
|
|
~Factory();
|
|
Factory(AudioFrameProcessor& frame_processor,
|
|
TaskQueueFactory& task_queue_factory);
|
|
Factory(std::unique_ptr<AudioFrameProcessor> frame_processor,
|
|
TaskQueueFactory& task_queue_factory);
|
|
|
|
std::unique_ptr<AsyncAudioProcessing> CreateAsyncAudioProcessing(
|
|
AudioFrameProcessor::OnAudioFrameCallback on_frame_processed_callback);
|
|
|
|
private:
|
|
// TODO(bugs.webrtc.org/15111):
|
|
// Remove 'AudioFrameProcessor& frame_processor_' in favour of
|
|
// std::unique_ptr in the follow-up.
|
|
// While transitioning this API from using AudioFrameProcessor& to using
|
|
// std::unique_ptr<AudioFrameProcessor>, we have two member variable both
|
|
// referencing the same object. Throughout the lifetime of the Factory
|
|
// only one of the variables is used, depending on which constructor was
|
|
// called.
|
|
AudioFrameProcessor& frame_processor_;
|
|
std::unique_ptr<AudioFrameProcessor> owned_frame_processor_;
|
|
TaskQueueFactory& task_queue_factory_;
|
|
};
|
|
|
|
AsyncAudioProcessing(const AsyncAudioProcessing&) = delete;
|
|
AsyncAudioProcessing& operator=(const AsyncAudioProcessing&) = delete;
|
|
|
|
~AsyncAudioProcessing();
|
|
|
|
// Creates AsyncAudioProcessing which will pass audio frames to
|
|
// `frame_processor` on `task_queue_` and reply with processed frames passed
|
|
// into `on_frame_processed_callback`, which is posted back onto
|
|
// `task_queue_`. `task_queue_` is created using the provided
|
|
// `task_queue_factory`.
|
|
// TODO(bugs.webrtc.org/15111):
|
|
// Remove this method in favour of the method taking the
|
|
// unique_ptr<AudioFrameProcessor> in the follow-up.
|
|
AsyncAudioProcessing(
|
|
AudioFrameProcessor& frame_processor,
|
|
TaskQueueFactory& task_queue_factory,
|
|
AudioFrameProcessor::OnAudioFrameCallback on_frame_processed_callback);
|
|
|
|
// Creates AsyncAudioProcessing which will pass audio frames to
|
|
// `frame_processor` on `task_queue_` and reply with processed frames passed
|
|
// into `on_frame_processed_callback`, which is posted back onto
|
|
// `task_queue_`. `task_queue_` is created using the provided
|
|
// `task_queue_factory`.
|
|
AsyncAudioProcessing(
|
|
std::unique_ptr<AudioFrameProcessor> frame_processor,
|
|
TaskQueueFactory& task_queue_factory,
|
|
AudioFrameProcessor::OnAudioFrameCallback on_frame_processed_callback);
|
|
|
|
// Accepts `frame` for asynchronous processing. Thread-safe.
|
|
void Process(std::unique_ptr<AudioFrame> frame);
|
|
|
|
private:
|
|
AudioFrameProcessor::OnAudioFrameCallback on_frame_processed_callback_;
|
|
// TODO(bugs.webrtc.org/15111):
|
|
// Remove 'AudioFrameProcessor& frame_processor_' in favour of
|
|
// std::unique_ptr in the follow-up.
|
|
// While transitioning this API from using AudioFrameProcessor& to using
|
|
// std::unique_ptr<AudioFrameProcessor>, we have two member variable both
|
|
// referencing the same object. Throughout the lifetime of the Factory
|
|
// only one of the variables is used, depending on which constructor was
|
|
// called.
|
|
AudioFrameProcessor& frame_processor_;
|
|
std::unique_ptr<AudioFrameProcessor> owned_frame_processor_;
|
|
rtc::TaskQueue task_queue_;
|
|
};
|
|
|
|
} // namespace webrtc
|
|
|
|
#endif // MODULES_ASYNC_AUDIO_PROCESSING_ASYNC_AUDIO_PROCESSING_H_
|