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 "echoCancellation";
51 const char MediaConstraintsInterface::kGoogEchoCancellation[] =
52 "googEchoCancellation";
53 const char MediaConstraintsInterface::kExtendedFilterEchoCancellation[] =
54 "googEchoCancellation2";
55 const char MediaConstraintsInterface::kDAEchoCancellation[] =
56 "googDAEchoCancellation";
57 const char MediaConstraintsInterface::kAutoGainControl[] =
58 "googAutoGainControl";
59 const char MediaConstraintsInterface::kExperimentalAutoGainControl[] =
60 "googAutoGainControl2";
61 const char MediaConstraintsInterface::kNoiseSuppression[] =
62 "googNoiseSuppression";
63 const char MediaConstraintsInterface::kExperimentalNoiseSuppression[] =
64 "googNoiseSuppression2";
65 const char MediaConstraintsInterface::kHighpassFilter[] =
66 "googHighpassFilter";
67 const char MediaConstraintsInterface::kTypingNoiseDetection[] =
68 "googTypingNoiseDetection";
69 const char MediaConstraintsInterface::kAudioMirroring[] = "googAudioMirroring";
70 const char MediaConstraintsInterface::kAecDump[] = "audioDebugRecording";
71
72 // Google-specific constraint keys for a local video source (getUserMedia).
73 const char MediaConstraintsInterface::kNoiseReduction[] = "googNoiseReduction";
74
75 // Constraint keys for CreateOffer / CreateAnswer defined in W3C specification.
76 const char MediaConstraintsInterface::kOfferToReceiveAudio[] =
77 "OfferToReceiveAudio";
78 const char MediaConstraintsInterface::kOfferToReceiveVideo[] =
79 "OfferToReceiveVideo";
80 const char MediaConstraintsInterface::kVoiceActivityDetection[] =
81 "VoiceActivityDetection";
82 const char MediaConstraintsInterface::kIceRestart[] =
83 "IceRestart";
84 // Google specific constraint for BUNDLE enable/disable.
85 const char MediaConstraintsInterface::kUseRtpMux[] =
86 "googUseRtpMUX";
87
88 // Below constraints should be used during PeerConnection construction.
89 const char MediaConstraintsInterface::kEnableDtlsSrtp[] =
90 "DtlsSrtpKeyAgreement";
91 const char MediaConstraintsInterface::kEnableRtpDataChannels[] =
92 "RtpDataChannels";
93 // Google-specific constraint keys.
94 const char MediaConstraintsInterface::kEnableDscp[] = "googDscp";
95 const char MediaConstraintsInterface::kEnableIPv6[] = "googIPv6";
96 const char MediaConstraintsInterface::kEnableVideoSuspendBelowMinBitrate[] =
97 "googSuspendBelowMinBitrate";
98 const char MediaConstraintsInterface::kNumUnsignalledRecvStreams[] =
99 "googNumUnsignalledRecvStreams";
100 const char MediaConstraintsInterface::kCombinedAudioVideoBwe[] =
101 "googCombinedAudioVideoBwe";
102 const char MediaConstraintsInterface::kScreencastMinBitrate[] =
103 "googScreencastMinBitrate";
104 // TODO(ronghuawu): Remove once cpu overuse detection is stable.
105 const char MediaConstraintsInterface::kCpuOveruseDetection[] =
106 "googCpuOveruseDetection";
107 const char MediaConstraintsInterface::kCpuUnderuseThreshold[] =
108 "googCpuUnderuseThreshold";
109 const char MediaConstraintsInterface::kCpuOveruseThreshold[] =
110 "googCpuOveruseThreshold";
111 const char MediaConstraintsInterface::kCpuUnderuseEncodeRsdThreshold[] =
112 "googCpuUnderuseEncodeRsdThreshold";
113 const char MediaConstraintsInterface::kCpuOveruseEncodeRsdThreshold[] =
114 "googCpuOveruseEncodeRsdThreshold";
115 const char MediaConstraintsInterface::kCpuOveruseEncodeUsage[] =
116 "googCpuOveruseEncodeUsage";
117 const char MediaConstraintsInterface::kHighStartBitrate[] =
118 "googHighStartBitrate";
119 const char MediaConstraintsInterface::kPayloadPadding[] = "googPayloadPadding";
120
121
122 // Set |value| to the value associated with the first appearance of |key|, or
123 // return false if |key| is not found.
FindFirst(const std::string & key,std::string * value) const124 bool MediaConstraintsInterface::Constraints::FindFirst(
125 const std::string& key, std::string* value) const {
126 for (Constraints::const_iterator iter = begin(); iter != end(); ++iter) {
127 if (iter->key == key) {
128 *value = iter->value;
129 return true;
130 }
131 }
132 return false;
133 }
134
135 // Find the highest-priority instance of the boolean-valued constraint) named by
136 // |key| and return its value as |value|. |constraints| can be null.
137 // If |mandatory_constraints| is non-null, it is incremented if the key appears
138 // among the mandatory constraints.
139 // Returns true if the key was found and has a valid boolean value.
140 // If the key appears multiple times as an optional constraint, appearances
141 // after the first are ignored.
142 // Note: Because this uses FindFirst, repeated optional constraints whose
143 // first instance has an unrecognized value are not handled precisely in
144 // accordance with the specification.
FindConstraint(const MediaConstraintsInterface * constraints,const std::string & key,bool * value,size_t * mandatory_constraints)145 bool FindConstraint(const MediaConstraintsInterface* constraints,
146 const std::string& key, bool* value,
147 size_t* mandatory_constraints) {
148 std::string string_value;
149 if (!constraints) {
150 return false;
151 }
152 if (constraints->GetMandatory().FindFirst(key, &string_value)) {
153 if (mandatory_constraints)
154 ++*mandatory_constraints;
155 return rtc::FromString(string_value, value);
156 }
157 if (constraints->GetOptional().FindFirst(key, &string_value)) {
158 return rtc::FromString(string_value, value);
159 }
160 return false;
161 }
162
163 } // namespace webrtc
164