xref: /external/robolectric/shadows/framework/src/main/java/org/robolectric/shadows/ShadowAudioManager.java

package org.robolectric.shadows;

import static android.os.Build.VERSION_CODES.M;
import static android.os.Build.VERSION_CODES.N;
import static android.os.Build.VERSION_CODES.O;
import static android.os.Build.VERSION_CODES.P;
import static android.os.Build.VERSION_CODES.Q;
import static android.os.Build.VERSION_CODES.R;
import static android.os.Build.VERSION_CODES.S;
import static android.os.Build.VERSION_CODES.TIRAMISU;
import static android.os.Build.VERSION_CODES.UPSIDE_DOWN_CAKE;
import static org.robolectric.util.ReflectionHelpers.ClassParameter.from;
import static org.robolectric.util.reflector.Reflector.reflector;

import android.annotation.RequiresPermission;
import android.annotation.TargetApi;
import android.media.AudioAttributes;
import android.media.AudioDeviceCallback;
import android.media.AudioDeviceInfo;
import android.media.AudioFormat;
import android.media.AudioManager;
import android.media.AudioPlaybackConfiguration;
import android.media.AudioProfile;
import android.media.AudioRecordingConfiguration;
import android.media.IPlayer;
import android.media.PlayerBase;
import android.media.audiopolicy.AudioPolicy;
import android.os.Build.VERSION_CODES;
import android.os.Handler;
import android.os.Parcel;
import android.view.KeyEvent;
import com.android.internal.util.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.concurrent.Executor;
import javax.annotation.Nonnull;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.ClassName;
import org.robolectric.annotation.HiddenApi;
import org.robolectric.annotation.Implementation;
import org.robolectric.annotation.Implements;
import org.robolectric.annotation.RealObject;
import org.robolectric.annotation.Resetter;
import org.robolectric.util.ReflectionHelpers;
import org.robolectric.util.reflector.Constructor;
import org.robolectric.util.reflector.ForType;

@SuppressWarnings({"UnusedDeclaration"})
@Implements(value = AudioManager.class)
public class ShadowAudioManager {
  @RealObject AudioManager realAudioManager;

  public static final int MAX_VOLUME_MUSIC_DTMF = 15;
  public static final int DEFAULT_MAX_VOLUME = 7;
  public static final int MIN_VOLUME = 0;
  public static final int DEFAULT_VOLUME = 7;
  public static final int INVALID_VOLUME = 0;
  public static final int FLAG_NO_ACTION = 0;
  public static final ImmutableList<Integer> ALL_STREAMS =
      ImmutableList.of(
          AudioManager.STREAM_MUSIC,
          AudioManager.STREAM_ASSISTANT,
          AudioManager.STREAM_ALARM,
          AudioManager.STREAM_NOTIFICATION,
          AudioManager.STREAM_RING,
          AudioManager.STREAM_SYSTEM,
          AudioManager.STREAM_VOICE_CALL,
          AudioManager.STREAM_DTMF,
          AudioManager.STREAM_ACCESSIBILITY);

  private static final int INVALID_PATCH_HANDLE = -1;
  private static final float MAX_VOLUME_DB = 0;
  private static final float MIN_VOLUME_DB = -100;

  private AudioFocusRequest lastAudioFocusRequest;
  private int nextResponseValue = AudioManager.AUDIOFOCUS_REQUEST_GRANTED;
  private AudioManager.OnAudioFocusChangeListener lastAbandonedAudioFocusListener;
  private android.media.AudioFocusRequest lastAbandonedAudioFocusRequest;
  private HashMap<Integer, AudioStream> streamStatus = new HashMap<>();
  private List<AudioPlaybackConfiguration> activePlaybackConfigurations = Collections.emptyList();
  private List<AudioRecordingConfiguration> activeRecordingConfigurations = ImmutableList.of();
  private final HashSet<AudioManager.AudioRecordingCallback> audioRecordingCallbacks =
      new HashSet<>();
  private final HashSet<AudioManager.AudioPlaybackCallback> audioPlaybackCallbacks =
      new HashSet<>();
  private final HashSet<AudioDeviceCallback> audioDeviceCallbacks = new HashSet<>();
  private static int ringerMode = AudioManager.RINGER_MODE_NORMAL;
  private static int mode = AudioManager.MODE_NORMAL;
  private static boolean lockMode = false;
  private static boolean bluetoothA2dpOn;
  private static boolean isBluetoothScoOn;
  private static boolean isSpeakerphoneOn;
  private static boolean isMicrophoneMuted = false;
  private static boolean isMusicActive;
  private static boolean wiredHeadsetOn;
  private static boolean isBluetoothScoAvailableOffCall = false;
  private final Map<String, String> parameters = new HashMap<>();
  private final Map<Integer, Boolean> streamsMuteState = new HashMap<>();
  private final Map<String, AudioPolicy> registeredAudioPolicies = new HashMap<>();
  private final Map<AudioManager.OnCommunicationDeviceChangedListener, Executor>
      registeredCommunicationDeviceChangedListeners = new HashMap<>();
  private int audioSessionIdCounter = 1;
  private final Map<AudioAttributes, ImmutableList<Object>> devicesForAttributes = new HashMap<>();
  private final List<AudioDeviceInfo> outputDevicesWithDirectProfiles = new ArrayList<>();
  private ImmutableList<Object> defaultDevicesForAttributes = ImmutableList.of();
  private final Map<AudioAttributes, ImmutableList<AudioDeviceInfo>> audioDevicesForAttributes =
      new HashMap<>();
  private List<AudioDeviceInfo> inputDevices = new ArrayList<>();
  private List<AudioDeviceInfo> outputDevices = new ArrayList<>();
  private List<AudioDeviceInfo> availableCommunicationDevices = new ArrayList<>();
  private AudioDeviceInfo communicationDevice = null;
  private static boolean lockCommunicationDevice = false;
  private final List<KeyEvent> dispatchedMediaKeyEvents = new ArrayList<>();
  private static boolean isHotwordStreamSupportedForLookbackAudio = false;
  private static boolean isHotwordStreamSupportedWithoutLookbackAudio = false;

  public ShadowAudioManager() {
    for (int stream : ALL_STREAMS) {
      streamStatus.put(stream, new AudioStream(DEFAULT_VOLUME, DEFAULT_MAX_VOLUME, FLAG_NO_ACTION));
    }
    streamStatus.get(AudioManager.STREAM_MUSIC).setMaxVolume(MAX_VOLUME_MUSIC_DTMF);
    streamStatus.get(AudioManager.STREAM_DTMF).setMaxVolume(MAX_VOLUME_MUSIC_DTMF);
  }

  @Implementation
  protected int getStreamMaxVolume(int streamType) {
    AudioStream stream = streamStatus.get(streamType);
    return (stream != null) ? stream.getMaxVolume() : INVALID_VOLUME;
  }

  @Implementation
  protected int getStreamVolume(int streamType) {
    AudioStream stream = streamStatus.get(streamType);
    return (stream != null) ? stream.getCurrentVolume() : INVALID_VOLUME;
  }

  @Implementation(minSdk = P)
  protected float getStreamVolumeDb(int streamType, int index, int deviceType) {
    AudioStream stream = streamStatus.get(streamType);
    if (stream == null) {
      return INVALID_VOLUME;
    }
    if (index < MIN_VOLUME || index > stream.getMaxVolume()) {
      throw new IllegalArgumentException("Invalid stream volume index " + index);
    }
    if (index == MIN_VOLUME) {
      return Float.NEGATIVE_INFINITY;
    }
    float interpolation = (index - MIN_VOLUME) / (float) (stream.getMaxVolume() - MIN_VOLUME);
    return MIN_VOLUME_DB + interpolation * (MAX_VOLUME_DB - MIN_VOLUME_DB);
  }

  @Implementation
  protected void setStreamVolume(int streamType, int index, int flags) {
    AudioStream stream = streamStatus.get(streamType);
    if (stream != null) {
      stream.setCurrentVolume(index);
      stream.setFlag(flags);
    }
  }

  @Implementation
  protected boolean isBluetoothScoAvailableOffCall() {
    return isBluetoothScoAvailableOffCall;
  }

  @Implementation
  protected int requestAudioFocus(
      android.media.AudioManager.OnAudioFocusChangeListener l, int streamType, int durationHint) {
    lastAudioFocusRequest = new AudioFocusRequest(l, streamType, durationHint);
    return nextResponseValue;
  }

  /**
   * Provides a mock like interface for the requestAudioFocus method by storing the request object
   * for later inspection and returning the value specified in setNextFocusRequestResponse.
   */
  @Implementation(minSdk = O)
  protected int requestAudioFocus(android.media.AudioFocusRequest audioFocusRequest) {
    lastAudioFocusRequest = new AudioFocusRequest(audioFocusRequest);
    return nextResponseValue;
  }

  @Implementation
  protected int abandonAudioFocus(AudioManager.OnAudioFocusChangeListener l) {
    lastAbandonedAudioFocusListener = l;
    return nextResponseValue;
  }

  /**
   * Provides a mock like interface for the abandonAudioFocusRequest method by storing the request
   * object for later inspection and returning the value specified in setNextFocusRequestResponse.
   */
  @Implementation(minSdk = O)
  protected int abandonAudioFocusRequest(android.media.AudioFocusRequest audioFocusRequest) {
    lastAbandonedAudioFocusListener = audioFocusRequest.getOnAudioFocusChangeListener();
    lastAbandonedAudioFocusRequest = audioFocusRequest;
    return nextResponseValue;
  }

  @Implementation
  protected int getRingerMode() {
    return ringerMode;
  }

  @Implementation
  protected void setRingerMode(int ringerMode) {
    if (!AudioManager.isValidRingerMode(ringerMode)) {
      return;
    }
    this.ringerMode = ringerMode;
  }

  @Implementation
  public static boolean isValidRingerMode(int ringerMode) {
    return ringerMode >= 0
        && ringerMode
            <= (int) ReflectionHelpers.getStaticField(AudioManager.class, "RINGER_MODE_MAX");
  }

  /** Note that this method can silently fail. See {@link lockMode}. */
  @Implementation
  protected void setMode(int mode) {
    if (lockMode) {
      return;
    }
    int previousMode = this.mode;
    this.mode = mode;
    if (RuntimeEnvironment.getApiLevel() >= S && mode != previousMode) {
      dispatchModeChangedListeners(mode);
    }
  }

  @Resetter
  public static void reset() {
    ringerMode = AudioManager.RINGER_MODE_NORMAL;
    mode = AudioManager.MODE_NORMAL;
    lockMode = false;
    bluetoothA2dpOn = false;
    isBluetoothScoOn = false;
    isSpeakerphoneOn = false;
    isMicrophoneMuted = false;
    isMusicActive = false;
    wiredHeadsetOn = false;
    isBluetoothScoAvailableOffCall = false;
    lockCommunicationDevice = false;
    isHotwordStreamSupportedForLookbackAudio = false;
    isHotwordStreamSupportedWithoutLookbackAudio = false;
  }

  private void dispatchModeChangedListeners(int newMode) {
    Object modeDispatcherStub =
        reflector(ModeDispatcherStubReflector.class).newModeDispatcherStub(realAudioManager);
    reflector(ModeDispatcherStubReflector.class, modeDispatcherStub)
        .dispatchAudioModeChanged(newMode);
  }

  /** Sets whether subsequent calls to {@link setMode} will succeed or not. */
  public void lockMode(boolean lockMode) {
    this.lockMode = lockMode;
  }

  @Implementation
  protected int getMode() {
    return this.mode;
  }

  @ForType(className = "android.media.AudioManager$ModeDispatcherStub")
  interface ModeDispatcherStubReflector {
    @Constructor
    Object newModeDispatcherStub(AudioManager audioManager);

    void dispatchAudioModeChanged(int newMode);
  }

  public void setStreamMaxVolume(int streamMaxVolume) {
    streamStatus.forEach((key, value) -> value.setMaxVolume(streamMaxVolume));
  }

  public void setStreamVolume(int streamVolume) {
    streamStatus.forEach((key, value) -> value.setCurrentVolume(streamVolume));
  }

  @Implementation
  protected void setWiredHeadsetOn(boolean on) {
    wiredHeadsetOn = on;
  }

  @Implementation
  protected boolean isWiredHeadsetOn() {
    return wiredHeadsetOn;
  }

  @Implementation
  protected void setBluetoothA2dpOn(boolean on) {
    bluetoothA2dpOn = on;
  }

  @Implementation
  protected boolean isBluetoothA2dpOn() {
    return bluetoothA2dpOn;
  }

  @Implementation
  protected void setSpeakerphoneOn(boolean on) {
    isSpeakerphoneOn = on;
  }

  @Implementation
  protected boolean isSpeakerphoneOn() {
    return isSpeakerphoneOn;
  }

  @Implementation
  protected void setMicrophoneMute(boolean on) {
    isMicrophoneMuted = on;
  }

  @Implementation
  protected boolean isMicrophoneMute() {
    return isMicrophoneMuted;
  }

  @Implementation
  protected boolean isBluetoothScoOn() {
    return isBluetoothScoOn;
  }

  @Implementation
  protected void setBluetoothScoOn(boolean isBluetoothScoOn) {
    this.isBluetoothScoOn = isBluetoothScoOn;
  }

  @Implementation
  protected boolean isMusicActive() {
    return isMusicActive;
  }

  @Implementation(minSdk = O)
  protected List<AudioPlaybackConfiguration> getActivePlaybackConfigurations() {
    return new ArrayList<>(activePlaybackConfigurations);
  }

  @Implementation
  protected void setParameters(String keyValuePairs) {
    if (keyValuePairs.isEmpty()) {
      throw new IllegalArgumentException("keyValuePairs should not be empty");
    }

    if (keyValuePairs.charAt(keyValuePairs.length() - 1) != ';') {
      throw new IllegalArgumentException("keyValuePairs should end with a ';'");
    }

    String[] pairs = keyValuePairs.split(";", 0);

    for (String pair : pairs) {
      if (pair.isEmpty()) {
        continue;
      }

      String[] splitPair = pair.split("=", 0);
      if (splitPair.length != 2) {
        throw new IllegalArgumentException(
            "keyValuePairs: each pair should be in the format of key=value;");
      }
      parameters.put(splitPair[0], splitPair[1]);
    }
  }

  /**
   * The expected composition for keys is not well defined.
   *
   * <p>For testing purposes this method call always returns null.
   */
  @Implementation
  protected String getParameters(String keys) {
    return null;
  }

  /** Returns a single parameter that was set via {@link #setParameters(String)}. */
  public String getParameter(String key) {
    return parameters.get(key);
  }

  /**
   * Implements {@link AudioManager#adjustStreamVolume(int, int, int)}.
   *
   * <p>Currently supports only the directions {@link AudioManager#ADJUST_MUTE}, {@link
   * AudioManager#ADJUST_UNMUTE}, {@link AudioManager#ADJUST_LOWER} and {@link
   * AudioManager#ADJUST_RAISE}.
   */
  @Implementation
  protected void adjustStreamVolume(int streamType, int direction, int flags) {
    int streamVolume = getStreamVolume(streamType);
    switch (direction) {
      case AudioManager.ADJUST_MUTE:
        streamsMuteState.put(streamType, true);
        break;
      case AudioManager.ADJUST_UNMUTE:
        streamsMuteState.put(streamType, false);
        break;
      case AudioManager.ADJUST_RAISE:
        int streamMaxVolume = getStreamMaxVolume(streamType);
        if (streamVolume == INVALID_VOLUME || streamMaxVolume == INVALID_VOLUME) {
          return;
        }
        int raisedVolume = streamVolume + 1;
        if (raisedVolume <= streamMaxVolume) {
          setStreamVolume(raisedVolume);
        }
        break;
      case AudioManager.ADJUST_LOWER:
        if (streamVolume == INVALID_VOLUME) {
          return;
        }
        int lowerVolume = streamVolume - 1;
        if (lowerVolume >= 1) {
          setStreamVolume(lowerVolume);
        }
        break;
      default:
        break;
    }
  }

  @Implementation(minSdk = M)
  protected boolean isStreamMute(int streamType) {
    if (!streamsMuteState.containsKey(streamType)) {
      return false;
    }
    return streamsMuteState.get(streamType);
  }

  public void setIsBluetoothScoAvailableOffCall(boolean isBluetoothScoAvailableOffCall) {
    this.isBluetoothScoAvailableOffCall = isBluetoothScoAvailableOffCall;
  }

  public void setIsStreamMute(int streamType, boolean isMuted) {
    streamsMuteState.put(streamType, isMuted);
  }

  /**
   * Registers callback that will receive changes made to the list of active playback configurations
   * by {@link setActivePlaybackConfigurationsFor}.
   */
  @Implementation(minSdk = O)
  protected void registerAudioPlaybackCallback(
      AudioManager.AudioPlaybackCallback cb, Handler handler) {
    audioPlaybackCallbacks.add(cb);
  }

  /** Unregisters callback listening to changes made to list of active playback configurations. */
  @Implementation(minSdk = O)
  protected void unregisterAudioPlaybackCallback(AudioManager.AudioPlaybackCallback cb) {
    audioPlaybackCallbacks.remove(cb);
  }

  /**
   * Returns the devices associated with the given audio stream.
   *
   * <p>In this shadow-implementation the devices returned are either
   *
   * <ol>
   *   <li>devices set through {@link #setDevicesForAttributes}, or
   *   <li>devices set through {@link #setDefaultDevicesForAttributes}, or
   *   <li>an empty list.
   * </ol>
   */
  @Implementation(minSdk = R)
  @Nonnull
  protected List</*android.media.AudioDeviceAttributes*/ ?> getDevicesForAttributes(
      @Nonnull AudioAttributes attributes) {
    ImmutableList<Object> devices = devicesForAttributes.get(attributes);
    return devices == null ? defaultDevicesForAttributes : devices;
  }

  /** Sets the devices associated with the given audio stream. */
  public void setDevicesForAttributes(
      @Nonnull AudioAttributes attributes, @Nonnull ImmutableList<Object> devices) {
    devicesForAttributes.put(attributes, devices);
  }

  /** Sets the devices to use as default for all audio streams. */
  public void setDefaultDevicesForAttributes(@Nonnull ImmutableList<Object> devices) {
    defaultDevicesForAttributes = devices;
  }

  /**
   * Returns the audio devices that would be used for the routing of the given audio attributes.
   *
   * <p>Devices can be added with {@link #setAudioDevicesForAttributes}. Note that {@link
   * #setDevicesForAttributes} and {@link #setDefaultDevicesForAttributes} have no effect on the
   * return value of this method.
   */
  @Implementation(minSdk = TIRAMISU)
  @Nonnull
  protected List<AudioDeviceInfo> getAudioDevicesForAttributes(
      @Nonnull AudioAttributes attributes) {
    ImmutableList<AudioDeviceInfo> devices = audioDevicesForAttributes.get(attributes);
    return devices == null ? ImmutableList.of() : devices;
  }

  /** Sets the audio devices returned from {@link #getAudioDevicesForAttributes}. */
  public void setAudioDevicesForAttributes(
      @Nonnull AudioAttributes attributes, @Nonnull ImmutableList<AudioDeviceInfo> devices) {
    audioDevicesForAttributes.put(attributes, devices);
  }

  /**
   * Registers a {@link AudioManager.OnCommunicationDeviceChangedListener} that can later be called
   * with {@link #callOnCommunicationDeviceChangedListeners}. The provided executor will be used
   * when calling {@link
   * AudioManager.OnCommunicationDeviceChangedListener#onCommunicationDeviceChanged}
   */
  @Implementation(minSdk = S)
  protected void addOnCommunicationDeviceChangedListener(
      Executor executor, AudioManager.OnCommunicationDeviceChangedListener listener) {
    Objects.requireNonNull(executor);
    Objects.requireNonNull(listener);
    if (registeredCommunicationDeviceChangedListeners.containsKey(listener)) {
      throw new IllegalArgumentException(
          "attempt to call addOnCommunicationDeviceChangedListener on a previously registered"
              + " listener");
    }
    registeredCommunicationDeviceChangedListeners.put(listener, executor);
  }

  /**
   * Unregisters a previously registered {@link AudioManager.OnCommunicationDeviceChangedListener}.
   */
  @Implementation(minSdk = S)
  protected void removeOnCommunicationDeviceChangedListener(
      AudioManager.OnCommunicationDeviceChangedListener listener) {
    Objects.requireNonNull(listener);
    if (!registeredCommunicationDeviceChangedListeners.containsKey(listener)) {
      throw new IllegalArgumentException(
          "attempt to call removeOnCommunicationDeviceChangedListener on an unregistered listener");
    }
    registeredCommunicationDeviceChangedListeners.remove(listener);
  }

  /**
   * Calls the {@link
   * AudioManager.OnCommunicationDeviceChangedListener#onCommunicationDeviceChanged} method on all
   * registered {@link AudioManager.OnCommunicationDeviceChangedListener}, using their registered
   * executors, with the provided {@link AudioDeviceInfo} as argument.
   */
  public void callOnCommunicationDeviceChangedListeners(AudioDeviceInfo device) {
    registeredCommunicationDeviceChangedListeners.forEach(
        (listener, executor) ->
            executor.execute(() -> listener.onCommunicationDeviceChanged(device)));
  }

  /**
   * Sets the list of connected input devices represented by {@link AudioDeviceInfo}.
   *
   * <p>The previous list of input devices is replaced and no notifications of the list of {@link
   * AudioDeviceCallback} is done.
   *
   * <p>To add/remove devices one by one and trigger notifications for the list of {@link
   * AudioDeviceCallback} please use one of the following methods {@link
   * #addInputDevice(AudioDeviceInfo, boolean)}, {@link #removeInputDevice(AudioDeviceInfo,
   * boolean)}.
   */
  public void setInputDevices(List<AudioDeviceInfo> inputDevices) {
    this.inputDevices = new ArrayList<>(inputDevices);
  }

  /**
   * Sets the list of connected output devices represented by {@link AudioDeviceInfo}.
   *
   * <p>The previous list of output devices is replaced and no notifications of the list of {@link
   * AudioDeviceCallback} is done.
   *
   * <p>To add/remove devices one by one and trigger notifications for the list of {@link
   * AudioDeviceCallback} please use one of the following methods {@link
   * #addOutputDevice(AudioDeviceInfo, boolean)}, {@link #removeOutputDevice(AudioDeviceInfo,
   * boolean)}.
   */
  public void setOutputDevices(List<AudioDeviceInfo> outputDevices) {
    this.outputDevices = new ArrayList<>(outputDevices);
  }

  /**
   * Sets the list of available communication devices represented by {@link AudioDeviceInfo}.
   *
   * <p>The previous list of communication devices is replaced and no notifications of the list of
   * {@link AudioDeviceCallback} is done.
   *
   * <p>To add/remove devices one by one and trigger notifications for the list of {@link
   * AudioDeviceCallback} please use one of the following methods {@link
   * #addOutputDevice(AudioDeviceInfo, boolean)}, {@link #removeOutputDevice(AudioDeviceInfo,
   * boolean)}.
   */
  @TargetApi(VERSION_CODES.S)
  public void setAvailableCommunicationDevices(
      List<AudioDeviceInfo> availableCommunicationDevices) {
    this.availableCommunicationDevices = new ArrayList<>(availableCommunicationDevices);
  }

  /**
   * Adds an input {@link AudioDeviceInfo} and notifies the list of {@link AudioDeviceCallback} if
   * the device was not present before and indicated by {@code notifyAudioDeviceCallbacks}.
   */
  public void addInputDevice(AudioDeviceInfo inputDevice, boolean notifyAudioDeviceCallbacks) {
    boolean changed =
        !this.inputDevices.contains(inputDevice) && this.inputDevices.add(inputDevice);
    if (changed && notifyAudioDeviceCallbacks) {
      notifyAudioDeviceCallbacks(ImmutableList.of(inputDevice), /* added= */ true);
    }
  }

  /**
   * Removes an input {@link AudioDeviceInfo} and notifies the list of {@link AudioDeviceCallback}
   * if the device was present before and indicated by {@code notifyAudioDeviceCallbacks}.
   */
  public void removeInputDevice(AudioDeviceInfo inputDevice, boolean notifyAudioDeviceCallbacks) {
    boolean changed = this.inputDevices.remove(inputDevice);
    if (changed && notifyAudioDeviceCallbacks) {
      notifyAudioDeviceCallbacks(ImmutableList.of(inputDevice), /* added= */ false);
    }
  }

  /**
   * Adds an output {@link AudioDeviceInfo} and notifies the list of {@link AudioDeviceCallback} if
   * the device was not present before and indicated by {@code notifyAudioDeviceCallbacks}.
   */
  public void addOutputDevice(AudioDeviceInfo outputDevice, boolean notifyAudioDeviceCallbacks) {
    boolean changed =
        !this.outputDevices.contains(outputDevice) && this.outputDevices.add(outputDevice);
    if (changed && notifyAudioDeviceCallbacks) {
      notifyAudioDeviceCallbacks(ImmutableList.of(outputDevice), /* added= */ true);
    }
  }

  /**
   * Removes an output {@link AudioDeviceInfo} and notifies the list of {@link AudioDeviceCallback}
   * if the device was present before and indicated by {@code notifyAudioDeviceCallbacks}.
   */
  public void removeOutputDevice(AudioDeviceInfo outputDevice, boolean notifyAudioDeviceCallbacks) {
    boolean changed = this.outputDevices.remove(outputDevice);
    if (changed && notifyAudioDeviceCallbacks) {
      notifyAudioDeviceCallbacks(ImmutableList.of(outputDevice), /* added= */ false);
    }
  }

  /**
   * Adds an available communication {@link AudioDeviceInfo} and notifies the list of {@link
   * AudioDeviceCallback} if the device was not present before and indicated by {@code
   * notifyAudioDeviceCallbacks}.
   */
  @TargetApi(VERSION_CODES.S)
  public void addAvailableCommunicationDevice(
      AudioDeviceInfo communicationDevice, boolean notifyAudioDeviceCallbacks) {
    boolean changed =
        !this.availableCommunicationDevices.contains(communicationDevice)
            && this.availableCommunicationDevices.add(communicationDevice);
    if (changed && notifyAudioDeviceCallbacks) {
      notifyAudioDeviceCallbacks(ImmutableList.of(communicationDevice), /* added= */ true);
    }
  }

  /**
   * Removes an available communication {@link AudioDeviceInfo} and notifies the list of {@link
   * AudioDeviceCallback} if the device was present before and indicated by {@code
   * notifyAudioDeviceCallbacks}.
   */
  @TargetApi(VERSION_CODES.S)
  public void removeAvailableCommunicationDevice(
      AudioDeviceInfo communicationDevice, boolean notifyAudioDeviceCallbacks) {
    boolean changed = this.availableCommunicationDevices.remove(communicationDevice);
    if (changed && notifyAudioDeviceCallbacks) {
      notifyAudioDeviceCallbacks(ImmutableList.of(communicationDevice), /* added= */ false);
    }
  }

  /**
   * Registers an {@link AudioDeviceCallback} object to receive notifications of changes to the set
   * of connected audio devices.
   *
   * <p>The {@code handler} is ignored.
   *
   * @see #addInputDevice(AudioDeviceInfo, boolean)
   * @see #addOutputDevice(AudioDeviceInfo, boolean)
   * @see #addAvailableCommunicationDevice(AudioDeviceInfo, boolean)
   * @see #removeInputDevice(AudioDeviceInfo, boolean)
   * @see #removeOutputDevice(AudioDeviceInfo, boolean)
   * @see #removeAvailableCommunicationDevice(AudioDeviceInfo, boolean)
   * @see #addOutputDeviceWithDirectProfiles(AudioDeviceInfo)
   * @see #removeOutputDeviceWithDirectProfiles(AudioDeviceInfo)
   */
  @Implementation(minSdk = M)
  protected void registerAudioDeviceCallback(AudioDeviceCallback callback, Handler handler) {
    audioDeviceCallbacks.add(callback);
    // indicate currently available devices as added, similarly to MSG_DEVICES_CALLBACK_REGISTERED
    callback.onAudioDevicesAdded(getDevices(AudioManager.GET_DEVICES_ALL));
  }

  /**
   * Unregisters an {@link AudioDeviceCallback} object which has been previously registered to
   * receive notifications of changes to the set of connected audio devices.
   *
   * @see #addInputDevice(AudioDeviceInfo, boolean)
   * @see #addOutputDevice(AudioDeviceInfo, boolean)
   * @see #addAvailableCommunicationDevice(AudioDeviceInfo, boolean)
   * @see #removeInputDevice(AudioDeviceInfo, boolean)
   * @see #removeOutputDevice(AudioDeviceInfo, boolean)
   * @see #removeAvailableCommunicationDevice(AudioDeviceInfo, boolean)
   * @see #addOutputDeviceWithDirectProfiles(AudioDeviceInfo)
   * @see #removeOutputDeviceWithDirectProfiles(AudioDeviceInfo)
   */
  @Implementation(minSdk = M)
  protected void unregisterAudioDeviceCallback(AudioDeviceCallback callback) {
    audioDeviceCallbacks.remove(callback);
  }

  private void notifyAudioDeviceCallbacks(List<AudioDeviceInfo> devices, boolean added) {
    AudioDeviceInfo[] devicesArray = devices.toArray(new AudioDeviceInfo[0]);
    for (AudioDeviceCallback callback : audioDeviceCallbacks) {
      if (added) {
        callback.onAudioDevicesAdded(devicesArray);
      } else {
        callback.onAudioDevicesRemoved(devicesArray);
      }
    }
  }

  private List<AudioDeviceInfo> getInputDevices() {
    return inputDevices;
  }

  private List<AudioDeviceInfo> getOutputDevices() {
    return outputDevices;
  }

  /** Note that this method can silently fail. See {@link lockCommunicationDevice}. */
  @Implementation(minSdk = S)
  protected boolean setCommunicationDevice(AudioDeviceInfo communicationDevice) {
    if (!lockCommunicationDevice) {
      this.communicationDevice = communicationDevice;
    }
    return !lockCommunicationDevice;
  }

  /** Sets whether subsequent calls to {@link setCommunicationDevice} will succeed. */
  public void lockCommunicationDevice(boolean lockCommunicationDevice) {
    this.lockCommunicationDevice = lockCommunicationDevice;
  }

  @Implementation(minSdk = S)
  protected AudioDeviceInfo getCommunicationDevice() {
    return communicationDevice;
  }

  @Implementation(minSdk = S)
  protected void clearCommunicationDevice() {
    this.communicationDevice = null;
  }

  @Implementation(minSdk = S)
  protected List<AudioDeviceInfo> getAvailableCommunicationDevices() {
    return availableCommunicationDevices;
  }

  @Implementation(minSdk = UPSIDE_DOWN_CAKE)
  protected boolean isHotwordStreamSupported(boolean lookbackAudio) {
    if (lookbackAudio) {
      return isHotwordStreamSupportedForLookbackAudio;
    }
    return isHotwordStreamSupportedWithoutLookbackAudio;
  }

  public void setHotwordStreamSupported(boolean lookbackAudio, boolean isSupported) {
    if (lookbackAudio) {
      isHotwordStreamSupportedForLookbackAudio = isSupported;
    } else {
      isHotwordStreamSupportedWithoutLookbackAudio = isSupported;
    }
  }

  @Implementation(minSdk = M)
  public AudioDeviceInfo[] getDevices(int flags) {
    List<AudioDeviceInfo> result = new ArrayList<>();
    if ((flags & AudioManager.GET_DEVICES_INPUTS) == AudioManager.GET_DEVICES_INPUTS) {
      result.addAll(getInputDevices());
    }
    if ((flags & AudioManager.GET_DEVICES_OUTPUTS) == AudioManager.GET_DEVICES_OUTPUTS) {
      result.addAll(getOutputDevices());
    }
    return result.toArray(new AudioDeviceInfo[0]);
  }

  /**
   * Sets active playback configurations that will be served by {@link
   * AudioManager#getActivePlaybackConfigurations}.
   *
   * <p>Note that there is no public {@link AudioPlaybackConfiguration} constructor, so the
   * configurations returned are specified by their audio attributes only.
   */
  @TargetApi(VERSION_CODES.O)
  public void setActivePlaybackConfigurationsFor(List<AudioAttributes> audioAttributes) {
    setActivePlaybackConfigurationsFor(audioAttributes, /* notifyCallbackListeners= */ false);
  }

  /**
   * Same as {@link #setActivePlaybackConfigurationsFor(List)}, but also notifies callbacks if
   * notifyCallbackListeners is true.
   */
  @TargetApi(VERSION_CODES.O)
  public void setActivePlaybackConfigurationsFor(
      List<AudioAttributes> audioAttributes, boolean notifyCallbackListeners) {
    if (RuntimeEnvironment.getApiLevel() < O) {
      throw new UnsupportedOperationException(
          "setActivePlaybackConfigurationsFor is not supported on API "
              + RuntimeEnvironment.getApiLevel());
    }
    activePlaybackConfigurations = new ArrayList<>(audioAttributes.size());
    for (AudioAttributes audioAttribute : audioAttributes) {
      AudioPlaybackConfiguration configuration = createAudioPlaybackConfiguration(audioAttribute);
      activePlaybackConfigurations.add(configuration);
    }
    if (notifyCallbackListeners) {
      for (AudioManager.AudioPlaybackCallback callback : audioPlaybackCallbacks) {
        callback.onPlaybackConfigChanged(activePlaybackConfigurations);
      }
    }
  }

  protected AudioPlaybackConfiguration createAudioPlaybackConfiguration(
      AudioAttributes audioAttributes) {
    // use reflection to call package private APIs
    if (RuntimeEnvironment.getApiLevel() >= S) {
      PlayerBase.PlayerIdCard playerIdCard =
          ReflectionHelpers.callConstructor(
              PlayerBase.PlayerIdCard.class,
              ReflectionHelpers.ClassParameter.from(int.class, 0), /* type */
              ReflectionHelpers.ClassParameter.from(AudioAttributes.class, audioAttributes),
              ReflectionHelpers.ClassParameter.from(IPlayer.class, null),
              ReflectionHelpers.ClassParameter.from(int.class, 0) /* sessionId */);
      AudioPlaybackConfiguration config =
          ReflectionHelpers.callConstructor(
              AudioPlaybackConfiguration.class,
              ReflectionHelpers.ClassParameter.from(PlayerBase.PlayerIdCard.class, playerIdCard),
              ReflectionHelpers.ClassParameter.from(int.class, 0), /* piid */
              ReflectionHelpers.ClassParameter.from(int.class, 0), /* uid */
              ReflectionHelpers.ClassParameter.from(int.class, 0) /* pid */);
      ReflectionHelpers.setField(
          config, "mPlayerState", AudioPlaybackConfiguration.PLAYER_STATE_STARTED);
      return config;
    } else {
      PlayerBase.PlayerIdCard playerIdCard =
          ReflectionHelpers.callConstructor(
              PlayerBase.PlayerIdCard.class,
              from(int.class, 0), /* type */
              from(AudioAttributes.class, audioAttributes),
              from(IPlayer.class, null));
      AudioPlaybackConfiguration config =
          ReflectionHelpers.callConstructor(
              AudioPlaybackConfiguration.class,
              from(PlayerBase.PlayerIdCard.class, playerIdCard),
              from(int.class, 0), /* piid */
              from(int.class, 0), /* uid */
              from(int.class, 0) /* pid */);
      ReflectionHelpers.setField(
          config, "mPlayerState", AudioPlaybackConfiguration.PLAYER_STATE_STARTED);
      return config;
    }
  }

  public void setIsMusicActive(boolean isMusicActive) {
    this.isMusicActive = isMusicActive;
  }

  public AudioFocusRequest getLastAudioFocusRequest() {
    return lastAudioFocusRequest;
  }

  public void setNextFocusRequestResponse(int nextResponseValue) {
    this.nextResponseValue = nextResponseValue;
  }

  public AudioManager.OnAudioFocusChangeListener getLastAbandonedAudioFocusListener() {
    return lastAbandonedAudioFocusListener;
  }

  public android.media.AudioFocusRequest getLastAbandonedAudioFocusRequest() {
    return lastAbandonedAudioFocusRequest;
  }

  /**
   * Returns list of active recording configurations that was set by {@link
   * #setActiveRecordingConfigurations} or empty list otherwise.
   */
  @Implementation(minSdk = N)
  protected List<AudioRecordingConfiguration> getActiveRecordingConfigurations() {
    return activeRecordingConfigurations;
  }

  /**
   * Registers callback that will receive changes made to the list of active recording
   * configurations by {@link setActiveRecordingConfigurations}.
   */
  @Implementation(minSdk = N)
  protected void registerAudioRecordingCallback(
      AudioManager.AudioRecordingCallback cb, Handler handler) {
    audioRecordingCallbacks.add(cb);
  }

  /** Unregisters callback listening to changes made to list of active recording configurations. */
  @Implementation(minSdk = N)
  protected void unregisterAudioRecordingCallback(AudioManager.AudioRecordingCallback cb) {
    audioRecordingCallbacks.remove(cb);
  }

  /**
   * Sets active recording configurations that will be served by {@link
   * AudioManager#getActiveRecordingConfigurations} and notifies callback listeners about that
   * change.
   */
  public void setActiveRecordingConfigurations(
      List<AudioRecordingConfiguration> activeRecordingConfigurations,
      boolean notifyCallbackListeners) {
    this.activeRecordingConfigurations = new ArrayList<>(activeRecordingConfigurations);

    if (notifyCallbackListeners) {
      for (AudioManager.AudioRecordingCallback callback : audioRecordingCallbacks) {
        callback.onRecordingConfigChanged(this.activeRecordingConfigurations);
      }
    }
  }

  /**
   * Creates simple active recording configuration. The resulting configuration will return {@code
   * null} for {@link android.media.AudioRecordingConfiguration#getAudioDevice}.
   */
  public AudioRecordingConfiguration createActiveRecordingConfiguration(
      int sessionId, int audioSource, String clientPackageName) {
    Parcel p = Parcel.obtain();
    p.writeInt(sessionId); // mSessionId
    p.writeInt(audioSource); // mClientSource
    writeMono16BitAudioFormatToParcel(p); // mClientFormat
    writeMono16BitAudioFormatToParcel(p); // mDeviceFormat
    p.writeInt(INVALID_PATCH_HANDLE); // mPatchHandle
    p.writeString(clientPackageName); // mClientPackageName
    p.writeInt(0); // mClientUid

    p.setDataPosition(0);

    AudioRecordingConfiguration configuration =
        AudioRecordingConfiguration.CREATOR.createFromParcel(p);
    p.recycle();

    return configuration;
  }

  /**
   * Registers an {@link AudioPolicy} to allow that policy to control audio routing and audio focus.
   *
   * <p>Note: this implementation does NOT ensure that we have the permissions necessary to register
   * the given {@link AudioPolicy}.
   *
   * @return {@link AudioManager.ERROR} if the given policy has already been registered, and {@link
   *     AudioManager.SUCCESS} otherwise.
   */
  @HiddenApi
  @Implementation(minSdk = P)
  @RequiresPermission(android.Manifest.permission.MODIFY_AUDIO_ROUTING)
  protected int registerAudioPolicy(
      @Nonnull @ClassName("android.media.audiopolicy.AudioPolicy") Object audioPolicy) {
    Preconditions.checkNotNull(audioPolicy, "Illegal null AudioPolicy argument");
    AudioPolicy policy = (AudioPolicy) audioPolicy;
    String id = getIdForAudioPolicy(audioPolicy);
    if (registeredAudioPolicies.containsKey(id)) {
      return AudioManager.ERROR;
    }
    registeredAudioPolicies.put(id, policy);
    policy.setRegistration(id);
    return AudioManager.SUCCESS;
  }

  @HiddenApi
  @Implementation(minSdk = Q)
  protected void unregisterAudioPolicy(
      @Nonnull @ClassName("android.media.audiopolicy.AudioPolicy") Object audioPolicy) {
    Preconditions.checkNotNull(audioPolicy, "Illegal null AudioPolicy argument");
    AudioPolicy policy = (AudioPolicy) audioPolicy;
    registeredAudioPolicies.remove(getIdForAudioPolicy(policy));
    policy.setRegistration(null);
  }

  /**
   * Returns true if at least one audio policy is registered with this manager, and false otherwise.
   */
  public boolean isAnyAudioPolicyRegistered() {
    return !registeredAudioPolicies.isEmpty();
  }

  /**
   * Returns the list of profiles supported for direct playback.
   *
   * <p>In this shadow-implementation the list returned are profiles set through {@link
   * #addOutputDeviceWithDirectProfiles(AudioDeviceInfo)}, {@link
   * #removeOutputDeviceWithDirectProfiles(AudioDeviceInfo)}.
   */
  @Implementation(minSdk = TIRAMISU)
  @Nonnull
  protected List<AudioProfile> getDirectProfilesForAttributes(@Nonnull AudioAttributes attributes) {
    ImmutableSet.Builder<AudioProfile> audioProfiles = new ImmutableSet.Builder<>();
    for (int i = 0; i < outputDevicesWithDirectProfiles.size(); i++) {
      audioProfiles.addAll(outputDevicesWithDirectProfiles.get(i).getAudioProfiles());
    }
    return new ArrayList<>(audioProfiles.build());
  }

  /**
   * Adds an output {@link AudioDeviceInfo device} with direct profiles and notifies the list of
   * {@link AudioDeviceCallback} if the device was not present before.
   */
  public void addOutputDeviceWithDirectProfiles(AudioDeviceInfo outputDevice) {
    boolean changed =
        !this.outputDevicesWithDirectProfiles.contains(outputDevice)
            && this.outputDevicesWithDirectProfiles.add(outputDevice);
    if (changed) {
      notifyAudioDeviceCallbacks(ImmutableList.of(outputDevice), /* added= */ true);
    }
  }

  /**
   * Removes an output {@link AudioDeviceInfo device} with direct profiles and notifies the list of
   * {@link AudioDeviceCallback} if the device was present before.
   */
  public void removeOutputDeviceWithDirectProfiles(AudioDeviceInfo outputDevice) {
    boolean changed = this.outputDevicesWithDirectProfiles.remove(outputDevice);
    if (changed) {
      notifyAudioDeviceCallbacks(ImmutableList.of(outputDevice), /* added= */ false);
    }
  }

  /**
   * Provides a mock like interface for the {@link AudioManager#generateAudioSessionId} method by
   * returning positive distinct values, or {@link AudioManager#ERROR} if all possible values have
   * already been returned.
   */
  @Implementation
  protected int generateAudioSessionId() {
    if (audioSessionIdCounter < 0) {
      return AudioManager.ERROR;
    }

    return audioSessionIdCounter++;
  }

  private static String getIdForAudioPolicy(@Nonnull Object audioPolicy) {
    return Integer.toString(System.identityHashCode(audioPolicy));
  }

  private static void writeMono16BitAudioFormatToParcel(Parcel p) {
    p.writeInt(
        AudioFormat.AUDIO_FORMAT_HAS_PROPERTY_ENCODING
            + AudioFormat.AUDIO_FORMAT_HAS_PROPERTY_SAMPLE_RATE
            + AudioFormat.AUDIO_FORMAT_HAS_PROPERTY_CHANNEL_MASK); // mPropertySetMask
    p.writeInt(AudioFormat.ENCODING_PCM_16BIT); // mEncoding
    p.writeInt(16000); // mSampleRate
    p.writeInt(AudioFormat.CHANNEL_OUT_MONO); // mChannelMask
    p.writeInt(0); // mChannelIndexMask
  }

  /**
   * Sends a simulated key event for a media button.
   *
   * <p>Instead of sending the media event to the media system service, from where it would be
   * routed to a media app, this shadow method only records the events to be verified through {@link
   * #getDispatchedMediaKeyEvents()}.
   */
  @Implementation
  protected void dispatchMediaKeyEvent(KeyEvent keyEvent) {
    if (keyEvent == null) {
      throw new NullPointerException("keyEvent is null");
    }
    dispatchedMediaKeyEvents.add(keyEvent);
  }

  public List<KeyEvent> getDispatchedMediaKeyEvents() {
    return new ArrayList<>(dispatchedMediaKeyEvents);
  }

  public void clearDispatchedMediaKeyEvents() {
    dispatchedMediaKeyEvents.clear();
  }

  public static class AudioFocusRequest {
    public final AudioManager.OnAudioFocusChangeListener listener;
    public final int streamType;
    public final int durationHint;
    public final android.media.AudioFocusRequest audioFocusRequest;

    private AudioFocusRequest(
        AudioManager.OnAudioFocusChangeListener listener, int streamType, int durationHint) {
      this.listener = listener;
      this.streamType = streamType;
      this.durationHint = durationHint;
      this.audioFocusRequest = null;
    }

    private AudioFocusRequest(android.media.AudioFocusRequest audioFocusRequest) {
      this.listener = audioFocusRequest.getOnAudioFocusChangeListener();
      this.durationHint = audioFocusRequest.getFocusGain();
      this.streamType = audioFocusRequest.getAudioAttributes().getVolumeControlStream();
      this.audioFocusRequest = audioFocusRequest;
    }
  }

  private static class AudioStream {
    private int currentVolume;
    private int maxVolume;
    private int flag;

    public AudioStream(int currVol, int maxVol, int flag) {
      if (MIN_VOLUME > maxVol) {
        throw new IllegalArgumentException("Min volume is higher than max volume.");
      }
      setCurrentVolume(currVol);
      setMaxVolume(maxVol);
      setFlag(flag);
    }

    public int getCurrentVolume() {
      return currentVolume;
    }

    public int getMaxVolume() {
      return maxVolume;
    }

    public int getFlag() {
      return flag;
    }

    public void setCurrentVolume(int vol) {
      if (vol > maxVolume) {
        vol = maxVolume;
      } else if (vol < MIN_VOLUME) {
        vol = MIN_VOLUME;
      }
      currentVolume = vol;
    }

    public void setMaxVolume(int vol) {
      maxVolume = vol;
    }

    public void setFlag(int flag) {
      this.flag = flag;
    }
  }
}