Add interfaces and stubs for audio and video tracks
[WebKit-https.git] / Source / WebCore / html / track / TrackBase.h
1 /*
2  * Copyright (C) 2011 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 TrackBase_h
27 #define TrackBase_h
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "EventTarget.h"
32 #include <wtf/RefCounted.h>
33
34 namespace WebCore {
35
36 class Element;
37 class HTMLMediaElement;
38
39 class TrackBase : public RefCounted<TrackBase> {
40 public:
41     virtual ~TrackBase();
42
43     enum Type { BaseTrack, TextTrack, AudioTrack, VideoTrack };
44     Type type() const { return m_type; }
45
46     void setMediaElement(HTMLMediaElement* element) { m_mediaElement = element; }
47     HTMLMediaElement* mediaElement() { return m_mediaElement; }
48     virtual Element* element();
49
50     AtomicString kind() const { return m_kind; }
51     virtual void setKind(const AtomicString&);
52
53     AtomicString label() const { return m_label; }
54     void setLabel(const AtomicString& label) { m_label = label; }
55
56     AtomicString language() const { return m_language; }
57     void setLanguage(const AtomicString& language) { m_language = language; }
58
59     virtual void clearClient() = 0;
60
61 protected:
62     TrackBase(Type, const AtomicString& label, const AtomicString& language);
63
64     virtual bool isValidKind(const AtomicString&) const = 0;
65     virtual const AtomicString& defaultKindKeyword() const = 0;
66
67     HTMLMediaElement* m_mediaElement;
68
69 private:
70     Type m_type;
71     AtomicString m_kind;
72     AtomicString m_label;
73     AtomicString m_language;
74 };
75
76 } // namespace WebCore
77
78 #endif
79 #endif // TrackBase_h