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