1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/*
* 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 "api/task_queue/task_queue_base.h"
#include "rtc_base/ref_count.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_;
std::unique_ptr<TaskQueueBase, TaskQueueDeleter> task_queue_;
};
} // namespace webrtc
#endif // MODULES_ASYNC_AUDIO_PROCESSING_ASYNC_AUDIO_PROCESSING_H_
|
