| /* |
| * Copyright (C) 2019 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.server.soundtrigger_middleware; |
| |
| import android.hardware.soundtrigger.V2_3.ModelParameterRange; |
| import android.hidl.base.V1_0.IBase; |
| import android.os.IHwBinder; |
| |
| /** |
| * This interface mimics android.hardware.soundtrigger.V2_x.ISoundTriggerHw and |
| * android.hardware.soundtrigger.V2_x.ISoundTriggerHwCallback, with a few key differences: |
| * <ul> |
| * <li>Methods in the original interface generally have a status return value and potentially a |
| * second return value which is the actual return value. This is reflected via a synchronous |
| * callback, which is not very pleasant to work with. This interface replaces that pattern with |
| * the convention that a HalException is thrown for non-OK status, and then we can use the |
| * return value for the actual return value. |
| * <li>This interface will always include all the methods from the latest 2.x version (and thus |
| * from every 2.x version) interface, with the convention that unsupported methods throw a |
| * {@link RecoverableException} with a |
| * {@link android.media.soundtrigger_middleware.Status#OPERATION_NOT_SUPPORTED} |
| * code. |
| * <li>Cases where the original interface had multiple versions of a method representing the exact |
| * thing, or there exists a trivial conversion between the new and old version, this interface |
| * represents only the latest version, without any _version suffixes. |
| * <li>Removes some of the obscure IBinder methods. |
| * <li>No RemoteExceptions are specified. Some implementations of this interface may rethrow |
| * RemoteExceptions as RuntimeExceptions, some can guarantee handling them somehow and never throw |
| * them. |
| * <li>soundModelCallback has been removed, since nobody cares about it. Implementations are free |
| * to silently discard it. |
| * </ul> |
| * For cases where the client wants to explicitly handle specific versions of the underlying driver |
| * interface, they may call {@link #interfaceDescriptor()}. |
| * <p> |
| * <b>Note to maintainers</b>: This class must always be kept in sync with the latest 2.x version, |
| * so that clients have access to the entire functionality without having to burden themselves with |
| * compatibility, as much as possible. |
| */ |
| public interface ISoundTriggerHw2 { |
| /** |
| * @see android.hardware.soundtrigger.V2_3.ISoundTriggerHw#getPropertiesEx( |
| * android.hardware.soundtrigger.V2_3.ISoundTriggerHw.getPropertiesExCallback) |
| */ |
| android.hardware.soundtrigger.V2_3.Properties getProperties(); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_2.ISoundTriggerHw#loadSoundModel_2_1(android.hardware.soundtrigger.V2_1.ISoundTriggerHw.SoundModel, |
| * android.hardware.soundtrigger.V2_1.ISoundTriggerHwCallback, int, |
| * android.hardware.soundtrigger.V2_1.ISoundTriggerHw.loadSoundModel_2_1Callback) |
| */ |
| int loadSoundModel( |
| android.hardware.soundtrigger.V2_1.ISoundTriggerHw.SoundModel soundModel, |
| SoundTriggerHw2Compat.Callback callback, int cookie); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_2.ISoundTriggerHw#loadPhraseSoundModel_2_1(android.hardware.soundtrigger.V2_1.ISoundTriggerHw.PhraseSoundModel, |
| * android.hardware.soundtrigger.V2_1.ISoundTriggerHwCallback, int, |
| * android.hardware.soundtrigger.V2_1.ISoundTriggerHw.loadPhraseSoundModel_2_1Callback) |
| */ |
| int loadPhraseSoundModel( |
| android.hardware.soundtrigger.V2_1.ISoundTriggerHw.PhraseSoundModel soundModel, |
| SoundTriggerHw2Compat.Callback callback, int cookie); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_2.ISoundTriggerHw#unloadSoundModel(int) |
| */ |
| void unloadSoundModel(int modelHandle); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_2.ISoundTriggerHw#stopRecognition(int) |
| */ |
| void stopRecognition(int modelHandle); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_2.ISoundTriggerHw#stopAllRecognitions() |
| */ |
| void stopAllRecognitions(); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_3.ISoundTriggerHw#startRecognition_2_3(int, |
| * android.hardware.soundtrigger.V2_3.RecognitionConfig, |
| * android.hardware.soundtrigger.V2_1.ISoundTriggerHwCallback, int) |
| */ |
| void startRecognition(int modelHandle, |
| android.hardware.soundtrigger.V2_3.RecognitionConfig config, |
| SoundTriggerHw2Compat.Callback callback, int cookie); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_2.ISoundTriggerHw#getModelState(int) |
| */ |
| void getModelState(int modelHandle); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_3.ISoundTriggerHw#getParameter(int, int, |
| * ISoundTriggerHw.getParameterCallback) |
| */ |
| int getModelParameter(int modelHandle, int param); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_3.ISoundTriggerHw#setParameter(int, int, int) |
| */ |
| void setModelParameter(int modelHandle, int param, int value); |
| |
| /** |
| * @return null if not supported. |
| * @see android.hardware.soundtrigger.V2_3.ISoundTriggerHw#queryParameter(int, int, |
| * ISoundTriggerHw.queryParameterCallback) |
| */ |
| ModelParameterRange queryParameter(int modelHandle, int param); |
| |
| /** |
| * @see IHwBinder#linkToDeath(IHwBinder.DeathRecipient, long) |
| */ |
| boolean linkToDeath(IHwBinder.DeathRecipient recipient, long cookie); |
| |
| /** |
| * @see IHwBinder#unlinkToDeath(IHwBinder.DeathRecipient) |
| */ |
| boolean unlinkToDeath(IHwBinder.DeathRecipient recipient); |
| |
| /** |
| * @see IBase#interfaceDescriptor() |
| */ |
| String interfaceDescriptor() throws android.os.RemoteException; |
| |
| interface Callback { |
| /** |
| * @see android.hardware.soundtrigger.V2_1.ISoundTriggerHwCallback#recognitionCallback_2_1(android.hardware.soundtrigger.V2_1.ISoundTriggerHwCallback.RecognitionEvent, |
| * int) |
| */ |
| void recognitionCallback( |
| android.hardware.soundtrigger.V2_1.ISoundTriggerHwCallback.RecognitionEvent event, |
| int cookie); |
| |
| /** |
| * @see android.hardware.soundtrigger.V2_1.ISoundTriggerHwCallback#phraseRecognitionCallback_2_1(android.hardware.soundtrigger.V2_1.ISoundTriggerHwCallback.PhraseRecognitionEvent, |
| * int) |
| */ |
| void phraseRecognitionCallback( |
| android.hardware.soundtrigger.V2_1.ISoundTriggerHwCallback.PhraseRecognitionEvent event, |
| int cookie); |
| } |
| } |