diff options
Diffstat (limited to 'Source/WebCore/html/track/TextTrack.h')
-rw-r--r-- | Source/WebCore/html/track/TextTrack.h | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/Source/WebCore/html/track/TextTrack.h b/Source/WebCore/html/track/TextTrack.h new file mode 100644 index 000000000..9a8eb8bb4 --- /dev/null +++ b/Source/WebCore/html/track/TextTrack.h @@ -0,0 +1,137 @@ +/* + * Copyright (C) 2011 Google Inc. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY + * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef TextTrack_h +#define TextTrack_h + +#if ENABLE(VIDEO_TRACK) + +#include "ExceptionCode.h" +#include "TrackBase.h" +#include <wtf/PassOwnPtr.h> +#include <wtf/RefCounted.h> +#include <wtf/text/WTFString.h> + +namespace WebCore { + +class HTMLMediaElement; +class TextTrack; +class TextTrackCue; +class TextTrackCueList; + +class TextTrackClient { +public: + virtual ~TextTrackClient() { } + virtual void textTrackKindChanged(TextTrack*) = 0; + virtual void textTrackModeChanged(TextTrack*) = 0; + virtual void textTrackAddCues(TextTrack*, const TextTrackCueList*) = 0; + virtual void textTrackRemoveCues(TextTrack*, const TextTrackCueList*) = 0; + virtual void textTrackAddCue(TextTrack*, PassRefPtr<TextTrackCue>) = 0; + virtual void textTrackRemoveCue(TextTrack*, PassRefPtr<TextTrackCue>) = 0; +}; + +class TextTrack : public TrackBase { +public: + static PassRefPtr<TextTrack> create(ScriptExecutionContext* context, TextTrackClient* client, const String& kind, const String& label, const String& language) + { + return adoptRef(new TextTrack(context, client, kind, label, language, AddTrack)); + } + virtual ~TextTrack(); + + void setMediaElement(HTMLMediaElement* element) { m_mediaElement = element; } + HTMLMediaElement* mediaElement() { return m_mediaElement; } + + String kind() const { return m_kind; } + void setKind(const String&); + + static const AtomicString& subtitlesKeyword(); + static const AtomicString& captionsKeyword(); + static const AtomicString& descriptionsKeyword(); + static const AtomicString& chaptersKeyword(); + static const AtomicString& metadataKeyword(); + static bool isValidKindKeyword(const String&); + + String label() const { return m_label; } + void setLabel(const String& label) { m_label = label; } + + String language() const { return m_language; } + void setLanguage(const String& language) { m_language = language; } + + enum Mode { DISABLED = 0, HIDDEN = 1, SHOWING = 2 }; + Mode mode() const; + void setMode(unsigned short, ExceptionCode&); + + bool showingByDefault() const { return m_showingByDefault; } + void setShowingByDefault(bool showing) { m_showingByDefault = showing; } + + enum ReadinessState { NotLoaded = 0, Loading = 1, Loaded = 2, FailedToLoad = 3 }; + ReadinessState readinessState() const { return m_readinessState; } + void setReadinessState(ReadinessState state) { m_readinessState = state; } + + TextTrackCueList* cues(); + TextTrackCueList* activeCues() const; + + virtual void clearClient() { m_client = 0; } + TextTrackClient* client() { return m_client; } + + void addCue(PassRefPtr<TextTrackCue>, ExceptionCode&); + void removeCue(TextTrackCue*, ExceptionCode&); + + virtual void fireCueChangeEvent() { }; + + void cueWillChange(TextTrackCue*); + void cueDidChange(TextTrackCue*); + + DEFINE_ATTRIBUTE_EVENT_LISTENER(cuechange); + + enum TextTrackType { TrackElement, AddTrack, InBand }; + TextTrackType trackType() const { return m_trackType; } + + int trackIndex(); + void invalidateTrackIndex(); + +protected: + TextTrack(ScriptExecutionContext*, TextTrackClient*, const String& kind, const String& label, const String& language, TextTrackType); + + RefPtr<TextTrackCueList> m_cues; + +private: + TextTrackCueList* ensureTextTrackCueList(); + HTMLMediaElement* m_mediaElement; + String m_kind; + String m_label; + String m_language; + Mode m_mode; + TextTrackClient* m_client; + TextTrackType m_trackType; + ReadinessState m_readinessState; + bool m_showingByDefault; + int m_trackIndex; +}; + +} // namespace WebCore + +#endif +#endif |