[Android] A prototype of the interactive media notification.

chrome/android/java_staging/src/org/chromium/chrome/browser/tab/ChromeTab.java

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.tab;
 
 import android.annotation.TargetApi;
 import android.content.Context;
 import android.content.Intent;
 import android.graphics.Rect;
@@ skipping 17 matching lines @@
 import org.chromium.chrome.browser.EmptyTabObserver;
 import org.chromium.chrome.browser.FrozenNativePage;
 import org.chromium.chrome.browser.IntentHandler.TabOpenType;
 import org.chromium.chrome.browser.NativePage;
 import org.chromium.chrome.browser.Tab;
 import org.chromium.chrome.browser.TabObserver;
 import org.chromium.chrome.browser.TabState;
 import org.chromium.chrome.browser.TabUma;
 import org.chromium.chrome.browser.TabUma.TabCreationState;
 import org.chromium.chrome.browser.UrlConstants;
+import org.chromium.chrome.browser.UrlUtilities;
 import org.chromium.chrome.browser.contextmenu.ChromeContextMenuPopulator;
 import org.chromium.chrome.browser.contextmenu.ContextMenuParams;
 import org.chromium.chrome.browser.contextmenu.ContextMenuPopulator;
 import org.chromium.chrome.browser.contextualsearch.ContextualSearchTabHelper;
 import org.chromium.chrome.browser.crash.MinidumpUploadService;
 import org.chromium.chrome.browser.dom_distiller.ReaderModeActivityDelegate;
 import org.chromium.chrome.browser.dom_distiller.ReaderModeManager;
 import org.chromium.chrome.browser.download.ChromeDownloadDelegate;
 import org.chromium.chrome.browser.externalnav.ExternalNavigationHandler;
 import org.chromium.chrome.browser.externalnav.ExternalNavigationHandler.OverrideUrlLoadingResult;
 import org.chromium.chrome.browser.externalnav.ExternalNavigationParams;
 import org.chromium.chrome.browser.fullscreen.FullscreenManager;
 import org.chromium.chrome.browser.media.MediaNotificationService;
+import org.chromium.chrome.browser.media.ui.MediaInfo;
+import org.chromium.chrome.browser.media.ui.NotificationMediaPlaybackControls;
 import org.chromium.chrome.browser.net.spdyproxy.DataReductionProxySettings;
 import org.chromium.chrome.browser.ntp.NativePageAssassin;
 import org.chromium.chrome.browser.ntp.NativePageFactory;
 import org.chromium.chrome.browser.omnibox.geo.GeolocationHeader;
 import org.chromium.chrome.browser.policy.PolicyAuditor;
 import org.chromium.chrome.browser.policy.PolicyAuditor.AuditEvent;
 import org.chromium.chrome.browser.preferences.PrefServiceBridge;
 import org.chromium.chrome.browser.rlz.RevenueStats;
 import org.chromium.chrome.browser.search_engines.TemplateUrlService;
 import org.chromium.chrome.browser.tab.BackgroundContentViewHelper.BackgroundContentViewDelegate;
@@ skipping 16 matching lines @@
 import org.chromium.content_public.browser.LoadUrlParams;
 import org.chromium.content_public.browser.NavigationController;
 import org.chromium.content_public.browser.WebContents;
 import org.chromium.content_public.browser.WebContentsObserver;
 import org.chromium.content_public.common.ConsoleMessageLevel;
 import org.chromium.content_public.common.Referrer;
 import org.chromium.ui.WindowOpenDisposition;
 import org.chromium.ui.base.PageTransition;
 import org.chromium.ui.base.WindowAndroid;
 
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.Locale;
 
 /**
  * A representation of a Tab for Chrome. This manages wrapping a WebContents and interacting with
  * most of Chromium while representing a consistent version of web content to the front end.
  */
 public class ChromeTab extends Tab {

[Ted C, 2015/06/26 00:43:55]

ChromeTab is going away, you should probably just add these to Tab.

[whywhat, 2015/06/26 19:29:32]

Ack.

     public static final int NTP_TAB_ID = -2;
 
-    private static final String TAG = "ChromeTab";
+    private static final String TAG = "cr.ChromeTab";
 
     // URL didFailLoad error code. Should match the value in net_error_list.h.
     public static final int BLOCKED_BY_ADMINISTRATOR = -22;
 
     public static final String PAGESPEED_PASSTHROUGH_HEADER = "Chrome-Proxy: pass-through";
 
     private static final int MSG_ID_ENABLE_FULLSCREEN_AFTER_LOAD = 1;
 
     /** The maximum amount of time to wait for a page to load before entering fullscreen.  -1 means
      *  wait until the page finishes loading. */
@@ skipping 244 matching lines @@
     @Override
     protected TabChromeWebContentsDelegateAndroid createWebContentsDelegate() {
         return new TabChromeWebContentsDelegateAndroidImpl();
     }
 
     /**
      * An implementation for this tab's web contents delegate.
      */
     public class TabChromeWebContentsDelegateAndroidImpl
             extends TabChromeWebContentsDelegateAndroid {
+        private NotificationMediaPlaybackControls.Listener mControlsListener =

[Ted C, 2015/06/26 00:43:55]

I'd rather not see this logic within tab.  I think we should pull it out as a
tabhelper of sorts and have it do this stuff.

I also don't think the methods you're calling right below belong in the web
contents delegate, so I think whatever extracted class should contain them (as
they only need the webcontents anyway, not any of the delegate functionality).

The class could be a webcontentsobserver as well, so it would know when to
delete itself.  And based on my comment about all the update paths potentially
going through the webcontentsobserver, it could maybe be isolated entirely
outside of this file.

[whywhat, 2015/06/26 19:29:32]

Ack. I'll need a tab id though to be able to come back to the tab when the
notification is touched. How do I do this from WebContentsObserver?
MediaNotificationService sits fine here and I'm writing its replacement for
media playback case essentially.

[Ted C, 2015/06/30 04:56:13]

Per my follow up comment, there is no reason you can't create a specialized
observer that takes a Tab (or you can use a TabObserver if you prefer).

I wouldn't take MediaNotificationService as a good example of what to follow
with regards to how it integrates with the Tab.  It is littered all over the
file and is definitely an example of something we'd like to see rewritten and
extracted from the Tab.

+                new NotificationMediaPlaybackControls.Listener() {
+            @Override
+            public void onPlay() {
+                TabChromeWebContentsDelegateAndroidImpl
+                        .nativeOnMediaControlsResume(getWebContents());
+            }
+
+            @Override
+            public void onPause() {
+                TabChromeWebContentsDelegateAndroidImpl
+                        .nativeOnMediaControlsPause(getWebContents());
+            }
+        };
+
         /**
          * This method is meant to be overridden by DocumentTab because the
          * TabModelSelector returned by the activity is not correct.
          * TODO(dfalcantara): remove this when DocumentActivity.getTabModelSelector()
          * will return the right TabModelSelector.
          */
         protected TabModel getTabModel() {
             return mActivity.getTabModelSelector().getModel(isIncognito());
         }
 
@@ skipping 112 matching lines @@
                 // interfere with other parts of the activity (e.g. the URL bar).
                 if (event.getKeyCode() == KeyEvent.KEYCODE_ESCAPE && event.hasNoModifiers()) {
                     WebContents wc = getWebContents();
                     if (wc != null) wc.stop();
                     return;
                 }
             }
             handleMediaKey(event);
         }
 
+        @Override
+        public void updateMediaControls(boolean isControllable, boolean isPaused) {
+            NotificationMediaPlaybackControls notificationControls =
+                    NotificationMediaPlaybackControls.getOrCreate(getApplicationContext());
+            if (!isControllable) {
+                notificationControls.hide(getId());
+                notificationControls.removeListener(mControlsListener);
+                return;
+            }
+            notificationControls.addListener(mControlsListener);
+            String origin = getUrl();
+            try {
+                origin = UrlUtilities.getOriginForDisplay(new URI(getUrl()), true);
+            } catch (URISyntaxException e) {
+                Log.e(TAG, "Wrong syntax for the tab URL when playing media. Showing the URL.");
+            }
+            notificationControls.show(new MediaInfo(getTitle(), isPaused, origin, getId()));
+        }
+
         /**
          * Redispatches unhandled media keys. This allows bluetooth headphones with play/pause or
          * other buttons to function correctly.
          */
         @TargetApi(19)
         private void handleMediaKey(KeyEvent e) {
             if (Build.VERSION.SDK_INT < 19) return;
             switch (e.getKeyCode()) {
                 case KeyEvent.KEYCODE_MUTE:
                 case KeyEvent.KEYCODE_HEADSETHOOK:
@@ skipping 31 matching lines @@
         private boolean isCapturingVideo() {
             return !isClosing() && super.nativeIsCapturingVideo(getWebContents());
         }
 
         /**
          * @return Whether audio is being played.
          */
         private boolean hasAudibleAudio() {
             return !isClosing() && super.nativeHasAudibleAudio(getWebContents());
         }
-
     }
 
     /**
      * Check whether the context menu download should be intercepted.
      *
      * @param url URL to be downloaded.
      * @return whether the download should be intercepted.
      */
     protected boolean shouldInterceptContextMenuDownload(String url) {
         return mDownloadDelegate.shouldInterceptContextMenuDownload(url);
@@ skipping 324 matching lines @@
             public void didDetachInterstitialPage() {
                 if (!maybeShowNativePage(getUrl(), false)) {
                     showRenderedPage();
                 }
             }
 
             @Override
             public void destroy() {
                 MediaNotificationService.updateMediaNotificationForTab(
                         getApplicationContext(), getId(), false, false, false, getUrl());
+                NotificationMediaPlaybackControls notificationControls =
+                        NotificationMediaPlaybackControls.getOrCreate(getApplicationContext());
+                notificationControls.hide(getId());

[Ted C, 2015/06/26 00:43:55]

should this be removing the listener as well?

Should the listener be associated with the id (passed in the show(...) method
maybe) such that it gets removed when you hide an id?

[whywhat, 2015/06/26 19:29:32]

I've put the listener to MediaInfo so now there's only one listener that has a
corresponding tabId.

                 super.destroy();
             }
         };
     }
 
     @Override
     protected void didStartPageLoad(String validatedUrl, boolean showingErrorPage) {
         if (mBackgroundContentViewHelper.isPageSwappingInProgress()) {
             mLoadProgressAtViewSwapInTime = 0;
         }
@@ skipping 501 matching lines @@
                 didFinishPageLoad();
             }
         }
     };
 
     @VisibleForTesting
     public OverrideUrlLoadingResult getLastOverrideUrlLoadingResultForTests() {
         return mLastOverrideUrlLoadingResult;
     }
 }