Rename AtomicString to AtomString
[WebKit-https.git] / Source / WebCore / html / HTMLTrackElement.h
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  * Copyright (C) 2011-2017 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 #pragma once
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "HTMLElement.h"
32 #include "LoadableTextTrack.h"
33
34 namespace WebCore {
35
36 class HTMLMediaElement;
37
38 class HTMLTrackElement final : public HTMLElement, public TextTrackClient {
39     WTF_MAKE_ISO_ALLOCATED(HTMLTrackElement);
40 public:
41     static Ref<HTMLTrackElement> create(const QualifiedName&, Document&);
42
43     const AtomString& kind();
44     void setKind(const AtomString&);
45
46     const AtomString& srclang() const;
47     const AtomString& label() const;
48     bool isDefault() const;
49
50     enum ReadyState { NONE = 0, LOADING = 1, LOADED = 2, TRACK_ERROR = 3 };
51     ReadyState readyState();
52     void setReadyState(ReadyState);
53
54     LoadableTextTrack& track();
55
56     void scheduleLoad();
57
58     enum LoadStatus { Failure, Success };
59     void didCompleteLoad(LoadStatus);
60
61     RefPtr<HTMLMediaElement> mediaElement() const;
62     const AtomString& mediaElementCrossOriginAttribute() const;
63
64 private:
65     HTMLTrackElement(const QualifiedName&, Document&);
66     virtual ~HTMLTrackElement();
67
68     void parseAttribute(const QualifiedName&, const AtomString&) final;
69
70     InsertedIntoAncestorResult insertedIntoAncestor(InsertionType, ContainerNode&) final;
71     void removedFromAncestor(RemovalType, ContainerNode&) final;
72
73     bool isURLAttribute(const Attribute&) const final;
74
75     void loadTimerFired();
76
77     // TextTrackClient
78     void textTrackModeChanged(TextTrack&) final;
79     void textTrackKindChanged(TextTrack&) final;
80     void textTrackAddCues(TextTrack&, const TextTrackCueList&) final;
81     void textTrackRemoveCues(TextTrack&, const TextTrackCueList&) final;
82     void textTrackAddCue(TextTrack&, TextTrackCue&) final;
83     void textTrackRemoveCue(TextTrack&, TextTrackCue&) final;
84
85     bool canLoadURL(const URL&);
86
87     RefPtr<LoadableTextTrack> m_track;
88     Timer m_loadTimer;
89 };
90
91 }
92
93 #endif