fc3fd2dca74f7f6877a4d6de2f7a461f3db3bd0a
[WebKit-https.git] / Source / WebCore / html / track / WebVTTParser.h
1 /*
2  * Copyright (C) 2011, 2013 Google Inc.  All rights reserved.
3  * Copyright (C) 2013 Cable Television Labs, Inc.
4  * Copyright (C) 2014 Apple Inc.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above
13  * copyright notice, this list of conditions and the following disclaimer
14  * in the documentation and/or other materials provided with the
15  * distribution.
16  *     * Neither the name of Google Inc. nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #ifndef WebVTTParser_h
34 #define WebVTTParser_h
35
36 #if ENABLE(VIDEO_TRACK)
37
38 #include "BufferedLineReader.h"
39 #include "DocumentFragment.h"
40 #include "HTMLNames.h"
41 #include "TextResourceDecoder.h"
42 #include "VTTRegion.h"
43 #include "WebVTTTokenizer.h"
44 #include <memory>
45 #include <wtf/text/StringBuilder.h>
46
47 namespace WebCore {
48
49 using namespace HTMLNames;
50
51 class Document;
52 class VTTScanner;
53
54 class WebVTTParserClient {
55 public:
56     virtual ~WebVTTParserClient() { }
57
58     virtual void newCuesParsed() = 0;
59 #if ENABLE(WEBVTT_REGIONS)
60     virtual void newRegionsParsed() = 0;
61 #endif
62     virtual void fileFailedToParse() = 0;
63 };
64
65 class WebVTTCueData : public RefCounted<WebVTTCueData> {
66 public:
67
68     static PassRefPtr<WebVTTCueData> create() { return adoptRef(new WebVTTCueData()); }
69     virtual ~WebVTTCueData() { }
70
71     double startTime() const { return m_startTime; }
72     void setStartTime(double startTime) { m_startTime = startTime; }
73
74     double endTime() const { return m_endTime; }
75     void setEndTime(double endTime) { m_endTime = endTime; }
76
77     String id() const { return m_id; }
78     void setId(String id) { m_id = id; }
79
80     String content() const { return m_content; }
81     void setContent(String content) { m_content = content; }
82
83     String settings() const { return m_settings; }
84     void setSettings(String settings) { m_settings = settings; }
85
86 private:
87     WebVTTCueData()
88         : m_startTime(0)
89         , m_endTime(0)
90     {
91     }
92
93     double m_startTime;
94     double m_endTime;
95     String m_id;
96     String m_content;
97     String m_settings;
98 };
99
100 class WebVTTParser final {
101 public:
102     enum ParseState {
103         Initial,
104         Header,
105         Id,
106         TimingsAndSettings,
107         CueText,
108         BadCue,
109         Finished
110     };
111
112     WebVTTParser(WebVTTParserClient*, ScriptExecutionContext*);
113
114     static inline bool isRecognizedTag(const AtomicString& tagName)
115     {
116         return tagName == iTag
117             || tagName == bTag
118             || tagName == uTag
119             || tagName == rubyTag
120             || tagName == rtTag;
121     }
122
123     static inline bool isASpace(UChar c)
124     {
125         // WebVTT space characters are U+0020 SPACE, U+0009 CHARACTER TABULATION (tab), U+000A LINE FEED (LF), U+000C FORM FEED (FF), and U+000D CARRIAGE RETURN    (CR).
126         return c == ' ' || c == '\t' || c == '\n' || c == '\f' || c == '\r';
127     }
128     static inline bool isValidSettingDelimiter(UChar c)
129     {
130         // ... a WebVTT cue consists of zero or more of the following components, in any order, separated from each other by one or more 
131         // U+0020 SPACE characters or U+0009 CHARACTER TABULATION (tab) characters.
132         return c == ' ' || c == '\t';
133     }
134     static bool collectTimeStamp(const String&, double&);
135
136 #if ENABLE(WEBVTT_REGIONS)
137     // Useful functions for parsing percentage settings.
138     static bool parseFloatPercentageValue(VTTScanner& valueScanner, float&);
139     static bool parseFloatPercentageValuePair(VTTScanner& valueScanner, char, FloatPoint&);
140 #endif
141
142     // Input data to the parser to parse.
143     void parseBytes(const char* data, unsigned length);
144     void flush();
145     void fileFinished();
146
147     // Transfers ownership of last parsed cues to caller.
148     void getNewCues(Vector<RefPtr<WebVTTCueData>>&);
149 #if ENABLE(WEBVTT_REGIONS)
150     void getNewRegions(Vector<RefPtr<VTTRegion>>&);
151 #endif
152
153     // Create the DocumentFragment representation of the WebVTT cue text.
154     static PassRefPtr<DocumentFragment> createDocumentFragmentFromCueText(Document&, const String&);
155
156 protected:
157     ScriptExecutionContext* m_scriptExecutionContext;
158     ParseState m_state;
159
160 private:
161     void parse();
162     void flushPendingCue();
163     bool hasRequiredFileIdentifier(const String&);
164     ParseState collectCueId(const String&);
165     ParseState collectTimingsAndSettings(const String&);
166     ParseState collectCueText(const String&);
167     ParseState recoverCue(const String&);
168     ParseState ignoreBadCue(const String&);
169
170     void createNewCue();
171     void resetCueValues();
172
173     void collectMetadataHeader(const String&);
174 #if ENABLE(WEBVTT_REGIONS)
175     void createNewRegion(const String& headerValue);
176 #endif
177
178     static bool collectTimeStamp(VTTScanner& input, double& timeStamp);
179
180     BufferedLineReader m_lineReader;
181     RefPtr<TextResourceDecoder> m_decoder;
182     String m_currentId;
183     double m_currentStartTime;
184     double m_currentEndTime;
185     StringBuilder m_currentContent;
186     String m_currentSettings;
187     
188     WebVTTParserClient* m_client;
189
190     Vector<RefPtr<WebVTTCueData>> m_cuelist;
191
192 #if ENABLE(WEBVTT_REGIONS)
193     Vector<RefPtr<VTTRegion>> m_regionList;
194 #endif
195 };
196
197 } // namespace WebCore
198
199 #endif
200 #endif