EffectBundle.h revision e0aed6ddcb4e3c301b80aa26706b6052dab42c41 
1/*
2 * Copyright (C) 2010 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_EFFECTBUNDLE_H_
18#define ANDROID_EFFECTBUNDLE_H_
19
20#include <media/EffectEqualizerApi.h>
21#include <media/EffectBassBoostApi.h>
22#include <media/EffectVirtualizerApi.h>
23#include <LVM.h>
24#include <limits.h>
25
26#if __cplusplus
27extern "C" {
28#endif
29
30#define FIVEBAND_NUMBANDS          5
31#define MAX_NUM_BANDS              5
32#define MAX_CALL_SIZE              256
33#define LVM_MAX_SESSIONS           32
34#define LVM_UNUSED_SESSION         INT_MAX
35#define BASS_BOOST_CUP_LOAD_ARM9E  150    // Expressed in 0.1 MIPS
36#define VIRTUALIZER_CUP_LOAD_ARM9E 120    // Expressed in 0.1 MIPS
37#define EQUALIZER_CUP_LOAD_ARM9E   220    // Expressed in 0.1 MIPS
38#define VOLUME_CUP_LOAD_ARM9E      0      // Expressed in 0.1 MIPS
39#define BUNDLE_MEM_USAGE           25     // Expressed in kB
40//#define LVM_PCM
41
42#ifndef OPENSL_ES_H_
43static const effect_uuid_t SL_IID_VOLUME_ = { 0x09e8ede0, 0xddde, 0x11db, 0xb4f6,
44                                            { 0x00, 0x02, 0xa5, 0xd5, 0xc5, 0x1b } };
45const effect_uuid_t * const SL_IID_VOLUME = &SL_IID_VOLUME_;
46#endif //OPENSL_ES_H_
47
48typedef enum
49{
50    LVM_BASS_BOOST,
51    LVM_VIRTUALIZER,
52    LVM_EQUALIZER,
53    LVM_VOLUME
54} lvm_effect_en;
55
56// Preset configuration.
57struct PresetConfig {
58    // Human-readable name.
59    const char * name;
60    // An array of size nBands where each element is a configuration for the
61    // corresponding band.
62    //const BandConfig * bandConfigs;
63};
64
65/* BundledEffectContext : One per session */
66struct BundledEffectContext{
67    LVM_Handle_t                    hInstance;                /* Instance handle */
68    int                             SessionNo;                /* Current session number */
69    int                             SessionId;                /* Current session id */
70    bool                            bVolumeEnabled;           /* Flag for Volume */
71    bool                            bEqualizerEnabled;        /* Flag for EQ */
72    bool                            bBassEnabled;             /* Flag for Bass */
73    bool                            bBassTempDisabled;        /* Flag for Bass to be re-enabled */
74    bool                            bVirtualizerEnabled;      /* Flag for Virtualizer */
75    bool                            bVirtualizerTempDisabled; /* Flag for effect to be re-enabled */
76    int                             NumberEffectsEnabled;     /* Effects in this session */
77    int                             NumberEffectsCalled;      /* Effects called so far */
78    bool                            firstVolume;              /* No smoothing on first Vol change */
79    // Saved parameters for each effect */
80    // Bass Boost
81    int                             BassStrengthSaved;        /* Conversion between Get/Set */
82    // Equalizer
83    int                             CurPreset;                /* Current preset being used */
84    // Virtualzer
85    int                             VirtStrengthSaved;        /* Conversion between Get/Set */
86    // Volume
87    int                             levelSaved;     /* for when mute is set, level must be saved */
88    int                             positionSaved;
89    bool                            bMuteEnabled;   /* Must store as mute = -96dB level */
90    bool                            bStereoPositionEnabled;
91    int                             frameCount;
92    LVM_Fs_en                       SampleRate;
93    int                             SamplesPerSecond;
94    int                             SamplesToExitCountEq;
95    int                             SamplesToExitCountBb;
96    int                             SamplesToExitCountVirt;
97    #ifdef LVM_PCM
98    FILE                            *PcmInPtr;
99    FILE                            *PcmOutPtr;
100    #endif
101};
102
103/* SessionContext : One session */
104struct SessionContext{
105    bool                            bBundledEffectsEnabled;
106    bool                            bVolumeInstantiated;
107    bool                            bEqualizerInstantiated;
108    bool                            bBassInstantiated;
109    bool                            bVirtualizerInstantiated;
110    BundledEffectContext            *pBundledContext;
111};
112
113struct EffectContext{
114    const struct effect_interface_s *itfe;
115    effect_config_t                 config;
116    lvm_effect_en                   EffectType;
117    BundledEffectContext            *pBundledContext;
118};
119
120
121/* enumerated parameter settings for Volume effect */
122typedef enum
123{
124    VOLUME_PARAM_LEVEL,                       // type SLmillibel = typedef SLuint16 (set & get)
125    VOLUME_PARAM_MAXLEVEL,                    // type SLmillibel = typedef SLuint16 (get)
126    VOLUME_PARAM_MUTE,                        // type SLboolean  = typedef SLuint32 (set & get)
127    VOLUME_PARAM_ENABLESTEREOPOSITION,        // type SLboolean  = typedef SLuint32 (set & get)
128    VOLUME_PARAM_STEREOPOSITION,              // type SLpermille = typedef SLuint16 (set & get)
129} t_volume_params;
130
131static const int PRESET_CUSTOM = -1;
132
133static const uint32_t bandFreqRange[FIVEBAND_NUMBANDS][2] = {
134                                       {30000, 120000},
135                                       {120001, 460000},
136                                       {460001, 1800000},
137                                       {1800001, 7000000},
138                                       {7000001, 1}};
139
140static const LVM_UINT16  EQNB_5BandPresetsFrequencies[] = {
141                                       60,           /* Frequencies in Hz */
142                                       230,
143                                       910,
144                                       3600,
145                                       14000};
146
147static const LVM_UINT16 EQNB_5BandPresetsQFactors[] = {
148                                       96,               /* Q factor multiplied by 100 */
149                                       96,
150                                       96,
151                                       96,
152                                       96};
153
154static const LVM_INT16 EQNB_5BandNormalPresets[] = {
155                                       3, 0, 0, 0, 3,       /* Normal Preset */
156                                       8, 5, -3, 5, 6,      /* Classical Preset */
157                                       15, -6, 7, 13, 10,   /* Dance Preset */
158                                       0, 0, 0, 0, 0,       /* Flat Preset */
159                                       6, -2, -2, 6, -3,    /* Folk Preset */
160                                       8, -8, 13, -1, -4,   /* Heavy Metal Preset */
161                                       10, 6, -4, 5, 8,     /* Hip Hop Preset */
162                                       8, 5, -4, 5, 9,      /* Jazz Preset */
163                                      -6, 4, 9, 4, -5,      /* Pop Preset */
164                                       10, 6, -1, 8, 10};   /* Rock Preset */
165
166static const LVM_INT16 EQNB_5BandSoftPresets[] = {
167                                        3, 0, 0, 0, 3,      /* Normal Preset */
168                                        5, 3, -2, 4, 4,     /* Classical Preset */
169                                        6, 0, 2, 4, 1,      /* Dance Preset */
170                                        0, 0, 0, 0, 0,      /* Flat Preset */
171                                        3, 0, 0, 2, -1,     /* Folk Preset */
172                                        4, 1, 9, 3, 0,      /* Heavy Metal Preset */
173                                        5, 3, 0, 1, 3,      /* Hip Hop Preset */
174                                        4, 2, -2, 2, 5,     /* Jazz Preset */
175                                       -1, 2, 5, 1, -2,     /* Pop Preset */
176                                        5, 3, -1, 3, 5};    /* Rock Preset */
177
178static const PresetConfig gEqualizerPresets[] = {
179                                        {"Normal"},
180                                        {"Classical"},
181                                        {"Dance"},
182                                        {"Flat"},
183                                        {"Folk"},
184                                        {"Heavy Metal"},
185                                        {"Hip Hop"},
186                                        {"Jazz"},
187                                        {"Pop"},
188                                        {"Rock"}};
189
190#if __cplusplus
191}  // extern "C"
192#endif
193
194
195#endif /*ANDROID_EFFECTBUNDLE_H_*/
196