1/*
2 *  Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
3 *
4 *  Use of this source code is governed by a BSD-style license
5 *  that can be found in the LICENSE file in the root of the source
6 *  tree. An additional intellectual property rights grant can be found
7 *  in the file PATENTS.  All contributing project authors may
8 *  be found in the AUTHORS file in the root of the source tree.
9 */
10
11#ifndef WEBRTC_MODULES_AUDIO_PROCESSING_GAIN_CONTROL_IMPL_H_
12#define WEBRTC_MODULES_AUDIO_PROCESSING_GAIN_CONTROL_IMPL_H_
13
14#include <vector>
15
16#include "webrtc/base/criticalsection.h"
17#include "webrtc/base/scoped_ptr.h"
18#include "webrtc/base/thread_annotations.h"
19#include "webrtc/common_audio/swap_queue.h"
20#include "webrtc/modules/audio_processing/include/audio_processing.h"
21#include "webrtc/modules/audio_processing/processing_component.h"
22
23namespace webrtc {
24
25class AudioBuffer;
26
27class GainControlImpl : public GainControl,
28                        public ProcessingComponent {
29 public:
30  GainControlImpl(const AudioProcessing* apm,
31                  rtc::CriticalSection* crit_render,
32                  rtc::CriticalSection* crit_capture);
33  virtual ~GainControlImpl();
34
35  int ProcessRenderAudio(AudioBuffer* audio);
36  int AnalyzeCaptureAudio(AudioBuffer* audio);
37  int ProcessCaptureAudio(AudioBuffer* audio);
38
39  // ProcessingComponent implementation.
40  int Initialize() override;
41
42  // GainControl implementation.
43  bool is_enabled() const override;
44  int stream_analog_level() override;
45  bool is_limiter_enabled() const override;
46  Mode mode() const override;
47
48  // Reads render side data that has been queued on the render call.
49  void ReadQueuedRenderData();
50
51 private:
52  // GainControl implementation.
53  int Enable(bool enable) override;
54  int set_stream_analog_level(int level) override;
55  int set_mode(Mode mode) override;
56  int set_target_level_dbfs(int level) override;
57  int target_level_dbfs() const override;
58  int set_compression_gain_db(int gain) override;
59  int compression_gain_db() const override;
60  int enable_limiter(bool enable) override;
61  int set_analog_level_limits(int minimum, int maximum) override;
62  int analog_level_minimum() const override;
63  int analog_level_maximum() const override;
64  bool stream_is_saturated() const override;
65
66  // ProcessingComponent implementation.
67  void* CreateHandle() const override;
68  int InitializeHandle(void* handle) const override;
69  int ConfigureHandle(void* handle) const override;
70  void DestroyHandle(void* handle) const override;
71  size_t num_handles_required() const override;
72  int GetHandleError(void* handle) const override;
73
74  void AllocateRenderQueue();
75
76  // Not guarded as its public API is thread safe.
77  const AudioProcessing* apm_;
78
79  rtc::CriticalSection* const crit_render_ ACQUIRED_BEFORE(crit_capture_);
80  rtc::CriticalSection* const crit_capture_;
81
82  Mode mode_ GUARDED_BY(crit_capture_);
83  int minimum_capture_level_ GUARDED_BY(crit_capture_);
84  int maximum_capture_level_ GUARDED_BY(crit_capture_);
85  bool limiter_enabled_ GUARDED_BY(crit_capture_);
86  int target_level_dbfs_ GUARDED_BY(crit_capture_);
87  int compression_gain_db_ GUARDED_BY(crit_capture_);
88  std::vector<int> capture_levels_ GUARDED_BY(crit_capture_);
89  int analog_capture_level_ GUARDED_BY(crit_capture_);
90  bool was_analog_level_set_ GUARDED_BY(crit_capture_);
91  bool stream_is_saturated_ GUARDED_BY(crit_capture_);
92
93  size_t render_queue_element_max_size_ GUARDED_BY(crit_render_)
94      GUARDED_BY(crit_capture_);
95  std::vector<int16_t> render_queue_buffer_ GUARDED_BY(crit_render_);
96  std::vector<int16_t> capture_queue_buffer_ GUARDED_BY(crit_capture_);
97
98  // Lock protection not needed.
99  rtc::scoped_ptr<
100      SwapQueue<std::vector<int16_t>, RenderQueueItemVerifier<int16_t>>>
101      render_signal_queue_;
102};
103}  // namespace webrtc
104
105#endif  // WEBRTC_MODULES_AUDIO_PROCESSING_GAIN_CONTROL_IMPL_H_
106