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