xref: /aosp_15_r20/external/webrtc/modules/audio_processing/agc/agc.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1*d9f75844SAndroid Build Coastguard Worker /*
2*d9f75844SAndroid Build Coastguard Worker  *  Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
3*d9f75844SAndroid Build Coastguard Worker  *
4*d9f75844SAndroid Build Coastguard Worker  *  Use of this source code is governed by a BSD-style license
5*d9f75844SAndroid Build Coastguard Worker  *  that can be found in the LICENSE file in the root of the source
6*d9f75844SAndroid Build Coastguard Worker  *  tree. An additional intellectual property rights grant can be found
7*d9f75844SAndroid Build Coastguard Worker  *  in the file PATENTS.  All contributing project authors may
8*d9f75844SAndroid Build Coastguard Worker  *  be found in the AUTHORS file in the root of the source tree.
9*d9f75844SAndroid Build Coastguard Worker  */
10*d9f75844SAndroid Build Coastguard Worker 
11*d9f75844SAndroid Build Coastguard Worker #ifndef MODULES_AUDIO_PROCESSING_AGC_AGC_H_
12*d9f75844SAndroid Build Coastguard Worker #define MODULES_AUDIO_PROCESSING_AGC_AGC_H_
13*d9f75844SAndroid Build Coastguard Worker 
14*d9f75844SAndroid Build Coastguard Worker #include <memory>
15*d9f75844SAndroid Build Coastguard Worker 
16*d9f75844SAndroid Build Coastguard Worker #include "api/array_view.h"
17*d9f75844SAndroid Build Coastguard Worker #include "modules/audio_processing/vad/voice_activity_detector.h"
18*d9f75844SAndroid Build Coastguard Worker 
19*d9f75844SAndroid Build Coastguard Worker namespace webrtc {
20*d9f75844SAndroid Build Coastguard Worker 
21*d9f75844SAndroid Build Coastguard Worker class LoudnessHistogram;
22*d9f75844SAndroid Build Coastguard Worker 
23*d9f75844SAndroid Build Coastguard Worker class Agc {
24*d9f75844SAndroid Build Coastguard Worker  public:
25*d9f75844SAndroid Build Coastguard Worker   Agc();
26*d9f75844SAndroid Build Coastguard Worker   virtual ~Agc();
27*d9f75844SAndroid Build Coastguard Worker 
28*d9f75844SAndroid Build Coastguard Worker   // `audio` must be mono; in a multi-channel stream, provide the first (usually
29*d9f75844SAndroid Build Coastguard Worker   // left) channel.
30*d9f75844SAndroid Build Coastguard Worker   virtual void Process(rtc::ArrayView<const int16_t> audio);
31*d9f75844SAndroid Build Coastguard Worker 
32*d9f75844SAndroid Build Coastguard Worker   // Retrieves the difference between the target RMS level and the current
33*d9f75844SAndroid Build Coastguard Worker   // signal RMS level in dB. Returns true if an update is available and false
34*d9f75844SAndroid Build Coastguard Worker   // otherwise, in which case `error` should be ignored and no action taken.
35*d9f75844SAndroid Build Coastguard Worker   virtual bool GetRmsErrorDb(int* error);
36*d9f75844SAndroid Build Coastguard Worker   virtual void Reset();
37*d9f75844SAndroid Build Coastguard Worker 
38*d9f75844SAndroid Build Coastguard Worker   virtual int set_target_level_dbfs(int level);
39*d9f75844SAndroid Build Coastguard Worker   virtual int target_level_dbfs() const;
40*d9f75844SAndroid Build Coastguard Worker   virtual float voice_probability() const;
41*d9f75844SAndroid Build Coastguard Worker 
42*d9f75844SAndroid Build Coastguard Worker  private:
43*d9f75844SAndroid Build Coastguard Worker   double target_level_loudness_;
44*d9f75844SAndroid Build Coastguard Worker   int target_level_dbfs_;
45*d9f75844SAndroid Build Coastguard Worker   std::unique_ptr<LoudnessHistogram> histogram_;
46*d9f75844SAndroid Build Coastguard Worker   std::unique_ptr<LoudnessHistogram> inactive_histogram_;
47*d9f75844SAndroid Build Coastguard Worker   VoiceActivityDetector vad_;
48*d9f75844SAndroid Build Coastguard Worker };
49*d9f75844SAndroid Build Coastguard Worker 
50*d9f75844SAndroid Build Coastguard Worker }  // namespace webrtc
51*d9f75844SAndroid Build Coastguard Worker 
52*d9f75844SAndroid Build Coastguard Worker #endif  // MODULES_AUDIO_PROCESSING_AGC_AGC_H_
53