RecognitionService.java revision 378ae126d9d61feed77ad596fa0823394eac6240
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 313da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov/** 323da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * This class provides a base class for recognition service implementations. This class should be 333da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * extended only in case you wish to implement a new speech recognizer. Please not that the 343da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * implementation of this service is state-less. 353da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 363da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsovpublic abstract class RecognitionService extends Service { 37378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau /** 38378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau * The {@link Intent} that must be declared as handled by the service. 39378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau */ 40378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau @SdkConstant(SdkConstantType.SERVICE_ACTION) 41378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau public static final String SERVICE_INTERFACE = "android.speech.RecognitionService"; 42378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau 43378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau /** 44378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau * Name under which a RecognitionService component publishes information about itself. 45378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau * This meta-data should reference an XML resource containing a 46378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau * <code><{@link android.R.styleable#RecognitionService recognition-service}></code> tag. 47378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau */ 48378ae126d9d61feed77ad596fa0823394eac6240Mike LeBeau public static final String SERVICE_META_DATA = "android.speech"; 493da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 503da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** Log messages identifier */ 513da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final String TAG = "RecognitionService"; 523da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 533da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** Debugging flag */ 543da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final boolean DBG = false; 553da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 563da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 573da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The current callback of an application that invoked the 583da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * {@link RecognitionService#onStartListening(Intent, Callback)} method 593da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 603da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private Callback mCurrentCallback = null; 613da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 623da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final int MSG_START_LISTENING = 1; 633da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 643da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final int MSG_STOP_LISTENING = 2; 653da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 663da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private static final int MSG_CANCEL = 3; 673da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 683da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private final Handler mHandler = new Handler() { 693da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov @Override 703da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void handleMessage(Message msg) { 713da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov switch (msg.what) { 723da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov case MSG_START_LISTENING: 733da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov StartListeningArgs args = (StartListeningArgs) msg.obj; 743da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov dispatchStartListening(args.mIntent, args.mListener); 753da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov break; 763da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov case MSG_STOP_LISTENING: 773da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov dispatchStopListening((IRecognitionListener) msg.obj); 783da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov break; 793da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov case MSG_CANCEL: 803da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov dispatchCancel((IRecognitionListener) msg.obj); 813da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 823da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 833da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov }; 843da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 853da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private void dispatchStartListening(Intent intent, IRecognitionListener listener) { 863da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (mCurrentCallback == null) { 873da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "created new mCurrentCallback, listener = " + listener.asBinder()); 883da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mCurrentCallback = new Callback(listener); 893da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov RecognitionService.this.onStartListening(intent, mCurrentCallback); 903da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else { 913da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov try { 923da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov listener.onError(RecognitionManager.ERROR_RECOGNIZER_BUSY); 933da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } catch (RemoteException e) { 943da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.d(TAG, "onError call from startListening failed"); 953da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 963da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.i(TAG, "concurrent startListening received - ignoring this call"); 973da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 983da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 993da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1003da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private void dispatchStopListening(IRecognitionListener listener) { 1013da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov try { 1023da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (mCurrentCallback == null) { 1033da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov listener.onError(RecognitionManager.ERROR_CLIENT); 1043da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.w(TAG, "stopListening called with no preceding startListening - ignoring"); 1053da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else if (mCurrentCallback.mListener.asBinder() != listener.asBinder()) { 1063da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov listener.onError(RecognitionManager.ERROR_RECOGNIZER_BUSY); 1073da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.w(TAG, "stopListening called by other caller than startListening - ignoring"); 1083da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else { // the correct state 1093da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov RecognitionService.this.onStopListening(mCurrentCallback); 1103da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1113da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } catch (RemoteException e) { // occurs if onError fails 1123da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.d(TAG, "onError call from stopListening failed"); 1133da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1143da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1153da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1163da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private void dispatchCancel(IRecognitionListener listener) { 1173da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (mCurrentCallback == null) { 1183da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.w(TAG, "cancel called with no preceding startListening - ignoring"); 1193da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else if (mCurrentCallback.mListener.asBinder() != listener.asBinder()) { 1203da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.w(TAG, "cancel called by client who did not call startListening - ignoring"); 1213da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } else { // the correct state 1223da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov RecognitionService.this.onCancel(mCurrentCallback); 1233da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mCurrentCallback = null; 1243da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "canceling - setting mCurrentCallback to null"); 1253da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1263da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1273da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1283da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private class StartListeningArgs { 1293da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public final Intent mIntent; 1303da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1313da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public final IRecognitionListener mListener; 1323da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1333da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public StartListeningArgs(Intent intent, IRecognitionListener listener) { 1343da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov this.mIntent = intent; 1353da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov this.mListener = listener; 1363da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1373da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1383da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1393da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** Binder of the recognition service */ 1403da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private final IRecognitionService.Stub mBinder = new IRecognitionService.Stub() { 1413da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void startListening(Intent recognizerIntent, IRecognitionListener listener) { 1423da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "startListening called by:" + listener.asBinder()); 1433da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (checkPermissions(listener)) { 1443da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mHandler.sendMessage(Message.obtain(mHandler, MSG_START_LISTENING, 1453da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov new StartListeningArgs(recognizerIntent, listener))); 1463da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1473da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1483da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1493da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void stopListening(IRecognitionListener listener) { 1503da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "stopListening called by:" + listener.asBinder()); 1513da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (checkPermissions(listener)) { 1523da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mHandler.sendMessage(Message.obtain(mHandler, MSG_STOP_LISTENING, listener)); 1533da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1543da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1553da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1563da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void cancel(IRecognitionListener listener) { 1573da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "cancel called by:" + listener.asBinder()); 1583da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (checkPermissions(listener)) { 1593da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mHandler.sendMessage(Message.obtain(mHandler, MSG_CANCEL, listener)); 1603da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1613da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1623da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov }; 1633da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1643da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 1653da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Checks whether the caller has sufficient permissions 1663da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 1673da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param listener to send the error message to in case of error 1683da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @return {@code true} if the caller has enough permissions, {@code false} otherwise 1693da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 1703da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private boolean checkPermissions(IRecognitionListener listener) { 1713da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "checkPermissions"); 1723da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (RecognitionService.this.checkCallingOrSelfPermission(android.Manifest.permission. 1733da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov RECORD_AUDIO) == PackageManager.PERMISSION_GRANTED) { 1743da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov return true; 1753da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1763da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov try { 1773da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.e(TAG, "call for recognition service without RECORD_AUDIO permissions"); 1783da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov listener.onError(RecognitionManager.ERROR_INSUFFICIENT_PERMISSIONS); 1793da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } catch (RemoteException re) { 1803da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov Log.e(TAG, "sending ERROR_INSUFFICIENT_PERMISSIONS message failed", re); 1813da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1823da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov return false; 1833da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 1843da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1853da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 1863da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Notifies the service that it should start listening for speech. 1873da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 1883da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param recognizerIntent contains parameters for the recognition to be performed. The intent 1893da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * may also contain optional extras, see {@link RecognizerIntent}. If these values are 1903da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * not set explicitly, default values should be used by the recognizer. 1913da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param listener that will receive the service's callbacks 1923da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 1933da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov protected abstract void onStartListening(Intent recognizerIntent, Callback listener); 1943da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 1953da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 1963da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Notifies the service that it should cancel the speech recognition. 1973da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 1983da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov protected abstract void onCancel(Callback listener); 1993da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2003da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2013da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * Notifies the service that it should stop listening for speech. Speech captured so far should 2023da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * be recognized as if the user had stopped speaking at this point. This method is only called 2033da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * if the application calls it explicitly. 2043da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2053da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov protected abstract void onStopListening(Callback listener); 2063da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2073da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov @Override 2083da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public final IBinder onBind(final Intent intent) { 2093da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "onBind, intent=" + intent); 2103da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov return mBinder; 2113da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2123da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2133da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2143da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * This class receives callbacks from the speech recognition service and forwards them to the 2153da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * user. An instance of this class is passed to the 2163da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * {@link RecognitionService#onStartListening(Intent, Callback)} method. Recognizers may call 2173da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * these methods on any thread. 2183da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2193da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public class Callback { 2203da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private final IRecognitionListener mListener; 2213da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2223da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov private Callback(IRecognitionListener listener) { 2233da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener = listener; 2243da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2253da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2263da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2273da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when the user has started to speak. 2283da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2293da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void beginningOfSpeech() throws RemoteException { 2303da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov if (DBG) Log.d(TAG, "beginningOfSpeech"); 2313da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onBeginningOfSpeech(); 2323da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2333da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2343da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2353da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when sound has been received. The purpose of this 2363da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * function is to allow giving feedback to the user regarding the captured audio. 2373da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2383da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param buffer a buffer containing a sequence of big-endian 16-bit integers representing a 2393da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * single channel audio stream. The sample rate is implementation dependent. 2403da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2413da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void bufferReceived(byte[] buffer) throws RemoteException { 2423da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onBufferReceived(buffer); 2433da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2443da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2453da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2463da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method after the user stops speaking. 2473da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2483da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void endOfSpeech() throws RemoteException { 2493da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onEndOfSpeech(); 2503da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2513da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2523da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2533da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when a network or recognition error occurred. 2543da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2553da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param error code is defined in {@link RecognitionManager} 2563da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2573da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void error(int error) throws RemoteException { 2583da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mCurrentCallback = null; 2593da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onError(error); 2603da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2613da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2623da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2633da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when partial recognition results are available. This 2643da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * method can be called at any time between {@link #beginningOfSpeech()} and 2653da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * {@link #results(Bundle)} when partial results are ready. This method may be called zero, 2663da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * one or multiple times for each call to {@link RecognitionManager#startListening(Intent)}, 2673da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * depending on the speech recognition service implementation. 2683da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2693da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param partialResults the returned results. To retrieve the results in 2703da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * ArrayList<String> format use {@link Bundle#getStringArrayList(String)} with 2713da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * {@link RecognitionManager#RESULTS_RECOGNITION} as a parameter 2723da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2733da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void partialResults(Bundle partialResults) throws RemoteException { 2743da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onPartialResults(partialResults); 2753da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2763da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2773da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2783da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when the endpointer is ready for the user to start 2793da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * speaking. 2803da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2813da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param params parameters set by the recognition service. Reserved for future use. 2823da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2833da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void readyForSpeech(Bundle params) throws RemoteException { 2843da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onReadyForSpeech(params); 2853da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2863da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2873da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 2883da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when recognition results are ready. 2893da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 2903da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param results the recognition results. To retrieve the results in {@code 2913da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * ArrayList<String>} format use {@link Bundle#getStringArrayList(String)} with 2923da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * {@link RecognitionManager#RESULTS_RECOGNITION} as a parameter 2933da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 2943da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void results(Bundle results) throws RemoteException { 2953da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mCurrentCallback = null; 2963da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onResults(results); 2973da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 2983da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov 2993da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov /** 3003da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * The service should call this method when the sound level in the audio stream has changed. 3013da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * There is no guarantee that this method will be called. 3023da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * 3033da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov * @param rmsdB the new RMS dB value 3043da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov */ 3053da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov public void rmsChanged(float rmsdB) throws RemoteException { 3063da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov mListener.onRmsChanged(rmsdB); 3073da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 3083da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov } 3093da3cad97269d694a6153771fb4a0c3775ca6ab5Valentin Kravtsov} 310