1/* 2 * Copyright (C) 2009 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#ifndef ANDROID_AUDIOEFFECT_H 18#define ANDROID_AUDIOEFFECT_H 19 20#include <stdint.h> 21#include <sys/types.h> 22 23#include <media/IAudioFlinger.h> 24#include <media/IAudioPolicyService.h> 25#include <media/IEffect.h> 26#include <media/IEffectClient.h> 27#include <hardware/audio_effect.h> 28#include <media/AudioSystem.h> 29 30#include <utils/RefBase.h> 31#include <utils/Errors.h> 32#include <binder/IInterface.h> 33 34 35namespace android { 36 37// ---------------------------------------------------------------------------- 38 39struct effect_param_cblk_t; 40 41// ---------------------------------------------------------------------------- 42 43class AudioEffect : public RefBase 44{ 45public: 46 47 /* 48 * Static methods for effects enumeration. 49 */ 50 51 /* 52 * Returns the number of effects available. This method together 53 * with queryEffect() is used to enumerate all effects: 54 * The enumeration sequence is: 55 * queryNumberEffects(&num_effects); 56 * for (i = 0; i < num_effects; i++) 57 * queryEffect(i,...); 58 * 59 * Parameters: 60 * numEffects: address where the number of effects should be returned. 61 * 62 * Returned status (from utils/Errors.h) can be: 63 * NO_ERROR successful operation. 64 * PERMISSION_DENIED could not get AudioFlinger interface 65 * NO_INIT effect library failed to initialize 66 * BAD_VALUE invalid numEffects pointer 67 * 68 * Returned value 69 * *numEffects: updated with number of effects available 70 */ 71 static status_t queryNumberEffects(uint32_t *numEffects); 72 73 /* 74 * Returns an effect descriptor during effect 75 * enumeration. 76 * 77 * Parameters: 78 * index: index of the queried effect. 79 * descriptor: address where the effect descriptor should be returned. 80 * 81 * Returned status (from utils/Errors.h) can be: 82 * NO_ERROR successful operation. 83 * PERMISSION_DENIED could not get AudioFlinger interface 84 * NO_INIT effect library failed to initialize 85 * BAD_VALUE invalid descriptor pointer or index 86 * INVALID_OPERATION effect list has changed since last execution of queryNumberEffects() 87 * 88 * Returned value 89 * *descriptor: updated with effect descriptor 90 */ 91 static status_t queryEffect(uint32_t index, effect_descriptor_t *descriptor); 92 93 94 /* 95 * Returns the descriptor for the specified effect uuid. 96 * 97 * Parameters: 98 * uuid: pointer to effect uuid. 99 * descriptor: address where the effect descriptor should be returned. 100 * 101 * Returned status (from utils/Errors.h) can be: 102 * NO_ERROR successful operation. 103 * PERMISSION_DENIED could not get AudioFlinger interface 104 * NO_INIT effect library failed to initialize 105 * BAD_VALUE invalid uuid or descriptor pointers 106 * NAME_NOT_FOUND no effect with this uuid found 107 * 108 * Returned value 109 * *descriptor updated with effect descriptor 110 */ 111 static status_t getEffectDescriptor(const effect_uuid_t *uuid, 112 effect_descriptor_t *descriptor) /*const*/; 113 114 115 /* 116 * Returns a list of descriptors corresponding to the pre processings enabled by default 117 * on an AudioRecord with the supplied audio session ID. 118 * 119 * Parameters: 120 * audioSession: audio session ID. 121 * descriptors: address where the effect descriptors should be returned. 122 * count: as input, the maximum number of descriptor than should be returned 123 * as output, the number of descriptor returned if status is NO_ERROR or the actual 124 * number of enabled pre processings if status is NO_MEMORY 125 * 126 * Returned status (from utils/Errors.h) can be: 127 * NO_ERROR successful operation. 128 * NO_MEMORY the number of descriptor to return is more than the maximum number 129 * indicated by count. 130 * PERMISSION_DENIED could not get AudioFlinger interface 131 * NO_INIT effect library failed to initialize 132 * BAD_VALUE invalid audio session or descriptor pointers 133 * 134 * Returned value 135 * *descriptor updated with descriptors of pre processings enabled by default 136 * *count number of descriptors returned if returned status is NO_ERROR. 137 * total number of pre processing enabled by default if returned status is 138 * NO_MEMORY. This happens if the count passed as input is less than the number 139 * of descriptors to return. 140 * *count is limited to kMaxPreProcessing on return. 141 */ 142 static status_t queryDefaultPreProcessing(int audioSession, 143 effect_descriptor_t *descriptors, 144 uint32_t *count); 145 146 /* 147 * Events used by callback function (effect_callback_t). 148 */ 149 enum event_type { 150 EVENT_CONTROL_STATUS_CHANGED = 0, 151 EVENT_ENABLE_STATUS_CHANGED = 1, 152 EVENT_PARAMETER_CHANGED = 2, 153 EVENT_ERROR = 3 154 }; 155 156 /* Callback function notifying client application of a change in effect engine state or 157 * configuration. 158 * An effect engine can be shared by several applications but only one has the control 159 * of the engine activity and configuration at a time. 160 * The EVENT_CONTROL_STATUS_CHANGED event is received when an application loses or 161 * retrieves the control of the effect engine. Loss of control happens 162 * if another application requests the use of the engine by creating an AudioEffect for 163 * the same effect type but with a higher priority. Control is returned when the 164 * application having the control deletes its AudioEffect object. 165 * The EVENT_ENABLE_STATUS_CHANGED event is received by all applications not having the 166 * control of the effect engine when the effect is enabled or disabled. 167 * The EVENT_PARAMETER_CHANGED event is received by all applications not having the 168 * control of the effect engine when an effect parameter is changed. 169 * The EVENT_ERROR event is received when the media server process dies. 170 * 171 * Parameters: 172 * 173 * event: type of event notified (see enum AudioEffect::event_type). 174 * user: Pointer to context for use by the callback receiver. 175 * info: Pointer to optional parameter according to event type: 176 * - EVENT_CONTROL_STATUS_CHANGED: boolean indicating if control is granted (true) 177 * or stolen (false). 178 * - EVENT_ENABLE_STATUS_CHANGED: boolean indicating if effect is now enabled (true) 179 * or disabled (false). 180 * - EVENT_PARAMETER_CHANGED: pointer to a effect_param_t structure. 181 * - EVENT_ERROR: status_t indicating the error (DEAD_OBJECT when media server dies). 182 */ 183 184 typedef void (*effect_callback_t)(int32_t event, void* user, void *info); 185 186 187 /* Constructor. 188 * AudioEffect is the base class for creating and controlling an effect engine from 189 * the application process. Creating an AudioEffect object will create the effect engine 190 * in the AudioFlinger if no engine of the specified type exists. If one exists, this engine 191 * will be used. The application creating the AudioEffect object (or a derived class like 192 * Reverb for instance) will either receive control of the effect engine or not, depending 193 * on the priority parameter. If priority is higher than the priority used by the current 194 * effect engine owner, the control will be transfered to the new application. Otherwise 195 * control will remain to the previous application. In this case, the new application will be 196 * notified of changes in effect engine state or control ownership by the effect callback. 197 * After creating the AudioEffect, the application must call the initCheck() method and 198 * check the creation status before trying to control the effect engine (see initCheck()). 199 * If the effect is to be applied to an AudioTrack or MediaPlayer only the application 200 * must specify the audio session ID corresponding to this player. 201 */ 202 203 /* Simple Constructor. 204 */ 205 AudioEffect(); 206 207 208 /* Constructor. 209 * 210 * Parameters: 211 * 212 * type: type of effect created: can be null if uuid is specified. This corresponds to 213 * the OpenSL ES interface implemented by this effect. 214 * uuid: Uuid of effect created: can be null if type is specified. This uuid corresponds to 215 * a particular implementation of an effect type. 216 * priority: requested priority for effect control: the priority level corresponds to the 217 * value of priority parameter: negative values indicate lower priorities, positive values 218 * higher priorities, 0 being the normal priority. 219 * cbf: optional callback function (see effect_callback_t) 220 * user: pointer to context for use by the callback receiver. 221 * sessionID: audio session this effect is associated to. 222 * If equal to AUDIO_SESSION_OUTPUT_MIX, the effect will be global to 223 * the output mix. Otherwise, the effect will be applied to all players 224 * (AudioTrack or MediaPLayer) within the same audio session. 225 * io: HAL audio output or input stream to which this effect must be attached. Leave at 0 for 226 * automatic output selection by AudioFlinger. 227 */ 228 229 AudioEffect(const effect_uuid_t *type, 230 const effect_uuid_t *uuid = NULL, 231 int32_t priority = 0, 232 effect_callback_t cbf = NULL, 233 void* user = NULL, 234 int sessionId = AUDIO_SESSION_OUTPUT_MIX, 235 audio_io_handle_t io = AUDIO_IO_HANDLE_NONE 236 ); 237 238 /* Constructor. 239 * Same as above but with type and uuid specified by character strings 240 */ 241 AudioEffect(const char *typeStr, 242 const char *uuidStr = NULL, 243 int32_t priority = 0, 244 effect_callback_t cbf = NULL, 245 void* user = NULL, 246 int sessionId = AUDIO_SESSION_OUTPUT_MIX, 247 audio_io_handle_t io = AUDIO_IO_HANDLE_NONE 248 ); 249 250 /* Terminates the AudioEffect and unregisters it from AudioFlinger. 251 * The effect engine is also destroyed if this AudioEffect was the last controlling 252 * the engine. 253 */ 254 ~AudioEffect(); 255 256 /* Initialize an uninitialized AudioEffect. 257 * Returned status (from utils/Errors.h) can be: 258 * - NO_ERROR or ALREADY_EXISTS: successful initialization 259 * - INVALID_OPERATION: AudioEffect is already initialized 260 * - BAD_VALUE: invalid parameter 261 * - NO_INIT: audio flinger or audio hardware not initialized 262 * */ 263 status_t set(const effect_uuid_t *type, 264 const effect_uuid_t *uuid = NULL, 265 int32_t priority = 0, 266 effect_callback_t cbf = NULL, 267 void* user = NULL, 268 int sessionId = AUDIO_SESSION_OUTPUT_MIX, 269 audio_io_handle_t io = AUDIO_IO_HANDLE_NONE 270 ); 271 272 /* Result of constructing the AudioEffect. This must be checked 273 * before using any AudioEffect API. 274 * initCheck() can return: 275 * - NO_ERROR: the effect engine is successfully created and the application has control. 276 * - ALREADY_EXISTS: the effect engine is successfully created but the application does not 277 * have control. 278 * - NO_INIT: the effect creation failed. 279 * 280 */ 281 status_t initCheck() const; 282 283 284 /* Returns the unique effect Id for the controlled effect engine. This ID is unique 285 * system wide and is used for instance in the case of auxiliary effects to attach 286 * the effect to an AudioTrack or MediaPlayer. 287 * 288 */ 289 int32_t id() const { return mId; } 290 291 /* Returns a descriptor for the effect (see effect_descriptor_t in audio_effect.h). 292 */ 293 effect_descriptor_t descriptor() const; 294 295 /* Returns effect control priority of this AudioEffect object. 296 */ 297 int32_t priority() const { return mPriority; } 298 299 300 /* Enables or disables the effect engine. 301 * 302 * Parameters: 303 * enabled: requested enable state. 304 * 305 * Returned status (from utils/Errors.h) can be: 306 * - NO_ERROR: successful operation 307 * - INVALID_OPERATION: the application does not have control of the effect engine or the 308 * effect is already in the requested state. 309 */ 310 virtual status_t setEnabled(bool enabled); 311 bool getEnabled() const; 312 313 /* Sets a parameter value. 314 * 315 * Parameters: 316 * param: pointer to effect_param_t structure containing the parameter 317 * and its value (See audio_effect.h). 318 * Returned status (from utils/Errors.h) can be: 319 * - NO_ERROR: successful operation. 320 * - INVALID_OPERATION: the application does not have control of the effect engine. 321 * - BAD_VALUE: invalid parameter identifier or value. 322 * - DEAD_OBJECT: the effect engine has been deleted. 323 */ 324 virtual status_t setParameter(effect_param_t *param); 325 326 /* Prepare a new parameter value that will be set by next call to 327 * setParameterCommit(). This method can be used to set multiple parameters 328 * in a synchronous manner or to avoid multiple binder calls for each 329 * parameter. 330 * 331 * Parameters: 332 * param: pointer to effect_param_t structure containing the parameter 333 * and its value (See audio_effect.h). 334 * 335 * Returned status (from utils/Errors.h) can be: 336 * - NO_ERROR: successful operation. 337 * - INVALID_OPERATION: the application does not have control of the effect engine. 338 * - NO_MEMORY: no more space available in shared memory used for deferred parameter 339 * setting. 340 */ 341 virtual status_t setParameterDeferred(effect_param_t *param); 342 343 /* Commit all parameter values previously prepared by setParameterDeferred(). 344 * 345 * Parameters: 346 * none 347 * 348 * Returned status (from utils/Errors.h) can be: 349 * - NO_ERROR: successful operation. 350 * - INVALID_OPERATION: No new parameter values ready for commit. 351 * - BAD_VALUE: invalid parameter identifier or value: there is no indication 352 * as to which of the parameters caused this error. 353 * - DEAD_OBJECT: the effect engine has been deleted. 354 */ 355 virtual status_t setParameterCommit(); 356 357 /* Gets a parameter value. 358 * 359 * Parameters: 360 * param: pointer to effect_param_t structure containing the parameter 361 * and the returned value (See audio_effect.h). 362 * 363 * Returned status (from utils/Errors.h) can be: 364 * - NO_ERROR: successful operation. 365 * - INVALID_OPERATION: the AudioEffect was not successfully initialized. 366 * - BAD_VALUE: invalid parameter identifier. 367 * - DEAD_OBJECT: the effect engine has been deleted. 368 */ 369 virtual status_t getParameter(effect_param_t *param); 370 371 /* Sends a command and receives a response to/from effect engine. 372 * See audio_effect.h for details on effect command() function, valid command codes 373 * and formats. 374 */ 375 virtual status_t command(uint32_t cmdCode, 376 uint32_t cmdSize, 377 void *cmdData, 378 uint32_t *replySize, 379 void *replyData); 380 381 382 /* 383 * Utility functions. 384 */ 385 386 /* Converts the string passed as first argument to the effect_uuid_t 387 * pointed to by second argument 388 */ 389 static status_t stringToGuid(const char *str, effect_uuid_t *guid); 390 /* Converts the effect_uuid_t pointed to by first argument to the 391 * string passed as second argument 392 */ 393 static status_t guidToString(const effect_uuid_t *guid, char *str, size_t maxLen); 394 395 // kMaxPreProcessing is a reasonable value for the maximum number of preprocessing effects 396 // that can be applied simultaneously. 397 static const uint32_t kMaxPreProcessing = 10; 398 399protected: 400 bool mEnabled; // enable state 401 int32_t mSessionId; // audio session ID 402 int32_t mPriority; // priority for effect control 403 status_t mStatus; // effect status 404 effect_callback_t mCbf; // callback function for status, control and 405 // parameter changes notifications 406 void* mUserData; // client context for callback function 407 effect_descriptor_t mDescriptor; // effect descriptor 408 int32_t mId; // system wide unique effect engine instance ID 409 Mutex mLock; // Mutex for mEnabled access 410 411 // IEffectClient 412 virtual void controlStatusChanged(bool controlGranted); 413 virtual void enableStatusChanged(bool enabled); 414 virtual void commandExecuted(uint32_t cmdCode, 415 uint32_t cmdSize, 416 void *pCmdData, 417 uint32_t replySize, 418 void *pReplyData); 419 420private: 421 422 // Implements the IEffectClient interface 423 class EffectClient : public android::BnEffectClient, public android::IBinder::DeathRecipient 424 { 425 public: 426 427 EffectClient(AudioEffect *effect) : mEffect(effect){} 428 429 // IEffectClient 430 virtual void controlStatusChanged(bool controlGranted) { 431 mEffect->controlStatusChanged(controlGranted); 432 } 433 virtual void enableStatusChanged(bool enabled) { 434 mEffect->enableStatusChanged(enabled); 435 } 436 virtual void commandExecuted(uint32_t cmdCode, 437 uint32_t cmdSize, 438 void *pCmdData, 439 uint32_t replySize, 440 void *pReplyData) { 441 mEffect->commandExecuted(cmdCode, cmdSize, pCmdData, replySize, pReplyData); 442 } 443 444 // IBinder::DeathRecipient 445 virtual void binderDied(const wp<IBinder>& who) {mEffect->binderDied();} 446 447 private: 448 AudioEffect *mEffect; 449 }; 450 451 void binderDied(); 452 453 sp<IEffect> mIEffect; // IEffect binder interface 454 sp<EffectClient> mIEffectClient; // IEffectClient implementation 455 sp<IMemory> mCblkMemory; // shared memory for deferred parameter setting 456 effect_param_cblk_t* mCblk; // control block for deferred parameter setting 457 pid_t mClientPid; 458}; 459 460 461}; // namespace android 462 463#endif // ANDROID_AUDIOEFFECT_H 464