/* * Copyright (C) 2016 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 android.hardware.display; import android.annotation.TestApi; import android.content.Context; import android.os.Build; import android.os.SystemProperties; import android.provider.Settings; import android.text.TextUtils; import android.util.ArrayMap; import android.util.SparseArray; import com.android.internal.R; import com.android.internal.util.ArrayUtils; import java.util.Map; /** * AmbientDisplayConfiguration encapsulates reading access to the configuration of ambient display. * * @hide */ @TestApi public class AmbientDisplayConfiguration { private static final String TAG = "AmbientDisplayConfig"; private final Context mContext; private final boolean mAlwaysOnByDefault; private final boolean mPickupGestureEnabledByDefault; /** Copied from android.provider.Settings.Secure since these keys are hidden. */ private static final String[] DOZE_SETTINGS = { Settings.Secure.DOZE_ENABLED, Settings.Secure.DOZE_ALWAYS_ON, Settings.Secure.DOZE_PICK_UP_GESTURE, Settings.Secure.DOZE_PULSE_ON_LONG_PRESS, Settings.Secure.DOZE_DOUBLE_TAP_GESTURE, Settings.Secure.DOZE_WAKE_LOCK_SCREEN_GESTURE, Settings.Secure.DOZE_WAKE_DISPLAY_GESTURE, Settings.Secure.DOZE_TAP_SCREEN_GESTURE }; /** Non-user configurable doze settings */ private static final String[] NON_USER_CONFIGURABLE_DOZE_SETTINGS = { Settings.Secure.DOZE_QUICK_PICKUP_GESTURE }; final SparseArray> mUsersInitialValues = new SparseArray<>(); /** @hide */ @TestApi public AmbientDisplayConfiguration(Context context) { mContext = context; mAlwaysOnByDefault = mContext.getResources().getBoolean(R.bool.config_dozeAlwaysOnEnabled); mPickupGestureEnabledByDefault = mContext.getResources().getBoolean(R.bool.config_dozePickupGestureEnabled); } /** @hide */ public boolean enabled(int user) { return pulseOnNotificationEnabled(user) || pulseOnLongPressEnabled(user) || alwaysOnEnabled(user) || wakeLockScreenGestureEnabled(user) || wakeDisplayGestureEnabled(user) || pickupGestureEnabled(user) || tapGestureEnabled(user) || doubleTapGestureEnabled(user) || quickPickupSensorEnabled(user) || screenOffUdfpsEnabled(user); } /** @hide */ public boolean pulseOnNotificationEnabled(int user) { return boolSettingDefaultOn(Settings.Secure.DOZE_ENABLED, user) && pulseOnNotificationAvailable(); } /** @hide */ public boolean pulseOnNotificationAvailable() { return mContext.getResources().getBoolean(R.bool.config_pulseOnNotificationsAvailable) && ambientDisplayAvailable(); } /** @hide */ public boolean pickupGestureEnabled(int user) { return boolSetting(Settings.Secure.DOZE_PICK_UP_GESTURE, user, mPickupGestureEnabledByDefault ? 1 : 0) && dozePickupSensorAvailable(); } /** @hide */ public boolean dozePickupSensorAvailable() { return mContext.getResources().getBoolean(R.bool.config_dozePulsePickup); } /** @hide */ public boolean tapGestureEnabled(int user) { return boolSettingDefaultOn(Settings.Secure.DOZE_TAP_SCREEN_GESTURE, user) && tapSensorAvailable(); } /** @hide */ public boolean tapSensorAvailable() { for (String tapType : tapSensorTypeMapping()) { if (!TextUtils.isEmpty(tapType)) { return true; } } return false; } /** @hide */ public boolean doubleTapGestureEnabled(int user) { return boolSettingDefaultOn(Settings.Secure.DOZE_DOUBLE_TAP_GESTURE, user) && doubleTapSensorAvailable(); } /** @hide */ public boolean doubleTapSensorAvailable() { return !TextUtils.isEmpty(doubleTapSensorType()); } /** @hide */ public boolean quickPickupSensorEnabled(int user) { return boolSettingDefaultOn(Settings.Secure.DOZE_QUICK_PICKUP_GESTURE, user) && !TextUtils.isEmpty(quickPickupSensorType()) && pickupGestureEnabled(user) && !alwaysOnEnabled(user); } /** @hide */ public boolean screenOffUdfpsEnabled(int user) { return !TextUtils.isEmpty(udfpsLongPressSensorType()) && boolSettingDefaultOff("screen_off_udfps_enabled", user); } /** @hide */ public boolean wakeScreenGestureAvailable() { return mContext.getResources() .getBoolean(R.bool.config_dozeWakeLockScreenSensorAvailable); } /** @hide */ public boolean wakeLockScreenGestureEnabled(int user) { return boolSettingDefaultOn(Settings.Secure.DOZE_WAKE_LOCK_SCREEN_GESTURE, user) && wakeScreenGestureAvailable(); } /** @hide */ public boolean wakeDisplayGestureEnabled(int user) { return boolSettingDefaultOn(Settings.Secure.DOZE_WAKE_DISPLAY_GESTURE, user) && wakeScreenGestureAvailable(); } /** @hide */ public long getWakeLockScreenDebounce() { return mContext.getResources().getInteger(R.integer.config_dozeWakeLockScreenDebounce); } /** @hide */ public String doubleTapSensorType() { return mContext.getResources().getString(R.string.config_dozeDoubleTapSensorType); } /** @hide * May support multiple postures. */ public String[] tapSensorTypeMapping() { String[] postureMapping = mContext.getResources().getStringArray(R.array.config_dozeTapSensorPostureMapping); if (ArrayUtils.isEmpty(postureMapping)) { return new String[] { mContext.getResources().getString(R.string.config_dozeTapSensorType) }; } return postureMapping; } /** @hide */ public String longPressSensorType() { return mContext.getResources().getString(R.string.config_dozeLongPressSensorType); } /** @hide */ public String udfpsLongPressSensorType() { return mContext.getResources().getString(R.string.config_dozeUdfpsLongPressSensorType); } /** @hide */ public String quickPickupSensorType() { return mContext.getResources().getString(R.string.config_quickPickupSensorType); } /** @hide */ public boolean pulseOnLongPressEnabled(int user) { return pulseOnLongPressAvailable() && boolSettingDefaultOff( Settings.Secure.DOZE_PULSE_ON_LONG_PRESS, user); } private boolean pulseOnLongPressAvailable() { return !TextUtils.isEmpty(longPressSensorType()); } /** * Returns if Always-on-Display functionality is enabled on the display for a specified user. * * @hide */ @TestApi public boolean alwaysOnEnabled(int user) { return boolSetting(Settings.Secure.DOZE_ALWAYS_ON, user, mAlwaysOnByDefault ? 1 : 0) && alwaysOnAvailable() && !accessibilityInversionEnabled(user); } /** * Returns if Always-on-Display functionality is available on the display. * * @hide */ @TestApi public boolean alwaysOnAvailable() { return (alwaysOnDisplayDebuggingEnabled() || alwaysOnDisplayAvailable()) && ambientDisplayAvailable(); } /** * Returns if Always-on-Display functionality is available on the display for a specified user. * * @hide */ @TestApi public boolean alwaysOnAvailableForUser(int user) { return alwaysOnAvailable() && !accessibilityInversionEnabled(user); } /** @hide */ public String ambientDisplayComponent() { return mContext.getResources().getString(R.string.config_dozeComponent); } /** @hide */ public boolean accessibilityInversionEnabled(int user) { return boolSettingDefaultOff(Settings.Secure.ACCESSIBILITY_DISPLAY_INVERSION_ENABLED, user); } /** @hide */ public boolean ambientDisplayAvailable() { return !TextUtils.isEmpty(ambientDisplayComponent()); } /** @hide */ public boolean dozeSuppressed(int user) { return boolSettingDefaultOff(Settings.Secure.SUPPRESS_DOZE, user); } private boolean alwaysOnDisplayAvailable() { return mContext.getResources().getBoolean(R.bool.config_dozeAlwaysOnDisplayAvailable); } private boolean alwaysOnDisplayDebuggingEnabled() { return SystemProperties.getBoolean("debug.doze.aod", false) && Build.IS_DEBUGGABLE; } private boolean boolSettingDefaultOn(String name, int user) { return boolSetting(name, user, 1); } private boolean boolSettingDefaultOff(String name, int user) { return boolSetting(name, user, 0); } private boolean boolSetting(String name, int user, int def) { return Settings.Secure.getIntForUser(mContext.getContentResolver(), name, def, user) != 0; } /** @hide */ @TestApi public void disableDozeSettings(int userId) { disableDozeSettings(false /* shouldDisableNonUserConfigurable */, userId); } /** @hide */ @TestApi public void disableDozeSettings(boolean shouldDisableNonUserConfigurable, int userId) { Map initialValues = mUsersInitialValues.get(userId); if (initialValues != null && !initialValues.isEmpty()) { throw new IllegalStateException("Don't call #disableDozeSettings more than once," + "without first calling #restoreDozeSettings"); } initialValues = new ArrayMap<>(); for (String name : DOZE_SETTINGS) { initialValues.put(name, getDozeSetting(name, userId)); putDozeSetting(name, "0", userId); } if (shouldDisableNonUserConfigurable) { for (String name : NON_USER_CONFIGURABLE_DOZE_SETTINGS) { initialValues.put(name, getDozeSetting(name, userId)); putDozeSetting(name, "0", userId); } } mUsersInitialValues.put(userId, initialValues); } /** @hide */ @TestApi public void restoreDozeSettings(int userId) { final Map initialValues = mUsersInitialValues.get(userId); if (initialValues != null && !initialValues.isEmpty()) { for (String name : DOZE_SETTINGS) { putDozeSetting(name, initialValues.get(name), userId); } mUsersInitialValues.remove(userId); } } private String getDozeSetting(String name, int userId) { return Settings.Secure.getStringForUser(mContext.getContentResolver(), name, userId); } private void putDozeSetting(String name, String value, int userId) { Settings.Secure.putStringForUser(mContext.getContentResolver(), name, value, userId); } }