[MediaStream] 'get' prefix is missing for capabilities and constraints.
[WebKit-https.git] / Source / WebCore / Modules / mediastream / MediaStream.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2011 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/RefCounted.h>
42 #include <wtf/RefPtr.h>
43
44 namespace WebCore {
45
46 class MediaStreamCenter;
47
48 class MediaStream final : public RefCounted<MediaStream>, public URLRegistrable, public ScriptWrappable, public MediaStreamPrivateClient, public EventTargetWithInlineData, public ContextDestructionObserver {
49 public:
50     class Observer {
51     public:
52         virtual void didAddOrRemoveTrack() = 0;
53     };
54
55     static PassRefPtr<MediaStream> create(ScriptExecutionContext&);
56     static PassRefPtr<MediaStream> create(ScriptExecutionContext&, PassRefPtr<MediaStream>);
57     static PassRefPtr<MediaStream> create(ScriptExecutionContext&, const Vector<RefPtr<MediaStreamTrack>>&);
58     static PassRefPtr<MediaStream> create(ScriptExecutionContext&, PassRefPtr<MediaStreamPrivate>);
59     virtual ~MediaStream();
60
61     String id() const { return m_private->id(); }
62
63     void addTrack(PassRefPtr<MediaStreamTrack>, ExceptionCode&);
64     void removeTrack(PassRefPtr<MediaStreamTrack>, ExceptionCode&);
65     MediaStreamTrack* getTrackById(String);
66
67     Vector<RefPtr<MediaStreamTrack>> getAudioTracks() const { return m_audioTracks; }
68     Vector<RefPtr<MediaStreamTrack>> getVideoTracks() const { return m_videoTracks; }
69
70     PassRefPtr<MediaStream> clone();
71
72     DEFINE_ATTRIBUTE_EVENT_LISTENER(addtrack);
73     DEFINE_ATTRIBUTE_EVENT_LISTENER(removetrack);
74
75     bool active() const;
76     void setActive(bool);
77
78     DEFINE_ATTRIBUTE_EVENT_LISTENER(active);
79     DEFINE_ATTRIBUTE_EVENT_LISTENER(inactive);
80
81     MediaStreamPrivate* privateStream() const { return m_private.get(); }
82
83     // EventTarget
84     virtual EventTargetInterface eventTargetInterface() const final { return MediaStreamEventTargetInterfaceType; }
85     virtual ScriptExecutionContext* scriptExecutionContext() const final { return ContextDestructionObserver::scriptExecutionContext(); }
86
87     using RefCounted<MediaStream>::ref;
88     using RefCounted<MediaStream>::deref;
89
90     // URLRegistrable
91     virtual URLRegistry& registry() const override;
92
93     void addObserver(Observer*);
94     void removeObserver(Observer*);
95
96 protected:
97     MediaStream(ScriptExecutionContext&, PassRefPtr<MediaStreamPrivate>);
98
99     // ContextDestructionObserver
100     virtual void contextDestroyed() override final;
101
102 private:
103     // EventTarget
104     virtual void refEventTarget() override final { ref(); }
105     virtual void derefEventTarget() override final { deref(); }
106
107     // MediaStreamPrivateClient
108     virtual void trackDidEnd() override final;
109     virtual void setStreamIsActive(bool) override final;
110     virtual void addRemoteSource(MediaStreamSource*) override final;
111     virtual void removeRemoteSource(MediaStreamSource*) override final;
112     virtual void addRemoteTrack(MediaStreamTrackPrivate*) override final;
113     virtual void removeRemoteTrack(MediaStreamTrackPrivate*) override final;
114
115     bool removeTrack(PassRefPtr<MediaStreamTrack>);
116     bool addTrack(PassRefPtr<MediaStreamTrack>);
117
118     bool haveTrackWithSource(PassRefPtr<MediaStreamSource>);
119
120     void scheduleDispatchEvent(PassRefPtr<Event>);
121     void scheduledEventTimerFired(Timer<MediaStream>*);
122
123     void cloneMediaStreamTrackVector(Vector<RefPtr<MediaStreamTrack>>&, const Vector<RefPtr<MediaStreamTrack>>&);
124
125     Vector<RefPtr<MediaStreamTrack>>* trackVectorForType(MediaStreamSource::Type);
126
127     RefPtr<MediaStreamPrivate> m_private;
128     Vector<RefPtr<MediaStreamTrack>> m_audioTracks;
129     Vector<RefPtr<MediaStreamTrack>> m_videoTracks;
130
131     Timer<MediaStream> m_scheduledEventTimer;
132     Vector<RefPtr<Event>> m_scheduledEvents;
133
134     Vector<Observer*> m_observers;
135 };
136
137 } // namespace WebCore
138
139 #endif // ENABLE(MEDIA_STREAM)
140
141 #endif // MediaStream_h