Use "= default" to denote default constructor or destructor
[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 #pragma once
27
28 #if ENABLE(VIDEO_TRACK)
29
30 #include "CachedResourceClient.h"
31 #include "CachedResourceHandle.h"
32 #include "Timer.h"
33 #include "WebVTTParser.h"
34 #include <memory>
35
36 namespace WebCore {
37
38 class CachedTextTrack;
39 class Document;
40 class TextTrackLoader;
41 class ScriptExecutionContext;
42
43 class TextTrackLoaderClient {
44 public:
45     virtual ~TextTrackLoaderClient() = default;
46     
47     virtual void newCuesAvailable(TextTrackLoader*) = 0;
48     virtual void cueLoadingCompleted(TextTrackLoader*, bool loadingFailed) = 0;
49     virtual void newRegionsAvailable(TextTrackLoader*) = 0;
50 };
51
52 class TextTrackLoader : public CachedResourceClient, private WebVTTParserClient {
53     WTF_MAKE_NONCOPYABLE(TextTrackLoader); 
54     WTF_MAKE_FAST_ALLOCATED;
55 public:
56     TextTrackLoader(TextTrackLoaderClient&, ScriptExecutionContext*);
57     virtual ~TextTrackLoader();
58     
59     bool load(const URL&, const String& crossOriginMode, bool isInitiatingElementInUserAgentShadowTree);
60     void cancelLoad();
61     void getNewCues(Vector<RefPtr<TextTrackCue>>& outputCues);
62     void getNewRegions(Vector<RefPtr<VTTRegion>>& outputRegions);
63 private:
64
65     // CachedResourceClient
66     void notifyFinished(CachedResource&) override;
67     void deprecatedDidReceiveCachedResource(CachedResource&) override;
68
69     // WebVTTParserClient
70     void newCuesParsed() override;
71     void newRegionsParsed() override;
72     void fileFailedToParse() override;
73
74     void processNewCueData(CachedResource&);
75     void cueLoadTimerFired();
76     void corsPolicyPreventedLoad();
77
78     enum State { Idle, Loading, Finished, Failed };
79
80     TextTrackLoaderClient& m_client;
81     std::unique_ptr<WebVTTParser> m_cueParser;
82     CachedResourceHandle<CachedTextTrack> m_resource;
83     ScriptExecutionContext* m_scriptExecutionContext;
84     Timer m_cueLoadTimer;
85     State m_state;
86     unsigned m_parseOffset;
87     bool m_newCuesAvailable;
88 };
89
90 } // namespace WebCore
91
92 #endif // ENABLE(VIDEO_TRACK)