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

Commit 616b0925 authored by Alan Huang's avatar Alan Huang Committed by Jenhou (Alan) Huang
Browse files

DO NOT MERGE Add setting page for the Spatial audio

The Spatial audio settings page control the state for the phone speaker
and the wired headphones

Test: make RunSettingsRoboTests

Bug: 220811398
Change-Id: I49e3fab48186d09357a8481652bdccb4aa5d044a
parent 798a0fab
Loading
Loading
Loading
Loading
+18 −0
Original line number Diff line number Diff line
@@ -8561,6 +8561,24 @@
    <!-- Setting summary for controlling how caption text display in real time [CHAR LIMIT=NONE]-->
    <string name="live_caption_summary">Automatically caption media</string>
    <!-- Output device type for the phone speaker that is available for spatializer effect. [CHAR LIMIT=NONE]-->
    <string name="spatial_audio_speaker">Phone speaker</string>
    <!-- Output device type for the wired headphones that is available for spatializer effect. [CHAR LIMIT=NONE]-->
    <string name="spatial_audio_wired_headphones">Wired headphones</string>
    <!-- Sound: Summary for the spatializer effect. [CHAR LIMIT=NONE]-->
    <string name="spatial_audio_text">Spatial Audio creates immersive sound that seems like it’s coming from all around you. Only works with some media.</string>
    <!-- Sound: Summary for the Spatial audio setting when it is off. [CHAR LIMIT=NONE]-->
    <string name="spatial_summary_off">Off</string>
    <!-- Sound: Summary for the Spatial audio setting when it is on with one output device enabled. [CHAR LIMIT=NONE]-->
    <string name="spatial_summary_on_one">On / <xliff:g id="output device" example="Phone speaker">%1$s</xliff:g></string>
    <!-- Sound: Summary for the Spatial audio setting when it is on with two output devices enabled. [CHAR LIMIT=NONE]-->
    <string name="spatial_summary_on_two">On / <xliff:g id="output device" example="Phone speaker">%1$s</xliff:g> and <xliff:g id="output device" example="Wired headphones">%2$s</xliff:g></string>
    <!-- Sound: Summary for the Do not Disturb option that describes how many automatic rules (schedules) are enabled [CHAR LIMIT=NONE]-->
    <string name="zen_mode_settings_schedules_summary">
        {count, plural,
+9 −7
Original line number Diff line number Diff line
@@ -111,6 +111,15 @@
        settings:keywords="@string/sound_settings"/>

    <!-- Live Caption -110 and Now Playing -105-->

    <!-- Spatial audio -->
    <Preference
        android:key="spatial_audio_summary"
        android:title="@string/spatial_audio_title"
        android:fragment="com.android.settings.notification.SpatialAudioSettings"
        android:order="-107"
        settings:controller="com.android.settings.notification.SpatialAudioParentPreferenceController"/>

    <Preference
        android:key="media_controls_summary"
        android:title="@string/media_controls_title"
@@ -154,13 +163,6 @@
        android:ringtoneType="alarm"
        android:order="-60"/>

    <!-- Spatial audio -->
    <SwitchPreference
        android:key="spatial_audio"
        android:title="@string/spatial_audio_title"
        android:order="-55"
        settings:controller="com.android.settings.notification.SpatialAudioPreferenceController"/>

    <!-- Dial pad tones -->
    <SwitchPreference
        android:key="dial_pad_tones"
+37 −0
Original line number Diff line number Diff line
<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (C) 2022 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.
-->

<PreferenceScreen
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:settings="http://schemas.android.com/apk/res-auto"
    android:title="@string/spatial_audio_title">

    <com.android.settingslib.widget.TopIntroPreference
        android:key="spatial_audio_top_intro"
        android:title="@string/spatial_audio_text"
        settings:searchable="false"/>

    <SwitchPreference
        android:key="spatial_audio"
        android:title="@string/spatial_audio_speaker"
        settings:controller="com.android.settings.notification.SpatialAudioPreferenceController"/>

    <SwitchPreference
        android:key="spatial_audio_wired_headphones"
        android:title="@string/spatial_audio_wired_headphones"
        settings:controller="com.android.settings.notification.SpatialAudioWiredHeadphonesController"/>

</PreferenceScreen>
+77 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2022 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.notification;

import android.content.Context;
import android.media.AudioManager;
import android.media.Spatializer;
import android.util.Log;

import com.android.settings.R;
import com.android.settings.core.BasePreferenceController;

/**
 * Parent menu summary of the Spatial audio settings
 */
public class SpatialAudioParentPreferenceController extends BasePreferenceController {
    private static final String TAG = "SpatialAudioSetting";
    private static final boolean DEBUG = Log.isLoggable(TAG, Log.DEBUG);

    private final Spatializer mSpatializer;
    private SpatialAudioPreferenceController mSpatialAudioPreferenceController;
    private SpatialAudioWiredHeadphonesController mSpatialAudioWiredHeadphonesController;

    public SpatialAudioParentPreferenceController(Context context, String key) {
        super(context, key);
        AudioManager audioManager = context.getSystemService(AudioManager.class);
        mSpatializer = audioManager.getSpatializer();
        mSpatialAudioPreferenceController = new SpatialAudioPreferenceController(context, "unused");
        mSpatialAudioWiredHeadphonesController = new SpatialAudioWiredHeadphonesController(context,
                "unused");
    }

    @Override
    public int getAvailabilityStatus() {
        int level = mSpatializer.getImmersiveAudioLevel();
        if (DEBUG) {
            Log.d(TAG, "spatialization level: " + level);
        }
        return level == Spatializer.SPATIALIZER_IMMERSIVE_LEVEL_NONE
                ? UNSUPPORTED_ON_DEVICE : AVAILABLE;
    }

    @Override
    public CharSequence getSummary() {
        boolean speakerOn = mSpatialAudioPreferenceController.isAvailable()
                && mSpatialAudioWiredHeadphonesController.isChecked();
        boolean wiredHeadphonesOn = mSpatialAudioWiredHeadphonesController.isAvailable()
                && mSpatialAudioWiredHeadphonesController.isChecked();
        if (speakerOn && wiredHeadphonesOn) {
            return mContext.getString(R.string.spatial_summary_on_two,
                    mContext.getString(R.string.spatial_audio_speaker),
                    mContext.getString(R.string.spatial_audio_wired_headphones));
        } else if (speakerOn) {
            return mContext.getString(R.string.spatial_summary_on_one,
                    mContext.getString(R.string.spatial_audio_speaker));
        } else if (wiredHeadphonesOn) {
            return mContext.getString(R.string.spatial_summary_on_one,
                    mContext.getString(R.string.spatial_audio_wired_headphones));
        } else {
            return mContext.getString(R.string.spatial_summary_off);
        }
    }
}
+19 −10
Original line number Diff line number Diff line
@@ -17,46 +17,55 @@
package com.android.settings.notification;

import android.content.Context;
import android.media.AudioDeviceAttributes;
import android.media.AudioDeviceInfo;
import android.media.AudioManager;
import android.media.Spatializer;

import androidx.annotation.VisibleForTesting;

import com.android.settings.R;
import com.android.settings.core.TogglePreferenceController;

/**
 * The controller of the Spatial audio setting in the SoundSettings.
 * The controller of the Spatial audio setting for speaker in the SoundSettings.
 */
public class SpatialAudioPreferenceController extends TogglePreferenceController {

    private static final String KEY_SPATIAL_AUDIO = "spatial_audio";

    private final Spatializer mSpatializer;
    @VisibleForTesting
    final AudioDeviceAttributes mSpeaker = new AudioDeviceAttributes(
            AudioDeviceAttributes.ROLE_OUTPUT, AudioDeviceInfo.TYPE_BUILTIN_SPEAKER, ""
    );

    public SpatialAudioPreferenceController(Context context) {
        super(context, KEY_SPATIAL_AUDIO);
    public SpatialAudioPreferenceController(Context context, String preferenceKey) {
        super(context, preferenceKey);
        AudioManager audioManager = context.getSystemService(AudioManager.class);
        mSpatializer = audioManager.getSpatializer();
    }

    @Override
    public int getAvailabilityStatus() {
        return mSpatializer.getImmersiveAudioLevel() == Spatializer.SPATIALIZER_IMMERSIVE_LEVEL_NONE
                ? UNSUPPORTED_ON_DEVICE : AVAILABLE;
        return mSpatializer.isAvailableForDevice(mSpeaker) ? AVAILABLE : UNSUPPORTED_ON_DEVICE;
    }

    @Override
    public boolean isChecked() {
        return mSpatializer.isEnabled();
        return mSpatializer.getCompatibleAudioDevices().contains(mSpeaker);
    }

    @Override
    public boolean setChecked(boolean isChecked) {
        mSpatializer.setEnabled(isChecked);
        if (isChecked) {
            mSpatializer.addCompatibleAudioDevice(mSpeaker);
        } else {
            mSpatializer.removeCompatibleAudioDevice(mSpeaker);
        }
        return isChecked == isChecked();
    }

    @Override
    public int getSliceHighlightMenuRes() {
        return R.string.menu_key_notifications;
        return R.string.menu_key_sound;
    }
}
Loading