Home | History | Annotate | Download | only in volume
      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.content.Context;
     20 import android.media.AudioManager;
     21 import android.media.AudioSystem;
     22 import android.provider.Settings.Global;
     23 import android.util.Log;
     24 
     25 import com.android.internal.logging.MetricsLogger;
     26 import com.android.internal.logging.nano.MetricsProto.MetricsEvent;
     27 import com.android.systemui.plugins.VolumeDialogController.State;
     28 
     29 import java.util.Arrays;
     30 
     31 /**
     32  *  Interesting events related to the volume.
     33  */
     34 public class Events {
     35     private static final String TAG = Util.logTag(Events.class);
     36 
     37     public static final int EVENT_SHOW_DIALOG = 0;  // (reason|int) (keyguard|bool)
     38     public static final int EVENT_DISMISS_DIALOG = 1; // (reason|int)
     39     public static final int EVENT_ACTIVE_STREAM_CHANGED = 2; // (stream|int)
     40     public static final int EVENT_EXPAND = 3; // (expand|bool)
     41     public static final int EVENT_KEY = 4;
     42     public static final int EVENT_COLLECTION_STARTED = 5;
     43     public static final int EVENT_COLLECTION_STOPPED = 6;
     44     public static final int EVENT_ICON_CLICK = 7; // (stream|int) (icon_state|int)
     45     public static final int EVENT_SETTINGS_CLICK = 8;
     46     public static final int EVENT_TOUCH_LEVEL_CHANGED = 9; // (stream|int) (level|int)
     47     public static final int EVENT_LEVEL_CHANGED = 10; // (stream|int) (level|int)
     48     public static final int EVENT_INTERNAL_RINGER_MODE_CHANGED = 11; // (mode|int)
     49     public static final int EVENT_EXTERNAL_RINGER_MODE_CHANGED = 12; // (mode|int)
     50     public static final int EVENT_ZEN_MODE_CHANGED = 13; // (mode|int)
     51     public static final int EVENT_SUPPRESSOR_CHANGED = 14;  // (component|string) (name|string)
     52     public static final int EVENT_MUTE_CHANGED = 15;  // (stream|int) (muted|bool)
     53     public static final int EVENT_TOUCH_LEVEL_DONE = 16;  // (stream|int) (level|bool)
     54     public static final int EVENT_ZEN_CONFIG_CHANGED = 17; // (allow/disallow|string)
     55     public static final int EVENT_RINGER_TOGGLE = 18; // (ringer_mode)
     56 
     57     private static final String[] EVENT_TAGS = {
     58             "show_dialog",
     59             "dismiss_dialog",
     60             "active_stream_changed",
     61             "expand",
     62             "key",
     63             "collection_started",
     64             "collection_stopped",
     65             "icon_click",
     66             "settings_click",
     67             "touch_level_changed",
     68             "level_changed",
     69             "internal_ringer_mode_changed",
     70             "external_ringer_mode_changed",
     71             "zen_mode_changed",
     72             "suppressor_changed",
     73             "mute_changed",
     74             "touch_level_done",
     75             "zen_mode_config_changed",
     76             "ringer_toggle"
     77     };
     78 
     79     public static final int DISMISS_REASON_UNKNOWN = 0;
     80     public static final int DISMISS_REASON_TOUCH_OUTSIDE = 1;
     81     public static final int DISMISS_REASON_VOLUME_CONTROLLER = 2;
     82     public static final int DISMISS_REASON_TIMEOUT = 3;
     83     public static final int DISMISS_REASON_SCREEN_OFF = 4;
     84     public static final int DISMISS_REASON_SETTINGS_CLICKED = 5;
     85     public static final int DISMISS_REASON_DONE_CLICKED = 6;
     86     public static final int DISMISS_STREAM_GONE = 7;
     87     public static final int DISMISS_REASON_OUTPUT_CHOOSER = 8;
     88     public static final String[] DISMISS_REASONS = {
     89             "unknown",
     90             "touch_outside",
     91             "volume_controller",
     92             "timeout",
     93             "screen_off",
     94             "settings_clicked",
     95             "done_clicked",
     96             "a11y_stream_changed",
     97             "output_chooser"
     98     };
     99 
    100     public static final int SHOW_REASON_UNKNOWN = 0;
    101     public static final int SHOW_REASON_VOLUME_CHANGED = 1;
    102     public static final int SHOW_REASON_REMOTE_VOLUME_CHANGED = 2;
    103     public static final String[] SHOW_REASONS = {
    104         "unknown",
    105         "volume_changed",
    106         "remote_volume_changed"
    107     };
    108 
    109     public static final int ICON_STATE_UNKNOWN = 0;
    110     public static final int ICON_STATE_UNMUTE = 1;
    111     public static final int ICON_STATE_MUTE = 2;
    112     public static final int ICON_STATE_VIBRATE = 3;
    113 
    114     public static Callback sCallback;
    115 
    116     public static void writeEvent(Context context, int tag, Object... list) {
    117         MetricsLogger logger = new MetricsLogger();
    118         final long time = System.currentTimeMillis();
    119         final StringBuilder sb = new StringBuilder("writeEvent ").append(EVENT_TAGS[tag]);
    120         if (list != null && list.length > 0) {
    121             sb.append(" ");
    122             switch (tag) {
    123                 case EVENT_SHOW_DIALOG:
    124                     MetricsLogger.visible(context, MetricsEvent.VOLUME_DIALOG);
    125                     MetricsLogger.histogram(context, "volume_from_keyguard",
    126                             (Boolean) list[1] ? 1 : 0);
    127                     sb.append(SHOW_REASONS[(Integer) list[0]]).append(" keyguard=").append(list[1]);
    128                     break;
    129                 case EVENT_EXPAND:
    130                     MetricsLogger.visibility(context, MetricsEvent.VOLUME_DIALOG_DETAILS,
    131                             (Boolean) list[0]);
    132                     sb.append(list[0]);
    133                     break;
    134                 case EVENT_DISMISS_DIALOG:
    135                     MetricsLogger.hidden(context, MetricsEvent.VOLUME_DIALOG);
    136                     sb.append(DISMISS_REASONS[(Integer) list[0]]);
    137                     break;
    138                 case EVENT_ACTIVE_STREAM_CHANGED:
    139                     MetricsLogger.action(context, MetricsEvent.ACTION_VOLUME_STREAM,
    140                             (Integer) list[0]);
    141                     sb.append(AudioSystem.streamToString((Integer) list[0]));
    142                     break;
    143                 case EVENT_ICON_CLICK:
    144                     MetricsLogger.action(context, MetricsEvent.ACTION_VOLUME_ICON,
    145                             (Integer) list[0]);
    146                     sb.append(AudioSystem.streamToString((Integer) list[0])).append(' ')
    147                             .append(iconStateToString((Integer) list[1]));
    148                     break;
    149                 case EVENT_TOUCH_LEVEL_DONE:
    150                     MetricsLogger.action(context, MetricsEvent.ACTION_VOLUME_SLIDER,
    151                             (Integer) list[1]);
    152                     // fall through
    153                 case EVENT_TOUCH_LEVEL_CHANGED:
    154                 case EVENT_LEVEL_CHANGED:
    155                 case EVENT_MUTE_CHANGED:
    156                     sb.append(AudioSystem.streamToString((Integer) list[0])).append(' ')
    157                             .append(list[1]);
    158                     break;
    159                 case EVENT_KEY:
    160                     MetricsLogger.action(context, MetricsEvent.ACTION_VOLUME_KEY,
    161                             (Integer) list[0]);
    162                     sb.append(AudioSystem.streamToString((Integer) list[0])).append(' ')
    163                             .append(list[1]);
    164                     break;
    165                 case EVENT_RINGER_TOGGLE:
    166                     logger.action(MetricsEvent.ACTION_VOLUME_RINGER_TOGGLE, (Integer) list[0]);
    167                     break;
    168                 case EVENT_SETTINGS_CLICK:
    169                     logger.action(MetricsEvent.ACTION_VOLUME_SETTINGS);
    170                     break;
    171                 case EVENT_EXTERNAL_RINGER_MODE_CHANGED:
    172                     MetricsLogger.action(context, MetricsEvent.ACTION_RINGER_MODE,
    173                             (Integer) list[0]);
    174                     // fall through
    175                 case EVENT_INTERNAL_RINGER_MODE_CHANGED:
    176                     sb.append(ringerModeToString((Integer) list[0]));
    177                     break;
    178                 case EVENT_ZEN_MODE_CHANGED:
    179                     sb.append(zenModeToString((Integer) list[0]));
    180                     break;
    181                 case EVENT_SUPPRESSOR_CHANGED:
    182                     sb.append(list[0]).append(' ').append(list[1]);
    183                     break;
    184                 default:
    185                     sb.append(Arrays.asList(list));
    186                     break;
    187             }
    188         }
    189         Log.i(TAG, sb.toString());
    190         if (sCallback != null) {
    191             sCallback.writeEvent(time, tag, list);
    192         }
    193     }
    194 
    195     public static void writeState(long time, State state) {
    196         if (sCallback != null) {
    197             sCallback.writeState(time, state);
    198         }
    199     }
    200 
    201     private static String iconStateToString(int iconState) {
    202         switch (iconState) {
    203             case ICON_STATE_UNMUTE: return "unmute";
    204             case ICON_STATE_MUTE: return "mute";
    205             case ICON_STATE_VIBRATE: return "vibrate";
    206             default: return "unknown_state_" + iconState;
    207         }
    208     }
    209 
    210     private static String ringerModeToString(int ringerMode) {
    211         switch (ringerMode) {
    212             case AudioManager.RINGER_MODE_SILENT: return "silent";
    213             case AudioManager.RINGER_MODE_VIBRATE: return "vibrate";
    214             case AudioManager.RINGER_MODE_NORMAL: return "normal";
    215             default: return "unknown";
    216         }
    217     }
    218 
    219     private static String zenModeToString(int zenMode) {
    220         switch (zenMode) {
    221             case Global.ZEN_MODE_OFF: return "off";
    222             case Global.ZEN_MODE_IMPORTANT_INTERRUPTIONS: return "important_interruptions";
    223             case Global.ZEN_MODE_ALARMS: return "alarms";
    224             case Global.ZEN_MODE_NO_INTERRUPTIONS: return "no_interruptions";
    225             default: return "unknown";
    226         }
    227     }
    228 
    229     public interface Callback {
    230         void writeEvent(long time, int tag, Object[] list);
    231         void writeState(long time, State state);
    232     }
    233 }
    234