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

Commit 274f05a8 authored by Nicholas Ambur's avatar Nicholas Ambur
Browse files

move HotwordDetector ctor work to initialize() 

new package-private initialize() method is added to
AbstractHotwordDetector to perform work which was previously done in the
implementing class' ctor. This allows the creator,
VoiceInteractionService to control when the initialize work is done
after create.

This change is apart of a larger topic to allow multiple detectors to be
active in parallel. By separating work done in the ctor to another
method, we can freely create detectors without impacting the other
services it communicates with.

This is an internal cleanup, and the client app using the detector will
observe no behavior change.

Test: atest VoiceInteractionSystemApiTest
Bug: 193232191
Change-Id: Ib63cff09e6a0c22fb0f77a0e721637dbb5ae7ed0
parent 8531eb26

core/java/android/service/voice/AbstractHotwordDetector.java

+7 −0
Original line number Diff line number Diff line
@@ -64,6 +64,13 @@ abstract class AbstractHotwordDetector implements HotwordDetector { 
        mIsDetectorActive = new AtomicBoolean(true);

    }



    /**

     * Method to be called for the detector to ready/register itself with underlying system

     * services.

     */

    abstract void initialize(@Nullable PersistableBundle options,

            @Nullable SharedMemory sharedMemory);



    /**

     * Detect hotword from an externally supplied stream of data.

     *

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

+8 −3
Original line number Diff line number Diff line
@@ -279,7 +279,7 @@ public class AlwaysOnHotwordDetector extends AbstractHotwordDetector { 
    private KeyphraseMetadata mKeyphraseMetadata;

    private final KeyphraseEnrollmentInfo mKeyphraseEnrollmentInfo;

    private final IVoiceInteractionManagerService mModelManagementService;

    private final IVoiceInteractionSoundTriggerSession mSoundTriggerSession;

    private IVoiceInteractionSoundTriggerSession mSoundTriggerSession;

    private final SoundTriggerListener mInternalCallback;

    private final Callback mExternalCallback;

    private final Handler mHandler;
@@ -788,8 +788,7 @@ public class AlwaysOnHotwordDetector extends AbstractHotwordDetector { 
    public AlwaysOnHotwordDetector(String text, Locale locale, Callback callback,

            KeyphraseEnrollmentInfo keyphraseEnrollmentInfo,

            IVoiceInteractionManagerService modelManagementService, int targetSdkVersion,

            boolean supportHotwordDetectionService, @Nullable PersistableBundle options,

            @Nullable SharedMemory sharedMemory) {

            boolean supportHotwordDetectionService) {

        super(modelManagementService, callback,

                supportHotwordDetectionService ? DETECTOR_TYPE_TRUSTED_HOTWORD_DSP

                        : DETECTOR_TYPE_NORMAL);
@@ -803,6 +802,12 @@ public class AlwaysOnHotwordDetector extends AbstractHotwordDetector { 
        mModelManagementService = modelManagementService;

        mTargetSdkVersion = targetSdkVersion;

        mSupportHotwordDetectionService = supportHotwordDetectionService;

    }



    @Override

    void initialize(@Nullable PersistableBundle options, @Nullable SharedMemory sharedMemory) {

        // TODO: transition to use an API that is not updateState to provide

        //  onHotwordDetectionServiceInitialized status to external callback

        if (mSupportHotwordDetectionService) {

            updateStateLocked(options, sharedMemory, mInternalCallback,

                    DETECTOR_TYPE_TRUSTED_HOTWORD_DSP);

core/java/android/service/voice/SoftwareHotwordDetector.java

+6 −2
Original line number Diff line number Diff line
@@ -57,8 +57,6 @@ class SoftwareHotwordDetector extends AbstractHotwordDetector { 
    SoftwareHotwordDetector(

            IVoiceInteractionManagerService managerService,

            AudioFormat audioFormat,

            PersistableBundle options,

            SharedMemory sharedMemory,

            HotwordDetector.Callback callback) {

        super(managerService, callback, DETECTOR_TYPE_TRUSTED_HOTWORD_SOFTWARE);
@@ -66,6 +64,12 @@ class SoftwareHotwordDetector extends AbstractHotwordDetector { 
        mAudioFormat = audioFormat;

        mCallback = callback;

        mHandler = new Handler(Looper.getMainLooper());

    }



    @Override

    void initialize(@Nullable PersistableBundle options, @Nullable SharedMemory sharedMemory) {

        // TODO: transition to use an API that is not updateState to provide

        //  onHotwordDetectionServiceInitialized status to external callback

        updateStateLocked(options, sharedMemory,

                new InitializationStateListener(mHandler, mCallback),

                DETECTOR_TYPE_TRUSTED_HOTWORD_SOFTWARE);

core/java/android/service/voice/VoiceInteractionService.java

+8 −3
Original line number Diff line number Diff line
@@ -381,12 +381,15 @@ public class VoiceInteractionService extends Service { 
        synchronized (mLock) {

            // Allow only one concurrent recognition via the APIs.

            safelyShutdownAllHotwordDetectors();

            mHotwordDetector = new AlwaysOnHotwordDetector(keyphrase, locale, callback,



            mHotwordDetector = new AlwaysOnHotwordDetector(keyphrase, locale,

                    callback,

                    mKeyphraseEnrollmentInfo, mSystemService,

                    getApplicationContext().getApplicationInfo().targetSdkVersion,

                    supportHotwordDetectionService, options, sharedMemory);

                    supportHotwordDetectionService);

            mHotwordDetector.registerOnDestroyListener((detector) -> onDspHotwordDetectorDestroyed(

                    (AlwaysOnHotwordDetector) detector));

            mHotwordDetector.initialize(options, sharedMemory);

        }

        return mHotwordDetector;

    }
@@ -436,12 +439,14 @@ public class VoiceInteractionService extends Service { 
        synchronized (mLock) {

            // Allow only one concurrent recognition via the APIs.

            safelyShutdownAllHotwordDetectors();



            mSoftwareHotwordDetector =

                    new SoftwareHotwordDetector(

                            mSystemService, null, options, sharedMemory, callback);

                            mSystemService, null, callback);

            mSoftwareHotwordDetector.registerOnDestroyListener(

                    (detector) -> onMicrophoneHotwordDetectorDestroyed(

                            (SoftwareHotwordDetector) detector));

            mSoftwareHotwordDetector.initialize(options, sharedMemory);

        }

        return mSoftwareHotwordDetector;

    }