[MediaStream] defer resolution of getUserMedia promise made in a background tab
[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-2015 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 #ifndef MediaStream_h
29 #define MediaStream_h
30
31 #if ENABLE(MEDIA_STREAM)
32
33 #include "ContextDestructionObserver.h"
34 #include "EventTarget.h"
35 #include "ExceptionBase.h"
36 #include "MediaCanStartListener.h"
37 #include "MediaProducer.h"
38 #include "MediaStreamPrivate.h"
39 #include "MediaStreamTrack.h"
40 #include "ScriptWrappable.h"
41 #include "Timer.h"
42 #include "URLRegistry.h"
43 #include <wtf/HashMap.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 ContextDestructionObserver
55     , public MediaStreamTrack::Observer
56     , public MediaStreamPrivate::Observer
57     , private MediaProducer
58     , private MediaCanStartListener
59     , public RefCounted<MediaStream> {
60 public:
61     class Observer {
62     public:
63         virtual ~Observer() { }
64         virtual void didAddOrRemoveTrack() = 0;
65     };
66
67     static Ref<MediaStream> create(ScriptExecutionContext&);
68     static Ref<MediaStream> create(ScriptExecutionContext&, MediaStream&);
69     static Ref<MediaStream> create(ScriptExecutionContext&, const MediaStreamTrackVector&);
70     static Ref<MediaStream> create(ScriptExecutionContext&, RefPtr<MediaStreamPrivate>&&);
71     virtual ~MediaStream();
72
73     String id() const { return m_private->id(); }
74
75     void addTrack(MediaStreamTrack&);
76     void removeTrack(MediaStreamTrack&);
77     MediaStreamTrack* getTrackById(String);
78
79     MediaStreamTrackVector getAudioTracks() const;
80     MediaStreamTrackVector getVideoTracks() const;
81     MediaStreamTrackVector getTracks() const;
82
83     RefPtr<MediaStream> clone();
84
85     bool active() const { return m_isActive; }
86     bool muted() const { return m_isMuted; }
87
88     MediaStreamPrivate* privateStream() const { return m_private.get(); }
89
90     void startProducingData();
91     void stopProducingData();
92
93     // EventTarget
94     EventTargetInterface eventTargetInterface() const final { return MediaStreamEventTargetInterfaceType; }
95     ScriptExecutionContext* scriptExecutionContext() const final { return ContextDestructionObserver::scriptExecutionContext(); }
96
97     using RefCounted<MediaStream>::ref;
98     using RefCounted<MediaStream>::deref;
99
100     // URLRegistrable
101     URLRegistry& registry() const override;
102
103     void addObserver(Observer*);
104     void removeObserver(Observer*);
105
106 protected:
107     MediaStream(ScriptExecutionContext&, const MediaStreamTrackVector&);
108     MediaStream(ScriptExecutionContext&, RefPtr<MediaStreamPrivate>&&);
109
110     // ContextDestructionObserver
111     void contextDestroyed() final;
112
113 private:
114     enum class StreamModifier { DomAPI, Platform };
115
116     // EventTarget
117     void refEventTarget() final { ref(); }
118     void derefEventTarget() final { deref(); }
119
120     // MediaStreamTrack::Observer
121     void trackDidEnd() final;
122
123     // MediaStreamPrivate::Observer
124     void activeStatusChanged() final;
125     void didAddTrack(MediaStreamTrackPrivate&) final;
126     void didRemoveTrack(MediaStreamTrackPrivate&) final;
127     void characteristicsChanged() final;
128
129     // MediaProducer
130     void pageMutedStateDidChange() final;
131     MediaProducer::MediaStateFlags mediaState() const final;
132
133     // MediaCanStartListener
134     void mediaCanStart(Document&) final;
135
136     bool internalAddTrack(Ref<MediaStreamTrack>&&, StreamModifier);
137     bool internalRemoveTrack(const String&, StreamModifier);
138
139     void scheduleActiveStateChange();
140     void activityEventTimerFired();
141     void setIsActive(bool);
142     void statusDidChange();
143
144     Document* document() const;
145
146     MediaStreamTrackVector trackVectorForType(RealtimeMediaSource::Type) const;
147
148     RefPtr<MediaStreamPrivate> m_private;
149
150     HashMap<String, RefPtr<MediaStreamTrack>> m_trackSet;
151
152     Timer m_activityEventTimer;
153     Vector<Ref<Event>> m_scheduledActivityEvents;
154
155     Vector<Observer*> m_observers;
156
157     bool m_isActive { false };
158     bool m_isMuted { true };
159     bool m_externallyMuted { false };
160     bool m_isWaitingUntilMediaCanStart { false };
161 };
162
163 } // namespace WebCore
164
165 #endif // ENABLE(MEDIA_STREAM)
166
167 #endif // MediaStream_h