connecteddevice/audiosharing/AudioSharingPreferenceController.java

/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.settings.connecteddevice.audiosharing;

import android.bluetooth.BluetoothLeBroadcast;
import android.bluetooth.BluetoothLeBroadcastMetadata;
import android.content.Context;
import android.util.Log;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.VisibleForTesting;
import androidx.lifecycle.DefaultLifecycleObserver;
import androidx.lifecycle.LifecycleOwner;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;

import com.android.settings.R;
import com.android.settings.bluetooth.Utils;
import com.android.settings.core.BasePreferenceController;
import com.android.settingslib.bluetooth.BluetoothCallback;
import com.android.settingslib.bluetooth.BluetoothEventManager;
import com.android.settingslib.bluetooth.BluetoothUtils;
import com.android.settingslib.bluetooth.LocalBluetoothLeBroadcast;
import com.android.settingslib.bluetooth.LocalBluetoothManager;
import com.android.settingslib.bluetooth.LocalBluetoothProfileManager;
import com.android.settingslib.utils.ThreadUtils;

import java.util.concurrent.Executor;
import java.util.concurrent.Executors;

public class AudioSharingPreferenceController extends BasePreferenceController
        implements DefaultLifecycleObserver, BluetoothCallback,
        LocalBluetoothProfileManager.ServiceListener {
    private static final String TAG = "AudioSharingPreferenceController";
    private static final String CONNECTED_DEVICES_PREF_KEY =
            "connected_device_audio_sharing_settings";
    private static final String CONNECTION_PREFERENCES_PREF_KEY = "audio_sharing_settings";

    @Nullable private final LocalBluetoothManager mBtManager;
    @Nullable private final LocalBluetoothProfileManager mProfileManager;
    @Nullable private final BluetoothEventManager mEventManager;
    @Nullable private final LocalBluetoothLeBroadcast mBroadcast;
    @Nullable private Preference mPreference;
    private final Executor mExecutor;

    @VisibleForTesting
    final BluetoothLeBroadcast.Callback mBroadcastCallback =
            new BluetoothLeBroadcast.Callback() {
                @Override
                public void onBroadcastStarted(int reason, int broadcastId) {
                    refreshPreference();
                }

                @Override
                public void onBroadcastStartFailed(int reason) {}

                @Override
                public void onBroadcastMetadataChanged(
                        int broadcastId, @NonNull BluetoothLeBroadcastMetadata metadata) {}

                @Override
                public void onBroadcastStopped(int reason, int broadcastId) {
                    refreshPreference();
                }

                @Override
                public void onBroadcastStopFailed(int reason) {}

                @Override
                public void onBroadcastUpdated(int reason, int broadcastId) {}

                @Override
                public void onBroadcastUpdateFailed(int reason, int broadcastId) {}

                @Override
                public void onPlaybackStarted(int reason, int broadcastId) {}

                @Override
                public void onPlaybackStopped(int reason, int broadcastId) {}
            };

    public AudioSharingPreferenceController(Context context, String preferenceKey) {
        super(context, preferenceKey);
        mBtManager = Utils.getLocalBtManager(context);
        mProfileManager = mBtManager == null ? null : mBtManager.getProfileManager();
        mEventManager = mBtManager == null ? null : mBtManager.getEventManager();
        mBroadcast = mProfileManager == null ? null : mProfileManager.getLeAudioBroadcastProfile();
        mExecutor = Executors.newSingleThreadExecutor();
    }

    @Override
    public void onStart(@NonNull LifecycleOwner owner) {
        if (!isAvailable()) {
            Log.d(TAG, "Skip register callbacks, feature not support");
            return;
        }
        if (mEventManager == null || mBroadcast == null) {
            Log.d(TAG, "Skip register callbacks, profile not ready");
            return;
        }
        mEventManager.registerCallback(this);
        mBroadcast.registerServiceCallBack(mExecutor, mBroadcastCallback);
        if (!AudioSharingUtils.isAudioSharingProfileReady(mProfileManager)) {
            if (mProfileManager != null) {
                mProfileManager.addServiceListener(this);
            }
            Log.d(TAG, "Skip updateVisibility. Profile is not ready.");
            return;
        }
        updateVisibility();
    }

    @Override
    public void onStop(@NonNull LifecycleOwner owner) {
        if (!isAvailable()) {
            Log.d(TAG, "Skip unregister callbacks, feature not support");
            return;
        }
        if (mEventManager == null || mBroadcast == null) {
            Log.d(TAG, "Skip register callbacks, profile not ready");
            return;
        }
        mEventManager.unregisterCallback(this);
        mBroadcast.unregisterServiceCallBack(mBroadcastCallback);
        if (mProfileManager != null) {
            mProfileManager.removeServiceListener(this);
        }
    }

    @Override
    public void displayPreference(@NonNull PreferenceScreen screen) {
        super.displayPreference(screen);
        mPreference = screen.findPreference(getPreferenceKey());
        // super.displayPreference set the visibility based on isAvailable()
        // immediately set the preference invisible on Connected devices page to avoid the audio
        // sharing entrance being shown before updateVisibility(need binder call) take effects.
        if (mPreference != null && CONNECTED_DEVICES_PREF_KEY.equals(getPreferenceKey())) {
            mPreference.setVisible(false);
        }
    }

    @Override
    public int getAvailabilityStatus() {
        return BluetoothUtils.isAudioSharingUIAvailable(mContext) ? AVAILABLE
                : UNSUPPORTED_ON_DEVICE;
    }

    @Override
    public void onServiceConnected() {
        if (AudioSharingUtils.isAudioSharingProfileReady(mProfileManager)) {
            Log.d(TAG, "onServiceConnected, audio sharing ready");
            refreshPreference();
            if (mProfileManager != null) {
                mProfileManager.removeServiceListener(this);
            }
        }
    }

    @Override
    public void onServiceDisconnected() {}

    @Override
    public CharSequence getSummary() {
        return switch (getPreferenceKey()) {
            case CONNECTION_PREFERENCES_PREF_KEY -> BluetoothUtils.isBroadcasting(mBtManager)
                    ? mContext.getString(R.string.audio_sharing_summary_on)
                    : mContext.getString(R.string.audio_sharing_summary_off);
            default -> "";
        };
    }

    @Override
    public void onBluetoothStateChanged(@AdapterState int bluetoothState) {
        refreshPreference();
    }

    private void refreshPreference() {
        switch (getPreferenceKey()) {
            // Audio sharing entrance on Connected devices page has no summary, but its visibility
            // will change based on audio sharing state
            case CONNECTED_DEVICES_PREF_KEY -> updateVisibility();
            // Audio sharing entrance on Connection preferences page always show up, but its summary
            // will change based on audio sharing state
            case CONNECTION_PREFERENCES_PREF_KEY -> refreshSummary();
        }
    }

    private void updateVisibility() {
        if (mPreference == null) {
            return;
        }
        switch (getPreferenceKey()) {
            case CONNECTED_DEVICES_PREF_KEY -> {
                var unused =
                        ThreadUtils.postOnBackgroundThread(
                                () -> {
                                    boolean visible = BluetoothUtils.isBroadcasting(mBtManager);
                                    AudioSharingUtils.postOnMainThread(
                                            mContext,
                                            () -> {
                                                // Check nullability to pass NullAway check
                                                if (mPreference != null) {
                                                    mPreference.setVisible(visible);
                                                }
                                            });
                                });
            }
        }
    }

    private void refreshSummary() {
        if (mPreference == null) {
            return;
        }
        var unused =
                ThreadUtils.postOnBackgroundThread(
                        () -> {
                            final CharSequence summary = getSummary();
                            AudioSharingUtils.postOnMainThread(
                                    mContext,
                                    () -> {
                                        // Check nullability to pass NullAway check
                                        if (mPreference != null) {
                                            mPreference.setSummary(summary);
                                        }
                                    });
                        });
    }
}