From 7d3375c6ec09f13fafe6d9f55b8a975f349cc4f3 Mon Sep 17 00:00:00 2001
From: ibaker <ibaker@google.com>
Date: Wed, 21 Dec 2022 10:58:36 +0000
Subject: [PATCH] Fix recursive loop when registering controller visibility
 listeners

There are two overloads of this method due to a type 'rename' from
`PlayerControlView.VisibilityListener` to
`PlayerView.ControllerVisibilityListener`. Currently when you call one
overload it passes `null` to the other one (to clear the other listener).
Unfortunately this results in it clearing itself, because it receives
a null call back!

This change tweaks the documentation to clarify that the 'other'
listener is only cleared if you pass a non-null listener in. This solves
the recursive problem, and allows the 'legacy' visibility listener to be
successfully registered.

Issue: androidx/media#229

#minor-release

PiperOrigin-RevId: 496876397
(cherry picked from commit 4087a011e21aba2c27e3ae890f74a65812c6f4ce)
---
 RELEASENOTES.md                                    |  5 +++++
 .../main/java/androidx/media3/ui/PlayerView.java   | 14 ++++++++------
 2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/RELEASENOTES.md b/RELEASENOTES.md
index f0c4f888924..7e9f8fd2b59 100644
--- a/RELEASENOTES.md
+++ b/RELEASENOTES.md
@@ -25,6 +25,11 @@
         `Subtitle.getEventTime` if a subtitle file contains no cues.
     *   SubRip: Add support for UTF-16 files if they start with a byte order
         mark.
+*   UI:
+    *   Fix the deprecated
+        `PlayerView.setControllerVisibilityListener(PlayerControlView.VisibilityListener)`
+        to ensure visibility changes are passed to the registered listener
+        ([#229](https://github.com/androidx/media/issues/229)).
 *   Session:
     *   Add abstract `SimpleBasePlayer` to help implement the `Player` interface
         for custom players.
diff --git a/libraries/ui/src/main/java/androidx/media3/ui/PlayerView.java b/libraries/ui/src/main/java/androidx/media3/ui/PlayerView.java
index 6731d040a3e..b91d14cb5fc 100644
--- a/libraries/ui/src/main/java/androidx/media3/ui/PlayerView.java
+++ b/libraries/ui/src/main/java/androidx/media3/ui/PlayerView.java
@@ -887,8 +887,8 @@ public void setControllerHideDuringAds(boolean controllerHideDuringAds) {
   /**
    * Sets the {@link PlayerControlView.VisibilityListener}.
    *
-   * <p>Removes any listener set by {@link
-   * #setControllerVisibilityListener(PlayerControlView.VisibilityListener)}.
+   * <p>If {@code listener} is non-null then any listener set by {@link
+   * #setControllerVisibilityListener(PlayerControlView.VisibilityListener)} is removed.
    *
    * @param listener The listener to be notified about visibility changes, or null to remove the
    *     current listener.
@@ -896,14 +896,16 @@ public void setControllerHideDuringAds(boolean controllerHideDuringAds) {
   @SuppressWarnings("deprecation") // Clearing the legacy listener.
   public void setControllerVisibilityListener(@Nullable ControllerVisibilityListener listener) {
     this.controllerVisibilityListener = listener;
-    setControllerVisibilityListener((PlayerControlView.VisibilityListener) null);
+    if (listener != null) {
+      setControllerVisibilityListener((PlayerControlView.VisibilityListener) null);
+    }
   }
 
   /**
    * Sets the {@link PlayerControlView.VisibilityListener}.
    *
-   * <p>Removes any listener set by {@link
-   * #setControllerVisibilityListener(ControllerVisibilityListener)}.
+   * <p>If {@code listener} is non-null then any listener set by {@link
+   * #setControllerVisibilityListener(ControllerVisibilityListener)} is removed.
    *
    * @deprecated Use {@link #setControllerVisibilityListener(ControllerVisibilityListener)} instead.
    */
@@ -923,8 +925,8 @@ public void setControllerVisibilityListener(
     this.legacyControllerVisibilityListener = listener;
     if (listener != null) {
       controller.addVisibilityListener(listener);
+      setControllerVisibilityListener((ControllerVisibilityListener) null);
     }
-    setControllerVisibilityListener((ControllerVisibilityListener) null);
   }
 
   /**