Change all uses of FINAL to final now that all our compilers support it
[WebKit-https.git] / Source / WebCore / Modules / mediasource / MediaSource.h
1 /*
2  * Copyright (C) 2013 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef MediaSource_h
32 #define MediaSource_h
33
34 #if ENABLE(MEDIA_SOURCE)
35
36 #include "ActiveDOMObject.h"
37 #include "EventTarget.h"
38 #include "GenericEventQueue.h"
39 #include "HTMLMediaSource.h"
40 #include "MediaSourcePrivate.h"
41 #include "ScriptWrappable.h"
42 #include "SourceBuffer.h"
43 #include "SourceBufferList.h"
44 #include "URLRegistry.h"
45 #include <wtf/PassOwnPtr.h>
46 #include <wtf/RefCounted.h>
47 #include <wtf/Vector.h>
48
49 namespace WebCore {
50
51 class GenericEventQueue;
52
53 class MediaSource : public RefCounted<MediaSource>, public HTMLMediaSource, public ActiveDOMObject, public EventTargetWithInlineData, public ScriptWrappable {
54 public:
55     static const AtomicString& openKeyword();
56     static const AtomicString& closedKeyword();
57     static const AtomicString& endedKeyword();
58
59     static PassRefPtr<MediaSource> create(ScriptExecutionContext&);
60     virtual ~MediaSource();
61
62     void addedToRegistry();
63     void removedFromRegistry();
64     void openIfInEndedState();
65     bool isOpen() const;
66     void sourceBufferDidChangeAcitveState(SourceBuffer*, bool);
67     void streamEndedWithError(const AtomicString& error, ExceptionCode&);
68
69     // HTMLMediaSource
70     virtual bool attachToElement(HTMLMediaElement*) override;
71     virtual void setPrivateAndOpen(PassRef<MediaSourcePrivate>) override;
72     virtual void close() override;
73     virtual bool isClosed() const override;
74     virtual double duration() const override;
75     virtual PassRefPtr<TimeRanges> buffered() const override;
76     virtual void refHTMLMediaSource() override { ref(); }
77     virtual void derefHTMLMediaSource() override { deref(); }
78     virtual void monitorSourceBuffers() override;
79
80     void setDuration(double, ExceptionCode&);
81     const AtomicString& readyState() const { return m_readyState; }
82     void setReadyState(const AtomicString&);
83     void endOfStream(const AtomicString& error, ExceptionCode&);
84
85     HTMLMediaElement* mediaElement() const { return m_mediaElement; }
86
87     // MediaSource.idl methods
88     SourceBufferList* sourceBuffers() { return m_sourceBuffers.get(); }
89     SourceBufferList* activeSourceBuffers() { return m_activeSourceBuffers.get(); }
90     SourceBuffer* addSourceBuffer(const String& type, ExceptionCode&);
91     void removeSourceBuffer(SourceBuffer*, ExceptionCode&);
92     static bool isTypeSupported(const String& type);
93
94     // ActiveDOMObject interface
95     virtual bool hasPendingActivity() const override;
96     virtual void stop() override;
97
98     // EventTarget interface
99     virtual ScriptExecutionContext* scriptExecutionContext() const override final;
100     virtual void refEventTarget() override final { ref(); }
101     virtual void derefEventTarget() override final { deref(); }
102     virtual EventTargetInterface eventTargetInterface() const override;
103
104     // URLRegistrable interface
105     virtual URLRegistry& registry() const override;
106
107     using RefCounted<MediaSource>::ref;
108     using RefCounted<MediaSource>::deref;
109
110 protected:
111     explicit MediaSource(ScriptExecutionContext&);
112
113     void onReadyStateChange(const AtomicString& oldState, const AtomicString& newState);
114     Vector<RefPtr<TimeRanges>> activeRanges() const;
115
116     RefPtr<SourceBufferPrivate> createSourceBufferPrivate(const ContentType&, ExceptionCode&);
117     void scheduleEvent(const AtomicString& eventName);
118     GenericEventQueue& asyncEventQueue() { return m_asyncEventQueue; }
119
120     RefPtr<MediaSourcePrivate> m_private;
121     RefPtr<SourceBufferList> m_sourceBuffers;
122     RefPtr<SourceBufferList> m_activeSourceBuffers;
123     HTMLMediaElement* m_mediaElement;
124     AtomicString m_readyState;
125     GenericEventQueue m_asyncEventQueue;
126 };
127
128 }
129
130 #endif
131
132 #endif