13da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov/* 23da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Copyright (C) 2010 The Android Open Source Project 33da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 43da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Licensed under the Apache License, Version 2.0 (the "License"); you may not 53da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * use this file except in compliance with the License. You may obtain a copy of 63da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * the License at 73da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 83da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * http://www.apache.org/licenses/LICENSE-2.0 93da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 103da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Unless required by applicable law or agreed to in writing, software 113da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 123da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 133da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * License for the specific language governing permissions and limitations under 143da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * the License. 153da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 163da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 173da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovpackage android.speech; 183da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 19378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeauimport android.annotation.SdkConstant; 20378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeauimport android.annotation.SdkConstant.SdkConstantType; 213da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovimport android.app.Service; 223da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovimport android.content.Intent; 233da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovimport android.content.pm.PackageManager; 243da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovimport android.os.Bundle; 253da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovimport android.os.Handler; 263da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovimport android.os.IBinder; 273da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovimport android.os.Message; 283da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovimport android.os.RemoteException; 293da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovimport android.util.Log; 303da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 3196156979022a6e1af4b29051aedd0d8e237018e8Jeff Brownimport java.lang.ref.WeakReference; 3296156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown 333da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov/** 343da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * This class provides a base class for recognition service implementations. This class should be 352f853ea47a194680657ddc2cc54336a14f38b8baMike LeBeau * extended only in case you wish to implement a new speech recognizer. Please note that the 362f853ea47a194680657ddc2cc54336a14f38b8baMike LeBeau * implementation of this service is stateless. 373da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 383da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovpublic abstract class RecognitionService extends Service { 39378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau /** 40378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau * The {@link Intent} that must be declared as handled by the service. 41378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau */ 42378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau @SdkConstant(SdkConstantType.SERVICE_ACTION) 43378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau public static final String SERVICE_INTERFACE = "android.speech.RecognitionService"; 44378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau 45378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau /** 46378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau * Name under which a RecognitionService component publishes information about itself. 47378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau * This meta-data should reference an XML resource containing a 48378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau * <code><{@link android.R.styleable#RecognitionService recognition-service}></code> tag. 49378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau */ 50378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau public static final String SERVICE_META_DATA = "android.speech"; 513da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 523da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** Log messages identifier */ 533da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final String TAG = "RecognitionService"; 543da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 553da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** Debugging flag */ 563da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final boolean DBG = false; 573da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 581c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov /** Binder of the recognition service */ 591c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov private RecognitionServiceBinder mBinder = new RecognitionServiceBinder(this); 601c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov 613da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 623da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The current callback of an application that invoked the 633da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * {@link RecognitionService#onStartListening(Intent, Callback)} method 643da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 653da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private Callback mCurrentCallback = null; 663da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 673da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final int MSG_START_LISTENING = 1; 683da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 693da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final int MSG_STOP_LISTENING = 2; 703da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 713da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final int MSG_CANCEL = 3; 723da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 73483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov private static final int MSG_RESET = 4; 74483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov 753da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private final Handler mHandler = new Handler() { 763da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov @Override 773da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void handleMessage(Message msg) { 783da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov switch (msg.what) { 793da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov case MSG_START_LISTENING: 803da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov StartListeningArgs args = (StartListeningArgs) msg.obj; 813da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov dispatchStartListening(args.mIntent, args.mListener); 823da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov break; 833da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov case MSG_STOP_LISTENING: 843da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov dispatchStopListening((IRecognitionListener) msg.obj); 853da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov break; 863da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov case MSG_CANCEL: 873da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov dispatchCancel((IRecognitionListener) msg.obj); 88483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov break; 89483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov case MSG_RESET: 90483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov dispatchClearCallback(); 91483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov break; 923da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 933da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 943da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov }; 953da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 96c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet private void dispatchStartListening(Intent intent, final IRecognitionListener listener) { 973da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (mCurrentCallback == null) { 983da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "created new mCurrentCallback, listener = " + listener.asBinder()); 99c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet try { 100c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet listener.asBinder().linkToDeath(new IBinder.DeathRecipient() { 101c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet @Override 102c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet public void binderDied() { 103c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet mHandler.sendMessage(mHandler.obtainMessage(MSG_CANCEL, listener)); 104c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet } 105c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet }, 0); 106c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet } catch (RemoteException re) { 107c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet Log.e(TAG, "dead listener on startListening"); 108c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet return; 109c1fb6dc1a494d73a080348d16b96e70f5735e036Jerome Poichet } 1103da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mCurrentCallback = new Callback(listener); 1113da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov RecognitionService.this.onStartListening(intent, mCurrentCallback); 1123da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else { 1133da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov try { 1142a5d9f9b577376768372837723f0f42098aba13bJean-Michel Trivi listener.onError(SpeechRecognizer.ERROR_RECOGNIZER_BUSY); 1153da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } catch (RemoteException e) { 1163da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.d(TAG, "onError call from startListening failed"); 1173da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1183da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.i(TAG, "concurrent startListening received - ignoring this call"); 1193da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1203da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1213da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1223da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private void dispatchStopListening(IRecognitionListener listener) { 1233da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov try { 1243da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (mCurrentCallback == null) { 1252a5d9f9b577376768372837723f0f42098aba13bJean-Michel Trivi listener.onError(SpeechRecognizer.ERROR_CLIENT); 1263da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.w(TAG, "stopListening called with no preceding startListening - ignoring"); 1273da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else if (mCurrentCallback.mListener.asBinder() != listener.asBinder()) { 1282a5d9f9b577376768372837723f0f42098aba13bJean-Michel Trivi listener.onError(SpeechRecognizer.ERROR_RECOGNIZER_BUSY); 1293da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.w(TAG, "stopListening called by other caller than startListening - ignoring"); 1303da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else { // the correct state 1313da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov RecognitionService.this.onStopListening(mCurrentCallback); 1323da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1333da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } catch (RemoteException e) { // occurs if onError fails 1343da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.d(TAG, "onError call from stopListening failed"); 1353da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1363da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1373da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1383da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private void dispatchCancel(IRecognitionListener listener) { 1393da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (mCurrentCallback == null) { 1402b0c7ab6891294473136bb6f7f2e751d133ae8cfValentin Kravtsov if (DBG) Log.d(TAG, "cancel called with no preceding startListening - ignoring"); 1413da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else if (mCurrentCallback.mListener.asBinder() != listener.asBinder()) { 1423da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.w(TAG, "cancel called by client who did not call startListening - ignoring"); 1433da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else { // the correct state 1443da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov RecognitionService.this.onCancel(mCurrentCallback); 1453da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mCurrentCallback = null; 1463da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "canceling - setting mCurrentCallback to null"); 1473da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1483da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1493da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 150483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov private void dispatchClearCallback() { 151483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov mCurrentCallback = null; 152483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov } 153483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov 1543da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private class StartListeningArgs { 1553da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public final Intent mIntent; 1563da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1573da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public final IRecognitionListener mListener; 1583da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1593da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public StartListeningArgs(Intent intent, IRecognitionListener listener) { 1603da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov this.mIntent = intent; 1613da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov this.mListener = listener; 1623da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1633da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1643da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1653da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 1663da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Checks whether the caller has sufficient permissions 1673da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 1683da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param listener to send the error message to in case of error 1693da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @return {@code true} if the caller has enough permissions, {@code false} otherwise 1703da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 1713da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private boolean checkPermissions(IRecognitionListener listener) { 1723da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "checkPermissions"); 1733da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (RecognitionService.this.checkCallingOrSelfPermission(android.Manifest.permission. 1743da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov RECORD_AUDIO) == PackageManager.PERMISSION_GRANTED) { 1753da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov return true; 1763da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1773da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov try { 1783da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.e(TAG, "call for recognition service without RECORD_AUDIO permissions"); 1792a5d9f9b577376768372837723f0f42098aba13bJean-Michel Trivi listener.onError(SpeechRecognizer.ERROR_INSUFFICIENT_PERMISSIONS); 1803da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } catch (RemoteException re) { 1813da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.e(TAG, "sending ERROR_INSUFFICIENT_PERMISSIONS message failed", re); 1823da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1833da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov return false; 1843da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1853da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1863da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 1873da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Notifies the service that it should start listening for speech. 1883da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 1893da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param recognizerIntent contains parameters for the recognition to be performed. The intent 1903da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * may also contain optional extras, see {@link RecognizerIntent}. If these values are 1913da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * not set explicitly, default values should be used by the recognizer. 1923da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param listener that will receive the service's callbacks 1933da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 1943da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov protected abstract void onStartListening(Intent recognizerIntent, Callback listener); 1953da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1963da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 1973da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Notifies the service that it should cancel the speech recognition. 1983da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 1993da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov protected abstract void onCancel(Callback listener); 2003da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2013da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2023da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Notifies the service that it should stop listening for speech. Speech captured so far should 2033da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * be recognized as if the user had stopped speaking at this point. This method is only called 2043da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * if the application calls it explicitly. 2053da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2063da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov protected abstract void onStopListening(Callback listener); 2073da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2083da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov @Override 2093da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public final IBinder onBind(final Intent intent) { 2103da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "onBind, intent=" + intent); 2113da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov return mBinder; 2123da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2133da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2141c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov @Override 2151c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov public void onDestroy() { 2161c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov if (DBG) Log.d(TAG, "onDestroy"); 2171c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov mCurrentCallback = null; 2181c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov mBinder.clearReference(); 2191c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov super.onDestroy(); 2201c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 2211c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov 2223da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2233da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * This class receives callbacks from the speech recognition service and forwards them to the 2243da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * user. An instance of this class is passed to the 2253da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * {@link RecognitionService#onStartListening(Intent, Callback)} method. Recognizers may call 2263da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * these methods on any thread. 2273da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2283da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public class Callback { 2293da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private final IRecognitionListener mListener; 2303da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2313da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private Callback(IRecognitionListener listener) { 2323da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener = listener; 2333da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2343da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2353da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2363da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when the user has started to speak. 2373da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2383da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void beginningOfSpeech() throws RemoteException { 2393da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "beginningOfSpeech"); 2403da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onBeginningOfSpeech(); 2413da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2423da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2433da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2443da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when sound has been received. The purpose of this 2453da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * function is to allow giving feedback to the user regarding the captured audio. 2463da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2473da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param buffer a buffer containing a sequence of big-endian 16-bit integers representing a 2483da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * single channel audio stream. The sample rate is implementation dependent. 2493da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2503da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void bufferReceived(byte[] buffer) throws RemoteException { 2513da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onBufferReceived(buffer); 2523da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2533da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2543da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2553da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method after the user stops speaking. 2563da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2573da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void endOfSpeech() throws RemoteException { 2583da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onEndOfSpeech(); 2593da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2603da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2613da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2623da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when a network or recognition error occurred. 2633da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2642a5d9f9b577376768372837723f0f42098aba13bJean-Michel Trivi * @param error code is defined in {@link SpeechRecognizer} 2653da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2663da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void error(int error) throws RemoteException { 267483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov Message.obtain(mHandler, MSG_RESET).sendToTarget(); 2683da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onError(error); 2693da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2703da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2713da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2723da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when partial recognition results are available. This 2733da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * method can be called at any time between {@link #beginningOfSpeech()} and 2743da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * {@link #results(Bundle)} when partial results are ready. This method may be called zero, 2752a5d9f9b577376768372837723f0f42098aba13bJean-Michel Trivi * one or multiple times for each call to {@link SpeechRecognizer#startListening(Intent)}, 2763da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * depending on the speech recognition service implementation. 2773da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2783da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param partialResults the returned results. To retrieve the results in 2793da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * ArrayList<String> format use {@link Bundle#getStringArrayList(String)} with 2802a5d9f9b577376768372837723f0f42098aba13bJean-Michel Trivi * {@link SpeechRecognizer#RESULTS_RECOGNITION} as a parameter 2813da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2823da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void partialResults(Bundle partialResults) throws RemoteException { 2833da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onPartialResults(partialResults); 2843da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2853da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2863da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2873da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when the endpointer is ready for the user to start 2883da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * speaking. 2893da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2903da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param params parameters set by the recognition service. Reserved for future use. 2913da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2923da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void readyForSpeech(Bundle params) throws RemoteException { 2933da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onReadyForSpeech(params); 2943da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2953da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2963da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2973da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when recognition results are ready. 2983da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2993da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param results the recognition results. To retrieve the results in {@code 3003da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * ArrayList<String>} format use {@link Bundle#getStringArrayList(String)} with 3012a5d9f9b577376768372837723f0f42098aba13bJean-Michel Trivi * {@link SpeechRecognizer#RESULTS_RECOGNITION} as a parameter 3023da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 3033da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void results(Bundle results) throws RemoteException { 304483701eb9f36a322ca7fa6cad76fa849a756810aValentin Kravtsov Message.obtain(mHandler, MSG_RESET).sendToTarget(); 3053da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onResults(results); 3063da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 3073da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 3083da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 3093da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when the sound level in the audio stream has changed. 3103da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * There is no guarantee that this method will be called. 3113da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 3123da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param rmsdB the new RMS dB value 3133da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 3143da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void rmsChanged(float rmsdB) throws RemoteException { 3153da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onRmsChanged(rmsdB); 3163da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 3173da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 3181c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov 3191c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov /** Binder of the recognition service */ 32096156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown private static final class RecognitionServiceBinder extends IRecognitionService.Stub { 32196156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown private final WeakReference<RecognitionService> mServiceRef; 3221c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov 3231c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov public RecognitionServiceBinder(RecognitionService service) { 32496156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown mServiceRef = new WeakReference<RecognitionService>(service); 3251c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 3261c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov 32796156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown @Override 3281c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov public void startListening(Intent recognizerIntent, IRecognitionListener listener) { 3291c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov if (DBG) Log.d(TAG, "startListening called by:" + listener.asBinder()); 33096156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown final RecognitionService service = mServiceRef.get(); 33196156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown if (service != null && service.checkPermissions(listener)) { 33296156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown service.mHandler.sendMessage(Message.obtain(service.mHandler, 33396156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown MSG_START_LISTENING, service.new StartListeningArgs( 3341c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov recognizerIntent, listener))); 3351c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 3361c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 3371c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov 33896156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown @Override 3391c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov public void stopListening(IRecognitionListener listener) { 3401c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov if (DBG) Log.d(TAG, "stopListening called by:" + listener.asBinder()); 34196156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown final RecognitionService service = mServiceRef.get(); 34296156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown if (service != null && service.checkPermissions(listener)) { 34396156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown service.mHandler.sendMessage(Message.obtain(service.mHandler, 3441c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov MSG_STOP_LISTENING, listener)); 3451c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 3461c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 3471c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov 34896156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown @Override 3491c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov public void cancel(IRecognitionListener listener) { 3501c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov if (DBG) Log.d(TAG, "cancel called by:" + listener.asBinder()); 35196156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown final RecognitionService service = mServiceRef.get(); 35296156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown if (service != null && service.checkPermissions(listener)) { 35396156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown service.mHandler.sendMessage(Message.obtain(service.mHandler, 3541c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov MSG_CANCEL, listener)); 3551c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 3561c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 3571c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov 3581c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov public void clearReference() { 35996156979022a6e1af4b29051aedd0d8e237018e8Jeff Brown mServiceRef.clear(); 3601c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 3611c3cca0abed55516d2c67f2f11fc888a6a66f341Valentin Kravtsov } 3623da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov} 363