The 'global isinf/isnan' compiler quirk required when using clang with libstdc++
[WebKit.git] / Source / WebCore / platform / graphics / avfoundation / MediaPlayerPrivateAVFoundation.h
1 /*
2  * Copyright (C) 2011, 2012 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 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 MediaPlayerPrivateAVFoundation_h
27 #define MediaPlayerPrivateAVFoundation_h
28
29 #if ENABLE(VIDEO) && USE(AVFOUNDATION)
30
31 #include "FloatSize.h"
32 #include "MediaPlayerPrivate.h"
33 #include "Timer.h"
34 #include <wtf/RetainPtr.h>
35
36 namespace WebCore {
37
38 class InbandTextTrackPrivateAVF;
39 class GenericCueData;
40
41 class MediaPlayerPrivateAVFoundation : public MediaPlayerPrivateInterface {
42 public:
43
44     virtual void repaint();
45     virtual void metadataLoaded();
46     virtual void playabilityKnown();
47     virtual void rateChanged();
48     virtual void loadedTimeRangesChanged();
49     virtual void seekableTimeRangesChanged();
50     virtual void timeChanged(double);
51     virtual void seekCompleted(bool);
52     virtual void didEnd();
53     virtual void contentsNeedsDisplay() { }
54 #if HAVE(AVFOUNDATION_TEXT_TRACK_SUPPORT)
55     virtual void configureInbandTracks();
56     virtual void setCurrentTrack(InbandTextTrackPrivateAVF*) { }
57     virtual InbandTextTrackPrivateAVF* currentTrack() { return 0; }
58 #endif
59
60     class Notification {
61     public:
62 #define FOR_EACH_MEDIAPLAYERPRIVATEAVFOUNDATION_NOTIFICATION_TYPE(macro) \
63     macro(None) \
64     macro(ItemDidPlayToEndTime) \
65     macro(ItemTracksChanged) \
66     macro(ItemStatusChanged) \
67     macro(ItemSeekableTimeRangesChanged) \
68     macro(ItemLoadedTimeRangesChanged) \
69     macro(ItemPresentationSizeChanged) \
70     macro(ItemIsPlaybackLikelyToKeepUpChanged) \
71     macro(ItemIsPlaybackBufferEmptyChanged) \
72     macro(ItemIsPlaybackBufferFullChanged) \
73     macro(AssetMetadataLoaded) \
74     macro(AssetPlayabilityKnown) \
75     macro(PlayerRateChanged) \
76     macro(PlayerTimeChanged) \
77     macro(SeekCompleted) \
78     macro(DurationChanged) \
79     macro(ContentsNeedsDisplay) \
80     macro(InbandTracksNeedConfiguration) \
81
82         enum Type {
83 #define DEFINE_TYPE_ENUM(type) type,
84             FOR_EACH_MEDIAPLAYERPRIVATEAVFOUNDATION_NOTIFICATION_TYPE(DEFINE_TYPE_ENUM)
85 #undef DEFINE_TYPE_ENUM
86         };
87         
88         Notification()
89             : m_type(None)
90             , m_time(0)
91             , m_finished(false)
92         {
93         }
94
95         Notification(Type type, double time)
96             : m_type(type)
97             , m_time(time)
98             , m_finished(false)
99         {
100         }
101         
102         Notification(Type type, bool finished)
103             : m_type(type)
104             , m_time(0)
105             , m_finished(finished)
106         {
107         }
108         
109         Type type() { return m_type; }
110         bool isValid() { return m_type != None; }
111         double time() { return m_time; }
112         bool finished() { return m_finished; }
113         
114     private:
115         Type m_type;
116         double m_time;
117         bool m_finished;
118     };
119
120     void scheduleMainThreadNotification(Notification);
121     void scheduleMainThreadNotification(Notification::Type, double time = 0);
122     void scheduleMainThreadNotification(Notification::Type, bool completed);
123     void dispatchNotification();
124     void clearMainThreadPendingFlag();
125
126 #if HAVE(AVFOUNDATION_TEXT_TRACK_SUPPORT)
127     void addGenericCue(InbandTextTrackPrivateAVF*, GenericCueData*);
128     void trackModeChanged();
129 #endif
130
131 protected:
132     MediaPlayerPrivateAVFoundation(MediaPlayer*);
133     virtual ~MediaPlayerPrivateAVFoundation();
134
135     // MediaPlayerPrivatePrivateInterface overrides.
136     virtual void load(const String& url);
137     virtual void cancelLoad() = 0;
138
139     virtual void prepareToPlay();
140     virtual PlatformMedia platformMedia() const = 0;
141
142     virtual void play();
143     virtual void pause();
144
145     virtual IntSize naturalSize() const;
146     virtual bool hasVideo() const { return m_cachedHasVideo; }
147     virtual bool hasAudio() const { return m_cachedHasAudio; }
148     virtual void setVisible(bool);
149     virtual float duration() const;
150     virtual float currentTime() const = 0;
151     virtual void seek(float);
152     virtual bool seeking() const;
153     virtual void setRate(float);
154     virtual bool paused() const;
155     virtual void setVolume(float) = 0;
156     virtual bool hasClosedCaptions() const { return m_cachedHasCaptions; }
157     virtual void setClosedCaptionsVisible(bool) = 0;
158     virtual MediaPlayer::NetworkState networkState() const { return m_networkState; }
159     virtual MediaPlayer::ReadyState readyState() const { return m_readyState; }
160     virtual float maxTimeSeekable() const;
161     virtual PassRefPtr<TimeRanges> buffered() const;
162     virtual bool didLoadingProgress() const;
163     virtual void setSize(const IntSize&);
164     virtual void paint(GraphicsContext*, const IntRect&) = 0;
165     virtual void paintCurrentFrameInContext(GraphicsContext*, const IntRect&) = 0;
166     virtual void setPreload(MediaPlayer::Preload);
167 #if USE(ACCELERATED_COMPOSITING)
168     virtual PlatformLayer* platformLayer() const { return 0; }
169     virtual bool supportsAcceleratedRendering() const = 0;
170     virtual void acceleratedRenderingStateChanged();
171 #endif
172     virtual MediaPlayer::MovieLoadType movieLoadType() const;
173     virtual void prepareForRendering();
174     virtual float mediaTimeForTimeValue(float) const = 0;
175
176     virtual bool supportsFullscreen() const;
177     virtual bool supportsScanning() const { return true; }
178
179     // Required interfaces for concrete derived classes.
180     virtual void createAVAssetForURL(const String&) = 0;
181     virtual void createAVPlayer() = 0;
182     virtual void createAVPlayerItem() = 0;
183
184     enum ItemStatus {
185         MediaPlayerAVPlayerItemStatusDoesNotExist,
186         MediaPlayerAVPlayerItemStatusUnknown,
187         MediaPlayerAVPlayerItemStatusFailed,
188         MediaPlayerAVPlayerItemStatusReadyToPlay,
189         MediaPlayerAVPlayerItemStatusPlaybackBufferEmpty,
190         MediaPlayerAVPlayerItemStatusPlaybackBufferFull,
191         MediaPlayerAVPlayerItemStatusPlaybackLikelyToKeepUp,
192     };
193     virtual ItemStatus playerItemStatus() const = 0;
194
195     enum AssetStatus {
196         MediaPlayerAVAssetStatusDoesNotExist,
197         MediaPlayerAVAssetStatusUnknown,
198         MediaPlayerAVAssetStatusLoading,
199         MediaPlayerAVAssetStatusFailed,
200         MediaPlayerAVAssetStatusCancelled,
201         MediaPlayerAVAssetStatusLoaded,
202         MediaPlayerAVAssetStatusPlayable,
203     };
204     virtual AssetStatus assetStatus() const = 0;
205
206     virtual void platformSetVisible(bool) = 0;
207     virtual void platformPlay() = 0;
208     virtual void platformPause() = 0;
209     virtual void checkPlayability() = 0;
210     virtual void updateRate() = 0;
211     virtual float rate() const = 0;
212     virtual void seekToTime(float time) = 0;
213     virtual unsigned totalBytes() const = 0;
214     virtual PassRefPtr<TimeRanges> platformBufferedTimeRanges() const = 0;
215     virtual float platformMaxTimeSeekable() const = 0;
216     virtual float platformMaxTimeLoaded() const = 0;
217     virtual float platformDuration() const = 0;
218
219     virtual void beginLoadingMetadata() = 0;
220     virtual void tracksChanged() = 0;
221     virtual void sizeChanged() = 0;
222
223     virtual void createContextVideoRenderer() = 0;
224     virtual void destroyContextVideoRenderer() = 0;
225
226     virtual void createVideoLayer() = 0;
227     virtual void destroyVideoLayer() = 0;
228
229     virtual bool hasAvailableVideoFrame() const = 0;
230
231     virtual bool hasContextRenderer() const = 0;
232     virtual bool hasLayerRenderer() const = 0;
233
234 protected:
235     void updateStates();
236
237     void setHasVideo(bool);
238     void setHasAudio(bool);
239     void setHasClosedCaptions(bool);
240     void setDelayCallbacks(bool) const;
241     void setIgnoreLoadStateChanges(bool delay) { m_ignoreLoadStateChanges = delay; }
242     void setNaturalSize(IntSize);
243     bool isLiveStream() const { return std::isinf(duration()); }
244
245     enum MediaRenderingMode { MediaRenderingNone, MediaRenderingToContext, MediaRenderingToLayer };
246     MediaRenderingMode currentRenderingMode() const;
247     MediaRenderingMode preferredRenderingMode() const;
248
249     bool metaDataAvailable() const { return m_readyState >= MediaPlayer::HaveMetadata; }
250     float requestedRate() const { return m_requestedRate; }
251     float maxTimeLoaded() const;
252     bool isReadyForVideoSetup() const;
253     virtual void setUpVideoRendering();
254     virtual void tearDownVideoRendering();
255     bool hasSetUpVideoRendering() const;
256     
257     static void mainThreadCallback(void*);
258     
259     void invalidateCachedDuration();
260
261     const String& assetURL() const { return m_assetURL; }
262
263     MediaPlayer* player() { return m_player; }
264
265     virtual String engineDescription() const { return "AVFoundation"; }
266
267 #if HAVE(AVFOUNDATION_TEXT_TRACK_SUPPORT)
268     Vector<RefPtr<InbandTextTrackPrivateAVF> > m_textTracks;
269 #endif
270     
271 private:
272     MediaPlayer* m_player;
273
274     Vector<Notification> m_queuedNotifications;
275     mutable Mutex m_queueMutex;
276
277     mutable RefPtr<TimeRanges> m_cachedLoadedTimeRanges;
278
279     MediaPlayer::NetworkState m_networkState;
280     MediaPlayer::ReadyState m_readyState;
281
282     String m_assetURL;
283     MediaPlayer::Preload m_preload;
284
285     IntSize m_cachedNaturalSize;
286     mutable float m_cachedMaxTimeLoaded;
287     mutable float m_cachedMaxTimeSeekable;
288     mutable float m_cachedDuration;
289     float m_reportedDuration;
290     mutable float m_maxTimeLoadedAtLastDidLoadingProgress;
291     float m_seekTo;
292     float m_requestedRate;
293     mutable int m_delayCallbacks;
294     bool m_mainThreadCallPending;
295     bool m_assetIsPlayable;
296     bool m_visible;
297     bool m_loadingMetadata;
298     bool m_isAllowedToRender;
299     bool m_cachedHasAudio;
300     bool m_cachedHasVideo;
301     bool m_cachedHasCaptions;
302     bool m_ignoreLoadStateChanges;
303     bool m_haveReportedFirstVideoFrame;
304     bool m_playWhenFramesAvailable;
305 #if HAVE(AVFOUNDATION_TEXT_TRACK_SUPPORT)
306     bool m_inbandTrackConfigurationPending;
307 #endif
308 };
309
310 } // namespace WebCore
311
312 #endif // ENABLE(VIDEO) && USE(AVFOUNDATION)
313
314 #endif // MediaPlayerPrivateAVFoundation_h