Eliminate MediaPlayer & MediaPlayerClient abstractions

Source/core/html/HTMLMediaElement.h

 /*
  * Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 14 matching lines @@
 
 #ifndef HTMLMediaElement_h
 #define HTMLMediaElement_h
 
 #include "core/CoreExport.h"
 #include "core/dom/ActiveDOMObject.h"
 #include "core/events/GenericEventQueue.h"
 #include "core/html/HTMLElement.h"
 #include "core/html/track/TextTrack.h"
 #include "platform/Supplementable.h"
-#include "platform/graphics/media/MediaPlayer.h"
+#include "platform/audio/AudioSourceProvider.h"
+#include "public/platform/WebAudioSourceProviderClient.h"
 #include "public/platform/WebMediaPlayerClient.h"
 #include "public/platform/WebMimeRegistry.h"
 
 namespace blink {
 class WebInbandTextTrack;
 class WebLayer;
 }
 
 namespace blink {
 
@@ skipping 12 matching lines @@
 class MediaController;
 class MediaControls;
 class MediaError;
 class HTMLMediaSource;
 class TextTrackContainer;
 class TextTrackList;
 class TimeRanges;
 class URLRegistry;
 class VideoTrackList;
 
-// FIXME: The inheritance from MediaPlayerClient here should be private inheritance.
-// But it can't be until the Chromium WebMediaPlayerClientImpl class is fixed so it
-// no longer depends on typecasting a MediaPlayerClient to an HTMLMediaElement.
-
-class CORE_EXPORT HTMLMediaElement : public HTMLElement, public WillBeHeapSupplementable<HTMLMediaElement>, public MediaPlayerClient, public ActiveDOMObject {
+class CORE_EXPORT HTMLMediaElement : public HTMLElement, public WillBeHeapSupplementable<HTMLMediaElement>, public WebMediaPlayerClient, public ActiveDOMObject {

[ddorwin, 2015/07/06 20:43:01]

Can WebMediaPlayerClient be private (similar to the FIXME that was removed)?

[Srirama, 2015/07/09 15:19:37]

It is giving problem in frameloaderclientimpl while type casting mediaelement to
webmediaplayerclient.

[ddorwin, 2015/07/09 18:37:42]

I don't see such a cast (or even "webmediaplayerclient") in that file. Can you
point me to the specific line (maybe with a "HERE" comment on that line)?

philipj: Should this indeed be private inheritance as indicated by the FIXME?

[philipj_slow, 2015/07/09 19:50:15]

It's the implicit cast from HTMLMediaElement* to WebMediaPlayerClient* in
FrameLoaderClientImpl::createWebMediaPlayer that's now a problem.

The original FIXME around MediaPlayerClient, where WebMediaPlayerClientImpl had
a cast from MediaPlayerClient* to HTMLMediaElement* was IMHO worse, because
there HTMLMediaElement* was used to bypass the layering in ugly ways, especially
in WebMediaPlayerClientImpl::load().

However, the layering is still not perfect. What remains is in order to avoid
HTMLMediaElement depending on HTMLMediaElementEncryptedMedia, a core-modules
dependency violation.

The most direct path forward I can see is some method in web/ that can return a
WebMediaPlayerEncryptedMediaClient* and WebContentDecryptionModule* from a
HTMLMediaElement*, and then having HTMLMediaElement call
WebFrameClient::createMediaPlayer() itself, removing the createWebMediaPlayer
helper. Do you think that would be OK, and if so what's a good place to put
those converters?

[ddorwin, 2015/07/09 21:15:11]

Ah, thanks. I'm not an expert in where to put such things or whether that would
be better. Other options might include friending or getWebMediaPlayerClient().

For now, perhaps we should just leave a TODO (or pick a simple solution to avoid
people using WebMediaPlayerClient APIs).

[philipj_slow, 2015/07/09 21:41:03]

I think it would be OK to leave this as

// TODO(srirama.m): Make the WebMediaPlayerClient inheritance private by adding
a means for getting a WebMediaPlayerEncryptedMediaClient and
WebContentDecryptionModule from an HTMLMediaElement and calling
WebFrameClient::createMediaPlayer() directly.

Or if you want to try it out now, that'd also be OK, Srirama.

[Srirama, 2015/07/15 13:25:24]

Done. Added TODO for now.

     DEFINE_WRAPPERTYPEINFO();
     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(HTMLMediaElement);
     WILL_BE_USING_PRE_FINALIZER(HTMLMediaElement, dispose);
 public:
     static WebMimeRegistry::SupportsType supportsType(const ContentType&, const String& keySystem = String());
 
     static void setMediaStreamRegistry(URLRegistry*);
     static bool isMediaStreamURL(const String& url);
 
     DECLARE_VIRTUAL_TRACE();
 #if ENABLE(WEB_AUDIO)
     void clearWeakMembers(Visitor*);
 #endif
-    WebMediaPlayer* webMediaPlayer() const { return m_player ? m_player->webMediaPlayer() : 0; }
+    WebMediaPlayer* webMediaPlayer() const
+    {
+        return m_webMediaPlayer.get();
+    }
 
     virtual bool hasVideo() const { return false; }
     bool hasAudio() const;
 
     bool supportsSave() const;
 
     WebLayer* platformLayer() const;
 
     enum DelayedActionType {
         LoadMediaResource = 1 << 0,
         LoadTextTrackResource = 1 << 1,
         TextTrackChangesNotification = 1 << 2
     };
     void scheduleDelayedAction(DelayedActionType);
 
     bool hasRemoteRoutes() const { return m_remoteRoutesAvailable; }
     bool isPlayingRemotely() const { return m_playingRemotely; }
 
     // error state
     PassRefPtrWillBeRawPtr<MediaError> error() const;
 
     // network state
     void setSrc(const AtomicString&);
     const KURL& currentSrc() const { return m_currentSrc; }
 
     enum NetworkState { NETWORK_EMPTY, NETWORK_IDLE, NETWORK_LOADING, NETWORK_NO_SOURCE };
     NetworkState networkState() const;
 
     String preload() const;
-    MediaPlayer::Preload effectivePreloadType() const;
+    WebMediaPlayer::Preload effectivePreloadType() const;
     void setPreload(const AtomicString&);
 
     PassRefPtrWillBeRawPtr<TimeRanges> buffered() const;
     void load();
     String canPlayType(const String& mimeType, const String& keySystem = String()) const;
 
     // ready state
     enum ReadyState { HAVE_NOTHING, HAVE_METADATA, HAVE_CURRENT_DATA, HAVE_FUTURE_DATA, HAVE_ENOUGH_DATA };
     ReadyState readyState() const;
     bool seeking() const;
@@ skipping 54 matching lines @@
     void removeTextTrack(TextTrack*);
     void textTracksChanged();
     void notifyMediaPlayerOfTextTrackChanges();
 
     // Implements the "forget the media element's media-resource-specific tracks" algorithm in the HTML5 spec.
     void forgetResourceSpecificTracks();
 
     void didAddTrackElement(HTMLTrackElement*);
     void didRemoveTrackElement(HTMLTrackElement*);
 
-    WebMediaPlayer::TrackId addAudioTrack(const String& id, WebMediaPlayerClient::AudioTrackKind, const AtomicString& label, const AtomicString& language, bool enabled);
-    void removeAudioTrack(WebMediaPlayer::TrackId);
-    WebMediaPlayer::TrackId addVideoTrack(const String& id, WebMediaPlayerClient::VideoTrackKind, const AtomicString& label, const AtomicString& language, bool selected);
-    void removeVideoTrack(WebMediaPlayer::TrackId);
-
-    virtual void mediaPlayerDidAddTextTrack(WebInbandTextTrack*) override final;
-    virtual void mediaPlayerDidRemoveTextTrack(WebInbandTextTrack*) override final;
-    // FIXME: Remove this when WebMediaPlayerClientImpl::loadInternal does not depend on it.
-    virtual KURL mediaPlayerPosterURL() override { return KURL(); }
-
     void honorUserPreferencesForAutomaticTextTrackSelection();
 
     bool textTracksAreReady() const;
     enum VisibilityChangeAssumption {
         AssumeNoVisibleChange,
         AssumeVisibleChange
     };
     void configureTextTrackDisplay(VisibilityChangeAssumption);
     void updateTextTrackDisplay();
     double lastSeekTime() const { return m_lastSeekTime; }
     void textTrackReadyStateChanged(TextTrack*);
 
     void textTrackModeChanged(TextTrack*);
 
     // EventTarget function.
     // Both Node (via HTMLElement) and ActiveDOMObject define this method, which
     // causes an ambiguity error at compile time. This class's constructor
     // ensures that both implementations return document, so return the result
     // of one of them here.
     using HTMLElement::executionContext;
 
-    bool hasSingleSecurityOrigin() const { return !m_player || (webMediaPlayer() && webMediaPlayer()->hasSingleSecurityOrigin()); }
+    bool hasSingleSecurityOrigin() const { return webMediaPlayer() && webMediaPlayer()->hasSingleSecurityOrigin(); }
 
     bool isFullscreen() const;
     void enterFullscreen();
     void exitFullscreen();
 
     bool hasClosedCaptions() const;
     bool closedCaptionsVisible() const;
     void setClosedCaptionsVisible(bool);
 
-    void remoteRouteAvailabilityChanged(bool);
-    void connectedToRemoteDevice();
-    void disconnectedFromRemoteDevice();
-
     // Returns the MediaControls, or null if they have not been added yet.
     // Note that this can be non-null even if there is no controls attribute.
     MediaControls* mediaControls() const;
 
     // Notifies the media element that the media controls became visible, so
     // that text track layout may be updated to avoid overlapping them.
     void mediaControlsDidBecomeVisible();
 
     void sourceWasRemoved(HTMLSourceElement*);
     void sourceWasAdded(HTMLSourceElement*);
 
     // ActiveDOMObject functions.
     virtual bool hasPendingActivity() const override final;
     virtual void contextDestroyed() override final;
 
 #if ENABLE(WEB_AUDIO)
     AudioSourceProviderClient* audioSourceNode() { return m_audioSourceNode; }
     void setAudioSourceNode(AudioSourceProviderClient*);
 
-    AudioSourceProvider* audioSourceProvider();
+    AudioSourceProvider* audioSourceProvider() { return &m_audioSourceProvider; }
 #endif
 
     enum InvalidURLAction { DoNothing, Complain };
     bool isSafeToLoadURL(const KURL&, InvalidURLAction);
 
     // Checks to see if current media data is CORS-same-origin as the
     // specified origin.
     bool isMediaDataCORSSameOrigin(SecurityOrigin*) const;
 
     MediaController* controller() const;
@@ skipping 26 matching lines @@
 #if ENABLE(OILPAN)
     void dispose();
 #endif
 
     virtual void parseAttribute(const QualifiedName&, const AtomicString&) override;
     virtual void finishParsingChildren() override final;
     virtual bool isURLAttribute(const Attribute&) const override;
     virtual void attach(const AttachContext& = AttachContext()) override;
 
     virtual void didMoveToNewDocument(Document& oldDocument) override;
+    virtual KURL posterImageURL() const { return KURL(); }
 
     enum DisplayMode { Unknown, Poster, Video };
     DisplayMode displayMode() const { return m_displayMode; }
     virtual void setDisplayMode(DisplayMode mode) { m_displayMode = mode; }
 
     void setControllerInternal(PassRefPtrWillBeRawPtr<MediaController>);
 
 private:
     void createMediaPlayer();
 
@@ skipping 17 matching lines @@
     virtual void defaultEventHandler(Event*) override final;
 
     // ActiveDOMObject functions.
     virtual void stop() override final;
 
     virtual void updateDisplayState() { }
 
     void setReadyState(ReadyState);
     void setNetworkState(WebMediaPlayer::NetworkState);
 
-    virtual void mediaPlayerNetworkStateChanged() override final;
-    virtual void mediaPlayerReadyStateChanged() override final;
-    virtual void mediaPlayerTimeChanged() override final;
-    virtual void mediaPlayerDurationChanged() override final;
-    virtual void mediaPlayerPlaybackStateChanged() override final;
+    virtual void networkStateChanged() override final;

[ddorwin, 2015/07/06 20:43:01]

Should we label these as:
// <interface> implementation.
as we do in Chromium?

[Srirama, 2015/07/09 15:19:37]

Done.

+    virtual void readyStateChanged() override final;
+    virtual void timeChanged() override final;
+    virtual void repaint() override final;
+    virtual void durationChanged() override final;
+    virtual void sizeChanged() override final;
+    virtual void playbackStateChanged() override final;
+
+    virtual void setWebLayer(WebLayer*) override final;
+    virtual WebMediaPlayer::TrackId addAudioTrack(const WebString&, WebMediaPlayerClient::AudioTrackKind, const WebString&, const WebString&, bool) override final;
+    virtual void removeAudioTrack(WebMediaPlayer::TrackId) override final;
+    virtual WebMediaPlayer::TrackId addVideoTrack(const WebString&, WebMediaPlayerClient::VideoTrackKind, const WebString&, const WebString&, bool) override final;
+    virtual void removeVideoTrack(WebMediaPlayer::TrackId) override final;
+    virtual void addTextTrack(WebInbandTextTrack*) override final;
+    virtual void removeTextTrack(WebInbandTextTrack*) override final;
+    virtual void mediaSourceOpened(WebMediaSource*) override final;
     virtual void mediaPlayerRequestSeek(double) override final;
-    virtual void mediaPlayerRepaint() override final;
-    virtual void mediaPlayerSizeChanged() override final;
-    virtual void mediaPlayerSetWebLayer(WebLayer*) override final;
-    virtual void mediaPlayerMediaSourceOpened(WebMediaSource*) override final;
+    virtual void remoteRouteAvailabilityChanged(bool) override final;
+    virtual void connectedToRemoteDevice() override final;
+    virtual void disconnectedFromRemoteDevice() override final;
 
     void loadTimerFired(Timer<HTMLMediaElement>*);
     void progressEventTimerFired(Timer<HTMLMediaElement>*);
     void playbackProgressTimerFired(Timer<HTMLMediaElement>*);
     void startPlaybackProgressTimer();
     void startProgressEventTimer();
     void stopPeriodicTimers();
 
     void seek(double time);
     void finishSeek();
@@ skipping 146 matching lines @@
         WaitingForStopDelayingLoadEventTask,
         // The load is the deferred, and waiting for a triggering event.
         WaitingForTrigger,
         // The load is deferred, and waiting for the task to set the
         // delaying-the-load-event flag, after which the load will be executed.
         ExecuteOnStopDelayingLoadEventTask
     };
     DeferredLoadState m_deferredLoadState;
     Timer<HTMLMediaElement> m_deferredLoadTimer;
 
-    OwnPtr<MediaPlayer> m_player;
+    OwnPtr<WebMediaPlayer> m_webMediaPlayer;
     WebLayer* m_webLayer;
 
-    MediaPlayer::Preload m_preload;
+    WebMediaPlayer::Preload m_preload;
 
     DisplayMode m_displayMode;
 
     RefPtrWillBeMember<HTMLMediaSource> m_mediaSource;
 
     // Cached time value. Only valid when ready state is HAVE_METADATA or
     // higher, otherwise the current time is assumed to be zero.
     mutable double m_cachedTime;
 
     double m_fragmentEndTime;
@@ skipping 40 matching lines @@
     RefPtrWillBeMember<TextTrackList> m_textTracks;
     WillBeHeapVector<RefPtrWillBeMember<TextTrack>> m_textTracksWhenResourceSelectionBegan;
 
     OwnPtrWillBeMember<CueTimeline> m_cueTimeline;
 
 #if ENABLE(WEB_AUDIO)
     // This is a weak reference, since m_audioSourceNode holds a reference to us.
     // FIXME: Oilpan: Consider making this a strongly traced pointer with oilpan where strong cycles are not a problem.
     GC_PLUGIN_IGNORE("http://crbug.com/404577")
     RawPtrWillBeWeakMember<AudioSourceProviderClient> m_audioSourceNode;
+
+    // AudioClientImpl wraps an AudioSourceProviderClient.
+    // When the audio format is known, Chromium calls setFormat().
+
+    class AudioClientImpl final : public GarbageCollectedFinalized<AudioClientImpl>, public WebAudioSourceProviderClient {
+    public:
+        explicit AudioClientImpl(AudioSourceProviderClient* client)
+            : m_client(client)
+        {
+        }
+
+        virtual ~AudioClientImpl() { }
+
+        // WebAudioSourceProviderClient
+        virtual void setFormat(size_t numberOfChannels, float sampleRate) override;
+
+        DECLARE_TRACE();
+
+    private:
+        Member<AudioSourceProviderClient> m_client;
+    };
+
+    // AudioSourceProviderImpl wraps a WebAudioSourceProvider.
+    // provideInput() calls into Chromium to get a rendered audio stream.
+
+    class AudioSourceProviderImpl final : public AudioSourceProvider {
+    public:
+        AudioSourceProviderImpl()
+            : m_webAudioSourceProvider(0)
+        {
+        }
+
+        virtual ~AudioSourceProviderImpl() { }
+
+        // Wraps the given WebAudioSourceProvider.
+        void wrap(WebAudioSourceProvider*);
+
+        // AudioSourceProvider
+        virtual void setClient(AudioSourceProviderClient*) override;
+        virtual void provideInput(AudioBus*, size_t framesToProcess) override;
+
+    private:
+        WebAudioSourceProvider* m_webAudioSourceProvider;
+        Persistent<AudioClientImpl> m_client;
+        Mutex provideInputLock;
+    };
+
+    AudioSourceProviderImpl m_audioSourceProvider;
 #endif
 
     friend class MediaController;
     RefPtrWillBeMember<MediaController> m_mediaController;
 
     friend class Internals;
     friend class TrackDisplayUpdateScope;
 
     static URLRegistry* s_mediaStreamRegistry;
 };
 
 inline bool isHTMLMediaElement(const HTMLElement& element)
 {
     return isHTMLAudioElement(element) || isHTMLVideoElement(element);
 }
 
 DEFINE_HTMLELEMENT_TYPE_CASTS_WITH_FUNCTION(HTMLMediaElement);
 
 } // namespace blink
 
 #endif // HTMLMediaElement_h