Move cross-port Source/WebCore/page/ code to std::unique_ptr
[WebKit-https.git] / Source / WebCore / page / CaptionUserPreferences.h
1 /*
2  * Copyright (C) 2012, 2013  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 CaptionUserPreferences_h
27 #define CaptionUserPreferences_h
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "Language.h"
32 #include "LocalizedStrings.h"
33 #include "TextTrack.h"
34 #include "Timer.h"
35 #include <wtf/text/AtomicString.h>
36
37 namespace WebCore {
38
39 class HTMLMediaElement;
40 class PageGroup;
41 class TextTrackList;
42
43 class CaptionUserPreferences {
44 public:
45     CaptionUserPreferences(PageGroup&);
46     virtual ~CaptionUserPreferences();
47
48     enum CaptionDisplayMode {
49         Automatic,
50         ForcedOnly,
51         AlwaysOn
52     };
53     virtual CaptionDisplayMode captionDisplayMode() const;
54     virtual void setCaptionDisplayMode(CaptionDisplayMode);
55
56     virtual int textTrackSelectionScore(TextTrack*, HTMLMediaElement*) const;
57     virtual int textTrackLanguageSelectionScore(TextTrack*, const Vector<String>&) const;
58
59     virtual bool userPrefersCaptions() const;
60     virtual void setUserPrefersCaptions(bool);
61
62     virtual bool userPrefersSubtitles() const;
63     virtual void setUserPrefersSubtitles(bool preference);
64     
65     virtual bool userPrefersTextDescriptions() const;
66     virtual void setUserPrefersTextDescriptions(bool preference);
67
68     virtual float captionFontSizeScaleAndImportance(bool& important) const { important = false; return 0.05f; }
69
70     virtual String captionsStyleSheetOverride() const { return m_captionsStyleSheetOverride; }
71     virtual void setCaptionsStyleSheetOverride(const String&);
72
73     virtual void setInterestedInCaptionPreferenceChanges() { }
74
75     virtual void captionPreferencesChanged();
76
77     virtual void setPreferredLanguage(const String&);
78     virtual Vector<String> preferredLanguages() const;
79
80     virtual String displayNameForTrack(TextTrack*) const;
81     virtual Vector<RefPtr<TextTrack>> sortedTrackListForMenu(TextTrackList*);
82
83     void setPrimaryAudioTrackLanguageOverride(const String& language) { m_primaryAudioTrackLanguageOverride = language;  }
84     String primaryAudioTrackLanguageOverride() const;
85
86     virtual bool testingMode() const { return m_testingMode; }
87     virtual void setTestingMode(bool override) { m_testingMode = override; }
88     
89     PageGroup& pageGroup() const { return m_pageGroup; }
90
91 protected:
92     void updateCaptionStyleSheetOveride();
93
94 private:
95     void timerFired(Timer<CaptionUserPreferences>&);
96     void notify();
97
98     PageGroup& m_pageGroup;
99     CaptionDisplayMode m_displayMode;
100     Timer<CaptionUserPreferences> m_timer;
101     String m_userPreferredLanguage;
102     String m_captionsStyleSheetOverride;
103     String m_primaryAudioTrackLanguageOverride;
104     bool m_testingMode;
105     bool m_havePreferences;
106 };
107     
108 }
109 #endif
110
111 #endif