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