src/content/renderer/media/media_stream_audio_processor.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_RENDERER_MEDIA_MEDIA_STREAM_AUDIO_PROCESSOR_H_
   6 #define CONTENT_RENDERER_MEDIA_MEDIA_STREAM_AUDIO_PROCESSOR_H_
   7
   8 #include "base/atomicops.h"
   9 #include "base/platform_file.h"
  10 #include "base/synchronization/lock.h"
  11 #include "base/threading/thread_checker.h"
  12 #include "base/time/time.h"
  13 #include "content/common/content_export.h"
  14 #include "content/public/common/media_stream_request.h"
  15 #include "content/renderer/media/webrtc_audio_device_impl.h"
  16 #include "media/base/audio_converter.h"
  17 #include "third_party/libjingle/source/talk/app/webrtc/mediastreaminterface.h"
  18 #include "third_party/webrtc/modules/audio_processing/include/audio_processing.h"
  19 #include "third_party/webrtc/modules/interface/module_common_types.h"
  20
  21 namespace blink {
  22 class WebMediaConstraints;
  23 }
  24
  25 namespace media {
  26 class AudioBus;
  27 class AudioFifo;
  28 class AudioParameters;
  29 }  // namespace media
  30
  31 namespace webrtc {
  32 class AudioFrame;
  33 class TypingDetection;
  34 }
  35
  36 namespace content {
  37
  38 class RTCMediaConstraints;
  39
  40 using webrtc::AudioProcessorInterface;
  41
  42 // This class owns an object of webrtc::AudioProcessing which contains signal
  43 // processing components like AGC, AEC and NS. It enables the components based
  44 // on the getUserMedia constraints, processes the data and outputs it in a unit
  45 // of 10 ms data chunk.
  46 class CONTENT_EXPORT MediaStreamAudioProcessor :
  47     NON_EXPORTED_BASE(public WebRtcPlayoutDataSource::Sink),
  48     NON_EXPORTED_BASE(public AudioProcessorInterface) {
  49  public:
  50   // |playout_data_source| is used to register this class as a sink to the
  51   // WebRtc playout data for processing AEC. If clients do not enable AEC,
  52   // |playout_data_source| won't be used.
  53   MediaStreamAudioProcessor(const blink::WebMediaConstraints& constraints,
  54                             int effects,
  55                             MediaStreamType type,
  56                             WebRtcPlayoutDataSource* playout_data_source);
  57
  58   // Called when format of the capture data has changed.
  59   // Called on the main render thread.  The caller is responsible for stopping
  60   // the capture thread before calling this method.
  61   // After this method, the capture thread will be changed to a new capture
  62   // thread.
  63   void OnCaptureFormatChanged(const media::AudioParameters& source_params);
  64
  65   // Pushes capture data in |audio_source| to the internal FIFO.
  66   // Called on the capture audio thread.
  67   void PushCaptureData(media::AudioBus* audio_source);
  68
  69   // Processes a block of 10 ms data from the internal FIFO and outputs it via
  70   // |out|. |out| is the address of the pointer that will be pointed to
  71   // the post-processed data if the method is returning a true. The lifetime
  72   // of the data represeted by |out| is guaranteed to outlive the method call.
  73   // That also says *|out| won't change until this method is called again.
  74   // |new_volume| receives the new microphone volume from the AGC.
  75   // The new microphoen volume range is [0, 255], and the value will be 0 if
  76   // the microphone volume should not be adjusted.
  77   // Returns true if the internal FIFO has at least 10 ms data for processing,
  78   // otherwise false.
  79   // |capture_delay|, |volume| and |key_pressed| will be passed to
  80   // webrtc::AudioProcessing to help processing the data.
  81   // Called on the capture audio thread.
  82   bool ProcessAndConsumeData(base::TimeDelta capture_delay,
  83                              int volume,
  84                              bool key_pressed,
  85                              int* new_volume,
  86                              int16** out);
  87
  88   bool IsAudioTrackProcessingEnabled() const;
  89
  90   // The audio format of the input to the processor.
  91   const media::AudioParameters& InputFormat() const;
  92
  93   // The audio format of the output from the processor.
  94   const media::AudioParameters& OutputFormat() const;
  95
  96   // Accessor to check if the audio processing is enabled or not.
  97   bool has_audio_processing() const { return audio_processing_ != NULL; }
  98
  99   // Starts/Stops the Aec dump on the |audio_processing_|.
 100   // Called on the main render thread.
 101   // This method takes the ownership of |aec_dump_file|.
 102   void StartAecDump(const base::PlatformFile& aec_dump_file);
 103   void StopAecDump();
 104
 105  protected:
 106   friend class base::RefCountedThreadSafe<MediaStreamAudioProcessor>;
 107   virtual ~MediaStreamAudioProcessor();
 108
 109  private:
 110   friend class MediaStreamAudioProcessorTest;
 111
 112   class MediaStreamAudioConverter;
 113
 114   // WebRtcPlayoutDataSource::Sink implementation.
 115   virtual void OnPlayoutData(media::AudioBus* audio_bus,
 116                              int sample_rate,
 117                              int audio_delay_milliseconds) OVERRIDE;
 118   virtual void OnPlayoutDataSourceChanged() OVERRIDE;
 119
 120   // webrtc::AudioProcessorInterface implementation.
 121   // This method is called on the libjingle thread.
 122   virtual void GetStats(AudioProcessorStats* stats) OVERRIDE;
 123
 124   // Helper to initialize the WebRtc AudioProcessing.
 125   void InitializeAudioProcessingModule(
 126       const blink::WebMediaConstraints& constraints, int effects,
 127       MediaStreamType type);
 128
 129   // Helper to initialize the capture converter.
 130   void InitializeCaptureConverter(const media::AudioParameters& source_params);
 131
 132   // Helper to initialize the render converter.
 133   void InitializeRenderConverterIfNeeded(int sample_rate,
 134                                          int number_of_channels,
 135                                          int frames_per_buffer);
 136
 137   // Called by ProcessAndConsumeData().
 138   // Returns the new microphone volume in the range of |0, 255].
 139   // When the volume does not need to be updated, it returns 0.
 140   int ProcessData(webrtc::AudioFrame* audio_frame,
 141                   base::TimeDelta capture_delay,
 142                   int volume,
 143                   bool key_pressed);
 144
 145   // Called when the processor is going away.
 146   void StopAudioProcessing();
 147
 148   // Cached value for the render delay latency. This member is accessed by
 149   // both the capture audio thread and the render audio thread.
 150   base::subtle::Atomic32 render_delay_ms_;
 151
 152   // webrtc::AudioProcessing module which does AEC, AGC, NS, HighPass filter,
 153   // ..etc.
 154   scoped_ptr<webrtc::AudioProcessing> audio_processing_;
 155
 156   // Converter used for the down-mixing and resampling of the capture data.
 157   scoped_ptr<MediaStreamAudioConverter> capture_converter_;
 158
 159   // AudioFrame used to hold the output of |capture_converter_|.
 160   webrtc::AudioFrame capture_frame_;
 161
 162   // Converter used for the down-mixing and resampling of the render data when
 163   // the AEC is enabled.
 164   scoped_ptr<MediaStreamAudioConverter> render_converter_;
 165
 166   // AudioFrame used to hold the output of |render_converter_|.
 167   webrtc::AudioFrame render_frame_;
 168
 169   // Data bus to help converting interleaved data to an AudioBus.
 170   scoped_ptr<media::AudioBus> render_data_bus_;
 171
 172   // Raw pointer to the WebRtcPlayoutDataSource, which is valid for the
 173   // lifetime of RenderThread.
 174   WebRtcPlayoutDataSource* const playout_data_source_;
 175
 176   // Used to DCHECK that the destructor is called on the main render thread.
 177   base::ThreadChecker main_thread_checker_;
 178
 179   // Used to DCHECK that some methods are called on the capture audio thread.
 180   base::ThreadChecker capture_thread_checker_;
 181
 182   // Used to DCHECK that PushRenderData() is called on the render audio thread.
 183   base::ThreadChecker render_thread_checker_;
 184
 185   // Flag to enable the stereo channels mirroring.
 186   bool audio_mirroring_;
 187
 188   // Used by the typing detection.
 189   scoped_ptr<webrtc::TypingDetection> typing_detector_;
 190
 191   // This flag is used to show the result of typing detection.
 192   // It can be accessed by the capture audio thread and by the libjingle thread
 193   // which calls GetStats().
 194   base::subtle::Atomic32 typing_detected_;
 195 };
 196
 197 }  // namespace content
 198
 199 #endif  // CONTENT_RENDERER_MEDIA_MEDIA_STREAM_AUDIO_PROCESSOR_H_