1b659ff52719ff195af37ec5387cd4506789e1fd
[WebKit-https.git] / Source / WebCore / html / HTMLTrackElement.h
1 /*
2  * Copyright (C) 2011 Google 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 HTMLTrackElement_h
27 #define HTMLTrackElement_h
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "HTMLElement.h"
32 #include "LoadableTextTrack.h"
33 #include "TextTrack.h"
34
35 namespace WebCore {
36
37 class HTMLMediaElement;
38
39 class HTMLTrackElement : public HTMLElement, public TextTrackClient {
40 public:
41     static PassRefPtr<HTMLTrackElement> create(const QualifiedName&, Document*);
42
43     KURL src() const;
44     void setSrc(const String&);
45
46     String kind();
47     void setKind(const String&);
48
49     String srclang() const;
50     void setSrclang(const String&);
51
52     String label() const;
53     void setLabel(const String&);
54
55     bool isDefault() const;
56     void setIsDefault(bool);
57
58     enum ReadyState { NONE = 0, LOADING = 1, LOADED = 2, TRACK_ERROR = 3 };
59     ReadyState readyState();
60     void setReadyState(ReadyState);
61
62     TextTrack* track();
63
64     void scheduleLoad();
65
66     enum LoadStatus { Failure, Success };
67     virtual void didCompleteLoad(LoadableTextTrack*, LoadStatus);
68
69     const AtomicString& mediaElementCrossOriginAttribute() const;
70
71 private:
72     HTMLTrackElement(const QualifiedName&, Document*);
73     virtual ~HTMLTrackElement();
74
75     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
76
77     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
78
79     virtual void removedFrom(ContainerNode*) OVERRIDE;
80     virtual bool isURLAttribute(const Attribute&) const OVERRIDE;
81
82 #if ENABLE(MICRODATA)
83     virtual String itemValueText() const OVERRIDE;
84     virtual void setItemValueText(const String&, ExceptionCode&) OVERRIDE;
85 #endif
86
87     HTMLMediaElement* mediaElement() const;
88
89     // TextTrackClient
90     virtual void textTrackModeChanged(TextTrack*);
91     virtual void textTrackKindChanged(TextTrack*);
92     virtual void textTrackAddCues(TextTrack*, const TextTrackCueList*);
93     virtual void textTrackRemoveCues(TextTrack*, const TextTrackCueList*);
94     virtual void textTrackAddCue(TextTrack*, PassRefPtr<TextTrackCue>);
95     virtual void textTrackRemoveCue(TextTrack*, PassRefPtr<TextTrackCue>);
96
97     LoadableTextTrack* ensureTrack();
98     virtual bool canLoadUrl(const KURL&);
99
100     RefPtr<LoadableTextTrack> m_track;
101 };
102
103 }
104
105 #endif
106 #endif