• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 <audio_effects/effect_bassboost.h>
21 #include <audio_effects/effect_equalizer.h>
22 #include <audio_effects/effect_virtualizer.h>
23 #include <LVM.h>
24 #include <limits.h>
25 
26 #if __cplusplus
27 extern "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_
43 static const effect_uuid_t SL_IID_VOLUME_ = { 0x09e8ede0, 0xddde, 0x11db, 0xb4f6,
44                                             { 0x00, 0x02, 0xa5, 0xd5, 0xc5, 0x1b } };
45 const effect_uuid_t * const SL_IID_VOLUME = &SL_IID_VOLUME_;
46 #endif //OPENSL_ES_H_
47 
48 typedef enum
49 {
50     LVM_BASS_BOOST,
51     LVM_VIRTUALIZER,
52     LVM_EQUALIZER,
53     LVM_VOLUME
54 } lvm_effect_en;
55 
56 // Preset configuration.
57 struct 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 */
66 struct 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     LVM_Fs_en                       SampleRate;
92     int                             SamplesPerSecond;
93     int                             SamplesToExitCountEq;
94     int                             SamplesToExitCountBb;
95     int                             SamplesToExitCountVirt;
96     LVM_INT16                       *workBuffer;
97     int                             frameCount;
98     int32_t                         bandGaindB[FIVEBAND_NUMBANDS];
99     int                             volume;
100     #ifdef LVM_PCM
101     FILE                            *PcmInPtr;
102     FILE                            *PcmOutPtr;
103     #endif
104 };
105 
106 /* SessionContext : One session */
107 struct SessionContext{
108     bool                            bBundledEffectsEnabled;
109     bool                            bVolumeInstantiated;
110     bool                            bEqualizerInstantiated;
111     bool                            bBassInstantiated;
112     bool                            bVirtualizerInstantiated;
113     BundledEffectContext            *pBundledContext;
114 };
115 
116 struct EffectContext{
117     const struct effect_interface_s *itfe;
118     effect_config_t                 config;
119     lvm_effect_en                   EffectType;
120     BundledEffectContext            *pBundledContext;
121 };
122 
123 
124 /* enumerated parameter settings for Volume effect */
125 typedef enum
126 {
127     VOLUME_PARAM_LEVEL,                       // type SLmillibel = typedef SLuint16 (set & get)
128     VOLUME_PARAM_MAXLEVEL,                    // type SLmillibel = typedef SLuint16 (get)
129     VOLUME_PARAM_MUTE,                        // type SLboolean  = typedef SLuint32 (set & get)
130     VOLUME_PARAM_ENABLESTEREOPOSITION,        // type SLboolean  = typedef SLuint32 (set & get)
131     VOLUME_PARAM_STEREOPOSITION,              // type SLpermille = typedef SLuint16 (set & get)
132 } t_volume_params;
133 
134 static const int PRESET_CUSTOM = -1;
135 
136 static const uint32_t bandFreqRange[FIVEBAND_NUMBANDS][2] = {
137                                        {30000, 120000},
138                                        {120001, 460000},
139                                        {460001, 1800000},
140                                        {1800001, 7000000},
141                                        {7000001, 1}};
142 
143 static const LVM_UINT16  EQNB_5BandPresetsFrequencies[] = {
144                                        60,           /* Frequencies in Hz */
145                                        230,
146                                        910,
147                                        3600,
148                                        14000};
149 
150 static const LVM_UINT16 EQNB_5BandPresetsQFactors[] = {
151                                        96,               /* Q factor multiplied by 100 */
152                                        96,
153                                        96,
154                                        96,
155                                        96};
156 
157 static const LVM_INT16 EQNB_5BandNormalPresets[] = {
158                                        3, 0, 0, 0, 3,       /* Normal Preset */
159                                        8, 5, -3, 5, 6,      /* Classical Preset */
160                                        15, -6, 7, 13, 10,   /* Dance Preset */
161                                        0, 0, 0, 0, 0,       /* Flat Preset */
162                                        6, -2, -2, 6, -3,    /* Folk Preset */
163                                        8, -8, 13, -1, -4,   /* Heavy Metal Preset */
164                                        10, 6, -4, 5, 8,     /* Hip Hop Preset */
165                                        8, 5, -4, 5, 9,      /* Jazz Preset */
166                                       -6, 4, 9, 4, -5,      /* Pop Preset */
167                                        10, 6, -1, 8, 10};   /* Rock Preset */
168 
169 static const LVM_INT16 EQNB_5BandSoftPresets[] = {
170                                         3, 0, 0, 0, 3,      /* Normal Preset */
171                                         5, 3, -2, 4, 4,     /* Classical Preset */
172                                         6, 0, 2, 4, 1,      /* Dance Preset */
173                                         0, 0, 0, 0, 0,      /* Flat Preset */
174                                         3, 0, 0, 2, -1,     /* Folk Preset */
175                                         4, 1, 9, 3, 0,      /* Heavy Metal Preset */
176                                         5, 3, 0, 1, 3,      /* Hip Hop Preset */
177                                         4, 2, -2, 2, 5,     /* Jazz Preset */
178                                        -1, 2, 5, 1, -2,     /* Pop Preset */
179                                         5, 3, -1, 3, 5};    /* Rock Preset */
180 
181 static const PresetConfig gEqualizerPresets[] = {
182                                         {"Normal"},
183                                         {"Classical"},
184                                         {"Dance"},
185                                         {"Flat"},
186                                         {"Folk"},
187                                         {"Heavy Metal"},
188                                         {"Hip Hop"},
189                                         {"Jazz"},
190                                         {"Pop"},
191                                         {"Rock"}};
192 
193 #if __cplusplus
194 }  // extern "C"
195 #endif
196 
197 
198 #endif /*ANDROID_EFFECTBUNDLE_H_*/
199