856115b2e802d7a0df92bf606110c4b60c4627c1
[WebKit-https.git] / Source / WebCore / html / track / TextTrackCueGeneric.h
1 /*
2  * Copyright (C) 2013, 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 #ifndef TextTrackCueGeneric_h
27 #define TextTrackCueGeneric_h
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "Color.h"
32 #include "VTTCue.h"
33
34 namespace WebCore {
35
36 class GenericCueData;
37
38 // A "generic" cue is a non-WebVTT cue, so it is not positioned/sized with the WebVTT logic.
39 class TextTrackCueGeneric final : public VTTCue {
40 public:
41     static Ref<TextTrackCueGeneric> create(ScriptExecutionContext& context, const MediaTime& start, const MediaTime& end, const String& content)
42     {
43         return adoptRef(*new TextTrackCueGeneric(context, start, end, content));
44     }
45     
46     virtual ~TextTrackCueGeneric() { }
47
48     PassRefPtr<VTTCueBox> createDisplayTree() override;
49
50     void setLine(double, ExceptionCode&) override;
51     void setPosition(double, ExceptionCode&) override;
52
53     bool useDefaultPosition() const { return m_defaultPosition; }
54     
55     double baseFontSizeRelativeToVideoHeight() const { return m_baseFontSizeRelativeToVideoHeight; }
56     void setBaseFontSizeRelativeToVideoHeight(double size) { m_baseFontSizeRelativeToVideoHeight = size; }
57
58     double fontSizeMultiplier() const { return m_fontSizeMultiplier; }
59     void setFontSizeMultiplier(double size) { m_fontSizeMultiplier = size; }
60
61     String fontName() const { return m_fontName; }
62     void setFontName(String name) { m_fontName = name; }
63
64     const Color& foregroundColor() const { return m_foregroundColor; }
65     void setForegroundColor(Color color) { m_foregroundColor = color; }
66     
67     const Color& backgroundColor() const { return m_backgroundColor; }
68     void setBackgroundColor(Color color) { m_backgroundColor = color; }
69     
70     const Color& highlightColor() const { return m_highlightColor; }
71     void setHighlightColor(Color color) { m_highlightColor = color; }
72     
73     void setFontSize(int, const IntSize&, bool important) override;
74
75     bool isEqual(const TextTrackCue&, CueMatchRules) const override;
76     bool cueContentsMatch(const TextTrackCue&) const override;
77     bool doesExtendCue(const TextTrackCue&) const override;
78
79     TextTrackCue::CueType cueType() const override { return TextTrackCue::Generic; }
80
81 private:
82     bool isOrderedBefore(const TextTrackCue*) const override;
83     bool isPositionedAbove(const TextTrackCue*) const override;
84
85     TextTrackCueGeneric(ScriptExecutionContext&, const MediaTime& start, const MediaTime& end, const String&);
86     
87     Color m_foregroundColor;
88     Color m_backgroundColor;
89     Color m_highlightColor;
90     double m_baseFontSizeRelativeToVideoHeight;
91     double m_fontSizeMultiplier;
92     String m_fontName;
93     bool m_defaultPosition;
94 };
95
96 } // namespace WebCore
97
98 #endif
99 #endif