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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
|
/*
* Copyright (C) 2011 Google Inc. All rights reserved.
* Copyright (C) 2012-2020 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:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * 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.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "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 THE COPYRIGHT
* OWNER 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.
*/
#pragma once
#if ENABLE(VIDEO)
#include "ActiveDOMObject.h"
#include "DocumentFragment.h"
#include "HTMLElement.h"
#include <wtf/JSONValues.h>
#include <wtf/MediaTime.h>
namespace WebCore {
class SpeechSynthesis;
class TextTrack;
class TextTrackCue;
class TextTrackCueBox : public HTMLElement {
WTF_MAKE_ISO_ALLOCATED(TextTrackCueBox);
public:
static Ref<TextTrackCueBox> create(Document&, TextTrackCue&);
TextTrackCue* getCue() const;
virtual void applyCSSProperties() { }
protected:
void initialize();
constexpr static auto CreateTextTrackCueBox = CreateHTMLElement | NodeFlag::HasCustomStyleResolveCallbacks;
TextTrackCueBox(Document&, TextTrackCue&);
~TextTrackCueBox() { }
private:
WeakPtr<TextTrackCue, WeakPtrImplWithEventTargetData> m_cue;
};
class TextTrackCue : public RefCounted<TextTrackCue>, public EventTarget, public ActiveDOMObject {
WTF_MAKE_ISO_ALLOCATED(TextTrackCue);
public:
static ExceptionOr<Ref<TextTrackCue>> create(Document&, double start, double end, DocumentFragment&);
TextTrack* track() const;
void setTrack(TextTrack*);
const AtomString& id() const { return m_id; }
void setId(const AtomString&);
double startTime() const { return startMediaTime().toDouble(); }
void setStartTime(double);
double endTime() const { return endMediaTime().toDouble(); }
void setEndTime(double);
bool pauseOnExit() const { return m_pauseOnExit; }
void setPauseOnExit(bool);
MediaTime startMediaTime() const { return m_startTime; }
void setStartTime(const MediaTime&);
MediaTime endMediaTime() const { return m_endTime; }
void setEndTime(const MediaTime&);
bool isActive() const;
virtual void setIsActive(bool);
virtual bool isOrderedBefore(const TextTrackCue*) const;
virtual bool isPositionedAbove(const TextTrackCue* cue) const { return isOrderedBefore(cue); }
bool hasEquivalentStartTime(const TextTrackCue&) const;
enum CueType { Generic, Data, ConvertedToWebVTT, WebVTT };
virtual CueType cueType() const { return CueType::Generic; }
virtual bool isRenderable() const;
enum CueMatchRules { MatchAllFields, IgnoreDuration };
bool isEqual(const TextTrackCue&, CueMatchRules) const;
void willChange();
virtual void didChange();
virtual RefPtr<TextTrackCueBox> getDisplayTree();
virtual void removeDisplayTree();
virtual RefPtr<DocumentFragment> getCueAsHTML();
virtual const String& text() const { return emptyString(); }
String toJSONString() const;
using RefCounted::ref;
using RefCounted::deref;
virtual void recalculateStyles() { m_displayTreeNeedsUpdate = true; }
virtual void setFontSize(int fontSize, bool important);
virtual void updateDisplayTree(const MediaTime&) { }
unsigned cueIndex() const;
using SpeakCueCompletionHandler = Function<void(const TextTrackCue&)>;
virtual void prepareToSpeak(SpeechSynthesis&, double, double, SpeakCueCompletionHandler&&) { }
virtual void beginSpeaking() { }
virtual void pauseSpeaking() { }
virtual void cancelSpeaking() { }
virtual bool cueContentsMatch(const TextTrackCue&) const;
protected:
TextTrackCue(Document&, const MediaTime& start, const MediaTime& end);
Document* document() const;
virtual void toJSON(JSON::Object&) const;
private:
TextTrackCue(Document&, const MediaTime& start, const MediaTime& end, Ref<DocumentFragment>&&);
// EventTarget
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
using EventTarget::dispatchEvent;
void dispatchEvent(Event&) final;
EventTargetInterface eventTargetInterface() const final { return TextTrackCueEventTargetInterfaceType; }
ScriptExecutionContext* scriptExecutionContext() const final;
// ActiveDOMObject
const char* activeDOMObjectName() const final;
void rebuildDisplayTree();
AtomString m_id;
MediaTime m_startTime;
MediaTime m_endTime;
int m_processingCueChanges { 0 };
TextTrack* m_track { nullptr };
RefPtr<DocumentFragment> m_cueNode;
RefPtr<TextTrackCueBox> m_displayTree;
int m_fontSize { 0 };
bool m_fontSizeIsImportant { false };
bool m_isActive { false };
bool m_pauseOnExit { false };
bool m_displayTreeNeedsUpdate { true };
};
#ifndef NDEBUG
TextStream& operator<<(TextStream&, const TextTrackCue&);
#endif
} // namespace WebCore
namespace WTF {
template<typename> struct LogArgument;
template<> struct LogArgument<WebCore::TextTrackCue> {
static String toString(const WebCore::TextTrackCue& cue) { return cue.toJSONString(); }
};
}
#endif
|