src/third_party/libjingle/source/talk/app/webrtc/mediaconstraintsinterface.cc

   1 /*
   2  * libjingle
   3  * Copyright 2013, Google Inc.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  *  1. Redistributions of source code must retain the above copyright notice,
   9  *     this list of conditions and the following disclaimer.
  10  *  2. Redistributions in binary form must reproduce the above copyright notice,
  11  *     this list of conditions and the following disclaimer in the documentation
  12  *     and/or other materials provided with the distribution.
  13  *  3. The name of the author may not be used to endorse or promote products
  14  *     derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include "talk/app/webrtc/mediaconstraintsinterface.h"
  29
  30 #include "webrtc/base/stringencode.h"
  31
  32 namespace webrtc {
  33
  34 const char MediaConstraintsInterface::kValueTrue[] = "true";
  35 const char MediaConstraintsInterface::kValueFalse[] = "false";
  36
  37 // Constraints declared as static members in mediastreaminterface.h
  38 // Specified by draft-alvestrand-constraints-resolution-00b
  39 const char MediaConstraintsInterface::kMinAspectRatio[] = "minAspectRatio";
  40 const char MediaConstraintsInterface::kMaxAspectRatio[] = "maxAspectRatio";
  41 const char MediaConstraintsInterface::kMaxWidth[] = "maxWidth";
  42 const char MediaConstraintsInterface::kMinWidth[] = "minWidth";
  43 const char MediaConstraintsInterface::kMaxHeight[] = "maxHeight";
  44 const char MediaConstraintsInterface::kMinHeight[] = "minHeight";
  45 const char MediaConstraintsInterface::kMaxFrameRate[] = "maxFrameRate";
  46 const char MediaConstraintsInterface::kMinFrameRate[] = "minFrameRate";
  47
  48 // Audio constraints.
  49 const char MediaConstraintsInterface::kEchoCancellation[] =
  50     "googEchoCancellation";
  51 const char MediaConstraintsInterface::kExperimentalEchoCancellation[] =
  52     "googEchoCancellation2";
  53 const char MediaConstraintsInterface::kAutoGainControl[] =
  54     "googAutoGainControl";
  55 const char MediaConstraintsInterface::kExperimentalAutoGainControl[] =
  56     "googAutoGainControl2";
  57 const char MediaConstraintsInterface::kNoiseSuppression[] =
  58     "googNoiseSuppression";
  59 const char MediaConstraintsInterface::kExperimentalNoiseSuppression[] =
  60     "googNoiseSuppression2";
  61 const char MediaConstraintsInterface::kHighpassFilter[] =
  62     "googHighpassFilter";
  63 const char MediaConstraintsInterface::kTypingNoiseDetection[] =
  64     "googTypingNoiseDetection";
  65 const char MediaConstraintsInterface::kAudioMirroring[] = "googAudioMirroring";
  66
  67 // Google-specific constraint keys for a local video source (getUserMedia).
  68 const char MediaConstraintsInterface::kNoiseReduction[] = "googNoiseReduction";
  69
  70 // Constraint keys for CreateOffer / CreateAnswer defined in W3C specification.
  71 const char MediaConstraintsInterface::kOfferToReceiveAudio[] =
  72     "OfferToReceiveAudio";
  73 const char MediaConstraintsInterface::kOfferToReceiveVideo[] =
  74     "OfferToReceiveVideo";
  75 const char MediaConstraintsInterface::kVoiceActivityDetection[] =
  76     "VoiceActivityDetection";
  77 const char MediaConstraintsInterface::kIceRestart[] =
  78     "IceRestart";
  79 // Google specific constraint for BUNDLE enable/disable.
  80 const char MediaConstraintsInterface::kUseRtpMux[] =
  81     "googUseRtpMUX";
  82
  83 // Below constraints should be used during PeerConnection construction.
  84 const char MediaConstraintsInterface::kEnableDtlsSrtp[] =
  85     "DtlsSrtpKeyAgreement";
  86 const char MediaConstraintsInterface::kEnableRtpDataChannels[] =
  87     "RtpDataChannels";
  88 // Google-specific constraint keys.
  89 const char MediaConstraintsInterface::kEnableDscp[] = "googDscp";
  90 const char MediaConstraintsInterface::kEnableIPv6[] = "googIPv6";
  91 const char MediaConstraintsInterface::kEnableVideoSuspendBelowMinBitrate[] =
  92     "googSuspendBelowMinBitrate";
  93 const char MediaConstraintsInterface::kNumUnsignalledRecvStreams[] =
  94     "googNumUnsignalledRecvStreams";
  95 const char MediaConstraintsInterface::kCombinedAudioVideoBwe[] =
  96     "googCombinedAudioVideoBwe";
  97 const char MediaConstraintsInterface::kScreencastMinBitrate[] =
  98     "googScreencastMinBitrate";
  99 // TODO(ronghuawu): Remove once cpu overuse detection is stable.
 100 const char MediaConstraintsInterface::kCpuOveruseDetection[] =
 101     "googCpuOveruseDetection";
 102 const char MediaConstraintsInterface::kCpuUnderuseThreshold[] =
 103     "googCpuUnderuseThreshold";
 104 const char MediaConstraintsInterface::kCpuOveruseThreshold[] =
 105     "googCpuOveruseThreshold";
 106 const char MediaConstraintsInterface::kCpuUnderuseEncodeRsdThreshold[] =
 107     "googCpuUnderuseEncodeRsdThreshold";
 108 const char MediaConstraintsInterface::kCpuOveruseEncodeRsdThreshold[] =
 109     "googCpuOveruseEncodeRsdThreshold";
 110 const char MediaConstraintsInterface::kCpuOveruseEncodeUsage[] =
 111     "googCpuOveruseEncodeUsage";
 112 const char MediaConstraintsInterface::kHighStartBitrate[] =
 113     "googHighStartBitrate";
 114 const char MediaConstraintsInterface::kHighBitrate[] =
 115     "googHighBitrate";
 116 const char MediaConstraintsInterface::kVeryHighBitrate[] =
 117     "googVeryHighBitrate";
 118 const char MediaConstraintsInterface::kPayloadPadding[] = "googPayloadPadding";
 119
 120
 121 // Set |value| to the value associated with the first appearance of |key|, or
 122 // return false if |key| is not found.
 123 bool MediaConstraintsInterface::Constraints::FindFirst(
 124     const std::string& key, std::string* value) const {
 125   for (Constraints::const_iterator iter = begin(); iter != end(); ++iter) {
 126     if (iter->key == key) {
 127       *value = iter->value;
 128       return true;
 129     }
 130   }
 131   return false;
 132 }
 133
 134 // Find the highest-priority instance of the boolean-valued constraint) named by
 135 // |key| and return its value as |value|. |constraints| can be null.
 136 // If |mandatory_constraints| is non-null, it is incremented if the key appears
 137 // among the mandatory constraints.
 138 // Returns true if the key was found and has a valid boolean value.
 139 // If the key appears multiple times as an optional constraint, appearances
 140 // after the first are ignored.
 141 // Note: Because this uses FindFirst, repeated optional constraints whose
 142 // first instance has an unrecognized value are not handled precisely in
 143 // accordance with the specification.
 144 bool FindConstraint(const MediaConstraintsInterface* constraints,
 145                     const std::string& key, bool* value,
 146                     size_t* mandatory_constraints) {
 147   std::string string_value;
 148   if (!constraints) {
 149     return false;
 150   }
 151   if (constraints->GetMandatory().FindFirst(key, &string_value)) {
 152     if (mandatory_constraints)
 153       ++*mandatory_constraints;
 154     return rtc::FromString(string_value, value);
 155   }
 156   if (constraints->GetOptional().FindFirst(key, &string_value)) {
 157     return rtc::FromString(string_value, value);
 158   }
 159   return false;
 160 }
 161
 162 }  // namespace webrtc