Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 96fcc490 authored by Treehugger Robot's avatar Treehugger Robot Committed by Automerger Merge Worker
Browse files

Merge "bluetooth: Refactor BT Audio Codec list" into main am: 7c9f1454

parents 51cac72d 7c9f1454
Loading
Loading
Loading
Loading
+2 −3
Original line number Diff line number Diff line
@@ -62,7 +62,6 @@ import com.android.settings.development.autofill.AutofillCategoryController;
import com.android.settings.development.autofill.AutofillLoggingLevelPreferenceController;
import com.android.settings.development.autofill.AutofillResetOptionsPreferenceController;
import com.android.settings.development.bluetooth.AbstractBluetoothDialogPreferenceController;
import com.android.settings.development.bluetooth.AbstractBluetoothListPreferenceController;
import com.android.settings.development.bluetooth.AbstractBluetoothPreferenceController;
import com.android.settings.development.bluetooth.BluetoothBitPerSampleDialogPreferenceController;
import com.android.settings.development.bluetooth.BluetoothChannelModeDialogPreferenceController;
@@ -814,8 +813,8 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra
                ((AbstractBluetoothDialogPreferenceController) controller).onHDAudioEnabled(
                        enabled);
            }
            if (controller instanceof AbstractBluetoothListPreferenceController) {
                ((AbstractBluetoothListPreferenceController) controller).onHDAudioEnabled(enabled);
            if (controller instanceof BluetoothCodecListPreferenceController) {
                ((BluetoothCodecListPreferenceController) controller).onHDAudioEnabled(enabled);
            }
        }
    }
+0 −261
Original line number Diff line number Diff line
/*
 * 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.development.bluetooth;

import static android.bluetooth.BluetoothCodecConfig.CODEC_PRIORITY_HIGHEST;

import android.bluetooth.BluetoothA2dp;
import android.bluetooth.BluetoothCodecConfig;
import android.bluetooth.BluetoothCodecStatus;
import android.bluetooth.BluetoothDevice;
import android.content.Context;
import android.util.Log;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.preference.ListPreference;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;

import com.android.settings.R;
import com.android.settings.development.BluetoothA2dpConfigStore;
import com.android.settingslib.core.lifecycle.Lifecycle;

import java.util.List;

/** Abstract class for Bluetooth A2DP config list controller in developer option. */
public abstract class AbstractBluetoothListPreferenceController
        extends AbstractBluetoothPreferenceController
        implements Preference.OnPreferenceChangeListener {

    private static final String TAG = "AbstrBtListPrefCtrl";

    protected static final int DEFAULT_VALUE_INT = 1000;

    @Nullable protected ListPreference mListPreference;

    protected String mDefaultEntry;
    protected String mDefaultValue;

    @Nullable protected final BluetoothA2dpConfigStore mBluetoothA2dpConfigStore;

    public AbstractBluetoothListPreferenceController(
            @NonNull Context context,
            @Nullable Lifecycle lifecycle,
            @Nullable BluetoothA2dpConfigStore store) {
        super(context, lifecycle, store);

        mDefaultEntry = mContext.getString(R.string.bluetooth_audio_codec_default_selection);
        mDefaultValue = String.valueOf(DEFAULT_VALUE_INT);

        mBluetoothA2dpConfigStore = store;
    }

    @Override
    public void displayPreference(@NonNull PreferenceScreen screen) {
        super.displayPreference(screen);
        mListPreference = screen.findPreference(getPreferenceKey());
    }

    @Override
    public boolean onPreferenceChange(@Nullable Preference preference, @NonNull Object newValue) {
        Log.d(TAG, "onPreferenceChange: newValue=" + (String) newValue);
        if (mListPreference == null) {
            Log.e(TAG, "onPreferenceChange: List preference is null");
            return false;
        }
        updateState(mListPreference);
        return true;
    }

    @Override
    public void updateState(@Nullable Preference preference) {
        setupDefaultListPreference();
    }

    @Override
    public void onBluetoothServiceConnected(@NonNull BluetoothA2dp bluetoothA2dp) {
        super.onBluetoothServiceConnected(bluetoothA2dp);
        initConfigStore();
    }

    @Override
    protected void onDeveloperOptionsSwitchDisabled() {
        super.onDeveloperOptionsSwitchDisabled();
        Log.d(TAG, "onDeveloperOptionsSwitchDisabled");
        if (mListPreference == null) {
            Log.e(TAG, "onDeveloperOptionsSwitchDisabled: List preference is null");
            return;
        }
        updateState(mListPreference);
    }

    /**
     * Method to notify controller when the HD audio(optional codec) state is changed.
     *
     * @param enabled Is {@code true} when the setting is enabled.
     */
    public void onHDAudioEnabled(boolean enabled) {}

    /**
     * Updates the new value to the {@link BluetoothA2dpConfigStore}.
     *
     * @param entryValue the new setting entry value
     */
    protected abstract void writeConfigurationValues(String entryValue);

    /**
     * Gets the current bluetooth codec status.
     *
     * @return {@link BluetoothCodecStatus}.
     */
    @Nullable
    protected BluetoothCodecStatus getBluetoothCodecStatus() {
        final BluetoothA2dp bluetoothA2dp = mBluetoothA2dp;
        if (bluetoothA2dp == null) {
            Log.e(
                    TAG,
                    "getBluetoothCodecStatus: Unable to get codec status. Bluetooth A2dp is null.");
            return null;
        }
        final BluetoothDevice activeDevice = getA2dpActiveDevice();
        if (activeDevice == null) {
            Log.e(TAG, "getBluetoothCodecStatus: Unable to get codec status. No active device.");
            return null;
        }
        final BluetoothCodecStatus codecStatus = bluetoothA2dp.getCodecStatus(activeDevice);
        if (codecStatus == null) {
            Log.e(TAG, "getBluetoothCodecStatus: Codec status is null");
            return null;
        }
        return codecStatus;
    }

    /**
     * Gets the current bluetooth codec config.
     *
     * @return {@link BluetoothCodecConfig}.
     */
    @Nullable
    protected BluetoothCodecConfig getCurrentCodecConfig() {
        final BluetoothCodecStatus codecStatus = getBluetoothCodecStatus();
        if (codecStatus == null) {
            Log.e(
                    TAG,
                    "getCurrentCodecConfig: Unable to get current codec config. Codec status is"
                            + " null");
            return null;
        }

        return codecStatus.getCodecConfig();
    }

    /**
     * Sets the {@link ListPreference}. This method adds the default entry and the entry value
     * automatically.
     *
     * @param entries list of String entries for the {@link ListPreference}.
     * @param entryValues list of String entry values for the {@link ListPreference}.
     * @param selectedEntry currently selected entry.
     * @param selectedValue currently selected entry value.
     */
    protected void setupListPreference(
            List<String> entries,
            List<String> entryValues,
            String selectedEntry,
            String selectedValue) {
        if (entries.size() != entryValues.size()) {
            Log.e(
                    TAG,
                    ("setupListPreference: size of entries: " + entries.size())
                            + (", size of entryValues" + entryValues.size()));
            setupDefaultListPreference();
            return;
        }
        if (entries.isEmpty() || entryValues.isEmpty()) {
            Log.e(TAG, "setupListPreference: entries or entryValues empty");
            setupDefaultListPreference();
            return;
        }
        entries.add(0, mDefaultEntry);
        entryValues.add(0, mDefaultValue);

        if (mListPreference == null) {
            Log.e(TAG, "setupListPreference: List preference is null");
            return;
        }
        mListPreference.setEntries(entries.toArray(new String[entries.size()]));
        mListPreference.setEntryValues(entryValues.toArray(new String[entryValues.size()]));
        mListPreference.setValue(selectedValue);
        mListPreference.setSummary(selectedEntry);
    }

    /**
     * Check HD Audio enabled.
     *
     * @return true if HD Audio is enabled.
     */
    protected boolean isHDAudioEnabled() {
        final BluetoothA2dp bluetoothA2dp = mBluetoothA2dp;
        if (bluetoothA2dp == null) {
            Log.e(TAG, "isHDAudioEnabled: Unable to get codec status. BluetoothA2dp is null.");
            return false;
        }
        BluetoothDevice activeDevice = getA2dpActiveDevice();
        if (activeDevice == null) {
            Log.e(TAG, "isHDAudioEnabled: Unable to get codec status. No active device.");
            return false;
        }
        return (bluetoothA2dp.isOptionalCodecsEnabled(activeDevice)
                == BluetoothA2dp.OPTIONAL_CODECS_PREF_ENABLED);
    }

    private void setupDefaultListPreference() {
        Log.d(
                TAG,
                "setupDefaultListPreference: mDefaultEntry="
                        + mDefaultEntry
                        + ", mDefaultValue="
                        + mDefaultValue);
        if (mListPreference == null) {
            Log.e(TAG, "setupListPreference: List preference is null");
            return;
        }
        mListPreference.setEntries(new String[] {mDefaultEntry});
        mListPreference.setEntryValues(new String[] {mDefaultValue});
        mListPreference.setValue(mDefaultValue);
        mListPreference.setSummary(mDefaultEntry);
    }

    private void initConfigStore() {
        final BluetoothCodecConfig config = getCurrentCodecConfig();
        if (config == null) {
            Log.e(TAG, "initConfigStore: Current codec config is null.");
            return;
        }
        if (mBluetoothA2dpConfigStore == null) {
            Log.e(TAG, "initConfigStore: Bluetooth A2dp Config Store is null.");
            return;
        }
        mBluetoothA2dpConfigStore.setCodecType(config.getExtendedCodecType());
        mBluetoothA2dpConfigStore.setSampleRate(config.getSampleRate());
        mBluetoothA2dpConfigStore.setBitsPerSample(config.getBitsPerSample());
        mBluetoothA2dpConfigStore.setChannelMode(config.getChannelMode());
        mBluetoothA2dpConfigStore.setCodecPriority(CODEC_PRIORITY_HIGHEST);
        mBluetoothA2dpConfigStore.setCodecSpecific1Value(config.getCodecSpecific1());
    }
}
+212 −58
Original line number Diff line number Diff line
@@ -26,9 +26,11 @@ import android.util.Log;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.preference.ListPreference;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;

import com.android.internal.annotations.VisibleForTesting;
import com.android.settings.development.BluetoothA2dpConfigStore;
import com.android.settings.development.Flags;
import com.android.settingslib.core.lifecycle.Lifecycle;
@@ -38,13 +40,15 @@ import java.util.Collection;
import java.util.List;

/** List preference controller to set the Bluetooth A2DP codec */
public class BluetoothCodecListPreferenceController
        extends AbstractBluetoothListPreferenceController {
public class BluetoothCodecListPreferenceController extends AbstractBluetoothPreferenceController
        implements Preference.OnPreferenceChangeListener {

    private static final String KEY = "bluetooth_audio_codec_settings_list";
    private static final String TAG = "BtExtCodecCtr";

    @Nullable private final Callback mCallback;
    @Nullable protected final BluetoothA2dpConfigStore mBluetoothA2dpConfigStore;
    @Nullable protected ListPreference mListPreference;

    public BluetoothCodecListPreferenceController(
            @NonNull Context context,
@@ -53,6 +57,7 @@ public class BluetoothCodecListPreferenceController
            @Nullable Callback callback) {
        super(context, lifecycle, store);
        mCallback = callback;
        mBluetoothA2dpConfigStore = store;
    }

    @Override
@@ -79,32 +84,38 @@ public class BluetoothCodecListPreferenceController
            return false;
        }

        if (mListPreference == null) {
            Log.e(TAG, "onPreferenceChange: List preference is null");
            return false;
        }

        Log.d(TAG, "onPreferenceChange: newValue=" + (String) newValue);
        final BluetoothA2dp bluetoothA2dp = mBluetoothA2dp;
        if (bluetoothA2dp == null) {
            Log.e(TAG, "onPreferenceChange: bluetoothA2dp is null");
            setListPreferenceEnabled(false);
            return false;
        }

        writeConfigurationValues((String) newValue);
        if (!writeConfigurationValues((String) newValue)) {
            Log.e(TAG, "onPreferenceChange: Configuration failed");
            return false;
        }

        if (mBluetoothA2dpConfigStore == null) {
            Log.e(TAG, "onPreferenceChange: Bluetooth A2dp Config Store is null");
            return false;
        }
        BluetoothCodecConfig codecConfig;
        if (Flags.a2dpOffloadCodecExtensibilitySettings()) {
            codecConfig = mBluetoothA2dpConfigStore.createCodecConfigFromCodecType();
        } else {
            codecConfig = mBluetoothA2dpConfigStore.createCodecConfig();
        }

        final BluetoothDevice activeDevice = getA2dpActiveDevice();
        if (activeDevice == null) {
            Log.e(TAG, "onPreferenceChange: active device is null");
            setListPreferenceEnabled(false);
            return false;
        }

        BluetoothCodecConfig codecConfig =
                mBluetoothA2dpConfigStore.createCodecConfigFromCodecType();
        Log.d(TAG, "onPreferenceChange: setCodecConfigPreference: " + codecConfig.toString());
        bluetoothA2dp.setCodecConfigPreference(activeDevice, codecConfig);
        if (mCallback != null) {
@@ -121,12 +132,12 @@ public class BluetoothCodecListPreferenceController
            return;
        }

        final List<String> codecIds = new ArrayList<>();
        final List<String> labels = new ArrayList<>();
        String selectedCodecId = mDefaultValue;
        String selectedLabel = mDefaultEntry;
        if (!isHDAudioEnabled()) {
            Log.d(TAG, "updateState: HD Audio is disabled");
            setListPreferenceEnabled(false);
            return;
        }

        if (isHDAudioEnabled()) {
        final BluetoothCodecStatus codecStatus = getBluetoothCodecStatus();
        if (codecStatus == null) {
            Log.e(TAG, "updateState: Bluetooth Codec Status is null");
@@ -139,15 +150,18 @@ public class BluetoothCodecListPreferenceController
            return;
        }

            final BluetoothA2dp bluetoothA2dp = mBluetoothA2dp;
            if (bluetoothA2dp == null) {
                Log.e(TAG, "updateState: bluetoothA2dp is null");
                return;
        final List<String> codecIds = new ArrayList<>();
        final List<String> labels = new ArrayList<>();
        String selectedCodecId = null;
        String selectedLabel = null;
        final List<BluetoothCodecConfig> codecConfigs =
                codecStatus.getCodecsSelectableCapabilities();
        for (BluetoothCodecConfig config : codecConfigs) {
            BluetoothCodecType codecType = config.getExtendedCodecType();
            if (codecType == null) {
                Log.e(TAG, "codec type for config:" + config + " is null");
                continue;
            }

            final Collection<BluetoothCodecType> codecTypes =
                    bluetoothA2dp.getSupportedCodecTypes();
            for (BluetoothCodecType codecType : codecTypes) {
            labels.add(codecType.getCodecName());
            codecIds.add(String.valueOf(codecType.getCodecId()));
            if (currentCodecConfig != null
@@ -156,29 +170,36 @@ public class BluetoothCodecListPreferenceController
                selectedLabel = labels.get(labels.size() - 1);
                Log.d(
                        TAG,
                            "updateState: Current config: "
                        "updateState: Selecting codec: "
                                + selectedLabel
                                + ", id: "
                                + selectedCodecId);
            }
        }

        setupListPreference(labels, codecIds, selectedLabel, selectedCodecId);
    }
    }

    @Override
    public void onBluetoothServiceConnected(@NonNull BluetoothA2dp bluetoothA2dp) {
        super.onBluetoothServiceConnected(bluetoothA2dp);
        initConfigStore();
    }

    public void onHDAudioEnabled(boolean enabled) {
        Log.d(TAG, "onHDAudioEnabled: enabled=" + enabled);
        if (mListPreference == null) {
            Log.e(TAG, "onHDAudioEnabled: List preference is null");
            return;
        }
        mListPreference.setEnabled(enabled);
        setListPreferenceEnabled(enabled);
        if (!enabled) {
            mListPreference.setValue(null);
            mListPreference.setSummary(null);
        }
    }

    @Override
    protected void writeConfigurationValues(String entryValue) {
    @VisibleForTesting
    boolean writeConfigurationValues(String entryValue) {
        long codecIdValue = getCodecIdFromEntryValue(entryValue);
        BluetoothCodecType selectedCodecType = null;
        BluetoothCodecConfig selectedCodecConfig = null;
@@ -186,7 +207,7 @@ public class BluetoothCodecListPreferenceController
        final BluetoothA2dp bluetoothA2dp = mBluetoothA2dp;
        if (bluetoothA2dp == null) {
            Log.e(TAG, "writeConfigurationValues: bluetoothA2dp is null");
            return;
            return false;
        }

        final Collection<BluetoothCodecType> codecTypes = bluetoothA2dp.getSupportedCodecTypes();
@@ -202,14 +223,14 @@ public class BluetoothCodecListPreferenceController
                    "writeConfigurationValues: No selectable codec ID: "
                            + codecIdValue
                            + " found. Unable to change codec");
            return;
            return false;
        }

        Log.d(TAG, "writeConfigurationValues: Selected codec: " + selectedCodecType.toString());
        final BluetoothCodecStatus codecStatus = getBluetoothCodecStatus();
        if (codecStatus == null) {
            Log.e(TAG, "writeConfigurationValues: Bluetooth Codec Status is null");
            return;
            return false;
        }

        final List<BluetoothCodecConfig> codecConfigs =
@@ -218,8 +239,9 @@ public class BluetoothCodecListPreferenceController
            BluetoothCodecType codecType = config.getExtendedCodecType();
            if (codecType == null) {
                Log.e(TAG, "codec type for config:" + config + " is null");
                continue;
            }
            if (codecType != null && codecType.equals(selectedCodecType)) {
            if (codecType.equals(selectedCodecType)) {
                selectedCodecConfig = config;
            }
        }
@@ -229,12 +251,12 @@ public class BluetoothCodecListPreferenceController
                    TAG,
                    "writeConfigurationValues: No selectable codec config for codec: "
                            + selectedCodecType.toString());
            return;
            return false;
        }

        if (mBluetoothA2dpConfigStore == null) {
            Log.e(TAG, "writeConfigurationValues: Bluetooth A2dp Config Store is null");
            return;
            return false;
        }

        mBluetoothA2dpConfigStore.setCodecType(selectedCodecType);
@@ -248,13 +270,145 @@ public class BluetoothCodecListPreferenceController
        mBluetoothA2dpConfigStore.setChannelMode(
                AbstractBluetoothDialogPreferenceController.getHighestChannelMode(
                        selectedCodecConfig));
        return true;
    }

    private long getCodecIdFromEntryValue(String entryValue) {
        long codecType = BluetoothCodecType.CODEC_ID_SBC;
        if (entryValue.isEmpty() || Long.valueOf(entryValue) == DEFAULT_VALUE_INT) {
        if (entryValue.isEmpty()) {
            return codecType;
        }
        return Long.valueOf(entryValue);
    }

    private void setListPreferenceEnabled(boolean enable) {
        if (mListPreference != null) {
            mListPreference.setEnabled(enable);
        }
    }

    @Nullable
    @VisibleForTesting
    BluetoothCodecStatus getBluetoothCodecStatus() {
        final BluetoothA2dp bluetoothA2dp = mBluetoothA2dp;
        if (bluetoothA2dp == null) {
            Log.e(
                    TAG,
                    "getBluetoothCodecStatus: Unable to get codec status. Bluetooth A2dp is null.");
            return null;
        }
        final BluetoothDevice activeDevice = getA2dpActiveDevice();
        if (activeDevice == null) {
            Log.e(TAG, "getBluetoothCodecStatus: Unable to get codec status. No active device.");
            return null;
        }
        final BluetoothCodecStatus codecStatus = bluetoothA2dp.getCodecStatus(activeDevice);
        if (codecStatus == null) {
            Log.e(TAG, "getBluetoothCodecStatus: Codec status is null");
            return null;
        }
        return codecStatus;
    }

    @Nullable
    @VisibleForTesting
    BluetoothCodecConfig getCurrentCodecConfig() {
        final BluetoothCodecStatus codecStatus = getBluetoothCodecStatus();
        if (codecStatus == null) {
            Log.e(
                    TAG,
                    "getCurrentCodecConfig: Unable to get current codec config. Codec status is"
                            + " null");
            return null;
        }

        return codecStatus.getCodecConfig();
    }

    @VisibleForTesting
    boolean isHDAudioEnabled() {
        final BluetoothA2dp bluetoothA2dp = mBluetoothA2dp;
        if (bluetoothA2dp == null) {
            Log.e(TAG, "isHDAudioEnabled: Unable to get codec status. BluetoothA2dp is null.");
            return false;
        }
        BluetoothDevice activeDevice = getA2dpActiveDevice();
        if (activeDevice == null) {
            Log.e(TAG, "isHDAudioEnabled: Unable to get codec status. No active device.");
            return false;
        }
        return (bluetoothA2dp.isOptionalCodecsEnabled(activeDevice)
                == BluetoothA2dp.OPTIONAL_CODECS_PREF_ENABLED);
    }

    @VisibleForTesting
    void initConfigStore() {
        final BluetoothCodecConfig config = getCurrentCodecConfig();
        if (config == null) {
            Log.e(TAG, "initConfigStore: Current codec config is null.");
            return;
        }
        if (mBluetoothA2dpConfigStore == null) {
            Log.e(TAG, "initConfigStore: Bluetooth A2dp Config Store is null.");
            return;
        }
        mBluetoothA2dpConfigStore.setCodecType(config.getExtendedCodecType());
        mBluetoothA2dpConfigStore.setSampleRate(config.getSampleRate());
        mBluetoothA2dpConfigStore.setBitsPerSample(config.getBitsPerSample());
        mBluetoothA2dpConfigStore.setChannelMode(config.getChannelMode());
        mBluetoothA2dpConfigStore.setCodecPriority(BluetoothCodecConfig.CODEC_PRIORITY_HIGHEST);
        mBluetoothA2dpConfigStore.setCodecSpecific1Value(config.getCodecSpecific1());
    }

    @VisibleForTesting
    void setupDefaultListPreference() {
        Log.d(TAG, "setupDefaultListPreference");
        if (mListPreference == null) {
            Log.e(TAG, "setupDefaultListPreference: List preference is null");
            return;
        }
        mListPreference.setValue(null);
        mListPreference.setSummary(null);
        setListPreferenceEnabled(false);
    }

    /**
     * Sets the {@link ListPreference}.
     *
     * @param entries list of String entries for the {@link ListPreference}.
     * @param entryValues list of String entry values for the {@link ListPreference}.
     * @param selectedEntry currently selected entry.
     * @param selectedValue currently selected entry value.
     */
    @VisibleForTesting
    void setupListPreference(
            List<String> entries,
            List<String> entryValues,
            @Nullable String selectedEntry,
            @Nullable String selectedValue) {
        if (mListPreference == null) {
            Log.e(TAG, "setupListPreference: List preference is null");
            return;
        }

        if (entries.size() != entryValues.size()) {
            Log.e(
                    TAG,
                    ("setupListPreference: size of entries: " + entries.size())
                            + (", size of entryValues" + entryValues.size()));
            setupDefaultListPreference();
            return;
        }
        if (entries.isEmpty() || entryValues.isEmpty()) {
            Log.e(TAG, "setupListPreference: entries or entryValues empty");
            setupDefaultListPreference();
            return;
        }

        mListPreference.setEntries(entries.toArray(new String[entries.size()]));
        mListPreference.setEntryValues(entryValues.toArray(new String[entryValues.size()]));
        mListPreference.setValue(selectedValue);
        mListPreference.setSummary(selectedEntry);
        setListPreferenceEnabled(true);
    }
}
+0 −240

File deleted.

Preview size limit exceeded, changes collapsed.

+214 −24

File changed.

Preview size limit exceeded, changes collapsed.