Next batch of conversions to use C++ enum class instead of strings for enumerations
[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 #pragma once
32
33 #if ENABLE(MEDIA_SOURCE)
34
35 #include "ActiveDOMObject.h"
36 #include "EventTarget.h"
37 #include "GenericEventQueue.h"
38 #include "MediaSourcePrivate.h"
39 #include "MediaSourcePrivateClient.h"
40 #include "ScriptWrappable.h"
41 #include "SourceBuffer.h"
42 #include "SourceBufferList.h"
43 #include "URLRegistry.h"
44 #include <wtf/RefCounted.h>
45 #include <wtf/Vector.h>
46
47 namespace WebCore {
48
49 class GenericEventQueue;
50
51 enum class EndOfStreamError { Network, Decode };
52
53 class MediaSource : public MediaSourcePrivateClient, public ActiveDOMObject, public EventTargetWithInlineData, public URLRegistrable {
54 public:
55     static void setRegistry(URLRegistry*);
56     static MediaSource* lookup(const String& url) { return s_registry ? static_cast<MediaSource*>(s_registry->lookup(url)) : 0; }
57
58     static const AtomicString& openKeyword();
59     static const AtomicString& closedKeyword();
60     static const AtomicString& endedKeyword();
61
62     static Ref<MediaSource> create(ScriptExecutionContext&);
63     virtual ~MediaSource();
64
65     void addedToRegistry();
66     void removedFromRegistry();
67     void openIfInEndedState();
68     bool isOpen() const;
69     bool isClosed() const;
70     bool isEnded() const;
71     void sourceBufferDidChangeActiveState(SourceBuffer&, bool);
72     void streamEndedWithError(Optional<EndOfStreamError>);
73
74     // MediaSourcePrivateClient
75     void setPrivateAndOpen(Ref<MediaSourcePrivate>&&) override;
76     MediaTime duration() const override;
77     std::unique_ptr<PlatformTimeRanges> buffered() const override;
78     void seekToTime(const MediaTime&) override;
79
80     bool attachToElement(HTMLMediaElement*);
81     void close();
82     void monitorSourceBuffers();
83     bool isSeeking() const { return m_pendingSeekTime.isValid(); }
84     void completeSeek();
85
86     void setDuration(double, ExceptionCode&);
87     void setDurationInternal(const MediaTime&);
88     MediaTime currentTime() const;
89     const AtomicString& readyState() const { return m_readyState; }
90     void setReadyState(const AtomicString&);
91     void endOfStream(Optional<EndOfStreamError>, ExceptionCode&);
92
93     HTMLMediaElement* mediaElement() const { return m_mediaElement; }
94
95     // MediaSource.idl methods
96     SourceBufferList* sourceBuffers() { return m_sourceBuffers.get(); }
97     SourceBufferList* activeSourceBuffers() { return m_activeSourceBuffers.get(); }
98     SourceBuffer* addSourceBuffer(const String& type, ExceptionCode&);
99     void removeSourceBuffer(SourceBuffer&, ExceptionCode&);
100     static bool isTypeSupported(const String& type);
101
102     // EventTarget interface
103     ScriptExecutionContext* scriptExecutionContext() const final;
104     void refEventTarget() final { ref(); }
105     void derefEventTarget() final { deref(); }
106     EventTargetInterface eventTargetInterface() const override;
107
108     // URLRegistrable interface
109     URLRegistry& registry() const override;
110
111     using RefCounted<MediaSourcePrivateClient>::ref;
112     using RefCounted<MediaSourcePrivateClient>::deref;
113
114     // ActiveDOMObject API.
115     bool hasPendingActivity() const override;
116
117 protected:
118     explicit MediaSource(ScriptExecutionContext&);
119
120     // ActiveDOMObject API.
121     void stop() override;
122     bool canSuspendForDocumentSuspension() const override;
123     const char* activeDOMObjectName() const override;
124
125     void onReadyStateChange(const AtomicString& oldState, const AtomicString& newState);
126     Vector<PlatformTimeRanges> activeRanges() const;
127
128     RefPtr<SourceBufferPrivate> createSourceBufferPrivate(const ContentType&, ExceptionCode&);
129     void scheduleEvent(const AtomicString& eventName);
130     GenericEventQueue& asyncEventQueue() { return m_asyncEventQueue; }
131
132     void regenerateActiveSourceBuffers();
133
134     static URLRegistry* s_registry;
135
136     RefPtr<MediaSourcePrivate> m_private;
137     RefPtr<SourceBufferList> m_sourceBuffers;
138     RefPtr<SourceBufferList> m_activeSourceBuffers;
139     mutable std::unique_ptr<PlatformTimeRanges> m_buffered;
140     HTMLMediaElement* m_mediaElement;
141     MediaTime m_duration;
142     MediaTime m_pendingSeekTime;
143     AtomicString m_readyState;
144     GenericEventQueue m_asyncEventQueue;
145 };
146
147 }
148
149 #endif