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#include "wtf/Forward.h"
30#include "wtf/Noncopyable.h"
31#include "wtf/RefCounted.h"
32#include "wtf/text/AtomicString.h"
33
34namespace WebCore {
35
36class InbandTextTrackPrivateClient;
37
38class InbandTextTrackPrivate : public RefCounted<InbandTextTrackPrivate> {
39    WTF_MAKE_NONCOPYABLE(InbandTextTrackPrivate); WTF_MAKE_FAST_ALLOCATED;
40public:
41    static PassRefPtr<InbandTextTrackPrivate> create()
42    {
43        return adoptRef(new InbandTextTrackPrivate());
44    }
45    virtual ~InbandTextTrackPrivate() { }
46
47    void setClient(InbandTextTrackPrivateClient* client) { m_client = client; }
48    InbandTextTrackPrivateClient* client() { return m_client; }
49
50    enum Mode { Disabled, Hidden, Showing };
51    virtual void setMode(Mode mode) { m_mode = mode; };
52    virtual InbandTextTrackPrivate::Mode mode() const { return m_mode; }
53
54    enum Kind { Subtitles, Captions, Descriptions, Chapters, Metadata, None };
55    virtual Kind kind() const { return Subtitles; }
56    virtual bool isClosedCaptions() const { return false; }
57    virtual bool containsOnlyForcedSubtitles() const { return false; }
58    virtual bool isMainProgramContent() const { return true; }
59    virtual bool isEasyToRead() const { return false; }
60
61    virtual AtomicString label() const { return emptyAtom; }
62    virtual AtomicString language() const { return emptyAtom; }
63    virtual bool isDefault() const { return false; }
64
65    virtual int textTrackIndex() const { return 0; }
66
67protected:
68    InbandTextTrackPrivate()
69        : m_client(0)
70        , m_mode(Disabled)
71    {
72    }
73
74private:
75    InbandTextTrackPrivateClient* m_client;
76    Mode m_mode;
77};
78
79} // namespace WebCore
80
81#endif
82