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