blob: 5ae035625ee6063893501d0cecae05ca2ec1572d [file] [log] [blame]
Eric Laurentb7a11d82014-04-18 17:40:41 -07001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define LOG_TAG "SoundTriggerHwService"
18//#define LOG_NDEBUG 0
19
20#include <stdio.h>
21#include <string.h>
22#include <sys/types.h>
23#include <pthread.h>
24
Eric Laurent8ba53d82014-08-01 23:15:05 +000025#include <system/sound_trigger.h>
26#include <cutils/atomic.h>
27#include <cutils/properties.h>
Eric Laurentdf3dc7e2014-07-27 18:39:40 -070028#include <hardware/hardware.h>
29#include <media/AudioSystem.h>
Eric Laurent8ba53d82014-08-01 23:15:05 +000030#include <utils/Errors.h>
31#include <utils/Log.h>
Eric Laurentb7a11d82014-04-18 17:40:41 -070032#include <binder/IServiceManager.h>
33#include <binder/MemoryBase.h>
34#include <binder/MemoryHeapBase.h>
Eric Laurent936c84a2014-07-17 10:26:04 -070035#include <hardware/sound_trigger.h>
Eric Laurent8ba53d82014-08-01 23:15:05 +000036#include <ServiceUtilities.h>
37#include "SoundTriggerHwService.h"
Eric Laurentb7a11d82014-04-18 17:40:41 -070038
39namespace android {
40
41#ifdef SOUND_TRIGGER_USE_STUB_MODULE
42#define HW_MODULE_PREFIX "stub"
43#else
44#define HW_MODULE_PREFIX "primary"
45#endif
46
47SoundTriggerHwService::SoundTriggerHwService()
48 : BnSoundTriggerHwService(),
Eric Laurentdf3dc7e2014-07-27 18:39:40 -070049 mNextUniqueId(1),
50 mMemoryDealer(new MemoryDealer(1024 * 1024, "SoundTriggerHwService")),
51 mCaptureState(false)
Eric Laurentb7a11d82014-04-18 17:40:41 -070052{
53}
54
55void SoundTriggerHwService::onFirstRef()
56{
57 const hw_module_t *mod;
58 int rc;
59 sound_trigger_hw_device *dev;
60
61 rc = hw_get_module_by_class(SOUND_TRIGGER_HARDWARE_MODULE_ID, HW_MODULE_PREFIX, &mod);
62 if (rc != 0) {
63 ALOGE("couldn't load sound trigger module %s.%s (%s)",
Ryan Bavetta9609a912016-01-28 19:22:29 -080064 SOUND_TRIGGER_HARDWARE_MODULE_ID, HW_MODULE_PREFIX, strerror(-rc));
Eric Laurentb7a11d82014-04-18 17:40:41 -070065 return;
66 }
67 rc = sound_trigger_hw_device_open(mod, &dev);
68 if (rc != 0) {
69 ALOGE("couldn't open sound trigger hw device in %s.%s (%s)",
Ryan Bavetta9609a912016-01-28 19:22:29 -080070 SOUND_TRIGGER_HARDWARE_MODULE_ID, HW_MODULE_PREFIX, strerror(-rc));
Eric Laurentb7a11d82014-04-18 17:40:41 -070071 return;
72 }
Chris Thorntonefcf16c2016-03-27 17:13:28 -070073 if (dev->common.version < SOUND_TRIGGER_DEVICE_API_VERSION_1_0 ||
74 dev->common.version > SOUND_TRIGGER_DEVICE_API_VERSION_CURRENT) {
Eric Laurentb7a11d82014-04-18 17:40:41 -070075 ALOGE("wrong sound trigger hw device version %04x", dev->common.version);
76 return;
77 }
78
79 sound_trigger_module_descriptor descriptor;
80 rc = dev->get_properties(dev, &descriptor.properties);
81 if (rc != 0) {
82 ALOGE("could not read implementation properties");
83 return;
84 }
85 descriptor.handle =
86 (sound_trigger_module_handle_t)android_atomic_inc(&mNextUniqueId);
87 ALOGI("loaded default module %s, handle %d", descriptor.properties.description,
88 descriptor.handle);
89
90 sp<ISoundTriggerClient> client;
91 sp<Module> module = new Module(this, dev, descriptor, client);
92 mModules.add(descriptor.handle, module);
93 mCallbackThread = new CallbackThread(this);
94}
95
96SoundTriggerHwService::~SoundTriggerHwService()
97{
98 if (mCallbackThread != 0) {
99 mCallbackThread->exit();
100 }
101 for (size_t i = 0; i < mModules.size(); i++) {
102 sound_trigger_hw_device_close(mModules.valueAt(i)->hwDevice());
103 }
104}
105
106status_t SoundTriggerHwService::listModules(struct sound_trigger_module_descriptor *modules,
107 uint32_t *numModules)
108{
109 ALOGV("listModules");
Eric Laurent8ba53d82014-08-01 23:15:05 +0000110 if (!captureHotwordAllowed()) {
111 return PERMISSION_DENIED;
112 }
113
Eric Laurentb7a11d82014-04-18 17:40:41 -0700114 AutoMutex lock(mServiceLock);
115 if (numModules == NULL || (*numModules != 0 && modules == NULL)) {
116 return BAD_VALUE;
117 }
118 size_t maxModules = *numModules;
119 *numModules = mModules.size();
120 for (size_t i = 0; i < mModules.size() && i < maxModules; i++) {
121 modules[i] = mModules.valueAt(i)->descriptor();
122 }
123 return NO_ERROR;
124}
125
126status_t SoundTriggerHwService::attach(const sound_trigger_module_handle_t handle,
127 const sp<ISoundTriggerClient>& client,
128 sp<ISoundTrigger>& moduleInterface)
129{
130 ALOGV("attach module %d", handle);
Eric Laurent8ba53d82014-08-01 23:15:05 +0000131 if (!captureHotwordAllowed()) {
132 return PERMISSION_DENIED;
133 }
134
Eric Laurentb7a11d82014-04-18 17:40:41 -0700135 AutoMutex lock(mServiceLock);
136 moduleInterface.clear();
137 if (client == 0) {
138 return BAD_VALUE;
139 }
140 ssize_t index = mModules.indexOfKey(handle);
141 if (index < 0) {
142 return BAD_VALUE;
143 }
144 sp<Module> module = mModules.valueAt(index);
145
146 module->setClient(client);
Marco Nelissenf8880202014-11-14 07:58:25 -0800147 IInterface::asBinder(client)->linkToDeath(module);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700148 moduleInterface = module;
149
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700150 module->setCaptureState_l(mCaptureState);
151
Eric Laurentb7a11d82014-04-18 17:40:41 -0700152 return NO_ERROR;
153}
154
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700155status_t SoundTriggerHwService::setCaptureState(bool active)
156{
157 ALOGV("setCaptureState %d", active);
158 AutoMutex lock(mServiceLock);
159 mCaptureState = active;
160 for (size_t i = 0; i < mModules.size(); i++) {
161 mModules.valueAt(i)->setCaptureState_l(active);
162 }
163 return NO_ERROR;
164}
165
166
167void SoundTriggerHwService::detachModule(sp<Module> module)
168{
Eric Laurent936c84a2014-07-17 10:26:04 -0700169 ALOGV("detachModule");
Eric Laurent8ba53d82014-08-01 23:15:05 +0000170 AutoMutex lock(mServiceLock);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700171 module->clearClient();
172}
173
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700174
Eric Laurentb7a11d82014-04-18 17:40:41 -0700175static const int kDumpLockRetries = 50;
176static const int kDumpLockSleep = 60000;
177
178static bool tryLock(Mutex& mutex)
179{
180 bool locked = false;
181 for (int i = 0; i < kDumpLockRetries; ++i) {
182 if (mutex.tryLock() == NO_ERROR) {
183 locked = true;
184 break;
185 }
186 usleep(kDumpLockSleep);
187 }
188 return locked;
189}
190
191status_t SoundTriggerHwService::dump(int fd, const Vector<String16>& args __unused) {
192 String8 result;
193 if (checkCallingPermission(String16("android.permission.DUMP")) == false) {
194 result.appendFormat("Permission Denial: can't dump SoundTriggerHwService");
195 write(fd, result.string(), result.size());
196 } else {
197 bool locked = tryLock(mServiceLock);
198 // failed to lock - SoundTriggerHwService is probably deadlocked
199 if (!locked) {
200 result.append("SoundTriggerHwService may be deadlocked\n");
201 write(fd, result.string(), result.size());
202 }
203
204 if (locked) mServiceLock.unlock();
205 }
206 return NO_ERROR;
207}
208
209status_t SoundTriggerHwService::onTransact(
210 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags) {
211 return BnSoundTriggerHwService::onTransact(code, data, reply, flags);
212}
213
214
215// static
216void SoundTriggerHwService::recognitionCallback(struct sound_trigger_recognition_event *event,
217 void *cookie)
218{
219 Module *module = (Module *)cookie;
220 if (module == NULL) {
221 return;
222 }
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700223 sp<SoundTriggerHwService> service = module->service().promote();
224 if (service == 0) {
225 return;
226 }
227
228 service->sendRecognitionEvent(event, module);
229}
230
231sp<IMemory> SoundTriggerHwService::prepareRecognitionEvent_l(
232 struct sound_trigger_recognition_event *event)
233{
234 sp<IMemory> eventMemory;
235
236 //sanitize event
237 switch (event->type) {
238 case SOUND_MODEL_TYPE_KEYPHRASE:
239 ALOGW_IF(event->data_size != 0 && event->data_offset !=
240 sizeof(struct sound_trigger_phrase_recognition_event),
241 "prepareRecognitionEvent_l(): invalid data offset %u for keyphrase event type",
242 event->data_offset);
243 event->data_offset = sizeof(struct sound_trigger_phrase_recognition_event);
244 break;
Ryan Bavetta00a727c2016-01-26 21:56:19 -0800245 case SOUND_MODEL_TYPE_GENERIC:
246 ALOGW_IF(event->data_size != 0 && event->data_offset !=
247 sizeof(struct sound_trigger_generic_recognition_event),
248 "prepareRecognitionEvent_l(): invalid data offset %u for generic event type",
249 event->data_offset);
250 event->data_offset = sizeof(struct sound_trigger_generic_recognition_event);
251 break;
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700252 case SOUND_MODEL_TYPE_UNKNOWN:
253 ALOGW_IF(event->data_size != 0 && event->data_offset !=
254 sizeof(struct sound_trigger_recognition_event),
255 "prepareRecognitionEvent_l(): invalid data offset %u for unknown event type",
256 event->data_offset);
257 event->data_offset = sizeof(struct sound_trigger_recognition_event);
258 break;
259 default:
Eric Laurent886561f2014-08-28 19:45:37 -0700260 return eventMemory;
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700261 }
262
263 size_t size = event->data_offset + event->data_size;
264 eventMemory = mMemoryDealer->allocate(size);
265 if (eventMemory == 0 || eventMemory->pointer() == NULL) {
266 eventMemory.clear();
267 return eventMemory;
268 }
269 memcpy(eventMemory->pointer(), event, size);
270
271 return eventMemory;
272}
273
274void SoundTriggerHwService::sendRecognitionEvent(struct sound_trigger_recognition_event *event,
275 Module *module)
276 {
277 AutoMutex lock(mServiceLock);
278 if (module == NULL) {
279 return;
280 }
281 sp<IMemory> eventMemory = prepareRecognitionEvent_l(event);
282 if (eventMemory == 0) {
283 return;
284 }
285 sp<Module> strongModule;
286 for (size_t i = 0; i < mModules.size(); i++) {
287 if (mModules.valueAt(i).get() == module) {
288 strongModule = mModules.valueAt(i);
289 break;
290 }
291 }
292 if (strongModule == 0) {
293 return;
294 }
295
296 sendCallbackEvent_l(new CallbackEvent(CallbackEvent::TYPE_RECOGNITION,
297 eventMemory, strongModule));
298}
299
300// static
301void SoundTriggerHwService::soundModelCallback(struct sound_trigger_model_event *event,
302 void *cookie)
303{
304 Module *module = (Module *)cookie;
305 if (module == NULL) {
306 return;
307 }
308 sp<SoundTriggerHwService> service = module->service().promote();
309 if (service == 0) {
310 return;
311 }
312
313 service->sendSoundModelEvent(event, module);
314}
315
316sp<IMemory> SoundTriggerHwService::prepareSoundModelEvent_l(struct sound_trigger_model_event *event)
317{
318 sp<IMemory> eventMemory;
319
320 size_t size = event->data_offset + event->data_size;
321 eventMemory = mMemoryDealer->allocate(size);
322 if (eventMemory == 0 || eventMemory->pointer() == NULL) {
323 eventMemory.clear();
324 return eventMemory;
325 }
326 memcpy(eventMemory->pointer(), event, size);
327
328 return eventMemory;
329}
330
331void SoundTriggerHwService::sendSoundModelEvent(struct sound_trigger_model_event *event,
332 Module *module)
333{
334 AutoMutex lock(mServiceLock);
335 sp<IMemory> eventMemory = prepareSoundModelEvent_l(event);
336 if (eventMemory == 0) {
337 return;
338 }
339 sp<Module> strongModule;
340 for (size_t i = 0; i < mModules.size(); i++) {
341 if (mModules.valueAt(i).get() == module) {
342 strongModule = mModules.valueAt(i);
343 break;
344 }
345 }
346 if (strongModule == 0) {
347 return;
348 }
349 sendCallbackEvent_l(new CallbackEvent(CallbackEvent::TYPE_SOUNDMODEL,
350 eventMemory, strongModule));
Eric Laurentb7a11d82014-04-18 17:40:41 -0700351}
352
353
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700354sp<IMemory> SoundTriggerHwService::prepareServiceStateEvent_l(sound_trigger_service_state_t state)
Eric Laurentb7a11d82014-04-18 17:40:41 -0700355{
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700356 sp<IMemory> eventMemory;
357
358 size_t size = sizeof(sound_trigger_service_state_t);
359 eventMemory = mMemoryDealer->allocate(size);
360 if (eventMemory == 0 || eventMemory->pointer() == NULL) {
361 eventMemory.clear();
362 return eventMemory;
363 }
364 *((sound_trigger_service_state_t *)eventMemory->pointer()) = state;
365 return eventMemory;
Eric Laurentb7a11d82014-04-18 17:40:41 -0700366}
367
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700368// call with mServiceLock held
369void SoundTriggerHwService::sendServiceStateEvent_l(sound_trigger_service_state_t state,
370 Module *module)
Eric Laurentb7a11d82014-04-18 17:40:41 -0700371{
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700372 sp<IMemory> eventMemory = prepareServiceStateEvent_l(state);
373 if (eventMemory == 0) {
374 return;
375 }
376 sp<Module> strongModule;
377 for (size_t i = 0; i < mModules.size(); i++) {
378 if (mModules.valueAt(i).get() == module) {
379 strongModule = mModules.valueAt(i);
380 break;
381 }
382 }
383 if (strongModule == 0) {
384 return;
385 }
386 sendCallbackEvent_l(new CallbackEvent(CallbackEvent::TYPE_SERVICE_STATE,
387 eventMemory, strongModule));
388}
389
390// call with mServiceLock held
391void SoundTriggerHwService::sendCallbackEvent_l(const sp<CallbackEvent>& event)
392{
393 mCallbackThread->sendCallbackEvent(event);
394}
395
396void SoundTriggerHwService::onCallbackEvent(const sp<CallbackEvent>& event)
397{
398 ALOGV("onCallbackEvent");
Eric Laurentb7a11d82014-04-18 17:40:41 -0700399 sp<Module> module;
400 {
401 AutoMutex lock(mServiceLock);
402 module = event->mModule.promote();
403 if (module == 0) {
404 return;
405 }
406 }
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700407 module->onCallbackEvent(event);
408 {
409 AutoMutex lock(mServiceLock);
410 // clear now to execute with mServiceLock locked
411 event->mMemory.clear();
412 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700413}
414
415#undef LOG_TAG
416#define LOG_TAG "SoundTriggerHwService::CallbackThread"
417
418SoundTriggerHwService::CallbackThread::CallbackThread(const wp<SoundTriggerHwService>& service)
419 : mService(service)
420{
421}
422
423SoundTriggerHwService::CallbackThread::~CallbackThread()
424{
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700425 while (!mEventQueue.isEmpty()) {
426 mEventQueue[0]->mMemory.clear();
427 mEventQueue.removeAt(0);
428 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700429}
430
431void SoundTriggerHwService::CallbackThread::onFirstRef()
432{
433 run("soundTrigger cbk", ANDROID_PRIORITY_URGENT_AUDIO);
434}
435
436bool SoundTriggerHwService::CallbackThread::threadLoop()
437{
438 while (!exitPending()) {
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700439 sp<CallbackEvent> event;
Eric Laurentb7a11d82014-04-18 17:40:41 -0700440 sp<SoundTriggerHwService> service;
441 {
442 Mutex::Autolock _l(mCallbackLock);
443 while (mEventQueue.isEmpty() && !exitPending()) {
444 ALOGV("CallbackThread::threadLoop() sleep");
445 mCallbackCond.wait(mCallbackLock);
446 ALOGV("CallbackThread::threadLoop() wake up");
447 }
448 if (exitPending()) {
449 break;
450 }
451 event = mEventQueue[0];
452 mEventQueue.removeAt(0);
453 service = mService.promote();
454 }
455 if (service != 0) {
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700456 service->onCallbackEvent(event);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700457 }
458 }
459 return false;
460}
461
462void SoundTriggerHwService::CallbackThread::exit()
463{
464 Mutex::Autolock _l(mCallbackLock);
465 requestExit();
466 mCallbackCond.broadcast();
467}
468
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700469void SoundTriggerHwService::CallbackThread::sendCallbackEvent(
470 const sp<SoundTriggerHwService::CallbackEvent>& event)
Eric Laurentb7a11d82014-04-18 17:40:41 -0700471{
472 AutoMutex lock(mCallbackLock);
473 mEventQueue.add(event);
474 mCallbackCond.signal();
475}
476
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700477SoundTriggerHwService::CallbackEvent::CallbackEvent(event_type type, sp<IMemory> memory,
478 wp<Module> module)
479 : mType(type), mMemory(memory), mModule(module)
Eric Laurentb7a11d82014-04-18 17:40:41 -0700480{
481}
482
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700483SoundTriggerHwService::CallbackEvent::~CallbackEvent()
Eric Laurentb7a11d82014-04-18 17:40:41 -0700484{
485}
486
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700487
Eric Laurentb7a11d82014-04-18 17:40:41 -0700488#undef LOG_TAG
489#define LOG_TAG "SoundTriggerHwService::Module"
490
491SoundTriggerHwService::Module::Module(const sp<SoundTriggerHwService>& service,
492 sound_trigger_hw_device* hwDevice,
493 sound_trigger_module_descriptor descriptor,
494 const sp<ISoundTriggerClient>& client)
495 : mService(service), mHwDevice(hwDevice), mDescriptor(descriptor),
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700496 mClient(client), mServiceState(SOUND_TRIGGER_STATE_NO_INIT)
Eric Laurentb7a11d82014-04-18 17:40:41 -0700497{
498}
499
500SoundTriggerHwService::Module::~Module() {
501}
502
503void SoundTriggerHwService::Module::detach() {
504 ALOGV("detach()");
Eric Laurent8ba53d82014-08-01 23:15:05 +0000505 if (!captureHotwordAllowed()) {
506 return;
507 }
Eric Laurent98647872017-10-05 10:58:38 -0700508 Vector<audio_session_t> releasedSessions;
509
Eric Laurentb7a11d82014-04-18 17:40:41 -0700510 {
511 AutoMutex lock(mLock);
512 for (size_t i = 0; i < mModels.size(); i++) {
513 sp<Model> model = mModels.valueAt(i);
514 ALOGV("detach() unloading model %d", model->mHandle);
515 if (model->mState == Model::STATE_ACTIVE) {
516 mHwDevice->stop_recognition(mHwDevice, model->mHandle);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700517 }
518 mHwDevice->unload_sound_model(mHwDevice, model->mHandle);
Eric Laurent98647872017-10-05 10:58:38 -0700519 releasedSessions.add(model->mCaptureSession);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700520 }
521 mModels.clear();
522 }
Eric Laurent98647872017-10-05 10:58:38 -0700523
524 for (size_t i = 0; i < releasedSessions.size(); i++) {
525 // do not call AudioSystem methods with mLock held
526 AudioSystem::releaseSoundTriggerSession(releasedSessions[i]);
527 }
528
Eric Laurentb7a11d82014-04-18 17:40:41 -0700529 if (mClient != 0) {
Marco Nelissenf8880202014-11-14 07:58:25 -0800530 IInterface::asBinder(mClient)->unlinkToDeath(this);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700531 }
532 sp<SoundTriggerHwService> service = mService.promote();
533 if (service == 0) {
534 return;
535 }
536 service->detachModule(this);
537}
538
539status_t SoundTriggerHwService::Module::loadSoundModel(const sp<IMemory>& modelMemory,
540 sound_model_handle_t *handle)
541{
542 ALOGV("loadSoundModel() handle");
Eric Laurent8ba53d82014-08-01 23:15:05 +0000543 if (!captureHotwordAllowed()) {
544 return PERMISSION_DENIED;
545 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700546
547 if (modelMemory == 0 || modelMemory->pointer() == NULL) {
548 ALOGE("loadSoundModel() modelMemory is 0 or has NULL pointer()");
549 return BAD_VALUE;
550 }
551 struct sound_trigger_sound_model *sound_model =
552 (struct sound_trigger_sound_model *)modelMemory->pointer();
553
Eric Laurentef0c9152016-08-17 06:19:32 -0700554 size_t structSize;
555 if (sound_model->type == SOUND_MODEL_TYPE_KEYPHRASE) {
556 structSize = sizeof(struct sound_trigger_phrase_sound_model);
557 } else {
558 structSize = sizeof(struct sound_trigger_sound_model);
559 }
560
561 if (sound_model->data_offset < structSize ||
562 sound_model->data_size > (UINT_MAX - sound_model->data_offset) ||
563 modelMemory->size() < sound_model->data_offset ||
564 sound_model->data_size > (modelMemory->size() - sound_model->data_offset)) {
565 android_errorWriteLog(0x534e4554, "30148546");
566 ALOGE("loadSoundModel() data_size is too big");
567 return BAD_VALUE;
568 }
569
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700570 audio_session_t session;
571 audio_io_handle_t ioHandle;
572 audio_devices_t device;
Eric Laurent98647872017-10-05 10:58:38 -0700573 // do not call AudioSystem methods with mLock held
574 status_t status = AudioSystem::acquireSoundTriggerSession(&session, &ioHandle, &device);
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700575 if (status != NO_ERROR) {
576 return status;
577 }
578
Eric Laurent98647872017-10-05 10:58:38 -0700579 {
580 AutoMutex lock(mLock);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700581
Eric Laurent98647872017-10-05 10:58:38 -0700582 if (mModels.size() >= mDescriptor.properties.max_sound_models) {
583 ALOGW("loadSoundModel(): Not loading, max number of models (%d) would be exceeded",
584 mDescriptor.properties.max_sound_models);
585 status = INVALID_OPERATION;
586 goto exit;
587 }
588
Eric Laurent82acb6c2017-11-13 16:04:55 -0800589 status = mHwDevice->load_sound_model(mHwDevice,
590 sound_model,
591 SoundTriggerHwService::soundModelCallback,
592 this,
593 handle);
Eric Laurent98647872017-10-05 10:58:38 -0700594 if (status != NO_ERROR) {
595 goto exit;
596 }
597
598 sp<Model> model = new Model(*handle, session, ioHandle, device, sound_model->type);
599 mModels.replaceValueFor(*handle, model);
600 }
601
602exit:
603 if (status != NO_ERROR) {
604 // do not call AudioSystem methods with mLock held
605 AudioSystem::releaseSoundTriggerSession(session);
606 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700607 return status;
608}
609
610status_t SoundTriggerHwService::Module::unloadSoundModel(sound_model_handle_t handle)
611{
612 ALOGV("unloadSoundModel() model handle %d", handle);
Eric Laurent8ba53d82014-08-01 23:15:05 +0000613 if (!captureHotwordAllowed()) {
614 return PERMISSION_DENIED;
615 }
Eric Laurent98647872017-10-05 10:58:38 -0700616 status_t status;
617 audio_session_t session;
Eric Laurentb7a11d82014-04-18 17:40:41 -0700618
Eric Laurent98647872017-10-05 10:58:38 -0700619 {
620 AutoMutex lock(mLock);
621 ssize_t index = mModels.indexOfKey(handle);
622 if (index < 0) {
623 return BAD_VALUE;
624 }
625 sp<Model> model = mModels.valueAt(index);
626 mModels.removeItem(handle);
627 if (model->mState == Model::STATE_ACTIVE) {
628 mHwDevice->stop_recognition(mHwDevice, model->mHandle);
629 model->mState = Model::STATE_IDLE;
630 }
631 status = mHwDevice->unload_sound_model(mHwDevice, handle);
632 session = model->mCaptureSession;
Eric Laurentb7a11d82014-04-18 17:40:41 -0700633 }
Eric Laurent98647872017-10-05 10:58:38 -0700634 AudioSystem::releaseSoundTriggerSession(session);
635 return status;
Eric Laurentb7a11d82014-04-18 17:40:41 -0700636}
637
638status_t SoundTriggerHwService::Module::startRecognition(sound_model_handle_t handle,
Eric Laurent0832b2d2014-07-06 16:17:25 -0700639 const sp<IMemory>& dataMemory)
Eric Laurentb7a11d82014-04-18 17:40:41 -0700640{
641 ALOGV("startRecognition() model handle %d", handle);
Eric Laurent8ba53d82014-08-01 23:15:05 +0000642 if (!captureHotwordAllowed()) {
643 return PERMISSION_DENIED;
644 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700645
Eric Laurentef0c9152016-08-17 06:19:32 -0700646 if (dataMemory == 0 || dataMemory->pointer() == NULL) {
647 ALOGE("startRecognition() dataMemory is 0 or has NULL pointer()");
Eric Laurentb7a11d82014-04-18 17:40:41 -0700648 return BAD_VALUE;
649
650 }
Eric Laurentef0c9152016-08-17 06:19:32 -0700651
652 struct sound_trigger_recognition_config *config =
653 (struct sound_trigger_recognition_config *)dataMemory->pointer();
654
655 if (config->data_offset < sizeof(struct sound_trigger_recognition_config) ||
656 config->data_size > (UINT_MAX - config->data_offset) ||
657 dataMemory->size() < config->data_offset ||
658 config->data_size > (dataMemory->size() - config->data_offset)) {
659 ALOGE("startRecognition() data_size is too big");
660 return BAD_VALUE;
661 }
662
Eric Laurentb7a11d82014-04-18 17:40:41 -0700663 AutoMutex lock(mLock);
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700664 if (mServiceState == SOUND_TRIGGER_STATE_DISABLED) {
665 return INVALID_OPERATION;
666 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700667 sp<Model> model = getModel(handle);
668 if (model == 0) {
669 return BAD_VALUE;
670 }
671
672 if (model->mState == Model::STATE_ACTIVE) {
673 return INVALID_OPERATION;
674 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700675
Eric Laurentb7a11d82014-04-18 17:40:41 -0700676
677 //TODO: get capture handle and device from audio policy service
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700678 config->capture_handle = model->mCaptureIOHandle;
679 config->capture_device = model->mCaptureDevice;
680 status_t status = mHwDevice->start_recognition(mHwDevice, handle, config,
Eric Laurentb7a11d82014-04-18 17:40:41 -0700681 SoundTriggerHwService::recognitionCallback,
Eric Laurent0832b2d2014-07-06 16:17:25 -0700682 this);
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700683
684 if (status == NO_ERROR) {
685 model->mState = Model::STATE_ACTIVE;
686 model->mConfig = *config;
687 }
688
689 return status;
Eric Laurentb7a11d82014-04-18 17:40:41 -0700690}
691
692status_t SoundTriggerHwService::Module::stopRecognition(sound_model_handle_t handle)
693{
694 ALOGV("stopRecognition() model handle %d", handle);
Eric Laurent8ba53d82014-08-01 23:15:05 +0000695 if (!captureHotwordAllowed()) {
696 return PERMISSION_DENIED;
697 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700698
699 AutoMutex lock(mLock);
700 sp<Model> model = getModel(handle);
701 if (model == 0) {
702 return BAD_VALUE;
703 }
704
705 if (model->mState != Model::STATE_ACTIVE) {
706 return INVALID_OPERATION;
707 }
708 mHwDevice->stop_recognition(mHwDevice, handle);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700709 model->mState = Model::STATE_IDLE;
710 return NO_ERROR;
711}
712
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700713
714void SoundTriggerHwService::Module::onCallbackEvent(const sp<CallbackEvent>& event)
Eric Laurentb7a11d82014-04-18 17:40:41 -0700715{
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700716 ALOGV("onCallbackEvent type %d", event->mType);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700717
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700718 sp<IMemory> eventMemory = event->mMemory;
Eric Laurentb7a11d82014-04-18 17:40:41 -0700719
720 if (eventMemory == 0 || eventMemory->pointer() == NULL) {
721 return;
722 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700723 if (mClient == 0) {
724 ALOGI("%s mClient == 0", __func__);
725 return;
726 }
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700727
728 switch (event->mType) {
729 case CallbackEvent::TYPE_RECOGNITION: {
730 struct sound_trigger_recognition_event *recognitionEvent =
731 (struct sound_trigger_recognition_event *)eventMemory->pointer();
Eric Laurent886561f2014-08-28 19:45:37 -0700732 sp<ISoundTriggerClient> client;
733 {
734 AutoMutex lock(mLock);
735 sp<Model> model = getModel(recognitionEvent->model);
736 if (model == 0) {
737 ALOGW("%s model == 0", __func__);
738 return;
739 }
740 if (model->mState != Model::STATE_ACTIVE) {
741 ALOGV("onCallbackEvent model->mState %d != Model::STATE_ACTIVE", model->mState);
742 return;
743 }
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700744
Eric Laurent886561f2014-08-28 19:45:37 -0700745 recognitionEvent->capture_session = model->mCaptureSession;
746 model->mState = Model::STATE_IDLE;
747 client = mClient;
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700748 }
Eric Laurent886561f2014-08-28 19:45:37 -0700749 if (client != 0) {
750 client->onRecognitionEvent(eventMemory);
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700751 }
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700752 } break;
753 case CallbackEvent::TYPE_SOUNDMODEL: {
754 struct sound_trigger_model_event *soundmodelEvent =
755 (struct sound_trigger_model_event *)eventMemory->pointer();
Eric Laurent886561f2014-08-28 19:45:37 -0700756 sp<ISoundTriggerClient> client;
757 {
758 AutoMutex lock(mLock);
759 sp<Model> model = getModel(soundmodelEvent->model);
760 if (model == 0) {
761 ALOGW("%s model == 0", __func__);
762 return;
763 }
764 client = mClient;
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700765 }
Eric Laurent886561f2014-08-28 19:45:37 -0700766 if (client != 0) {
767 client->onSoundModelEvent(eventMemory);
768 }
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700769 } break;
770 case CallbackEvent::TYPE_SERVICE_STATE: {
Eric Laurent886561f2014-08-28 19:45:37 -0700771 sp<ISoundTriggerClient> client;
772 {
773 AutoMutex lock(mLock);
774 client = mClient;
775 }
776 if (client != 0) {
777 client->onServiceStateChange(eventMemory);
778 }
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700779 } break;
780 default:
781 LOG_ALWAYS_FATAL("onCallbackEvent unknown event type %d", event->mType);
782 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700783}
784
785sp<SoundTriggerHwService::Model> SoundTriggerHwService::Module::getModel(
786 sound_model_handle_t handle)
787{
788 sp<Model> model;
789 ssize_t index = mModels.indexOfKey(handle);
790 if (index >= 0) {
791 model = mModels.valueAt(index);
792 }
793 return model;
794}
795
796void SoundTriggerHwService::Module::binderDied(
797 const wp<IBinder> &who __unused) {
798 ALOGW("client binder died for module %d", mDescriptor.handle);
799 detach();
800}
801
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700802// Called with mServiceLock held
803void SoundTriggerHwService::Module::setCaptureState_l(bool active)
Eric Laurentb7a11d82014-04-18 17:40:41 -0700804{
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700805 ALOGV("Module::setCaptureState_l %d", active);
806 sp<SoundTriggerHwService> service;
807 sound_trigger_service_state_t state;
Eric Laurentb7a11d82014-04-18 17:40:41 -0700808
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700809 Vector< sp<IMemory> > events;
810 {
811 AutoMutex lock(mLock);
812 state = (active && !mDescriptor.properties.concurrent_capture) ?
813 SOUND_TRIGGER_STATE_DISABLED : SOUND_TRIGGER_STATE_ENABLED;
Eric Laurentb7a11d82014-04-18 17:40:41 -0700814
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700815 if (state == mServiceState) {
816 return;
817 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700818
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700819 mServiceState = state;
820
821 service = mService.promote();
822 if (service == 0) {
823 return;
824 }
825
826 if (state == SOUND_TRIGGER_STATE_ENABLED) {
827 goto exit;
828 }
829
Chris Thorntonefcf16c2016-03-27 17:13:28 -0700830 const bool supports_stop_all =
831 (mHwDevice->common.version >= SOUND_TRIGGER_DEVICE_API_VERSION_1_1 &&
832 mHwDevice->stop_all_recognitions);
833
834 if (supports_stop_all) {
835 mHwDevice->stop_all_recognitions(mHwDevice);
836 }
837
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700838 for (size_t i = 0; i < mModels.size(); i++) {
839 sp<Model> model = mModels.valueAt(i);
840 if (model->mState == Model::STATE_ACTIVE) {
Chris Thorntonefcf16c2016-03-27 17:13:28 -0700841 if (!supports_stop_all) {
842 mHwDevice->stop_recognition(mHwDevice, model->mHandle);
843 }
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700844 // keep model in ACTIVE state so that event is processed by onCallbackEvent()
Ryan Bavetta00a727c2016-01-26 21:56:19 -0800845 if (model->mType == SOUND_MODEL_TYPE_KEYPHRASE) {
846 struct sound_trigger_phrase_recognition_event event;
847 memset(&event, 0, sizeof(struct sound_trigger_phrase_recognition_event));
848 event.num_phrases = model->mConfig.num_phrases;
849 for (size_t i = 0; i < event.num_phrases; i++) {
850 event.phrase_extras[i] = model->mConfig.phrases[i];
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700851 }
Ryan Bavetta00a727c2016-01-26 21:56:19 -0800852 event.common.status = RECOGNITION_STATUS_ABORT;
853 event.common.type = model->mType;
854 event.common.model = model->mHandle;
855 event.common.data_size = 0;
856 sp<IMemory> eventMemory = service->prepareRecognitionEvent_l(&event.common);
857 if (eventMemory != 0) {
858 events.add(eventMemory);
859 }
860 } else if (model->mType == SOUND_MODEL_TYPE_GENERIC) {
861 struct sound_trigger_generic_recognition_event event;
862 memset(&event, 0, sizeof(struct sound_trigger_generic_recognition_event));
863 event.common.status = RECOGNITION_STATUS_ABORT;
864 event.common.type = model->mType;
865 event.common.model = model->mHandle;
866 event.common.data_size = 0;
867 sp<IMemory> eventMemory = service->prepareRecognitionEvent_l(&event.common);
868 if (eventMemory != 0) {
869 events.add(eventMemory);
870 }
Ryan Bavetta9609a912016-01-28 19:22:29 -0800871 } else if (model->mType == SOUND_MODEL_TYPE_UNKNOWN) {
872 struct sound_trigger_phrase_recognition_event event;
873 memset(&event, 0, sizeof(struct sound_trigger_phrase_recognition_event));
874 event.common.status = RECOGNITION_STATUS_ABORT;
875 event.common.type = model->mType;
876 event.common.model = model->mHandle;
877 event.common.data_size = 0;
878 sp<IMemory> eventMemory = service->prepareRecognitionEvent_l(&event.common);
879 if (eventMemory != 0) {
880 events.add(eventMemory);
881 }
Ryan Bavetta00a727c2016-01-26 21:56:19 -0800882 } else {
883 goto exit;
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700884 }
885 }
886 }
Eric Laurentb7a11d82014-04-18 17:40:41 -0700887 }
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700888
889 for (size_t i = 0; i < events.size(); i++) {
890 service->sendCallbackEvent_l(new CallbackEvent(CallbackEvent::TYPE_RECOGNITION, events[i],
891 this));
892 }
893
894exit:
895 service->sendServiceStateEvent_l(state, this);
Eric Laurentb7a11d82014-04-18 17:40:41 -0700896}
897
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700898
899SoundTriggerHwService::Model::Model(sound_model_handle_t handle, audio_session_t session,
900 audio_io_handle_t ioHandle, audio_devices_t device,
901 sound_trigger_sound_model_type_t type) :
902 mHandle(handle), mState(STATE_IDLE), mCaptureSession(session),
903 mCaptureIOHandle(ioHandle), mCaptureDevice(device), mType(type)
Eric Laurentb7a11d82014-04-18 17:40:41 -0700904{
Eric Laurentdf3dc7e2014-07-27 18:39:40 -0700905
Eric Laurentb7a11d82014-04-18 17:40:41 -0700906}
907
908status_t SoundTriggerHwService::Module::dump(int fd __unused,
909 const Vector<String16>& args __unused) {
910 String8 result;
911 return NO_ERROR;
912}
913
914}; // namespace android