Clean up some includes to make the build a bit faster: DOMPromise
[WebKit-https.git] / Source / WebCore / Modules / mediastream / MediaStreamTrack.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2011, 2015 Ericsson AB. All rights reserved.
4  * Copyright (C) 2013-2019 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  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer.
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #pragma once
29
30 #if ENABLE(MEDIA_STREAM)
31
32 #include "ActiveDOMObject.h"
33 #include "DoubleRange.h"
34 #include "EventTarget.h"
35 #include "GenericTaskQueue.h"
36 #include "LongRange.h"
37 #include "MediaProducer.h"
38 #include "MediaStreamTrackPrivate.h"
39 #include "MediaTrackConstraints.h"
40 #include <wtf/LoggerHelper.h>
41
42 namespace WebCore {
43
44 class AudioSourceProvider;
45 class Document;
46
47 struct MediaTrackConstraints;
48
49 template<typename IDLType> class DOMPromiseDeferred;
50
51 class MediaStreamTrack
52     : public RefCounted<MediaStreamTrack>
53     , public ActiveDOMObject
54     , public EventTargetWithInlineData
55     , public MediaProducer
56     , private MediaStreamTrackPrivate::Observer
57 #if !RELEASE_LOG_DISABLED
58     , private LoggerHelper
59 #endif
60 {
61     WTF_MAKE_ISO_ALLOCATED(MediaStreamTrack);
62 public:
63     class Observer {
64     public:
65         virtual ~Observer() = default;
66         virtual void trackDidEnd() = 0;
67     };
68
69     static Ref<MediaStreamTrack> create(ScriptExecutionContext&, Ref<MediaStreamTrackPrivate>&&);
70     virtual ~MediaStreamTrack();
71
72     static void endCapture(Document&);
73
74 #if PLATFORM(IOS_FAMILY)
75     static MediaProducer::MediaStateFlags captureState();
76     static void muteCapture();
77 #endif
78
79     virtual bool isCanvas() const { return false; }
80
81     const AtomString& kind() const;
82     WEBCORE_EXPORT const String& id() const;
83     const String& label() const;
84
85     const AtomString& contentHint() const;
86     void setContentHint(const String&);
87         
88     bool enabled() const;
89     void setEnabled(bool);
90
91     bool muted() const;
92     void setMuted(MediaProducer::MutedStateFlags);
93
94     enum class State { Live, Ended };
95     State readyState() const;
96
97     bool ended() const;
98
99     virtual RefPtr<MediaStreamTrack> clone();
100
101     enum class StopMode { Silently, PostEvent };
102     void stopTrack(StopMode = StopMode::Silently);
103
104     bool isCaptureTrack() const { return m_isCaptureTrack; }
105
106     struct TrackSettings {
107         Optional<int> width;
108         Optional<int> height;
109         Optional<double> aspectRatio;
110         Optional<double> frameRate;
111         String facingMode;
112         Optional<double> volume;
113         Optional<int> sampleRate;
114         Optional<int> sampleSize;
115         Optional<bool> echoCancellation;
116         Optional<bool> displaySurface;
117         String logicalSurface;
118         String deviceId;
119         String groupId;
120     };
121     TrackSettings getSettings() const;
122
123     struct TrackCapabilities {
124         Optional<LongRange> width;
125         Optional<LongRange> height;
126         Optional<DoubleRange> aspectRatio;
127         Optional<DoubleRange> frameRate;
128         Optional<Vector<String>> facingMode;
129         Optional<DoubleRange> volume;
130         Optional<LongRange> sampleRate;
131         Optional<LongRange> sampleSize;
132         Optional<Vector<bool>> echoCancellation;
133         String deviceId;
134         String groupId;
135     };
136     TrackCapabilities getCapabilities() const;
137
138     const MediaTrackConstraints& getConstraints() const { return m_constraints; }
139     void applyConstraints(const Optional<MediaTrackConstraints>&, DOMPromiseDeferred<void>&&);
140
141     RealtimeMediaSource& source() const { return m_private->source(); }
142     MediaStreamTrackPrivate& privateTrack() { return m_private.get(); }
143
144     AudioSourceProvider* audioSourceProvider();
145
146     // MediaProducer
147     void pageMutedStateDidChange() final;
148     MediaProducer::MediaStateFlags mediaState() const final;
149
150     void addObserver(Observer&);
151     void removeObserver(Observer&);
152
153     using RefCounted::ref;
154     using RefCounted::deref;
155
156     // ActiveDOMObject API.
157     bool hasPendingActivity() const final;
158
159     void setIdForTesting(String&& id) { m_private->setIdForTesting(WTFMove(id)); }
160
161 #if !RELEASE_LOG_DISABLED
162     const Logger& logger() const final { return m_private->logger(); }
163     const void* logIdentifier() const final { return m_private->logIdentifier(); }
164 #endif
165
166 protected:
167     MediaStreamTrack(ScriptExecutionContext&, Ref<MediaStreamTrackPrivate>&&);
168
169     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
170         
171     Ref<MediaStreamTrackPrivate> m_private;
172         
173 private:
174     explicit MediaStreamTrack(MediaStreamTrack&);
175
176     void configureTrackRendering();
177
178     Document* document() const;
179
180     // ActiveDOMObject API.
181     void stop() final;
182     const char* activeDOMObjectName() const final;
183     bool canSuspendForDocumentSuspension() const final;
184
185     // EventTarget
186     void refEventTarget() final { ref(); }
187     void derefEventTarget() final { deref(); }
188     EventTargetInterface eventTargetInterface() const final { return MediaStreamTrackEventTargetInterfaceType; }
189
190     // MediaStreamTrackPrivate::Observer
191     void trackStarted(MediaStreamTrackPrivate&) final;
192     void trackEnded(MediaStreamTrackPrivate&) final;
193     void trackMutedChanged(MediaStreamTrackPrivate&) final;
194     void trackSettingsChanged(MediaStreamTrackPrivate&) final;
195     void trackEnabledChanged(MediaStreamTrackPrivate&) final;
196
197 #if !RELEASE_LOG_DISABLED
198     const char* logClassName() const final { return "MediaStreamTrack"; }
199     WTFLogChannel& logChannel() const final;
200 #endif
201
202     Vector<Observer*> m_observers;
203
204     MediaTrackConstraints m_constraints;
205     std::unique_ptr<DOMPromiseDeferred<void>> m_promise;
206     GenericTaskQueue<ScriptExecutionContext> m_taskQueue;
207     GenericTaskQueue<Timer> m_eventTaskQueue;
208
209     bool m_ended { false };
210     const bool m_isCaptureTrack { false };
211 };
212
213 typedef Vector<RefPtr<MediaStreamTrack>> MediaStreamTrackVector;
214
215 } // namespace WebCore
216
217 #endif // ENABLE(MEDIA_STREAM)