Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit eb4a4114 authored by Nicholas Ambur's avatar Nicholas Ambur
Browse files

expand AlwaysOnHotwordDetection.startRecognition 

an additional byte[] data to the AlwaysOnHotwordDetector
startRecognition class. This data is use a pass-through
to the system voice engine.

Test: atest CtsVoiceInteractionTestCases
CTS-Coverage-Bug: 215375531
Bug: 224638834
Change-Id: I74be65b8718c0d10c69e69ad11a7014cdf55d873
parent b5bf9093

core/api/system-current.txt

+1 −0
Original line number Diff line number Diff line
@@ -11890,6 +11890,7 @@ package android.service.voice { 
    method public int getSupportedRecognitionModes();

    method @Nullable @RequiresPermission(allOf={android.Manifest.permission.RECORD_AUDIO, android.Manifest.permission.CAPTURE_AUDIO_HOTWORD}) public android.service.voice.AlwaysOnHotwordDetector.ModelParamRange queryParameter(int);

    method @RequiresPermission(allOf={android.Manifest.permission.RECORD_AUDIO, android.Manifest.permission.CAPTURE_AUDIO_HOTWORD}) public int setParameter(int, int);

    method @RequiresPermission(allOf={android.Manifest.permission.RECORD_AUDIO, android.Manifest.permission.CAPTURE_AUDIO_HOTWORD}) public boolean startRecognition(int, @NonNull byte[]);

    method @RequiresPermission(allOf={android.Manifest.permission.RECORD_AUDIO, android.Manifest.permission.CAPTURE_AUDIO_HOTWORD}) public boolean startRecognition(int);

    method @RequiresPermission(allOf={android.Manifest.permission.RECORD_AUDIO, android.Manifest.permission.CAPTURE_AUDIO_HOTWORD}) public boolean startRecognition();

    method public boolean startRecognition(@NonNull android.os.ParcelFileDescriptor, @NonNull android.media.AudioFormat, @Nullable android.os.PersistableBundle);

core/java/android/service/voice/AlwaysOnHotwordDetector.java

+48 −14
Original line number Diff line number Diff line
@@ -954,6 +954,9 @@ public class AlwaysOnHotwordDetector extends AbstractHotwordDetector { 
     * @see #RECOGNITION_FLAG_ALLOW_MULTIPLE_TRIGGERS

     *

     * @param recognitionFlags The flags to control the recognition properties.

     * @param data Additional pass-through data to the system voice engine along with the

     *             startRecognition request. This data is intended to provide additional parameters

     *             when starting the opaque sound model.

     * @return Indicates whether the call succeeded or not.

     * @throws UnsupportedOperationException if the recognition isn't supported.

     *         Callers should only call this method after a supported state callback on
@@ -963,21 +966,35 @@ public class AlwaysOnHotwordDetector extends AbstractHotwordDetector { 
     *         {@link VoiceInteractionService} hosting this detector has been shut down.

     */

    @RequiresPermission(allOf = {RECORD_AUDIO, CAPTURE_AUDIO_HOTWORD})

    public boolean startRecognition(@RecognitionFlags int recognitionFlags) {

        if (DBG) Slog.d(TAG, "startRecognition(" + recognitionFlags + ")");

    public boolean startRecognition(@RecognitionFlags int recognitionFlags, @NonNull byte[] data) {

        synchronized (mLock) {

            if (mAvailability == STATE_INVALID || mAvailability == STATE_ERROR) {

                throw new IllegalStateException(

                        "startRecognition called on an invalid detector or error state");

            return startRecognitionLocked(recognitionFlags, data)

                    == STATUS_OK;

        }



            // Check if we can start/stop a recognition.

            if (mAvailability != STATE_KEYPHRASE_ENROLLED) {

                throw new UnsupportedOperationException(

                        "Recognition for the given keyphrase is not supported");

    }



            return startRecognitionLocked(recognitionFlags) == STATUS_OK;

    /**

     * Starts recognition for the associated keyphrase.

     * Caller must be the active voice interaction service via

     * Settings.Secure.VOICE_INTERACTION_SERVICE.

     *

     * @see #RECOGNITION_FLAG_CAPTURE_TRIGGER_AUDIO

     * @see #RECOGNITION_FLAG_ALLOW_MULTIPLE_TRIGGERS

     *

     * @param recognitionFlags The flags to control the recognition properties.

     * @return Indicates whether the call succeeded or not.

     * @throws UnsupportedOperationException if the recognition isn't supported.

     *         Callers should only call this method after a supported state callback on

     *         {@link Callback#onAvailabilityChanged(int)} to avoid this exception.

     * @throws IllegalStateException if the detector is in an invalid or error state.

     *         This may happen if another detector has been instantiated or the

     *         {@link VoiceInteractionService} hosting this detector has been shut down.

     */

    @RequiresPermission(allOf = {RECORD_AUDIO, CAPTURE_AUDIO_HOTWORD})

    public boolean startRecognition(@RecognitionFlags int recognitionFlags) {

        if (DBG) Slog.d(TAG, "startRecognition(" + recognitionFlags + ")");

        synchronized (mLock) {

            return startRecognitionLocked(recognitionFlags, null /* data */) == STATUS_OK;

        }

    }
@@ -1276,7 +1293,24 @@ public class AlwaysOnHotwordDetector extends AbstractHotwordDetector { 
        }

    }



    private int startRecognitionLocked(int recognitionFlags) {

    private int startRecognitionLocked(int recognitionFlags,

            @Nullable byte[] data) {

        if (DBG) {

            Slog.d(TAG, "startRecognition("

                    + recognitionFlags

                    + ", " + Arrays.toString(data) + ")");

        }

        if (mAvailability == STATE_INVALID || mAvailability == STATE_ERROR) {

            throw new IllegalStateException(

                    "startRecognition called on an invalid detector or error state");

        }



        // Check if we can start/stop a recognition.

        if (mAvailability != STATE_KEYPHRASE_ENROLLED) {

            throw new UnsupportedOperationException(

                    "Recognition for the given keyphrase is not supported");

        }



        KeyphraseRecognitionExtra[] recognitionExtra = new KeyphraseRecognitionExtra[1];

        // TODO: Do we need to do something about the confidence level here?

        recognitionExtra[0] = new KeyphraseRecognitionExtra(mKeyphraseMetadata.getId(),
@@ -1300,7 +1334,7 @@ public class AlwaysOnHotwordDetector extends AbstractHotwordDetector { 
            code = mSoundTriggerSession.startRecognition(

                    mKeyphraseMetadata.getId(), mLocale.toLanguageTag(), mInternalCallback,

                    new RecognitionConfig(captureTriggerAudio, allowMultipleTriggers,

                            recognitionExtra, null /* additional data */, audioCapabilities),

                            recognitionExtra, data, audioCapabilities),

                    runInBatterySaver);

        } catch (RemoteException e) {

            throw e.rethrowFromSystemServer();