Merge changes from topics "presubmit-am-396588a7c76a4caab06560123f7aa31f",... (9197321f) · Commits · e / os / android_frameworks_base

services/core/java/com/android/server/soundtrigger_middleware/AidlUtil.java

0 → 100644

+71 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2022 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.media.soundtrigger.PhraseRecognitionEvent;
		import android.media.soundtrigger.PhraseRecognitionExtra;
		import android.media.soundtrigger.RecognitionEvent;
		import android.media.soundtrigger.RecognitionStatus;
		import android.media.soundtrigger.SoundModelType;

		/**
		* Utilities for working with sound trigger related AIDL generated types.
		*/
		public class AidlUtil {
		/**
		* Initialize a new recognition event.
		* @return The new event.
		*/
		static RecognitionEvent newEmptyRecognitionEvent() {
		RecognitionEvent result = new RecognitionEvent();
		result.data = new byte[0];
		return result;
		}

		/**
		* Initialize a new phrase recognition event.
		* @return The new event.
		*/
		static PhraseRecognitionEvent newEmptyPhraseRecognitionEvent() {
		PhraseRecognitionEvent result = new PhraseRecognitionEvent();
		result.common = newEmptyRecognitionEvent();
		result.phraseExtras = new PhraseRecognitionExtra[0];
		return result;
		}

		/**
		* Creates a new generic abort event.
		* @return The new event.
		*/
		static RecognitionEvent newAbortEvent() {
		RecognitionEvent event = newEmptyRecognitionEvent();
		event.type = SoundModelType.GENERIC;
		event.status = RecognitionStatus.ABORTED;
		return event;
		}

		/**
		* Creates a new generic phrase event.
		* @return The new event.
		*/
		static PhraseRecognitionEvent newAbortPhraseEvent() {
		PhraseRecognitionEvent event = newEmptyPhraseRecognitionEvent();
		event.common.type = SoundModelType.KEYPHRASE;
		event.common.status = RecognitionStatus.ABORTED;
		return event;
		}
		}

services/core/java/com/android/server/soundtrigger_middleware/SoundTriggerHalConcurrentCaptureHandler.java

+8 −30

Original line number	Diff line number	Diff line
		@@ -20,12 +20,10 @@ import android.annotation.NonNull;
		import android.media.permission.SafeCloseable;
		import android.media.soundtrigger.ModelParameterRange;
		import android.media.soundtrigger.PhraseRecognitionEvent;
		import android.media.soundtrigger.PhraseRecognitionExtra;
		import android.media.soundtrigger.PhraseSoundModel;
		import android.media.soundtrigger.Properties;
		import android.media.soundtrigger.RecognitionConfig;
		import android.media.soundtrigger.RecognitionEvent;
		import android.media.soundtrigger.RecognitionStatus;
		import android.media.soundtrigger.SoundModel;
		import android.media.soundtrigger.SoundModelType;
		import android.media.soundtrigger.Status;
		@@ -392,20 +390,13 @@ public class SoundTriggerHalConcurrentCaptureHandler implements ISoundTriggerHal
		/** Notify the client that recognition has been aborted. */
		private static void notifyAbort(int modelHandle, LoadedModel model) {
		switch (model.type) {
		case SoundModelType.GENERIC: {
		RecognitionEvent event = newEmptyRecognitionEvent();
		event.status = RecognitionStatus.ABORTED;
		event.type = SoundModelType.GENERIC;
		model.callback.recognitionCallback(modelHandle, event);
		}
		case SoundModelType.GENERIC:
		model.callback.recognitionCallback(modelHandle, AidlUtil.newAbortEvent());
		break;

		case SoundModelType.KEYPHRASE: {
		PhraseRecognitionEvent event = newEmptyPhraseRecognitionEvent();
		event.common.status = RecognitionStatus.ABORTED;
		event.common.type = SoundModelType.KEYPHRASE;
		model.callback.phraseRecognitionCallback(modelHandle, event);
		}
		case SoundModelType.KEYPHRASE:
		model.callback.phraseRecognitionCallback(modelHandle,
		AidlUtil.newAbortPhraseEvent());
		break;
		}
		}
		@@ -416,19 +407,6 @@ public class SoundTriggerHalConcurrentCaptureHandler implements ISoundTriggerHal
		mNotifier.unregisterListener(this);
		}

		private static PhraseRecognitionEvent newEmptyPhraseRecognitionEvent() {
		PhraseRecognitionEvent result = new PhraseRecognitionEvent();
		result.common = newEmptyRecognitionEvent();
		result.phraseExtras = new PhraseRecognitionExtra[0];
		return result;
		}

		private static RecognitionEvent newEmptyRecognitionEvent() {
		RecognitionEvent result = new RecognitionEvent();
		result.data = new byte[0];
		return result;
		}

		////////////////////////////////////////////////////////////////////////////////////////////////
		// All methods below do trivial delegation - no interesting logic.
		@Override

services/core/java/com/android/server/soundtrigger_middleware/SoundTriggerModule.java

+42 −6

Original line number	Diff line number	Diff line
		@@ -25,6 +25,7 @@ import android.media.soundtrigger.Properties;
		import android.media.soundtrigger.RecognitionConfig;
		import android.media.soundtrigger.RecognitionEvent;
		import android.media.soundtrigger.SoundModel;
		import android.media.soundtrigger.SoundModelType;
		import android.media.soundtrigger.Status;
		import android.media.soundtrigger_middleware.ISoundTriggerCallback;
		import android.media.soundtrigger_middleware.ISoundTriggerModule;
		@@ -305,9 +306,12 @@ class SoundTriggerModule implements IBinder.DeathRecipient, ISoundTriggerHal.Glo

		@Override
		public void stopRecognition(int modelHandle) {
		Model model;
		synchronized (SoundTriggerModule.this) {
		mLoadedModels.get(modelHandle).stopRecognition();
		checkValid();
		model = mLoadedModels.get(modelHandle);
		}
		model.stopRecognition();
		}

		@Override
		@@ -374,6 +378,7 @@ class SoundTriggerModule implements IBinder.DeathRecipient, ISoundTriggerHal.Glo
		private class Model implements ISoundTriggerHal.ModelCallback {
		public int mHandle;
		private ModelState mState = ModelState.INIT;
		private int mType = SoundModelType.INVALID;
		private SoundTriggerMiddlewareImpl.AudioSessionProvider.AudioSession mSession;

		private @NonNull
		@@ -390,6 +395,7 @@ class SoundTriggerModule implements IBinder.DeathRecipient, ISoundTriggerHal.Glo
		SoundTriggerMiddlewareImpl.AudioSessionProvider.AudioSession audioSession) {
		mSession = audioSession;
		mHandle = mHalService.loadSoundModel(model, this);
		mType = SoundModelType.GENERIC;
		setState(ModelState.LOADED);
		mLoadedModels.put(mHandle, this);
		return mHandle;
		@@ -399,7 +405,7 @@ class SoundTriggerModule implements IBinder.DeathRecipient, ISoundTriggerHal.Glo
		SoundTriggerMiddlewareImpl.AudioSessionProvider.AudioSession audioSession) {
		mSession = audioSession;
		mHandle = mHalService.loadPhraseSoundModel(model, this);

		mType = SoundModelType.KEYPHRASE;
		setState(ModelState.LOADED);
		mLoadedModels.put(mHandle, this);
		return mHandle;
		@@ -422,13 +428,42 @@ class SoundTriggerModule implements IBinder.DeathRecipient, ISoundTriggerHal.Glo
		}

		private void stopRecognition() {
		synchronized (SoundTriggerModule.this) {
		if (getState() == ModelState.LOADED) {
		// This call is idempotent in order to avoid races.
		return;
		}
		}
		// This must be invoked outside the lock.
		mHalService.stopRecognition(mHandle);

		// No more callbacks for this model after this point.
		synchronized (SoundTriggerModule.this) {
		// Generate an abortion callback to the client if the model is still active.
		if (getState() == ModelState.ACTIVE) {
		if (mCallback != null) {
		try {
		switch (mType) {
		case SoundModelType.GENERIC:
		mCallback.onRecognition(mHandle, AidlUtil.newAbortEvent(),
		mSession.mSessionHandle);
		break;
		case SoundModelType.KEYPHRASE:
		mCallback.onPhraseRecognition(mHandle,
		AidlUtil.newAbortPhraseEvent(),
		mSession.mSessionHandle);
		break;
		default:
		throw new RuntimeException(
		"Unexpected model type: " + mType);
		}
		} catch (RemoteException e) {
		}
		}
		setState(ModelState.LOADED);
		}
		}
		}

		/** Request a forced recognition event. Will do nothing if recognition is inactive. */
		private void forceRecognitionEvent() {
		@@ -518,4 +553,5 @@ class SoundTriggerModule implements IBinder.DeathRecipient, ISoundTriggerHal.Glo
		}
		}
		}

		}

services/tests/servicestests/src/com/android/server/soundtrigger_middleware/SoundTriggerMiddlewareImplTest.java

+10 −0

Original line number	Diff line number	Diff line
		@@ -224,6 +224,11 @@ public class SoundTriggerMiddlewareImplTest {
		// Stop the recognition.
		stopRecognition(module, handle, hwHandle);

		ArgumentCaptor<RecognitionEvent> eventCaptor = ArgumentCaptor.forClass(
		RecognitionEvent.class);
		verify(callback).onRecognition(eq(handle), eventCaptor.capture(), eq(101));
		assertEquals(RecognitionStatus.ABORTED, eventCaptor.getValue().status);

		// Unload the model.
		unloadModel(module, handle, hwHandle);
		module.detach();
		@@ -268,6 +273,11 @@ public class SoundTriggerMiddlewareImplTest {
		// Stop the recognition.
		stopRecognition(module, handle, hwHandle);

		ArgumentCaptor<PhraseRecognitionEvent> eventCaptor = ArgumentCaptor.forClass(
		PhraseRecognitionEvent.class);
		verify(callback).onPhraseRecognition(eq(handle), eventCaptor.capture(), eq(101));
		assertEquals(RecognitionStatus.ABORTED, eventCaptor.getValue().common.status);

		// Unload the model.
		unloadModel(module, handle, hwHandle);
		module.detach();

services/voiceinteraction/java/com/android/server/soundtrigger/SoundTriggerHelper.java

+53 −29

Original line number	Diff line number	Diff line
		@@ -84,6 +84,9 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {

		private static final int INVALID_VALUE = Integer.MIN_VALUE;

		/** Maximum time to wait for a model stop confirmation before giving up. */
		private static final long STOP_TIMEOUT_MS = 5000;

		/** The {@link ModuleProperties} for the system, or null if none exists. */
		final ModuleProperties mModuleProperties;

		@@ -831,7 +834,7 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		}

		if (!event.recognitionStillActive) {
		model.setStopped();
		model.setStoppedLocked();
		}

		try {
		@@ -918,7 +921,7 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		MetricsLogger.count(mContext, "sth_recognition_aborted", 1);
		ModelData modelData = getModelDataForLocked(event.soundModelHandle);
		if (modelData != null && modelData.isModelStarted()) {
		modelData.setStopped();
		modelData.setStoppedLocked();
		try {
		modelData.getCallback().onRecognitionPaused();
		} catch (DeadObjectException e) {
		@@ -972,7 +975,7 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		}

		if (!event.recognitionStillActive) {
		modelData.setStopped();
		modelData.setStoppedLocked();
		}

		try {
		@@ -1200,7 +1203,7 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		if (modelData.isModelStarted()) {
		Slog.d(TAG, "Stopping previously started dangling model " + modelData.getHandle());
		if (mModule.stopRecognition(modelData.getHandle()) == STATUS_OK) {
		modelData.setStopped();
		modelData.setStoppedLocked();
		modelData.setRequested(false);
		} else {
		Slog.e(TAG, "Failed to stop model " + modelData.getHandle());
		@@ -1249,7 +1252,7 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		private ModelData getOrCreateGenericModelDataLocked(UUID modelId) {
		ModelData modelData = mModelDataMap.get(modelId);
		if (modelData == null) {
		modelData = ModelData.createGenericModelData(modelId);
		modelData = createGenericModelData(modelId);
		mModelDataMap.put(modelId, modelData);
		} else if (!modelData.isGenericModel()) {
		Slog.e(TAG, "UUID already used for non-generic model.");
		@@ -1281,7 +1284,7 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		mKeyphraseUuidMap.remove(keyphraseId);
		mModelDataMap.remove(modelId);
		mKeyphraseUuidMap.put(keyphraseId, modelId);
		ModelData modelData = ModelData.createKeyphraseModelData(modelId);
		ModelData modelData = createKeyphraseModelData(modelId);
		mModelDataMap.put(modelId, modelData);
		return modelData;
		}
		@@ -1413,8 +1416,17 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		Slog.w(TAG, "RemoteException in onError", e);
		}
		}
		} else {
		modelData.setStopped();
		return status;
		}

		// Wait for model to be stopped.
		try {
		modelData.waitStoppedLocked(STOP_TIMEOUT_MS);
		} catch (InterruptedException e) {
		Slog.e(TAG, "Didn't receive model stop callback");
		return SoundTrigger.STATUS_ERROR;
		}

		MetricsLogger.count(mContext, "sth_stop_recognition_success", 1);
		// Notify of pause if needed.
		if (notify) {
		@@ -1426,7 +1438,6 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		Slog.w(TAG, "RemoteException in onRecognitionPaused", e);
		}
		}
		}
		if (DBG) {
		Slog.d(TAG, "Model being stopped :" + modelData.toString());
		}
		@@ -1459,7 +1470,7 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {

		// This class encapsulates the callbacks, state, handles and any other information that
		// represents a model.
		private static class ModelData {
		private class ModelData {
		// Model not loaded (and hence not started).
		static final int MODEL_NOTLOADED = 0;

		@@ -1516,17 +1527,9 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		mModelType = modelType;
		}

		static ModelData createKeyphraseModelData(UUID modelId) {
		return new ModelData(modelId, SoundModel.TYPE_KEYPHRASE);
		}

		static ModelData createGenericModelData(UUID modelId) {
		return new ModelData(modelId, SoundModel.TYPE_GENERIC_SOUND);
		}

		// Note that most of the functionality in this Java class will not work for
		// SoundModel.TYPE_UNKNOWN nevertheless we have it since lower layers support it.
		static ModelData createModelDataOfUnknownType(UUID modelId) {
		ModelData createModelDataOfUnknownType(UUID modelId) {
		return new ModelData(modelId, SoundModel.TYPE_UNKNOWN);
		}

		@@ -1550,8 +1553,20 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		mModelState = MODEL_STARTED;
		}

		synchronized void setStopped() {
		synchronized void setStoppedLocked() {
		mModelState = MODEL_LOADED;
		mLock.notifyAll();
		}

		void waitStoppedLocked(long timeoutMs) throws InterruptedException {
		long deadline = System.currentTimeMillis() + timeoutMs;
		while (mModelState == MODEL_STARTED) {
		long waitTime = deadline - System.currentTimeMillis();
		if (waitTime <= 0) {
		throw new InterruptedException();
		}
		mLock.wait(waitTime);
		}
		}

		synchronized void setLoaded() {
		@@ -1571,6 +1586,7 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		mRecognitionConfig = null;
		mRequested = false;
		mCallback = null;
		notifyAll();
		}

		synchronized void clearCallback() {
		@@ -1675,4 +1691,12 @@ public class SoundTriggerHelper implements SoundTrigger.StatusListener {
		return "Model type: " + type + "\n";
		}
		}

		ModelData createKeyphraseModelData(UUID modelId) {
		return new ModelData(modelId, SoundModel.TYPE_KEYPHRASE);
		}

		ModelData createGenericModelData(UUID modelId) {
		return new ModelData(modelId, SoundModel.TYPE_GENERIC_SOUND);
		}
		}