1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
/*
* 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 "core/events/EventTarget.h"
#include "core/html/track/TrackBase.h"
#include "platform/heap/Handle.h"
#include "wtf/text/WTFString.h"
namespace blink {
class ExceptionState;
class HTMLMediaElement;
class TextTrack;
class TextTrackCue;
class TextTrackCueList;
class TextTrackList;
class VTTRegion;
class VTTRegionList;
class TextTrack : public EventTargetWithInlineData, public TrackBase {
DEFINE_WRAPPERTYPEINFO();
REFCOUNTED_EVENT_TARGET(TrackBase);
WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(TextTrack);
public:
static PassRefPtrWillBeRawPtr<TextTrack> create(const AtomicString& kind, const AtomicString& label, const AtomicString& language)
{
return adoptRefWillBeNoop(new TextTrack(kind, label, language, emptyAtom, AddTrack));
}
virtual ~TextTrack();
virtual void setTrackList(TextTrackList*);
TextTrackList* trackList() { return m_trackList; }
virtual void setKind(const AtomicString&) override;
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&);
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;
HTMLMediaElement* mediaElement() const;
Node* owner() const;
void addCue(PassRefPtrWillBeRawPtr<TextTrackCue>);
void removeCue(TextTrackCue*, ExceptionState&);
VTTRegionList* regions();
void addRegion(PassRefPtrWillBeRawPtr<VTTRegion>);
void removeRegion(VTTRegion*, ExceptionState&);
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();
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();
// EventTarget methods
virtual const AtomicString& interfaceName() const override;
virtual ExecutionContext* executionContext() const override;
virtual void trace(Visitor*) override;
protected:
TextTrack(const AtomicString& kind, const AtomicString& label, const AtomicString& language, const AtomicString& id, TextTrackType);
virtual bool isValidKind(const AtomicString& kind) const override { return isValidKindKeyword(kind); }
virtual AtomicString defaultKind() const override { return subtitlesKeyword(); }
RefPtrWillBeMember<TextTrackCueList> m_cues;
private:
VTTRegionList* ensureVTTRegionList();
RefPtrWillBeMember<VTTRegionList> m_regions;
TextTrackCueList* ensureTextTrackCueList();
RawPtrWillBeMember<TextTrackList> m_trackList;
AtomicString m_mode;
TextTrackType m_trackType;
ReadinessState m_readinessState;
int m_trackIndex;
int m_renderedTrackIndex;
bool m_hasBeenConfigured;
};
DEFINE_TRACK_TYPE_CASTS(TextTrack, TrackBase::TextTrack);
} // namespace blink
#endif // TextTrack_h
|