2f22d4894ede6ee3f6b8f69c2950e27220936eaa
[WebKit-https.git] / Source / WebCore / platform / mediastream / RealtimeMediaSourceCapabilities.h
1 /*
2  * Copyright (C) 2013 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  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef RealtimeMediaSourceCapabilities_h
27 #define RealtimeMediaSourceCapabilities_h
28
29 #if ENABLE(MEDIA_STREAM)
30
31 #include "RealtimeMediaSourceSettings.h"
32 #include <wtf/RefCounted.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/AtomicString.h>
35
36 namespace WebCore {
37
38 class CapabilityValueOrRange {
39 public:
40
41     enum Type {
42         Undefined,
43         Double,
44         ULong,
45         DoubleRange,
46         ULongRange,
47     };
48     Type type() const { return m_type; }
49
50     union ValueUnion {
51         int asInt;
52         double asDouble;
53     };
54
55     CapabilityValueOrRange()
56         : m_type(Undefined)
57     {
58     }
59
60     CapabilityValueOrRange(double value)
61         : m_type(Double)
62     {
63         m_minOrValue.asDouble = value;
64     }
65
66     CapabilityValueOrRange(int value)
67         : m_type(ULong)
68     {
69         m_minOrValue.asInt = value;
70     }
71
72     CapabilityValueOrRange(double min, double max)
73         : m_type(DoubleRange)
74     {
75         m_minOrValue.asDouble = min;
76         m_max.asDouble = max;
77     }
78     
79     CapabilityValueOrRange(int min, int max)
80         : m_type(ULongRange)
81     {
82         m_minOrValue.asInt = min;
83         m_max.asInt = max;
84     }
85
86     const ValueUnion& rangeMin() const
87     {
88         ASSERT(m_type == DoubleRange || m_type == ULongRange);
89         return m_minOrValue;
90     }
91
92     const ValueUnion& rangeMax() const
93     {
94         ASSERT(m_type == DoubleRange || m_type == ULongRange);
95         return m_max;
96     }
97
98     const ValueUnion& value() const
99     {
100         ASSERT(m_type == Double || m_type == ULong);
101         return m_minOrValue;
102     }
103
104 private:
105     ValueUnion m_minOrValue;
106     ValueUnion m_max;
107     Type m_type;
108 };
109
110 class RealtimeMediaSourceCapabilities : public RefCounted<RealtimeMediaSourceCapabilities> {
111 public:
112     static PassRefPtr<RealtimeMediaSourceCapabilities> create(const RealtimeMediaSourceSupportedConstraints& supportedConstraints)
113     {
114         return adoptRef(new RealtimeMediaSourceCapabilities(supportedConstraints));
115     }
116
117     ~RealtimeMediaSourceCapabilities() { }
118
119     bool supportsWidth() const { return m_supportedConstraints.supportsWidth(); }
120     const CapabilityValueOrRange& width() { return m_width; }
121     void setWidth(const CapabilityValueOrRange& width) { m_width = width; }
122
123     bool supportsHeight() const { return m_supportedConstraints.supportsHeight(); }
124     const CapabilityValueOrRange& height() { return m_height; }
125     void setHeight(const CapabilityValueOrRange& height) { m_height = height; }
126
127     bool supportsFrameRate() const { return m_supportedConstraints.supportsFrameRate(); }
128     const CapabilityValueOrRange& frameRate() { return m_frameRate; }
129     void setFrameRate(const CapabilityValueOrRange& frameRate) { m_frameRate = frameRate; }
130
131     bool supportsFacingMode() const { return m_supportedConstraints.supportsFacingMode(); }
132     const Vector<RealtimeMediaSourceSettings::VideoFacingMode>& facingMode() { return m_facingMode; }
133     void addFacingMode(RealtimeMediaSourceSettings::VideoFacingMode mode) { m_facingMode.append(mode); }
134
135     bool supportsAspectRatio() const { return m_supportedConstraints.supportsAspectRatio(); }
136     const CapabilityValueOrRange& aspectRatio() { return m_aspectRatio; }
137     void setAspectRatio(const CapabilityValueOrRange& aspectRatio) { m_aspectRatio = aspectRatio; }
138
139     bool supportsVolume() const { return m_supportedConstraints.supportsVolume(); }
140     const CapabilityValueOrRange& volume() { return m_volume; }
141     void setVolume(const CapabilityValueOrRange& volume) { m_volume = volume; }
142
143     bool supportsSampleRate() const { return m_supportedConstraints.supportsSampleRate(); }
144     const CapabilityValueOrRange& sampleRate() { return m_sampleRate; }
145     void setSampleRate(const CapabilityValueOrRange& sampleRate) { m_sampleRate = sampleRate; }
146
147     bool supportsSampleSize() const { return m_supportedConstraints.supportsSampleSize(); }
148     const CapabilityValueOrRange& sampleSize() { return m_sampleSize; }
149     void setSampleSize(const CapabilityValueOrRange& sampleSize) { m_sampleSize = sampleSize; }
150
151     enum class EchoCancellation {
152         ReadOnly = 0,
153         ReadWrite = 1,
154     };
155     bool supportsEchoCancellation() const { return m_supportedConstraints.supportsEchoCancellation(); }
156     EchoCancellation echoCancellation() { return m_echoCancellation; }
157     void setEchoCancellation(EchoCancellation echoCancellation) { m_echoCancellation = echoCancellation; }
158
159     bool supportsDeviceId() const { return m_supportedConstraints.supportsDeviceId(); }
160     const AtomicString& deviceId() { return m_deviceId; }
161     void setDeviceId(const AtomicString& id)  { m_deviceId = id; }
162
163     bool supportsGroupId() const { return m_supportedConstraints.supportsGroupId(); }
164     const AtomicString& groupId() { return m_groupId; }
165     void setGroupId(const AtomicString& id)  { m_groupId = id; }
166     
167 private:
168     RealtimeMediaSourceCapabilities(const RealtimeMediaSourceSupportedConstraints& supportedConstraints)
169         : m_supportedConstraints(supportedConstraints)
170     {
171     }
172
173     CapabilityValueOrRange m_width;
174     CapabilityValueOrRange m_height;
175     CapabilityValueOrRange m_aspectRatio;
176     CapabilityValueOrRange m_frameRate;
177     Vector<RealtimeMediaSourceSettings::VideoFacingMode> m_facingMode;
178     CapabilityValueOrRange m_volume;
179     CapabilityValueOrRange m_sampleRate;
180     CapabilityValueOrRange m_sampleSize;
181     EchoCancellation m_echoCancellation;
182     AtomicString m_deviceId;
183     AtomicString m_groupId;
184
185     const RealtimeMediaSourceSupportedConstraints& m_supportedConstraints;
186 };
187
188 } // namespace WebCore
189
190 #endif // RealtimeMediaSourceCapabilities_h
191
192 #endif