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

Commit e601349c authored by Daniel Kim's avatar Daniel Kim Committed by Daniel
Browse files

Revert^2 "Add proximity state to the HotwordDetectedResult" 

Reverting the previous revert commit which was merged to resolve the
broken tests. Adding a fix to the broken tests by surrounding
mAttentionManagerInternal with null checks.

dbe5ad1a

Test: atest CtsVoiceInteractionTestCases, atest CtsVoiceInteractionTestCases:android.voiceinteraction.cts.AlwaysOnHotwordDetectorTest#testAlwaysOnHotwordDetector_startRecognitionWithData -- --abi x86_64
Change-Id: Ife5fb9220518a32a89494217f56932f290cce5f3
parent 11bdf8e2

core/java/android/service/voice/HotwordDetectedResult.java

+53 −4
Original line number Diff line number Diff line
@@ -95,6 +95,16 @@ public final class HotwordDetectedResult implements Parcelable { 
    /** Limits the max value for the triggered audio channel. */

    private static final int LIMIT_AUDIO_CHANNEL_MAX_VALUE = 63;



    /**

     * The bundle key for proximity value

     *

     * TODO(b/238896013): Move the proximity logic out of bundle to proper API.

     *

     * @hide

     */

    public static final String EXTRA_PROXIMITY_METERS =

            "android.service.voice.extra.PROXIMITY_METERS";



    /** Confidence level in the trigger outcome. */

    @HotwordConfidenceLevelValue

    private final int mConfidenceLevel;
@@ -197,6 +207,14 @@ public final class HotwordDetectedResult implements Parcelable { 
     * <p>The use of this method is discouraged, and support for it will be removed in future

     * versions of Android.

     *

     * <p>After the trigger happens, a special case of proximity-related extra, with the key of

     * 'android.service.voice.extra.PROXIMITY_METERS' and the value of distance in meters (double),

     * will be stored to enable proximity logic. The proximity meters is provided by the system,

     * on devices that support detecting proximity of nearby users, to help disambiguate which

     * nearby device should respond. When the proximity is unknown, the proximity value will not

     * be stored. This mapping will be excluded from the max bundle size calculation because this

     * mapping is included after the result is returned from the hotword detector service.

     *

     * <p>This is a PersistableBundle so it doesn't allow any remotable objects or other contents

     * that can be used to communicate with other processes.

     */
@@ -315,8 +333,23 @@ public final class HotwordDetectedResult implements Parcelable { 
                    "audioChannel");

        }

        if (!mExtras.isEmpty()) {

            Preconditions.checkArgumentInRange(getParcelableSize(mExtras), 0, getMaxBundleSize(),

                    "extras");

            // Remove the proximity key from the bundle before checking the bundle size. The

            // proximity value is added after the privileged module and can avoid the

            // maxBundleSize limitation.

            if (mExtras.containsKey(EXTRA_PROXIMITY_METERS)) {

                double proximityMeters = mExtras.getDouble(EXTRA_PROXIMITY_METERS);

                mExtras.remove(EXTRA_PROXIMITY_METERS);

                // Skip checking parcelable size if the new bundle size is 0. Newly empty bundle

                // has parcelable size of 4, but the default bundle has parcelable size of 0.

                if (mExtras.size() > 0) {

                    Preconditions.checkArgumentInRange(getParcelableSize(mExtras), 0,

                            getMaxBundleSize(), "extras");

                }

                mExtras.putDouble(EXTRA_PROXIMITY_METERS, proximityMeters);

            } else {

                Preconditions.checkArgumentInRange(getParcelableSize(mExtras), 0,

                        getMaxBundleSize(), "extras");

            }

        }

    }
@@ -513,6 +546,14 @@ public final class HotwordDetectedResult implements Parcelable { 
     * <p>The use of this method is discouraged, and support for it will be removed in future

     * versions of Android.

     *

     * <p>After the trigger happens, a special case of proximity-related extra, with the key of

     * 'android.service.voice.extra.PROXIMITY_METERS' and the value of distance in meters (double),

     * will be stored to enable proximity logic. The proximity meters is provided by the system,

     * on devices that support detecting proximity of nearby users, to help disambiguate which

     * nearby device should respond. When the proximity is unknown, the proximity value will not

     * be stored. This mapping will be excluded from the max bundle size calculation because this

     * mapping is included after the result is returned from the hotword detector service.

     *

     * <p>This is a PersistableBundle so it doesn't allow any remotable objects or other contents

     * that can be used to communicate with other processes.

     */
@@ -813,6 +854,14 @@ public final class HotwordDetectedResult implements Parcelable { 
         * <p>The use of this method is discouraged, and support for it will be removed in future

         * versions of Android.

         *

         * <p>After the trigger happens, a special case of proximity-related extra, with the key of

         * 'android.service.voice.extra.PROXIMITY_METERS' and the value of distance in meters (double),

         * will be stored to enable proximity logic. The proximity meters is provided by the system,

         * on devices that support detecting proximity of nearby users, to help disambiguate which

         * nearby device should respond. When the proximity is unknown, the proximity value will not

         * be stored. This mapping will be excluded from the max bundle size calculation because this

         * mapping is included after the result is returned from the hotword detector service.

         *

         * <p>This is a PersistableBundle so it doesn't allow any remotable objects or other contents

         * that can be used to communicate with other processes.

         */
@@ -882,10 +931,10 @@ public final class HotwordDetectedResult implements Parcelable { 
    }



    @DataClass.Generated(

            time = 1625541522353L,

            time = 1658357814396L,

            codegenVersion = "1.0.23",

            sourceFile = "frameworks/base/core/java/android/service/voice/HotwordDetectedResult.java",

            inputSignatures = "public static final  int CONFIDENCE_LEVEL_NONE\npublic static final  int CONFIDENCE_LEVEL_LOW\npublic static final  int CONFIDENCE_LEVEL_LOW_MEDIUM\npublic static final  int CONFIDENCE_LEVEL_MEDIUM\npublic static final  int CONFIDENCE_LEVEL_MEDIUM_HIGH\npublic static final  int CONFIDENCE_LEVEL_HIGH\npublic static final  int CONFIDENCE_LEVEL_VERY_HIGH\npublic static final  int HOTWORD_OFFSET_UNSET\npublic static final  int AUDIO_CHANNEL_UNSET\nprivate static final  int LIMIT_HOTWORD_OFFSET_MAX_VALUE\nprivate static final  int LIMIT_AUDIO_CHANNEL_MAX_VALUE\nprivate final @android.service.voice.HotwordDetectedResult.HotwordConfidenceLevelValue int mConfidenceLevel\nprivate @android.annotation.Nullable android.media.MediaSyncEvent mMediaSyncEvent\nprivate  int mHotwordOffsetMillis\nprivate  int mHotwordDurationMillis\nprivate  int mAudioChannel\nprivate  boolean mHotwordDetectionPersonalized\nprivate final  int mScore\nprivate final  int mPersonalizedScore\nprivate final  int mHotwordPhraseId\nprivate final @android.annotation.NonNull android.os.PersistableBundle mExtras\nprivate static  int sMaxBundleSize\nprivate static  int defaultConfidenceLevel()\nprivate static  int defaultScore()\nprivate static  int defaultPersonalizedScore()\npublic static  int getMaxScore()\nprivate static  int defaultHotwordPhraseId()\npublic static  int getMaxHotwordPhraseId()\nprivate static  android.os.PersistableBundle defaultExtras()\npublic static  int getMaxBundleSize()\npublic @android.annotation.Nullable android.media.MediaSyncEvent getMediaSyncEvent()\npublic static  int getParcelableSize(android.os.Parcelable)\npublic static  int getUsageSize(android.service.voice.HotwordDetectedResult)\nprivate static  int bitCount(long)\nprivate  void onConstructed()\nclass HotwordDetectedResult extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genConstructor=false, genBuilder=true, genEqualsHashCode=true, genHiddenConstDefs=true, genParcelable=true, genToString=true)")

            inputSignatures = "public static final  int CONFIDENCE_LEVEL_NONE\npublic static final  int CONFIDENCE_LEVEL_LOW\npublic static final  int CONFIDENCE_LEVEL_LOW_MEDIUM\npublic static final  int CONFIDENCE_LEVEL_MEDIUM\npublic static final  int CONFIDENCE_LEVEL_MEDIUM_HIGH\npublic static final  int CONFIDENCE_LEVEL_HIGH\npublic static final  int CONFIDENCE_LEVEL_VERY_HIGH\npublic static final  int HOTWORD_OFFSET_UNSET\npublic static final  int AUDIO_CHANNEL_UNSET\nprivate static final  int LIMIT_HOTWORD_OFFSET_MAX_VALUE\nprivate static final  int LIMIT_AUDIO_CHANNEL_MAX_VALUE\npublic static final  java.lang.String EXTRA_PROXIMITY_METERS\nprivate final @android.service.voice.HotwordDetectedResult.HotwordConfidenceLevelValue int mConfidenceLevel\nprivate @android.annotation.Nullable android.media.MediaSyncEvent mMediaSyncEvent\nprivate  int mHotwordOffsetMillis\nprivate  int mHotwordDurationMillis\nprivate  int mAudioChannel\nprivate  boolean mHotwordDetectionPersonalized\nprivate final  int mScore\nprivate final  int mPersonalizedScore\nprivate final  int mHotwordPhraseId\nprivate final @android.annotation.NonNull android.os.PersistableBundle mExtras\nprivate static  int sMaxBundleSize\nprivate static  int defaultConfidenceLevel()\nprivate static  int defaultScore()\nprivate static  int defaultPersonalizedScore()\npublic static  int getMaxScore()\nprivate static  int defaultHotwordPhraseId()\npublic static  int getMaxHotwordPhraseId()\nprivate static  android.os.PersistableBundle defaultExtras()\npublic static  int getMaxBundleSize()\npublic @android.annotation.Nullable android.media.MediaSyncEvent getMediaSyncEvent()\npublic static  int getParcelableSize(android.os.Parcelable)\npublic static  int getUsageSize(android.service.voice.HotwordDetectedResult)\nprivate static  int bitCount(long)\nprivate  void onConstructed()\nclass HotwordDetectedResult extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genConstructor=false, genBuilder=true, genEqualsHashCode=true, genHiddenConstDefs=true, genParcelable=true, genToString=true)")

    @Deprecated

    private void __metadata() {}

services/core/java/com/android/server/attention/AttentionManagerService.java

+3 −0
Original line number Diff line number Diff line
@@ -343,6 +343,9 @@ public class AttentionManagerService extends SystemService { 
     *

     * Calling this multiple times for duplicate requests will be no-ops, returning true.

     *

     * TODO(b/239130847): Maintain the proximity state in AttentionManagerService and change this

     * to a polling API.

     *

     * @return {@code true} if the framework was able to dispatch the request

     */

    @VisibleForTesting

services/voiceinteraction/java/com/android/server/voiceinteraction/HotwordDetectionConnection.java

+35 −0
Original line number Diff line number Diff line
@@ -18,6 +18,8 @@ package com.android.server.voiceinteraction; 


import static android.Manifest.permission.CAPTURE_AUDIO_HOTWORD;

import static android.Manifest.permission.RECORD_AUDIO;

import static android.service.attention.AttentionService.PROXIMITY_UNKNOWN;

import static android.service.voice.HotwordDetectedResult.EXTRA_PROXIMITY_METERS;

import static android.service.voice.HotwordDetectionService.AUDIO_SOURCE_EXTERNAL;

import static android.service.voice.HotwordDetectionService.AUDIO_SOURCE_MICROPHONE;

import static android.service.voice.HotwordDetectionService.INITIALIZATION_STATUS_SUCCESS;
@@ -58,6 +60,7 @@ import static com.android.server.voiceinteraction.SoundTriggerSessionPermissions 
import android.annotation.NonNull;

import android.annotation.Nullable;

import android.app.AppOpsManager;

import android.attention.AttentionManagerInternal;

import android.content.ComponentName;

import android.content.ContentCaptureOptions;

import android.content.Context;
@@ -186,6 +189,19 @@ final class HotwordDetectionConnection { 
    final int mUser;

    final Context mContext;



    @Nullable final AttentionManagerInternal mAttentionManagerInternal;



    final AttentionManagerInternal.ProximityUpdateCallbackInternal mProximityCallbackInternal =

            new AttentionManagerInternal.ProximityUpdateCallbackInternal() {

        @Override

        public void onProximityUpdate(double distance) {

            synchronized (mLock) {

                mProximityMeters = distance;

            }

        }

    };





    volatile HotwordDetectionServiceIdentity mIdentity;

    private IMicrophoneHotwordDetectionVoiceInteractionCallback mSoftwareCallback;

    private Instant mLastRestartInstant;
@@ -206,6 +222,8 @@ final class HotwordDetectionConnection { 
    private @NonNull ServiceConnection mRemoteHotwordDetectionService;

    private IBinder mAudioFlinger;

    private boolean mDebugHotwordLogging = false;

    @GuardedBy("mLock")

    private double mProximityMeters = PROXIMITY_UNKNOWN;



    HotwordDetectionConnection(Object lock, Context context, int voiceInteractionServiceUid,

            Identity voiceInteractorIdentity, ComponentName serviceName, int userId,
@@ -233,6 +251,10 @@ final class HotwordDetectionConnection { 
        mServiceConnectionFactory = new ServiceConnectionFactory(intent, bindInstantServiceAllowed);



        mRemoteHotwordDetectionService = mServiceConnectionFactory.createLocked();

        mAttentionManagerInternal = LocalServices.getService(AttentionManagerInternal.class);

        if (mAttentionManagerInternal != null) {

            mAttentionManagerInternal.onStartProximityUpdates(mProximityCallbackInternal);

        }



        mLastRestartInstant = Instant.now();

        updateStateAfterProcessStart(options, sharedMemory);
@@ -397,6 +419,9 @@ final class HotwordDetectionConnection { 
        if (mAudioFlinger != null) {

            mAudioFlinger.unlinkToDeath(mAudioServerDeathRecipient, /* flags= */ 0);

        }

        if (mAttentionManagerInternal != null) {

            mAttentionManagerInternal.onStopProximityUpdates(mProximityCallbackInternal);

        }

    }



    void updateStateLocked(PersistableBundle options, SharedMemory sharedMemory) {
@@ -464,6 +489,7 @@ final class HotwordDetectionConnection { 
                        mSoftwareCallback.onError();

                        return;

                    }

                    saveProximityMetersToBundle(result);

                    mSoftwareCallback.onDetected(result, null, null);

                    if (result != null) {

                        Slog.i(TAG, "Egressed " + HotwordDetectedResult.getUsageSize(result)
@@ -591,6 +617,7 @@ final class HotwordDetectionConnection { 
                        externalCallback.onError(CALLBACK_ONDETECTED_GOT_SECURITY_EXCEPTION);

                        return;

                    }

                    saveProximityMetersToBundle(result);

                    externalCallback.onKeyphraseDetected(recognitionEvent, result);

                    if (result != null) {

                        Slog.i(TAG, "Egressed " + HotwordDetectedResult.getUsageSize(result)
@@ -1159,6 +1186,14 @@ final class HotwordDetectionConnection { 
        });

    }



    private void saveProximityMetersToBundle(HotwordDetectedResult result) {

        synchronized (mLock) {

            if (result != null && mProximityMeters != PROXIMITY_UNKNOWN) {

                result.getExtras().putDouble(EXTRA_PROXIMITY_METERS, mProximityMeters);

            }

        }

    }



    private static void bestEffortClose(Closeable... closeables) {

        for (Closeable closeable : closeables) {

            bestEffortClose(closeable);