This source file includes following definitions.
- subtitlesKeyword
- captionsKeyword
- descriptionsKeyword
- chaptersKeyword
- metadataKeyword
- disabledKeyword
- hiddenKeyword
- showingKeyword
- m_hasBeenConfigured
- isValidKindKeyword
- setTrackList
- setKind
- setMode
- cues
- removeAllCues
- activeCues
- addCue
- removeCue
- ensureVTTRegionList
- regions
- addRegion
- removeRegion
- cueWillChange
- cueDidChange
- trackIndex
- invalidateTrackIndex
- isRendered
- ensureTextTrackCueList
- trackIndexRelativeToRenderedTracks
- interfaceName
- executionContext
- mediaElement
#include "config.h"
#include "core/html/track/TextTrack.h"
#include "RuntimeEnabledFeatures.h"
#include "bindings/v8/ExceptionState.h"
#include "bindings/v8/ExceptionStatePlaceholder.h"
#include "core/dom/Document.h"
#include "core/dom/ExceptionCode.h"
#include "core/html/HTMLMediaElement.h"
#include "core/html/track/TextTrackCueList.h"
#include "core/html/track/TextTrackList.h"
#include "core/html/track/vtt/VTTRegion.h"
#include "core/html/track/vtt/VTTRegionList.h"
namespace WebCore {
static const int invalidTrackIndex = -1;
const AtomicString& TextTrack::subtitlesKeyword()
{
DEFINE_STATIC_LOCAL(const AtomicString, subtitles, ("subtitles", AtomicString::ConstructFromLiteral));
return subtitles;
}
const AtomicString& TextTrack::captionsKeyword()
{
DEFINE_STATIC_LOCAL(const AtomicString, captions, ("captions", AtomicString::ConstructFromLiteral));
return captions;
}
const AtomicString& TextTrack::descriptionsKeyword()
{
DEFINE_STATIC_LOCAL(const AtomicString, descriptions, ("descriptions", AtomicString::ConstructFromLiteral));
return descriptions;
}
const AtomicString& TextTrack::chaptersKeyword()
{
DEFINE_STATIC_LOCAL(const AtomicString, chapters, ("chapters", AtomicString::ConstructFromLiteral));
return chapters;
}
const AtomicString& TextTrack::metadataKeyword()
{
DEFINE_STATIC_LOCAL(const AtomicString, metadata, ("metadata", AtomicString::ConstructFromLiteral));
return metadata;
}
const AtomicString& TextTrack::disabledKeyword()
{
DEFINE_STATIC_LOCAL(const AtomicString, open, ("disabled", AtomicString::ConstructFromLiteral));
return open;
}
const AtomicString& TextTrack::hiddenKeyword()
{
DEFINE_STATIC_LOCAL(const AtomicString, closed, ("hidden", AtomicString::ConstructFromLiteral));
return closed;
}
const AtomicString& TextTrack::showingKeyword()
{
DEFINE_STATIC_LOCAL(const AtomicString, ended, ("showing", AtomicString::ConstructFromLiteral));
return ended;
}
TextTrack::TextTrack(Document& document, const AtomicString& kind, const AtomicString& label, const AtomicString& language, const AtomicString& id, TextTrackType type)
: TrackBase(TrackBase::TextTrack, label, language, id)
, m_cues(nullptr)
, m_regions(nullptr)
, m_document(&document)
, m_trackList(0)
, m_mode(disabledKeyword())
, m_trackType(type)
, m_readinessState(NotLoaded)
, m_trackIndex(invalidTrackIndex)
, m_renderedTrackIndex(invalidTrackIndex)
, m_hasBeenConfigured(false)
{
ScriptWrappable::init(this);
setKind(kind);
}
TextTrack::~TextTrack()
{
ASSERT(!m_trackList);
if (m_cues) {
for (size_t i = 0; i < m_cues->length(); ++i)
m_cues->item(i)->setTrack(0);
}
if (m_regions) {
for (size_t i = 0; i < m_regions->length(); ++i)
m_regions->item(i)->setTrack(0);
}
}
bool TextTrack::isValidKindKeyword(const AtomicString& value)
{
if (value == subtitlesKeyword())
return true;
if (value == captionsKeyword())
return true;
if (value == descriptionsKeyword())
return true;
if (value == chaptersKeyword())
return true;
if (value == metadataKeyword())
return true;
return false;
}
void TextTrack::setTrackList(TextTrackList* trackList)
{
if (!trackList && mediaElement() && m_cues)
mediaElement()->textTrackRemoveCues(this, m_cues.get());
m_trackList = trackList;
invalidateTrackIndex();
}
void TextTrack::setKind(const AtomicString& newKind)
{
AtomicString oldKind = kind();
TrackBase::setKind(newKind);
if (mediaElement() && oldKind != kind())
mediaElement()->textTrackKindChanged(this);
}
void TextTrack::setMode(const AtomicString& mode)
{
ASSERT(mode == disabledKeyword() || mode == hiddenKeyword() || mode == showingKeyword());
if (m_mode == mode)
return;
if (mode == disabledKeyword() && mediaElement() && m_cues)
mediaElement()->textTrackRemoveCues(this, m_cues.get());
if (mode != showingKeyword() && m_cues)
for (size_t i = 0; i < m_cues->length(); ++i)
m_cues->item(i)->removeDisplayTree();
m_mode = mode;
if (mediaElement())
mediaElement()->textTrackModeChanged(this);
}
TextTrackCueList* TextTrack::cues()
{
if (m_mode != disabledKeyword())
return ensureTextTrackCueList();
return 0;
}
void TextTrack::removeAllCues()
{
if (!m_cues)
return;
if (mediaElement())
mediaElement()->textTrackRemoveCues(this, m_cues.get());
for (size_t i = 0; i < m_cues->length(); ++i)
m_cues->item(i)->setTrack(0);
m_cues = nullptr;
}
TextTrackCueList* TextTrack::activeCues() const
{
if (m_cues && m_mode != disabledKeyword())
return m_cues->activeCues();
return 0;
}
void TextTrack::addCue(PassRefPtr<TextTrackCue> prpCue)
{
if (!prpCue)
return;
RefPtr<TextTrackCue> cue = prpCue;
if (std::isnan(cue->startTime()) || std::isnan(cue->endTime()) || cue->startTime() < 0 || cue->endTime() < 0)
return;
TextTrack* cueTrack = cue->track();
if (cueTrack && cueTrack != this)
cueTrack->removeCue(cue.get(), ASSERT_NO_EXCEPTION);
cue->setTrack(this);
ensureTextTrackCueList()->add(cue);
if (mediaElement())
mediaElement()->textTrackAddCue(this, cue.get());
}
void TextTrack::removeCue(TextTrackCue* cue, ExceptionState& exceptionState)
{
if (!cue)
return;
if (cue->track() != this) {
exceptionState.throwDOMException(NotFoundError, "The specified cue is not listed in the TextTrack's list of cues.");
return;
}
if (!m_cues || !m_cues->remove(cue)) {
exceptionState.throwDOMException(InvalidStateError, "Failed to remove the specified cue.");
return;
}
cue->setTrack(0);
if (mediaElement())
mediaElement()->textTrackRemoveCue(this, cue);
}
VTTRegionList* TextTrack::ensureVTTRegionList()
{
if (!m_regions)
m_regions = VTTRegionList::create();
return m_regions.get();
}
VTTRegionList* TextTrack::regions()
{
if (RuntimeEnabledFeatures::webVTTRegionsEnabled() && m_mode != disabledKeyword())
return ensureVTTRegionList();
return 0;
}
void TextTrack::addRegion(PassRefPtr<VTTRegion> prpRegion)
{
if (!prpRegion)
return;
RefPtr<VTTRegion> region = prpRegion;
VTTRegionList* regionList = ensureVTTRegionList();
TextTrack* regionTrack = region->track();
if (regionTrack && regionTrack != this)
regionTrack->removeRegion(region.get(), ASSERT_NO_EXCEPTION);
VTTRegion* existingRegion = regionList->getRegionById(region->id());
if (existingRegion) {
existingRegion->updateParametersFromRegion(region.get());
return;
}
region->setTrack(this);
regionList->add(region);
}
void TextTrack::removeRegion(VTTRegion* region, ExceptionState &exceptionState)
{
if (!region)
return;
if (region->track() != this) {
exceptionState.throwDOMException(NotFoundError, "The specified region is not listed in the TextTrack's list of regions.");
return;
}
if (!m_regions || !m_regions->remove(region)) {
exceptionState.throwDOMException(InvalidStateError, "Failed to remove the specified region.");
return;
}
region->setTrack(0);
}
void TextTrack::cueWillChange(TextTrackCue* cue)
{
if (!mediaElement())
return;
mediaElement()->textTrackRemoveCue(this, cue);
}
void TextTrack::cueDidChange(TextTrackCue* cue)
{
if (!mediaElement())
return;
ensureTextTrackCueList()->updateCueIndex(cue);
mediaElement()->textTrackAddCue(this, cue);
}
int TextTrack::trackIndex()
{
ASSERT(m_trackList);
if (m_trackIndex == invalidTrackIndex)
m_trackIndex = m_trackList->getTrackIndex(this);
return m_trackIndex;
}
void TextTrack::invalidateTrackIndex()
{
m_trackIndex = invalidTrackIndex;
m_renderedTrackIndex = invalidTrackIndex;
}
bool TextTrack::isRendered()
{
if (kind() != captionsKeyword() && kind() != subtitlesKeyword())
return false;
if (m_mode != showingKeyword())
return false;
return true;
}
TextTrackCueList* TextTrack::ensureTextTrackCueList()
{
if (!m_cues)
m_cues = TextTrackCueList::create();
return m_cues.get();
}
int TextTrack::trackIndexRelativeToRenderedTracks()
{
ASSERT(m_trackList);
if (m_renderedTrackIndex == invalidTrackIndex)
m_renderedTrackIndex = m_trackList->getTrackIndexRelativeToRenderedTracks(this);
return m_renderedTrackIndex;
}
const AtomicString& TextTrack::interfaceName() const
{
return EventTargetNames::TextTrack;
}
ExecutionContext* TextTrack::executionContext() const
{
return m_document;
}
HTMLMediaElement* TextTrack::mediaElement()
{
return m_trackList ? m_trackList->owner() : 0;
}
}