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 InbandTextTrack_h
27#define InbandTextTrack_h
28
29#if ENABLE(VIDEO_TRACK)
30
31#include "InbandTextTrackPrivateClient.h"
32#include "TextTrack.h"
33#include "TextTrackCueGeneric.h"
34#include <wtf/RefPtr.h>
35
36namespace WebCore {
37
38class InbandTextTrack : public TextTrack, public InbandTextTrackPrivateClient {
39public:
40    static PassRefPtr<InbandTextTrack> create(ScriptExecutionContext*, TextTrackClient*, PassRefPtr<InbandTextTrackPrivate>);
41    virtual ~InbandTextTrack();
42
43    virtual bool isClosedCaptions() const override;
44    virtual bool isSDH() const override;
45    virtual bool containsOnlyForcedSubtitles() const override;
46    virtual bool isMainProgramContent() const override;
47    virtual bool isEasyToRead() const override;
48    virtual void setMode(const AtomicString&) override;
49    size_t inbandTrackIndex();
50
51    virtual AtomicString inBandMetadataTrackDispatchType() const;
52
53    void setPrivate(PassRefPtr<InbandTextTrackPrivate>);
54
55    virtual bool isInband() const override { return true; }
56
57protected:
58    InbandTextTrack(ScriptExecutionContext*, TextTrackClient*, PassRefPtr<InbandTextTrackPrivate>);
59
60    void setModeInternal(const AtomicString&);
61    void updateKindFromPrivate();
62
63    RefPtr<InbandTextTrackPrivate> m_private;
64
65private:
66
67    virtual void idChanged(TrackPrivateBase*, const AtomicString&) override;
68    virtual void labelChanged(TrackPrivateBase*, const AtomicString&) override;
69    virtual void languageChanged(TrackPrivateBase*, const AtomicString&) override;
70    virtual void willRemove(TrackPrivateBase*) override;
71
72    virtual void addDataCue(InbandTextTrackPrivate*, double, double, const void*, unsigned) override { ASSERT_NOT_REACHED(); }
73
74#if ENABLE(DATACUE_VALUE)
75    virtual void addDataCue(InbandTextTrackPrivate*, double, double, PassRefPtr<SerializedPlatformRepresentation>, const String&) override { ASSERT_NOT_REACHED(); }
76    virtual void updateDataCue(InbandTextTrackPrivate*, double, double, PassRefPtr<SerializedPlatformRepresentation>) override  { ASSERT_NOT_REACHED(); }
77    virtual void removeDataCue(InbandTextTrackPrivate*, double, double, PassRefPtr<SerializedPlatformRepresentation>) override  { ASSERT_NOT_REACHED(); }
78#endif
79
80    virtual void addGenericCue(InbandTextTrackPrivate*, PassRefPtr<GenericCueData>) override { ASSERT_NOT_REACHED(); }
81    virtual void updateGenericCue(InbandTextTrackPrivate*, GenericCueData*) override { ASSERT_NOT_REACHED(); }
82    virtual void removeGenericCue(InbandTextTrackPrivate*, GenericCueData*) override { ASSERT_NOT_REACHED(); }
83
84    virtual void parseWebVTTFileHeader(InbandTextTrackPrivate*, String) override { ASSERT_NOT_REACHED(); }
85    virtual void parseWebVTTCueData(InbandTextTrackPrivate*, const char*, unsigned) override { ASSERT_NOT_REACHED(); }
86    virtual void parseWebVTTCueData(InbandTextTrackPrivate*, const ISOWebVTTCue&) override { ASSERT_NOT_REACHED(); }
87
88    virtual double startTimeVariance() const;
89
90#if USE(PLATFORM_TEXT_TRACK_MENU)
91    virtual InbandTextTrackPrivate* privateTrack() override { return m_private.get(); }
92#endif
93};
94
95TYPE_CASTS_BASE(InbandTextTrack, TextTrack, track, track->isInband(), track.isInband());
96
97} // namespace WebCore
98
99#endif
100#endif
101