| /* |
| * Copyright (C) 2016 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. |
| */ |
| |
| |
| #ifndef ANDROID_AUDIO_EFFECT_CORE_H |
| #define ANDROID_AUDIO_EFFECT_CORE_H |
| |
| #include "audio.h" |
| #include "audio_effect-base.h" |
| |
| __BEGIN_DECLS |
| |
| ///////////////////////////////////////////////// |
| // Common Definitions |
| ///////////////////////////////////////////////// |
| |
| // |
| //--- Effect descriptor structure effect_descriptor_t |
| // |
| |
| // This format is used for both "type" and "uuid" fields of the effect descriptor structure. |
| // - When used for effect type and the engine is implementing and effect corresponding to a standard |
| // OpenSL ES interface, this ID must be the one defined in OpenSLES_IID.h for that interface. |
| // - When used as uuid, it should be a unique UUID for this particular implementation. |
| typedef audio_uuid_t effect_uuid_t; |
| |
| // Maximum length of character strings in structures defines by this API. |
| #define EFFECT_STRING_LEN_MAX 64 |
| |
| // NULL UUID definition (matches SL_IID_NULL_) |
| #define EFFECT_UUID_INITIALIZER { 0xec7178ec, 0xe5e1, 0x4432, 0xa3f4, \ |
| { 0x46, 0x57, 0xe6, 0x79, 0x52, 0x10 } } |
| static const effect_uuid_t EFFECT_UUID_NULL_ = EFFECT_UUID_INITIALIZER; |
| static const effect_uuid_t * const EFFECT_UUID_NULL = &EFFECT_UUID_NULL_; |
| static const char * const EFFECT_UUID_NULL_STR = "ec7178ec-e5e1-4432-a3f4-4657e6795210"; |
| |
| // The effect descriptor contains necessary information to facilitate the enumeration of the effect |
| // engines present in a library. |
| typedef struct effect_descriptor_s { |
| effect_uuid_t type; // UUID of to the OpenSL ES interface implemented by this effect |
| effect_uuid_t uuid; // UUID for this particular implementation |
| uint32_t apiVersion; // Version of the effect control API implemented |
| uint32_t flags; // effect engine capabilities/requirements flags (see below) |
| uint16_t cpuLoad; // CPU load indication (see below) |
| uint16_t memoryUsage; // Data Memory usage (see below) |
| char name[EFFECT_STRING_LEN_MAX]; // human readable effect name |
| char implementor[EFFECT_STRING_LEN_MAX]; // human readable effect implementor name |
| } effect_descriptor_t; |
| |
| #define EFFECT_CONFIG_ALL (EFFECT_CONFIG_BUFFER | \ |
| EFFECT_CONFIG_SMP_RATE | \ |
| EFFECT_CONFIG_CHANNELS | \ |
| EFFECT_CONFIG_FORMAT | \ |
| EFFECT_CONFIG_ACC_MODE) |
| |
| ///////////////////////////////////////////////// |
| // Effect control interface |
| ///////////////////////////////////////////////// |
| |
| // |
| //--- Standardized command codes for command() function |
| // |
| enum effect_command_e { |
| EFFECT_CMD_INIT, // initialize effect engine |
| EFFECT_CMD_SET_CONFIG, // configure effect engine (see effect_config_t) |
| EFFECT_CMD_RESET, // reset effect engine |
| EFFECT_CMD_ENABLE, // enable effect process |
| EFFECT_CMD_DISABLE, // disable effect process |
| EFFECT_CMD_SET_PARAM, // set parameter immediately (see effect_param_t) |
| EFFECT_CMD_SET_PARAM_DEFERRED, // set parameter deferred |
| EFFECT_CMD_SET_PARAM_COMMIT, // commit previous set parameter deferred |
| EFFECT_CMD_GET_PARAM, // get parameter |
| EFFECT_CMD_SET_DEVICE, // set audio device (see audio.h, audio_devices_t) |
| EFFECT_CMD_SET_VOLUME, // set volume |
| EFFECT_CMD_SET_AUDIO_MODE, // set the audio mode (normal, ring, ...) |
| EFFECT_CMD_SET_CONFIG_REVERSE, // configure effect engine reverse stream(see effect_config_t) |
| EFFECT_CMD_SET_INPUT_DEVICE, // set capture device (see audio.h, audio_devices_t) |
| EFFECT_CMD_GET_CONFIG, // read effect engine configuration |
| EFFECT_CMD_GET_CONFIG_REVERSE, // read configure effect engine reverse stream configuration |
| EFFECT_CMD_GET_FEATURE_SUPPORTED_CONFIGS,// get all supported configurations for a feature. |
| EFFECT_CMD_GET_FEATURE_CONFIG, // get current feature configuration |
| EFFECT_CMD_SET_FEATURE_CONFIG, // set current feature configuration |
| EFFECT_CMD_SET_AUDIO_SOURCE, // set the audio source (see audio.h, audio_source_t) |
| EFFECT_CMD_OFFLOAD, // set if effect thread is an offload one, |
| // send the ioHandle of the effect thread |
| EFFECT_CMD_FIRST_PROPRIETARY = 0x10000 // first proprietary command code |
| }; |
| |
| //================================================================================================== |
| // command: EFFECT_CMD_INIT |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Initialize effect engine: All configurations return to default |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: 0 |
| // data: N/A |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(int) |
| // data: status |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_CONFIG |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Apply new audio parameters configurations for input and output buffers |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(effect_config_t) |
| // data: effect_config_t |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(int) |
| // data: status |
| //================================================================================================== |
| // command: EFFECT_CMD_RESET |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Reset the effect engine. Keep configuration but resets state and buffer content |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: 0 |
| // data: N/A |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: 0 |
| // data: N/A |
| //================================================================================================== |
| // command: EFFECT_CMD_ENABLE |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Enable the process. Called by the framework before the first call to process() |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: 0 |
| // data: N/A |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(int) |
| // data: status |
| //================================================================================================== |
| // command: EFFECT_CMD_DISABLE |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Disable the process. Called by the framework after the last call to process() |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: 0 |
| // data: N/A |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(int) |
| // data: status |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_PARAM |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Set a parameter and apply it immediately |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(effect_param_t) + size of param and value |
| // data: effect_param_t + param + value. See effect_param_t definition below for value offset |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(int) |
| // data: status |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_PARAM_DEFERRED |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Set a parameter but apply it only when receiving EFFECT_CMD_SET_PARAM_COMMIT command |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(effect_param_t) + size of param and value |
| // data: effect_param_t + param + value. See effect_param_t definition below for value offset |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: 0 |
| // data: N/A |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_PARAM_COMMIT |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Apply all previously received EFFECT_CMD_SET_PARAM_DEFERRED commands |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: 0 |
| // data: N/A |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(int) |
| // data: status |
| //================================================================================================== |
| // command: EFFECT_CMD_GET_PARAM |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Get a parameter value |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(effect_param_t) + size of param |
| // data: effect_param_t + param |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(effect_param_t) + size of param and value |
| // data: effect_param_t + param + value. See effect_param_t definition below for value offset |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_DEVICE |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Set the rendering device the audio output path is connected to. See audio.h, audio_devices_t |
| // for device values. |
| // The effect implementation must set EFFECT_FLAG_DEVICE_IND flag in its descriptor to receive this |
| // command when the device changes |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(uint32_t) |
| // data: uint32_t |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: 0 |
| // data: N/A |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_VOLUME |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Set and get volume. Used by audio framework to delegate volume control to effect engine. |
| // The effect implementation must set EFFECT_FLAG_VOLUME_IND or EFFECT_FLAG_VOLUME_CTRL flag in |
| // its descriptor to receive this command before every call to process() function |
| // If EFFECT_FLAG_VOLUME_CTRL flag is set in the effect descriptor, the effect engine must return |
| // the volume that should be applied before the effect is processed. The overall volume (the volume |
| // actually applied by the effect engine multiplied by the returned value) should match the value |
| // indicated in the command. |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: n * sizeof(uint32_t) |
| // data: volume for each channel defined in effect_config_t for output buffer expressed in |
| // 8.24 fixed point format |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: n * sizeof(uint32_t) / 0 |
| // data: - if EFFECT_FLAG_VOLUME_CTRL is set in effect descriptor: |
| // volume for each channel defined in effect_config_t for output buffer expressed in |
| // 8.24 fixed point format |
| // - if EFFECT_FLAG_VOLUME_CTRL is not set in effect descriptor: |
| // N/A |
| // It is legal to receive a null pointer as pReplyData in which case the effect framework has |
| // delegated volume control to another effect |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_AUDIO_MODE |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Set the audio mode. The effect implementation must set EFFECT_FLAG_AUDIO_MODE_IND flag in its |
| // descriptor to receive this command when the audio mode changes. |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(uint32_t) |
| // data: audio_mode_t |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: 0 |
| // data: N/A |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_CONFIG_REVERSE |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Apply new audio parameters configurations for input and output buffers of reverse stream. |
| // An example of reverse stream is the echo reference supplied to an Acoustic Echo Canceler. |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(effect_config_t) |
| // data: effect_config_t |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(int) |
| // data: status |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_INPUT_DEVICE |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Set the capture device the audio input path is connected to. See audio.h, audio_devices_t |
| // for device values. |
| // The effect implementation must set EFFECT_FLAG_DEVICE_IND flag in its descriptor to receive this |
| // command when the device changes |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(uint32_t) |
| // data: uint32_t |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: 0 |
| // data: N/A |
| //================================================================================================== |
| // command: EFFECT_CMD_GET_CONFIG |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Read audio parameters configurations for input and output buffers |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: 0 |
| // data: N/A |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(effect_config_t) |
| // data: effect_config_t |
| //================================================================================================== |
| // command: EFFECT_CMD_GET_CONFIG_REVERSE |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Read audio parameters configurations for input and output buffers of reverse stream |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: 0 |
| // data: N/A |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(effect_config_t) |
| // data: effect_config_t |
| //================================================================================================== |
| // command: EFFECT_CMD_GET_FEATURE_SUPPORTED_CONFIGS |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Queries for supported configurations for a particular feature (e.g. get the supported |
| // combinations of main and auxiliary channels for a noise suppressor). |
| // The command parameter is the feature identifier (See effect_feature_e for a list of defined |
| // features) followed by the maximum number of configuration descriptor to return. |
| // The reply is composed of: |
| // - status (uint32_t): |
| // - 0 if feature is supported |
| // - -ENOSYS if the feature is not supported, |
| // - -ENOMEM if the feature is supported but the total number of supported configurations |
| // exceeds the maximum number indicated by the caller. |
| // - total number of supported configurations (uint32_t) |
| // - an array of configuration descriptors. |
| // The actual number of descriptors returned must not exceed the maximum number indicated by |
| // the caller. |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: 2 x sizeof(uint32_t) |
| // data: effect_feature_e + maximum number of configurations to return |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: 2 x sizeof(uint32_t) + n x sizeof (<config descriptor>) |
| // data: status + total number of configurations supported + array of n config descriptors |
| //================================================================================================== |
| // command: EFFECT_CMD_GET_FEATURE_CONFIG |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Retrieves current configuration for a given feature. |
| // The reply status is: |
| // - 0 if feature is supported |
| // - -ENOSYS if the feature is not supported, |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(uint32_t) |
| // data: effect_feature_e |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(uint32_t) + sizeof (<config descriptor>) |
| // data: status + config descriptor |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_FEATURE_CONFIG |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Sets current configuration for a given feature. |
| // The reply status is: |
| // - 0 if feature is supported |
| // - -ENOSYS if the feature is not supported, |
| // - -EINVAL if the configuration is invalid |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(uint32_t) + sizeof (<config descriptor>) |
| // data: effect_feature_e + config descriptor |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(uint32_t) |
| // data: status |
| //================================================================================================== |
| // command: EFFECT_CMD_SET_AUDIO_SOURCE |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // Set the audio source the capture path is configured for (Camcorder, voice recognition...). |
| // See audio.h, audio_source_t for values. |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(uint32_t) |
| // data: uint32_t |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: 0 |
| // data: N/A |
| //================================================================================================== |
| // command: EFFECT_CMD_OFFLOAD |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // 1.indicate if the playback thread the effect is attached to is offloaded or not |
| // 2.update the io handle of the playback thread the effect is attached to |
| //-------------------------------------------------------------------------------------------------- |
| // command format: |
| // size: sizeof(effect_offload_param_t) |
| // data: effect_offload_param_t |
| //-------------------------------------------------------------------------------------------------- |
| // reply format: |
| // size: sizeof(uint32_t) |
| // data: uint32_t |
| //-------------------------------------------------------------------------------------------------- |
| // command: EFFECT_CMD_FIRST_PROPRIETARY |
| //-------------------------------------------------------------------------------------------------- |
| // description: |
| // All proprietary effect commands must use command codes above this value. The size and format of |
| // command and response fields is free in this case |
| //================================================================================================== |
| |
| // Audio buffer descriptor used by process(), bufferProvider() functions and buffer_config_t |
| // structure. Multi-channel audio is always interleaved. The channel order is from LSB to MSB with |
| // regard to the channel mask definition in audio.h, audio_channel_mask_t e.g : |
| // Stereo: left, right |
| // 5 point 1: front left, front right, front center, low frequency, back left, back right |
| // The buffer size is expressed in frame count, a frame being composed of samples for all |
| // channels at a given time. Frame size for unspecified format (AUDIO_FORMAT_OTHER) is 8 bit by |
| // definition |
| typedef struct audio_buffer_s { |
| size_t frameCount; // number of frames in buffer |
| union { |
| void* raw; // raw pointer to start of buffer |
| float* f32; // pointer to float 32 bit data at start of buffer |
| int32_t* s32; // pointer to signed 32 bit data at start of buffer |
| int16_t* s16; // pointer to signed 16 bit data at start of buffer |
| uint8_t* u8; // pointer to unsigned 8 bit data at start of buffer |
| }; |
| } audio_buffer_t; |
| |
| // The buffer_provider_s structure contains functions that can be used |
| // by the effect engine process() function to query and release input |
| // or output audio buffer. |
| // The getBuffer() function is called to retrieve a buffer where data |
| // should read from or written to by process() function. |
| // The releaseBuffer() function MUST be called when the buffer retrieved |
| // with getBuffer() is not needed anymore. |
| // The process function should use the buffer provider mechanism to retrieve |
| // input or output buffer if the inBuffer or outBuffer passed as argument is NULL |
| // and the buffer configuration (buffer_config_t) given by the EFFECT_CMD_SET_CONFIG |
| // command did not specify an audio buffer. |
| |
| typedef int32_t (* buffer_function_t)(void *cookie, audio_buffer_t *buffer); |
| |
| typedef struct buffer_provider_s { |
| buffer_function_t getBuffer; // retrieve next buffer |
| buffer_function_t releaseBuffer; // release used buffer |
| void *cookie; // for use by client of buffer provider functions |
| } buffer_provider_t; |
| |
| // The buffer_config_s structure specifies the input or output audio format |
| // to be used by the effect engine. |
| typedef struct buffer_config_s { |
| audio_buffer_t buffer; // buffer for use by process() function if not passed explicitly |
| uint32_t samplingRate; // sampling rate |
| uint32_t channels; // channel mask (see audio_channel_mask_t in audio.h) |
| buffer_provider_t bufferProvider; // buffer provider |
| uint8_t format; // Audio format (see audio_format_t in audio.h) |
| uint8_t accessMode; // read/write or accumulate in buffer (effect_buffer_access_e) |
| uint16_t mask; // indicates which of the above fields is valid |
| } buffer_config_t; |
| |
| // EFFECT_FEATURE_AUX_CHANNELS feature configuration descriptor. Describe a combination |
| // of main and auxiliary channels supported |
| typedef struct channel_config_s { |
| audio_channel_mask_t main_channels; // channel mask for main channels |
| audio_channel_mask_t aux_channels; // channel mask for auxiliary channels |
| } channel_config_t; |
| |
| |
| // effect_config_s structure is used to configure audio parameters and buffers for effect engine |
| // input and output. |
| typedef struct effect_config_s { |
| buffer_config_t inputCfg; |
| buffer_config_t outputCfg; |
| } effect_config_t; |
| |
| |
| // effect_param_s structure describes the format of the pCmdData argument of EFFECT_CMD_SET_PARAM |
| // command and pCmdData and pReplyData of EFFECT_CMD_GET_PARAM command. |
| // psize and vsize represent the actual size of parameter and value. |
| // |
| // NOTE: the start of value field inside the data field is always on a 32 bit boundary: |
| // |
| // +-----------+ |
| // | status | sizeof(int) |
| // +-----------+ |
| // | psize | sizeof(int) |
| // +-----------+ |
| // | vsize | sizeof(int) |
| // +-----------+ |
| // | | | | |
| // ~ parameter ~ > psize | |
| // | | | > ((psize - 1)/sizeof(int) + 1) * sizeof(int) |
| // +-----------+ | |
| // | padding | | |
| // +-----------+ |
| // | | | |
| // ~ value ~ > vsize |
| // | | | |
| // +-----------+ |
| |
| typedef struct effect_param_s { |
| int32_t status; // Transaction status (unused for command, used for reply) |
| uint32_t psize; // Parameter size |
| uint32_t vsize; // Value size |
| char data[]; // Start of Parameter + Value data |
| } effect_param_t; |
| |
| // Maximum effect_param_t size |
| #define EFFECT_PARAM_SIZE_MAX 65536 |
| |
| // structure used by EFFECT_CMD_OFFLOAD command |
| typedef struct effect_offload_param_s { |
| bool isOffload; // true if the playback thread the effect is attached to is offloaded |
| int ioHandle; // io handle of the playback thread the effect is attached to |
| } effect_offload_param_t; |
| |
| |
| __END_DECLS |
| |
| #endif // ANDROID_AUDIO_EFFECT_CORE_H |