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

Commit 093ce8e3 authored by Jakub Pawlowski's avatar Jakub Pawlowski Committed by Automerger Merge Worker
Browse files

Merge "Bluetooth: add Volume Control Profile boilerpalate" am: 0778be80 am:... 

Merge "Bluetooth: add Volume Control Profile boilerpalate" am: 0778be80 am: 46a57e4a am: ef956abe

Original change: https://android-review.googlesource.com/c/platform/frameworks/base/+/1736553

Change-Id: Idc16b0555b0fdf384b3a362e42c68f5f8e2b2aea
parents 5059828f ef956abe

core/api/current.txt

+1 −0
Original line number Diff line number Diff line
@@ -9458,6 +9458,7 @@ package android.bluetooth { 
    field public static final int STATE_CONNECTING = 1; // 0x1

    field public static final int STATE_DISCONNECTED = 0; // 0x0

    field public static final int STATE_DISCONNECTING = 3; // 0x3

    field public static final int VOLUME_CONTROL = 23; // 0x17

  }















  public static interface BluetoothProfile.ServiceListener {

























core/api/system-current.txt



+10
−0






























Original line number
Diff line number
Diff line








@@ -2127,6 +2127,16 @@ package android.bluetooth {













    field @NonNull public static final android.os.ParcelUuid VOLUME_CONTROL;















  }



























  public final class BluetoothVolumeControl implements java.lang.AutoCloseable android.bluetooth.BluetoothProfile {













    method @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED) public void close();













    method @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED) protected void finalize();













    method @NonNull @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED) public java.util.List<android.bluetooth.BluetoothDevice> getConnectedDevices();













    method @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED) public int getConnectionPolicy(@NonNull android.bluetooth.BluetoothDevice);













    method @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED) public boolean setConnectionPolicy(@NonNull android.bluetooth.BluetoothDevice, int);













    method @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED) public void setVolume(@Nullable android.bluetooth.BluetoothDevice, @IntRange(from=0, to=255) int);













    field @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED) public static final String ACTION_CONNECTION_STATE_CHANGED = "android.bluetooth.volume-control.profile.action.CONNECTION_STATE_CHANGED";













  }



























  public final class BufferConstraint implements android.os.Parcelable {















    ctor public BufferConstraint(int, int, int);















    method public int describeContents();

























core/java/android/bluetooth/BluetoothAdapter.java



+8
−0






























Original line number
Diff line number
Diff line








@@ -3054,6 +3054,9 @@ public final class BluetoothAdapter {













                return true;















            }















            return false;













        } else if (profile == BluetoothProfile.VOLUME_CONTROL) {













            BluetoothVolumeControl vcs = new BluetoothVolumeControl(context, listener, this);













            return true;















        } else {















            return false;















        }










@@ -3142,6 +3145,11 @@ public final class BluetoothAdapter {













            case BluetoothProfile.HEARING_AID:















                BluetoothHearingAid hearingAid = (BluetoothHearingAid) proxy;















                hearingAid.close();













                break;













            case BluetoothProfile.VOLUME_CONTROL:













                BluetoothVolumeControl vcs = (BluetoothVolumeControl) proxy;













                vcs.close();













                break;















        }















    }

















































core/java/android/bluetooth/BluetoothProfile.java



+7
−1






























Original line number
Diff line number
Diff line








@@ -212,13 +212,19 @@ public interface BluetoothProfile {













     */















    int LE_AUDIO = 22;





























    /**













     * Volume Control profile













     *













     */













    int VOLUME_CONTROL = 23;





























    /**















     * Max profile ID. This value should be updated whenever a new profile is added to match















     * the largest value assigned to a profile.















     *















     * @hide















     */













    int MAX_PROFILE_ID = 22;













    int MAX_PROFILE_ID = 23;































    /**















     * Default priority for devices that we try to auto-connect to and

































core/java/android/bluetooth/BluetoothVolumeControl.java
0 → 100644



+320
−0






























Original line number
Diff line number
Diff line













/*













 * Copyright 2021 HIMSA II K/S - www.himsa.com.













 * Represented by EHIMA - www.ehima.com













 *













 * 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 android.bluetooth;



























import android.Manifest;













import android.annotation.IntRange;













import android.annotation.NonNull;













import android.annotation.Nullable;













import android.annotation.RequiresPermission;













import android.annotation.SdkConstant;













import android.annotation.SdkConstant.SdkConstantType;













import android.annotation.SuppressLint;













import android.annotation.SystemApi;













import android.compat.annotation.UnsupportedAppUsage;













import android.content.Context;













import android.os.Binder;













import android.os.IBinder;













import android.os.RemoteException;













import android.util.CloseGuard;













import android.util.Log;



























import java.util.ArrayList;













import java.util.List;



























/**













 * This class provides the public APIs to control the Bluetooth Volume Control service.













 *













 * <p>BluetoothVolumeControl is a proxy object for controlling the Bluetooth VC













 * Service via IPC. Use {@link BluetoothAdapter#getProfileProxy} to get













 * the BluetoothVolumeControl proxy object.













 * @hide













 */













@SystemApi













public final class BluetoothVolumeControl implements BluetoothProfile, AutoCloseable {













    private static final String TAG = "BluetoothVolumeControl";













    private static final boolean DBG = true;













    private static final boolean VDBG = false;



























    private CloseGuard mCloseGuard;



























    /**













     * Intent used to broadcast the change in connection state of the Volume Control













     * profile.













     *













     * <p>This intent will have 3 extras:













     * <ul>













     * <li> {@link #EXTRA_STATE} - The current state of the profile. </li>













     * <li> {@link #EXTRA_PREVIOUS_STATE}- The previous state of the profile.</li>













     * <li> {@link BluetoothDevice#EXTRA_DEVICE} - The remote device. </li>













     * </ul>













     *













     * <p>{@link #EXTRA_STATE} or {@link #EXTRA_PREVIOUS_STATE} can be any of













     * {@link #STATE_DISCONNECTED}, {@link #STATE_CONNECTING},













     * {@link #STATE_CONNECTED}, {@link #STATE_DISCONNECTING}.













     *













     * @hide













     */













    @SystemApi













    @SuppressLint("ActionValue")













    @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)













    @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)













    public static final String ACTION_CONNECTION_STATE_CHANGED =













            "android.bluetooth.volume-control.profile.action.CONNECTION_STATE_CHANGED";



























    private BluetoothAdapter mAdapter;













    private final BluetoothProfileConnector<IBluetoothVolumeControl> mProfileConnector =













            new BluetoothProfileConnector(this, BluetoothProfile.VOLUME_CONTROL, TAG,













                    IBluetoothVolumeControl.class.getName()) {













                @Override













                public IBluetoothVolumeControl getServiceInterface(IBinder service) {













                    return IBluetoothVolumeControl.Stub.asInterface(Binder.allowBlocking(service));













                }













            };



























    /**













     * Create a BluetoothVolumeControl proxy object for interacting with the local













     * Bluetooth Volume Control service.













     */













    /*package*/ BluetoothVolumeControl(Context context, ServiceListener listener,













            BluetoothAdapter adapter) {













        mAdapter = adapter;













        mProfileConnector.connect(context, listener);













        mCloseGuard = new CloseGuard();













        mCloseGuard.open("close");













    }



























    @RequiresPermission(Manifest.permission.BLUETOOTH_PRIVILEGED)













    protected void finalize() {













        if (mCloseGuard != null) {













            mCloseGuard.warnIfOpen();













        }













        close();













    }



























    /*package*/













    @RequiresPermission(Manifest.permission.BLUETOOTH_PRIVILEGED)













    public void close() {













        mProfileConnector.disconnect();













    }



























    private IBluetoothVolumeControl getService() { return mProfileConnector.getService(); }



























    /**













     * Get the list of connected devices. Currently at most one.













     *













     * @return list of connected devices













     *













     * @hide













     */













    @SystemApi













    @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)













    public @NonNull List<BluetoothDevice> getConnectedDevices() {













        if (DBG) log("getConnectedDevices()");













        final IBluetoothVolumeControl service = getService();













        if (service != null && isEnabled()) {













            try {













                return service.getConnectedDevices();













            } catch (RemoteException e) {













                Log.e(TAG, Log.getStackTraceString(new Throwable()));













                return new ArrayList<BluetoothDevice>();













            }













        }













        if (service == null) Log.w(TAG, "Proxy not attached to service");













        return new ArrayList<BluetoothDevice>();













    }



























    /**













     * Get the list of devices matching specified states. Currently at most one.













     *













     * @return list of matching devices













     *













     * @hide













     */













    @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)













    public List<BluetoothDevice> getDevicesMatchingConnectionStates(int[] states) {













        if (DBG) log("getDevicesMatchingStates()");













        final IBluetoothVolumeControl service = getService();













        if (service != null && isEnabled()) {













            try {













                return service.getDevicesMatchingConnectionStates(states);













            } catch (RemoteException e) {













                Log.e(TAG, Log.getStackTraceString(new Throwable()));













                return new ArrayList<BluetoothDevice>();













            }













        }













        if (service == null) Log.w(TAG, "Proxy not attached to service");













        return new ArrayList<BluetoothDevice>();













    }



























    /**













     * Get connection state of device













     *













     * @return device connection state













     *













     * @hide













     */













    @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)













    public int getConnectionState(BluetoothDevice device) {













        if (DBG) log("getConnectionState(" + device + ")");













        final IBluetoothVolumeControl service = getService();













        if (service != null && isEnabled() && isValidDevice(device)) {













            try {













                return service.getConnectionState(device);













            } catch (RemoteException e) {













                Log.e(TAG, Log.getStackTraceString(new Throwable()));













                return BluetoothProfile.STATE_DISCONNECTED;













            }













        }













        if (service == null) Log.w(TAG, "Proxy not attached to service");













        return BluetoothProfile.STATE_DISCONNECTED;













    }



























    /**













     * Tells remote device to set an absolute volume.













     *













     * @param volume Absolute volume to be set on remote device.













     *               Minimum value is 0 and maximum value is 255













     * @hide













     */













    @SystemApi













    @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)













    public void setVolume(@Nullable BluetoothDevice device,













            @IntRange(from = 0, to = 255) int volume) {













        if (DBG)













            log("setVolume(" + volume + ")");













        final IBluetoothVolumeControl service = getService();













        try {













            if (service != null && isEnabled()) {













                service.setVolume(device, volume);













                return;













            }













            if (service == null)













                Log.w(TAG, "Proxy not attached to service");













        } catch (RemoteException e) {













            Log.e(TAG, "Stack:" + Log.getStackTraceString(new Throwable()));













        }













    }



























    /**













     * Set priority of the profile













     *













     * <p> The device should already be paired.













     * Priority can be one of {@link #PRIORITY_ON} or {@link #PRIORITY_OFF},













     *













     * @param device Paired bluetooth device













     * @param priority













     * @return true if priority is set, false on error













     * @hide













     */













    @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)













    public boolean setPriority(BluetoothDevice device, int priority) {













        if (DBG) log("setPriority(" + device + ", " + priority + ")");













        return setConnectionPolicy(device, BluetoothAdapter.priorityToConnectionPolicy(priority));













    }



























    /**













     * Set connection policy of the profile













     *













     * <p> The device should already be paired.













     * Connection policy can be one of {@link #CONNECTION_POLICY_ALLOWED},













     * {@link #CONNECTION_POLICY_FORBIDDEN}, {@link #CONNECTION_POLICY_UNKNOWN}













     *













     * @param device Paired bluetooth device













     * @param connectionPolicy is the connection policy to set to for this profile













     * @return true if connectionPolicy is set, false on error













     * @hide













     */













    @SystemApi













    @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)













    public boolean setConnectionPolicy(@NonNull BluetoothDevice device,













            @ConnectionPolicy int connectionPolicy) {













        if (DBG) log("setConnectionPolicy(" + device + ", " + connectionPolicy + ")");













        final IBluetoothVolumeControl service = getService();













        if (service != null && isEnabled() && isValidDevice(device)) {













            if (connectionPolicy != BluetoothProfile.CONNECTION_POLICY_FORBIDDEN













                    && connectionPolicy != BluetoothProfile.CONNECTION_POLICY_ALLOWED) {













                return false;













            }













            try {













                return service.setConnectionPolicy(device, connectionPolicy);













            } catch (RemoteException e) {













                Log.e(TAG, Log.getStackTraceString(new Throwable()));













                return false;













            }













        }













        if (service == null) Log.w(TAG, "Proxy not attached to service");













        return false;













    }



























    /**













     * Get the priority of the profile.













     *













     * <p> The priority can be any of:













     * {@link #PRIORITY_OFF}, {@link #PRIORITY_ON}, {@link #PRIORITY_UNDEFINED}













     *













     * @param device Bluetooth device













     * @return priority of the device













     * @hide













     */













    @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)













    public int getPriority(BluetoothDevice device) {













        if (VDBG) log("getPriority(" + device + ")");













        return BluetoothAdapter.connectionPolicyToPriority(getConnectionPolicy(device));













    }



























    /**













     * Get the connection policy of the profile.













     *













     * <p> The connection policy can be any of:













     * {@link #CONNECTION_POLICY_ALLOWED}, {@link #CONNECTION_POLICY_FORBIDDEN},













     * {@link #CONNECTION_POLICY_UNKNOWN}













     *













     * @param device Bluetooth device













     * @return connection policy of the device













     * @hide













     */













    @SystemApi













    @RequiresPermission(android.Manifest.permission.BLUETOOTH_PRIVILEGED)













    public @ConnectionPolicy int getConnectionPolicy(@NonNull BluetoothDevice device) {













        if (VDBG) log("getConnectionPolicy(" + device + ")");













        final IBluetoothVolumeControl service = getService();













        if (service != null && isEnabled() && isValidDevice(device)) {













            try {













                return service.getConnectionPolicy(device);













            } catch (RemoteException e) {













                Log.e(TAG, Log.getStackTraceString(new Throwable()));













                return BluetoothProfile.CONNECTION_POLICY_FORBIDDEN;













            }













        }













        if (service == null) Log.w(TAG, "Proxy not attached to service");













        return BluetoothProfile.CONNECTION_POLICY_FORBIDDEN;













    }



























    private boolean isEnabled() {













        return mAdapter.getState() == BluetoothAdapter.STATE_ON;













    }



























    private static boolean isValidDevice(@Nullable BluetoothDevice device) {













        return device != null && BluetoothAdapter.checkBluetoothAddress(device.getAddress());













    }



























    private static void log(String msg) {













        Log.d(TAG, msg);













    }













}