AndroidOverlay implementation using Dialog.

content/public/android/java/src/org/chromium/content/browser/androidoverlay/AndroidOverlayProviderImpl.java

 // Copyright 2017 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.content.browser.androidoverlay;
 
 import android.content.Context;
+import android.os.Handler;
+import android.os.HandlerThread;
 
 import org.chromium.media.mojom.AndroidOverlay;
 import org.chromium.media.mojom.AndroidOverlayClient;
 import org.chromium.media.mojom.AndroidOverlayConfig;
 import org.chromium.media.mojom.AndroidOverlayProvider;
 import org.chromium.mojo.bindings.InterfaceRequest;
 import org.chromium.mojo.system.MojoException;
 import org.chromium.services.service_manager.InterfaceFactory;
 
 /**
- * Default impl of AndroidOverlayProvider.  Creates AndroidOverlayImpls.
+ * Default impl of AndroidOverlayProvider.  Creates AndroidOverlayImpls.  We're a singleton, in the
+ * sense that all provider clients talk to the same instance in the browser.
  */
 public class AndroidOverlayProviderImpl implements AndroidOverlayProvider {
     private static final String TAG = "AndroidOverlayProvider";
 
+    // We maintain a thread with a Looper for the AndroidOverlays to use, since Dialog requires one.
+    // We don't want this to be the native thread that's used to create them (the browser UI thread)
+    // since we don't want to block that waiting for sync callbacks from Android, such as
+    // surfaceDestroyed.  Instead, we run all AndroidOverlays on one shared overlay-ui thread.

[boliu, 2017/03/30 22:42:02]

maybe just call this the "overlay" thread everywhere, overlay-ui is kinda
confusing with ui thread

[liberato (no reviews please), 2017/04/04 17:49:29]

Done.

+    private HandlerThread mOverlayUiThread;
+    private Handler mHandler;
+
+    // Number of AndroidOverlays that have been created but not released.
+    private int mNumOverlays;
+
+    // Runnable that notifies us that a client has been released.
+    private Runnable mNotifyReleasedRunnable = new Runnable() {
+        @Override
+        public void run() {
+            notifyReleased();
+        }
+    };
+
+    // Maximum number of concurrent overlays that we allow.
+    private static final int MAX_OVERLAYS = 1;

[boliu, 2017/03/30 22:42:02]

nit: constants at the top

[liberato (no reviews please), 2017/04/04 17:49:29]

Done.

+
     /**
      * Create an overlay matching |config| for |client|, and bind it to |request|.  Remember that
      * potentially many providers are created.
      */
     public void createOverlay(InterfaceRequest<AndroidOverlay> request, AndroidOverlayClient client,

[boliu, 2017/03/30 22:42:02]

is this @Override?

[liberato (no reviews please), 2017/04/04 17:49:29]

Done.

             AndroidOverlayConfig config) {
-        client.onDestroyed();
+        // Limit the number of concurrent surfaces.
+        if (mNumOverlays >= MAX_OVERLAYS) {
+            client.onDestroyed();
+            return;
+        }
+
+        startThreadIfNeeded();
+        mNumOverlays++;
+
+        DialogOverlayOperations ops =
+                new DialogOverlayOperationsImpl(mHandler, mNotifyReleasedRunnable);
+
+        DialogOverlayImpl impl = new DialogOverlayImpl(client, config, ops);
+        DialogOverlayImpl.MANAGER.bind(impl, request);
     }
 
+    /**
+     * Make sure that mOverlayUiThread and mHandler are ready for use, if needed.
+     */
+    private void startThreadIfNeeded() {
+        if (mOverlayUiThread != null) return;
+
+        mOverlayUiThread = new HandlerThread("AndroidOverlayThread");
+        mOverlayUiThread.start();
+        mHandler = new Handler(mOverlayUiThread.getLooper());
+    }
+
+    /**
+     * Called by AndroidOverlays when they no longer need the thread via |mNotifyReleasedRunnable|.
+     */
+    public void notifyReleased() {

[boliu, 2017/03/30 22:42:02]

only called by runnable, right? so can be private

[liberato (no reviews please), 2017/04/04 17:49:29]

Done.

+        assert mNumOverlays > 0;
+        mNumOverlays--;
+
+        // We don't stop the looper thread here, else android can get mad when it tries to send
+        // a message from the dialog on this thread.  AndroidOverlay might have to notify us
+        // separately to tell us when it's done with the thread, if we don't want to wait until
+        // then to start creating a new SV.
+        // Instead, we just avoid shutting down the thread at all for now.
+    }
+
+    // Remember that we can't tell which client disconnected.
     @Override
     public void close() {}
 
+    // Remember that we can't tell which client disconnected.
     @Override
     public void onConnectionError(MojoException e) {}
 
     /**
      * Mojo factory.
      */
     public static class Factory implements InterfaceFactory<AndroidOverlayProvider> {
+        private static AndroidOverlayProviderImpl sImpl;
         public Factory(Context context) {}
 
         @Override
         public AndroidOverlayProvider createImpl() {
-            return new AndroidOverlayProviderImpl();
+            if (sImpl == null) sImpl = new AndroidOverlayProviderImpl();
+            return sImpl;
         }
     }
 }