Add media stream release logging
[WebKit-https.git] / Source / WebCore / Modules / mediastream / MediaStream.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 "EventTarget.h"
34 #include "MediaCanStartListener.h"
35 #include "MediaProducer.h"
36 #include "MediaStreamPrivate.h"
37 #include "MediaStreamTrack.h"
38 #include "PlatformMediaSession.h"
39 #include "ScriptWrappable.h"
40 #include "Timer.h"
41 #include "URLRegistry.h"
42 #include <wtf/HashMap.h>
43 #include <wtf/LoggerHelper.h>
44 #include <wtf/RefCounted.h>
45 #include <wtf/RefPtr.h>
46
47 namespace WebCore {
48
49 class Document;
50
51 class MediaStream final
52     : public URLRegistrable
53     , public EventTargetWithInlineData
54     , public ActiveDOMObject
55     , public MediaStreamTrack::Observer
56     , public MediaStreamPrivate::Observer
57     , private MediaCanStartListener
58     , private PlatformMediaSessionClient
59 #if !RELEASE_LOG_DISABLED
60     , private LoggerHelper
61 #endif
62     , public RefCounted<MediaStream> {
63 public:
64     class Observer {
65     public:
66         virtual ~Observer() = default;
67         virtual void didAddOrRemoveTrack() = 0;
68     };
69
70     static Ref<MediaStream> create(ScriptExecutionContext&);
71     static Ref<MediaStream> create(ScriptExecutionContext&, MediaStream&);
72     static Ref<MediaStream> create(ScriptExecutionContext&, const MediaStreamTrackVector&);
73     static Ref<MediaStream> create(ScriptExecutionContext&, Ref<MediaStreamPrivate>&&);
74     virtual ~MediaStream();
75
76     String id() const { return m_private->id(); }
77
78     void addTrack(MediaStreamTrack&);
79     void removeTrack(MediaStreamTrack&);
80     MediaStreamTrack* getTrackById(String);
81
82     MediaStreamTrackVector getAudioTracks() const;
83     MediaStreamTrackVector getVideoTracks() const;
84     MediaStreamTrackVector getTracks() const;
85
86     RefPtr<MediaStream> clone();
87
88     bool active() const { return m_isActive; }
89     bool muted() const { return m_private->muted(); }
90
91     MediaStreamPrivate& privateStream() { return m_private.get(); }
92
93     void startProducingData();
94     void stopProducingData();
95
96     void endCaptureTracks();
97
98     // EventTarget
99     EventTargetInterface eventTargetInterface() const final { return MediaStreamEventTargetInterfaceType; }
100     ScriptExecutionContext* scriptExecutionContext() const final { return ContextDestructionObserver::scriptExecutionContext(); }
101
102     using RefCounted<MediaStream>::ref;
103     using RefCounted<MediaStream>::deref;
104
105     // URLRegistrable
106     URLRegistry& registry() const override;
107
108     void addObserver(Observer*);
109     void removeObserver(Observer*);
110
111     void addTrackFromPlatform(Ref<MediaStreamTrack>&&);
112
113     Document* document() const;
114
115     // ActiveDOMObject API.
116     bool hasPendingActivity() const final;
117
118     enum class StreamModifier { DomAPI, Platform };
119     bool internalAddTrack(Ref<MediaStreamTrack>&&, StreamModifier);
120     WEBCORE_EXPORT bool internalRemoveTrack(const String&, StreamModifier);
121
122 protected:
123     MediaStream(ScriptExecutionContext&, const MediaStreamTrackVector&);
124     MediaStream(ScriptExecutionContext&, Ref<MediaStreamPrivate>&&);
125
126 #if !RELEASE_LOG_DISABLED
127     const Logger& logger() const final { return m_logger.get(); }
128     const void* logIdentifier() const final { return m_logIdentifier; }
129     WTFLogChannel& logChannel() const final;
130     const char* logClassName() const final { return "MediaStream"; }
131 #endif
132
133 private:
134
135     // EventTarget
136     void refEventTarget() final { ref(); }
137     void derefEventTarget() final { deref(); }
138
139     // MediaStreamTrack::Observer
140     void trackDidEnd() final;
141
142     // MediaStreamPrivate::Observer
143     void activeStatusChanged() final;
144     void didAddTrack(MediaStreamTrackPrivate&) final;
145     void didRemoveTrack(MediaStreamTrackPrivate&) final;
146     void characteristicsChanged() final;
147
148     MediaProducer::MediaStateFlags mediaState() const;
149
150     // MediaCanStartListener
151     void mediaCanStart(Document&) final;
152
153     // PlatformMediaSessionClient
154     PlatformMediaSession::MediaType mediaType() const final;
155     PlatformMediaSession::MediaType presentationType() const final;
156     PlatformMediaSession::CharacteristicsFlags characteristics() const final;
157     void mayResumePlayback(bool shouldResume) final;
158     void suspendPlayback() final;
159     bool canReceiveRemoteControlCommands() const final { return false; }
160     void didReceiveRemoteControlCommand(PlatformMediaSession::RemoteControlCommandType, const PlatformMediaSession::RemoteCommandArgument*) final { }
161     bool supportsSeeking() const final { return false; }
162     bool shouldOverrideBackgroundPlaybackRestriction(PlatformMediaSession::InterruptionType) const final { return false; }
163     String sourceApplicationIdentifier() const final;
164     bool canProduceAudio() const final;
165     Document* hostingDocument() const final { return document(); }
166     bool processingUserGestureForMedia() const final;
167
168     // ActiveDOMObject API.
169     void stop() final;
170     const char* activeDOMObjectName() const final;
171     bool canSuspendForDocumentSuspension() const final;
172
173     void updateActiveState();
174     void activityEventTimerFired();
175     void setIsActive(bool);
176     void statusDidChange();
177
178     MediaStreamTrackVector trackVectorForType(RealtimeMediaSource::Type) const;
179
180     Ref<MediaStreamPrivate> m_private;
181
182     HashMap<String, RefPtr<MediaStreamTrack>> m_trackSet;
183
184     Vector<Observer*> m_observers;
185     std::unique_ptr<PlatformMediaSession> m_mediaSession;
186
187     MediaProducer::MediaStateFlags m_state { MediaProducer::IsNotPlaying };
188
189 #if !RELEASE_LOG_DISABLED
190     Ref<Logger> m_logger;
191     const void* m_logIdentifier;
192 #endif
193
194     bool m_isActive { false };
195     bool m_isProducingData { false };
196     bool m_isWaitingUntilMediaCanStart { false };
197 };
198
199 } // namespace WebCore
200
201 #endif // ENABLE(MEDIA_STREAM)