Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 1b88fb16 authored by Eric Laurent's avatar Eric Laurent Committed by Android Git Automerger
Browse files

am cf3fa85c: Merge "Fix issue 2667796: [Audio Effect Framework] Effect factory... 

am cf3fa85c: Merge "Fix issue 2667796: [Audio Effect Framework] Effect factory and libraries." into kraken
parents 36893612 cf3fa85c

include/media/AudioCommon.h

0 → 100644
+80 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2010 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_AUDIOCOMMON_H_

#define ANDROID_AUDIOCOMMON_H_



#if __cplusplus

extern "C" {

#endif



/////////////////////////////////////////////////

//      Common definitions for PCM audio

/////////////////////////////////////////////////





// PCM Sample format

enum audio_format_e {

    PCM_FORMAT_S15 = 1,     // PCM signed 16 bits, must be 1 for backward compatibility

    PCM_FORMAT_U8 = 2,      // PCM unsigned 8 bits, must be 2 for backward compatibility

    PCM_FORMAT_S7_24        // signed 7.24 fixed point representation

};



// Channel mask definitions

enum audio_channels_e {

    CHANNEL_FRONT_LEFT = 0x4,                   // front left channel

    CHANNEL_FRONT_RIGHT = 0x8,                  // front right channel

    CHANNEL_FRONT_CENTER = 0x10,                // front center channel

    CHANNEL_LOW_FREQUENCY = 0x20,               // low frequency channel

    CHANNEL_BACK_LEFT = 0x40,                   // back left channel

    CHANNEL_BACK_RIGHT = 0x80,                  // back right channel

    CHANNEL_FRONT_LEFT_OF_CENTER = 0x100,       // front left of center channel

    CHANNEL_FRONT_RIGHT_OF_CENTER = 0x200,      // front right of center channel

    CHANNEL_BACK_CENTER = 0x400,                // back center channel

    CHANNEL_MONO = CHANNEL_FRONT_LEFT,

    CHANNEL_STEREO = (CHANNEL_FRONT_LEFT | CHANNEL_FRONT_RIGHT),

    CHANNEL_QUAD = (CHANNEL_FRONT_LEFT | CHANNEL_FRONT_RIGHT |

            CHANNEL_BACK_LEFT | CHANNEL_BACK_RIGHT),

    CHANNEL_SURROUND = (CHANNEL_FRONT_LEFT | CHANNEL_FRONT_RIGHT |

            CHANNEL_FRONT_CENTER | CHANNEL_BACK_CENTER),

    CHANNEL_5POINT1 = (CHANNEL_FRONT_LEFT | CHANNEL_FRONT_RIGHT |

            CHANNEL_FRONT_CENTER | CHANNEL_LOW_FREQUENCY | CHANNEL_BACK_LEFT | CHANNEL_BACK_RIGHT),

    CHANNEL_7POINT1 = (CHANNEL_FRONT_LEFT | CHANNEL_FRONT_RIGHT |

            CHANNEL_FRONT_CENTER | CHANNEL_LOW_FREQUENCY | CHANNEL_BACK_LEFT | CHANNEL_BACK_RIGHT |

            CHANNEL_FRONT_LEFT_OF_CENTER | CHANNEL_FRONT_RIGHT_OF_CENTER),

};



// Render device definitions

enum audio_device_e {

    DEVICE_EARPIECE = 0x1,                      // earpiece

    DEVICE_SPEAKER = 0x2,                       // speaker

    DEVICE_WIRED_HEADSET = 0x4,                 // wired headset, with microphone

    DEVICE_WIRED_HEADPHONE = 0x8,               // wired headphone, without microphone

    DEVICE_BLUETOOTH_SCO = 0x10,                // generic bluetooth SCO

    DEVICE_BLUETOOTH_SCO_HEADSET = 0x20,        // bluetooth SCO headset

    DEVICE_BLUETOOTH_SCO_CARKIT = 0x40,         // bluetooth SCO car kit

    DEVICE_BLUETOOTH_A2DP = 0x80,               // generic bluetooth A2DP

    DEVICE_BLUETOOTH_A2DP_HEADPHONES = 0x100,   // bluetooth A2DP headphones

    DEVICE_BLUETOOTH_A2DP_SPEAKER = 0x200,      // bluetooth A2DP speakers

    DEVICE_AUX_DIGITAL = 0x400                  // digital output

};



#if __cplusplus

}  // extern "C"

#endif





#endif /*ANDROID_AUDIOCOMMON_H_*/

include/media/AudioSystem.h

+29 −33
Original line number Original line Diff line number Diff line
@@ -20,6 +20,7 @@ 
#include <utils/RefBase.h>

#include <utils/RefBase.h>

#include <utils/threads.h>

#include <utils/threads.h>

#include <media/IAudioFlinger.h>

#include <media/IAudioFlinger.h>

#include <media/AudioCommon.h>





namespace android {

namespace android {
@@ -50,8 +51,8 @@ public: 




    // Audio sub formats (see AudioSystem::audio_format).

    // Audio sub formats (see AudioSystem::audio_format).

    enum pcm_sub_format {

    enum pcm_sub_format {

        PCM_SUB_16_BIT          = 0x1, // must be 1 for backward compatibility

        PCM_SUB_16_BIT          = PCM_FORMAT_S15, // must be 1 for backward compatibility

        PCM_SUB_8_BIT           = 0x2, // must be 2 for backward compatibility

        PCM_SUB_8_BIT           = PCM_FORMAT_U8, // must be 2 for backward compatibility

    };

    };





    // MP3 sub format field definition : can use 11 LSBs in the same way as MP3 frame header to specify

    // MP3 sub format field definition : can use 11 LSBs in the same way as MP3 frame header to specify
@@ -103,26 +104,21 @@ public: 
    // Channel mask definitions must be kept in sync with JAVA values in /media/java/android/media/AudioFormat.java

    // Channel mask definitions must be kept in sync with JAVA values in /media/java/android/media/AudioFormat.java

    enum audio_channels {

    enum audio_channels {

        // output channels

        // output channels

        CHANNEL_OUT_FRONT_LEFT = 0x4,

        CHANNEL_OUT_FRONT_LEFT = CHANNEL_FRONT_LEFT,

        CHANNEL_OUT_FRONT_RIGHT = 0x8,

        CHANNEL_OUT_FRONT_RIGHT = CHANNEL_FRONT_RIGHT,

        CHANNEL_OUT_FRONT_CENTER = 0x10,

        CHANNEL_OUT_FRONT_CENTER = CHANNEL_FRONT_CENTER,

        CHANNEL_OUT_LOW_FREQUENCY = 0x20,

        CHANNEL_OUT_LOW_FREQUENCY = CHANNEL_LOW_FREQUENCY,

        CHANNEL_OUT_BACK_LEFT = 0x40,

        CHANNEL_OUT_BACK_LEFT = CHANNEL_BACK_LEFT,

        CHANNEL_OUT_BACK_RIGHT = 0x80,

        CHANNEL_OUT_BACK_RIGHT = CHANNEL_BACK_RIGHT,

        CHANNEL_OUT_FRONT_LEFT_OF_CENTER = 0x100,

        CHANNEL_OUT_FRONT_LEFT_OF_CENTER = CHANNEL_FRONT_LEFT_OF_CENTER,

        CHANNEL_OUT_FRONT_RIGHT_OF_CENTER = 0x200,

        CHANNEL_OUT_FRONT_RIGHT_OF_CENTER = CHANNEL_FRONT_RIGHT_OF_CENTER,

        CHANNEL_OUT_BACK_CENTER = 0x400,

        CHANNEL_OUT_BACK_CENTER = CHANNEL_BACK_CENTER,

        CHANNEL_OUT_MONO = CHANNEL_OUT_FRONT_LEFT,

        CHANNEL_OUT_MONO = CHANNEL_MONO,

        CHANNEL_OUT_STEREO = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT),

        CHANNEL_OUT_STEREO = CHANNEL_STEREO,

        CHANNEL_OUT_QUAD = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |

        CHANNEL_OUT_QUAD = CHANNEL_QUAD,

                CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT),

        CHANNEL_OUT_SURROUND = CHANNEL_SURROUND,

        CHANNEL_OUT_SURROUND = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |

        CHANNEL_OUT_5POINT1 = CHANNEL_5POINT1,

                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_BACK_CENTER),

        CHANNEL_OUT_7POINT1 = CHANNEL_7POINT1,

        CHANNEL_OUT_5POINT1 = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |

                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT),

        CHANNEL_OUT_7POINT1 = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |

                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT |

                CHANNEL_OUT_FRONT_LEFT_OF_CENTER | CHANNEL_OUT_FRONT_RIGHT_OF_CENTER),

        CHANNEL_OUT_ALL = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |

        CHANNEL_OUT_ALL = (CHANNEL_OUT_FRONT_LEFT | CHANNEL_OUT_FRONT_RIGHT |

                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT |

                CHANNEL_OUT_FRONT_CENTER | CHANNEL_OUT_LOW_FREQUENCY | CHANNEL_OUT_BACK_LEFT | CHANNEL_OUT_BACK_RIGHT |

                CHANNEL_OUT_FRONT_LEFT_OF_CENTER | CHANNEL_OUT_FRONT_RIGHT_OF_CENTER | CHANNEL_OUT_BACK_CENTER),

                CHANNEL_OUT_FRONT_LEFT_OF_CENTER | CHANNEL_OUT_FRONT_RIGHT_OF_CENTER | CHANNEL_OUT_BACK_CENTER),
@@ -240,17 +236,17 @@ public: 




    enum audio_devices {

    enum audio_devices {

        // output devices

        // output devices

        DEVICE_OUT_EARPIECE = 0x1,

        DEVICE_OUT_EARPIECE = DEVICE_EARPIECE,

        DEVICE_OUT_SPEAKER = 0x2,

        DEVICE_OUT_SPEAKER = DEVICE_SPEAKER,

        DEVICE_OUT_WIRED_HEADSET = 0x4,

        DEVICE_OUT_WIRED_HEADSET = DEVICE_WIRED_HEADSET,

        DEVICE_OUT_WIRED_HEADPHONE = 0x8,

        DEVICE_OUT_WIRED_HEADPHONE = DEVICE_WIRED_HEADPHONE,

        DEVICE_OUT_BLUETOOTH_SCO = 0x10,

        DEVICE_OUT_BLUETOOTH_SCO = DEVICE_BLUETOOTH_SCO,

        DEVICE_OUT_BLUETOOTH_SCO_HEADSET = 0x20,

        DEVICE_OUT_BLUETOOTH_SCO_HEADSET = DEVICE_BLUETOOTH_SCO_HEADSET,

        DEVICE_OUT_BLUETOOTH_SCO_CARKIT = 0x40,

        DEVICE_OUT_BLUETOOTH_SCO_CARKIT = DEVICE_BLUETOOTH_SCO_CARKIT,

        DEVICE_OUT_BLUETOOTH_A2DP = 0x80,

        DEVICE_OUT_BLUETOOTH_A2DP = DEVICE_BLUETOOTH_A2DP,

        DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES = 0x100,

        DEVICE_OUT_BLUETOOTH_A2DP_HEADPHONES = DEVICE_BLUETOOTH_A2DP_HEADPHONES,

        DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER = 0x200,

        DEVICE_OUT_BLUETOOTH_A2DP_SPEAKER = DEVICE_BLUETOOTH_A2DP_SPEAKER,

        DEVICE_OUT_AUX_DIGITAL = 0x400,

        DEVICE_OUT_AUX_DIGITAL = DEVICE_AUX_DIGITAL,

        DEVICE_OUT_DEFAULT = 0x8000,

        DEVICE_OUT_DEFAULT = 0x8000,

        DEVICE_OUT_ALL = (DEVICE_OUT_EARPIECE | DEVICE_OUT_SPEAKER | DEVICE_OUT_WIRED_HEADSET |

        DEVICE_OUT_ALL = (DEVICE_OUT_EARPIECE | DEVICE_OUT_SPEAKER | DEVICE_OUT_WIRED_HEADSET |

                DEVICE_OUT_WIRED_HEADPHONE | DEVICE_OUT_BLUETOOTH_SCO | DEVICE_OUT_BLUETOOTH_SCO_HEADSET |

                DEVICE_OUT_WIRED_HEADPHONE | DEVICE_OUT_BLUETOOTH_SCO | DEVICE_OUT_BLUETOOTH_SCO_HEADSET |

include/media/EffectApi.h

0 → 100644
+555 −0

File added.

Preview size limit exceeded, changes collapsed.

include/media/EffectEqualizerApi.h

0 → 100644
+50 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2010 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_EFFECTEQUALIZERAPI_H_

#define ANDROID_EFFECTEQUALIZERAPI_H_



#include <media/EffectApi.h>



#if __cplusplus

extern "C" {

#endif



//TODO replace by openSL ES include when available

static const effect_uuid_t SL_IID_EQUALIZER_ = { 0x0bed4300, 0xddd6, 0x11db, 0x8f34, { 0x00, 0x02, 0xa5, 0xd5, 0xc5, 0x1b } };

const effect_uuid_t * const SL_IID_EQUALIZER = &SL_IID_EQUALIZER_;



/* enumerated parameters for Equalizer effect */

typedef enum

{

    EQ_PARAM_NUM_BANDS,             // Gets the number of frequency bands that the equalizer supports.

    EQ_PARAM_LEVEL_RANGE,           // Returns the minimum and maximum band levels supported.

    EQ_PARAM_BAND_LEVEL,            // Gets/Sets the gain set for the given equalizer band.

    EQ_PARAM_CENTER_FREQ,           // Gets the center frequency of the given band.

    EQ_PARAM_BAND_FREQ_RANGE,       // Gets the frequency range of the given frequency band.

    EQ_PARAM_GET_BAND,              // Gets the band that has the most effect on the given frequency.

    EQ_PARAM_CUR_PRESET,            // Gets/Sets the current preset.

    EQ_PARAM_GET_NUM_OF_PRESETS,    // Gets the total number of presets the equalizer supports.

    EQ_PARAM_GET_PRESET_NAME        // Gets the preset name based on the index.

} t_equalizer_params;





#if __cplusplus

}  // extern "C"

#endif





#endif /*ANDROID_EFFECTEQUALIZERAPI_H_*/

include/media/EffectFactoryApi.h

0 → 100644
+214 −0
Original line number Original line Diff line number Diff line 
/*

 * Copyright (C) 2010 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_EFFECTFACTORYAPI_H_

#define ANDROID_EFFECTFACTORYAPI_H_



#include <errno.h>

#include <stdint.h>

#include <sys/types.h>

#include <media/EffectApi.h>



#if __cplusplus

extern "C" {

#endif



/////////////////////////////////////////////////

//      Effect factory interface

/////////////////////////////////////////////////



////////////////////////////////////////////////////////////////////////////////

//

//    Function:       EffectQueryNumberEffects

//

//    Description:    Returns the number of different effect in all loaded libraries.

//          Each effect must have a different effect uuid (see

//          effect_descriptor_t). This function together with EffectQueryNext()

//          is used to enumerate all effects present in all loaded libraries.

//          Each time EffectQueryNumberEffects() is called, the factory must

//          reset the index of the effect descriptor returned by next call to

//          EffectQueryNext() to restart enumeration from the beginning.

//

//    Input/Output:

//          pNumEffects:    address where the number of effects should be returned.

//

//    Output:

//        returned value:    0          successful operation.

//                          -ENODEV     factory failed to initialize

//                          -EINVAL     invalid pNumEffects

//        *pNumEffects:     updated with number of effects in factory

//

////////////////////////////////////////////////////////////////////////////////

int EffectQueryNumberEffects(int *pNumEffects);



////////////////////////////////////////////////////////////////////////////////

//

//    Function:       EffectQueryNext

//

//    Description:    Returns a descriptor of the next available effect.

//          See effect_descriptor_t for a details on effect descriptor.

//          This function together with EffectQueryNext() is used to enumerate all

//          effects present in all loaded libraries. The enumeration sequence is:

//              EffectQueryNumberEffects(&num_effects);

//              while (num_effects--)

//                  EffectQueryNext();

//

//    Input/Output:

//          pDescriptor:    address where to return the effect descriptor.

//

//    Output:

//        returned value:    0          successful operation.

//                          -ENODEV     factory failed to initialize

//                          -EINVAL     invalid pDescriptor

//                          -ENOENT     no more effect available

//        *pDescriptor:     updated with the effect descriptor.

//

////////////////////////////////////////////////////////////////////////////////

int EffectQueryNext(effect_descriptor_t *pDescriptor);



////////////////////////////////////////////////////////////////////////////////

//

//    Function:       EffectCreate

//

//    Description:    Creates an effect engine of the specified type and returns an

//          effect control interface on this engine. The function will allocate the

//          resources for an instance of the requested effect engine and return

//          a handler on the effect control interface.

//

//    Input:

//          pEffectUuid:    pointer to the effect uuid.

//

//    Input/Output:

//          pInterface:    address where to return the effect interface.

//

//    Output:

//        returned value:    0          successful operation.

//                          -ENODEV     factory failed to initialize

//                          -EINVAL     invalid pEffectUuid or pInterface

//                          -ENOENT     No effect with this uuid found

//        *pInterface:     updated with the effect interface.

//

////////////////////////////////////////////////////////////////////////////////

int EffectCreate(effect_uuid_t *pEffectUuid, effect_interface_t *pInterface);



////////////////////////////////////////////////////////////////////////////////

//

//    Function:       EffectRelease

//

//    Description:    Releases the effect engine whose handler is given as argument.

//          All resources allocated to this particular instance of the effect are

//          released.

//

//    Input:

//          interface:    handler on the effect interface to be released.

//

//    Output:

//        returned value:    0          successful operation.

//                          -ENODEV     factory failed to initialize

//                          -EINVAL     invalid interface handler

//

////////////////////////////////////////////////////////////////////////////////

int EffectRelease(effect_interface_t interface);



////////////////////////////////////////////////////////////////////////////////

//

//    Function:       EffectLoadLibrary

//

//    Description:    Loads the effect library which path is given as first argument.

//          This must be the full path of a dynamic library (.so) implementing one or

//          more effect engines and exposing the effect library interface described in

//          EffectApi.h. The function returns a handle on the library for used by

//          further call to EffectUnloadLibrary() to unload the library.

//

//    Input:

//          libPath:    full path of the dynamic library file in the file system.

//

//          handle:     address where to return the library handle

//

//    Output:

//        returned value:    0          successful operation.

//                          -ENODEV     Effect factory not initialized or

//                                      library could not be loaded or

//                                      library does not implement required functions

//                          -EINVAL     invalid libPath string or handle

//

////////////////////////////////////////////////////////////////////////////////

int EffectLoadLibrary(const char *libPath, int *handle);



////////////////////////////////////////////////////////////////////////////////

//

//    Function:       EffectUnloadLibrary

//

//    Description:  Unloads the effect library which handle is given as argument.

//

//    Input:

//          handle: library handle

//

//    Output:

//        returned value:    0          successful operation.

//                          -ENODEV     Effect factory not initialized

//                          -ENOENT     invalid handle

//

////////////////////////////////////////////////////////////////////////////////

int EffectUnloadLibrary(int handle);







////////////////////////////////////////////////////////////////////////////////

//

//    Function:       EffectGetDescriptor

//

//    Description:    Returns the descriptor of the effect which uuid is pointed

//          to by first argument.

//

//    Input:

//          pEffectUuid:    pointer to the effect uuid.

//

//    Input/Output:

//          pDescriptor:    address where to return the effect descriptor.

//

//    Output:

//        returned value:    0          successful operation.

//                          -ENODEV     factory failed to initialize

//                          -EINVAL     invalid pEffectUuid or pDescriptor

//                          -ENOENT     No effect with this uuid found

//        *pDescriptor:     updated with the effect descriptor.

//

////////////////////////////////////////////////////////////////////////////////

int EffectGetDescriptor(effect_uuid_t *pEffectUuid, effect_descriptor_t *pDescriptor);



////////////////////////////////////////////////////////////////////////////////

//

//    Function:       EffectIsNullUuid

//

//    Description:    Helper function to compare effect uuid to EFFECT_UUID_NULL

//

//    Input:

//          pEffectUuid: pointer to effect uuid to compare to EFFECT_UUID_NULL.

//

//    Output:

//        returned value:    0 if uuid is different from EFFECT_UUID_NULL.

//                           1 if uuid is equal to EFFECT_UUID_NULL.

//

////////////////////////////////////////////////////////////////////////////////

int EffectIsNullUuid(effect_uuid_t *pEffectUuid);



#if __cplusplus

}  // extern "C"

#endif





#endif /*ANDROID_EFFECTFACTORYAPI_H_*/