58ea43acf9
take the user to Market after clicking on "Install Voice Data" in the TTS Settings page. Launching the Activity for the installation of the TTS data should be a distinct task, dissociated from the one associated with the Settings app. Also the intent ACTION_INSTALL_TTS_DATA doesn't return a result, so the activity should be started with startActivity() rather than startActivityForResult().
428 lines
17 KiB
Java
428 lines
17 KiB
Java
/*
|
|
* Copyright (C) 2009 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.settings;
|
|
|
|
import static android.provider.Settings.Secure.TTS_USE_DEFAULTS;
|
|
import static android.provider.Settings.Secure.TTS_DEFAULT_RATE;
|
|
import static android.provider.Settings.Secure.TTS_DEFAULT_LANG;
|
|
import static android.provider.Settings.Secure.TTS_DEFAULT_COUNTRY;
|
|
import static android.provider.Settings.Secure.TTS_DEFAULT_VARIANT;
|
|
import static android.provider.Settings.Secure.TTS_DEFAULT_SYNTH;
|
|
|
|
import android.content.ContentResolver;
|
|
import android.content.Intent;
|
|
import android.content.pm.ActivityInfo;
|
|
import android.content.pm.PackageManager;
|
|
import android.content.pm.ResolveInfo;
|
|
import android.os.Bundle;
|
|
import android.preference.ListPreference;
|
|
import android.preference.Preference;
|
|
import android.preference.PreferenceActivity;
|
|
import android.preference.CheckBoxPreference;
|
|
import android.provider.Settings;
|
|
import android.provider.Settings.SettingNotFoundException;
|
|
import android.speech.tts.TextToSpeech;
|
|
import android.util.Log;
|
|
|
|
import java.util.List;
|
|
import java.util.Locale;
|
|
import java.util.StringTokenizer;
|
|
|
|
public class TextToSpeechSettings extends PreferenceActivity implements
|
|
Preference.OnPreferenceChangeListener, Preference.OnPreferenceClickListener,
|
|
TextToSpeech.OnInitListener {
|
|
|
|
private static final String TAG = "TextToSpeechSettings";
|
|
|
|
private static final String KEY_TTS_PLAY_EXAMPLE = "tts_play_example";
|
|
private static final String KEY_TTS_INSTALL_DATA = "tts_install_data";
|
|
private static final String KEY_TTS_USE_DEFAULT = "toggle_use_default_tts_settings";
|
|
private static final String KEY_TTS_DEFAULT_RATE = "tts_default_rate";
|
|
private static final String KEY_TTS_DEFAULT_LANG = "tts_default_lang";
|
|
private static final String KEY_TTS_DEFAULT_COUNTRY = "tts_default_country";
|
|
private static final String KEY_TTS_DEFAULT_VARIANT = "tts_default_variant";
|
|
// TODO move default Locale values to TextToSpeech.Engine
|
|
private static final String DEFAULT_LANG_VAL = "eng";
|
|
private static final String DEFAULT_COUNTRY_VAL = "USA";
|
|
private static final String DEFAULT_VARIANT_VAL = "";
|
|
|
|
private static final String LOCALE_DELIMITER = "-";
|
|
|
|
private static final String FALLBACK_TTS_DEFAULT_SYNTH =
|
|
TextToSpeech.Engine.DEFAULT_SYNTH;
|
|
|
|
private Preference mPlayExample = null;
|
|
private Preference mInstallData = null;
|
|
private CheckBoxPreference mUseDefaultPref = null;
|
|
private ListPreference mDefaultRatePref = null;
|
|
private ListPreference mDefaultLocPref = null;
|
|
private String mDefaultLanguage = null;
|
|
private String mDefaultCountry = null;
|
|
private String mDefaultLocVariant = null;
|
|
private String mDefaultEng = "";
|
|
private int mDefaultRate = TextToSpeech.Engine.DEFAULT_RATE;
|
|
|
|
// Array of strings used to demonstrate TTS in the different languages.
|
|
private String[] mDemoStrings;
|
|
// Index of the current string to use for the demo.
|
|
private int mDemoStringIndex = 0;
|
|
|
|
private boolean mEnableDemo = false;
|
|
|
|
private TextToSpeech mTts = null;
|
|
|
|
/**
|
|
* Request code (arbitrary value) for voice data check through
|
|
* startActivityForResult.
|
|
*/
|
|
private static final int VOICE_DATA_INTEGRITY_CHECK = 1977;
|
|
|
|
@Override
|
|
protected void onCreate(Bundle savedInstanceState) {
|
|
super.onCreate(savedInstanceState);
|
|
|
|
addPreferencesFromResource(R.xml.tts_settings);
|
|
|
|
mDemoStrings = getResources().getStringArray(R.array.tts_demo_strings);
|
|
|
|
setVolumeControlStream(TextToSpeech.Engine.DEFAULT_STREAM);
|
|
|
|
mEnableDemo = false;
|
|
initClickers();
|
|
initDefaultSettings();
|
|
}
|
|
|
|
|
|
@Override
|
|
protected void onStart() {
|
|
super.onStart();
|
|
// whenever we return to this screen, we don't know the state of the
|
|
// system, so we have to recheck that we can play the demo, or it must be disabled.
|
|
// TODO make the TTS service listen to "changes in the system", i.e. sd card un/mount
|
|
initClickers();
|
|
updateWidgetState();
|
|
checkVoiceData();
|
|
}
|
|
|
|
|
|
@Override
|
|
protected void onDestroy() {
|
|
super.onDestroy();
|
|
if (mTts != null) {
|
|
mTts.shutdown();
|
|
}
|
|
}
|
|
|
|
|
|
private void initClickers() {
|
|
mPlayExample = findPreference(KEY_TTS_PLAY_EXAMPLE);
|
|
mPlayExample.setOnPreferenceClickListener(this);
|
|
|
|
mInstallData = findPreference(KEY_TTS_INSTALL_DATA);
|
|
mInstallData.setOnPreferenceClickListener(this);
|
|
}
|
|
|
|
|
|
private void initDefaultSettings() {
|
|
ContentResolver resolver = getContentResolver();
|
|
|
|
// Find the default TTS values in the settings, initialize and store the
|
|
// settings if they are not found.
|
|
|
|
// "Use Defaults"
|
|
int useDefault = 0;
|
|
mUseDefaultPref = (CheckBoxPreference) findPreference(KEY_TTS_USE_DEFAULT);
|
|
try {
|
|
useDefault = Settings.Secure.getInt(resolver, TTS_USE_DEFAULTS);
|
|
} catch (SettingNotFoundException e) {
|
|
// "use default" setting not found, initialize it
|
|
useDefault = TextToSpeech.Engine.USE_DEFAULTS;
|
|
Settings.Secure.putInt(resolver, TTS_USE_DEFAULTS, useDefault);
|
|
}
|
|
mUseDefaultPref.setChecked(useDefault == 1);
|
|
mUseDefaultPref.setOnPreferenceChangeListener(this);
|
|
|
|
// Default engine
|
|
String engine = Settings.Secure.getString(resolver, TTS_DEFAULT_SYNTH);
|
|
if (engine == null) {
|
|
// TODO move FALLBACK_TTS_DEFAULT_SYNTH to TextToSpeech
|
|
engine = FALLBACK_TTS_DEFAULT_SYNTH;
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_SYNTH, engine);
|
|
}
|
|
mDefaultEng = engine;
|
|
|
|
// Default rate
|
|
mDefaultRatePref = (ListPreference) findPreference(KEY_TTS_DEFAULT_RATE);
|
|
try {
|
|
mDefaultRate = Settings.Secure.getInt(resolver, TTS_DEFAULT_RATE);
|
|
} catch (SettingNotFoundException e) {
|
|
// default rate setting not found, initialize it
|
|
mDefaultRate = TextToSpeech.Engine.DEFAULT_RATE;
|
|
Settings.Secure.putInt(resolver, TTS_DEFAULT_RATE, mDefaultRate);
|
|
}
|
|
mDefaultRatePref.setValue(String.valueOf(mDefaultRate));
|
|
mDefaultRatePref.setOnPreferenceChangeListener(this);
|
|
|
|
// Default language / country / variant : these three values map to a single ListPref
|
|
// representing the matching Locale
|
|
mDefaultLocPref = (ListPreference) findPreference(KEY_TTS_DEFAULT_LANG);
|
|
initDefaultLang();
|
|
mDefaultLocPref.setOnPreferenceChangeListener(this);
|
|
}
|
|
|
|
|
|
/**
|
|
* Ask the current default engine to launch the matching CHECK_TTS_DATA activity
|
|
* to check the required TTS files are properly installed.
|
|
*/
|
|
private void checkVoiceData() {
|
|
PackageManager pm = getPackageManager();
|
|
Intent intent = new Intent();
|
|
intent.setAction(TextToSpeech.Engine.ACTION_CHECK_TTS_DATA);
|
|
List<ResolveInfo> resolveInfos = pm.queryIntentActivities(intent, 0);
|
|
// query only the package that matches that of the default engine
|
|
for (int i = 0; i < resolveInfos.size(); i++) {
|
|
ActivityInfo currentActivityInfo = resolveInfos.get(i).activityInfo;
|
|
if (mDefaultEng.equals(currentActivityInfo.packageName)) {
|
|
intent.setClassName(mDefaultEng, currentActivityInfo.name);
|
|
this.startActivityForResult(intent, VOICE_DATA_INTEGRITY_CHECK);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Ask the current default engine to launch the matching INSTALL_TTS_DATA activity
|
|
* so the required TTS files are properly installed.
|
|
*/
|
|
private void installVoiceData() {
|
|
PackageManager pm = getPackageManager();
|
|
Intent intent = new Intent();
|
|
intent.setAction(TextToSpeech.Engine.ACTION_INSTALL_TTS_DATA);
|
|
intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
|
|
List<ResolveInfo> resolveInfos = pm.queryIntentActivities(intent, 0);
|
|
// query only the package that matches that of the default engine
|
|
for (int i = 0; i < resolveInfos.size(); i++) {
|
|
ActivityInfo currentActivityInfo = resolveInfos.get(i).activityInfo;
|
|
if (mDefaultEng.equals(currentActivityInfo.packageName)) {
|
|
intent.setClassName(mDefaultEng, currentActivityInfo.name);
|
|
this.startActivity(intent);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Called when the TTS engine is initialized.
|
|
*/
|
|
public void onInit(int status) {
|
|
if (status == TextToSpeech.SUCCESS) {
|
|
Log.v(TAG, "TTS engine for settings screen initialized.");
|
|
mEnableDemo = true;
|
|
mTts.setLanguage(new Locale(mDefaultLanguage, mDefaultCountry));
|
|
mTts.setSpeechRate((float)(mDefaultRate/100.0f));
|
|
} else {
|
|
Log.v(TAG, "TTS engine for settings screen failed to initialize successfully.");
|
|
mEnableDemo = false;
|
|
}
|
|
updateWidgetState();
|
|
}
|
|
|
|
|
|
/**
|
|
* Called when voice data integrity check returns
|
|
*/
|
|
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
|
|
if (requestCode == VOICE_DATA_INTEGRITY_CHECK) {
|
|
if (resultCode == TextToSpeech.Engine.CHECK_VOICE_DATA_PASS) {
|
|
Log.v(TAG, "Voice data check passed");
|
|
if (mTts == null) {
|
|
mTts = new TextToSpeech(this, this);
|
|
}
|
|
} else {
|
|
Log.v(TAG, "Voice data check failed");
|
|
mEnableDemo = false;
|
|
updateWidgetState();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
public boolean onPreferenceChange(Preference preference, Object objValue) {
|
|
if (KEY_TTS_USE_DEFAULT.equals(preference.getKey())) {
|
|
// "Use Defaults"
|
|
int value = (Boolean)objValue ? 1 : 0;
|
|
Settings.Secure.putInt(getContentResolver(), TTS_USE_DEFAULTS,
|
|
value);
|
|
Log.i(TAG, "TTS use default settings is "+objValue.toString());
|
|
} else if (KEY_TTS_DEFAULT_RATE.equals(preference.getKey())) {
|
|
// Default rate
|
|
mDefaultRate = Integer.parseInt((String) objValue);
|
|
try {
|
|
Settings.Secure.putInt(getContentResolver(),
|
|
TTS_DEFAULT_RATE, mDefaultRate);
|
|
if (mTts != null) {
|
|
mTts.setSpeechRate((float)(mDefaultRate/100.0f));
|
|
}
|
|
Log.i(TAG, "TTS default rate is " + mDefaultRate);
|
|
} catch (NumberFormatException e) {
|
|
Log.e(TAG, "could not persist default TTS rate setting", e);
|
|
}
|
|
} else if (KEY_TTS_DEFAULT_LANG.equals(preference.getKey())) {
|
|
// Default locale
|
|
ContentResolver resolver = getContentResolver();
|
|
parseLocaleInfo((String) objValue);
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_LANG, mDefaultLanguage);
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_COUNTRY, mDefaultCountry);
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_VARIANT, mDefaultLocVariant);
|
|
Log.v(TAG, "TTS default lang/country/variant set to "
|
|
+ mDefaultLanguage + "/" + mDefaultCountry + "/" + mDefaultLocVariant);
|
|
if (mTts != null) {
|
|
mTts.setLanguage(new Locale(mDefaultLanguage, mDefaultCountry));
|
|
}
|
|
int newIndex = mDefaultLocPref.findIndexOfValue((String)objValue);
|
|
Log.v("Settings", " selected is " + newIndex);
|
|
mDemoStringIndex = newIndex > -1 ? newIndex : 0;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Called when mPlayExample or mInstallData is clicked
|
|
*/
|
|
public boolean onPreferenceClick(Preference preference) {
|
|
if (preference == mPlayExample) {
|
|
// Play example
|
|
if (mTts != null) {
|
|
mTts.speak(mDemoStrings[mDemoStringIndex], TextToSpeech.QUEUE_FLUSH, null);
|
|
}
|
|
return true;
|
|
}
|
|
if (preference == mInstallData) {
|
|
installVoiceData();
|
|
// quit this activity so it needs to be restarted after installation of the voice data
|
|
finish();
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
|
|
private void updateWidgetState() {
|
|
mPlayExample.setEnabled(mEnableDemo);
|
|
mUseDefaultPref.setEnabled(mEnableDemo);
|
|
mDefaultRatePref.setEnabled(mEnableDemo);
|
|
mDefaultLocPref.setEnabled(mEnableDemo);
|
|
|
|
mInstallData.setEnabled(!mEnableDemo);
|
|
}
|
|
|
|
|
|
private void parseLocaleInfo(String locale) {
|
|
StringTokenizer tokenizer = new StringTokenizer(locale, LOCALE_DELIMITER);
|
|
mDefaultLanguage = "";
|
|
mDefaultCountry = "";
|
|
mDefaultLocVariant = "";
|
|
if (tokenizer.hasMoreTokens()) {
|
|
mDefaultLanguage = tokenizer.nextToken().trim();
|
|
}
|
|
if (tokenizer.hasMoreTokens()) {
|
|
mDefaultCountry = tokenizer.nextToken().trim();
|
|
}
|
|
if (tokenizer.hasMoreTokens()) {
|
|
mDefaultLocVariant = tokenizer.nextToken().trim();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Initialize the default language in the UI and in the preferences.
|
|
* After this method has been invoked, the default language is a supported Locale.
|
|
*/
|
|
private void initDefaultLang() {
|
|
// if there isn't already a default language preference
|
|
if (!hasLangPref()) {
|
|
// if the current Locale is supported
|
|
if (isCurrentLocSupported()) {
|
|
// then use the current Locale as the default language
|
|
useCurrentLocAsDefault();
|
|
} else {
|
|
// otherwise use a default supported Locale as the default language
|
|
useSupportedLocAsDefault();
|
|
}
|
|
}
|
|
|
|
// Update the language preference list with the default language and the matching
|
|
// demo string (at this stage there is a default language pref)
|
|
ContentResolver resolver = getContentResolver();
|
|
mDefaultLanguage = Settings.Secure.getString(resolver, TTS_DEFAULT_LANG);
|
|
mDefaultCountry = Settings.Secure.getString(resolver, KEY_TTS_DEFAULT_COUNTRY);
|
|
mDefaultLocVariant = Settings.Secure.getString(resolver, KEY_TTS_DEFAULT_VARIANT);
|
|
|
|
// update the demo string
|
|
mDemoStringIndex = mDefaultLocPref.findIndexOfValue(mDefaultLanguage + LOCALE_DELIMITER
|
|
+ mDefaultCountry);
|
|
mDefaultLocPref.setValueIndex(mDemoStringIndex);
|
|
}
|
|
|
|
/**
|
|
* (helper function for initDefaultLang() )
|
|
* Returns whether there is a default language in the TTS settings.
|
|
*/
|
|
private boolean hasLangPref() {
|
|
String language = Settings.Secure.getString(getContentResolver(), TTS_DEFAULT_LANG);
|
|
return (language != null);
|
|
}
|
|
|
|
/**
|
|
* (helper function for initDefaultLang() )
|
|
* Returns whether the current Locale is supported by this Settings screen
|
|
*/
|
|
private boolean isCurrentLocSupported() {
|
|
String currentLocID = Locale.getDefault().getISO3Language() + LOCALE_DELIMITER
|
|
+ Locale.getDefault().getISO3Country();
|
|
return (mDefaultLocPref.findIndexOfValue(currentLocID) > -1);
|
|
}
|
|
|
|
/**
|
|
* (helper function for initDefaultLang() )
|
|
* Sets the default language in TTS settings to be the current Locale.
|
|
* This should only be used after checking that the current Locale is supported.
|
|
*/
|
|
private void useCurrentLocAsDefault() {
|
|
Locale currentLocale = Locale.getDefault();
|
|
ContentResolver resolver = getContentResolver();
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_LANG, currentLocale.getISO3Language());
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_COUNTRY, currentLocale.getISO3Country());
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_VARIANT, currentLocale.getVariant());
|
|
}
|
|
|
|
/**
|
|
* (helper function for initDefaultLang() )
|
|
* Sets the default language in TTS settings to be one known to be supported
|
|
*/
|
|
private void useSupportedLocAsDefault() {
|
|
ContentResolver resolver = getContentResolver();
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_LANG, DEFAULT_LANG_VAL);
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_COUNTRY, DEFAULT_COUNTRY_VAL);
|
|
Settings.Secure.putString(resolver, TTS_DEFAULT_VARIANT, DEFAULT_VARIANT_VAL);
|
|
}
|
|
|
|
}
|