blob: ef11072e03adb8833656484e437553f58655fe85 [file] [log] [blame]
Eric Laurent6d607012021-07-05 11:54:40 +02001/*
2**
3** Copyright 2021, The Android Open Source Project
4**
5** Licensed under the Apache License, Version 2.0 (the "License");
6** you may not use this file except in compliance with the License.
7** You may obtain a copy of the License at
8**
9** http://www.apache.org/licenses/LICENSE-2.0
10**
11** Unless required by applicable law or agreed to in writing, software
12** distributed under the License is distributed on an "AS IS" BASIS,
13** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14** See the License for the specific language governing permissions and
15** limitations under the License.
16*/
17
18
19#define LOG_TAG "Spatializer"
20//#define LOG_NDEBUG 0
21#include <utils/Log.h>
22
23#include <limits.h>
24#include <stdint.h>
25#include <sys/types.h>
26
27#include <android/content/AttributionSourceState.h>
28#include <audio_utils/fixedfft.h>
29#include <cutils/bitops.h>
Eric Laurent2be8b292021-08-23 09:44:33 -070030#include <hardware/sensors.h>
Eric Laurent6d607012021-07-05 11:54:40 +020031#include <media/audiohal/EffectsFactoryHalInterface.h>
Eric Laurent8a4259f2021-09-14 16:04:00 +020032#include <media/stagefright/foundation/AHandler.h>
33#include <media/stagefright/foundation/AMessage.h>
34#include <media/ShmemCompat.h>
Eric Laurent6d607012021-07-05 11:54:40 +020035#include <mediautils/ServiceUtilities.h>
36#include <utils/Thread.h>
37
38#include "Spatializer.h"
39
40namespace android {
41
42using aidl_utils::statusTFromBinderStatus;
43using aidl_utils::binderStatusFromStatusT;
44using android::content::AttributionSourceState;
45using binder::Status;
Eric Laurent2be8b292021-08-23 09:44:33 -070046using media::HeadTrackingMode;
47using media::Pose3f;
Eric Laurent6d607012021-07-05 11:54:40 +020048using media::SpatializationLevel;
Eric Laurent2be8b292021-08-23 09:44:33 -070049using media::SpatializationMode;
Ytai Ben-Tsvia16a9df2021-08-05 08:57:06 -070050using media::SpatializerHeadTrackingMode;
Eric Laurent2be8b292021-08-23 09:44:33 -070051using media::SensorPoseProvider;
52
Eric Laurent2be8b292021-08-23 09:44:33 -070053using namespace std::chrono_literals;
Eric Laurent6d607012021-07-05 11:54:40 +020054
55#define VALUE_OR_RETURN_BINDER_STATUS(x) \
56 ({ auto _tmp = (x); \
57 if (!_tmp.ok()) return aidl_utils::binderStatusFromStatusT(_tmp.error()); \
58 std::move(_tmp.value()); })
59
Eric Laurent6d607012021-07-05 11:54:40 +020060// ---------------------------------------------------------------------------
61
Eric Laurent8a4259f2021-09-14 16:04:00 +020062class Spatializer::EngineCallbackHandler : public AHandler {
63public:
64 EngineCallbackHandler(wp<Spatializer> spatializer)
65 : mSpatializer(spatializer) {
66 }
67
68 enum {
69 // Device state callbacks
70 kWhatOnFramesProcessed, // AudioEffect::EVENT_FRAMES_PROCESSED
71 kWhatOnHeadToStagePose, // SpatializerPoseController::Listener::onHeadToStagePose
72 kWhatOnActualModeChange, // SpatializerPoseController::Listener::onActualModeChange
73 };
74 static constexpr const char *kNumFramesKey = "numFrames";
75 static constexpr const char *kModeKey = "mode";
76 static constexpr const char *kTranslation0Key = "translation0";
77 static constexpr const char *kTranslation1Key = "translation1";
78 static constexpr const char *kTranslation2Key = "translation2";
79 static constexpr const char *kRotation0Key = "rotation0";
80 static constexpr const char *kRotation1Key = "rotation1";
81 static constexpr const char *kRotation2Key = "rotation2";
82
83 void onMessageReceived(const sp<AMessage> &msg) override {
84 switch (msg->what()) {
85 case kWhatOnFramesProcessed: {
86 sp<Spatializer> spatializer = mSpatializer.promote();
87 if (spatializer == nullptr) {
88 ALOGW("%s: Cannot promote spatializer", __func__);
89 return;
90 }
91 int numFrames;
92 if (!msg->findInt32(kNumFramesKey, &numFrames)) {
93 ALOGE("%s: Cannot find num frames!", __func__);
94 return;
95 }
96 if (numFrames > 0) {
97 spatializer->calculateHeadPose();
98 }
99 } break;
100 case kWhatOnHeadToStagePose: {
101 sp<Spatializer> spatializer = mSpatializer.promote();
102 if (spatializer == nullptr) {
103 ALOGW("%s: Cannot promote spatializer", __func__);
104 return;
105 }
106 std::vector<float> headToStage(sHeadPoseKeys.size());
107 for (size_t i = 0 ; i < sHeadPoseKeys.size(); i++) {
108 if (!msg->findFloat(sHeadPoseKeys[i], &headToStage[i])) {
109 ALOGE("%s: Cannot find kTranslation0Key!", __func__);
110 return;
111 }
112 }
113 spatializer->onHeadToStagePoseMsg(headToStage);
114 } break;
115 case kWhatOnActualModeChange: {
116 sp<Spatializer> spatializer = mSpatializer.promote();
117 if (spatializer == nullptr) {
118 ALOGW("%s: Cannot promote spatializer", __func__);
119 return;
120 }
121 int mode;
122 if (!msg->findInt32(EngineCallbackHandler::kModeKey, &mode)) {
123 ALOGE("%s: Cannot find actualMode!", __func__);
124 return;
125 }
126 spatializer->onActualModeChangeMsg(static_cast<HeadTrackingMode>(mode));
127 } break;
128 default:
129 LOG_ALWAYS_FATAL("Invalid callback message %d", msg->what());
130 }
131 }
132private:
133 wp<Spatializer> mSpatializer;
134};
135
136const std::vector<const char *> Spatializer::sHeadPoseKeys = {
137 Spatializer::EngineCallbackHandler::kTranslation0Key,
138 Spatializer::EngineCallbackHandler::kTranslation1Key,
139 Spatializer::EngineCallbackHandler::kTranslation2Key,
140 Spatializer::EngineCallbackHandler::kRotation0Key,
141 Spatializer::EngineCallbackHandler::kRotation1Key,
142 Spatializer::EngineCallbackHandler::kRotation2Key,
143};
144
145// ---------------------------------------------------------------------------
Eric Laurent6d607012021-07-05 11:54:40 +0200146sp<Spatializer> Spatializer::create(SpatializerPolicyCallback *callback) {
147 sp<Spatializer> spatializer;
148
149 sp<EffectsFactoryHalInterface> effectsFactoryHal = EffectsFactoryHalInterface::create();
150 if (effectsFactoryHal == nullptr) {
151 ALOGW("%s failed to create effect factory interface", __func__);
152 return spatializer;
153 }
154
155 std::vector<effect_descriptor_t> descriptors;
156 status_t status =
Eric Laurent1c5e2e32021-08-18 18:50:28 +0200157 effectsFactoryHal->getDescriptors(FX_IID_SPATIALIZER, &descriptors);
Eric Laurent6d607012021-07-05 11:54:40 +0200158 if (status != NO_ERROR) {
159 ALOGW("%s failed to get spatializer descriptor, error %d", __func__, status);
160 return spatializer;
161 }
162 ALOG_ASSERT(!descriptors.empty(),
163 "%s getDescriptors() returned no error but empty list", __func__);
164
165 //TODO: get supported spatialization modes from FX engine or descriptor
166
167 sp<EffectHalInterface> effect;
168 status = effectsFactoryHal->createEffect(&descriptors[0].uuid, AUDIO_SESSION_OUTPUT_STAGE,
169 AUDIO_IO_HANDLE_NONE, AUDIO_PORT_HANDLE_NONE, &effect);
170 ALOGI("%s FX create status %d effect %p", __func__, status, effect.get());
171
172 if (status == NO_ERROR && effect != nullptr) {
173 spatializer = new Spatializer(descriptors[0], callback);
Eric Laurent2be8b292021-08-23 09:44:33 -0700174 if (spatializer->loadEngineConfiguration(effect) != NO_ERROR) {
175 spatializer.clear();
176 }
Eric Laurent6d607012021-07-05 11:54:40 +0200177 }
178
179 return spatializer;
180}
181
Eric Laurent2be8b292021-08-23 09:44:33 -0700182Spatializer::Spatializer(effect_descriptor_t engineDescriptor, SpatializerPolicyCallback* callback)
183 : mEngineDescriptor(engineDescriptor),
184 mPolicyCallback(callback) {
Eric Laurent6d607012021-07-05 11:54:40 +0200185 ALOGV("%s", __func__);
186}
187
Eric Laurent8a4259f2021-09-14 16:04:00 +0200188void Spatializer::onFirstRef() {
189 mLooper = new ALooper;
190 mLooper->setName("Spatializer-looper");
191 mLooper->start(
192 /*runOnCallingThread*/false,
193 /*canCallJava*/ false,
194 PRIORITY_AUDIO);
195
196 mHandler = new EngineCallbackHandler(this);
197 mLooper->registerHandler(mHandler);
198}
199
Eric Laurent6d607012021-07-05 11:54:40 +0200200Spatializer::~Spatializer() {
201 ALOGV("%s", __func__);
Eric Laurent8a4259f2021-09-14 16:04:00 +0200202 if (mLooper != nullptr) {
203 mLooper->stop();
204 mLooper->unregisterHandler(mHandler->id());
205 }
206 mLooper.clear();
207 mHandler.clear();
Eric Laurent6d607012021-07-05 11:54:40 +0200208}
209
Eric Laurent2be8b292021-08-23 09:44:33 -0700210status_t Spatializer::loadEngineConfiguration(sp<EffectHalInterface> effect) {
211 ALOGV("%s", __func__);
212
213 std::vector<bool> supportsHeadTracking;
214 status_t status = getHalParameter<false>(effect, SPATIALIZER_PARAM_HEADTRACKING_SUPPORTED,
215 &supportsHeadTracking);
216 if (status != NO_ERROR) {
217 return status;
218 }
219 mSupportsHeadTracking = supportsHeadTracking[0];
220
221 status = getHalParameter<true>(effect, SPATIALIZER_PARAM_SUPPORTED_LEVELS, &mLevels);
222 if (status != NO_ERROR) {
223 return status;
224 }
225 status = getHalParameter<true>(effect, SPATIALIZER_PARAM_SUPPORTED_SPATIALIZATION_MODES,
226 &mSpatializationModes);
227 if (status != NO_ERROR) {
228 return status;
229 }
Eric Laurentb4f42a92022-01-17 17:37:31 +0100230 return getHalParameter<true>(effect, SPATIALIZER_PARAM_SUPPORTED_CHANNEL_MASKS,
Eric Laurent2be8b292021-08-23 09:44:33 -0700231 &mChannelMasks);
Eric Laurent2be8b292021-08-23 09:44:33 -0700232}
233
234/** Gets the channel mask, sampling rate and format set for the spatializer input. */
235audio_config_base_t Spatializer::getAudioInConfig() const {
236 std::lock_guard lock(mLock);
237 audio_config_base_t config = AUDIO_CONFIG_BASE_INITIALIZER;
238 // For now use highest supported channel count
239 uint32_t maxCount = 0;
240 for ( auto mask : mChannelMasks) {
241 if (audio_channel_count_from_out_mask(mask) > maxCount) {
242 config.channel_mask = mask;
243 }
244 }
245 return config;
246}
247
Eric Laurent6d607012021-07-05 11:54:40 +0200248status_t Spatializer::registerCallback(
249 const sp<media::INativeSpatializerCallback>& callback) {
Eric Laurent2be8b292021-08-23 09:44:33 -0700250 std::lock_guard lock(mLock);
Eric Laurent6d607012021-07-05 11:54:40 +0200251 if (callback == nullptr) {
252 return BAD_VALUE;
253 }
254
255 sp<IBinder> binder = IInterface::asBinder(callback);
256 status_t status = binder->linkToDeath(this);
257 if (status == NO_ERROR) {
258 mSpatializerCallback = callback;
259 }
260 ALOGV("%s status %d", __func__, status);
261 return status;
262}
263
264// IBinder::DeathRecipient
265void Spatializer::binderDied(__unused const wp<IBinder> &who) {
266 {
Eric Laurent2be8b292021-08-23 09:44:33 -0700267 std::lock_guard lock(mLock);
Eric Laurent6d607012021-07-05 11:54:40 +0200268 mLevel = SpatializationLevel::NONE;
269 mSpatializerCallback.clear();
270 }
271 ALOGV("%s", __func__);
272 mPolicyCallback->onCheckSpatializer();
273}
274
275// ISpatializer
276Status Spatializer::getSupportedLevels(std::vector<SpatializationLevel> *levels) {
277 ALOGV("%s", __func__);
278 if (levels == nullptr) {
279 return binderStatusFromStatusT(BAD_VALUE);
280 }
Eric Laurent6d607012021-07-05 11:54:40 +0200281 levels->push_back(SpatializationLevel::NONE);
Eric Laurent2be8b292021-08-23 09:44:33 -0700282 levels->insert(levels->end(), mLevels.begin(), mLevels.end());
Eric Laurent6d607012021-07-05 11:54:40 +0200283 return Status::ok();
284}
285
Eric Laurent2be8b292021-08-23 09:44:33 -0700286Status Spatializer::setLevel(SpatializationLevel level) {
Eric Laurent6d607012021-07-05 11:54:40 +0200287 ALOGV("%s level %d", __func__, (int)level);
288 if (level != SpatializationLevel::NONE
Eric Laurent2be8b292021-08-23 09:44:33 -0700289 && std::find(mLevels.begin(), mLevels.end(), level) == mLevels.end()) {
Eric Laurent6d607012021-07-05 11:54:40 +0200290 return binderStatusFromStatusT(BAD_VALUE);
291 }
292 sp<media::INativeSpatializerCallback> callback;
293 bool levelChanged = false;
294 {
Eric Laurent2be8b292021-08-23 09:44:33 -0700295 std::lock_guard lock(mLock);
Eric Laurent6d607012021-07-05 11:54:40 +0200296 levelChanged = mLevel != level;
297 mLevel = level;
298 callback = mSpatializerCallback;
Eric Laurent2be8b292021-08-23 09:44:33 -0700299
300 if (levelChanged && mEngine != nullptr) {
Eric Laurent7ea0d1b2022-04-01 14:23:44 +0200301 checkEngineState_l();
Eric Laurent2be8b292021-08-23 09:44:33 -0700302 }
Eric Laurent9249d342022-03-18 11:55:56 +0100303 checkSensorsState_l();
Eric Laurent6d607012021-07-05 11:54:40 +0200304 }
305
306 if (levelChanged) {
307 mPolicyCallback->onCheckSpatializer();
308 if (callback != nullptr) {
309 callback->onLevelChanged(level);
310 }
311 }
312 return Status::ok();
313}
314
Eric Laurent2be8b292021-08-23 09:44:33 -0700315Status Spatializer::getLevel(SpatializationLevel *level) {
Eric Laurent6d607012021-07-05 11:54:40 +0200316 if (level == nullptr) {
317 return binderStatusFromStatusT(BAD_VALUE);
318 }
Eric Laurent2be8b292021-08-23 09:44:33 -0700319 std::lock_guard lock(mLock);
Eric Laurent6d607012021-07-05 11:54:40 +0200320 *level = mLevel;
321 ALOGV("%s level %d", __func__, (int)*level);
322 return Status::ok();
323}
324
Eric Laurentc87402b2021-09-17 16:49:42 +0200325Status Spatializer::isHeadTrackingSupported(bool *supports) {
326 ALOGV("%s mSupportsHeadTracking %d", __func__, mSupportsHeadTracking);
327 if (supports == nullptr) {
328 return binderStatusFromStatusT(BAD_VALUE);
329 }
330 std::lock_guard lock(mLock);
331 *supports = mSupportsHeadTracking;
332 return Status::ok();
333}
334
Eric Laurent6d607012021-07-05 11:54:40 +0200335Status Spatializer::getSupportedHeadTrackingModes(
Eric Laurent2be8b292021-08-23 09:44:33 -0700336 std::vector<SpatializerHeadTrackingMode>* modes) {
337 std::lock_guard lock(mLock);
Eric Laurent6d607012021-07-05 11:54:40 +0200338 ALOGV("%s", __func__);
339 if (modes == nullptr) {
340 return binderStatusFromStatusT(BAD_VALUE);
341 }
Eric Laurent6d607012021-07-05 11:54:40 +0200342
Eric Laurent2be8b292021-08-23 09:44:33 -0700343 modes->push_back(SpatializerHeadTrackingMode::DISABLED);
344 if (mSupportsHeadTracking) {
Eric Laurent3815d852022-05-05 10:37:30 +0200345 modes->push_back(SpatializerHeadTrackingMode::RELATIVE_WORLD);
Eric Laurent6d607012021-07-05 11:54:40 +0200346 }
347 return Status::ok();
348}
349
Eric Laurent2be8b292021-08-23 09:44:33 -0700350Status Spatializer::setDesiredHeadTrackingMode(SpatializerHeadTrackingMode mode) {
351 ALOGV("%s mode %d", __func__, (int)mode);
352
353 if (!mSupportsHeadTracking) {
354 return binderStatusFromStatusT(INVALID_OPERATION);
355 }
356 std::lock_guard lock(mLock);
357 switch (mode) {
358 case SpatializerHeadTrackingMode::OTHER:
359 return binderStatusFromStatusT(BAD_VALUE);
360 case SpatializerHeadTrackingMode::DISABLED:
361 mDesiredHeadTrackingMode = HeadTrackingMode::STATIC;
362 break;
363 case SpatializerHeadTrackingMode::RELATIVE_WORLD:
364 mDesiredHeadTrackingMode = HeadTrackingMode::WORLD_RELATIVE;
365 break;
366 case SpatializerHeadTrackingMode::RELATIVE_SCREEN:
367 mDesiredHeadTrackingMode = HeadTrackingMode::SCREEN_RELATIVE;
368 break;
369 }
370
Eric Laurent11094172022-04-05 18:27:42 +0200371 checkPoseController_l();
372 checkSensorsState_l();
Eric Laurent2be8b292021-08-23 09:44:33 -0700373
374 return Status::ok();
375}
376
377Status Spatializer::getActualHeadTrackingMode(SpatializerHeadTrackingMode *mode) {
Eric Laurent6d607012021-07-05 11:54:40 +0200378 if (mode == nullptr) {
379 return binderStatusFromStatusT(BAD_VALUE);
380 }
Eric Laurent2be8b292021-08-23 09:44:33 -0700381 std::lock_guard lock(mLock);
382 *mode = mActualHeadTrackingMode;
Eric Laurent6d607012021-07-05 11:54:40 +0200383 ALOGV("%s mode %d", __func__, (int)*mode);
384 return Status::ok();
385}
386
Ytai Ben-Tsvia16a9df2021-08-05 08:57:06 -0700387Status Spatializer::recenterHeadTracker() {
Eric Laurent780be4a2021-09-16 10:44:24 +0200388 if (!mSupportsHeadTracking) {
389 return binderStatusFromStatusT(INVALID_OPERATION);
390 }
Eric Laurent2be8b292021-08-23 09:44:33 -0700391 std::lock_guard lock(mLock);
392 if (mPoseController != nullptr) {
393 mPoseController->recenter();
394 }
Eric Laurent6d607012021-07-05 11:54:40 +0200395 return Status::ok();
396}
397
398Status Spatializer::setGlobalTransform(const std::vector<float>& screenToStage) {
Eric Laurent6d607012021-07-05 11:54:40 +0200399 ALOGV("%s", __func__);
Eric Laurent780be4a2021-09-16 10:44:24 +0200400 if (!mSupportsHeadTracking) {
401 return binderStatusFromStatusT(INVALID_OPERATION);
402 }
Eric Laurent2be8b292021-08-23 09:44:33 -0700403 std::optional<Pose3f> maybePose = Pose3f::fromVector(screenToStage);
404 if (!maybePose.has_value()) {
405 ALOGW("Invalid screenToStage vector.");
406 return binderStatusFromStatusT(BAD_VALUE);
407 }
408 std::lock_guard lock(mLock);
409 if (mPoseController != nullptr) {
410 mPoseController->setScreenToStagePose(maybePose.value());
411 }
Eric Laurent6d607012021-07-05 11:54:40 +0200412 return Status::ok();
413}
414
415Status Spatializer::release() {
416 ALOGV("%s", __func__);
417 bool levelChanged = false;
418 {
Eric Laurent2be8b292021-08-23 09:44:33 -0700419 std::lock_guard lock(mLock);
Eric Laurent6d607012021-07-05 11:54:40 +0200420 if (mSpatializerCallback == nullptr) {
421 return binderStatusFromStatusT(INVALID_OPERATION);
422 }
423
424 sp<IBinder> binder = IInterface::asBinder(mSpatializerCallback);
425 binder->unlinkToDeath(this);
426 mSpatializerCallback.clear();
427
428 levelChanged = mLevel != SpatializationLevel::NONE;
429 mLevel = SpatializationLevel::NONE;
430 }
431
432 if (levelChanged) {
433 mPolicyCallback->onCheckSpatializer();
434 }
435 return Status::ok();
436}
437
Eric Laurent2be8b292021-08-23 09:44:33 -0700438Status Spatializer::setHeadSensor(int sensorHandle) {
439 ALOGV("%s sensorHandle %d", __func__, sensorHandle);
Eric Laurent780be4a2021-09-16 10:44:24 +0200440 if (!mSupportsHeadTracking) {
441 return binderStatusFromStatusT(INVALID_OPERATION);
442 }
Eric Laurent2be8b292021-08-23 09:44:33 -0700443 std::lock_guard lock(mLock);
Ytai Ben-Tsvi9f12f172021-09-23 16:47:25 -0700444 mHeadSensor = sensorHandle;
Eric Laurent11094172022-04-05 18:27:42 +0200445 checkPoseController_l();
Eric Laurent9249d342022-03-18 11:55:56 +0100446 checkSensorsState_l();
Eric Laurent2be8b292021-08-23 09:44:33 -0700447 return Status::ok();
448}
449
450Status Spatializer::setScreenSensor(int sensorHandle) {
451 ALOGV("%s sensorHandle %d", __func__, sensorHandle);
Eric Laurent780be4a2021-09-16 10:44:24 +0200452 if (!mSupportsHeadTracking) {
453 return binderStatusFromStatusT(INVALID_OPERATION);
454 }
Eric Laurent2be8b292021-08-23 09:44:33 -0700455 std::lock_guard lock(mLock);
Ytai Ben-Tsvi9f12f172021-09-23 16:47:25 -0700456 mScreenSensor = sensorHandle;
Eric Laurente51f80e2022-04-14 10:20:38 +0200457 checkSensorsState_l();
Eric Laurent2be8b292021-08-23 09:44:33 -0700458 return Status::ok();
459}
460
461Status Spatializer::setDisplayOrientation(float physicalToLogicalAngle) {
462 ALOGV("%s physicalToLogicalAngle %f", __func__, physicalToLogicalAngle);
Eric Laurent780be4a2021-09-16 10:44:24 +0200463 if (!mSupportsHeadTracking) {
464 return binderStatusFromStatusT(INVALID_OPERATION);
465 }
Eric Laurent2be8b292021-08-23 09:44:33 -0700466 std::lock_guard lock(mLock);
467 mDisplayOrientation = physicalToLogicalAngle;
468 if (mPoseController != nullptr) {
469 mPoseController->setDisplayOrientation(mDisplayOrientation);
470 }
Eric Laurent16ddaf42021-09-17 15:00:35 +0200471 if (mEngine != nullptr) {
472 setEffectParameter_l(
473 SPATIALIZER_PARAM_DISPLAY_ORIENTATION, std::vector<float>{physicalToLogicalAngle});
474 }
Eric Laurent2be8b292021-08-23 09:44:33 -0700475 return Status::ok();
476}
477
478Status Spatializer::setHingeAngle(float hingeAngle) {
479 std::lock_guard lock(mLock);
480 ALOGV("%s hingeAngle %f", __func__, hingeAngle);
481 if (mEngine != nullptr) {
482 setEffectParameter_l(SPATIALIZER_PARAM_HINGE_ANGLE, std::vector<float>{hingeAngle});
483 }
484 return Status::ok();
485}
486
487Status Spatializer::getSupportedModes(std::vector<SpatializationMode> *modes) {
488 ALOGV("%s", __func__);
489 if (modes == nullptr) {
490 return binderStatusFromStatusT(BAD_VALUE);
491 }
492 *modes = mSpatializationModes;
493 return Status::ok();
494}
495
Eric Laurent67816e32021-09-16 15:18:40 +0200496Status Spatializer::registerHeadTrackingCallback(
497 const sp<media::ISpatializerHeadTrackingCallback>& callback) {
498 ALOGV("%s callback %p", __func__, callback.get());
499 std::lock_guard lock(mLock);
500 if (!mSupportsHeadTracking) {
501 return binderStatusFromStatusT(INVALID_OPERATION);
502 }
503 mHeadTrackingCallback = callback;
504 return Status::ok();
505}
506
Eric Laurentc87402b2021-09-17 16:49:42 +0200507Status Spatializer::setParameter(int key, const std::vector<unsigned char>& value) {
508 ALOGV("%s key %d", __func__, key);
509 std::lock_guard lock(mLock);
510 status_t status = INVALID_OPERATION;
511 if (mEngine != nullptr) {
512 status = setEffectParameter_l(key, value);
513 }
514 return binderStatusFromStatusT(status);
515}
516
517Status Spatializer::getParameter(int key, std::vector<unsigned char> *value) {
Greg Kaiserf7249f82021-09-21 07:10:12 -0700518 ALOGV("%s key %d value size %d", __func__, key,
519 (value != nullptr ? (int)value->size() : -1));
Eric Laurentc87402b2021-09-17 16:49:42 +0200520 if (value == nullptr) {
George Burgess IV22386222021-09-22 12:09:31 -0700521 return binderStatusFromStatusT(BAD_VALUE);
Eric Laurentc87402b2021-09-17 16:49:42 +0200522 }
523 std::lock_guard lock(mLock);
524 status_t status = INVALID_OPERATION;
525 if (mEngine != nullptr) {
526 ALOGV("%s key %d mEngine %p", __func__, key, mEngine.get());
527 status = getEffectParameter_l(key, value);
528 }
529 return binderStatusFromStatusT(status);
530}
531
532Status Spatializer::getOutput(int *output) {
533 ALOGV("%s", __func__);
534 if (output == nullptr) {
535 binderStatusFromStatusT(BAD_VALUE);
536 }
537 std::lock_guard lock(mLock);
538 *output = VALUE_OR_RETURN_BINDER_STATUS(legacy2aidl_audio_io_handle_t_int32_t(mOutput));
539 ALOGV("%s got output %d", __func__, *output);
540 return Status::ok();
541}
542
Eric Laurent2be8b292021-08-23 09:44:33 -0700543// SpatializerPoseController::Listener
544void Spatializer::onHeadToStagePose(const Pose3f& headToStage) {
545 ALOGV("%s", __func__);
Eric Laurent780be4a2021-09-16 10:44:24 +0200546 LOG_ALWAYS_FATAL_IF(!mSupportsHeadTracking,
547 "onHeadToStagePose() called with no head tracking support!");
548
Eric Laurent2be8b292021-08-23 09:44:33 -0700549 auto vec = headToStage.toVector();
Eric Laurent8a4259f2021-09-14 16:04:00 +0200550 LOG_ALWAYS_FATAL_IF(vec.size() != sHeadPoseKeys.size(),
551 "%s invalid head to stage vector size %zu", __func__, vec.size());
Eric Laurent8a4259f2021-09-14 16:04:00 +0200552 sp<AMessage> msg =
553 new AMessage(EngineCallbackHandler::kWhatOnHeadToStagePose, mHandler);
554 for (size_t i = 0 ; i < sHeadPoseKeys.size(); i++) {
555 msg->setFloat(sHeadPoseKeys[i], vec[i]);
556 }
557 msg->post();
558}
559
560void Spatializer::onHeadToStagePoseMsg(const std::vector<float>& headToStage) {
561 ALOGV("%s", __func__);
Eric Laurent67816e32021-09-16 15:18:40 +0200562 sp<media::ISpatializerHeadTrackingCallback> callback;
Eric Laurent2be8b292021-08-23 09:44:33 -0700563 {
564 std::lock_guard lock(mLock);
Eric Laurent67816e32021-09-16 15:18:40 +0200565 callback = mHeadTrackingCallback;
Eric Laurent2be8b292021-08-23 09:44:33 -0700566 if (mEngine != nullptr) {
Eric Laurent8a4259f2021-09-14 16:04:00 +0200567 setEffectParameter_l(SPATIALIZER_PARAM_HEAD_TO_STAGE, headToStage);
Eric Laurent2be8b292021-08-23 09:44:33 -0700568 }
569 }
570
571 if (callback != nullptr) {
Eric Laurent8a4259f2021-09-14 16:04:00 +0200572 callback->onHeadToSoundStagePoseUpdated(headToStage);
Eric Laurent2be8b292021-08-23 09:44:33 -0700573 }
574}
575
576void Spatializer::onActualModeChange(HeadTrackingMode mode) {
Eric Laurent8a4259f2021-09-14 16:04:00 +0200577 ALOGV("%s(%d)", __func__, (int)mode);
578 sp<AMessage> msg =
579 new AMessage(EngineCallbackHandler::kWhatOnActualModeChange, mHandler);
580 msg->setInt32(EngineCallbackHandler::kModeKey, static_cast<int>(mode));
581 msg->post();
582}
583
584void Spatializer::onActualModeChangeMsg(HeadTrackingMode mode) {
585 ALOGV("%s(%d)", __func__, (int) mode);
Eric Laurent67816e32021-09-16 15:18:40 +0200586 sp<media::ISpatializerHeadTrackingCallback> callback;
Eric Laurent2be8b292021-08-23 09:44:33 -0700587 SpatializerHeadTrackingMode spatializerMode;
588 {
589 std::lock_guard lock(mLock);
590 if (!mSupportsHeadTracking) {
591 spatializerMode = SpatializerHeadTrackingMode::DISABLED;
592 } else {
593 switch (mode) {
594 case HeadTrackingMode::STATIC:
595 spatializerMode = SpatializerHeadTrackingMode::DISABLED;
596 break;
597 case HeadTrackingMode::WORLD_RELATIVE:
598 spatializerMode = SpatializerHeadTrackingMode::RELATIVE_WORLD;
599 break;
600 case HeadTrackingMode::SCREEN_RELATIVE:
601 spatializerMode = SpatializerHeadTrackingMode::RELATIVE_SCREEN;
602 break;
603 default:
604 LOG_ALWAYS_FATAL("Unknown mode: %d", mode);
605 }
606 }
607 mActualHeadTrackingMode = spatializerMode;
Eric Laurente51f80e2022-04-14 10:20:38 +0200608 if (mEngine != nullptr) {
Eric Laurent7ea0d1b2022-04-01 14:23:44 +0200609 setEffectParameter_l(SPATIALIZER_PARAM_HEADTRACKING_MODE,
610 std::vector<SpatializerHeadTrackingMode>{spatializerMode});
611 }
Eric Laurent67816e32021-09-16 15:18:40 +0200612 callback = mHeadTrackingCallback;
Eric Laurent2be8b292021-08-23 09:44:33 -0700613 }
Eric Laurente51f80e2022-04-14 10:20:38 +0200614 if (callback != nullptr) {
Eric Laurent2be8b292021-08-23 09:44:33 -0700615 callback->onHeadTrackingModeChanged(spatializerMode);
616 }
617}
618
Eric Laurent15903592022-02-24 20:44:36 +0100619status_t Spatializer::attachOutput(audio_io_handle_t output, size_t numActiveTracks) {
Eric Laurent4a872862021-10-11 17:06:47 +0200620 bool outputChanged = false;
621 sp<media::INativeSpatializerCallback> callback;
622
Eric Laurent2be8b292021-08-23 09:44:33 -0700623 {
624 std::lock_guard lock(mLock);
625 ALOGV("%s output %d mOutput %d", __func__, (int)output, (int)mOutput);
626 if (mOutput != AUDIO_IO_HANDLE_NONE) {
627 LOG_ALWAYS_FATAL_IF(mEngine == nullptr, "%s output set without FX engine", __func__);
628 // remove FX instance
629 mEngine->setEnabled(false);
630 mEngine.clear();
Eric Laurent15903592022-02-24 20:44:36 +0100631 mPoseController.reset();
Eric Laurent2be8b292021-08-23 09:44:33 -0700632 }
633 // create FX instance on output
634 AttributionSourceState attributionSource = AttributionSourceState();
635 mEngine = new AudioEffect(attributionSource);
636 mEngine->set(nullptr, &mEngineDescriptor.uuid, 0, Spatializer::engineCallback /* cbf */,
637 this /* user */, AUDIO_SESSION_OUTPUT_STAGE, output, {} /* device */,
638 false /* probe */, true /* notifyFramesProcessed */);
639 status_t status = mEngine->initCheck();
640 ALOGV("%s mEngine create status %d", __func__, (int)status);
641 if (status != NO_ERROR) {
642 return status;
643 }
644
Eric Laurent4a872862021-10-11 17:06:47 +0200645 outputChanged = mOutput != output;
Eric Laurent2be8b292021-08-23 09:44:33 -0700646 mOutput = output;
Eric Laurent11094172022-04-05 18:27:42 +0200647 mNumActiveTracks = numActiveTracks;
Eric Laurent2be8b292021-08-23 09:44:33 -0700648
Eric Laurent11094172022-04-05 18:27:42 +0200649 checkEngineState_l();
Eric Laurent780be4a2021-09-16 10:44:24 +0200650 if (mSupportsHeadTracking) {
Eric Laurent11094172022-04-05 18:27:42 +0200651 checkPoseController_l();
Eric Laurent9249d342022-03-18 11:55:56 +0100652 checkSensorsState_l();
Eric Laurent780be4a2021-09-16 10:44:24 +0200653 }
Eric Laurent4a872862021-10-11 17:06:47 +0200654 callback = mSpatializerCallback;
Eric Laurent6d607012021-07-05 11:54:40 +0200655 }
Eric Laurent4a872862021-10-11 17:06:47 +0200656
657 if (outputChanged && callback != nullptr) {
658 callback->onOutputChanged(output);
659 }
660
Eric Laurent6d607012021-07-05 11:54:40 +0200661 return NO_ERROR;
662}
663
664audio_io_handle_t Spatializer::detachOutput() {
Eric Laurent2be8b292021-08-23 09:44:33 -0700665 audio_io_handle_t output = AUDIO_IO_HANDLE_NONE;
Eric Laurent4a872862021-10-11 17:06:47 +0200666 sp<media::INativeSpatializerCallback> callback;
667
668 {
669 std::lock_guard lock(mLock);
670 ALOGV("%s mOutput %d", __func__, (int)mOutput);
671 if (mOutput == AUDIO_IO_HANDLE_NONE) {
672 return output;
673 }
674 // remove FX instance
675 mEngine->setEnabled(false);
676 mEngine.clear();
677 output = mOutput;
678 mOutput = AUDIO_IO_HANDLE_NONE;
679 mPoseController.reset();
Eric Laurent4a872862021-10-11 17:06:47 +0200680 callback = mSpatializerCallback;
Eric Laurent6d607012021-07-05 11:54:40 +0200681 }
Eric Laurent4a872862021-10-11 17:06:47 +0200682
683 if (callback != nullptr) {
684 callback->onOutputChanged(AUDIO_IO_HANDLE_NONE);
685 }
Eric Laurent6d607012021-07-05 11:54:40 +0200686 return output;
687}
688
Eric Laurent15903592022-02-24 20:44:36 +0100689void Spatializer::updateActiveTracks(size_t numActiveTracks) {
690 std::lock_guard lock(mLock);
Eric Laurent7ea0d1b2022-04-01 14:23:44 +0200691 if (mNumActiveTracks != numActiveTracks) {
692 mNumActiveTracks = numActiveTracks;
693 checkEngineState_l();
694 checkSensorsState_l();
695 }
Eric Laurent15903592022-02-24 20:44:36 +0100696}
697
Eric Laurent9249d342022-03-18 11:55:56 +0100698void Spatializer::checkSensorsState_l() {
Eric Laurent15903592022-02-24 20:44:36 +0100699 if (mSupportsHeadTracking && mPoseController != nullptr) {
Eric Laurent9249d342022-03-18 11:55:56 +0100700 if (mNumActiveTracks > 0 && mLevel != SpatializationLevel::NONE
Eric Laurent15903592022-02-24 20:44:36 +0100701 && mDesiredHeadTrackingMode != HeadTrackingMode::STATIC
702 && mHeadSensor != SpatializerPoseController::INVALID_SENSOR) {
703 mPoseController->setHeadSensor(mHeadSensor);
Eric Laurent9249d342022-03-18 11:55:56 +0100704 mPoseController->setScreenSensor(mScreenSensor);
Eric Laurent15903592022-02-24 20:44:36 +0100705 } else {
706 mPoseController->setHeadSensor(SpatializerPoseController::INVALID_SENSOR);
Eric Laurent9249d342022-03-18 11:55:56 +0100707 mPoseController->setScreenSensor(SpatializerPoseController::INVALID_SENSOR);
Eric Laurent15903592022-02-24 20:44:36 +0100708 }
709 }
710}
711
Eric Laurent7ea0d1b2022-04-01 14:23:44 +0200712void Spatializer::checkEngineState_l() {
713 if (mEngine != nullptr) {
714 if (mLevel != SpatializationLevel::NONE && mNumActiveTracks > 0) {
715 mEngine->setEnabled(true);
716 setEffectParameter_l(SPATIALIZER_PARAM_LEVEL,
717 std::vector<SpatializationLevel>{mLevel});
718 setEffectParameter_l(SPATIALIZER_PARAM_HEADTRACKING_MODE,
719 std::vector<SpatializerHeadTrackingMode>{mActualHeadTrackingMode});
720 } else {
721 setEffectParameter_l(SPATIALIZER_PARAM_LEVEL,
722 std::vector<SpatializationLevel>{SpatializationLevel::NONE});
723 mEngine->setEnabled(false);
724 }
725 }
726}
727
Eric Laurent11094172022-04-05 18:27:42 +0200728void Spatializer::checkPoseController_l() {
729 bool isControllerNeeded = mDesiredHeadTrackingMode != HeadTrackingMode::STATIC
730 && mHeadSensor != SpatializerPoseController::INVALID_SENSOR;
731
732 if (isControllerNeeded && mPoseController == nullptr) {
733 mPoseController = std::make_shared<SpatializerPoseController>(
734 static_cast<SpatializerPoseController::Listener*>(this),
Eric Laurente51f80e2022-04-14 10:20:38 +0200735 10ms, std::nullopt);
Eric Laurent11094172022-04-05 18:27:42 +0200736 LOG_ALWAYS_FATAL_IF(mPoseController == nullptr,
737 "%s could not allocate pose controller", __func__);
738 mPoseController->setDisplayOrientation(mDisplayOrientation);
739 } else if (!isControllerNeeded && mPoseController != nullptr) {
740 mPoseController.reset();
741 }
742 if (mPoseController != nullptr) {
743 mPoseController->setDesiredMode(mDesiredHeadTrackingMode);
744 }
745}
746
Eric Laurent2be8b292021-08-23 09:44:33 -0700747void Spatializer::calculateHeadPose() {
748 ALOGV("%s", __func__);
749 std::lock_guard lock(mLock);
750 if (mPoseController != nullptr) {
751 mPoseController->calculateAsync();
752 }
753}
Eric Laurent6d607012021-07-05 11:54:40 +0200754
Eric Laurent2be8b292021-08-23 09:44:33 -0700755void Spatializer::engineCallback(int32_t event, void *user, void *info) {
Eric Laurent6d607012021-07-05 11:54:40 +0200756 if (user == nullptr) {
757 return;
758 }
Eric Laurent2be8b292021-08-23 09:44:33 -0700759 Spatializer* const me = reinterpret_cast<Spatializer *>(user);
Eric Laurent6d607012021-07-05 11:54:40 +0200760 switch (event) {
761 case AudioEffect::EVENT_FRAMES_PROCESSED: {
Eric Laurent2be8b292021-08-23 09:44:33 -0700762 int frames = info == nullptr ? 0 : *(int*)info;
Eric Laurent9249d342022-03-18 11:55:56 +0100763 ALOGV("%s frames processed %d for me %p", __func__, frames, me);
Eric Laurent8a4259f2021-09-14 16:04:00 +0200764 me->postFramesProcessedMsg(frames);
Eric Laurent2be8b292021-08-23 09:44:33 -0700765 } break;
Eric Laurent6d607012021-07-05 11:54:40 +0200766 default:
Eric Laurent9249d342022-03-18 11:55:56 +0100767 ALOGV("%s event %d", __func__, event);
Eric Laurent6d607012021-07-05 11:54:40 +0200768 break;
769 }
770}
771
Eric Laurent8a4259f2021-09-14 16:04:00 +0200772void Spatializer::postFramesProcessedMsg(int frames) {
773 sp<AMessage> msg =
774 new AMessage(EngineCallbackHandler::kWhatOnFramesProcessed, mHandler);
775 msg->setInt32(EngineCallbackHandler::kNumFramesKey, frames);
776 msg->post();
777}
778
Eric Laurent6d607012021-07-05 11:54:40 +0200779} // namespace android