content/renderer/media/media_stream_audio_processor_options.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_OPTIONS_H_
   6 #define CONTENT_RENDERER_MEDIA_MEDIA_STREAM_AUDIO_PROCESSOR_OPTIONS_H_
   7
   8 #include <string>
   9
  10 #include "base/files/file.h"
  11 #include "content/common/content_export.h"
  12 #include "third_party/WebKit/public/platform/WebMediaConstraints.h"
  13 #include "third_party/libjingle/source/talk/app/webrtc/mediastreaminterface.h"
  14
  15 namespace webrtc {
  16
  17 class AudioFrame;
  18 class AudioProcessing;
  19 class EchoCancellation;
  20 class MediaConstraintsInterface;
  21 class TypingDetection;
  22
  23 }
  24
  25 namespace content {
  26
  27 class RTCMediaConstraints;
  28
  29 using webrtc::AudioProcessing;
  30 using webrtc::MediaConstraintsInterface;
  31
  32 // A helper class to parse audio constraints from a blink::WebMediaConstraints
  33 // object.
  34 class CONTENT_EXPORT MediaAudioConstraints {
  35  public:
  36   // Constraint keys used by audio processing.
  37   static const char kEchoCancellation[];
  38   static const char kGoogEchoCancellation[];
  39   static const char kGoogExperimentalEchoCancellation[];
  40   static const char kGoogAutoGainControl[];
  41   static const char kGoogExperimentalAutoGainControl[];
  42   static const char kGoogNoiseSuppression[];
  43   static const char kGoogExperimentalNoiseSuppression[];
  44   static const char kGoogBeamforming[];
  45   static const char kGoogHighpassFilter[];
  46   static const char kGoogTypingNoiseDetection[];
  47   static const char kGoogAudioMirroring[];
  48
  49   // Merge |constraints| with |kDefaultAudioConstraints|. For any key which
  50   // exists in both, the value from |constraints| is maintained, including its
  51   // mandatory/optional status. New values from |kDefaultAudioConstraints| will
  52   // be added with optional status.
  53   static void ApplyFixedAudioConstraints(RTCMediaConstraints* constraints);
  54
  55   // |effects| is the bitmasks telling whether certain platform
  56   // hardware audio effects are enabled, like hardware echo cancellation. If
  57   // some hardware effect is enabled, the corresponding software audio
  58   // processing will be disabled.
  59   MediaAudioConstraints(const blink::WebMediaConstraints& constraints,
  60                         int effects);
  61   virtual ~MediaAudioConstraints();
  62
  63   // Gets the property of the constraint named by |key| in |constraints_|.
  64   // Returns the constraint's value if the key is found; Otherwise returns the
  65   // default value of the constraint.
  66   // Note, for constraint of |kEchoCancellation| or |kGoogEchoCancellation|,
  67   // clients should use GetEchoCancellationProperty().
  68   bool GetProperty(const std::string& key);
  69
  70   // Gets the property of echo cancellation defined in |constraints_|. The
  71   // returned value depends on a combination of |effects_|, |kEchoCancellation|
  72   // and |kGoogEchoCancellation| in |constraints_|.
  73   bool GetEchoCancellationProperty();
  74
  75   // Returns true if all the mandatory constraints in |constraints_| are valid;
  76   // Otherwise return false.
  77   bool IsValid();
  78
  79  private:
  80   // Gets the default value of constraint named by |key| in |constraints|.
  81   bool GetDefaultValueForConstraint(
  82       const blink::WebMediaConstraints& constraints, const std::string& key);
  83
  84   const blink::WebMediaConstraints constraints_;
  85   const int effects_;
  86   bool default_audio_processing_constraint_value_;
  87 };
  88
  89 // A helper class to log echo information in general and Echo Cancellation
  90 // quality in particular.
  91 class CONTENT_EXPORT EchoInformation {
  92  public:
  93   EchoInformation();
  94   virtual ~EchoInformation();
  95
  96   void UpdateAecDelayStats(webrtc::EchoCancellation* echo_cancellation);
  97
  98  private:
  99   // Updates UMA histograms with an interval of 5 seconds.
 100   void LogAecDelayStats();
 101
 102   // Counters to be able to aquire a 5 second aggregated metric out of 1 second
 103   // aggregated webrtc::EchoCancellation::GetEchoDelayMetrics() queries.
 104   int num_chunks_;
 105   int num_queries_;
 106   float echo_fraction_poor_delays_;
 107
 108   DISALLOW_COPY_AND_ASSIGN(EchoInformation);
 109 };
 110
 111 // Enables the echo cancellation in |audio_processing|.
 112 void EnableEchoCancellation(AudioProcessing* audio_processing);
 113
 114 // Enables the noise suppression in |audio_processing|.
 115 void EnableNoiseSuppression(AudioProcessing* audio_processing);
 116
 117 // Enables the high pass filter in |audio_processing|.
 118 void EnableHighPassFilter(AudioProcessing* audio_processing);
 119
 120 // Enables the typing detection in |audio_processing|.
 121 void EnableTypingDetection(AudioProcessing* audio_processing,
 122                            webrtc::TypingDetection* typing_detector);
 123
 124 // Starts the echo cancellation dump in |audio_processing|.
 125 void StartEchoCancellationDump(AudioProcessing* audio_processing,
 126                                base::File aec_dump_file);
 127
 128 // Stops the echo cancellation dump in |audio_processing|.
 129 // This method has no impact if echo cancellation dump has not been started on
 130 // |audio_processing|.
 131 void StopEchoCancellationDump(AudioProcessing* audio_processing);
 132
 133 void EnableAutomaticGainControl(AudioProcessing* audio_processing);
 134
 135 void GetAecStats(webrtc::EchoCancellation* echo_cancellation,
 136                  webrtc::AudioProcessorInterface::AudioProcessorStats* stats);
 137
 138 }  // namespace content
 139
 140 #endif  // CONTENT_RENDERER_MEDIA_MEDIA_STREAM_AUDIO_PROCESSOR_OPTIONS_H_