1/*
2 * Copyright (C) 2011 Google Inc. All rights reserved.
3 * Copyright (C) 2011, 2012, 2013 Apple Inc.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#ifndef VideoTrack_h
28#define VideoTrack_h
29
30#if ENABLE(VIDEO_TRACK)
31
32#include "ExceptionCode.h"
33#include "TrackBase.h"
34#include "VideoTrackPrivate.h"
35#include <wtf/RefCounted.h>
36#include <wtf/text/WTFString.h>
37
38namespace WebCore {
39
40class MediaDescription;
41class VideoTrack;
42
43class VideoTrackClient {
44public:
45    virtual ~VideoTrackClient() { }
46    virtual void videoTrackSelectedChanged(VideoTrack*) = 0;
47};
48
49class VideoTrack : public TrackBase, public VideoTrackPrivateClient {
50public:
51    static PassRefPtr<VideoTrack> create(VideoTrackClient* client, PassRefPtr<VideoTrackPrivate> trackPrivate)
52    {
53        return adoptRef(new VideoTrack(client, trackPrivate));
54    }
55    virtual ~VideoTrack();
56
57    static const AtomicString& alternativeKeyword();
58    static const AtomicString& captionsKeyword();
59    static const AtomicString& mainKeyword();
60    static const AtomicString& signKeyword();
61    static const AtomicString& subtitlesKeyword();
62    static const AtomicString& commentaryKeyword();
63    virtual const AtomicString& defaultKindKeyword() const override { return emptyAtom; }
64
65    bool selected() const { return m_selected; }
66    virtual void setSelected(const bool);
67
68    virtual void clearClient() override { m_client = 0; }
69    VideoTrackClient* client() const { return m_client; }
70
71    size_t inbandTrackIndex();
72
73#if ENABLE(MEDIA_SOURCE)
74    virtual void setKind(const AtomicString&) override;
75    virtual void setLanguage(const AtomicString&) override;
76#endif
77
78    const MediaDescription& description() const;
79
80    void setPrivate(PassRefPtr<VideoTrackPrivate>);
81
82protected:
83    VideoTrack(VideoTrackClient*, PassRefPtr<VideoTrackPrivate> privateTrack);
84
85private:
86    virtual bool isValidKind(const AtomicString&) const override;
87
88    virtual void selectedChanged(VideoTrackPrivate*, bool) override;
89    virtual void idChanged(TrackPrivateBase*, const AtomicString&) override;
90    virtual void labelChanged(TrackPrivateBase*, const AtomicString&) override;
91    virtual void languageChanged(TrackPrivateBase*, const AtomicString&) override;
92    virtual void willRemove(TrackPrivateBase*) override;
93
94    virtual bool enabled() const override { return selected(); }
95
96    void updateKindFromPrivate();
97
98    bool m_selected;
99    VideoTrackClient* m_client;
100
101    RefPtr<VideoTrackPrivate> m_private;
102};
103
104inline VideoTrack* toVideoTrack(TrackBase* track)
105{
106    ASSERT_WITH_SECURITY_IMPLICATION(track->type() == TrackBase::VideoTrack);
107    return static_cast<VideoTrack*>(track);
108}
109
110} // namespace WebCore
111
112#endif
113#endif
114