8fa8903d090c848905ce5dfcc8fe2fd98a719fa3
[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 "JSDOMPromiseDeferred.h"
37 #include "LongRange.h"
38 #include "MediaProducer.h"
39 #include "MediaStreamTrackPrivate.h"
40 #include "MediaTrackConstraints.h"
41 #include <wtf/LoggerHelper.h>
42
43 namespace WebCore {
44
45 class AudioSourceProvider;
46 class Document;
47
48 struct MediaTrackConstraints;
49
50 class MediaStreamTrack
51     : public RefCounted<MediaStreamTrack>
52     , public ActiveDOMObject
53     , public EventTargetWithInlineData
54     , public MediaProducer
55     , private MediaStreamTrackPrivate::Observer
56 #if !RELEASE_LOG_DISABLED
57     , private LoggerHelper
58 #endif
59 {
60     WTF_MAKE_ISO_ALLOCATED(MediaStreamTrack);
61 public:
62     class Observer {
63     public:
64         virtual ~Observer() = default;
65         virtual void trackDidEnd() = 0;
66     };
67
68     static Ref<MediaStreamTrack> create(ScriptExecutionContext&, Ref<MediaStreamTrackPrivate>&&);
69     virtual ~MediaStreamTrack();
70
71     static void endCapture(Document&);
72
73 #if PLATFORM(IOS_FAMILY)
74     static MediaProducer::MediaStateFlags captureState();
75     static void muteCapture();
76 #endif
77
78     virtual bool isCanvas() const { return false; }
79
80     const AtomString& kind() const;
81     WEBCORE_EXPORT const String& id() const;
82     const String& label() const;
83
84     const AtomString& contentHint() const;
85     void setContentHint(const String&);
86         
87     bool enabled() const;
88     void setEnabled(bool);
89
90     bool muted() const;
91     void setMuted(MediaProducer::MutedStateFlags);
92
93     enum class State { Live, Ended };
94     State readyState() const;
95
96     bool ended() const;
97
98     virtual RefPtr<MediaStreamTrack> clone();
99
100     enum class StopMode { Silently, PostEvent };
101     void stopTrack(StopMode = StopMode::Silently);
102
103     bool isCaptureTrack() const { return m_isCaptureTrack; }
104
105     struct TrackSettings {
106         Optional<int> width;
107         Optional<int> height;
108         Optional<double> aspectRatio;
109         Optional<double> frameRate;
110         String facingMode;
111         Optional<double> volume;
112         Optional<int> sampleRate;
113         Optional<int> sampleSize;
114         Optional<bool> echoCancellation;
115         Optional<bool> displaySurface;
116         String logicalSurface;
117         String deviceId;
118         String groupId;
119     };
120     TrackSettings getSettings() const;
121
122     struct TrackCapabilities {
123         Optional<LongRange> width;
124         Optional<LongRange> height;
125         Optional<DoubleRange> aspectRatio;
126         Optional<DoubleRange> frameRate;
127         Optional<Vector<String>> facingMode;
128         Optional<DoubleRange> volume;
129         Optional<LongRange> sampleRate;
130         Optional<LongRange> sampleSize;
131         Optional<Vector<bool>> echoCancellation;
132         String deviceId;
133         String groupId;
134     };
135     TrackCapabilities getCapabilities() const;
136
137     const MediaTrackConstraints& getConstraints() const { return m_constraints; }
138     void applyConstraints(const Optional<MediaTrackConstraints>&, DOMPromiseDeferred<void>&&);
139
140     RealtimeMediaSource& source() const { return m_private->source(); }
141     MediaStreamTrackPrivate& privateTrack() { return m_private.get(); }
142
143     AudioSourceProvider* audioSourceProvider();
144
145     // MediaProducer
146     void pageMutedStateDidChange() final;
147     MediaProducer::MediaStateFlags mediaState() const final;
148
149     void addObserver(Observer&);
150     void removeObserver(Observer&);
151
152     using RefCounted::ref;
153     using RefCounted::deref;
154
155     // ActiveDOMObject API.
156     bool hasPendingActivity() const final;
157
158     void setIdForTesting(String&& id) { m_private->setIdForTesting(WTFMove(id)); }
159
160 #if !RELEASE_LOG_DISABLED
161     const Logger& logger() const final { return m_private->logger(); }
162     const void* logIdentifier() const final { return m_private->logIdentifier(); }
163 #endif
164
165 protected:
166     MediaStreamTrack(ScriptExecutionContext&, Ref<MediaStreamTrackPrivate>&&);
167
168     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
169         
170     Ref<MediaStreamTrackPrivate> m_private;
171         
172 private:
173     explicit MediaStreamTrack(MediaStreamTrack&);
174
175     void configureTrackRendering();
176
177     Document* document() const;
178
179     // ActiveDOMObject API.
180     void stop() final;
181     const char* activeDOMObjectName() const final;
182     bool canSuspendForDocumentSuspension() const final;
183
184     // EventTarget
185     void refEventTarget() final { ref(); }
186     void derefEventTarget() final { deref(); }
187     EventTargetInterface eventTargetInterface() const final { return MediaStreamTrackEventTargetInterfaceType; }
188
189     // MediaStreamTrackPrivate::Observer
190     void trackStarted(MediaStreamTrackPrivate&) final;
191     void trackEnded(MediaStreamTrackPrivate&) final;
192     void trackMutedChanged(MediaStreamTrackPrivate&) final;
193     void trackSettingsChanged(MediaStreamTrackPrivate&) final;
194     void trackEnabledChanged(MediaStreamTrackPrivate&) final;
195
196 #if !RELEASE_LOG_DISABLED
197     const char* logClassName() const final { return "MediaStreamTrack"; }
198     WTFLogChannel& logChannel() const final;
199 #endif
200
201     Vector<Observer*> m_observers;
202
203     MediaTrackConstraints m_constraints;
204     Optional<DOMPromiseDeferred<void>> m_promise;
205     GenericTaskQueue<ScriptExecutionContext> m_taskQueue;
206     GenericTaskQueue<Timer> m_eventTaskQueue;
207
208     bool m_ended { false };
209     const bool m_isCaptureTrack { false };
210 };
211
212 typedef Vector<RefPtr<MediaStreamTrack>> MediaStreamTrackVector;
213
214 } // namespace WebCore
215
216 #endif // ENABLE(MEDIA_STREAM)