blob: edb9962d75cccb27bb40f5cfbb8272e07350c402 [file] [log] [blame]
niklase@google.com470e71d2011-07-07 08:21:25 +00001/*
andrew@webrtc.org648af742012-02-08 01:57:29 +00002 * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
niklase@google.com470e71d2011-07-07 08:21:25 +00003 *
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
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +000011#ifndef WEBRTC_MODULES_AUDIO_PROCESSING_INCLUDE_AUDIO_PROCESSING_H_
12#define WEBRTC_MODULES_AUDIO_PROCESSING_INCLUDE_AUDIO_PROCESSING_H_
niklase@google.com470e71d2011-07-07 08:21:25 +000013
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +000014#include <stddef.h> // size_t
henrikg@webrtc.org863b5362013-12-06 16:05:17 +000015#include <stdio.h> // FILE
ajm@google.com22e65152011-07-18 18:03:01 +000016
andrew@webrtc.org61e596f2013-07-25 18:28:29 +000017#include "webrtc/common.h"
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +000018#include "webrtc/modules/interface/module.h"
19#include "webrtc/typedefs.h"
niklase@google.com470e71d2011-07-07 08:21:25 +000020
bjornv@webrtc.org91d11b32013-03-05 16:53:09 +000021struct AecCore;
22
niklase@google.com470e71d2011-07-07 08:21:25 +000023namespace webrtc {
24
25class AudioFrame;
26class EchoCancellation;
27class EchoControlMobile;
28class GainControl;
29class HighPassFilter;
30class LevelEstimator;
31class NoiseSuppression;
32class VoiceDetection;
33
andrew@webrtc.org6b1e2192013-09-25 23:46:20 +000034// Use to enable the delay correction feature. This now engages an extended
35// filter mode in the AEC, along with robustness measures around the reported
36// system delays. It comes with a significant increase in AEC complexity, but is
37// much more robust to unreliable reported delays.
38//
39// Detailed changes to the algorithm:
40// - The filter length is changed from 48 to 128 ms. This comes with tuning of
41// several parameters: i) filter adaptation stepsize and error threshold;
42// ii) non-linear processing smoothing and overdrive.
43// - Option to ignore the reported delays on platforms which we deem
44// sufficiently unreliable. See WEBRTC_UNTRUSTED_DELAY in echo_cancellation.c.
45// - Faster startup times by removing the excessive "startup phase" processing
46// of reported delays.
47// - Much more conservative adjustments to the far-end read pointer. We smooth
48// the delay difference more heavily, and back off from the difference more.
49// Adjustments force a readaptation of the filter, so they should be avoided
50// except when really necessary.
51struct DelayCorrection {
52 DelayCorrection() : enabled(false) {}
53 DelayCorrection(bool enabled) : enabled(enabled) {}
54
55 bool enabled;
56};
57
niklase@google.com470e71d2011-07-07 08:21:25 +000058// The Audio Processing Module (APM) provides a collection of voice processing
59// components designed for real-time communications software.
60//
61// APM operates on two audio streams on a frame-by-frame basis. Frames of the
62// primary stream, on which all processing is applied, are passed to
63// |ProcessStream()|. Frames of the reverse direction stream, which are used for
64// analysis by some components, are passed to |AnalyzeReverseStream()|. On the
65// client-side, this will typically be the near-end (capture) and far-end
66// (render) streams, respectively. APM should be placed in the signal chain as
67// close to the audio hardware abstraction layer (HAL) as possible.
68//
69// On the server-side, the reverse stream will normally not be used, with
70// processing occurring on each incoming stream.
71//
72// Component interfaces follow a similar pattern and are accessed through
73// corresponding getters in APM. All components are disabled at create-time,
74// with default settings that are recommended for most situations. New settings
75// can be applied without enabling a component. Enabling a component triggers
76// memory allocation and initialization to allow it to start processing the
77// streams.
78//
79// Thread safety is provided with the following assumptions to reduce locking
80// overhead:
81// 1. The stream getters and setters are called from the same thread as
82// ProcessStream(). More precisely, stream functions are never called
83// concurrently with ProcessStream().
84// 2. Parameter getters are never called concurrently with the corresponding
85// setter.
86//
87// APM accepts only 16-bit linear PCM audio data in frames of 10 ms. Multiple
88// channels should be interleaved.
89//
90// Usage example, omitting error checking:
91// AudioProcessing* apm = AudioProcessing::Create(0);
niklase@google.com470e71d2011-07-07 08:21:25 +000092//
93// apm->high_pass_filter()->Enable(true);
94//
95// apm->echo_cancellation()->enable_drift_compensation(false);
96// apm->echo_cancellation()->Enable(true);
97//
98// apm->noise_reduction()->set_level(kHighSuppression);
99// apm->noise_reduction()->Enable(true);
100//
101// apm->gain_control()->set_analog_level_limits(0, 255);
102// apm->gain_control()->set_mode(kAdaptiveAnalog);
103// apm->gain_control()->Enable(true);
104//
105// apm->voice_detection()->Enable(true);
106//
107// // Start a voice call...
108//
109// // ... Render frame arrives bound for the audio HAL ...
110// apm->AnalyzeReverseStream(render_frame);
111//
112// // ... Capture frame arrives from the audio HAL ...
113// // Call required set_stream_ functions.
114// apm->set_stream_delay_ms(delay_ms);
115// apm->gain_control()->set_stream_analog_level(analog_level);
116//
117// apm->ProcessStream(capture_frame);
118//
119// // Call required stream_ functions.
120// analog_level = apm->gain_control()->stream_analog_level();
121// has_voice = apm->stream_has_voice();
122//
123// // Repeate render and capture processing for the duration of the call...
124// // Start a new call...
125// apm->Initialize();
126//
127// // Close the application...
andrew@webrtc.orgf3930e92013-09-18 22:37:32 +0000128// delete apm;
niklase@google.com470e71d2011-07-07 08:21:25 +0000129//
130class AudioProcessing : public Module {
131 public:
132 // Creates a APM instance, with identifier |id|. Use one instance for every
133 // primary audio stream requiring processing. On the client-side, this would
134 // typically be one instance for the near-end stream, and additional instances
135 // for each far-end stream which requires processing. On the server-side,
136 // this would typically be one instance for every incoming stream.
andrew@webrtc.orge84978f2014-01-25 02:09:06 +0000137 static AudioProcessing* Create();
138 static AudioProcessing* Create(const Config& config);
139 // TODO(ajm): Deprecated; remove all calls to it.
niklase@google.com470e71d2011-07-07 08:21:25 +0000140 static AudioProcessing* Create(int id);
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +0000141 virtual ~AudioProcessing() {}
niklase@google.com470e71d2011-07-07 08:21:25 +0000142
niklase@google.com470e71d2011-07-07 08:21:25 +0000143 // Initializes internal states, while retaining all user settings. This
144 // should be called before beginning to process a new audio stream. However,
145 // it is not necessary to call before processing the first stream after
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000146 // creation. It is also not necessary to call if the audio parameters (sample
147 // rate and number of channels) have changed. Passing updated parameters
148 // directly to |ProcessStream()| and |AnalyzeReverseStream()| is permissible.
niklase@google.com470e71d2011-07-07 08:21:25 +0000149 virtual int Initialize() = 0;
150
andrew@webrtc.org61e596f2013-07-25 18:28:29 +0000151 // Pass down additional options which don't have explicit setters. This
152 // ensures the options are applied immediately.
153 virtual void SetExtraOptions(const Config& config) = 0;
154
aluebs@webrtc.org0b72f582013-11-19 15:17:51 +0000155 virtual int EnableExperimentalNs(bool enable) = 0;
156 virtual bool experimental_ns_enabled() const = 0;
157
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000158 // DEPRECATED: It is now possible to modify the sample rate directly in a call
159 // to |ProcessStream|.
niklase@google.com470e71d2011-07-07 08:21:25 +0000160 // Sets the sample |rate| in Hz for both the primary and reverse audio
161 // streams. 8000, 16000 or 32000 Hz are permitted.
162 virtual int set_sample_rate_hz(int rate) = 0;
163 virtual int sample_rate_hz() const = 0;
164
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000165 // DEPRECATED: It is now possible to modify the number of channels directly in
166 // a call to |ProcessStream|.
niklase@google.com470e71d2011-07-07 08:21:25 +0000167 // Sets the number of channels for the primary audio stream. Input frames must
168 // contain a number of channels given by |input_channels|, while output frames
169 // will be returned with number of channels given by |output_channels|.
170 virtual int set_num_channels(int input_channels, int output_channels) = 0;
171 virtual int num_input_channels() const = 0;
172 virtual int num_output_channels() const = 0;
173
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000174 // DEPRECATED: It is now possible to modify the number of channels directly in
175 // a call to |AnalyzeReverseStream|.
niklase@google.com470e71d2011-07-07 08:21:25 +0000176 // Sets the number of channels for the reverse audio stream. Input frames must
177 // contain a number of channels given by |channels|.
178 virtual int set_num_reverse_channels(int channels) = 0;
179 virtual int num_reverse_channels() const = 0;
180
181 // Processes a 10 ms |frame| of the primary audio stream. On the client-side,
182 // this is the near-end (or captured) audio.
183 //
184 // If needed for enabled functionality, any function with the set_stream_ tag
185 // must be called prior to processing the current frame. Any getter function
186 // with the stream_ tag which is needed should be called after processing.
187 //
andrew@webrtc.org63a50982012-05-02 23:56:37 +0000188 // The |sample_rate_hz_|, |num_channels_|, and |samples_per_channel_|
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000189 // members of |frame| must be valid. If changed from the previous call to this
190 // method, it will trigger an initialization.
niklase@google.com470e71d2011-07-07 08:21:25 +0000191 virtual int ProcessStream(AudioFrame* frame) = 0;
192
193 // Analyzes a 10 ms |frame| of the reverse direction audio stream. The frame
194 // will not be modified. On the client-side, this is the far-end (or to be
195 // rendered) audio.
196 //
197 // It is only necessary to provide this if echo processing is enabled, as the
198 // reverse stream forms the echo reference signal. It is recommended, but not
199 // necessary, to provide if gain control is enabled. On the server-side this
200 // typically will not be used. If you're not sure what to pass in here,
201 // chances are you don't need to use it.
202 //
andrew@webrtc.org63a50982012-05-02 23:56:37 +0000203 // The |sample_rate_hz_|, |num_channels_|, and |samples_per_channel_|
andrew@webrtc.org60730cf2014-01-07 17:45:09 +0000204 // members of |frame| must be valid. |sample_rate_hz_| must correspond to
205 // |sample_rate_hz()|
niklase@google.com470e71d2011-07-07 08:21:25 +0000206 //
207 // TODO(ajm): add const to input; requires an implementation fix.
208 virtual int AnalyzeReverseStream(AudioFrame* frame) = 0;
209
210 // This must be called if and only if echo processing is enabled.
211 //
212 // Sets the |delay| in ms between AnalyzeReverseStream() receiving a far-end
213 // frame and ProcessStream() receiving a near-end frame containing the
214 // corresponding echo. On the client-side this can be expressed as
215 // delay = (t_render - t_analyze) + (t_process - t_capture)
216 // where,
217 // - t_analyze is the time a frame is passed to AnalyzeReverseStream() and
218 // t_render is the time the first sample of the same frame is rendered by
219 // the audio hardware.
220 // - t_capture is the time the first sample of a frame is captured by the
221 // audio hardware and t_pull is the time the same frame is passed to
222 // ProcessStream().
223 virtual int set_stream_delay_ms(int delay) = 0;
224 virtual int stream_delay_ms() const = 0;
225
andrew@webrtc.org6f9f8172012-03-06 19:03:39 +0000226 // Sets a delay |offset| in ms to add to the values passed in through
227 // set_stream_delay_ms(). May be positive or negative.
228 //
229 // Note that this could cause an otherwise valid value passed to
230 // set_stream_delay_ms() to return an error.
231 virtual void set_delay_offset_ms(int offset) = 0;
232 virtual int delay_offset_ms() const = 0;
233
niklase@google.com470e71d2011-07-07 08:21:25 +0000234 // Starts recording debugging information to a file specified by |filename|,
235 // a NULL-terminated string. If there is an ongoing recording, the old file
236 // will be closed, and recording will continue in the newly specified file.
237 // An already existing file will be overwritten without warning.
andrew@webrtc.org5ae19de2011-12-13 22:59:33 +0000238 static const size_t kMaxFilenameSize = 1024;
niklase@google.com470e71d2011-07-07 08:21:25 +0000239 virtual int StartDebugRecording(const char filename[kMaxFilenameSize]) = 0;
240
henrikg@webrtc.org863b5362013-12-06 16:05:17 +0000241 // Same as above but uses an existing file handle. Takes ownership
242 // of |handle| and closes it at StopDebugRecording().
243 virtual int StartDebugRecording(FILE* handle) = 0;
244
niklase@google.com470e71d2011-07-07 08:21:25 +0000245 // Stops recording debugging information, and closes the file. Recording
246 // cannot be resumed in the same file (without overwriting it).
247 virtual int StopDebugRecording() = 0;
248
249 // These provide access to the component interfaces and should never return
250 // NULL. The pointers will be valid for the lifetime of the APM instance.
251 // The memory for these objects is entirely managed internally.
252 virtual EchoCancellation* echo_cancellation() const = 0;
253 virtual EchoControlMobile* echo_control_mobile() const = 0;
254 virtual GainControl* gain_control() const = 0;
255 virtual HighPassFilter* high_pass_filter() const = 0;
256 virtual LevelEstimator* level_estimator() const = 0;
257 virtual NoiseSuppression* noise_suppression() const = 0;
258 virtual VoiceDetection* voice_detection() const = 0;
259
260 struct Statistic {
261 int instant; // Instantaneous value.
262 int average; // Long-term average.
263 int maximum; // Long-term maximum.
264 int minimum; // Long-term minimum.
265 };
266
andrew@webrtc.org648af742012-02-08 01:57:29 +0000267 enum Error {
268 // Fatal errors.
niklase@google.com470e71d2011-07-07 08:21:25 +0000269 kNoError = 0,
270 kUnspecifiedError = -1,
271 kCreationFailedError = -2,
272 kUnsupportedComponentError = -3,
273 kUnsupportedFunctionError = -4,
274 kNullPointerError = -5,
275 kBadParameterError = -6,
276 kBadSampleRateError = -7,
277 kBadDataLengthError = -8,
278 kBadNumberChannelsError = -9,
279 kFileError = -10,
280 kStreamParameterNotSetError = -11,
andrew@webrtc.org648af742012-02-08 01:57:29 +0000281 kNotEnabledError = -12,
niklase@google.com470e71d2011-07-07 08:21:25 +0000282
andrew@webrtc.org648af742012-02-08 01:57:29 +0000283 // Warnings are non-fatal.
niklase@google.com470e71d2011-07-07 08:21:25 +0000284 // This results when a set_stream_ parameter is out of range. Processing
285 // will continue, but the parameter may have been truncated.
andrew@webrtc.org648af742012-02-08 01:57:29 +0000286 kBadStreamParameterWarning = -13
niklase@google.com470e71d2011-07-07 08:21:25 +0000287 };
288
289 // Inherited from Module.
pbos@webrtc.org91620802013-08-02 11:44:11 +0000290 virtual int32_t TimeUntilNextProcess() OVERRIDE;
291 virtual int32_t Process() OVERRIDE;
niklase@google.com470e71d2011-07-07 08:21:25 +0000292};
293
294// The acoustic echo cancellation (AEC) component provides better performance
295// than AECM but also requires more processing power and is dependent on delay
296// stability and reporting accuracy. As such it is well-suited and recommended
297// for PC and IP phone applications.
298//
299// Not recommended to be enabled on the server-side.
300class EchoCancellation {
301 public:
302 // EchoCancellation and EchoControlMobile may not be enabled simultaneously.
303 // Enabling one will disable the other.
304 virtual int Enable(bool enable) = 0;
305 virtual bool is_enabled() const = 0;
306
307 // Differences in clock speed on the primary and reverse streams can impact
308 // the AEC performance. On the client-side, this could be seen when different
309 // render and capture devices are used, particularly with webcams.
310 //
311 // This enables a compensation mechanism, and requires that
312 // |set_device_sample_rate_hz()| and |set_stream_drift_samples()| be called.
313 virtual int enable_drift_compensation(bool enable) = 0;
314 virtual bool is_drift_compensation_enabled() const = 0;
315
316 // Provides the sampling rate of the audio devices. It is assumed the render
317 // and capture devices use the same nominal sample rate. Required if and only
318 // if drift compensation is enabled.
319 virtual int set_device_sample_rate_hz(int rate) = 0;
320 virtual int device_sample_rate_hz() const = 0;
321
322 // Sets the difference between the number of samples rendered and captured by
323 // the audio devices since the last call to |ProcessStream()|. Must be called
andrew@webrtc.org6be1e932013-03-01 18:47:28 +0000324 // if drift compensation is enabled, prior to |ProcessStream()|.
325 virtual void set_stream_drift_samples(int drift) = 0;
niklase@google.com470e71d2011-07-07 08:21:25 +0000326 virtual int stream_drift_samples() const = 0;
327
328 enum SuppressionLevel {
329 kLowSuppression,
330 kModerateSuppression,
331 kHighSuppression
332 };
333
334 // Sets the aggressiveness of the suppressor. A higher level trades off
335 // double-talk performance for increased echo suppression.
336 virtual int set_suppression_level(SuppressionLevel level) = 0;
337 virtual SuppressionLevel suppression_level() const = 0;
338
339 // Returns false if the current frame almost certainly contains no echo
340 // and true if it _might_ contain echo.
341 virtual bool stream_has_echo() const = 0;
342
343 // Enables the computation of various echo metrics. These are obtained
344 // through |GetMetrics()|.
345 virtual int enable_metrics(bool enable) = 0;
346 virtual bool are_metrics_enabled() const = 0;
347
348 // Each statistic is reported in dB.
349 // P_far: Far-end (render) signal power.
350 // P_echo: Near-end (capture) echo signal power.
351 // P_out: Signal power at the output of the AEC.
352 // P_a: Internal signal power at the point before the AEC's non-linear
353 // processor.
354 struct Metrics {
355 // RERL = ERL + ERLE
356 AudioProcessing::Statistic residual_echo_return_loss;
357
358 // ERL = 10log_10(P_far / P_echo)
359 AudioProcessing::Statistic echo_return_loss;
360
361 // ERLE = 10log_10(P_echo / P_out)
362 AudioProcessing::Statistic echo_return_loss_enhancement;
363
364 // (Pre non-linear processing suppression) A_NLP = 10log_10(P_echo / P_a)
365 AudioProcessing::Statistic a_nlp;
366 };
367
368 // TODO(ajm): discuss the metrics update period.
369 virtual int GetMetrics(Metrics* metrics) = 0;
370
bjornv@google.com1ba3dbe2011-10-03 08:18:10 +0000371 // Enables computation and logging of delay values. Statistics are obtained
372 // through |GetDelayMetrics()|.
373 virtual int enable_delay_logging(bool enable) = 0;
374 virtual bool is_delay_logging_enabled() const = 0;
375
376 // The delay metrics consists of the delay |median| and the delay standard
377 // deviation |std|. The values are averaged over the time period since the
378 // last call to |GetDelayMetrics()|.
379 virtual int GetDelayMetrics(int* median, int* std) = 0;
380
bjornv@webrtc.org91d11b32013-03-05 16:53:09 +0000381 // Returns a pointer to the low level AEC component. In case of multiple
382 // channels, the pointer to the first one is returned. A NULL pointer is
383 // returned when the AEC component is disabled or has not been initialized
384 // successfully.
385 virtual struct AecCore* aec_core() const = 0;
386
niklase@google.com470e71d2011-07-07 08:21:25 +0000387 protected:
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +0000388 virtual ~EchoCancellation() {}
niklase@google.com470e71d2011-07-07 08:21:25 +0000389};
390
391// The acoustic echo control for mobile (AECM) component is a low complexity
392// robust option intended for use on mobile devices.
393//
394// Not recommended to be enabled on the server-side.
395class EchoControlMobile {
396 public:
397 // EchoCancellation and EchoControlMobile may not be enabled simultaneously.
398 // Enabling one will disable the other.
399 virtual int Enable(bool enable) = 0;
400 virtual bool is_enabled() const = 0;
401
402 // Recommended settings for particular audio routes. In general, the louder
403 // the echo is expected to be, the higher this value should be set. The
404 // preferred setting may vary from device to device.
405 enum RoutingMode {
406 kQuietEarpieceOrHeadset,
407 kEarpiece,
408 kLoudEarpiece,
409 kSpeakerphone,
410 kLoudSpeakerphone
411 };
412
413 // Sets echo control appropriate for the audio routing |mode| on the device.
414 // It can and should be updated during a call if the audio routing changes.
415 virtual int set_routing_mode(RoutingMode mode) = 0;
416 virtual RoutingMode routing_mode() const = 0;
417
418 // Comfort noise replaces suppressed background noise to maintain a
419 // consistent signal level.
420 virtual int enable_comfort_noise(bool enable) = 0;
421 virtual bool is_comfort_noise_enabled() const = 0;
422
bjornv@google.comc4b939c2011-07-13 08:09:56 +0000423 // A typical use case is to initialize the component with an echo path from a
ajm@google.com22e65152011-07-18 18:03:01 +0000424 // previous call. The echo path is retrieved using |GetEchoPath()|, typically
425 // at the end of a call. The data can then be stored for later use as an
426 // initializer before the next call, using |SetEchoPath()|.
427 //
bjornv@google.comc4b939c2011-07-13 08:09:56 +0000428 // Controlling the echo path this way requires the data |size_bytes| to match
429 // the internal echo path size. This size can be acquired using
430 // |echo_path_size_bytes()|. |SetEchoPath()| causes an entire reset, worth
ajm@google.com22e65152011-07-18 18:03:01 +0000431 // noting if it is to be called during an ongoing call.
432 //
433 // It is possible that version incompatibilities may result in a stored echo
434 // path of the incorrect size. In this case, the stored path should be
435 // discarded.
436 virtual int SetEchoPath(const void* echo_path, size_t size_bytes) = 0;
437 virtual int GetEchoPath(void* echo_path, size_t size_bytes) const = 0;
438
439 // The returned path size is guaranteed not to change for the lifetime of
440 // the application.
441 static size_t echo_path_size_bytes();
bjornv@google.comc4b939c2011-07-13 08:09:56 +0000442
niklase@google.com470e71d2011-07-07 08:21:25 +0000443 protected:
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +0000444 virtual ~EchoControlMobile() {}
niklase@google.com470e71d2011-07-07 08:21:25 +0000445};
446
447// The automatic gain control (AGC) component brings the signal to an
448// appropriate range. This is done by applying a digital gain directly and, in
449// the analog mode, prescribing an analog gain to be applied at the audio HAL.
450//
451// Recommended to be enabled on the client-side.
452class GainControl {
453 public:
454 virtual int Enable(bool enable) = 0;
455 virtual bool is_enabled() const = 0;
456
457 // When an analog mode is set, this must be called prior to |ProcessStream()|
458 // to pass the current analog level from the audio HAL. Must be within the
459 // range provided to |set_analog_level_limits()|.
460 virtual int set_stream_analog_level(int level) = 0;
461
462 // When an analog mode is set, this should be called after |ProcessStream()|
463 // to obtain the recommended new analog level for the audio HAL. It is the
464 // users responsibility to apply this level.
465 virtual int stream_analog_level() = 0;
466
467 enum Mode {
468 // Adaptive mode intended for use if an analog volume control is available
469 // on the capture device. It will require the user to provide coupling
470 // between the OS mixer controls and AGC through the |stream_analog_level()|
471 // functions.
472 //
473 // It consists of an analog gain prescription for the audio device and a
474 // digital compression stage.
475 kAdaptiveAnalog,
476
477 // Adaptive mode intended for situations in which an analog volume control
478 // is unavailable. It operates in a similar fashion to the adaptive analog
479 // mode, but with scaling instead applied in the digital domain. As with
480 // the analog mode, it additionally uses a digital compression stage.
481 kAdaptiveDigital,
482
483 // Fixed mode which enables only the digital compression stage also used by
484 // the two adaptive modes.
485 //
486 // It is distinguished from the adaptive modes by considering only a
487 // short time-window of the input signal. It applies a fixed gain through
488 // most of the input level range, and compresses (gradually reduces gain
489 // with increasing level) the input signal at higher levels. This mode is
490 // preferred on embedded devices where the capture signal level is
491 // predictable, so that a known gain can be applied.
492 kFixedDigital
493 };
494
495 virtual int set_mode(Mode mode) = 0;
496 virtual Mode mode() const = 0;
497
498 // Sets the target peak |level| (or envelope) of the AGC in dBFs (decibels
499 // from digital full-scale). The convention is to use positive values. For
500 // instance, passing in a value of 3 corresponds to -3 dBFs, or a target
501 // level 3 dB below full-scale. Limited to [0, 31].
502 //
503 // TODO(ajm): use a negative value here instead, if/when VoE will similarly
504 // update its interface.
505 virtual int set_target_level_dbfs(int level) = 0;
506 virtual int target_level_dbfs() const = 0;
507
508 // Sets the maximum |gain| the digital compression stage may apply, in dB. A
509 // higher number corresponds to greater compression, while a value of 0 will
510 // leave the signal uncompressed. Limited to [0, 90].
511 virtual int set_compression_gain_db(int gain) = 0;
512 virtual int compression_gain_db() const = 0;
513
514 // When enabled, the compression stage will hard limit the signal to the
515 // target level. Otherwise, the signal will be compressed but not limited
516 // above the target level.
517 virtual int enable_limiter(bool enable) = 0;
518 virtual bool is_limiter_enabled() const = 0;
519
520 // Sets the |minimum| and |maximum| analog levels of the audio capture device.
521 // Must be set if and only if an analog mode is used. Limited to [0, 65535].
522 virtual int set_analog_level_limits(int minimum,
523 int maximum) = 0;
524 virtual int analog_level_minimum() const = 0;
525 virtual int analog_level_maximum() const = 0;
526
527 // Returns true if the AGC has detected a saturation event (period where the
528 // signal reaches digital full-scale) in the current frame and the analog
529 // level cannot be reduced.
530 //
531 // This could be used as an indicator to reduce or disable analog mic gain at
532 // the audio HAL.
533 virtual bool stream_is_saturated() const = 0;
534
535 protected:
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +0000536 virtual ~GainControl() {}
niklase@google.com470e71d2011-07-07 08:21:25 +0000537};
538
539// A filtering component which removes DC offset and low-frequency noise.
540// Recommended to be enabled on the client-side.
541class HighPassFilter {
542 public:
543 virtual int Enable(bool enable) = 0;
544 virtual bool is_enabled() const = 0;
545
546 protected:
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +0000547 virtual ~HighPassFilter() {}
niklase@google.com470e71d2011-07-07 08:21:25 +0000548};
549
550// An estimation component used to retrieve level metrics.
551class LevelEstimator {
552 public:
553 virtual int Enable(bool enable) = 0;
554 virtual bool is_enabled() const = 0;
555
andrew@webrtc.org755b04a2011-11-15 16:57:56 +0000556 // Returns the root mean square (RMS) level in dBFs (decibels from digital
557 // full-scale), or alternately dBov. It is computed over all primary stream
558 // frames since the last call to RMS(). The returned value is positive but
559 // should be interpreted as negative. It is constrained to [0, 127].
560 //
561 // The computation follows:
562 // http://tools.ietf.org/html/draft-ietf-avtext-client-to-mixer-audio-level-05
563 // with the intent that it can provide the RTP audio level indication.
564 //
565 // Frames passed to ProcessStream() with an |_energy| of zero are considered
566 // to have been muted. The RMS of the frame will be interpreted as -127.
567 virtual int RMS() = 0;
niklase@google.com470e71d2011-07-07 08:21:25 +0000568
569 protected:
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +0000570 virtual ~LevelEstimator() {}
niklase@google.com470e71d2011-07-07 08:21:25 +0000571};
572
573// The noise suppression (NS) component attempts to remove noise while
574// retaining speech. Recommended to be enabled on the client-side.
575//
576// Recommended to be enabled on the client-side.
577class NoiseSuppression {
578 public:
579 virtual int Enable(bool enable) = 0;
580 virtual bool is_enabled() const = 0;
581
582 // Determines the aggressiveness of the suppression. Increasing the level
583 // will reduce the noise level at the expense of a higher speech distortion.
584 enum Level {
585 kLow,
586 kModerate,
587 kHigh,
588 kVeryHigh
589 };
590
591 virtual int set_level(Level level) = 0;
592 virtual Level level() const = 0;
593
bjornv@webrtc.org08329f42012-07-12 21:00:43 +0000594 // Returns the internally computed prior speech probability of current frame
595 // averaged over output channels. This is not supported in fixed point, for
596 // which |kUnsupportedFunctionError| is returned.
597 virtual float speech_probability() const = 0;
598
niklase@google.com470e71d2011-07-07 08:21:25 +0000599 protected:
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +0000600 virtual ~NoiseSuppression() {}
niklase@google.com470e71d2011-07-07 08:21:25 +0000601};
602
603// The voice activity detection (VAD) component analyzes the stream to
604// determine if voice is present. A facility is also provided to pass in an
605// external VAD decision.
andrew@webrtc.orged083d42011-09-19 15:28:51 +0000606//
607// In addition to |stream_has_voice()| the VAD decision is provided through the
andrew@webrtc.org63a50982012-05-02 23:56:37 +0000608// |AudioFrame| passed to |ProcessStream()|. The |vad_activity_| member will be
andrew@webrtc.orged083d42011-09-19 15:28:51 +0000609// modified to reflect the current decision.
niklase@google.com470e71d2011-07-07 08:21:25 +0000610class VoiceDetection {
611 public:
612 virtual int Enable(bool enable) = 0;
613 virtual bool is_enabled() const = 0;
614
615 // Returns true if voice is detected in the current frame. Should be called
616 // after |ProcessStream()|.
617 virtual bool stream_has_voice() const = 0;
618
619 // Some of the APM functionality requires a VAD decision. In the case that
620 // a decision is externally available for the current frame, it can be passed
621 // in here, before |ProcessStream()| is called.
622 //
623 // VoiceDetection does _not_ need to be enabled to use this. If it happens to
624 // be enabled, detection will be skipped for any frame in which an external
625 // VAD decision is provided.
626 virtual int set_stream_has_voice(bool has_voice) = 0;
627
628 // Specifies the likelihood that a frame will be declared to contain voice.
629 // A higher value makes it more likely that speech will not be clipped, at
630 // the expense of more noise being detected as voice.
631 enum Likelihood {
632 kVeryLowLikelihood,
633 kLowLikelihood,
634 kModerateLikelihood,
635 kHighLikelihood
636 };
637
638 virtual int set_likelihood(Likelihood likelihood) = 0;
639 virtual Likelihood likelihood() const = 0;
640
641 // Sets the |size| of the frames in ms on which the VAD will operate. Larger
642 // frames will improve detection accuracy, but reduce the frequency of
643 // updates.
644 //
645 // This does not impact the size of frames passed to |ProcessStream()|.
646 virtual int set_frame_size_ms(int size) = 0;
647 virtual int frame_size_ms() const = 0;
648
649 protected:
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +0000650 virtual ~VoiceDetection() {}
niklase@google.com470e71d2011-07-07 08:21:25 +0000651};
652} // namespace webrtc
653
andrew@webrtc.orgd72b3d62012-11-15 21:46:06 +0000654#endif // WEBRTC_MODULES_AUDIO_PROCESSING_INCLUDE_AUDIO_PROCESSING_H_