afe1977908d2137a4c6dcee649073bd71bb8b451
[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-2018 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 "CaptureDevice.h"
39 #include "Image.h"
40 #include "MediaConstraints.h"
41 #include "MediaSample.h"
42 #include "PlatformLayer.h"
43 #include "RealtimeMediaSourceCapabilities.h"
44 #include "RealtimeMediaSourceFactory.h"
45 #include <wtf/RecursiveLockAdapter.h>
46 #include <wtf/ThreadSafeRefCounted.h>
47 #include <wtf/Vector.h>
48 #include <wtf/WeakPtr.h>
49 #include <wtf/text/WTFString.h>
50
51 namespace WTF {
52 class MediaTime;
53 }
54
55 namespace WebCore {
56
57 class AudioStreamDescription;
58 class FloatRect;
59 class GraphicsContext;
60 class MediaStreamPrivate;
61 class OrientationNotifier;
62 class PlatformAudioData;
63 class RealtimeMediaSourceSettings;
64 class RemoteVideoSample;
65
66 struct CaptureSourceOrError;
67
68 class WEBCORE_EXPORT RealtimeMediaSource : public ThreadSafeRefCounted<RealtimeMediaSource>, public CanMakeWeakPtr<RealtimeMediaSource> {
69 public:
70     class Observer {
71     public:
72         virtual ~Observer();
73
74         // Source state changes.
75         virtual void sourceStarted() { }
76         virtual void sourceStopped() { }
77         virtual void sourceMutedChanged() { }
78         virtual void sourceSettingsChanged() { }
79
80         // Observer state queries.
81         virtual bool preventSourceFromStopping() { return false; }
82
83         // Called on the main thread.
84         virtual void videoSampleAvailable(MediaSample&) { }
85
86         // May be called on a background thread.
87         virtual void audioSamplesAvailable(const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t /*numberOfFrames*/) { }
88     };
89
90     virtual ~RealtimeMediaSource() = default;
91
92     const String& hashedId() const;
93     String deviceIDHashSalt() const;
94
95     const String& persistentID() const { return m_persistentID; }
96
97     enum class Type { None, Audio, Video };
98     Type type() const { return m_type; }
99
100     bool isProducingData() const { return m_isProducingData; }
101     void start();
102     void stop();
103     void requestToEnd(Observer& callingObserver);
104
105     bool muted() const { return m_muted; }
106     void setMuted(bool);
107
108     bool captureDidFail() const { return m_captureDidFailed; }
109
110     virtual bool interrupted() const { return m_interrupted; }
111     virtual void setInterrupted(bool, bool);
112
113     const String& name() const { return m_name; }
114     void setName(String&& name) { m_name = WTFMove(name); }
115
116     unsigned fitnessScore() const { return m_fitnessScore; }
117
118     WEBCORE_EXPORT void addObserver(Observer&);
119     WEBCORE_EXPORT void removeObserver(Observer&);
120
121     const IntSize size() const;
122     void setSize(const IntSize&);
123
124     const IntSize intrinsicSize() const;
125     void setIntrinsicSize(const IntSize&);
126
127     double frameRate() const { return m_frameRate; }
128     void setFrameRate(double);
129
130     double aspectRatio() const { return m_aspectRatio; }
131     void setAspectRatio(double);
132
133     RealtimeMediaSourceSettings::VideoFacingMode facingMode() const { return m_facingMode; }
134     void setFacingMode(RealtimeMediaSourceSettings::VideoFacingMode);
135
136     double volume() const { return m_volume; }
137     void setVolume(double);
138
139     int sampleRate() const { return m_sampleRate; }
140     void setSampleRate(int);
141     virtual Optional<Vector<int>> discreteSampleRates() const;
142
143     int sampleSize() const { return m_sampleSize; }
144     void setSampleSize(int);
145     virtual Optional<Vector<int>> discreteSampleSizes() const;
146
147     bool echoCancellation() const { return m_echoCancellation; }
148     void setEchoCancellation(bool);
149
150     virtual const RealtimeMediaSourceCapabilities& capabilities() = 0;
151     virtual const RealtimeMediaSourceSettings& settings() = 0;
152
153     struct ApplyConstraintsError {
154         String badConstraint;
155         String message;
156     };
157     using ApplyConstraintsHandler = CompletionHandler<void(Optional<ApplyConstraintsError>&&)>;
158     virtual void applyConstraints(const MediaConstraints&, ApplyConstraintsHandler&&);
159     Optional<ApplyConstraintsError> applyConstraints(const MediaConstraints&);
160
161     bool supportsConstraints(const MediaConstraints&, String&);
162     bool supportsConstraint(const MediaConstraint&);
163
164     virtual bool isIsolated() const { return false; }
165
166     virtual bool isCaptureSource() const { return false; }
167     virtual CaptureDevice::DeviceType deviceType() const { return CaptureDevice::DeviceType::Unknown; }
168
169     virtual void monitorOrientation(OrientationNotifier&) { }
170
171     virtual void captureFailed();
172
173     virtual bool isIncomingAudioSource() const { return false; }
174     virtual bool isIncomingVideoSource() const { return false; }
175
176     void setIsRemote(bool isRemote) { m_isRemote = isRemote; }
177     bool isRemote() const { return m_isRemote; }
178
179     // Testing only
180     virtual void delaySamples(Seconds) { };
181     void setInterruptedForTesting(bool);
182
183 protected:
184     RealtimeMediaSource(Type, String&& name, String&& deviceID = { }, String&& hashSalt = { });
185
186     void scheduleDeferredTask(WTF::Function<void()>&&);
187
188     virtual void beginConfiguration() { }
189     virtual void commitConfiguration() { }
190
191     bool selectSettings(const MediaConstraints&, FlattenedConstraint&, String&);
192     double fitnessDistance(const MediaConstraint&);
193     void applyConstraint(const MediaConstraint&);
194     void applyConstraints(const FlattenedConstraint&);
195     bool supportsSizeAndFrameRate(Optional<IntConstraint> width, Optional<IntConstraint> height, Optional<DoubleConstraint>, String&, double& fitnessDistance);
196
197     virtual bool supportsSizeAndFrameRate(Optional<int> width, Optional<int> height, Optional<double>);
198     virtual void setSizeAndFrameRate(Optional<int> width, Optional<int> height, Optional<double>);
199
200     void notifyMutedObservers() const;
201     void notifyMutedChange(bool muted);
202     void notifySettingsDidChangeObservers(OptionSet<RealtimeMediaSourceSettings::Flag>);
203
204     void initializeVolume(double volume) { m_volume = volume; }
205     void initializeSampleRate(int sampleRate) { m_sampleRate = sampleRate; }
206     void initializeEchoCancellation(bool echoCancellation) { m_echoCancellation = echoCancellation; }
207
208     void videoSampleAvailable(MediaSample&);
209     void audioSamplesAvailable(const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t);
210
211 private:
212     virtual void startProducingData() { }
213     virtual void stopProducingData() { }
214     virtual void settingsDidChange(OptionSet<RealtimeMediaSourceSettings::Flag>) { }
215
216     virtual void hasEnded() { }
217
218     void forEachObserver(const WTF::Function<void(Observer&)>&) const;
219
220     bool m_muted { false };
221
222     String m_idHashSalt;
223     String m_hashedID;
224     String m_persistentID;
225     Type m_type;
226     String m_name;
227     mutable RecursiveLock m_observersLock;
228     HashSet<Observer*> m_observers;
229     IntSize m_size;
230     IntSize m_intrinsicSize;
231     double m_frameRate { 30 };
232     double m_aspectRatio { 0 };
233     double m_volume { 1 };
234     double m_sampleRate { 0 };
235     double m_sampleSize { 0 };
236     double m_fitnessScore { 0 };
237     RealtimeMediaSourceSettings::VideoFacingMode m_facingMode { RealtimeMediaSourceSettings::User};
238
239     bool m_pendingSettingsDidChangeNotification { false };
240     bool m_echoCancellation { false };
241     bool m_isProducingData { false };
242     bool m_interrupted { false };
243     bool m_captureDidFailed { false };
244     bool m_isRemote { false };
245     bool m_isEnded { false };
246 };
247
248 struct CaptureSourceOrError {
249     CaptureSourceOrError() = default;
250     CaptureSourceOrError(Ref<RealtimeMediaSource>&& source) : captureSource(WTFMove(source)) { }
251     CaptureSourceOrError(String&& message) : errorMessage(WTFMove(message)) { }
252     
253     operator bool()  const { return !!captureSource; }
254     Ref<RealtimeMediaSource> source() { return captureSource.releaseNonNull(); }
255     
256     RefPtr<RealtimeMediaSource> captureSource;
257     String errorMessage;
258 };
259
260 } // namespace WebCore
261
262 #endif // ENABLE(MEDIA_STREAM)