Merge "Extract single vibrator control into a separate class" (1d9ab531) · Commits · e / os / android_frameworks_base

services/core/java/com/android/server/VibratorService.java

+75 −348

File changed.

Preview size limit exceeded, changes collapsed.

services/core/java/com/android/server/vibrator/VibrationSettings.java

+61 −0

Original line number	Diff line number	Diff line
		@@ -17,14 +17,17 @@
		package com.android.server.vibrator;

		import android.content.Context;
		import android.content.res.Resources;
		import android.database.ContentObserver;
		import android.media.AudioManager;
		import android.net.Uri;
		import android.os.Handler;
		import android.os.UserHandle;
		import android.os.VibrationAttributes;
		import android.os.VibrationEffect;
		import android.os.Vibrator;
		import android.provider.Settings;
		import android.util.SparseArray;

		import com.android.internal.annotations.GuardedBy;
		import com.android.internal.annotations.VisibleForTesting;
		@@ -37,6 +40,8 @@ import java.util.List;
		public final class VibrationSettings {
		private static final String TAG = "VibrationSettings";

		private static final long[] DOUBLE_CLICK_EFFECT_FALLBACK_TIMINGS = {0, 30, 100, 30};

		/** Listener for changes on vibration settings. */
		public interface OnVibratorSettingsChanged {
		/** Callback triggered when any of the vibrator settings change. */
		@@ -51,6 +56,7 @@ public final class VibrationSettings {

		@GuardedBy("mLock")
		private final List<OnVibratorSettingsChanged> mListeners = new ArrayList<>();
		private final SparseArray<VibrationEffect> mFallbackEffects;

		@GuardedBy("mLock")
		private boolean mVibrateInputDevices;
		@@ -84,6 +90,23 @@ public final class VibrationSettings {
		registerSettingsObserver(
		Settings.System.getUriFor(Settings.System.RING_VIBRATION_INTENSITY));

		VibrationEffect clickEffect = createEffectFromResource(
		com.android.internal.R.array.config_virtualKeyVibePattern);
		VibrationEffect doubleClickEffect = VibrationEffect.createWaveform(
		DOUBLE_CLICK_EFFECT_FALLBACK_TIMINGS, -1 /repeatIndex/);
		VibrationEffect heavyClickEffect = createEffectFromResource(
		com.android.internal.R.array.config_longPressVibePattern);
		VibrationEffect tickEffect = createEffectFromResource(
		com.android.internal.R.array.config_clockTickVibePattern);

		mFallbackEffects = new SparseArray<>();
		mFallbackEffects.put(VibrationEffect.EFFECT_CLICK, clickEffect);
		mFallbackEffects.put(VibrationEffect.EFFECT_DOUBLE_CLICK, doubleClickEffect);
		mFallbackEffects.put(VibrationEffect.EFFECT_TICK, tickEffect);
		mFallbackEffects.put(VibrationEffect.EFFECT_HEAVY_CLICK, heavyClickEffect);
		mFallbackEffects.put(VibrationEffect.EFFECT_TEXTURE_TICK,
		VibrationEffect.get(VibrationEffect.EFFECT_TICK, false));

		// Update with current values from settings.
		updateSettings();
		}
		@@ -149,6 +172,17 @@ public final class VibrationSettings {
		}
		}

		/**
		* Return a {@link VibrationEffect} that should be played if the device do not support given
		* {@code effectId}.
		*
		* @param effectId one of VibrationEffect.EFFECT_*
		* @return The effect to be played as a fallback
		*/
		public VibrationEffect getFallbackEffect(int effectId) {
		return mFallbackEffects.get(effectId);
		}

		/**
		* Return {@code true} if the device should vibrate for ringtones.
		*
		@@ -270,6 +304,33 @@ public final class VibrationSettings {
		UserHandle.USER_ALL);
		}

		private VibrationEffect createEffectFromResource(int resId) {
		long[] timings = getLongIntArray(mContext.getResources(), resId);
		return createEffectFromTimings(timings);
		}

		private static VibrationEffect createEffectFromTimings(long[] timings) {
		if (timings == null \|\| timings.length == 0) {
		return null;
		} else if (timings.length == 1) {
		return VibrationEffect.createOneShot(timings[0], VibrationEffect.DEFAULT_AMPLITUDE);
		} else {
		return VibrationEffect.createWaveform(timings, -1);
		}
		}

		private static long[] getLongIntArray(Resources r, int resid) {
		int[] ar = r.getIntArray(resid);
		if (ar == null) {
		return null;
		}
		long[] out = new long[ar.length];
		for (int i = 0; i < ar.length; i++) {
		out[i] = ar[i];
		}
		return out;
		}

		/** Implementation of {@link ContentObserver} to be registered to a setting {@link Uri}. */
		private final class SettingsObserver extends ContentObserver {
		SettingsObserver(Handler handler) {

services/core/java/com/android/server/vibrator/VibratorController.java

0 → 100644

+472 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2020 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.server.vibrator;

		import android.annotation.Nullable;
		import android.hardware.vibrator.IVibrator;
		import android.os.Binder;
		import android.os.IVibratorStateListener;
		import android.os.RemoteCallbackList;
		import android.os.RemoteException;
		import android.os.VibrationEffect;
		import android.os.Vibrator;
		import android.util.Slog;

		import com.android.internal.annotations.GuardedBy;
		import com.android.internal.annotations.VisibleForTesting;

		import libcore.util.NativeAllocationRegistry;

		import java.util.Arrays;
		import java.util.HashSet;
		import java.util.Set;

		/** Controls a single vibrator. */
		// TODO(b/159207608): Make this package-private once vibrator services are moved to this package
		public final class VibratorController {
		private static final String TAG = "VibratorController";

		private final Object mLock = new Object();
		private final NativeWrapper mNativeWrapper;
		private final int mVibratorId;
		private final long mCapabilities;
		@Nullable
		private final Set<Integer> mSupportedEffects;
		@Nullable
		private final Set<Integer> mSupportedPrimitives;

		@GuardedBy("mLock")
		private final RemoteCallbackList<IVibratorStateListener> mVibratorStateListeners =
		new RemoteCallbackList<>();
		@GuardedBy("mLock")
		private boolean mIsVibrating;
		@GuardedBy("mLock")
		private boolean mIsUnderExternalControl;

		/** Listener for vibration completion callbacks from native. */
		public interface OnVibrationCompleteListener {

		/** Callback triggered when vibration is complete. */
		void onComplete(int vibratorId, long vibrationId);
		}

		/**
		* Initializes the native part of this controller, creating a global reference to given
		* {@link OnVibrationCompleteListener} and returns a newly allocated native pointer. This
		* wrapper is responsible for deleting this pointer by calling the method pointed
		* by {@link #vibratorGetFinalizer()}.
		*
		* <p><b>Note:</b> Make sure the given implementation of {@link OnVibrationCompleteListener}
		* do not hold any strong reference to the instance responsible for deleting the returned
		* pointer, to avoid creating a cyclic GC root reference.
		*/
		static native long vibratorInit(int vibratorId, OnVibrationCompleteListener listener);

		/**
		* Returns pointer to native function responsible for cleaning up the native pointer allocated
		* and returned by {@link #vibratorInit(int, OnVibrationCompleteListener)}.
		*/
		static native long vibratorGetFinalizer();

		static native boolean vibratorIsAvailable(long nativePtr);

		static native void vibratorOn(long nativePtr, long milliseconds, long vibrationId);

		static native void vibratorOff(long nativePtr);

		static native void vibratorSetAmplitude(long nativePtr, int amplitude);

		static native int[] vibratorGetSupportedEffects(long nativePtr);

		static native int[] vibratorGetSupportedPrimitives(long nativePtr);

		static native long vibratorPerformEffect(
		long nativePtr, long effect, long strength, long vibrationId);

		static native void vibratorPerformComposedEffect(long nativePtr,
		VibrationEffect.Composition.PrimitiveEffect[] effect, long vibrationId);

		static native void vibratorSetExternalControl(long nativePtr, boolean enabled);

		static native long vibratorGetCapabilities(long nativePtr);

		static native void vibratorAlwaysOnEnable(long nativePtr, long id, long effect, long strength);

		static native void vibratorAlwaysOnDisable(long nativePtr, long id);

		public VibratorController(int vibratorId, OnVibrationCompleteListener listener) {
		this(vibratorId, listener, new NativeWrapper());
		}

		@VisibleForTesting
		public VibratorController(int vibratorId, OnVibrationCompleteListener listener,
		NativeWrapper nativeWrapper) {
		mVibratorId = vibratorId;
		mNativeWrapper = nativeWrapper;

		nativeWrapper.init(vibratorId, listener);
		mCapabilities = nativeWrapper.getCapabilities();
		mSupportedEffects = asSet(nativeWrapper.getSupportedEffects());
		mSupportedPrimitives = asSet(nativeWrapper.getSupportedPrimitives());
		}

		/** Register state listener for this vibrator. */
		public boolean registerVibratorStateListener(IVibratorStateListener listener) {
		synchronized (mLock) {
		final long token = Binder.clearCallingIdentity();
		try {
		if (!mVibratorStateListeners.register(listener)) {
		return false;
		}
		// Notify its callback after new client registered.
		notifyStateListenerLocked(listener);
		return true;
		} finally {
		Binder.restoreCallingIdentity(token);
		}
		}
		}

		/** Remove registered state listener for this vibrator. */
		public boolean unregisterVibratorStateListener(IVibratorStateListener listener) {
		synchronized (mLock) {
		final long token = Binder.clearCallingIdentity();
		try {
		return mVibratorStateListeners.unregister(listener);
		} finally {
		Binder.restoreCallingIdentity(token);
		}
		}
		}

		/** Return the id of the vibrator controlled by this instance. */
		public int getVibratorId() {
		return mVibratorId;
		}

		/**
		* Return {@code true} is this vibrator is currently vibrating, false otherwise.
		*
		* <p>This state is controlled by calls to {@link #on} and {@link #off} methods, and is
		* automatically notified to any registered {@link IVibratorStateListener} on change.
		*/
		public boolean isVibrating() {
		synchronized (mLock) {
		return mIsVibrating;
		}
		}

		/** Return {@code true} if this vibrator is under external control, false otherwise. */
		public boolean isUnderExternalControl() {
		synchronized (mLock) {
		return mIsUnderExternalControl;
		}
		}

		/**
		* Check against this vibrator capabilities.
		*
		* @param capability one of IVibrator.CAP_*
		* @return true if this vibrator has this capability, false otherwise
		*/
		public boolean hasCapability(long capability) {
		return (mCapabilities & capability) == capability;
		}

		/**
		* Check against this vibrator supported effects.
		*
		* @param effectIds list of effects, one of VibrationEffect.EFFECT_*
		* @return one entry per requested effectId, with one of Vibrator.VIBRATION_EFFECT_SUPPORT_*
		*/
		public int[] areEffectsSupported(int[] effectIds) {
		int[] supported = new int[effectIds.length];
		if (mSupportedEffects == null) {
		Arrays.fill(supported, Vibrator.VIBRATION_EFFECT_SUPPORT_UNKNOWN);
		} else {
		for (int i = 0; i < effectIds.length; i++) {
		supported[i] = mSupportedEffects.contains(effectIds[i])
		? Vibrator.VIBRATION_EFFECT_SUPPORT_YES
		: Vibrator.VIBRATION_EFFECT_SUPPORT_NO;
		}
		}
		return supported;
		}

		/**
		* Check against this vibrator supported primitives.
		*
		* @param primitiveIds list of primitives, one of VibrationEffect.Composition.EFFECT_*
		* @return one entry per requested primitiveId, with true if it is supported
		*/
		public boolean[] arePrimitivesSupported(int[] primitiveIds) {
		boolean[] supported = new boolean[primitiveIds.length];
		if (mSupportedPrimitives != null && hasCapability(IVibrator.CAP_COMPOSE_EFFECTS)) {
		for (int i = 0; i < primitiveIds.length; i++) {
		supported[i] = mSupportedPrimitives.contains(primitiveIds[i]);
		}
		}
		return supported;
		}

		/** Return {@code true} if the underlying vibrator is currently available, false otherwise. */
		public boolean isAvailable() {
		return mNativeWrapper.isAvailable();
		}

		/**
		* Set the vibrator control to be external or not, based on given flag.
		*
		* <p>This will affect the state of {@link #isUnderExternalControl()}.
		*/
		public void setExternalControl(boolean externalControl) {
		if (!hasCapability(IVibrator.CAP_EXTERNAL_CONTROL)) {
		return;
		}
		synchronized (mLock) {
		mIsUnderExternalControl = externalControl;
		mNativeWrapper.setExternalControl(externalControl);
		}
		}

		/**
		* Update the predefined vibration effect saved with given id. This will remove the saved effect
		* if given {@code effect} is {@code null}.
		*/
		public void updateAlwaysOn(int id, @Nullable VibrationEffect.Prebaked effect) {
		if (!hasCapability(IVibrator.CAP_ALWAYS_ON_CONTROL)) {
		return;
		}
		synchronized (mLock) {
		if (effect == null) {
		mNativeWrapper.alwaysOnDisable(id);
		} else {
		mNativeWrapper.alwaysOnEnable(id, effect.getId(), effect.getEffectStrength());
		}
		}
		}

		/** Set the vibration amplitude. This will NOT affect the state of {@link #isVibrating()}. */
		public void setAmplitude(int amplitude) {
		synchronized (mLock) {
		if (hasCapability(IVibrator.CAP_AMPLITUDE_CONTROL)) {
		mNativeWrapper.setAmplitude(amplitude);
		}
		}
		}

		/**
		* Turn on the vibrator for {@code milliseconds} time, using {@code vibrationId} or completion
		* callback to {@link OnVibrationCompleteListener}.
		*
		* <p>This will affect the state of {@link #isVibrating()}.
		*/
		public void on(long milliseconds, long vibrationId) {
		synchronized (mLock) {
		mNativeWrapper.on(milliseconds, vibrationId);
		notifyVibratorOnLocked();
		}
		}

		/**
		* Plays predefined vibration effect, using {@code vibrationId} or completion callback to
		* {@link OnVibrationCompleteListener}.
		*
		* <p>This will affect the state of {@link #isVibrating()}.
		*/
		public long on(VibrationEffect.Prebaked effect, long vibrationId) {
		synchronized (mLock) {
		long duration = mNativeWrapper.perform(effect.getId(), effect.getEffectStrength(),
		vibrationId);
		if (duration > 0) {
		notifyVibratorOnLocked();
		}
		return duration;
		}
		}

		/**
		* Plays composited vibration effect, using {@code vibrationId} or completion callback to
		* {@link OnVibrationCompleteListener}.
		*
		* <p>This will affect the state of {@link #isVibrating()}.
		*/
		public void on(VibrationEffect.Composed effect, long vibrationId) {
		if (!hasCapability(IVibrator.CAP_COMPOSE_EFFECTS)) {
		return;
		}
		synchronized (mLock) {
		mNativeWrapper.compose(effect.getPrimitiveEffects().toArray(
		new VibrationEffect.Composition.PrimitiveEffect[0]), vibrationId);
		notifyVibratorOnLocked();
		}
		}

		/** Turns off the vibrator.This will affect the state of {@link #isVibrating()}. */
		public void off() {
		synchronized (mLock) {
		mNativeWrapper.off();
		notifyVibratorOffLocked();
		}
		}

		@Override
		public String toString() {
		return "VibratorController{"
		+ "mVibratorId=" + mVibratorId
		+ ", mCapabilities=" + mCapabilities
		+ ", mSupportedEffects=" + mSupportedEffects
		+ ", mSupportedPrimitives=" + mSupportedPrimitives
		+ ", mIsVibrating=" + mIsVibrating
		+ ", mIsUnderExternalControl=" + mIsUnderExternalControl
		+ ", mVibratorStateListeners count="
		+ mVibratorStateListeners.getRegisteredCallbackCount()
		+ '}';
		}

		@GuardedBy("mLock")
		private void notifyVibratorOnLocked() {
		if (!mIsVibrating) {
		mIsVibrating = true;
		notifyStateListenersLocked();
		}
		}

		@GuardedBy("mLock")
		private void notifyVibratorOffLocked() {
		if (mIsVibrating) {
		mIsVibrating = false;
		notifyStateListenersLocked();
		}
		}

		@GuardedBy("mLock")
		private void notifyStateListenersLocked() {
		final int length = mVibratorStateListeners.beginBroadcast();
		try {
		for (int i = 0; i < length; i++) {
		notifyStateListenerLocked(mVibratorStateListeners.getBroadcastItem(i));
		}
		} finally {
		mVibratorStateListeners.finishBroadcast();
		}
		}

		@GuardedBy("mLock")
		private void notifyStateListenerLocked(IVibratorStateListener listener) {
		try {
		listener.onVibrating(mIsVibrating);
		} catch (RemoteException \| RuntimeException e) {
		Slog.e(TAG, "Vibrator state listener failed to call", e);
		}
		}

		@Nullable
		private static Set<Integer> asSet(int[] values) {
		if (values == null) {
		return null;
		}
		HashSet<Integer> set = new HashSet<>();
		for (int value : values) {
		set.add(value);
		}
		return set;
		}

		/** Wrapper around the static-native methods of {@link VibratorController} for tests. */
		@VisibleForTesting
		public static class NativeWrapper {

		private long mNativePtr = 0;

		/** Initializes native controller and allocation registry to destroy native instances. */
		public void init(int vibratorId, OnVibrationCompleteListener listener) {
		mNativePtr = VibratorController.vibratorInit(vibratorId, listener);
		long finalizerPtr = VibratorController.vibratorGetFinalizer();

		if (finalizerPtr != 0) {
		NativeAllocationRegistry registry =
		NativeAllocationRegistry.createMalloced(
		VibratorController.class.getClassLoader(), finalizerPtr);
		registry.registerNativeAllocation(this, mNativePtr);
		}
		}

		/** Check if the vibrator is currently available. */
		public boolean isAvailable() {
		return VibratorController.vibratorIsAvailable(mNativePtr);
		}

		/** Turns vibrator on for given time. */
		public void on(long milliseconds, long vibrationId) {
		VibratorController.vibratorOn(mNativePtr, milliseconds, vibrationId);
		}

		/** Turns vibrator off. */
		public void off() {
		VibratorController.vibratorOff(mNativePtr);
		}

		/** Sets the amplitude for the vibrator to run. */
		public void setAmplitude(int amplitude) {
		VibratorController.vibratorSetAmplitude(mNativePtr, amplitude);
		}

		/** Returns all predefined effects supported by the device vibrator. */
		public int[] getSupportedEffects() {
		return VibratorController.vibratorGetSupportedEffects(mNativePtr);
		}

		/** Returns all compose primitives supported by the device vibrator. */
		public int[] getSupportedPrimitives() {
		return VibratorController.vibratorGetSupportedPrimitives(mNativePtr);
		}

		/** Turns vibrator on to perform one of the supported effects. */
		public long perform(long effect, long strength, long vibrationId) {
		return VibratorController.vibratorPerformEffect(
		mNativePtr, effect, strength, vibrationId);
		}

		/** Turns vibrator on to perform one of the supported composed effects. */
		public void compose(
		VibrationEffect.Composition.PrimitiveEffect[] effect, long vibrationId) {
		VibratorController.vibratorPerformComposedEffect(mNativePtr, effect,
		vibrationId);
		}

		/** Enabled the device vibrator to be controlled by another service. */
		public void setExternalControl(boolean enabled) {
		VibratorController.vibratorSetExternalControl(mNativePtr, enabled);
		}

		/** Returns all capabilities of the device vibrator. */
		public long getCapabilities() {
		return VibratorController.vibratorGetCapabilities(mNativePtr);
		}

		/** Enable always-on vibration with given id and effect. */
		public void alwaysOnEnable(long id, long effect, long strength) {
		VibratorController.vibratorAlwaysOnEnable(mNativePtr, id, effect, strength);
		}

		/** Disable always-on vibration for given id. */
		public void alwaysOnDisable(long id) {
		VibratorController.vibratorAlwaysOnDisable(mNativePtr, id);
		}
		}
		}

services/core/jni/Android.bp

+1 −1

Original line number	Diff line number	Diff line
		@@ -53,8 +53,8 @@ cc_library_static {
		"com_android_server_UsbDescriptorParser.cpp",
		"com_android_server_UsbMidiDevice.cpp",
		"com_android_server_UsbHostManager.cpp",
		"com_android_server_vibrator_VibratorController.cpp",
		"com_android_server_VibratorManagerService.cpp",
		"com_android_server_VibratorService.cpp",
		"com_android_server_PersistentDataBlockService.cpp",
		"com_android_server_am_CachedAppOptimizer.cpp",
		"com_android_server_am_LowMemDetector.cpp",

services/core/jni/OWNERS

+1 −1

Original line number	Diff line number	Diff line
		@@ -2,8 +2,8 @@
		per-file com_android_server_lights_LightsService.cpp = michaelwr@google.com, santoscordon@google.com

		# Haptics
		per-file com_android_server_vibrator_VibratorController.cpp = michaelwr@google.com
		per-file com_android_server_VibratorManagerService.cpp = michaelwr@google.com
		per-file com_android_server_VibratorService.cpp = michaelwr@google.com

		# Input
		per-file com_android_server_input_InputManagerService.cpp = michaelwr@google.com, svv@google.com