Update platform text track menu
[WebKit-https.git] / Source / WebCore / platform / graphics / PlatformTextTrack.h
1 /*
2  * Copyright (C) 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef PlatformTextTrack_h
27 #define PlatformTextTrack_h
28
29 #if USE(PLATFORM_TEXT_TRACK_MENU)
30
31 #include <wtf/RefCounted.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35
36 class TextTrack;
37 class InbandTextTrackPrivate;
38
39 class PlatformTextTrackClient {
40 public:
41     virtual ~PlatformTextTrackClient() { }
42     
43     virtual TextTrack* publicTrack() = 0;
44     virtual InbandTextTrackPrivate* privateTrack() { return 0; }
45 };
46
47 class PlatformTextTrack : public RefCounted<PlatformTextTrack> {
48 public:
49     enum TrackKind {
50         Subtitle = 0,
51         Caption = 1,
52         Description = 2,
53         Chapter = 3,
54         MetaData = 4,
55         Forced = 5,
56     };
57     enum TrackType {
58         InBand = 0,
59         OutOfBand = 1,
60         Script = 2
61     };
62
63     static PassRefPtr<PlatformTextTrack> create(PlatformTextTrackClient* client, const String& label, const String& language, TrackKind kind, TrackType type, int uniqueId)
64     {
65         return adoptRef(new PlatformTextTrack(client, label, language, kind, type, uniqueId));
66     }
67
68     virtual ~PlatformTextTrack() { }
69     
70     TrackType type() const { return m_type; }
71     TrackKind kind() const { return m_kind; }
72     String label() const { return m_label; }
73     String language() const { return m_language; }
74     PlatformTextTrackClient* client() const { return m_client; }
75     int uniqueId() const { return m_uniqueId; }
76
77     static PlatformTextTrack* captionMenuOffItem()
78     {
79         DEFINE_STATIC_LOCAL(RefPtr<PlatformTextTrack>, off, (PlatformTextTrack::create(0, "off menu item", "", Subtitle, InBand, 0)));
80         return off.get();
81     }
82
83     static PlatformTextTrack* captionMenuAutomaticItem()
84     {
85         DEFINE_STATIC_LOCAL(RefPtr<PlatformTextTrack>, automatic, (PlatformTextTrack::create(0, "automatic menu item", "", Subtitle, InBand, 0)));
86         return automatic.get();
87     }
88
89 protected:
90     PlatformTextTrack(PlatformTextTrackClient* client, const String& label, const String& language, TrackKind kind, TrackType type, int uniqueId)
91         : m_label(label)
92         , m_language(language)
93         , m_kind(kind)
94         , m_type(type)
95         , m_client(client)
96         , m_uniqueId(uniqueId)
97     {
98     }
99
100     String m_label;
101     String m_language;
102     TrackKind m_kind;
103     TrackType m_type;
104     PlatformTextTrackClient* m_client;
105     int m_uniqueId;
106 };
107
108 }
109
110 #endif
111
112 #endif // PlatformTextTrack_h