/* * Copyright (C) 2021 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.systemui.battery; import static android.provider.Settings.System.SHOW_BATTERY_PERCENT; import static com.android.systemui.DejankUtils.whitelistIpcs; import static java.lang.annotation.RetentionPolicy.SOURCE; import android.animation.LayoutTransition; import android.animation.ObjectAnimator; import android.annotation.IntDef; import android.annotation.IntRange; import android.content.Context; import android.content.res.Configuration; import android.content.res.Resources; import android.content.res.TypedArray; import android.graphics.Rect; import android.graphics.drawable.Drawable; import android.os.UserHandle; import android.provider.Settings; import android.text.TextUtils; import android.util.AttributeSet; import android.util.TypedValue; import android.view.Gravity; import android.view.LayoutInflater; import android.widget.ImageView; import android.widget.LinearLayout; import android.widget.TextView; import androidx.annotation.StyleRes; import androidx.annotation.VisibleForTesting; import com.android.app.animation.Interpolators; import com.android.systemui.DualToneHandler; import com.android.systemui.R; import com.android.systemui.plugins.DarkIconDispatcher; import com.android.systemui.plugins.DarkIconDispatcher.DarkReceiver; import com.android.systemui.statusbar.policy.BatteryController; import java.io.PrintWriter; import java.lang.annotation.Retention; import java.text.NumberFormat; import java.util.ArrayList; public class BatteryMeterView extends LinearLayout implements DarkReceiver { @Retention(SOURCE) @IntDef({MODE_DEFAULT, MODE_ON, MODE_OFF, MODE_ESTIMATE}) public @interface BatteryPercentMode {} public static final int MODE_DEFAULT = 0; public static final int MODE_ON = 1; public static final int MODE_OFF = 2; public static final int MODE_ESTIMATE = 3; private final AccessorizedBatteryDrawable mDrawable; private final ImageView mBatteryIconView; private TextView mBatteryPercentView; private final @StyleRes int mPercentageStyleId; private int mTextColor; private int mLevel; private int mShowPercentMode = MODE_DEFAULT; private boolean mShowPercentAvailable; private String mEstimateText = null; private boolean mPluggedIn; private boolean mIsBatteryDefender; private boolean mIsIncompatibleCharging; private boolean mDisplayShieldEnabled; // Error state where we know nothing about the current battery state private boolean mBatteryStateUnknown; // Lazily-loaded since this is expected to be a rare-if-ever state private Drawable mUnknownStateDrawable; private DualToneHandler mDualToneHandler; private int mNonAdaptedSingleToneColor; private int mNonAdaptedForegroundColor; private int mNonAdaptedBackgroundColor; private BatteryEstimateFetcher mBatteryEstimateFetcher; public BatteryMeterView(Context context, AttributeSet attrs) { this(context, attrs, 0); } public BatteryMeterView(Context context, AttributeSet attrs, int defStyle) { super(context, attrs, defStyle); setOrientation(LinearLayout.HORIZONTAL); setGravity(Gravity.CENTER_VERTICAL | Gravity.START); TypedArray atts = context.obtainStyledAttributes(attrs, R.styleable.BatteryMeterView, defStyle, 0); final int frameColor = atts.getColor(R.styleable.BatteryMeterView_frameColor, context.getColor(R.color.meter_background_color)); mPercentageStyleId = atts.getResourceId(R.styleable.BatteryMeterView_textAppearance, 0); mDrawable = new AccessorizedBatteryDrawable(context, frameColor); atts.recycle(); mShowPercentAvailable = context.getResources().getBoolean( com.android.internal.R.bool.config_battery_percentage_setting_available); setupLayoutTransition(); mBatteryIconView = new ImageView(context); mBatteryIconView.setImageDrawable(mDrawable); final MarginLayoutParams mlp = new MarginLayoutParams( getResources().getDimensionPixelSize(R.dimen.status_bar_battery_icon_width), getResources().getDimensionPixelSize(R.dimen.status_bar_battery_icon_height)); mlp.setMargins(0, 0, 0, getResources().getDimensionPixelOffset(R.dimen.battery_margin_bottom)); addView(mBatteryIconView, mlp); updateShowPercent(); mDualToneHandler = new DualToneHandler(context); // Init to not dark at all. onDarkChanged(new ArrayList(), 0, DarkIconDispatcher.DEFAULT_ICON_TINT); setClipChildren(false); setClipToPadding(false); } private void setupLayoutTransition() { LayoutTransition transition = new LayoutTransition(); transition.setDuration(200); // Animates appearing/disappearing of the battery percentage text using fade-in/fade-out // and disables all other animation types ObjectAnimator appearAnimator = ObjectAnimator.ofFloat(null, "alpha", 0f, 1f); transition.setAnimator(LayoutTransition.APPEARING, appearAnimator); transition.setInterpolator(LayoutTransition.APPEARING, Interpolators.ALPHA_IN); ObjectAnimator disappearAnimator = ObjectAnimator.ofFloat(null, "alpha", 1f, 0f); transition.setInterpolator(LayoutTransition.DISAPPEARING, Interpolators.ALPHA_OUT); transition.setAnimator(LayoutTransition.DISAPPEARING, disappearAnimator); transition.setAnimator(LayoutTransition.CHANGE_APPEARING, null); transition.setAnimator(LayoutTransition.CHANGE_DISAPPEARING, null); transition.setAnimator(LayoutTransition.CHANGING, null); setLayoutTransition(transition); } public void setForceShowPercent(boolean show) { setPercentShowMode(show ? MODE_ON : MODE_DEFAULT); } /** * Force a particular mode of showing percent * * 0 - No preference * 1 - Force on * 2 - Force off * 3 - Estimate * @param mode desired mode (none, on, off) */ public void setPercentShowMode(@BatteryPercentMode int mode) { if (mode == mShowPercentMode) return; mShowPercentMode = mode; updateShowPercent(); updatePercentText(); } @Override protected void onConfigurationChanged(Configuration newConfig) { super.onConfigurationChanged(newConfig); updatePercentView(); mDrawable.notifyDensityChanged(); } public void setColorsFromContext(Context context) { if (context == null) { return; } mDualToneHandler.setColorsFromContext(context); } @Override public boolean hasOverlappingRendering() { return false; } /** * Update battery level * * @param level int between 0 and 100 (representing percentage value) * @param pluggedIn whether the device is plugged in or not */ public void onBatteryLevelChanged(@IntRange(from = 0, to = 100) int level, boolean pluggedIn) { mPluggedIn = pluggedIn; mLevel = level; mDrawable.setCharging(isCharging()); mDrawable.setBatteryLevel(level); updatePercentText(); } void onPowerSaveChanged(boolean isPowerSave) { mDrawable.setPowerSaveEnabled(isPowerSave); } void onIsBatteryDefenderChanged(boolean isBatteryDefender) { boolean valueChanged = mIsBatteryDefender != isBatteryDefender; mIsBatteryDefender = isBatteryDefender; if (valueChanged) { updateContentDescription(); // The battery drawable is a different size depending on whether it's currently // overheated or not, so we need to re-scale the view when overheated changes. scaleBatteryMeterViews(); } } void onIsIncompatibleChargingChanged(boolean isIncompatibleCharging) { boolean valueChanged = mIsIncompatibleCharging != isIncompatibleCharging; mIsIncompatibleCharging = isIncompatibleCharging; if (valueChanged) { mDrawable.setCharging(isCharging()); updateContentDescription(); } } private TextView loadPercentView() { return (TextView) LayoutInflater.from(getContext()) .inflate(R.layout.battery_percentage_view, null); } /** * Updates percent view by removing old one and reinflating if necessary */ public void updatePercentView() { if (mBatteryPercentView != null) { removeView(mBatteryPercentView); mBatteryPercentView = null; } updateShowPercent(); } /** * Sets the fetcher that should be used to get the estimated time remaining for the user's * battery. */ void setBatteryEstimateFetcher(BatteryEstimateFetcher fetcher) { mBatteryEstimateFetcher = fetcher; } void setDisplayShieldEnabled(boolean displayShieldEnabled) { mDisplayShieldEnabled = displayShieldEnabled; } void updatePercentText() { if (mBatteryStateUnknown) { return; } if (mBatteryEstimateFetcher == null) { setPercentTextAtCurrentLevel(); return; } if (mBatteryPercentView != null) { if (mShowPercentMode == MODE_ESTIMATE && !isCharging()) { mBatteryEstimateFetcher.fetchBatteryTimeRemainingEstimate( (String estimate) -> { if (mBatteryPercentView == null) { return; } if (estimate != null && mShowPercentMode == MODE_ESTIMATE) { mEstimateText = estimate; mBatteryPercentView.setText(estimate); updateContentDescription(); } else { setPercentTextAtCurrentLevel(); } }); } else { setPercentTextAtCurrentLevel(); } } else { updateContentDescription(); } } private void setPercentTextAtCurrentLevel() { if (mBatteryPercentView != null) { mEstimateText = null; String percentText = NumberFormat.getPercentInstance().format(mLevel / 100f); // Setting text actually triggers a layout pass (because the text view is set to // wrap_content width and TextView always relayouts for this). Avoid needless // relayout if the text didn't actually change. if (!TextUtils.equals(mBatteryPercentView.getText(), percentText)) { mBatteryPercentView.setText(percentText); } } updateContentDescription(); } private void updateContentDescription() { Context context = getContext(); String contentDescription; if (mBatteryStateUnknown) { contentDescription = context.getString(R.string.accessibility_battery_unknown); } else if (mShowPercentMode == MODE_ESTIMATE && !TextUtils.isEmpty(mEstimateText)) { contentDescription = context.getString( mIsBatteryDefender ? R.string.accessibility_battery_level_charging_paused_with_estimate : R.string.accessibility_battery_level_with_estimate, mLevel, mEstimateText); } else if (mIsBatteryDefender) { contentDescription = context.getString(R.string.accessibility_battery_level_charging_paused, mLevel); } else if (isCharging()) { contentDescription = context.getString(R.string.accessibility_battery_level_charging, mLevel); } else { contentDescription = context.getString(R.string.accessibility_battery_level, mLevel); } setContentDescription(contentDescription); } void updateShowPercent() { final boolean showing = mBatteryPercentView != null; // TODO(b/140051051) final boolean systemSetting = 0 != whitelistIpcs(() -> Settings.System .getIntForUser(getContext().getContentResolver(), SHOW_BATTERY_PERCENT, 0, UserHandle.USER_CURRENT)); boolean shouldShow = (mShowPercentAvailable && systemSetting && mShowPercentMode != MODE_OFF) || mShowPercentMode == MODE_ON || mShowPercentMode == MODE_ESTIMATE; shouldShow = shouldShow && !mBatteryStateUnknown; if (shouldShow) { if (!showing) { mBatteryPercentView = loadPercentView(); if (mPercentageStyleId != 0) { // Only set if specified as attribute mBatteryPercentView.setTextAppearance(mPercentageStyleId); } float fontHeight = mBatteryPercentView.getPaint().getFontMetricsInt(null); mBatteryPercentView.setLineHeight(TypedValue.COMPLEX_UNIT_PX, fontHeight); if (mTextColor != 0) mBatteryPercentView.setTextColor(mTextColor); updatePercentText(); addView(mBatteryPercentView, new LayoutParams( LayoutParams.WRAP_CONTENT, (int) Math.ceil(fontHeight))); } } else { if (showing) { removeView(mBatteryPercentView); mBatteryPercentView = null; } } } private Drawable getUnknownStateDrawable() { if (mUnknownStateDrawable == null) { mUnknownStateDrawable = mContext.getDrawable(R.drawable.ic_battery_unknown); mUnknownStateDrawable.setTint(mTextColor); } return mUnknownStateDrawable; } void onBatteryUnknownStateChanged(boolean isUnknown) { if (mBatteryStateUnknown == isUnknown) { return; } mBatteryStateUnknown = isUnknown; updateContentDescription(); if (mBatteryStateUnknown) { mBatteryIconView.setImageDrawable(getUnknownStateDrawable()); } else { mBatteryIconView.setImageDrawable(mDrawable); } updateShowPercent(); } /** * Looks up the scale factor for status bar icons and scales the battery view by that amount. */ void scaleBatteryMeterViews() { Resources res = getContext().getResources(); TypedValue typedValue = new TypedValue(); res.getValue(R.dimen.status_bar_icon_scale_factor, typedValue, true); float iconScaleFactor = typedValue.getFloat(); float mainBatteryHeight = res.getDimensionPixelSize(R.dimen.status_bar_battery_icon_height) * iconScaleFactor; float mainBatteryWidth = res.getDimensionPixelSize(R.dimen.status_bar_battery_icon_width) * iconScaleFactor; boolean displayShield = mDisplayShieldEnabled && mIsBatteryDefender; float fullBatteryIconHeight = BatterySpecs.getFullBatteryHeight(mainBatteryHeight, displayShield); float fullBatteryIconWidth = BatterySpecs.getFullBatteryWidth(mainBatteryWidth, displayShield); int marginTop; if (displayShield) { // If the shield is displayed, we need some extra marginTop so that the bottom of the // main icon is still aligned with the bottom of all the other system icons. int shieldHeightAddition = Math.round(fullBatteryIconHeight - mainBatteryHeight); // However, the other system icons have some embedded bottom padding that the battery // doesn't have, so we shouldn't move the battery icon down by the full amount. // See b/258672854. marginTop = shieldHeightAddition - res.getDimensionPixelSize(R.dimen.status_bar_battery_extra_vertical_spacing); } else { marginTop = 0; } int marginBottom = res.getDimensionPixelSize(R.dimen.battery_margin_bottom); LinearLayout.LayoutParams scaledLayoutParams = new LinearLayout.LayoutParams( Math.round(fullBatteryIconWidth), Math.round(fullBatteryIconHeight)); scaledLayoutParams.setMargins(0, marginTop, 0, marginBottom); mDrawable.setDisplayShield(displayShield); mBatteryIconView.setLayoutParams(scaledLayoutParams); mBatteryIconView.invalidateDrawable(mDrawable); } @Override public void onDarkChanged(ArrayList areas, float darkIntensity, int tint) { float intensity = DarkIconDispatcher.isInAreas(areas, this) ? darkIntensity : 0; mNonAdaptedSingleToneColor = mDualToneHandler.getSingleColor(intensity); mNonAdaptedForegroundColor = mDualToneHandler.getFillColor(intensity); mNonAdaptedBackgroundColor = mDualToneHandler.getBackgroundColor(intensity); updateColors(mNonAdaptedForegroundColor, mNonAdaptedBackgroundColor, mNonAdaptedSingleToneColor); } /** * Sets icon and text colors. This will be overridden by {@code onDarkChanged} events, * if registered. * * @param foregroundColor * @param backgroundColor * @param singleToneColor */ public void updateColors(int foregroundColor, int backgroundColor, int singleToneColor) { mDrawable.setColors(foregroundColor, backgroundColor, singleToneColor); mTextColor = singleToneColor; if (mBatteryPercentView != null) { mBatteryPercentView.setTextColor(singleToneColor); } if (mUnknownStateDrawable != null) { mUnknownStateDrawable.setTint(singleToneColor); } } private boolean isCharging() { return mPluggedIn && !mIsIncompatibleCharging; } public void dump(PrintWriter pw, String[] args) { String powerSave = mDrawable == null ? null : mDrawable.getPowerSaveEnabled() + ""; String displayShield = mDrawable == null ? null : mDrawable.getDisplayShield() + ""; String charging = mDrawable == null ? null : mDrawable.getCharging() + ""; CharSequence percent = mBatteryPercentView == null ? null : mBatteryPercentView.getText(); pw.println(" BatteryMeterView:"); pw.println(" mDrawable.getPowerSave: " + powerSave); pw.println(" mDrawable.getDisplayShield: " + displayShield); pw.println(" mDrawable.getCharging: " + charging); pw.println(" mBatteryPercentView.getText(): " + percent); pw.println(" mTextColor: #" + Integer.toHexString(mTextColor)); pw.println(" mBatteryStateUnknown: " + mBatteryStateUnknown); pw.println(" mIsIncompatibleCharging: " + mIsIncompatibleCharging); pw.println(" mPluggedIn: " + mPluggedIn); pw.println(" mLevel: " + mLevel); pw.println(" mMode: " + mShowPercentMode); } @VisibleForTesting CharSequence getBatteryPercentViewText() { return mBatteryPercentView.getText(); } /** An interface that will fetch the estimated time remaining for the user's battery. */ public interface BatteryEstimateFetcher { void fetchBatteryTimeRemainingEstimate( BatteryController.EstimateFetchCompletion completion); } }