SoundSettings.java revision b3e6afe029a852d50bcba4dd6eca0d831db9d771 
1/*
2 * Copyright (C) 2007 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
17package com.android.settings;
18
19import android.content.BroadcastReceiver;
20import android.content.ContentResolver;
21import android.content.Context;
22import android.content.Intent;
23import android.content.IntentFilter;
24import android.content.pm.PackageManager;
25import android.content.pm.ResolveInfo;
26import android.database.Cursor;
27import android.database.sqlite.SQLiteException;
28import android.media.AudioManager;
29import android.media.Ringtone;
30import android.media.RingtoneManager;
31import android.media.audiofx.AudioEffect;
32import android.net.Uri;
33import android.os.Bundle;
34import android.os.Handler;
35import android.os.Message;
36import android.os.Vibrator;
37import android.preference.CheckBoxPreference;
38import android.preference.ListPreference;
39import android.preference.Preference;
40import android.preference.PreferenceGroup;
41import android.preference.PreferenceScreen;
42import android.provider.MediaStore;
43import android.provider.Settings;
44import android.provider.MediaStore.Images.Media;
45import android.provider.Settings.SettingNotFoundException;
46import android.telephony.TelephonyManager;
47import android.util.Log;
48
49import java.util.List;
50
51public class SoundSettings extends SettingsPreferenceFragment implements
52        Preference.OnPreferenceChangeListener {
53    private static final String TAG = "SoundSettings";
54
55    /** If there is no setting in the provider, use this. */
56    private static final int FALLBACK_EMERGENCY_TONE_VALUE = 0;
57
58    private static final String KEY_SILENT_MODE = "silent_mode";
59    private static final String KEY_VIBRATE = "vibrate_on_ring";
60    private static final String KEY_RING_VOLUME = "ring_volume";
61    private static final String KEY_MUSICFX = "musicfx";
62    private static final String KEY_DTMF_TONE = "dtmf_tone";
63    private static final String KEY_SOUND_EFFECTS = "sound_effects";
64    private static final String KEY_HAPTIC_FEEDBACK = "haptic_feedback";
65    private static final String KEY_EMERGENCY_TONE = "emergency_tone";
66    private static final String KEY_SOUND_SETTINGS = "sound_settings";
67    private static final String KEY_LOCK_SOUNDS = "lock_sounds";
68    private static final String KEY_RINGTONE = "ringtone";
69    private static final String KEY_NOTIFICATION_SOUND = "notification_sound";
70    private static final String KEY_CATEGORY_CALLS = "category_calls";
71
72    private static final String SILENT_MODE_OFF = "off";
73    private static final String SILENT_MODE_VIBRATE = "vibrate";
74    private static final String SILENT_MODE_MUTE = "mute";
75
76    private static final String[] NEED_VOICE_CAPABILITY = {
77            KEY_RINGTONE, KEY_DTMF_TONE, KEY_CATEGORY_CALLS,
78            KEY_EMERGENCY_TONE
79    };
80
81    private static final int MSG_UPDATE_RINGTONE_SUMMARY = 1;
82    private static final int MSG_UPDATE_NOTIFICATION_SUMMARY = 2;
83
84    private CheckBoxPreference mVibrateOnRing;
85    private ListPreference mSilentMode;
86    private CheckBoxPreference mDtmfTone;
87    private CheckBoxPreference mSoundEffects;
88    private CheckBoxPreference mHapticFeedback;
89    private Preference mMusicFx;
90    private CheckBoxPreference mLockSounds;
91    private Preference mRingtonePreference;
92    private Preference mNotificationPreference;
93
94    private Runnable mRingtoneLookupRunnable;
95
96    private AudioManager mAudioManager;
97
98    private BroadcastReceiver mReceiver = new BroadcastReceiver() {
99        @Override
100        public void onReceive(Context context, Intent intent) {
101            if (intent.getAction().equals(AudioManager.RINGER_MODE_CHANGED_ACTION)) {
102                updateState(false);
103            }
104        }
105    };
106
107    private Handler mHandler = new Handler() {
108        public void handleMessage(Message msg) {
109            switch (msg.what) {
110            case MSG_UPDATE_RINGTONE_SUMMARY:
111                mRingtonePreference.setSummary((CharSequence) msg.obj);
112                break;
113            case MSG_UPDATE_NOTIFICATION_SUMMARY:
114                mNotificationPreference.setSummary((CharSequence) msg.obj);
115                break;
116            }
117        }
118    };
119
120    private PreferenceGroup mSoundSettings;
121
122    @Override
123    public void onCreate(Bundle savedInstanceState) {
124        super.onCreate(savedInstanceState);
125        ContentResolver resolver = getContentResolver();
126        int activePhoneType = TelephonyManager.getDefault().getCurrentPhoneType();
127
128        mAudioManager = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
129
130        addPreferencesFromResource(R.xml.sound_settings);
131
132        if (TelephonyManager.PHONE_TYPE_CDMA != activePhoneType) {
133            // device is not CDMA, do not display CDMA emergency_tone
134            getPreferenceScreen().removePreference(findPreference(KEY_EMERGENCY_TONE));
135        }
136
137        mSilentMode = (ListPreference) findPreference(KEY_SILENT_MODE);
138        if (!getResources().getBoolean(R.bool.has_silent_mode)) {
139            getPreferenceScreen().removePreference(mSilentMode);
140            findPreference(KEY_RING_VOLUME).setDependency(null);
141        } else {
142            mSilentMode.setOnPreferenceChangeListener(this);
143        }
144
145        mVibrateOnRing = (CheckBoxPreference) findPreference(KEY_VIBRATE);
146        mVibrateOnRing.setOnPreferenceChangeListener(this);
147
148        mDtmfTone = (CheckBoxPreference) findPreference(KEY_DTMF_TONE);
149        mDtmfTone.setPersistent(false);
150        mDtmfTone.setChecked(Settings.System.getInt(resolver,
151                Settings.System.DTMF_TONE_WHEN_DIALING, 1) != 0);
152        mSoundEffects = (CheckBoxPreference) findPreference(KEY_SOUND_EFFECTS);
153        mSoundEffects.setPersistent(false);
154        mSoundEffects.setChecked(Settings.System.getInt(resolver,
155                Settings.System.SOUND_EFFECTS_ENABLED, 1) != 0);
156        mHapticFeedback = (CheckBoxPreference) findPreference(KEY_HAPTIC_FEEDBACK);
157        mHapticFeedback.setPersistent(false);
158        mHapticFeedback.setChecked(Settings.System.getInt(resolver,
159                Settings.System.HAPTIC_FEEDBACK_ENABLED, 1) != 0);
160        mLockSounds = (CheckBoxPreference) findPreference(KEY_LOCK_SOUNDS);
161        mLockSounds.setPersistent(false);
162        mLockSounds.setChecked(Settings.System.getInt(resolver,
163                Settings.System.LOCKSCREEN_SOUNDS_ENABLED, 1) != 0);
164
165        mRingtonePreference = findPreference(KEY_RINGTONE);
166        mNotificationPreference = findPreference(KEY_NOTIFICATION_SOUND);
167
168        if (!((Vibrator) getSystemService(Context.VIBRATOR_SERVICE)).hasVibrator()) {
169            getPreferenceScreen().removePreference(mVibrateOnRing);
170            getPreferenceScreen().removePreference(mHapticFeedback);
171        }
172
173        if (TelephonyManager.PHONE_TYPE_CDMA == activePhoneType) {
174            ListPreference emergencyTonePreference =
175                (ListPreference) findPreference(KEY_EMERGENCY_TONE);
176            emergencyTonePreference.setValue(String.valueOf(Settings.System.getInt(
177                resolver, Settings.System.EMERGENCY_TONE, FALLBACK_EMERGENCY_TONE_VALUE)));
178            emergencyTonePreference.setOnPreferenceChangeListener(this);
179        }
180
181        mSoundSettings = (PreferenceGroup) findPreference(KEY_SOUND_SETTINGS);
182
183        mMusicFx = mSoundSettings.findPreference(KEY_MUSICFX);
184        Intent i = new Intent(AudioEffect.ACTION_DISPLAY_AUDIO_EFFECT_CONTROL_PANEL);
185        PackageManager p = getPackageManager();
186        List<ResolveInfo> ris = p.queryIntentActivities(i, PackageManager.GET_DISABLED_COMPONENTS);
187        if (ris.size() <= 2) {
188            // no need to show the item if there is no choice for the user to make
189            // note: the built in musicfx panel has two activities (one being a
190            // compatibility shim that launches either the other activity, or a
191            // third party one), hence the check for <=2. If the implementation
192            // of the compatbility layer changes, this check may need to be updated.
193            mSoundSettings.removePreference(mMusicFx);
194        }
195
196        if (!Utils.isVoiceCapable(getActivity())) {
197            for (String prefKey : NEED_VOICE_CAPABILITY) {
198                Preference pref = findPreference(prefKey);
199                if (pref != null) {
200                    getPreferenceScreen().removePreference(pref);
201                }
202            }
203        }
204
205        mRingtoneLookupRunnable = new Runnable() {
206            public void run() {
207                if (mRingtonePreference != null) {
208                    updateRingtoneName(RingtoneManager.TYPE_RINGTONE, mRingtonePreference,
209                            MSG_UPDATE_RINGTONE_SUMMARY);
210                }
211                if (mNotificationPreference != null) {
212                    updateRingtoneName(RingtoneManager.TYPE_NOTIFICATION, mNotificationPreference,
213                            MSG_UPDATE_NOTIFICATION_SUMMARY);
214                }
215            }
216        };
217    }
218
219    @Override
220    public void onResume() {
221        super.onResume();
222
223        updateState(true);
224        lookupRingtoneNames();
225
226        IntentFilter filter = new IntentFilter(AudioManager.RINGER_MODE_CHANGED_ACTION);
227        getActivity().registerReceiver(mReceiver, filter);
228    }
229
230    @Override
231    public void onPause() {
232        super.onPause();
233
234        getActivity().unregisterReceiver(mReceiver);
235    }
236
237    /**
238     * Put the audio system into the correct vibrate setting
239     */
240    private void setPhoneVibrateSettingValue(boolean vibeOnRing) {
241        // If vibrate-on-ring is checked, use VIBRATE_SETTING_ON
242        // Otherwise vibrate is off when ringer is silent
243        int vibrateMode = vibeOnRing ? AudioManager.VIBRATE_SETTING_ON
244                : AudioManager.VIBRATE_SETTING_ONLY_SILENT;
245        mAudioManager.setVibrateSetting(AudioManager.VIBRATE_TYPE_RINGER, vibrateMode);
246        mAudioManager.setVibrateSetting(AudioManager.VIBRATE_TYPE_NOTIFICATION, vibrateMode);
247    }
248
249    private void setPhoneSilentSettingValue(String value) {
250        int ringerMode = AudioManager.RINGER_MODE_NORMAL;
251        if (value.equals(SILENT_MODE_MUTE)) {
252            ringerMode = AudioManager.RINGER_MODE_SILENT;
253        } else if (value.equals(SILENT_MODE_VIBRATE)) {
254            ringerMode = AudioManager.RINGER_MODE_VIBRATE;
255        }
256        mAudioManager.setRingerMode(ringerMode);
257    }
258
259    private String getPhoneSilentModeSettingValue() {
260        switch (mAudioManager.getRingerMode()) {
261        case AudioManager.RINGER_MODE_NORMAL:
262            return SILENT_MODE_OFF;
263        case AudioManager.RINGER_MODE_VIBRATE:
264            return SILENT_MODE_VIBRATE;
265        case AudioManager.RINGER_MODE_SILENT:
266            return SILENT_MODE_MUTE;
267        }
268        // Shouldn't happen
269        return SILENT_MODE_OFF;
270    }
271
272    // updateState in fact updates the UI to reflect the system state
273    private void updateState(boolean force) {
274        if (getActivity() == null) return;
275
276        final int vibrateMode = mAudioManager.getVibrateSetting(AudioManager.VIBRATE_TYPE_RINGER);
277
278        mVibrateOnRing.setChecked(vibrateMode == AudioManager.VIBRATE_SETTING_ON);
279        mSilentMode.setValue(getPhoneSilentModeSettingValue());
280
281        mSilentMode.setSummary(mSilentMode.getEntry());
282    }
283
284    private void updateRingtoneName(int type, Preference preference, int msg) {
285        if (preference == null) return;
286        Context context = getActivity();
287        if (context == null) return;
288        Uri ringtoneUri = RingtoneManager.getActualDefaultRingtoneUri(context, type);
289        CharSequence summary = context.getString(com.android.internal.R.string.ringtone_unknown);
290        // Is it a silent ringtone?
291        if (ringtoneUri == null) {
292            summary = context.getString(com.android.internal.R.string.ringtone_silent);
293        } else {
294            // Fetch the ringtone title from the media provider
295            try {
296                Cursor cursor = context.getContentResolver().query(ringtoneUri,
297                        new String[] { MediaStore.Audio.Media.TITLE }, null, null, null);
298                if (cursor != null) {
299                    if (cursor.moveToFirst()) {
300                        summary = cursor.getString(0);
301                    }
302                    cursor.close();
303                }
304            } catch (SQLiteException sqle) {
305                // Unknown title for the ringtone
306            }
307        }
308        mHandler.sendMessage(mHandler.obtainMessage(msg, summary));
309    }
310
311    private void lookupRingtoneNames() {
312        new Thread(mRingtoneLookupRunnable).start();
313    }
314
315    @Override
316    public boolean onPreferenceTreeClick(PreferenceScreen preferenceScreen, Preference preference) {
317        if (preference == mDtmfTone) {
318            Settings.System.putInt(getContentResolver(), Settings.System.DTMF_TONE_WHEN_DIALING,
319                    mDtmfTone.isChecked() ? 1 : 0);
320
321        } else if (preference == mSoundEffects) {
322            if (mSoundEffects.isChecked()) {
323                mAudioManager.loadSoundEffects();
324            } else {
325                mAudioManager.unloadSoundEffects();
326            }
327            Settings.System.putInt(getContentResolver(), Settings.System.SOUND_EFFECTS_ENABLED,
328                    mSoundEffects.isChecked() ? 1 : 0);
329
330        } else if (preference == mHapticFeedback) {
331            Settings.System.putInt(getContentResolver(), Settings.System.HAPTIC_FEEDBACK_ENABLED,
332                    mHapticFeedback.isChecked() ? 1 : 0);
333
334        } else if (preference == mLockSounds) {
335            Settings.System.putInt(getContentResolver(), Settings.System.LOCKSCREEN_SOUNDS_ENABLED,
336                    mLockSounds.isChecked() ? 1 : 0);
337
338        } else if (preference == mMusicFx) {
339            // let the framework fire off the intent
340            return false;
341        }
342
343        return true;
344    }
345
346    public boolean onPreferenceChange(Preference preference, Object objValue) {
347        final String key = preference.getKey();
348        if (KEY_EMERGENCY_TONE.equals(key)) {
349            try {
350                int value = Integer.parseInt((String) objValue);
351                Settings.System.putInt(getContentResolver(),
352                        Settings.System.EMERGENCY_TONE, value);
353            } catch (NumberFormatException e) {
354                Log.e(TAG, "could not persist emergency tone setting", e);
355            }
356        } else if (preference == mVibrateOnRing) {
357            setPhoneVibrateSettingValue((Boolean) objValue);
358        } else if (preference == mSilentMode) {
359            setPhoneSilentSettingValue(objValue.toString());
360        }
361
362        return true;
363    }
364}
365