Expose MediaStream methods to be used in the MediaStream Engine
[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 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 "MediaStreamPrivate.h"
37 #include "MediaStreamTrack.h"
38 #include "ScriptWrappable.h"
39 #include "Timer.h"
40 #include "URLRegistry.h"
41 #include <wtf/HashMap.h>
42 #include <wtf/RefCounted.h>
43 #include <wtf/RefPtr.h>
44
45 namespace WebCore {
46
47 class MediaStream final : public URLRegistrable, public ScriptWrappable, public MediaStreamPrivateClient, public EventTargetWithInlineData, public ContextDestructionObserver, public MediaStreamTrack::Observer {
48 public:
49     class Observer {
50     public:
51         virtual ~Observer() { }
52         virtual void didAddOrRemoveTrack() = 0;
53     };
54
55     static Ref<MediaStream> create(ScriptExecutionContext&);
56     static Ref<MediaStream> create(ScriptExecutionContext&, MediaStream*);
57     static Ref<MediaStream> create(ScriptExecutionContext&, const Vector<RefPtr<MediaStreamTrack>>&);
58     static Ref<MediaStream> create(ScriptExecutionContext&, RefPtr<MediaStreamPrivate>&&);
59     virtual ~MediaStream();
60
61     String id() const { return m_private->id(); }
62
63     void addTrack(RefPtr<MediaStreamTrack>&&);
64     void removeTrack(MediaStreamTrack*);
65     MediaStreamTrack* getTrackById(String);
66
67     Vector<RefPtr<MediaStreamTrack>> getAudioTracks() override final;
68     Vector<RefPtr<MediaStreamTrack>> getVideoTracks() override final;
69     Vector<RefPtr<MediaStreamTrack>> getTracks() const;
70
71     RefPtr<MediaStream> clone();
72
73     bool active() const { return m_isActive; }
74
75     MediaStreamPrivate* privateStream() const { return m_private.get(); }
76
77     // EventTarget
78     virtual EventTargetInterface eventTargetInterface() const final { return MediaStreamEventTargetInterfaceType; }
79     virtual ScriptExecutionContext* scriptExecutionContext() const final { return ContextDestructionObserver::scriptExecutionContext(); }
80
81     using RefCounted<MediaStreamPrivateClient>::ref;
82     using RefCounted<MediaStreamPrivateClient>::deref;
83
84     // URLRegistrable
85     virtual URLRegistry& registry() const override;
86
87     void addObserver(Observer*);
88     void removeObserver(Observer*);
89
90 protected:
91     MediaStream(ScriptExecutionContext&, const Vector<RefPtr<MediaStreamTrack>>&);
92     MediaStream(ScriptExecutionContext&, RefPtr<MediaStreamPrivate>&&);
93
94     // ContextDestructionObserver
95     virtual void contextDestroyed() override final;
96
97 private:
98     enum class StreamModifier { DomAPI, Platform };
99
100     // EventTarget
101     virtual void refEventTarget() override final { ref(); }
102     virtual void derefEventTarget() override final { deref(); }
103
104     // MediaStreamTrack::Observer
105     virtual void trackDidEnd() override final;
106
107     // MediaStreamPrivateClient
108     virtual void activeStatusChanged() override final;
109     virtual void didAddTrackToPrivate(MediaStreamTrackPrivate&) override final;
110     virtual void didRemoveTrackFromPrivate(MediaStreamTrackPrivate&) override final;
111
112     bool internalAddTrack(RefPtr<MediaStreamTrack>&&, StreamModifier);
113     bool internalRemoveTrack(RefPtr<MediaStreamTrack>&&, StreamModifier);
114
115     void scheduleActiveStateChange();
116     void activityEventTimerFired();
117
118     Vector<RefPtr<MediaStreamTrack>> trackVectorForType(RealtimeMediaSource::Type) const;
119
120     RefPtr<MediaStreamPrivate> m_private;
121
122     bool m_isActive;
123     HashMap<String, RefPtr<MediaStreamTrack>> m_trackSet;
124
125     Timer m_activityEventTimer;
126     Vector<RefPtr<Event>> m_scheduledActivityEvents;
127
128     Vector<Observer*> m_observers;
129 };
130
131 } // namespace WebCore
132
133 #endif // ENABLE(MEDIA_STREAM)
134
135 #endif // MediaStream_h