Removing MediaStreamTrackVector and MediaStreamSourceVector typedefs
[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  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
22  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef MediaStream_h
28 #define MediaStream_h
29
30 #if ENABLE(MEDIA_STREAM)
31
32 #include "ContextDestructionObserver.h"
33 #include "EventTarget.h"
34 #include "ExceptionBase.h"
35 #include "MediaStreamDescriptor.h"
36 #include "MediaStreamTrack.h"
37 #include "ScriptWrappable.h"
38 #include "Timer.h"
39 #include "URLRegistry.h"
40 #include <wtf/RefCounted.h>
41 #include <wtf/RefPtr.h>
42
43 namespace WebCore {
44
45 class MediaStreamCenter;
46
47 class MediaStream FINAL : public RefCounted<MediaStream>, public URLRegistrable, public ScriptWrappable, public MediaStreamDescriptorClient, public EventTargetWithInlineData, public ContextDestructionObserver {
48 public:
49     static PassRefPtr<MediaStream> create(ScriptExecutionContext&);
50     static PassRefPtr<MediaStream> create(ScriptExecutionContext&, PassRefPtr<MediaStream>);
51     static PassRefPtr<MediaStream> create(ScriptExecutionContext&, const Vector<RefPtr<MediaStreamTrack>>&);
52     static PassRefPtr<MediaStream> create(ScriptExecutionContext&, PassRefPtr<MediaStreamDescriptor>);
53     virtual ~MediaStream();
54
55     String id() const { return m_descriptor->id(); }
56
57     void addTrack(PassRefPtr<MediaStreamTrack>, ExceptionCode&);
58     void removeTrack(PassRefPtr<MediaStreamTrack>, ExceptionCode&);
59     MediaStreamTrack* getTrackById(String);
60
61     Vector<RefPtr<MediaStreamTrack>> getAudioTracks() const { return m_audioTracks; }
62     Vector<RefPtr<MediaStreamTrack>> getVideoTracks() const { return m_videoTracks; }
63
64     bool ended() const;
65     void setEnded();
66     PassRefPtr<MediaStream> clone();
67
68     DEFINE_ATTRIBUTE_EVENT_LISTENER(ended);
69     DEFINE_ATTRIBUTE_EVENT_LISTENER(addtrack);
70     DEFINE_ATTRIBUTE_EVENT_LISTENER(removetrack);
71
72     MediaStreamDescriptor* descriptor() const { return m_descriptor.get(); }
73
74     // EventTarget
75     virtual EventTargetInterface eventTargetInterface() const FINAL { return MediaStreamEventTargetInterfaceType; }
76     virtual ScriptExecutionContext* scriptExecutionContext() const FINAL { return ContextDestructionObserver::scriptExecutionContext(); }
77
78     using RefCounted<MediaStream>::ref;
79     using RefCounted<MediaStream>::deref;
80
81     // URLRegistrable
82     virtual URLRegistry& registry() const OVERRIDE;
83
84 protected:
85     MediaStream(ScriptExecutionContext&, PassRefPtr<MediaStreamDescriptor>);
86
87     // ContextDestructionObserver
88     virtual void contextDestroyed() OVERRIDE FINAL;
89
90 private:
91     // EventTarget
92     virtual void refEventTarget() OVERRIDE FINAL { ref(); }
93     virtual void derefEventTarget() OVERRIDE FINAL { deref(); }
94
95     // MediaStreamDescriptorClient
96     virtual void trackDidEnd() OVERRIDE FINAL;
97     virtual void streamDidEnd() OVERRIDE FINAL;
98     virtual void addRemoteSource(MediaStreamSource*) OVERRIDE FINAL;
99     virtual void removeRemoteSource(MediaStreamSource*) OVERRIDE FINAL;
100     virtual void addRemoteTrack(MediaStreamTrackPrivate*) OVERRIDE FINAL;
101     virtual void removeRemoteTrack(MediaStreamTrackPrivate*) OVERRIDE FINAL;
102
103     bool removeTrack(PassRefPtr<MediaStreamTrack>);
104     bool addTrack(PassRefPtr<MediaStreamTrack>);
105
106     bool haveTrackWithSource(PassRefPtr<MediaStreamSource>);
107
108     void scheduleDispatchEvent(PassRefPtr<Event>);
109     void scheduledEventTimerFired(Timer<MediaStream>*);
110
111     void cloneMediaStreamTrackVector(Vector<RefPtr<MediaStreamTrack>>&, const Vector<RefPtr<MediaStreamTrack>>&);
112
113     Vector<RefPtr<MediaStreamTrack>>* trackVectorForType(MediaStreamSource::Type);
114
115     RefPtr<MediaStreamDescriptor> m_descriptor;
116     Vector<RefPtr<MediaStreamTrack>> m_audioTracks;
117     Vector<RefPtr<MediaStreamTrack>> m_videoTracks;
118
119     Timer<MediaStream> m_scheduledEventTimer;
120     Vector<RefPtr<Event>> m_scheduledEvents;
121 };
122
123 typedef Vector<RefPtr<MediaStream>> MediaStreamVector;
124
125 } // namespace WebCore
126
127 #endif // ENABLE(MEDIA_STREAM)
128
129 #endif // MediaStream_h