Update TextTrack API to current spec
[WebKit-https.git] / Source / WebCore / rendering / RenderVTTCue.cpp
1 /*
2  * Copyright (C) 2012 Victor Carbune (victor@rosedu.org)
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 COMPUTER, 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 COMPUTER, 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 #include "RenderVTTCue.h"
30
31 #include "RenderView.h"
32 #include "TextTrackCueGeneric.h"
33 #include "VTTCue.h"
34 #include <wtf/StackStats.h>
35
36 namespace WebCore {
37
38 RenderVTTCue::RenderVTTCue(VTTCueBox& element, PassRef<RenderStyle> style)
39     : RenderBlockFlow(element, std::move(style))
40     , m_cue(element.getCue())
41 {
42 }
43
44 void RenderVTTCue::layout()
45 {
46     StackStats::LayoutCheckPoint layoutCheckPoint;
47     RenderBlockFlow::layout();
48
49     LayoutStateMaintainer statePusher(view(), *this, locationOffset(), hasTransform() || hasReflection() || style().isFlippedBlocksWritingMode());
50     
51     if (m_cue->cueType()== TextTrackCue::WebVTT) {
52         if (toVTTCue(m_cue)->snapToLines())
53             repositionCueSnapToLinesSet();
54         else
55             repositionCueSnapToLinesNotSet();
56     } else
57         repositionGenericCue();
58
59     statePusher.pop();
60 }
61
62 bool RenderVTTCue::initializeLayoutParameters(InlineFlowBox*& firstLineBox, LayoutUnit& step, LayoutUnit& position)
63 {
64     ASSERT(firstChild());
65
66     RenderBlock* parentBlock = containingBlock();
67     firstLineBox = toRenderInline(firstChild())->firstLineBox();
68     if (!firstLineBox)
69         firstLineBox = this->firstRootBox();
70
71     // 1. Horizontal: Let step be the height of the first line box in boxes.
72     //    Vertical: Let step be the width of the first line box in boxes.
73     step = m_cue->getWritingDirection() == VTTCue::Horizontal ? firstLineBox->height() : firstLineBox->width();
74
75     // 2. If step is zero, then jump to the step labeled done positioning below.
76     if (!step)
77         return false;
78
79     // 3. Let line position be the text track cue computed line position.
80     int linePosition = m_cue->calculateComputedLinePosition();
81
82     // 4. Vertical Growing Left: Add one to line position then negate it.
83     if (m_cue->getWritingDirection() == VTTCue::VerticalGrowingLeft)
84         linePosition = -(linePosition + 1);
85
86     // 5. Let position be the result of multiplying step and line position.
87     position = step * linePosition;
88
89     // 6. Vertical Growing Left: Decrease position by the width of the
90     // bounding box of the boxes in boxes, then increase position by step.
91     if (m_cue->getWritingDirection() == VTTCue::VerticalGrowingLeft) {
92         position -= width();
93         position += step;
94     }
95
96     // 7. If line position is less than zero...
97     if (linePosition < 0) {
98         // Horizontal / Vertical: ... then increase position by the
99         // height / width of the video's rendering area ...
100         position += m_cue->getWritingDirection() == VTTCue::Horizontal ? parentBlock->height() : parentBlock->width();
101
102         // ... and negate step.
103         step = -step;
104     }
105
106     return true;
107 }
108
109 void RenderVTTCue::placeBoxInDefaultPosition(LayoutUnit position, bool& switched)
110 {
111     // 8. Move all boxes in boxes ...
112     if (m_cue->getWritingDirection() == VTTCue::Horizontal)
113         // Horizontal: ... down by the distance given by position
114         setY(y() + position);
115     else
116         // Vertical: ... right by the distance given by position
117         setX(x() + position);
118
119     // 9. Default: Remember the position of all the boxes in boxes as their
120     // default position.
121     m_fallbackPosition = FloatPoint(x(), y());
122
123     // 10. Let switched be false.
124     switched = false;
125 }
126
127 bool RenderVTTCue::isOutside() const
128 {
129     return !rectIsWithinContainer(absoluteContentBox());
130 }
131
132 bool RenderVTTCue::rectIsWithinContainer(const IntRect& rect) const
133 {
134     return containingBlock()->absoluteBoundingBoxRect().contains(rect);
135 }
136
137
138 bool RenderVTTCue::isOverlapping() const
139 {
140     return overlappingObject();
141 }
142
143 RenderObject* RenderVTTCue::overlappingObject() const
144 {
145     return overlappingObjectForRect(absoluteBoundingBoxRect());
146 }
147
148 RenderObject* RenderVTTCue::overlappingObjectForRect(const IntRect& rect) const
149 {
150     for (RenderObject* box = previousSibling(); box; box = box->previousSibling()) {
151         IntRect boxRect = box->absoluteBoundingBoxRect();
152
153         if (rect.intersects(boxRect))
154             return box;
155     }
156
157     return 0;
158 }
159
160 bool RenderVTTCue::shouldSwitchDirection(InlineFlowBox* firstLineBox, LayoutUnit step) const
161 {
162     LayoutUnit top = y();
163     LayoutUnit left = x();
164     LayoutUnit bottom = top + firstLineBox->height();
165     LayoutUnit right = left + firstLineBox->width();
166
167     // 12. Horizontal: If step is negative and the top of the first line
168     // box in boxes is now above the top of the video's rendering area,
169     // or if step is positive and the bottom of the first line box in
170     // boxes is now below the bottom of the video's rendering area, jump
171     // to the step labeled switch direction.
172     LayoutUnit parentHeight = containingBlock()->height();
173     if (m_cue->getWritingDirection() == VTTCue::Horizontal && ((step < 0 && top < 0) || (step > 0 && bottom > parentHeight)))
174         return true;
175
176     // 12. Vertical: If step is negative and the left edge of the first line
177     // box in boxes is now to the left of the left edge of the video's
178     // rendering area, or if step is positive and the right edge of the
179     // first line box in boxes is now to the right of the right edge of
180     // the video's rendering area, jump to the step labeled switch direction.
181     LayoutUnit parentWidth = containingBlock()->width();
182     if (m_cue->getWritingDirection() != VTTCue::Horizontal && ((step < 0 && left < 0) || (step > 0 && right > parentWidth)))
183         return true;
184
185     return false;
186 }
187
188 void RenderVTTCue::moveBoxesByStep(LayoutUnit step)
189 {
190     // 13. Horizontal: Move all the boxes in boxes down by the distance
191     // given by step. (If step is negative, then this will actually
192     // result in an upwards movement of the boxes in absolute terms.)
193     if (m_cue->getWritingDirection() == VTTCue::Horizontal)
194         setY(y() + step);
195
196     // 13. Vertical: Move all the boxes in boxes right by the distance
197     // given by step. (If step is negative, then this will actually
198     // result in a leftwards movement of the boxes in absolute terms.)
199     else
200         setX(x() + step);
201 }
202
203 bool RenderVTTCue::switchDirection(bool& switched, LayoutUnit& step)
204 {
205     // 15. Switch direction: Move all the boxes in boxes back to their
206     // default position as determined in the step above labeled default.
207     setX(m_fallbackPosition.x());
208     setY(m_fallbackPosition.y());
209
210     // 16. If switched is true, jump to the step labeled done
211     // positioning below.
212     if (switched)
213         return false;
214
215     // 17. Negate step.
216     step = -step;
217
218     // 18. Set switched to true.
219     switched = true;
220     return true;
221 }
222
223 void RenderVTTCue::moveIfNecessaryToKeepWithinContainer()
224 {
225     IntRect containerRect = containingBlock()->absoluteBoundingBoxRect();
226     IntRect cueRect = absoluteBoundingBoxRect();
227
228     int topOverflow = cueRect.y() - containerRect.y();
229     int bottomOverflow = containerRect.maxY() - cueRect.maxY();
230
231     int verticalAdjustment = 0;
232     if (topOverflow < 0)
233         verticalAdjustment = -topOverflow;
234     else if (bottomOverflow < 0)
235         verticalAdjustment = bottomOverflow;
236
237     if (verticalAdjustment)
238         setY(y() + verticalAdjustment);
239
240     int leftOverflow = cueRect.x() - containerRect.x();
241     int rightOverflow = containerRect.maxX() - cueRect.maxX();
242
243     int horizontalAdjustment = 0;
244     if (leftOverflow < 0)
245         horizontalAdjustment = -leftOverflow;
246     else if (rightOverflow < 0)
247         horizontalAdjustment = rightOverflow;
248
249     if (horizontalAdjustment)
250         setX(x() + horizontalAdjustment);
251 }
252
253 bool RenderVTTCue::findNonOverlappingPosition(int& newX, int& newY) const
254 {
255     newX = x();
256     newY = y();
257     IntRect srcRect = absoluteBoundingBoxRect();
258     IntRect destRect = srcRect;
259
260     // Move the box up, looking for a non-overlapping position:
261     while (RenderObject* box = overlappingObjectForRect(destRect)) {
262         if (m_cue->getWritingDirection() == VTTCue::Horizontal)
263             destRect.setY(box->absoluteBoundingBoxRect().y() - destRect.height());
264         else
265             destRect.setX(box->absoluteBoundingBoxRect().x() - destRect.width());
266     }
267
268     if (rectIsWithinContainer(destRect)) {
269         newX += destRect.x() - srcRect.x();
270         newY += destRect.y() - srcRect.y();
271         return true;
272     }
273
274     destRect = srcRect;
275
276     // Move the box down, looking for a non-overlapping position:
277     while (RenderObject* box = overlappingObjectForRect(destRect)) {
278         if (m_cue->getWritingDirection() == VTTCue::Horizontal)
279             destRect.setY(box->absoluteBoundingBoxRect().maxY());
280         else
281             destRect.setX(box->absoluteBoundingBoxRect().maxX());
282     }
283
284     if (rectIsWithinContainer(destRect)) {
285         newX += destRect.x() - srcRect.x();
286         newY += destRect.y() - srcRect.y();
287         return true;
288     }
289
290     return false;
291 }
292
293 void RenderVTTCue::repositionCueSnapToLinesSet()
294 {
295     InlineFlowBox* firstLineBox;
296     LayoutUnit step;
297     LayoutUnit position;
298     if (!initializeLayoutParameters(firstLineBox, step, position))
299         return;
300
301     bool switched;
302     placeBoxInDefaultPosition(position, switched);
303
304     // 11. Step loop: If none of the boxes in boxes would overlap any of the boxes
305     // in output and all the boxes in output are within the video's rendering area
306     // then jump to the step labeled done positioning.
307     while (isOutside() || isOverlapping()) {
308         if (!shouldSwitchDirection(firstLineBox, step))
309             // 13. Move all the boxes in boxes ...
310             // 14. Jump back to the step labeled step loop.
311             moveBoxesByStep(step);
312         else if (!switchDirection(switched, step))
313             break;
314
315         // 19. Jump back to the step labeled step loop.
316     }
317
318     // Acommodate extra top and bottom padding, border or margin.
319     // Note: this is supported only for internal UA styling, not through the cue selector.
320     if (hasInlineDirectionBordersPaddingOrMargin())
321         moveIfNecessaryToKeepWithinContainer();
322 }
323
324 void RenderVTTCue::repositionGenericCue()
325 {
326     ASSERT(firstChild());
327     InlineFlowBox* firstLineBox = toRenderInline(firstChild())->firstLineBox();
328     if (static_cast<TextTrackCueGeneric*>(m_cue)->useDefaultPosition() && firstLineBox) {
329         LayoutUnit parentWidth = containingBlock()->logicalWidth();
330         LayoutUnit width = firstLineBox->width();
331         LayoutUnit right = (parentWidth / 2) - (width / 2);
332         setX(right);
333     }
334     repositionCueSnapToLinesNotSet();
335 }
336
337 void RenderVTTCue::repositionCueSnapToLinesNotSet()
338 {
339     // 3. If none of the boxes in boxes would overlap any of the boxes in output, and all the boxes in
340     // output are within the video's rendering area, then jump to the step labeled done positioning below.
341     if (!isOutside() && !isOverlapping())
342         return;
343
344     // 4. If there is a position to which the boxes in boxes can be moved while maintaining the relative
345     // positions of the boxes in boxes to each other such that none of the boxes in boxes would overlap
346     // any of the boxes in output, and all the boxes in output would be within the video's rendering area,
347     // then move the boxes in boxes to the closest such position to their current position, and then jump
348     // to the step labeled done positioning below. If there are multiple such positions that are equidistant
349     // from their current position, use the highest one amongst them; if there are several at that height,
350     // then use the leftmost one amongst them.
351     moveIfNecessaryToKeepWithinContainer();
352     int x = 0;
353     int y = 0;
354     if (!findNonOverlappingPosition(x, y))
355         return;
356
357     setX(x);
358     setY(y);
359 }
360
361 } // namespace WebCore
362
363 #endif