Move ValueToString out to its own header file to remove duplication
[WebKit-https.git] / Source / WebCore / html / HTMLMediaElement.h
1 /*
2  * Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 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 HTMLMediaElement_h
27 #define HTMLMediaElement_h
28
29 #if ENABLE(VIDEO)
30 #include "HTMLElement.h"
31 #include "ActiveDOMObject.h"
32 #include "GenericEventQueue.h"
33 #include "MediaCanStartListener.h"
34 #include "MediaControllerInterface.h"
35 #include "MediaPlayer.h"
36
37 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
38 #include "HTMLPlugInImageElement.h"
39 #include "MediaPlayerProxy.h"
40 #endif
41
42 #if ENABLE(VIDEO_TRACK)
43 #include "AudioTrack.h"
44 #include "CaptionUserPreferences.h"
45 #include "PODIntervalTree.h"
46 #include "TextTrack.h"
47 #include "TextTrackCue.h"
48 #include "VideoTrack.h"
49 #endif
50
51
52
53 namespace WebCore {
54
55 #if USE(AUDIO_SESSION)
56 class AudioSessionManagerToken;
57 #endif
58 #if ENABLE(WEB_AUDIO)
59 class AudioSourceProvider;
60 class MediaElementAudioSourceNode;
61 #endif
62 class Event;
63 class HTMLSourceElement;
64 class HTMLTrackElement;
65 class URL;
66 class MediaController;
67 class MediaControls;
68 class MediaControlsHost;
69 class MediaError;
70 class PageActivityAssertionToken;
71 class TimeRanges;
72 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
73 class Widget;
74 #endif
75 #if PLATFORM(MAC)
76 class DisplaySleepDisabler;
77 #endif
78 #if ENABLE(ENCRYPTED_MEDIA_V2)
79 class MediaKeys;
80 #endif
81
82 #if ENABLE(VIDEO_TRACK)
83 class AudioTrackList;
84 class AudioTrackPrivate;
85 class InbandTextTrackPrivate;
86 class TextTrackList;
87 class VideoTrackList;
88 class VideoTrackPrivate;
89
90 typedef PODIntervalTree<double, TextTrackCue*> CueIntervalTree;
91 typedef CueIntervalTree::IntervalType CueInterval;
92 typedef Vector<CueInterval> CueList;
93 #endif
94
95 class HTMLMediaElement : public HTMLElement, private MediaPlayerClient, public MediaPlayerSupportsTypeClient, private MediaCanStartListener, public ActiveDOMObject, public MediaControllerInterface
96 #if ENABLE(VIDEO_TRACK)
97     , private AudioTrackClient
98     , private TextTrackClient
99     , private VideoTrackClient
100 #endif
101 #if USE(PLATFORM_TEXT_TRACK_MENU)
102     , public PlatformTextTrackMenuClient
103 #endif
104 {
105 public:
106     MediaPlayer* player() const { return m_player.get(); }
107
108     virtual bool isVideo() const { return false; }
109     virtual bool hasVideo() const OVERRIDE { return false; }
110     virtual bool hasAudio() const OVERRIDE;
111
112     void rewind(double timeDelta);
113     virtual void returnToRealtime() OVERRIDE;
114
115     // Eventually overloaded in HTMLVideoElement
116     virtual bool supportsFullscreen() const OVERRIDE { return false; };
117
118     virtual bool supportsSave() const;
119     virtual bool supportsScanning() const OVERRIDE;
120     
121     PlatformMedia platformMedia() const;
122 #if USE(ACCELERATED_COMPOSITING)
123     PlatformLayer* platformLayer() const;
124 #endif
125
126     enum DelayedActionType {
127         LoadMediaResource = 1 << 0,
128         ConfigureTextTracks = 1 << 1,
129         TextTrackChangesNotification = 1 << 2,
130         ConfigureTextTrackDisplay = 1 << 3,
131     };
132     void scheduleDelayedAction(DelayedActionType);
133     
134     MediaPlayer::MovieLoadType movieLoadType() const;
135     
136     bool inActiveDocument() const { return m_inActiveDocument; }
137     
138 // DOM API
139 // error state
140     PassRefPtr<MediaError> error() const;
141
142 // network state
143     void setSrc(const String&);
144     const URL& currentSrc() const { return m_currentSrc; }
145
146     enum NetworkState { NETWORK_EMPTY, NETWORK_IDLE, NETWORK_LOADING, NETWORK_NO_SOURCE };
147     NetworkState networkState() const;
148
149     String preload() const;    
150     void setPreload(const String&);
151
152     virtual PassRefPtr<TimeRanges> buffered() const OVERRIDE;
153     void load();
154     String canPlayType(const String& mimeType, const String& keySystem = String(), const URL& = URL()) const;
155
156 // ready state
157     virtual ReadyState readyState() const OVERRIDE;
158     bool seeking() const;
159
160 // playback state
161     virtual double currentTime() const OVERRIDE;
162     virtual void setCurrentTime(double, ExceptionCode&) OVERRIDE;
163     virtual double duration() const OVERRIDE;
164     virtual bool paused() const OVERRIDE;
165     virtual double defaultPlaybackRate() const OVERRIDE;
166     virtual void setDefaultPlaybackRate(double) OVERRIDE;
167     virtual double playbackRate() const OVERRIDE;
168     virtual void setPlaybackRate(double) OVERRIDE;
169     void updatePlaybackRate();
170     bool webkitPreservesPitch() const;
171     void setWebkitPreservesPitch(bool);
172     virtual PassRefPtr<TimeRanges> played() OVERRIDE;
173     virtual PassRefPtr<TimeRanges> seekable() const OVERRIDE;
174     bool ended() const;
175     bool autoplay() const;    
176     void setAutoplay(bool b);
177     bool loop() const;    
178     void setLoop(bool b);
179     virtual void play() OVERRIDE;
180     virtual void pause() OVERRIDE;
181
182 // captions
183     bool webkitHasClosedCaptions() const;
184     bool webkitClosedCaptionsVisible() const;
185     void setWebkitClosedCaptionsVisible(bool);
186
187 #if ENABLE(MEDIA_STATISTICS)
188 // Statistics
189     unsigned webkitAudioDecodedByteCount() const;
190     unsigned webkitVideoDecodedByteCount() const;
191 #endif
192
193 #if ENABLE(MEDIA_SOURCE)
194 //  Media Source.
195     void closeMediaSource();
196 #endif 
197
198 #if ENABLE(ENCRYPTED_MEDIA)
199     void webkitGenerateKeyRequest(const String& keySystem, PassRefPtr<Uint8Array> initData, ExceptionCode&);
200     void webkitGenerateKeyRequest(const String& keySystem, ExceptionCode&);
201     void webkitAddKey(const String& keySystem, PassRefPtr<Uint8Array> key, PassRefPtr<Uint8Array> initData, const String& sessionId, ExceptionCode&);
202     void webkitAddKey(const String& keySystem, PassRefPtr<Uint8Array> key, ExceptionCode&);
203     void webkitCancelKeyRequest(const String& keySystem, const String& sessionId, ExceptionCode&);
204
205     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitkeyadded);
206     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitkeyerror);
207     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitkeymessage);
208 #endif
209 #if ENABLE(ENCRYPTED_MEDIA) || ENABLE(ENCRYPTED_MEDIA_V2)
210     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitneedkey);
211 #endif
212
213 #if ENABLE(ENCRYPTED_MEDIA_V2)
214     MediaKeys* keys() const { return m_mediaKeys.get(); }
215     void setMediaKeys(MediaKeys*);
216 #endif
217
218 // controls
219     bool controls() const;
220     void setControls(bool);
221     virtual double volume() const OVERRIDE;
222     virtual void setVolume(double, ExceptionCode&) OVERRIDE;
223     virtual bool muted() const OVERRIDE;
224     virtual void setMuted(bool) OVERRIDE;
225
226     void togglePlayState();
227     virtual void beginScrubbing() OVERRIDE;
228     virtual void endScrubbing() OVERRIDE;
229     
230     virtual bool canPlay() const OVERRIDE;
231
232     double percentLoaded() const;
233
234 #if ENABLE(VIDEO_TRACK)
235     PassRefPtr<TextTrack> addTextTrack(const String& kind, const String& label, const String& language, ExceptionCode&);
236     PassRefPtr<TextTrack> addTextTrack(const String& kind, const String& label, ExceptionCode& ec) { return addTextTrack(kind, label, emptyString(), ec); }
237     PassRefPtr<TextTrack> addTextTrack(const String& kind, ExceptionCode& ec) { return addTextTrack(kind, emptyString(), emptyString(), ec); }
238
239     AudioTrackList* audioTracks();
240     TextTrackList* textTracks();
241     VideoTrackList* videoTracks();
242
243     CueList currentlyActiveCues() const { return m_currentlyActiveCues; }
244
245     void addAudioTrack(PassRefPtr<AudioTrack>);
246     void addTextTrack(PassRefPtr<TextTrack>);
247     void addVideoTrack(PassRefPtr<VideoTrack>);
248     void removeAudioTrack(AudioTrack*);
249     void removeTextTrack(TextTrack*);
250     void removeVideoTrack(VideoTrack*);
251     void removeAllInbandTracks();
252     void closeCaptionTracksChanged();
253     void notifyMediaPlayerOfTextTrackChanges();
254
255     virtual void didAddTextTrack(HTMLTrackElement*);
256     virtual void didRemoveTextTrack(HTMLTrackElement*);
257
258     virtual void mediaPlayerDidAddAudioTrack(PassRefPtr<AudioTrackPrivate>) OVERRIDE;
259     virtual void mediaPlayerDidAddTextTrack(PassRefPtr<InbandTextTrackPrivate>) OVERRIDE;
260     virtual void mediaPlayerDidAddVideoTrack(PassRefPtr<VideoTrackPrivate>) OVERRIDE;
261     virtual void mediaPlayerDidRemoveAudioTrack(PassRefPtr<AudioTrackPrivate>) OVERRIDE;
262     virtual void mediaPlayerDidRemoveTextTrack(PassRefPtr<InbandTextTrackPrivate>) OVERRIDE;
263     virtual void mediaPlayerDidRemoveVideoTrack(PassRefPtr<VideoTrackPrivate>) OVERRIDE;
264
265 #if USE(PLATFORM_TEXT_TRACK_MENU)
266     virtual void setSelectedTextTrack(PassRefPtr<PlatformTextTrack>) OVERRIDE;
267     virtual Vector<RefPtr<PlatformTextTrack>> platformTextTracks() OVERRIDE;
268     PlatformTextTrackMenuInterface* platformTextTrackMenu();
269 #endif
270
271     struct TrackGroup {
272         enum GroupKind { CaptionsAndSubtitles, Description, Chapter, Metadata, Other };
273
274         TrackGroup(GroupKind kind)
275             : visibleTrack(0)
276             , defaultTrack(0)
277             , kind(kind)
278             , hasSrcLang(false)
279         {
280         }
281
282         Vector<RefPtr<TextTrack>> tracks;
283         RefPtr<TextTrack> visibleTrack;
284         RefPtr<TextTrack> defaultTrack;
285         GroupKind kind;
286         bool hasSrcLang;
287     };
288
289     void configureTextTrackGroupForLanguage(const TrackGroup&) const;
290     void configureTextTracks();
291     void configureTextTrackGroup(const TrackGroup&);
292
293     void setSelectedTextTrack(TextTrack*);
294
295     bool textTracksAreReady() const;
296     enum TextTrackVisibilityCheckType { CheckTextTrackVisibility, AssumeTextTrackVisibilityChanged };
297     void configureTextTrackDisplay(TextTrackVisibilityCheckType checkType = CheckTextTrackVisibility);
298     void updateTextTrackDisplay();
299
300     // AudioTrackClient
301     virtual void audioTrackEnabledChanged(AudioTrack*) OVERRIDE;
302
303     // TextTrackClient
304     virtual void textTrackReadyStateChanged(TextTrack*);
305     virtual void textTrackKindChanged(TextTrack*) OVERRIDE;
306     virtual void textTrackModeChanged(TextTrack*) OVERRIDE;
307     virtual void textTrackAddCues(TextTrack*, const TextTrackCueList*) OVERRIDE;
308     virtual void textTrackRemoveCues(TextTrack*, const TextTrackCueList*) OVERRIDE;
309     virtual void textTrackAddCue(TextTrack*, PassRefPtr<TextTrackCue>) OVERRIDE;
310     virtual void textTrackRemoveCue(TextTrack*, PassRefPtr<TextTrackCue>) OVERRIDE;
311
312     // VideoTrackClient
313     virtual void videoTrackSelectedChanged(VideoTrack*) OVERRIDE;
314
315     bool requiresTextTrackRepresentation() const;
316     void setTextTrackRepresentation(TextTrackRepresentation*);
317 #endif
318
319 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
320     void allocateMediaPlayerIfNecessary();
321     void setNeedWidgetUpdate(bool needWidgetUpdate) { m_needWidgetUpdate = needWidgetUpdate; }
322     void deliverNotification(MediaPlayerProxyNotificationType notification);
323     void setMediaPlayerProxy(WebMediaPlayerProxy* proxy);
324     void getPluginProxyParams(URL& url, Vector<String>& names, Vector<String>& values);
325     void createMediaPlayerProxy();
326     void updateWidget(PluginCreationOption);
327 #endif
328
329     // EventTarget function.
330     // Both Node (via HTMLElement) and ActiveDOMObject define this method, which
331     // causes an ambiguity error at compile time. This class's constructor
332     // ensures that both implementations return document, so return the result
333     // of one of them here.
334     using HTMLElement::scriptExecutionContext;
335
336     bool hasSingleSecurityOrigin() const { return !m_player || m_player->hasSingleSecurityOrigin(); }
337     
338     virtual bool isFullscreen() const OVERRIDE;
339     void toggleFullscreenState();
340     virtual void enterFullscreen() OVERRIDE;
341     void exitFullscreen();
342
343     virtual bool hasClosedCaptions() const OVERRIDE;
344     virtual bool closedCaptionsVisible() const OVERRIDE;
345     virtual void setClosedCaptionsVisible(bool) OVERRIDE;
346
347     MediaControls* mediaControls() const;
348
349     void sourceWasRemoved(HTMLSourceElement*);
350     void sourceWasAdded(HTMLSourceElement*);
351
352     virtual void privateBrowsingStateDidChange() OVERRIDE;
353
354     // Media cache management.
355     static void getSitesInMediaCache(Vector<String>&);
356     static void clearMediaCache();
357     static void clearMediaCacheForSite(const String&);
358     static void resetMediaEngines();
359
360     bool isPlaying() const { return m_playing; }
361
362     virtual bool hasPendingActivity() const OVERRIDE;
363
364 #if ENABLE(WEB_AUDIO)
365     MediaElementAudioSourceNode* audioSourceNode() { return m_audioSourceNode; }
366     void setAudioSourceNode(MediaElementAudioSourceNode*);
367
368     AudioSourceProvider* audioSourceProvider();
369 #endif
370
371     enum InvalidURLAction { DoNothing, Complain };
372     bool isSafeToLoadURL(const URL&, InvalidURLAction);
373
374     const String& mediaGroup() const;
375     void setMediaGroup(const String&);
376
377     MediaController* controller() const;
378     void setController(PassRefPtr<MediaController>);
379
380     virtual bool willRespondToMouseClickEvents() OVERRIDE;
381
382     void enteredOrExitedFullscreen() { configureMediaControls(); }
383
384 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
385     bool shouldUseVideoPluginProxy() const;
386 #endif
387
388 protected:
389     HTMLMediaElement(const QualifiedName&, Document&, bool);
390     virtual ~HTMLMediaElement();
391
392     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
393     virtual void finishParsingChildren() OVERRIDE;
394     virtual bool isURLAttribute(const Attribute&) const OVERRIDE;
395     virtual void willAttachRenderers() OVERRIDE;
396     virtual void didAttachRenderers() OVERRIDE;
397
398     virtual void didMoveToNewDocument(Document* oldDocument) OVERRIDE;
399
400     enum DisplayMode { Unknown, None, Poster, PosterWaitingForVideo, Video };
401     DisplayMode displayMode() const { return m_displayMode; }
402     virtual void setDisplayMode(DisplayMode mode) { m_displayMode = mode; }
403     
404     virtual bool isMediaElement() const OVERRIDE { return true; }
405
406     // Restrictions to change default behaviors.
407     enum BehaviorRestrictionFlags {
408         NoRestrictions = 0,
409         RequireUserGestureForLoadRestriction = 1 << 0,
410         RequireUserGestureForRateChangeRestriction = 1 << 1,
411         RequireUserGestureForFullscreenRestriction = 1 << 2,
412         RequirePageConsentToLoadMediaRestriction = 1 << 3,
413         RequirePageConsentToResumeMediaRestriction = 1 << 4,
414     };
415     typedef unsigned BehaviorRestrictions;
416     
417     bool userGestureRequiredForLoad() const { return m_restrictions & RequireUserGestureForLoadRestriction; }
418     bool userGestureRequiredForRateChange() const { return m_restrictions & RequireUserGestureForRateChangeRestriction; }
419     bool userGestureRequiredForFullscreen() const { return m_restrictions & RequireUserGestureForFullscreenRestriction; }
420     bool pageConsentRequiredForLoad() const { return m_restrictions & RequirePageConsentToLoadMediaRestriction; }
421     bool pageConsentRequiredForResume() const { return m_restrictions & RequirePageConsentToResumeMediaRestriction; }
422     
423     void addBehaviorRestriction(BehaviorRestrictions restriction) { m_restrictions |= restriction; }
424     void removeBehaviorRestriction(BehaviorRestrictions restriction) { m_restrictions &= ~restriction; }
425
426 #if ENABLE(VIDEO_TRACK)
427     bool ignoreTrackDisplayUpdateRequests() const { return m_ignoreTrackDisplayUpdate > 0 || !m_textTracks || !m_cueTree.size(); }
428     void beginIgnoringTrackDisplayUpdateRequests();
429     void endIgnoringTrackDisplayUpdateRequests();
430 #endif
431
432     virtual RenderElement* createRenderer(PassRef<RenderStyle>) OVERRIDE;
433
434 private:
435     void createMediaPlayer();
436
437     virtual bool alwaysCreateUserAgentShadowRoot() const OVERRIDE { return true; }
438     virtual bool areAuthorShadowsAllowed() const OVERRIDE { return false; }
439
440     virtual bool hasCustomFocusLogic() const OVERRIDE;
441     virtual bool supportsFocus() const OVERRIDE;
442     virtual bool isMouseFocusable() const OVERRIDE;
443     virtual bool rendererIsNeeded(const RenderStyle&) OVERRIDE;
444     virtual bool childShouldCreateRenderer(const Node&) const OVERRIDE;
445     virtual InsertionNotificationRequest insertedInto(ContainerNode&) OVERRIDE;
446     virtual void removedFrom(ContainerNode&) OVERRIDE;
447     virtual void didRecalcStyle(Style::Change) OVERRIDE;
448
449     virtual void defaultEventHandler(Event*) OVERRIDE;
450
451     virtual void didBecomeFullscreenElement() OVERRIDE;
452     virtual void willStopBeingFullscreenElement() OVERRIDE;
453
454     // ActiveDOMObject functions.
455     virtual bool canSuspend() const OVERRIDE;
456     virtual void suspend(ReasonForSuspension) OVERRIDE;
457     virtual void resume() OVERRIDE;
458     virtual void stop() OVERRIDE;
459     
460     virtual void mediaVolumeDidChange() OVERRIDE;
461
462 #if ENABLE(PAGE_VISIBILITY_API)
463     virtual void visibilityStateChanged() OVERRIDE;
464 #endif
465
466     virtual void updateDisplayState() { }
467     
468     void setReadyState(MediaPlayer::ReadyState);
469     void setNetworkState(MediaPlayer::NetworkState);
470
471     virtual Document* mediaPlayerOwningDocument() OVERRIDE;
472     virtual void mediaPlayerNetworkStateChanged(MediaPlayer*) OVERRIDE;
473     virtual void mediaPlayerReadyStateChanged(MediaPlayer*) OVERRIDE;
474     virtual void mediaPlayerTimeChanged(MediaPlayer*) OVERRIDE;
475     virtual void mediaPlayerVolumeChanged(MediaPlayer*) OVERRIDE;
476     virtual void mediaPlayerMuteChanged(MediaPlayer*) OVERRIDE;
477     virtual void mediaPlayerDurationChanged(MediaPlayer*) OVERRIDE;
478     virtual void mediaPlayerRateChanged(MediaPlayer*) OVERRIDE;
479     virtual void mediaPlayerPlaybackStateChanged(MediaPlayer*) OVERRIDE;
480     virtual void mediaPlayerSawUnsupportedTracks(MediaPlayer*) OVERRIDE;
481     virtual void mediaPlayerResourceNotSupported(MediaPlayer*) OVERRIDE;
482     virtual void mediaPlayerRepaint(MediaPlayer*) OVERRIDE;
483     virtual void mediaPlayerSizeChanged(MediaPlayer*) OVERRIDE;
484 #if USE(ACCELERATED_COMPOSITING)
485     virtual bool mediaPlayerRenderingCanBeAccelerated(MediaPlayer*) OVERRIDE;
486     virtual void mediaPlayerRenderingModeChanged(MediaPlayer*) OVERRIDE;
487 #endif
488     virtual void mediaPlayerEngineUpdated(MediaPlayer*) OVERRIDE;
489     
490     virtual void mediaPlayerFirstVideoFrameAvailable(MediaPlayer*) OVERRIDE;
491     virtual void mediaPlayerCharacteristicChanged(MediaPlayer*) OVERRIDE;
492
493 #if ENABLE(ENCRYPTED_MEDIA)
494     virtual void mediaPlayerKeyAdded(MediaPlayer*, const String& keySystem, const String& sessionId) OVERRIDE;
495     virtual void mediaPlayerKeyError(MediaPlayer*, const String& keySystem, const String& sessionId, MediaPlayerClient::MediaKeyErrorCode, unsigned short systemCode) OVERRIDE;
496     virtual void mediaPlayerKeyMessage(MediaPlayer*, const String& keySystem, const String& sessionId, const unsigned char* message, unsigned messageLength, const URL& defaultURL) OVERRIDE;
497     virtual bool mediaPlayerKeyNeeded(MediaPlayer*, const String& keySystem, const String& sessionId, const unsigned char* initData, unsigned initDataLength) OVERRIDE;
498 #endif
499
500 #if ENABLE(ENCRYPTED_MEDIA_V2)
501     virtual bool mediaPlayerKeyNeeded(MediaPlayer*, Uint8Array*) OVERRIDE;
502 #endif
503
504     virtual String mediaPlayerReferrer() const OVERRIDE;
505     virtual String mediaPlayerUserAgent() const OVERRIDE;
506     virtual CORSMode mediaPlayerCORSMode() const OVERRIDE;
507
508     virtual bool mediaPlayerNeedsSiteSpecificHacks() const OVERRIDE;
509     virtual String mediaPlayerDocumentHost() const OVERRIDE;
510
511     virtual void mediaPlayerEnterFullscreen() OVERRIDE;
512     virtual void mediaPlayerExitFullscreen() OVERRIDE;
513     virtual bool mediaPlayerIsFullscreen() const OVERRIDE;
514     virtual bool mediaPlayerIsFullscreenPermitted() const OVERRIDE;
515     virtual bool mediaPlayerIsVideo() const OVERRIDE;
516     virtual LayoutRect mediaPlayerContentBoxRect() const OVERRIDE;
517     virtual void mediaPlayerSetSize(const IntSize&) OVERRIDE;
518     virtual void mediaPlayerPause() OVERRIDE;
519     virtual void mediaPlayerPlay() OVERRIDE;
520     virtual bool mediaPlayerPlatformVolumeConfigurationRequired() const OVERRIDE;
521     virtual bool mediaPlayerIsPaused() const OVERRIDE;
522     virtual bool mediaPlayerIsLooping() const OVERRIDE;
523     virtual HostWindow* mediaPlayerHostWindow() OVERRIDE;
524     virtual IntRect mediaPlayerWindowClipRect() OVERRIDE;
525     virtual CachedResourceLoader* mediaPlayerCachedResourceLoader() OVERRIDE;
526
527 #if PLATFORM(WIN) && USE(AVFOUNDATION)
528     virtual GraphicsDeviceAdapter* mediaPlayerGraphicsDeviceAdapter(const MediaPlayer*) const OVERRIDE;
529 #endif
530
531     void loadTimerFired(Timer<HTMLMediaElement>*);
532     void progressEventTimerFired(Timer<HTMLMediaElement>*);
533     void playbackProgressTimerFired(Timer<HTMLMediaElement>*);
534     void startPlaybackProgressTimer();
535     void startProgressEventTimer();
536     void stopPeriodicTimers();
537
538     void seek(double time, ExceptionCode&);
539     void finishSeek();
540     void checkIfSeekNeeded();
541     void addPlayedRange(double start, double end);
542     
543     void scheduleTimeupdateEvent(bool periodicEvent);
544     void scheduleEvent(const AtomicString& eventName);
545     
546     // loading
547     void selectMediaResource();
548     void loadResource(const URL&, ContentType&, const String& keySystem);
549     void scheduleNextSourceChild();
550     void loadNextSourceChild();
551     void userCancelledLoad();
552     void clearMediaPlayer(int flags);
553     bool havePotentialSourceChild();
554     void noneSupported();
555     void mediaEngineError(PassRefPtr<MediaError> err);
556     void cancelPendingEventsAndCallbacks();
557     void waitForSourceChange();
558     void prepareToPlay();
559
560     URL selectNextSourceChild(ContentType*, String* keySystem, InvalidURLAction);
561
562     void mediaLoadingFailed(MediaPlayer::NetworkState);
563
564 #if ENABLE(VIDEO_TRACK)
565     void updateActiveTextTrackCues(double);
566     HTMLTrackElement* showingTrackWithSameKind(HTMLTrackElement*) const;
567
568     enum ReconfigureMode {
569         Immediately,
570         AfterDelay,
571     };
572     void markCaptionAndSubtitleTracksAsUnconfigured(ReconfigureMode);
573     virtual void captionPreferencesChanged() OVERRIDE;
574 #endif
575
576     // These "internal" functions do not check user gesture restrictions.
577     void loadInternal();
578     void playInternal();
579     void pauseInternal();
580
581     void prepareForLoad();
582     void allowVideoRendering();
583
584     bool processingMediaPlayerCallback() const { return m_processingMediaPlayerCallback > 0; }
585     void beginProcessingMediaPlayerCallback() { ++m_processingMediaPlayerCallback; }
586     void endProcessingMediaPlayerCallback() { ASSERT(m_processingMediaPlayerCallback); --m_processingMediaPlayerCallback; }
587
588     void updateVolume();
589     void updatePlayState();
590     bool potentiallyPlaying() const;
591     bool endedPlayback() const;
592     bool stoppedDueToErrors() const;
593     bool pausedForUserInteraction() const;
594     bool couldPlayIfEnoughData() const;
595
596     double minTimeSeekable() const;
597     double maxTimeSeekable() const;
598
599     // Pauses playback without changing any states or generating events
600     void setPausedInternal(bool);
601
602     void setPlaybackRateInternal(double);
603
604     virtual void mediaCanStart() OVERRIDE;
605
606     void setShouldDelayLoadEvent(bool);
607     void invalidateCachedTime();
608     void refreshCachedTime() const;
609
610     bool hasMediaControls() const;
611     bool createMediaControls();
612     void configureMediaControls();
613
614     void prepareMediaFragmentURI();
615     void applyMediaFragmentURI();
616
617     void changeNetworkStateFromLoadingToIdle();
618
619     void removeBehaviorsRestrictionsAfterFirstUserGesture();
620
621     void updateMediaController();
622     bool isBlocked() const;
623     bool isBlockedOnMediaController() const;
624     virtual bool hasCurrentSrc() const OVERRIDE { return !m_currentSrc.isEmpty(); }
625     virtual bool isLiveStream() const OVERRIDE { return movieLoadType() == MediaPlayer::LiveStream; }
626     bool isAutoplaying() const { return m_autoplaying; }
627
628     void updateSleepDisabling();
629 #if PLATFORM(MAC)
630     bool shouldDisableSleep() const;
631 #endif
632
633 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
634     virtual void didAddUserAgentShadowRoot(ShadowRoot*) OVERRIDE;
635     DOMWrapperWorld& ensureIsolatedWorld();
636     bool ensureMediaControlsInjectedScript();
637 #endif
638
639     Timer<HTMLMediaElement> m_loadTimer;
640     Timer<HTMLMediaElement> m_progressEventTimer;
641     Timer<HTMLMediaElement> m_playbackProgressTimer;
642     RefPtr<TimeRanges> m_playedTimeRanges;
643     GenericEventQueue m_asyncEventQueue;
644
645     double m_playbackRate;
646     double m_defaultPlaybackRate;
647     bool m_webkitPreservesPitch;
648     NetworkState m_networkState;
649     ReadyState m_readyState;
650     ReadyState m_readyStateMaximum;
651     URL m_currentSrc;
652
653     RefPtr<MediaError> m_error;
654
655     double m_volume;
656     bool m_volumeInitialized;
657     double m_lastSeekTime;
658     
659     unsigned m_previousProgress;
660     double m_previousProgressTime;
661
662     // The last time a timeupdate event was sent (based on monotonic clock).
663     double m_clockTimeAtLastUpdateEvent;
664
665     // The last time a timeupdate event was sent in movie time.
666     double m_lastTimeUpdateEventMovieTime;
667     
668     // Loading state.
669     enum LoadState { WaitingForSource, LoadingFromSrcAttr, LoadingFromSourceElement };
670     LoadState m_loadState;
671     RefPtr<HTMLSourceElement> m_currentSourceNode;
672     RefPtr<Node> m_nextChildNodeToConsider;
673
674     OwnPtr<MediaPlayer> m_player;
675 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
676     RefPtr<Widget> m_proxyWidget;
677 #endif
678
679     BehaviorRestrictions m_restrictions;
680     
681     MediaPlayer::Preload m_preload;
682
683     DisplayMode m_displayMode;
684
685     // Counter incremented while processing a callback from the media player, so we can avoid
686     // calling the media engine recursively.
687     int m_processingMediaPlayerCallback;
688
689 #if ENABLE(MEDIA_SOURCE)
690     RefPtr<HTMLMediaSource> m_mediaSource;
691 #endif
692
693     mutable double m_cachedTime;
694     mutable double m_clockTimeAtLastCachedTimeUpdate;
695     mutable double m_minimumClockTimeToUpdateCachedTime;
696
697     double m_fragmentStartTime;
698     double m_fragmentEndTime;
699
700     typedef unsigned PendingActionFlags;
701     PendingActionFlags m_pendingActionFlags;
702
703     bool m_playing : 1;
704     bool m_isWaitingUntilMediaCanStart : 1;
705     bool m_shouldDelayLoadEvent : 1;
706     bool m_haveFiredLoadedData : 1;
707     bool m_inActiveDocument : 1;
708     bool m_autoplaying : 1;
709     bool m_muted : 1;
710     bool m_paused : 1;
711     bool m_seeking : 1;
712
713     // data has not been loaded since sending a "stalled" event
714     bool m_sentStalledEvent : 1;
715
716     // time has not changed since sending an "ended" event
717     bool m_sentEndEvent : 1;
718
719     bool m_pausedInternal : 1;
720
721     // Not all media engines provide enough information about a file to be able to
722     // support progress events so setting m_sendProgressEvents disables them 
723     bool m_sendProgressEvents : 1;
724
725     bool m_isFullscreen : 1;
726     bool m_closedCaptionsVisible : 1;
727     bool m_webkitLegacyClosedCaptionOverride : 1;
728
729 #if ENABLE(PLUGIN_PROXY_FOR_VIDEO)
730     bool m_needWidgetUpdate : 1;
731 #endif
732
733     bool m_loadInitiatedByUserGesture : 1;
734     bool m_completelyLoaded : 1;
735     bool m_havePreparedToPlay : 1;
736     bool m_parsingInProgress : 1;
737 #if ENABLE(PAGE_VISIBILITY_API)
738     bool m_isDisplaySleepDisablingSuspended : 1;
739 #endif
740
741 #if ENABLE(VIDEO_TRACK)
742     bool m_tracksAreReady : 1;
743     bool m_haveVisibleTextTrack : 1;
744     bool m_processingPreferenceChange : 1;
745
746     String m_subtitleTrackLanguage;
747     float m_lastTextTrackUpdateTime;
748
749     CaptionUserPreferences::CaptionDisplayMode m_captionDisplayMode;
750
751     RefPtr<AudioTrackList> m_audioTracks;
752     RefPtr<TextTrackList> m_textTracks;
753     RefPtr<VideoTrackList> m_videoTracks;
754     Vector<RefPtr<TextTrack>> m_textTracksWhenResourceSelectionBegan;
755
756     CueIntervalTree m_cueTree;
757
758     CueList m_currentlyActiveCues;
759     int m_ignoreTrackDisplayUpdate;
760 #endif
761
762 #if ENABLE(WEB_AUDIO)
763     // This is a weak reference, since m_audioSourceNode holds a reference to us.
764     // The value is set just after the MediaElementAudioSourceNode is created.
765     // The value is cleared in MediaElementAudioSourceNode::~MediaElementAudioSourceNode().
766     MediaElementAudioSourceNode* m_audioSourceNode;
767 #endif
768
769     String m_mediaGroup;
770     friend class MediaController;
771     RefPtr<MediaController> m_mediaController;
772
773 #if PLATFORM(MAC)
774     OwnPtr<DisplaySleepDisabler> m_sleepDisabler;
775 #endif
776
777     friend class TrackDisplayUpdateScope;
778
779 #if ENABLE(ENCRYPTED_MEDIA_V2)
780     RefPtr<MediaKeys> m_mediaKeys;
781 #endif
782
783 #if USE(PLATFORM_TEXT_TRACK_MENU)
784     RefPtr<PlatformTextTrackMenuInterface> m_platformMenu;
785 #endif
786
787 #if USE(AUDIO_SESSION)
788     OwnPtr<AudioSessionManagerToken> m_audioSessionManagerToken;
789 #endif
790
791     std::unique_ptr<PageActivityAssertionToken> m_activityToken;
792     size_t m_reportedExtraMemoryCost;
793
794 #if ENABLE(MEDIA_CONTROLS_SCRIPT)
795     RefPtr<MediaControlsHost> m_mediaControlsHost;
796     RefPtr<DOMWrapperWorld> m_isolatedWorld;
797 #endif
798 };
799
800 #if ENABLE(VIDEO_TRACK)
801 #ifndef NDEBUG
802 // Template specialization required by PodIntervalTree in debug mode.
803 template <>
804 struct ValueToString<TextTrackCue*> {
805     static String string(TextTrackCue* const& cue)
806     {
807         return String::format("%p id=%s interval=%f-->%f cue=%s)", cue, cue->id().utf8().data(), cue->startTime(), cue->endTime(), cue->text().utf8().data());
808     }
809 };
810 #endif
811 #endif
812
813 void isHTMLMediaElement(const HTMLMediaElement&); // Catch unnecessary runtime check of type known at compile time.
814 inline bool isHTMLMediaElement(const Element& element) { return element.isMediaElement(); }
815 inline bool isHTMLMediaElement(const Node& node) { return node.isElementNode() && toElement(node).isMediaElement(); }
816 template <> inline bool isElementOfType<const HTMLMediaElement>(const Element& element) { return element.isMediaElement(); }
817
818 NODE_TYPE_CASTS(HTMLMediaElement)
819
820 } //namespace
821
822 #endif
823 #endif