CTTE Timer and DeferrableOneShotTimer
[WebKit-https.git] / Source / WebCore / html / track / LoadableTextTrack.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 LoadableTextTrack_h
27 #define LoadableTextTrack_h
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "TextTrack.h"
32 #include "TextTrackLoader.h"
33 #include <wtf/Vector.h>
34
35 namespace WebCore {
36
37 class HTMLTrackElement;
38 class LoadableTextTrack;
39
40 class LoadableTextTrackClient : public TextTrackClient {
41 public:
42     virtual ~LoadableTextTrackClient() { }
43     
44     virtual bool canLoadUrl(LoadableTextTrack*, const URL&) { return false; }
45     virtual void loadingCompleted(LoadableTextTrack*, bool /* loadingFailed */) { }
46 };
47
48 class LoadableTextTrack : public TextTrack, private TextTrackLoaderClient {
49 public:
50     static PassRefPtr<LoadableTextTrack> create(HTMLTrackElement* track, const String& kind, const String& label, const String& language)
51     {
52         return adoptRef(new LoadableTextTrack(track, kind, label, language));
53     }
54     virtual ~LoadableTextTrack();
55
56     void scheduleLoad(const URL&);
57
58     virtual void clearClient();
59
60     virtual AtomicString id() const OVERRIDE;
61
62     size_t trackElementIndex();
63     HTMLTrackElement* trackElement() { return m_trackElement; }
64     void setTrackElement(HTMLTrackElement*);
65     virtual Element* element() OVERRIDE;
66
67     virtual bool isDefault() const OVERRIDE { return m_isDefault; }
68     virtual void setIsDefault(bool isDefault) OVERRIDE  { m_isDefault = isDefault; }
69
70 private:
71     // TextTrackLoaderClient
72     virtual bool shouldLoadCues(TextTrackLoader*) { return true; }
73     virtual void newCuesAvailable(TextTrackLoader*);
74     virtual void cueLoadingStarted(TextTrackLoader*);
75     virtual void cueLoadingCompleted(TextTrackLoader*, bool loadingFailed);
76 #if ENABLE(WEBVTT_REGIONS)
77     virtual void newRegionsAvailable(TextTrackLoader*);
78 #endif
79
80     LoadableTextTrack(HTMLTrackElement*, const String& kind, const String& label, const String& language);
81
82     void loadTimerFired(Timer<LoadableTextTrack>&);
83
84     HTMLTrackElement* m_trackElement;
85     Timer<LoadableTextTrack> m_loadTimer;
86     OwnPtr<TextTrackLoader> m_loader;
87     URL m_url;
88     bool m_isDefault;
89 };
90 } // namespace WebCore
91
92 #endif
93 #endif