[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / platform / mediastream / MediaConstraints.cpp
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer
12  *    in the documentation and/or other materials provided with the
13  *    distribution.
14  * 3. Neither the name of Google Inc. nor the names of its contributors
15  *    may be used to endorse or promote products derived from this
16  *    software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "MediaConstraints.h"
33
34 #if ENABLE(MEDIA_STREAM)
35 #include "RealtimeMediaSourceCenter.h"
36 #include "RealtimeMediaSourceSupportedConstraints.h"
37 #include <wtf/StdLibExtras.h>
38
39 namespace WebCore {
40
41 const String& StringConstraint::find(std::function<bool(const String&)> filter) const
42 {
43     for (auto& constraint : m_exact) {
44         if (filter(constraint))
45             return constraint;
46     }
47
48     for (auto& constraint : m_ideal) {
49         if (filter(constraint))
50             return constraint;
51     }
52     
53     return emptyString();
54 }
55
56 double StringConstraint::fitnessDistance(const String& value) const
57 {
58     // https://w3c.github.io/mediacapture-main/#dfn-applyconstraints
59
60     // 1. If the constraint is not supported by the browser, the fitness distance is 0.
61     if (isEmpty())
62         return 0;
63
64     // 2. If the constraint is required ('min', 'max', or 'exact'), and the settings
65     //    dictionary's value for the constraint does not satisfy the constraint, the
66     //    fitness distance is positive infinity.
67     if (!m_exact.isEmpty() && m_exact.find(value) == notFound)
68         return std::numeric_limits<double>::infinity();
69
70     // 3. If no ideal value is specified, the fitness distance is 0.
71     if (m_exact.isEmpty())
72         return 0;
73
74     // 5. For all string and enum non-required constraints (deviceId, groupId, facingMode,
75     // echoCancellation), the fitness distance is the result of the formula
76     //        (actual == ideal) ? 0 : 1
77     return m_ideal.find(value) != notFound ? 0 : 1;
78 }
79
80 double StringConstraint::fitnessDistance(const Vector<String>& values) const
81 {
82     if (isEmpty())
83         return 0;
84
85     double minimumDistance = std::numeric_limits<double>::infinity();
86     for (auto& value : values)
87         minimumDistance = std::min(minimumDistance, fitnessDistance(value));
88
89     return minimumDistance;
90 }
91
92 void StringConstraint::merge(const MediaConstraint& other)
93 {
94     ASSERT(other.isString());
95     const StringConstraint& typedOther = downcast<StringConstraint>(other);
96
97     if (typedOther.isEmpty())
98         return;
99
100     Vector<String> values;
101     if (typedOther.getExact(values)) {
102         if (m_exact.isEmpty())
103             m_exact = values;
104         else {
105             for (auto& value : values) {
106                 if (m_exact.find(value) == notFound)
107                     m_exact.append(value);
108             }
109         }
110     }
111
112     if (typedOther.getIdeal(values)) {
113         if (m_ideal.isEmpty())
114             m_ideal = values;
115         else {
116             for (auto& value : values) {
117                 if (m_ideal.find(value) == notFound)
118                     m_ideal.append(value);
119             }
120         }
121     }
122 }
123
124 void FlattenedConstraint::set(const MediaConstraint& constraint)
125 {
126     for (auto& variant : m_variants) {
127         if (variant.constraintType() == constraint.constraintType())
128             return;
129     }
130
131     append(constraint);
132 }
133
134 void FlattenedConstraint::merge(const MediaConstraint& constraint)
135 {
136     for (auto& variant : *this) {
137         if (variant.constraintType() != constraint.constraintType())
138             continue;
139
140         switch (variant.dataType()) {
141         case MediaConstraint::DataType::Integer:
142             ASSERT(constraint.isInt());
143             downcast<const IntConstraint>(variant).merge(downcast<const IntConstraint>(constraint));
144             return;
145         case MediaConstraint::DataType::Double:
146             ASSERT(constraint.isDouble());
147             downcast<const DoubleConstraint>(variant).merge(downcast<const DoubleConstraint>(constraint));
148             return;
149         case MediaConstraint::DataType::Boolean:
150             ASSERT(constraint.isBoolean());
151             downcast<const BooleanConstraint>(variant).merge(downcast<const BooleanConstraint>(constraint));
152             return;
153         case MediaConstraint::DataType::String:
154             ASSERT(constraint.isString());
155             downcast<const StringConstraint>(variant).merge(downcast<const StringConstraint>(constraint));
156             return;
157         case MediaConstraint::DataType::None:
158             ASSERT_NOT_REACHED();
159             return;
160         }
161     }
162
163     append(constraint);
164 }
165
166 void FlattenedConstraint::append(const MediaConstraint& constraint)
167 {
168 #ifndef NDEBUG
169     ++m_generation;
170 #endif
171
172     m_variants.append(ConstraintHolder::create(constraint));
173 }
174
175 const MediaConstraint* FlattenedConstraint::find(MediaConstraintType type) const
176 {
177     for (auto& variant : m_variants) {
178         if (variant.constraintType() == type)
179             return &variant.constraint();
180     }
181
182     return nullptr;
183 }
184
185 void MediaTrackConstraintSetMap::forEach(std::function<void(const MediaConstraint&)> callback) const
186 {
187     filter([callback] (const MediaConstraint& constraint) mutable {
188         callback(constraint);
189         return false;
190     });
191 }
192
193 void MediaTrackConstraintSetMap::filter(std::function<bool(const MediaConstraint&)> callback) const
194 {
195     if (m_width && !m_width->isEmpty() && callback(*m_width))
196         return;
197     if (m_height && !m_height->isEmpty() && callback(*m_height))
198         return;
199     if (m_sampleRate && !m_sampleRate->isEmpty() && callback(*m_sampleRate))
200         return;
201     if (m_sampleSize && !m_sampleSize->isEmpty() && callback(*m_sampleSize))
202         return;
203
204     if (m_aspectRatio && !m_aspectRatio->isEmpty() && callback(*m_aspectRatio))
205         return;
206     if (m_frameRate && !m_frameRate->isEmpty() && callback(*m_frameRate))
207         return;
208     if (m_volume && !m_volume->isEmpty() && callback(*m_volume))
209         return;
210
211     if (m_echoCancellation && !m_echoCancellation->isEmpty() && callback(*m_echoCancellation))
212         return;
213
214     if (m_facingMode && !m_facingMode->isEmpty() && callback(*m_facingMode))
215         return;
216     if (m_deviceId && !m_deviceId->isEmpty() && callback(*m_deviceId))
217         return;
218     if (m_groupId && !m_groupId->isEmpty() && callback(*m_groupId))
219         return;
220 }
221
222 void MediaTrackConstraintSetMap::set(MediaConstraintType constraintType, std::optional<IntConstraint>&& constraint)
223 {
224     switch (constraintType) {
225     case MediaConstraintType::Width:
226         m_width = WTFMove(constraint);
227         break;
228     case MediaConstraintType::Height:
229         m_height = WTFMove(constraint);
230         break;
231     case MediaConstraintType::SampleRate:
232         m_sampleRate = WTFMove(constraint);
233         break;
234     case MediaConstraintType::SampleSize:
235         m_sampleSize = WTFMove(constraint);
236         break;
237
238     case MediaConstraintType::AspectRatio:
239     case MediaConstraintType::FrameRate:
240     case MediaConstraintType::Volume:
241     case MediaConstraintType::EchoCancellation:
242     case MediaConstraintType::FacingMode:
243     case MediaConstraintType::DeviceId:
244     case MediaConstraintType::GroupId:
245     case MediaConstraintType::Unknown:
246         ASSERT_NOT_REACHED();
247         break;
248     }
249 }
250
251 void MediaTrackConstraintSetMap::set(MediaConstraintType constraintType, std::optional<DoubleConstraint>&& constraint)
252 {
253     switch (constraintType) {
254     case MediaConstraintType::AspectRatio:
255         m_aspectRatio = WTFMove(constraint);
256         break;
257     case MediaConstraintType::FrameRate:
258         m_frameRate = WTFMove(constraint);
259         break;
260     case MediaConstraintType::Volume:
261         m_volume = WTFMove(constraint);
262         break;
263
264     case MediaConstraintType::Width:
265     case MediaConstraintType::Height:
266     case MediaConstraintType::SampleRate:
267     case MediaConstraintType::SampleSize:
268     case MediaConstraintType::EchoCancellation:
269     case MediaConstraintType::FacingMode:
270     case MediaConstraintType::DeviceId:
271     case MediaConstraintType::GroupId:
272     case MediaConstraintType::Unknown:
273         ASSERT_NOT_REACHED();
274         break;
275     }
276 }
277
278 void MediaTrackConstraintSetMap::set(MediaConstraintType constraintType, std::optional<BooleanConstraint>&& constraint)
279 {
280     switch (constraintType) {
281     case MediaConstraintType::EchoCancellation:
282         m_echoCancellation = WTFMove(constraint);
283         break;
284
285     case MediaConstraintType::Width:
286     case MediaConstraintType::Height:
287     case MediaConstraintType::SampleRate:
288     case MediaConstraintType::SampleSize:
289     case MediaConstraintType::AspectRatio:
290     case MediaConstraintType::FrameRate:
291     case MediaConstraintType::Volume:
292     case MediaConstraintType::FacingMode:
293     case MediaConstraintType::DeviceId:
294     case MediaConstraintType::GroupId:
295     case MediaConstraintType::Unknown:
296         ASSERT_NOT_REACHED();
297         break;
298     }
299 }
300
301 void MediaTrackConstraintSetMap::set(MediaConstraintType constraintType, std::optional<StringConstraint>&& constraint)
302 {
303     switch (constraintType) {
304     case MediaConstraintType::FacingMode:
305         m_facingMode = WTFMove(constraint);
306         break;
307     case MediaConstraintType::DeviceId:
308         m_deviceId = WTFMove(constraint);
309         break;
310     case MediaConstraintType::GroupId:
311         m_groupId = WTFMove(constraint);
312         break;
313
314     case MediaConstraintType::Width:
315     case MediaConstraintType::Height:
316     case MediaConstraintType::SampleRate:
317     case MediaConstraintType::SampleSize:
318     case MediaConstraintType::AspectRatio:
319     case MediaConstraintType::FrameRate:
320     case MediaConstraintType::Volume:
321     case MediaConstraintType::EchoCancellation:
322     case MediaConstraintType::Unknown:
323         ASSERT_NOT_REACHED();
324         break;
325     }
326 }
327
328 size_t MediaTrackConstraintSetMap::size() const
329 {
330     size_t count = 0;
331     forEach([&count] (const MediaConstraint&) mutable {
332         ++count;
333     });
334
335     return count;
336 }
337
338 bool MediaTrackConstraintSetMap::isEmpty() const
339 {
340     return !size();
341 }
342
343 }
344
345 #endif // ENABLE(MEDIA_STREAM)