Home | History | Annotate | Download | only in webrtc 
      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 "talk/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 const char MediaConstraintsInterface::kLeakyBucket[] = "googLeakyBucket";
     70 const char MediaConstraintsInterface::kTemporalLayeredScreencast[] =
     71     "googTemporalLayeredScreencast";
     72 
     73 // Constraint keys for CreateOffer / CreateAnswer defined in W3C specification.
     74 const char MediaConstraintsInterface::kOfferToReceiveAudio[] =
     75     "OfferToReceiveAudio";
     76 const char MediaConstraintsInterface::kOfferToReceiveVideo[] =
     77     "OfferToReceiveVideo";
     78 const char MediaConstraintsInterface::kVoiceActivityDetection[] =
     79     "VoiceActivityDetection";
     80 const char MediaConstraintsInterface::kIceRestart[] =
     81     "IceRestart";
     82 // Google specific constraint for BUNDLE enable/disable.
     83 const char MediaConstraintsInterface::kUseRtpMux[] =
     84     "googUseRtpMUX";
     85 
     86 // Below constraints should be used during PeerConnection construction.
     87 const char MediaConstraintsInterface::kEnableDtlsSrtp[] =
     88     "DtlsSrtpKeyAgreement";
     89 const char MediaConstraintsInterface::kEnableRtpDataChannels[] =
     90     "RtpDataChannels";
     91 // Google-specific constraint keys.
     92 const char MediaConstraintsInterface::kEnableDscp[] = "googDscp";
     93 const char MediaConstraintsInterface::kEnableIPv6[] = "googIPv6";
     94 const char MediaConstraintsInterface::kEnableVideoSuspendBelowMinBitrate[] =
     95     "googSuspendBelowMinBitrate";
     96 const char MediaConstraintsInterface::kImprovedWifiBwe[] =
     97     "googImprovedWifiBwe";
     98 const char MediaConstraintsInterface::kScreencastMinBitrate[] =
     99     "googScreencastMinBitrate";
    100 const char MediaConstraintsInterface::kSkipEncodingUnusedStreams[] =
    101     "googSkipEncodingUnusedStreams";
    102 // TODO(ronghuawu): Remove once cpu overuse detection is stable.
    103 const char MediaConstraintsInterface::kCpuOveruseDetection[] =
    104     "googCpuOveruseDetection";
    105 const char MediaConstraintsInterface::kCpuUnderuseThreshold[] =
    106     "googCpuUnderuseThreshold";
    107 const char MediaConstraintsInterface::kCpuOveruseThreshold[] =
    108     "googCpuOveruseThreshold";
    109 const char MediaConstraintsInterface::kCpuUnderuseEncodeRsdThreshold[] =
    110     "googCpuUnderuseEncodeRsdThreshold";
    111 const char MediaConstraintsInterface::kCpuOveruseEncodeRsdThreshold[] =
    112     "googCpuOveruseEncodeRsdThreshold";
    113 const char MediaConstraintsInterface::kCpuOveruseEncodeUsage[] =
    114     "googCpuOveruseEncodeUsage";
    115 const char MediaConstraintsInterface::kHighStartBitrate[] =
    116     "googHighStartBitrate";
    117 const char MediaConstraintsInterface::kHighBitrate[] =
    118     "googHighBitrate";
    119 const char MediaConstraintsInterface::kVeryHighBitrate[] =
    120     "googVeryHighBitrate";
    121 const char MediaConstraintsInterface::kPayloadPadding[] = "googPayloadPadding";
    122 const char MediaConstraintsInterface::kOpusFec[] = "googOpusFec";
    123 
    124 
    125 // Set |value| to the value associated with the first appearance of |key|, or
    126 // return false if |key| is not found.
    127 bool MediaConstraintsInterface::Constraints::FindFirst(
    128     const std::string& key, std::string* value) const {
    129   for (Constraints::const_iterator iter = begin(); iter != end(); ++iter) {
    130     if (iter->key == key) {
    131       *value = iter->value;
    132       return true;
    133     }
    134   }
    135   return false;
    136 }
    137 
    138 // Find the highest-priority instance of the boolean-valued constraint) named by
    139 // |key| and return its value as |value|. |constraints| can be null.
    140 // If |mandatory_constraints| is non-null, it is incremented if the key appears
    141 // among the mandatory constraints.
    142 // Returns true if the key was found and has a valid boolean value.
    143 // If the key appears multiple times as an optional constraint, appearances
    144 // after the first are ignored.
    145 // Note: Because this uses FindFirst, repeated optional constraints whose
    146 // first instance has an unrecognized value are not handled precisely in
    147 // accordance with the specification.
    148 bool FindConstraint(const MediaConstraintsInterface* constraints,
    149                     const std::string& key, bool* value,
    150                     size_t* mandatory_constraints) {
    151   std::string string_value;
    152   if (!constraints) {
    153     return false;
    154   }
    155   if (constraints->GetMandatory().FindFirst(key, &string_value)) {
    156     if (mandatory_constraints)
    157       ++*mandatory_constraints;
    158     return talk_base::FromString(string_value, value);
    159   }
    160   if (constraints->GetOptional().FindFirst(key, &string_value)) {
    161     return talk_base::FromString(string_value, value);
    162   }
    163   return false;
    164 }
    165 
    166 }  // namespace webrtc
    167