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
195
196
197
198
199
|
/*
* Copyright (C) 2011, 2013 Google Inc. All rights reserved.
* Copyright (C) 2013 Cable Television Labs, Inc.
* Copyright (C) 2014 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.
*/
#ifndef WebVTTParser_h
#define WebVTTParser_h
#if ENABLE(VIDEO_TRACK)
#include "BufferedLineReader.h"
#include "DocumentFragment.h"
#include "HTMLNames.h"
#include "TextResourceDecoder.h"
#include "VTTRegion.h"
#include "WebVTTTokenizer.h"
#include <memory>
#include <wtf/MediaTime.h>
#include <wtf/text/StringBuilder.h>
namespace WebCore {
using namespace HTMLNames;
class Document;
class ISOWebVTTCue;
class VTTScanner;
class WebVTTParserClient {
public:
virtual ~WebVTTParserClient() { }
virtual void newCuesParsed() = 0;
#if ENABLE(WEBVTT_REGIONS)
virtual void newRegionsParsed() = 0;
#endif
virtual void fileFailedToParse() = 0;
};
class WebVTTCueData : public RefCounted<WebVTTCueData> {
public:
static PassRefPtr<WebVTTCueData> create() { return adoptRef(new WebVTTCueData()); }
virtual ~WebVTTCueData() { }
MediaTime startTime() const { return m_startTime; }
void setStartTime(const MediaTime& startTime) { m_startTime = startTime; }
MediaTime endTime() const { return m_endTime; }
void setEndTime(const MediaTime& endTime) { m_endTime = endTime; }
String id() const { return m_id; }
void setId(String id) { m_id = id; }
String content() const { return m_content; }
void setContent(String content) { m_content = content; }
String settings() const { return m_settings; }
void setSettings(String settings) { m_settings = settings; }
MediaTime originalStartTime() const { return m_originalStartTime; }
void setOriginalStartTime(const MediaTime& time) { m_originalStartTime = time; }
private:
WebVTTCueData() { }
MediaTime m_startTime;
MediaTime m_endTime;
MediaTime m_originalStartTime;
String m_id;
String m_content;
String m_settings;
};
class WebVTTParser final {
public:
enum ParseState {
Initial,
Header,
Id,
TimingsAndSettings,
CueText,
BadCue,
Finished
};
WebVTTParser(WebVTTParserClient*, ScriptExecutionContext*);
static inline bool isRecognizedTag(const AtomicString& tagName)
{
return tagName == iTag
|| tagName == bTag
|| tagName == uTag
|| tagName == rubyTag
|| tagName == rtTag;
}
static inline bool isValidSettingDelimiter(UChar c)
{
// ... a WebVTT cue consists of zero or more of the following components, in any order, separated from each other by one or more
// U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab) characters.
return c == ' ' || c == '\t';
}
static bool collectTimeStamp(const String&, MediaTime&);
// Useful functions for parsing percentage settings.
static bool parseFloatPercentageValue(VTTScanner& valueScanner, float&);
#if ENABLE(WEBVTT_REGIONS)
static bool parseFloatPercentageValuePair(VTTScanner& valueScanner, char, FloatPoint&);
#endif
// Input data to the parser to parse.
void parseBytes(const char*, unsigned);
void parseFileHeader(const String&);
void parseCueData(const ISOWebVTTCue&);
void flush();
void fileFinished();
// Transfers ownership of last parsed cues to caller.
void getNewCues(Vector<RefPtr<WebVTTCueData>>&);
#if ENABLE(WEBVTT_REGIONS)
void getNewRegions(Vector<RefPtr<VTTRegion>>&);
#endif
// Create the DocumentFragment representation of the WebVTT cue text.
static PassRefPtr<DocumentFragment> createDocumentFragmentFromCueText(Document&, const String&);
protected:
ScriptExecutionContext* m_scriptExecutionContext;
ParseState m_state;
private:
void parse();
void flushPendingCue();
bool hasRequiredFileIdentifier(const String&);
ParseState collectCueId(const String&);
ParseState collectTimingsAndSettings(const String&);
ParseState collectCueText(const String&);
ParseState recoverCue(const String&);
ParseState ignoreBadCue(const String&);
void createNewCue();
void resetCueValues();
void collectMetadataHeader(const String&);
#if ENABLE(WEBVTT_REGIONS)
void createNewRegion(const String& headerValue);
#endif
static bool collectTimeStamp(VTTScanner& input, MediaTime& timeStamp);
BufferedLineReader m_lineReader;
RefPtr<TextResourceDecoder> m_decoder;
String m_currentId;
MediaTime m_currentStartTime;
MediaTime m_currentEndTime;
StringBuilder m_currentContent;
String m_currentSettings;
WebVTTParserClient* m_client;
Vector<RefPtr<WebVTTCueData>> m_cuelist;
#if ENABLE(WEBVTT_REGIONS)
Vector<RefPtr<VTTRegion>> m_regionList;
#endif
};
} // namespace WebCore
#endif
#endif
|
