| /* |
| * Copyright (C) 2018 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.car.audio; |
| |
| import static com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport.BOILERPLATE_CODE; |
| import static com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport.DUMP_INFO; |
| |
| import android.annotation.NonNull; |
| import android.annotation.Nullable; |
| import android.annotation.UserIdInt; |
| import android.car.media.CarAudioManager; |
| import android.media.AudioDevicePort; |
| import android.os.UserHandle; |
| import android.util.IndentingPrintWriter; |
| import android.util.Slog; |
| import android.util.SparseArray; |
| |
| import com.android.car.CarLog; |
| import com.android.car.audio.CarAudioContext.AudioContext; |
| import com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport; |
| import com.android.internal.annotations.GuardedBy; |
| import com.android.internal.annotations.VisibleForTesting; |
| import com.android.internal.util.Preconditions; |
| |
| import java.util.ArrayList; |
| import java.util.Arrays; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| |
| /** |
| * A class encapsulates a volume group in car. |
| * |
| * Volume in a car is controlled by group. A group holds one or more car audio contexts. |
| * Call {@link CarAudioManager#getVolumeGroupCount()} to get the count of {@link CarVolumeGroup} |
| * supported in a car. |
| */ |
| /* package */ final class CarVolumeGroup { |
| |
| private final boolean mUseCarVolumeGroupMute; |
| private final boolean mHasCriticalAudioContexts; |
| private final CarAudioSettings mSettingsManager; |
| private final int mDefaultGain; |
| private final int mId; |
| private final int mMaxGain; |
| private final int mMinGain; |
| private final int mStepSize; |
| private final int mZoneId; |
| private final SparseArray<String> mContextToAddress; |
| private final Map<String, CarAudioDeviceInfo> mAddressToCarAudioDeviceInfo; |
| |
| private final Object mLock = new Object(); |
| |
| @GuardedBy("mLock") |
| private int mStoredGainIndex; |
| @GuardedBy("mLock") |
| private int mCurrentGainIndex = -1; |
| @GuardedBy("mLock") |
| private boolean mIsMuted; |
| @GuardedBy("mLock") |
| private @UserIdInt int mUserId = UserHandle.USER_CURRENT; |
| |
| private CarVolumeGroup(int zoneId, int id, CarAudioSettings settingsManager, int stepSize, |
| int defaultGain, int minGain, int maxGain, SparseArray<String> contextToAddress, |
| Map<String, CarAudioDeviceInfo> addressToCarAudioDeviceInfo, |
| boolean useCarVolumeGroupMute) { |
| |
| mSettingsManager = settingsManager; |
| mZoneId = zoneId; |
| mId = id; |
| mStepSize = stepSize; |
| mDefaultGain = defaultGain; |
| mMinGain = minGain; |
| mMaxGain = maxGain; |
| mContextToAddress = contextToAddress; |
| mAddressToCarAudioDeviceInfo = addressToCarAudioDeviceInfo; |
| mUseCarVolumeGroupMute = useCarVolumeGroupMute; |
| |
| mHasCriticalAudioContexts = containsCriticalAudioContext(contextToAddress); |
| } |
| |
| void init() { |
| mStoredGainIndex = mSettingsManager.getStoredVolumeGainIndexForUser(mUserId, mZoneId, mId); |
| updateCurrentGainIndexLocked(); |
| } |
| |
| @Nullable |
| CarAudioDeviceInfo getCarAudioDeviceInfoForAddress(String address) { |
| return mAddressToCarAudioDeviceInfo.get(address); |
| } |
| |
| @AudioContext |
| int[] getContexts() { |
| final int[] carAudioContexts = new int[mContextToAddress.size()]; |
| for (int i = 0; i < carAudioContexts.length; i++) { |
| carAudioContexts[i] = mContextToAddress.keyAt(i); |
| } |
| return carAudioContexts; |
| } |
| |
| /** |
| * Returns the devices address for the given context |
| * or {@code null} if the context does not exist in the volume group |
| */ |
| @Nullable |
| String getAddressForContext(int audioContext) { |
| return mContextToAddress.get(audioContext); |
| } |
| |
| @AudioContext |
| List<Integer> getContextsForAddress(@NonNull String address) { |
| List<Integer> carAudioContexts = new ArrayList<>(); |
| for (int i = 0; i < mContextToAddress.size(); i++) { |
| String value = mContextToAddress.valueAt(i); |
| if (address.equals(value)) { |
| carAudioContexts.add(mContextToAddress.keyAt(i)); |
| } |
| } |
| return carAudioContexts; |
| } |
| |
| List<String> getAddresses() { |
| return new ArrayList<>(mAddressToCarAudioDeviceInfo.keySet()); |
| } |
| |
| int getMaxGainIndex() { |
| synchronized (mLock) { |
| return getIndexForGain(mMaxGain); |
| } |
| } |
| |
| int getMinGainIndex() { |
| synchronized (mLock) { |
| return getIndexForGain(mMinGain); |
| } |
| } |
| |
| int getCurrentGainIndex() { |
| synchronized (mLock) { |
| if (mIsMuted) { |
| return getIndexForGain(mMinGain); |
| } |
| return getCurrentGainIndexLocked(); |
| } |
| } |
| |
| private int getCurrentGainIndexLocked() { |
| return mCurrentGainIndex; |
| } |
| |
| /** |
| * Sets the gain on this group, gain will be set on all devices within volume group. |
| */ |
| void setCurrentGainIndex(int gainIndex) { |
| Preconditions.checkArgument(isValidGainIndex(gainIndex), |
| "Gain out of range (%d:%d) index %d", mMinGain, mMaxGain, gainIndex); |
| synchronized (mLock) { |
| if (mIsMuted) { |
| setMuteLocked(false); |
| } |
| setCurrentGainIndexLocked(gainIndex); |
| } |
| } |
| |
| private void setCurrentGainIndexLocked(int gainIndex) { |
| int gainInMillibels = getGainForIndex(gainIndex); |
| for (String address : mAddressToCarAudioDeviceInfo.keySet()) { |
| CarAudioDeviceInfo info = mAddressToCarAudioDeviceInfo.get(address); |
| info.setCurrentGain(gainInMillibels); |
| } |
| |
| mCurrentGainIndex = gainIndex; |
| |
| storeGainIndexForUserLocked(mCurrentGainIndex, mUserId); |
| } |
| |
| @Nullable |
| AudioDevicePort getAudioDevicePortForContext(int carAudioContext) { |
| final String address = mContextToAddress.get(carAudioContext); |
| if (address == null || mAddressToCarAudioDeviceInfo.get(address) == null) { |
| return null; |
| } |
| |
| return mAddressToCarAudioDeviceInfo.get(address).getAudioDevicePort(); |
| } |
| |
| boolean hasCriticalAudioContexts() { |
| return mHasCriticalAudioContexts; |
| } |
| |
| @Override |
| @ExcludeFromCodeCoverageGeneratedReport(reason = BOILERPLATE_CODE) |
| public String toString() { |
| return "CarVolumeGroup id: " + mId |
| + " currentGainIndex: " + mCurrentGainIndex |
| + " contexts: " + Arrays.toString(getContexts()) |
| + " addresses: " + String.join(", ", getAddresses()); |
| } |
| |
| @ExcludeFromCodeCoverageGeneratedReport(reason = DUMP_INFO) |
| void dump(IndentingPrintWriter writer) { |
| synchronized (mLock) { |
| writer.printf("CarVolumeGroup(%d)\n", mId); |
| writer.increaseIndent(); |
| writer.printf("Zone Id(%b)\n", mZoneId); |
| writer.printf("Is Muted(%b)\n", mIsMuted); |
| writer.printf("UserId(%d)\n", mUserId); |
| writer.printf("Persist Volume Group Mute(%b)\n", |
| mSettingsManager.isPersistVolumeGroupMuteEnabled(mUserId)); |
| writer.printf("Step size: %d\n", mStepSize); |
| writer.printf("Gain values (min / max / default/ current): %d %d %d %d\n", mMinGain, |
| mMaxGain, mDefaultGain, getGainForIndex(mCurrentGainIndex)); |
| writer.printf("Gain indexes (min / max / default / current): %d %d %d %d\n", |
| getMinGainIndex(), getMaxGainIndex(), getDefaultGainIndex(), mCurrentGainIndex); |
| for (int i = 0; i < mContextToAddress.size(); i++) { |
| writer.printf("Context: %s -> Address: %s\n", |
| CarAudioContext.toString(mContextToAddress.keyAt(i)), |
| mContextToAddress.valueAt(i)); |
| } |
| mAddressToCarAudioDeviceInfo.keySet().stream() |
| .map(mAddressToCarAudioDeviceInfo::get) |
| .forEach((info -> info.dump(writer))); |
| |
| // Empty line for comfortable reading |
| writer.println(); |
| writer.decreaseIndent(); |
| } |
| } |
| |
| void loadVolumesSettingsForUser(@UserIdInt int userId) { |
| synchronized (mLock) { |
| //Update the volume for the new user |
| updateUserIdLocked(userId); |
| //Update the current gain index |
| updateCurrentGainIndexLocked(); |
| setCurrentGainIndexLocked(getCurrentGainIndexLocked()); |
| //Reset devices with current gain index |
| updateGroupMuteLocked(); |
| } |
| } |
| |
| void setMute(boolean mute) { |
| synchronized (mLock) { |
| setMuteLocked(mute); |
| } |
| } |
| |
| void setMuteLocked(boolean mute) { |
| mIsMuted = mute; |
| if (mSettingsManager.isPersistVolumeGroupMuteEnabled(mUserId)) { |
| mSettingsManager.storeVolumeGroupMuteForUser(mUserId, mZoneId, mId, mute); |
| } |
| } |
| |
| boolean isMuted() { |
| synchronized (mLock) { |
| return mIsMuted; |
| } |
| } |
| |
| private static boolean containsCriticalAudioContext(SparseArray<String> contextToAddress) { |
| for (int i = 0; i < contextToAddress.size(); i++) { |
| int audioContext = contextToAddress.keyAt(i); |
| if (CarAudioContext.isCriticalAudioContext(audioContext)) { |
| return true; |
| } |
| } |
| return false; |
| } |
| |
| @GuardedBy("mLock") |
| private void updateUserIdLocked(@UserIdInt int userId) { |
| mUserId = userId; |
| mStoredGainIndex = getCurrentGainIndexForUserLocked(); |
| } |
| |
| @GuardedBy("mLock") |
| private int getCurrentGainIndexForUserLocked() { |
| int gainIndexForUser = mSettingsManager.getStoredVolumeGainIndexForUser(mUserId, mZoneId, |
| mId); |
| Slog.i(CarLog.TAG_AUDIO, "updateUserId userId " + mUserId |
| + " gainIndexForUser " + gainIndexForUser); |
| return gainIndexForUser; |
| } |
| |
| /** |
| * Update the current gain index based on the stored gain index |
| */ |
| @GuardedBy("mLock") |
| private void updateCurrentGainIndexLocked() { |
| if (isValidGainIndex(mStoredGainIndex)) { |
| mCurrentGainIndex = mStoredGainIndex; |
| } else { |
| mCurrentGainIndex = getIndexForGain(mDefaultGain); |
| } |
| } |
| |
| private boolean isValidGainIndex(int gainIndex) { |
| return gainIndex >= getIndexForGain(mMinGain) |
| && gainIndex <= getIndexForGain(mMaxGain); |
| } |
| |
| private int getDefaultGainIndex() { |
| synchronized (mLock) { |
| return getIndexForGain(mDefaultGain); |
| } |
| } |
| |
| @GuardedBy("mLock") |
| private void storeGainIndexForUserLocked(int gainIndex, @UserIdInt int userId) { |
| mSettingsManager.storeVolumeGainIndexForUser(userId, |
| mZoneId, mId, gainIndex); |
| } |
| |
| private int getGainForIndex(int gainIndex) { |
| return mMinGain + gainIndex * mStepSize; |
| } |
| |
| private int getIndexForGain(int gainInMillibel) { |
| return (gainInMillibel - mMinGain) / mStepSize; |
| } |
| |
| @GuardedBy("mLock") |
| private void updateGroupMuteLocked() { |
| if (!mUseCarVolumeGroupMute) { |
| return; |
| } |
| if (!mSettingsManager.isPersistVolumeGroupMuteEnabled(mUserId)) { |
| mIsMuted = false; |
| return; |
| } |
| mIsMuted = mSettingsManager.getVolumeGroupMuteForUser(mUserId, mZoneId, mId); |
| } |
| |
| static final class Builder { |
| private static final int UNSET_STEP_SIZE = -1; |
| |
| private final int mId; |
| private final int mZoneId; |
| private final boolean mUseCarVolumeGroupMute; |
| private final CarAudioSettings mCarAudioSettings; |
| private final SparseArray<String> mContextToAddress = new SparseArray<>(); |
| private final Map<String, CarAudioDeviceInfo> mAddressToCarAudioDeviceInfo = |
| new HashMap<>(); |
| |
| @VisibleForTesting |
| int mStepSize = UNSET_STEP_SIZE; |
| @VisibleForTesting |
| int mDefaultGain = Integer.MIN_VALUE; |
| @VisibleForTesting |
| int mMaxGain = Integer.MIN_VALUE; |
| @VisibleForTesting |
| int mMinGain = Integer.MAX_VALUE; |
| |
| Builder(int zoneId, int id, CarAudioSettings carAudioSettings, |
| boolean useCarVolumeGroupMute) { |
| mZoneId = zoneId; |
| mId = id; |
| mCarAudioSettings = carAudioSettings; |
| mUseCarVolumeGroupMute = useCarVolumeGroupMute; |
| } |
| |
| Builder setDeviceInfoForContext(int carAudioContext, CarAudioDeviceInfo info) { |
| Preconditions.checkArgument(mContextToAddress.get(carAudioContext) == null, |
| "Context %s has already been set to %s", |
| CarAudioContext.toString(carAudioContext), |
| mContextToAddress.get(carAudioContext)); |
| |
| if (mAddressToCarAudioDeviceInfo.isEmpty()) { |
| mStepSize = info.getStepValue(); |
| } else { |
| Preconditions.checkArgument( |
| info.getStepValue() == mStepSize, |
| "Gain controls within one group must have same step value"); |
| } |
| |
| mAddressToCarAudioDeviceInfo.put(info.getAddress(), info); |
| mContextToAddress.put(carAudioContext, info.getAddress()); |
| |
| if (info.getDefaultGain() > mDefaultGain) { |
| // We're arbitrarily selecting the highest |
| // device default gain as the group's default. |
| mDefaultGain = info.getDefaultGain(); |
| } |
| if (info.getMaxGain() > mMaxGain) { |
| mMaxGain = info.getMaxGain(); |
| } |
| if (info.getMinGain() < mMinGain) { |
| mMinGain = info.getMinGain(); |
| } |
| |
| return this; |
| } |
| |
| CarVolumeGroup build() { |
| Preconditions.checkArgument(mStepSize != UNSET_STEP_SIZE, |
| "setDeviceInfoForContext has to be called at least once before building"); |
| CarVolumeGroup group = new CarVolumeGroup(mZoneId, mId, mCarAudioSettings, mStepSize, |
| mDefaultGain, mMinGain, mMaxGain, mContextToAddress, |
| mAddressToCarAudioDeviceInfo, mUseCarVolumeGroupMute); |
| group.init(); |
| return group; |
| } |
| } |
| } |