Eliminate MediaPlayer & MediaPlayerClient abstractions

Source/core/html/HTMLMediaElement.h

Index: Source/core/html/HTMLMediaElement.h
diff --git a/Source/core/html/HTMLMediaElement.h b/Source/core/html/HTMLMediaElement.h
index db317f5f58a4b61e62358f652528ffa95fa168b4..1e7976e666a35b1b32d070be74d1da0b6d5450e0 100644
--- a/Source/core/html/HTMLMediaElement.h
+++ b/Source/core/html/HTMLMediaElement.h
@@ -32,7 +32,8 @@
 #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"
 
@@ -65,11 +66,7 @@ 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);
@@ -83,7 +80,10 @@ public:
 #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;
@@ -113,7 +113,7 @@ public:
     NetworkState networkState() const;
 
     String preload() const;
-    MediaPlayer::Preload effectivePreloadType() const;
+    WebMediaPlayer::Preload effectivePreloadType() const;
     void setPreload(const AtomicString&);
 
     PassRefPtrWillBeRawPtr<TimeRanges> buffered() const;
@@ -188,16 +188,6 @@ public:
     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;
@@ -219,7 +209,7 @@ public:
     // 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();
@@ -229,10 +219,6 @@ public:
     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;
@@ -252,7 +238,7 @@ public:
     AudioSourceProviderClient* audioSourceNode() { return m_audioSourceNode; }
     void setAudioSourceNode(AudioSourceProviderClient*);
 
-    AudioSourceProvider* audioSourceProvider();
+    AudioSourceProvider* audioSourceProvider() { return &m_audioSourceProvider; }
 #endif
 
     enum InvalidURLAction { DoNothing, Complain };
@@ -299,6 +285,7 @@ protected:
     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; }
@@ -336,16 +323,26 @@ private:
     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>*);
@@ -512,10 +509,10 @@ private:
     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;
 
@@ -576,6 +573,54 @@ private:
     // 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;