Integrate Intelligibility with APM

webrtc/modules/audio_processing/include/audio_processing.h

 /*
  *  Copyright (c) 2012 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.
  */
 
@@ skipping 104 matching lines @@
 
 // Use to enable 48kHz support in audio processing. Must be provided through the
 // constructor. It will have no impact if used with
 // AudioProcessing::SetExtraOptions().
 struct AudioProcessing48kHzSupport {
   AudioProcessing48kHzSupport() : enabled(true) {}
   explicit AudioProcessing48kHzSupport(bool enabled) : enabled(enabled) {}
   bool enabled;
 };
 
+// Use to enable intelligibility enhancer in audio processing. It can be set
+// in the constructor or using AudioProcessing::SetExtraOptions().

[Andrew MacDonald, 2015/07/21 19:29:22]

Please don't allow it to be set through SetExtraOptions. We want to remove this
method. I realize this won't allow you to enable it through voice engine for
now, but I think that's an acceptable compromise.

[Andrew MacDonald, 2015/07/22 02:09:48]

Ah, my mistake. You can still enable it in voice engine, but it makes it harder
through the crappy voe_cmd_test. Put up a CL here which shows how you could do
it through agc_harness at least:
https://codereview.webrtc.org/1247033006/

[ekm, 2015/07/23 00:26:28]

Got it. Thanks for the pointer. Can also at least enable it in voe_cmd_test at
compile time. On a similar note, what's the status of the Enable method that
several of the apm components provide?

+struct Intelligibility {
+  Intelligibility() : enabled(false) {}
+  explicit Intelligibility(bool enabled) : enabled(enabled) {}
+  bool enabled;
+};
+
 static const int kAudioProcMaxNativeSampleRateHz = 32000;
 
 // The Audio Processing Module (APM) provides a collection of voice processing
 // components designed for real-time communications software.
 //
 // APM operates on two audio streams on a frame-by-frame basis. Frames of the
 // primary stream, on which all processing is applied, are passed to
 // |ProcessStream()|. Frames of the reverse direction stream, which are used for
 // analysis by some components, are passed to |AnalyzeReverseStream()|. On the
 // client-side, this will typically be the near-end (capture) and far-end
@@ skipping 181 matching lines @@
   // members of |frame| must be valid. |sample_rate_hz_| must correspond to
   // |input_sample_rate_hz()|
   //
   // TODO(ajm): add const to input; requires an implementation fix.
   virtual int AnalyzeReverseStream(AudioFrame* frame) = 0;
 
   // Accepts deinterleaved float audio with the range [-1, 1]. Each element
   // of |data| points to a channel buffer, arranged according to |layout|.
   virtual int AnalyzeReverseStream(const float* const* data,
                                    int samples_per_channel,
-                                   int sample_rate_hz,
+                                   int rev_sample_rate_hz,
+                                   ChannelLayout layout) = 0;
+
+  // Same as AnalyzeReverseStream, but may modify |data| if intelligibility
+  // is enabled.
+  virtual int ProcessReverseStream(float* const* data,
+                                   int samples_per_channel,
+                                   int rev_sample_rate_hz,
                                    ChannelLayout layout) = 0;
 
   // This must be called if and only if echo processing is enabled.
   //
   // Sets the |delay| in ms between AnalyzeReverseStream() receiving a far-end
   // frame and ProcessStream() receiving a near-end frame containing the
   // corresponding echo. On the client-side this can be expressed as
   //   delay = (t_render - t_analyze) + (t_process - t_capture)
   // where,
   //   - t_analyze is the time a frame is passed to AnalyzeReverseStream() and
@@ skipping 450 matching lines @@
   // This does not impact the size of frames passed to |ProcessStream()|.
   virtual int set_frame_size_ms(int size) = 0;
   virtual int frame_size_ms() const = 0;
 
  protected:
   virtual ~VoiceDetection() {}
 };
 }  // namespace webrtc
 
 #endif  // WEBRTC_MODULES_AUDIO_PROCESSING_INCLUDE_AUDIO_PROCESSING_H_