4bf7219a818dbcdbac15af0e59dcaf0a941b8ec2
[WebKit-https.git] / Source / WebCore / platform / mediastream / RealtimeMediaSource.h
1 /*
2  * Copyright (C) 2011 Ericsson AB. All rights reserved.
3  * Copyright (C) 2012 Google Inc. All rights reserved.
4  * Copyright (C) 2013-2017 Apple Inc. All rights reserved.
5  * Copyright (C) 2013 Nokia Corporation and/or its subsidiary(-ies).
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer
15  *    in the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of Ericsson nor the names of its contributors
18  *    may be used to endorse or promote products derived from this
19  *    software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #pragma once
35
36 #if ENABLE(MEDIA_STREAM)
37
38 #include "AudioSourceProvider.h"
39 #include "CaptureDevice.h"
40 #include "Image.h"
41 #include "MediaConstraints.h"
42 #include "MediaSample.h"
43 #include "PlatformLayer.h"
44 #include "RealtimeMediaSourceCapabilities.h"
45 #include <wtf/RefCounted.h>
46 #include <wtf/Vector.h>
47 #include <wtf/WeakPtr.h>
48 #include <wtf/text/WTFString.h>
49
50 namespace WTF {
51 class MediaTime;
52 }
53
54 namespace WebCore {
55
56 class AudioStreamDescription;
57 class FloatRect;
58 class GraphicsContext;
59 class MediaStreamPrivate;
60 class OrientationNotifier;
61 class PlatformAudioData;
62 class RealtimeMediaSourceSettings;
63
64 struct CaptureSourceOrError;
65
66 class WEBCORE_EXPORT RealtimeMediaSource : public RefCounted<RealtimeMediaSource> {
67 public:
68     class Observer {
69     public:
70         virtual ~Observer() { }
71         
72         // Source state changes.
73         virtual void sourceStopped() { }
74         virtual void sourceMutedChanged() { }
75         virtual void sourceEnabledChanged() { }
76         virtual void sourceSettingsChanged() { }
77
78         // Observer state queries.
79         virtual bool preventSourceFromStopping() { return false; }
80
81         // Called on the main thread.
82         virtual void videoSampleAvailable(MediaSample&) { }
83
84         // May be called on a background thread.
85         virtual void audioSamplesAvailable(const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t /*numberOfFrames*/) { }
86     };
87
88     template<typename Source> class SingleSourceFactory {
89     public:
90         void setActiveSource(Source& source)
91         {
92             if (m_activeSource == &source)
93                 return;
94             if (m_activeSource && m_activeSource->isProducingData())
95                 m_activeSource->setMuted(true);
96             m_activeSource = &source;
97         }
98
99         void unsetActiveSource(Source& source)
100         {
101             if (m_activeSource == &source)
102                 m_activeSource = nullptr;
103         }
104
105         RealtimeMediaSource* activeSource() { return m_activeSource; }
106     private:
107         RealtimeMediaSource* m_activeSource { nullptr };
108     };
109
110     class AudioCaptureFactory {
111     public:
112         virtual ~AudioCaptureFactory() = default;
113         virtual CaptureSourceOrError createAudioCaptureSource(const String& audioDeviceID, const MediaConstraints*) = 0;
114         
115     protected:
116         AudioCaptureFactory() = default;
117     };
118
119     class VideoCaptureFactory {
120     public:
121         virtual ~VideoCaptureFactory() = default;
122         virtual CaptureSourceOrError createVideoCaptureSource(const String& videoDeviceID, const MediaConstraints*) = 0;
123         virtual void setVisibility(bool) { }
124
125     protected:
126         VideoCaptureFactory() = default;
127     };
128
129     virtual ~RealtimeMediaSource() { }
130
131     const String& id() const { return m_id; }
132
133     const String& persistentID() const { return m_persistentID; }
134     virtual void setPersistentID(String&& persistentID) { m_persistentID = WTFMove(persistentID); }
135
136     enum class Type { None, Audio, Video };
137     Type type() const { return m_type; }
138
139     bool isProducingData() const { return m_isProducingData; }
140     void start();
141     void stop();
142     void requestStop(Observer* callingObserver = nullptr);
143
144     bool muted() const { return m_muted; }
145     void setMuted(bool);
146     
147     bool enabled() const { return m_enabled; }
148     void setEnabled(bool);
149
150     const String& name() const { return m_name; }
151     void setName(const String& name) { m_name = name; }
152     
153     unsigned fitnessScore() const { return m_fitnessScore; }
154
155     WEBCORE_EXPORT void addObserver(Observer&);
156     WEBCORE_EXPORT void removeObserver(Observer&);
157
158     void setWidth(int);
159     void setHeight(int);
160     const IntSize& size() const { return m_size; }
161     virtual bool applySize(const IntSize&) { return false; }
162
163     double frameRate() const { return m_frameRate; }
164     void setFrameRate(double);
165     virtual bool applyFrameRate(double) { return false; }
166
167     double aspectRatio() const { return m_aspectRatio; }
168     void setAspectRatio(double);
169     virtual bool applyAspectRatio(double) { return false; }
170
171     RealtimeMediaSourceSettings::VideoFacingMode facingMode() const { return m_facingMode; }
172     void setFacingMode(RealtimeMediaSourceSettings::VideoFacingMode);
173     virtual bool applyFacingMode(RealtimeMediaSourceSettings::VideoFacingMode) { return false; }
174
175     double volume() const { return m_volume; }
176     void setVolume(double);
177     virtual bool applyVolume(double) { return false; }
178
179     int sampleRate() const { return m_sampleRate; }
180     void setSampleRate(int);
181     virtual bool applySampleRate(int) { return false; }
182
183     int sampleSize() const { return m_sampleSize; }
184     void setSampleSize(int);
185     virtual bool applySampleSize(int) { return false; }
186
187     bool echoCancellation() const { return m_echoCancellation; }
188     void setEchoCancellation(bool);
189     virtual bool applyEchoCancellation(bool) { return false; }
190
191     virtual const RealtimeMediaSourceCapabilities& capabilities() const = 0;
192     virtual const RealtimeMediaSourceSettings& settings() const = 0;
193
194     using SuccessHandler = std::function<void()>;
195     using FailureHandler = std::function<void(const String& badConstraint, const String& errorString)>;
196     virtual void applyConstraints(const MediaConstraints&, SuccessHandler&&, FailureHandler&&);
197     std::optional<std::pair<String, String>> applyConstraints(const MediaConstraints&);
198
199     virtual bool supportsConstraints(const MediaConstraints&, String&);
200     virtual bool supportsConstraint(const MediaConstraint&) const;
201
202     virtual void settingsDidChange();
203
204     virtual bool isIsolated() const { return false; }
205
206     virtual bool isCaptureSource() const { return false; }
207
208     virtual void monitorOrientation(OrientationNotifier&) { }
209
210     virtual AudioSourceProvider* audioSourceProvider() { return nullptr; }
211
212     // Testing only
213     virtual void delaySamples(float) { };
214
215 protected:
216     RealtimeMediaSource(const String& id, Type, const String& name);
217
218     void scheduleDeferredTask(std::function<void()>&&);
219
220     virtual void beginConfiguration() { }
221     virtual void commitConfiguration() { }
222
223     enum class SelectType { ForApplyConstraints, ForSupportsConstraints };
224     bool selectSettings(const MediaConstraints&, FlattenedConstraint&, String&, SelectType);
225     virtual double fitnessDistance(const MediaConstraint&);
226     virtual bool supportsSizeAndFrameRate(std::optional<IntConstraint> width, std::optional<IntConstraint> height, std::optional<DoubleConstraint>, String&, double& fitnessDistance);
227     virtual bool supportsSizeAndFrameRate(std::optional<int> width, std::optional<int> height, std::optional<double>);
228     virtual void applyConstraint(const MediaConstraint&);
229     virtual void applyConstraints(const FlattenedConstraint&);
230     virtual void applySizeAndFrameRate(std::optional<int> width, std::optional<int> height, std::optional<double>);
231
232     void notifyMutedObservers() const;
233     void notifyMutedChange(bool muted);
234
235     void initializeVolume(double volume) { m_volume = volume; }
236     void initializeSampleRate(int sampleRate) { m_sampleRate = sampleRate; }
237     void initializeEchoCancellation(bool echoCancellation) { m_echoCancellation = echoCancellation; }
238
239     void videoSampleAvailable(MediaSample&);
240     void audioSamplesAvailable(const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t);
241     
242 private:
243     WeakPtr<RealtimeMediaSource> createWeakPtr() { return m_weakPtrFactory.createWeakPtr(); }
244
245     virtual void startProducingData() { }
246     virtual void stopProducingData() { }
247
248     bool m_muted { false };
249     bool m_enabled { true };
250
251     WeakPtrFactory<RealtimeMediaSource> m_weakPtrFactory;
252     String m_id;
253     String m_persistentID;
254     Type m_type;
255     String m_name;
256     Vector<std::reference_wrapper<Observer>> m_observers;
257     IntSize m_size;
258     double m_frameRate { 30 };
259     double m_aspectRatio { 0 };
260     double m_volume { 1 };
261     double m_sampleRate { 0 };
262     double m_sampleSize { 0 };
263     double m_fitnessScore { std::numeric_limits<double>::infinity() };
264     RealtimeMediaSourceSettings::VideoFacingMode m_facingMode { RealtimeMediaSourceSettings::User};
265
266     bool m_echoCancellation { false };
267     bool m_pendingSettingsDidChangeNotification { false };
268     bool m_suppressNotifications { true };
269     bool m_isProducingData { false };
270 };
271
272 struct CaptureSourceOrError {
273     CaptureSourceOrError() = default;
274     CaptureSourceOrError(Ref<RealtimeMediaSource>&& source) : captureSource(WTFMove(source)) { }
275     CaptureSourceOrError(String&& message) : errorMessage(WTFMove(message)) { }
276     
277     operator bool()  const { return !!captureSource; }
278     Ref<RealtimeMediaSource> source() { return captureSource.releaseNonNull(); }
279     
280     RefPtr<RealtimeMediaSource> captureSource;
281     String errorMessage;
282 };
283
284 } // namespace WebCore
285
286 #endif // ENABLE(MEDIA_STREAM)