1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*
* Copyright (C) 2018 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.statusbar;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.media.AudioAttributes;
import android.os.Process;
import android.os.VibrationAttributes;
import android.os.VibrationEffect;
import android.os.Vibrator;
import androidx.annotation.VisibleForTesting;
import com.android.systemui.dagger.SysUISingleton;
import org.jetbrains.annotations.NotNull;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;
import javax.inject.Inject;
/**
* A Helper class that offloads {@link Vibrator} calls to a different thread.
* {@link Vibrator} makes blocking calls that may cause SysUI to ANR.
* TODO(b/245528624): Use regular Vibrator instance once new APIs are available.
*/
@SysUISingleton
public class VibratorHelper {
private final Vibrator mVibrator;
public static final VibrationAttributes TOUCH_VIBRATION_ATTRIBUTES =
VibrationAttributes.createForUsage(VibrationAttributes.USAGE_TOUCH);
private static final VibrationEffect BIOMETRIC_SUCCESS_VIBRATION_EFFECT =
VibrationEffect.get(VibrationEffect.EFFECT_CLICK);
private static final VibrationEffect BIOMETRIC_ERROR_VIBRATION_EFFECT =
VibrationEffect.get(VibrationEffect.EFFECT_DOUBLE_CLICK);
private static final VibrationAttributes HARDWARE_FEEDBACK_VIBRATION_ATTRIBUTES =
VibrationAttributes.createForUsage(VibrationAttributes.USAGE_HARDWARE_FEEDBACK);
private final Executor mExecutor;
/**
* Creates a vibrator helper on a new single threaded {@link Executor}.
*/
@Inject
public VibratorHelper(@Nullable Vibrator vibrator) {
this(vibrator, Executors.newSingleThreadExecutor());
}
/**
* Creates new vibrator helper on a specific {@link Executor}.
*/
@VisibleForTesting
public VibratorHelper(@Nullable Vibrator vibrator, Executor executor) {
mExecutor = executor;
mVibrator = vibrator;
}
/**
* @see Vibrator#vibrate(long)
*/
public void vibrate(final int effectId) {
if (!hasVibrator()) {
return;
}
mExecutor.execute(() ->
mVibrator.vibrate(VibrationEffect.get(effectId, false /* fallback */),
TOUCH_VIBRATION_ATTRIBUTES));
}
/**
* @see Vibrator#vibrate(int, String, VibrationEffect, String, VibrationAttributes)
*/
public void vibrate(int uid, String opPkg, @NonNull VibrationEffect vibe,
String reason, @NonNull VibrationAttributes attributes) {
if (!hasVibrator()) {
return;
}
mExecutor.execute(() -> mVibrator.vibrate(uid, opPkg, vibe, reason, attributes));
}
/**
* @see Vibrator#vibrate(VibrationEffect, AudioAttributes)
*/
public void vibrate(@NonNull VibrationEffect effect, @NonNull AudioAttributes attributes) {
if (!hasVibrator()) {
return;
}
mExecutor.execute(() -> mVibrator.vibrate(effect, attributes));
}
/**
* @see Vibrator#vibrate(VibrationEffect)
*/
public void vibrate(@NotNull VibrationEffect effect) {
if (!hasVibrator()) {
return;
}
mExecutor.execute(() -> mVibrator.vibrate(effect));
}
/**
* @see Vibrator#hasVibrator()
*/
public boolean hasVibrator() {
return mVibrator != null && mVibrator.hasVibrator();
}
/**
* @see Vibrator#cancel()
*/
public void cancel() {
if (!hasVibrator()) {
return;
}
mExecutor.execute(mVibrator::cancel);
}
/**
* Perform vibration when biometric authentication success
*/
public void vibrateAuthSuccess(String reason) {
vibrate(Process.myUid(),
"com.android.systemui",
BIOMETRIC_SUCCESS_VIBRATION_EFFECT, reason,
HARDWARE_FEEDBACK_VIBRATION_ATTRIBUTES);
}
/**
* Perform vibration when biometric authentication error
*/
public void vibrateAuthError(String reason) {
vibrate(Process.myUid(), "com.android.systemui",
BIOMETRIC_ERROR_VIBRATION_EFFECT, reason,
HARDWARE_FEEDBACK_VIBRATION_ATTRIBUTES);
}
}
|
