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 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 InbandTextTrack_h
27#define InbandTextTrack_h
28
29#if ENABLE(VIDEO_TRACK)
30
31#include "InbandTextTrackPrivate.h"
32#include "InbandTextTrackPrivateClient.h"
33#include "TextTrack.h"
34#include "TextTrackCueGeneric.h"
35#include <wtf/RefPtr.h>
36
37namespace WebCore {
38
39class Document;
40class InbandTextTrackPrivate;
41class TextTrackCue;
42
43class TextTrackCueMap {
44public:
45    TextTrackCueMap() { }
46    virtual ~TextTrackCueMap() { }
47
48    void add(GenericCueData*, TextTrackCueGeneric*);
49
50    void remove(GenericCueData*);
51    void remove(TextTrackCueGeneric*);
52
53    PassRefPtr<GenericCueData> find(TextTrackCueGeneric*);
54    PassRefPtr<TextTrackCueGeneric> find(GenericCueData*);
55
56private:
57    typedef HashMap<RefPtr<TextTrackCueGeneric>, RefPtr<GenericCueData> > GenericCueToCueDataMap;
58    typedef HashMap<RefPtr<GenericCueData>, RefPtr<TextTrackCueGeneric> > GenericCueDataToCueMap;
59
60    GenericCueToCueDataMap m_cueToDataMap;
61    GenericCueDataToCueMap m_dataToCueMap;
62};
63
64class InbandTextTrack : public TextTrack, public InbandTextTrackPrivateClient {
65public:
66    static PassRefPtr<InbandTextTrack> create(ScriptExecutionContext*, TextTrackClient*, PassRefPtr<InbandTextTrackPrivate>);
67    virtual ~InbandTextTrack();
68
69    virtual bool isClosedCaptions() const OVERRIDE;
70    virtual bool isSDH() const OVERRIDE;
71    virtual bool containsOnlyForcedSubtitles() const OVERRIDE;
72    virtual bool isMainProgramContent() const OVERRIDE;
73    virtual bool isEasyToRead() const OVERRIDE;
74    virtual void setMode(const AtomicString&) OVERRIDE;
75    size_t inbandTrackIndex();
76
77private:
78    InbandTextTrack(ScriptExecutionContext*, TextTrackClient*, PassRefPtr<InbandTextTrackPrivate>);
79
80    virtual void addGenericCue(InbandTextTrackPrivate*, PassRefPtr<GenericCueData>) OVERRIDE;
81    virtual void updateGenericCue(InbandTextTrackPrivate*, GenericCueData*) OVERRIDE;
82    virtual void removeGenericCue(InbandTextTrackPrivate*, GenericCueData*) OVERRIDE;
83    virtual void removeCue(TextTrackCue*, ExceptionCode&) OVERRIDE;
84    virtual void willRemoveTextTrackPrivate(InbandTextTrackPrivate*) OVERRIDE;
85
86    PassRefPtr<TextTrackCueGeneric> createCue(PassRefPtr<GenericCueData>);
87    void updateCueFromCueData(TextTrackCueGeneric*, GenericCueData*);
88
89#if USE(PLATFORM_TEXT_TRACK_MENU)
90    virtual InbandTextTrackPrivate* privateTrack() OVERRIDE { return m_private.get(); }
91#endif
92
93    TextTrackCueMap m_cueMap;
94    RefPtr<InbandTextTrackPrivate> m_private;
95};
96
97} // namespace WebCore
98
99#endif
100#endif
101