7dc027c57926cf01a7beb8be9591babe52c5d5d6
[WebKit-https.git] / Source / WebCore / html / track / InbandGenericTextTrack.cpp
1 /*
2  * Copyright (C) 2012-2014 Apple Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27
28 #if ENABLE(VIDEO_TRACK)
29
30 #include "InbandGenericTextTrack.h"
31
32 #include "ExceptionCodePlaceholder.h"
33 #include "HTMLMediaElement.h"
34 #include "InbandTextTrackPrivate.h"
35 #include "Logging.h"
36 #include "VTTRegionList.h"
37 #include <math.h>
38 #include <wtf/text/CString.h>
39
40
41 namespace WebCore {
42
43 GenericTextTrackCueMap::GenericTextTrackCueMap()
44 {
45 }
46
47 GenericTextTrackCueMap::~GenericTextTrackCueMap()
48 {
49 }
50
51 void GenericTextTrackCueMap::add(GenericCueData* cueData, TextTrackCueGeneric* cue)
52 {
53     m_dataToCueMap.add(cueData, cue);
54     m_cueToDataMap.add(cue, cueData);
55 }
56
57 PassRefPtr<TextTrackCueGeneric> GenericTextTrackCueMap::find(GenericCueData* cueData)
58 {
59     CueDataToCueMap::iterator iter = m_dataToCueMap.find(cueData);
60     if (iter == m_dataToCueMap.end())
61         return 0;
62
63     return iter->value;
64 }
65
66 PassRefPtr<GenericCueData> GenericTextTrackCueMap::find(TextTrackCue* cue)
67 {
68     CueToDataMap::iterator iter = m_cueToDataMap.find(cue);
69     if (iter == m_cueToDataMap.end())
70         return 0;
71
72     return iter->value;
73 }
74
75 void GenericTextTrackCueMap::remove(GenericCueData* cueData)
76 {
77     RefPtr<TextTrackCueGeneric> cue = find(cueData);
78
79     if (cue)
80         m_cueToDataMap.remove(cue);
81     m_dataToCueMap.remove(cueData);
82 }
83
84 void GenericTextTrackCueMap::remove(TextTrackCue* cue)
85 {
86     RefPtr<GenericCueData> genericData = find(cue);
87     if (genericData) {
88         m_dataToCueMap.remove(genericData);
89         m_cueToDataMap.remove(cue);
90     }
91 }
92
93 Ref<InbandGenericTextTrack> InbandGenericTextTrack::create(ScriptExecutionContext* context, TextTrackClient* client, PassRefPtr<InbandTextTrackPrivate> playerPrivate)
94 {
95     return adoptRef(*new InbandGenericTextTrack(context, client, playerPrivate));
96 }
97
98 InbandGenericTextTrack::InbandGenericTextTrack(ScriptExecutionContext* context, TextTrackClient* client, PassRefPtr<InbandTextTrackPrivate> trackPrivate)
99     : InbandTextTrack(context, client, trackPrivate)
100 {
101 }
102
103 InbandGenericTextTrack::~InbandGenericTextTrack()
104 {
105 }
106
107 void InbandGenericTextTrack::updateCueFromCueData(TextTrackCueGeneric* cue, GenericCueData* cueData)
108 {
109     cue->willChange();
110
111     cue->setStartTime(cueData->startTime());
112     MediaTime endTime = cueData->endTime();
113     if (endTime.isPositiveInfinite() && mediaElement())
114         endTime = mediaElement()->durationMediaTime();
115     cue->setEndTime(endTime);
116     cue->setText(cueData->content());
117     cue->setId(cueData->id());
118     cue->setBaseFontSizeRelativeToVideoHeight(cueData->baseFontSize());
119     cue->setFontSizeMultiplier(cueData->relativeFontSize());
120     cue->setFontName(cueData->fontName());
121
122     if (cueData->position() > 0)
123         cue->setPosition(lround(cueData->position()), IGNORE_EXCEPTION);
124     if (cueData->line() > 0)
125         cue->setLine(lround(cueData->line()), IGNORE_EXCEPTION);
126     if (cueData->size() > 0)
127         cue->setSize(lround(cueData->size()), IGNORE_EXCEPTION);
128     if (cueData->backgroundColor().isValid())
129         cue->setBackgroundColor(cueData->backgroundColor().rgb());
130     if (cueData->foregroundColor().isValid())
131         cue->setForegroundColor(cueData->foregroundColor().rgb());
132     if (cueData->highlightColor().isValid())
133         cue->setHighlightColor(cueData->highlightColor().rgb());
134
135     if (cueData->align() == GenericCueData::Start)
136         cue->setAlign(ASCIILiteral("start"), IGNORE_EXCEPTION);
137     else if (cueData->align() == GenericCueData::Middle)
138         cue->setAlign(ASCIILiteral("middle"), IGNORE_EXCEPTION);
139     else if (cueData->align() == GenericCueData::End)
140         cue->setAlign(ASCIILiteral("end"), IGNORE_EXCEPTION);
141     cue->setSnapToLines(false);
142
143     cue->didChange();
144 }
145
146 void InbandGenericTextTrack::addGenericCue(InbandTextTrackPrivate* trackPrivate, PassRefPtr<GenericCueData> prpCueData)
147 {
148     ASSERT_UNUSED(trackPrivate, trackPrivate == m_private);
149
150     RefPtr<GenericCueData> cueData = prpCueData;
151     if (m_cueMap.find(cueData.get()))
152         return;
153
154     RefPtr<TextTrackCueGeneric> cue = TextTrackCueGeneric::create(*scriptExecutionContext(), cueData->startTime(), cueData->endTime(), cueData->content());
155     updateCueFromCueData(cue.get(), cueData.get());
156     if (hasCue(cue.get(), TextTrackCue::IgnoreDuration)) {
157         LOG(Media, "InbandGenericTextTrack::addGenericCue ignoring already added cue: start=%s, end=%s, content=\"%s\"\n", toString(cueData->startTime()).utf8().data(), toString(cueData->endTime()).utf8().data(), cueData->content().utf8().data());
158         return;
159     }
160
161     LOG(Media, "InbandGenericTextTrack::addGenericCue added cue: start=%.2f, end=%.2f, content=\"%s\"\n", cueData->startTime().toDouble(), cueData->endTime().toDouble(), cueData->content().utf8().data());
162
163     if (cueData->status() != GenericCueData::Complete)
164         m_cueMap.add(cueData.get(), cue.get());
165
166     addCue(cue, ASSERT_NO_EXCEPTION);
167 }
168
169 void InbandGenericTextTrack::updateGenericCue(InbandTextTrackPrivate*, GenericCueData* cueData)
170 {
171     RefPtr<TextTrackCueGeneric> cue = m_cueMap.find(cueData);
172     if (!cue)
173         return;
174
175     updateCueFromCueData(cue.get(), cueData);
176
177     if (cueData->status() == GenericCueData::Complete)
178         m_cueMap.remove(cueData);
179 }
180
181 void InbandGenericTextTrack::removeGenericCue(InbandTextTrackPrivate*, GenericCueData* cueData)
182 {
183     RefPtr<TextTrackCueGeneric> cue = m_cueMap.find(cueData);
184     if (cue) {
185         LOG(Media, "InbandGenericTextTrack::removeGenericCue removing cue: start=%s, end=%s, content=\"%s\"\n",  toString(cueData->startTime()).utf8().data(), toString(cueData->endTime()).utf8().data(), cueData->content().utf8().data());
186         removeCue(cue.get(), IGNORE_EXCEPTION);
187     } else {
188         LOG(Media, "InbandGenericTextTrack::removeGenericCue UNABLE to find cue: start=%.2f, end=%.2f, content=\"%s\"\n", cueData->startTime().toDouble(), cueData->endTime().toDouble(), cueData->content().utf8().data());
189         m_cueMap.remove(cueData);
190     }
191 }
192
193 void InbandGenericTextTrack::removeCue(TextTrackCue* cue, ExceptionCode& ec)
194 {
195     m_cueMap.remove(cue);
196     TextTrack::removeCue(cue, ec);
197 }
198
199 WebVTTParser& InbandGenericTextTrack::parser()
200 {
201     if (!m_webVTTParser)
202         m_webVTTParser = std::make_unique<WebVTTParser>(static_cast<WebVTTParserClient*>(this), scriptExecutionContext());
203     return *m_webVTTParser;
204 }
205
206 void InbandGenericTextTrack::parseWebVTTCueData(InbandTextTrackPrivate* trackPrivate, const ISOWebVTTCue& cueData)
207 {
208     ASSERT_UNUSED(trackPrivate, trackPrivate == m_private);
209     parser().parseCueData(cueData);
210 }
211
212 void InbandGenericTextTrack::parseWebVTTFileHeader(InbandTextTrackPrivate* trackPrivate, String header)
213 {
214     ASSERT_UNUSED(trackPrivate, trackPrivate == m_private);
215     parser().parseFileHeader(header);
216 }
217
218 void InbandGenericTextTrack::newCuesParsed()
219 {
220     Vector<RefPtr<WebVTTCueData>> cues;
221     parser().getNewCues(cues);
222
223     for (auto& cueData : cues) {
224         auto vttCue = VTTCue::create(*scriptExecutionContext(), *cueData);
225
226         if (hasCue(vttCue.ptr(), TextTrackCue::IgnoreDuration)) {
227             LOG(Media, "InbandGenericTextTrack::newCuesParsed ignoring already added cue: start=%.2f, end=%.2f, content=\"%s\"\n", vttCue->startTime(), vttCue->endTime(), vttCue->text().utf8().data());
228             return;
229         }
230         addCue(WTFMove(vttCue), ASSERT_NO_EXCEPTION);
231     }
232 }
233
234 void InbandGenericTextTrack::newRegionsParsed()
235 {
236     Vector<RefPtr<VTTRegion>> newRegions;
237     parser().getNewRegions(newRegions);
238
239     for (auto& region : newRegions) {
240         region->setTrack(this);
241         regions()->add(region);
242     }
243 }
244
245 void InbandGenericTextTrack::fileFailedToParse()
246 {
247     LOG(Media, "Error parsing WebVTT stream.");
248 }
249
250 } // namespace WebCore
251
252 #endif