Not all subtitle tracks are SDH
[WebKit-https.git] / Source / WebCore / platform / graphics / InbandTextTrackPrivate.h
1 /*
2  * Copyright (C) 2012 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 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 #ifndef InbandTextTrackPrivate_h
27 #define InbandTextTrackPrivate_h
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "InbandTextTrackPrivateClient.h"
32 #include <wtf/Forward.h>
33 #include <wtf/Noncopyable.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/text/AtomicString.h>
36
37 namespace WebCore {
38
39 class InbandTextTrackPrivate : public RefCounted<InbandTextTrackPrivate> {
40     WTF_MAKE_NONCOPYABLE(InbandTextTrackPrivate); WTF_MAKE_FAST_ALLOCATED;
41 public:
42     static PassRefPtr<InbandTextTrackPrivate> create()
43     {
44         return adoptRef(new InbandTextTrackPrivate());
45     }
46     virtual ~InbandTextTrackPrivate() { }
47
48     void setClient(InbandTextTrackPrivateClient* client) { m_client = client; }
49     InbandTextTrackPrivateClient* client() { return m_client; }
50
51     enum Mode {
52         Disabled,
53         Hidden,
54         Showing
55     };
56     virtual void setMode(Mode mode) { m_mode = mode; };
57     virtual InbandTextTrackPrivate::Mode mode() const { return m_mode; }
58
59     enum Kind {
60         Subtitles,
61         Captions,
62         Descriptions,
63         Chapters,
64         Metadata,
65         Forced,
66         None
67     };
68     virtual Kind kind() const { return Subtitles; }
69     virtual bool isClosedCaptions() const { return false; }
70     virtual bool isSDH() const { return false; }
71     virtual bool containsOnlyForcedSubtitles() const { return false; }
72     virtual bool isMainProgramContent() const { return true; }
73     virtual bool isEasyToRead() const { return false; }
74
75     virtual AtomicString label() const { return emptyAtom; }
76     virtual AtomicString language() const { return emptyAtom; }
77     virtual bool isDefault() const { return false; }
78
79     virtual int textTrackIndex() const { return 0; }
80
81     void willBeRemoved()
82     {
83         if (m_client)
84             m_client->willRemoveTextTrackPrivate(this);
85     }
86
87 protected:
88     InbandTextTrackPrivate()
89         : m_client(0)
90         , m_mode(Disabled)
91     {
92     }
93
94 private:
95     InbandTextTrackPrivateClient* m_client;
96     Mode m_mode;
97 };
98
99 } // namespace WebCore
100
101 #endif
102 #endif