John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package com.android.systemui.volume; |
| 18 | |
| 19 | import android.media.AudioManager; |
| 20 | import android.media.AudioSystem; |
| 21 | import android.provider.Settings.Global; |
| 22 | import android.util.Log; |
| 23 | |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 24 | import com.android.internal.logging.MetricsLogger; |
Tamas Berghammer | 383db5eb | 2016-06-22 15:21:38 +0100 | [diff] [blame] | 25 | import com.android.internal.logging.nano.MetricsProto.MetricsEvent; |
Jason Monk | 782cd67 | 2017-03-22 12:50:57 -0400 | [diff] [blame] | 26 | import com.android.systemui.plugins.VolumeDialogController.State; |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 27 | |
| 28 | import java.util.Arrays; |
| 29 | |
| 30 | /** |
| 31 | * Interesting events related to the volume. |
| 32 | */ |
| 33 | public class Events { |
| 34 | private static final String TAG = Util.logTag(Events.class); |
| 35 | |
| 36 | public static final int EVENT_SHOW_DIALOG = 0; // (reason|int) (keyguard|bool) |
| 37 | public static final int EVENT_DISMISS_DIALOG = 1; // (reason|int) |
| 38 | public static final int EVENT_ACTIVE_STREAM_CHANGED = 2; // (stream|int) |
| 39 | public static final int EVENT_EXPAND = 3; // (expand|bool) |
| 40 | public static final int EVENT_KEY = 4; |
| 41 | public static final int EVENT_COLLECTION_STARTED = 5; |
| 42 | public static final int EVENT_COLLECTION_STOPPED = 6; |
| 43 | public static final int EVENT_ICON_CLICK = 7; // (stream|int) (icon_state|int) |
| 44 | public static final int EVENT_SETTINGS_CLICK = 8; |
| 45 | public static final int EVENT_TOUCH_LEVEL_CHANGED = 9; // (stream|int) (level|int) |
| 46 | public static final int EVENT_LEVEL_CHANGED = 10; // (stream|int) (level|int) |
| 47 | public static final int EVENT_INTERNAL_RINGER_MODE_CHANGED = 11; // (mode|int) |
| 48 | public static final int EVENT_EXTERNAL_RINGER_MODE_CHANGED = 12; // (mode|int) |
| 49 | public static final int EVENT_ZEN_MODE_CHANGED = 13; // (mode|int) |
| 50 | public static final int EVENT_SUPPRESSOR_CHANGED = 14; // (component|string) (name|string) |
| 51 | public static final int EVENT_MUTE_CHANGED = 15; // (stream|int) (muted|bool) |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 52 | public static final int EVENT_TOUCH_LEVEL_DONE = 16; // (stream|int) (level|bool) |
Beverly | 925cde8 | 2018-01-23 09:31:23 -0500 | [diff] [blame] | 53 | public static final int EVENT_ZEN_CONFIG_CHANGED = 17; // (allow/disallow|string) |
Julia Reynolds | 5ba8dda | 2018-04-10 16:07:57 -0400 | [diff] [blame] | 54 | public static final int EVENT_RINGER_TOGGLE = 18; // (ringer_mode) |
Sherry Huang | ce02ed3 | 2019-01-17 20:37:29 +0800 | [diff] [blame] | 55 | public static final int EVENT_SHOW_USB_OVERHEAT_ALARM = 19; // (reason|int) (keyguard|bool) |
| 56 | public static final int EVENT_DISMISS_USB_OVERHEAT_ALARM = 20; // (reason|int) (keyguard|bool) |
Anthony Tripaldi | a404da3 | 2019-03-02 16:29:49 -0500 | [diff] [blame] | 57 | public static final int EVENT_ODI_CAPTIONS_CLICK = 21; |
Anthony Tripaldi | ea0236d | 2019-03-18 11:47:52 -0400 | [diff] [blame] | 58 | public static final int EVENT_ODI_CAPTIONS_TOOLTIP_CLICK = 22; |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 59 | |
| 60 | private static final String[] EVENT_TAGS = { |
Julia Reynolds | 5ba8dda | 2018-04-10 16:07:57 -0400 | [diff] [blame] | 61 | "show_dialog", |
| 62 | "dismiss_dialog", |
| 63 | "active_stream_changed", |
| 64 | "expand", |
| 65 | "key", |
| 66 | "collection_started", |
| 67 | "collection_stopped", |
| 68 | "icon_click", |
| 69 | "settings_click", |
| 70 | "touch_level_changed", |
| 71 | "level_changed", |
| 72 | "internal_ringer_mode_changed", |
| 73 | "external_ringer_mode_changed", |
| 74 | "zen_mode_changed", |
| 75 | "suppressor_changed", |
| 76 | "mute_changed", |
| 77 | "touch_level_done", |
| 78 | "zen_mode_config_changed", |
Sherry Huang | ce02ed3 | 2019-01-17 20:37:29 +0800 | [diff] [blame] | 79 | "ringer_toggle", |
| 80 | "show_usb_overheat_alarm", |
Anthony Tripaldi | a404da3 | 2019-03-02 16:29:49 -0500 | [diff] [blame] | 81 | "dismiss_usb_overheat_alarm", |
Anthony Tripaldi | ea0236d | 2019-03-18 11:47:52 -0400 | [diff] [blame] | 82 | "odi_captions_click", |
| 83 | "odi_captions_tooltip_click" |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 84 | }; |
| 85 | |
| 86 | public static final int DISMISS_REASON_UNKNOWN = 0; |
| 87 | public static final int DISMISS_REASON_TOUCH_OUTSIDE = 1; |
| 88 | public static final int DISMISS_REASON_VOLUME_CONTROLLER = 2; |
| 89 | public static final int DISMISS_REASON_TIMEOUT = 3; |
| 90 | public static final int DISMISS_REASON_SCREEN_OFF = 4; |
| 91 | public static final int DISMISS_REASON_SETTINGS_CLICKED = 5; |
| 92 | public static final int DISMISS_REASON_DONE_CLICKED = 6; |
Julia Reynolds | 74cc650 | 2017-08-08 12:41:04 -0400 | [diff] [blame] | 93 | public static final int DISMISS_STREAM_GONE = 7; |
Julia Reynolds | fba474a8 | 2017-12-13 15:35:54 -0500 | [diff] [blame] | 94 | public static final int DISMISS_REASON_OUTPUT_CHOOSER = 8; |
Sherry Huang | ce02ed3 | 2019-01-17 20:37:29 +0800 | [diff] [blame] | 95 | public static final int DISMISS_REASON_USB_OVERHEAD_ALARM_CHANGED = 9; |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 96 | public static final String[] DISMISS_REASONS = { |
Julia Reynolds | 74cc650 | 2017-08-08 12:41:04 -0400 | [diff] [blame] | 97 | "unknown", |
| 98 | "touch_outside", |
| 99 | "volume_controller", |
| 100 | "timeout", |
| 101 | "screen_off", |
| 102 | "settings_clicked", |
| 103 | "done_clicked", |
Julia Reynolds | fba474a8 | 2017-12-13 15:35:54 -0500 | [diff] [blame] | 104 | "a11y_stream_changed", |
Sherry Huang | ce02ed3 | 2019-01-17 20:37:29 +0800 | [diff] [blame] | 105 | "output_chooser", |
Anthony Tripaldi | 8eb58c2 | 2019-04-10 04:49:48 -0400 | [diff] [blame] | 106 | "usb_temperature_below_threshold" |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 107 | }; |
| 108 | |
| 109 | public static final int SHOW_REASON_UNKNOWN = 0; |
| 110 | public static final int SHOW_REASON_VOLUME_CHANGED = 1; |
| 111 | public static final int SHOW_REASON_REMOTE_VOLUME_CHANGED = 2; |
Sherry Huang | ce02ed3 | 2019-01-17 20:37:29 +0800 | [diff] [blame] | 112 | public static final int SHOW_REASON_USB_OVERHEAD_ALARM_CHANGED = 3; |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 113 | public static final String[] SHOW_REASONS = { |
| 114 | "unknown", |
| 115 | "volume_changed", |
Sherry Huang | ce02ed3 | 2019-01-17 20:37:29 +0800 | [diff] [blame] | 116 | "remote_volume_changed", |
| 117 | "usb_temperature_above_threshold" |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 118 | }; |
| 119 | |
| 120 | public static final int ICON_STATE_UNKNOWN = 0; |
| 121 | public static final int ICON_STATE_UNMUTE = 1; |
| 122 | public static final int ICON_STATE_MUTE = 2; |
| 123 | public static final int ICON_STATE_VIBRATE = 3; |
| 124 | |
| 125 | public static Callback sCallback; |
| 126 | |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 127 | /** |
| 128 | * Logs an event to the system log and the event log. |
| 129 | * @param tag One of the EVENT_* codes above. |
| 130 | * @param list Any additional event-specific arguments, documented above. |
| 131 | */ |
| 132 | public static void writeEvent(int tag, Object... list) { |
Julia Reynolds | 5ba8dda | 2018-04-10 16:07:57 -0400 | [diff] [blame] | 133 | MetricsLogger logger = new MetricsLogger(); |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 134 | final long time = System.currentTimeMillis(); |
| 135 | final StringBuilder sb = new StringBuilder("writeEvent ").append(EVENT_TAGS[tag]); |
| 136 | if (list != null && list.length > 0) { |
| 137 | sb.append(" "); |
| 138 | switch (tag) { |
| 139 | case EVENT_SHOW_DIALOG: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 140 | logger.visible(MetricsEvent.VOLUME_DIALOG); |
| 141 | logger.histogram("volume_from_keyguard", |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 142 | (Boolean) list[1] ? 1 : 0); |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 143 | sb.append(SHOW_REASONS[(Integer) list[0]]).append(" keyguard=").append(list[1]); |
| 144 | break; |
| 145 | case EVENT_EXPAND: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 146 | logger.visibility(MetricsEvent.VOLUME_DIALOG_DETAILS, |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 147 | (Boolean) list[0]); |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 148 | sb.append(list[0]); |
| 149 | break; |
| 150 | case EVENT_DISMISS_DIALOG: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 151 | logger.hidden(MetricsEvent.VOLUME_DIALOG); |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 152 | sb.append(DISMISS_REASONS[(Integer) list[0]]); |
| 153 | break; |
| 154 | case EVENT_ACTIVE_STREAM_CHANGED: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 155 | logger.action(MetricsEvent.ACTION_VOLUME_STREAM, |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 156 | (Integer) list[0]); |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 157 | sb.append(AudioSystem.streamToString((Integer) list[0])); |
| 158 | break; |
| 159 | case EVENT_ICON_CLICK: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 160 | logger.action(MetricsEvent.ACTION_VOLUME_ICON, |
Julia Reynolds | 5ba8dda | 2018-04-10 16:07:57 -0400 | [diff] [blame] | 161 | (Integer) list[0]); |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 162 | sb.append(AudioSystem.streamToString((Integer) list[0])).append(' ') |
| 163 | .append(iconStateToString((Integer) list[1])); |
| 164 | break; |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 165 | case EVENT_TOUCH_LEVEL_DONE: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 166 | logger.action(MetricsEvent.ACTION_VOLUME_SLIDER, |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 167 | (Integer) list[1]); |
| 168 | // fall through |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 169 | case EVENT_TOUCH_LEVEL_CHANGED: |
| 170 | case EVENT_LEVEL_CHANGED: |
| 171 | case EVENT_MUTE_CHANGED: |
| 172 | sb.append(AudioSystem.streamToString((Integer) list[0])).append(' ') |
| 173 | .append(list[1]); |
| 174 | break; |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 175 | case EVENT_KEY: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 176 | logger.action(MetricsEvent.ACTION_VOLUME_KEY, |
Julia Reynolds | 5ba8dda | 2018-04-10 16:07:57 -0400 | [diff] [blame] | 177 | (Integer) list[0]); |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 178 | sb.append(AudioSystem.streamToString((Integer) list[0])).append(' ') |
| 179 | .append(list[1]); |
| 180 | break; |
Julia Reynolds | 5ba8dda | 2018-04-10 16:07:57 -0400 | [diff] [blame] | 181 | case EVENT_RINGER_TOGGLE: |
| 182 | logger.action(MetricsEvent.ACTION_VOLUME_RINGER_TOGGLE, (Integer) list[0]); |
| 183 | break; |
| 184 | case EVENT_SETTINGS_CLICK: |
| 185 | logger.action(MetricsEvent.ACTION_VOLUME_SETTINGS); |
| 186 | break; |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 187 | case EVENT_EXTERNAL_RINGER_MODE_CHANGED: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 188 | logger.action(MetricsEvent.ACTION_RINGER_MODE, |
Chris Wren | e565ee6 | 2015-06-17 15:24:56 -0400 | [diff] [blame] | 189 | (Integer) list[0]); |
| 190 | // fall through |
| 191 | case EVENT_INTERNAL_RINGER_MODE_CHANGED: |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 192 | sb.append(ringerModeToString((Integer) list[0])); |
| 193 | break; |
| 194 | case EVENT_ZEN_MODE_CHANGED: |
| 195 | sb.append(zenModeToString((Integer) list[0])); |
| 196 | break; |
| 197 | case EVENT_SUPPRESSOR_CHANGED: |
| 198 | sb.append(list[0]).append(' ').append(list[1]); |
| 199 | break; |
Sherry Huang | ce02ed3 | 2019-01-17 20:37:29 +0800 | [diff] [blame] | 200 | case EVENT_SHOW_USB_OVERHEAT_ALARM: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 201 | logger.visible(MetricsEvent.POWER_OVERHEAT_ALARM); |
| 202 | logger.histogram("show_usb_overheat_alarm", |
Sherry Huang | ce02ed3 | 2019-01-17 20:37:29 +0800 | [diff] [blame] | 203 | (Boolean) list[1] ? 1 : 0); |
| 204 | sb.append(SHOW_REASONS[(Integer) list[0]]).append(" keyguard=").append(list[1]); |
| 205 | break; |
| 206 | case EVENT_DISMISS_USB_OVERHEAT_ALARM: |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 207 | logger.hidden(MetricsEvent.POWER_OVERHEAT_ALARM); |
| 208 | logger.histogram("dismiss_usb_overheat_alarm", |
Sherry Huang | ce02ed3 | 2019-01-17 20:37:29 +0800 | [diff] [blame] | 209 | (Boolean) list[1] ? 1 : 0); |
| 210 | sb.append(DISMISS_REASONS[(Integer) list[0]]) |
| 211 | .append(" keyguard=").append(list[1]); |
| 212 | break; |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 213 | default: |
| 214 | sb.append(Arrays.asList(list)); |
| 215 | break; |
| 216 | } |
| 217 | } |
| 218 | Log.i(TAG, sb.toString()); |
| 219 | if (sCallback != null) { |
| 220 | sCallback.writeEvent(time, tag, list); |
| 221 | } |
| 222 | } |
| 223 | |
| 224 | public static void writeState(long time, State state) { |
| 225 | if (sCallback != null) { |
| 226 | sCallback.writeState(time, state); |
| 227 | } |
| 228 | } |
| 229 | |
| 230 | private static String iconStateToString(int iconState) { |
| 231 | switch (iconState) { |
| 232 | case ICON_STATE_UNMUTE: return "unmute"; |
| 233 | case ICON_STATE_MUTE: return "mute"; |
| 234 | case ICON_STATE_VIBRATE: return "vibrate"; |
| 235 | default: return "unknown_state_" + iconState; |
| 236 | } |
| 237 | } |
| 238 | |
| 239 | private static String ringerModeToString(int ringerMode) { |
| 240 | switch (ringerMode) { |
| 241 | case AudioManager.RINGER_MODE_SILENT: return "silent"; |
| 242 | case AudioManager.RINGER_MODE_VIBRATE: return "vibrate"; |
| 243 | case AudioManager.RINGER_MODE_NORMAL: return "normal"; |
| 244 | default: return "unknown"; |
| 245 | } |
| 246 | } |
| 247 | |
| 248 | private static String zenModeToString(int zenMode) { |
| 249 | switch (zenMode) { |
| 250 | case Global.ZEN_MODE_OFF: return "off"; |
| 251 | case Global.ZEN_MODE_IMPORTANT_INTERRUPTIONS: return "important_interruptions"; |
John Spurlock | 4f1163c | 2015-04-02 17:41:21 -0400 | [diff] [blame] | 252 | case Global.ZEN_MODE_ALARMS: return "alarms"; |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 253 | case Global.ZEN_MODE_NO_INTERRUPTIONS: return "no_interruptions"; |
| 254 | default: return "unknown"; |
| 255 | } |
| 256 | } |
| 257 | |
| 258 | public interface Callback { |
| 259 | void writeEvent(long time, int tag, Object[] list); |
| 260 | void writeState(long time, State state); |
| 261 | } |
Will Brockman | 1d716b2 | 2019-11-26 10:10:07 -0500 | [diff] [blame] | 262 | |
John Spurlock | f88d808 | 2015-03-25 18:09:51 -0400 | [diff] [blame] | 263 | } |