| /* |
| * Copyright (C) 2011 Google Inc. All rights reserved. |
| * Copyright (C) 2011, 2012, 2013 Apple 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 |
| |
| #include "bindings/v8/ScriptWrappable.h" |
| #include "core/html/track/TrackBase.h" |
| #include "wtf/text/WTFString.h" |
| |
| namespace WebCore { |
| |
| class ExceptionState; |
| class HTMLMediaElement; |
| class TextTrack; |
| class TextTrackCue; |
| class TextTrackCueList; |
| #if ENABLE(WEBVTT_REGIONS) |
| class TextTrackRegion; |
| class TextTrackRegionList; |
| #endif |
| |
| 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 ScriptWrappable { |
| public: |
| static PassRefPtr<TextTrack> create(ExecutionContext* context, TextTrackClient* client, const AtomicString& kind, const AtomicString& label, const AtomicString& 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; } |
| |
| AtomicString kind() const { return m_kind; } |
| void setKind(const AtomicString&); |
| |
| static const AtomicString& subtitlesKeyword(); |
| static const AtomicString& captionsKeyword(); |
| static const AtomicString& descriptionsKeyword(); |
| static const AtomicString& chaptersKeyword(); |
| static const AtomicString& metadataKeyword(); |
| static bool isValidKindKeyword(const AtomicString&); |
| |
| AtomicString label() const { return m_label; } |
| void setLabel(const AtomicString& label) { m_label = label; } |
| |
| AtomicString language() const { return m_language; } |
| void setLanguage(const AtomicString& language) { m_language = language; } |
| |
| static const AtomicString& disabledKeyword(); |
| static const AtomicString& hiddenKeyword(); |
| static const AtomicString& showingKeyword(); |
| |
| AtomicString mode() const { return m_mode; } |
| virtual void setMode(const AtomicString&); |
| |
| 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; |
| |
| void clearClient() { m_client = 0; } |
| TextTrackClient* client() { return m_client; } |
| |
| void addCue(PassRefPtr<TextTrackCue>); |
| void removeCue(TextTrackCue*, ExceptionState&); |
| bool hasCue(TextTrackCue*); |
| |
| #if ENABLE(WEBVTT_REGIONS) |
| TextTrackRegionList* regions(); |
| void addRegion(PassRefPtr<TextTrackRegion>); |
| void removeRegion(TextTrackRegion*, ExceptionState&); |
| #endif |
| |
| void cueWillChange(TextTrackCue*); |
| void cueDidChange(TextTrackCue*); |
| |
| DEFINE_ATTRIBUTE_EVENT_LISTENER(cuechange); |
| |
| enum TextTrackType { TrackElement, AddTrack, InBand }; |
| TextTrackType trackType() const { return m_trackType; } |
| |
| virtual bool isClosedCaptions() const { return false; } |
| |
| virtual bool containsOnlyForcedSubtitles() const { return false; } |
| virtual bool isMainProgramContent() const; |
| virtual bool isEasyToRead() const { return false; } |
| |
| int trackIndex(); |
| void invalidateTrackIndex(); |
| |
| bool isRendered(); |
| int trackIndexRelativeToRenderedTracks(); |
| |
| bool hasBeenConfigured() const { return m_hasBeenConfigured; } |
| void setHasBeenConfigured(bool flag) { m_hasBeenConfigured = flag; } |
| |
| virtual bool isDefault() const { return false; } |
| virtual void setIsDefault(bool) { } |
| |
| void removeAllCues(); |
| |
| protected: |
| TextTrack(ExecutionContext*, TextTrackClient*, const AtomicString& kind, const AtomicString& label, const AtomicString& language, TextTrackType); |
| #if ENABLE(WEBVTT_REGIONS) |
| TextTrackRegionList* regionList(); |
| #endif |
| |
| RefPtr<TextTrackCueList> m_cues; |
| |
| private: |
| |
| #if ENABLE(WEBVTT_REGIONS) |
| TextTrackRegionList* ensureTextTrackRegionList(); |
| RefPtr<TextTrackRegionList> m_regions; |
| #endif |
| |
| TextTrackCueList* ensureTextTrackCueList(); |
| |
| HTMLMediaElement* m_mediaElement; |
| AtomicString m_kind; |
| AtomicString m_label; |
| AtomicString m_language; |
| AtomicString m_mode; |
| TextTrackClient* m_client; |
| TextTrackType m_trackType; |
| ReadinessState m_readinessState; |
| int m_trackIndex; |
| int m_renderedTrackIndex; |
| bool m_hasBeenConfigured; |
| }; |
| |
| } // namespace WebCore |
| |
| #endif |