Remove the Timer parameters from timer callbacks
[WebKit-https.git] / Source / WebCore / loader / TextTrackLoader.h
1 /*
2  * Copyright (C) 2011, 2014 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef TextTrackLoader_h
27 #define TextTrackLoader_h
28
29 #if ENABLE(VIDEO_TRACK)
30
31 #include "CachedResourceClient.h"
32 #include "CachedResourceHandle.h"
33 #include "Timer.h"
34 #include "WebVTTParser.h"
35 #include <memory>
36
37 namespace WebCore {
38
39 class CachedTextTrack;
40 class Document;
41 class TextTrackLoader;
42 class ScriptExecutionContext;
43
44 class TextTrackLoaderClient {
45 public:
46     virtual ~TextTrackLoaderClient() { }
47     
48     virtual void newCuesAvailable(TextTrackLoader*) = 0;
49     virtual void cueLoadingCompleted(TextTrackLoader*, bool loadingFailed) = 0;
50 #if ENABLE(WEBVTT_REGIONS)
51     virtual void newRegionsAvailable(TextTrackLoader*) = 0;
52 #endif
53 };
54
55 class TextTrackLoader : public CachedResourceClient, private WebVTTParserClient {
56     WTF_MAKE_NONCOPYABLE(TextTrackLoader); 
57     WTF_MAKE_FAST_ALLOCATED;
58 public:
59     TextTrackLoader(TextTrackLoaderClient&, ScriptExecutionContext*);
60     virtual ~TextTrackLoader();
61     
62     bool load(const URL&, const String& crossOriginMode);
63     void cancelLoad();
64     void getNewCues(Vector<RefPtr<TextTrackCue>>& outputCues);
65 #if ENABLE(WEBVTT_REGIONS)
66     void getNewRegions(Vector<RefPtr<VTTRegion>>& outputRegions);
67 #endif
68 private:
69
70     // CachedResourceClient
71     virtual void notifyFinished(CachedResource*) override;
72     virtual void deprecatedDidReceiveCachedResource(CachedResource*) override;
73     
74     // WebVTTParserClient
75     virtual void newCuesParsed() override;
76 #if ENABLE(WEBVTT_REGIONS)
77     virtual void newRegionsParsed() override;
78 #endif
79     virtual void fileFailedToParse() override;
80     
81     void processNewCueData(CachedResource*);
82     void cueLoadTimerFired();
83     void corsPolicyPreventedLoad();
84
85     enum State { Idle, Loading, Finished, Failed };
86     
87     TextTrackLoaderClient& m_client;
88     std::unique_ptr<WebVTTParser> m_cueParser;
89     CachedResourceHandle<CachedTextTrack> m_resource;
90     ScriptExecutionContext* m_scriptExecutionContext;
91     Timer m_cueLoadTimer;
92     String m_crossOriginMode;
93     State m_state;
94     unsigned m_parseOffset;
95     bool m_newCuesAvailable;
96 };
97
98 } // namespace WebCore
99
100 #endif
101 #endif