AudioPolicyManager.h revision 1afeecb88bea660b2c10b2096be0fd02433303ce
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
18#include <stdint.h>
19#include <sys/types.h>
20#include <cutils/config_utils.h>
21#include <cutils/misc.h>
22#include <utils/Timers.h>
23#include <utils/Errors.h>
24#include <utils/KeyedVector.h>
25#include <utils/SortedVector.h>
26#include "AudioPolicyInterface.h"
27
28
29namespace android {
30
31// ----------------------------------------------------------------------------
32
33// Attenuation applied to STRATEGY_SONIFICATION streams when a headset is connected: 6dB
34#define SONIFICATION_HEADSET_VOLUME_FACTOR 0.5
35// Min volume for STRATEGY_SONIFICATION streams when limited by music volume: -36dB
36#define SONIFICATION_HEADSET_VOLUME_MIN  0.016
37// Time in milliseconds during which we consider that music is still active after a music
38// track was stopped - see computeVolume()
39#define SONIFICATION_HEADSET_MUSIC_DELAY  5000
40// Time in milliseconds after media stopped playing during which we consider that the
41// sonification should be as unobtrusive as during the time media was playing.
42#define SONIFICATION_RESPECTFUL_AFTER_MUSIC_DELAY 5000
43// Time in milliseconds during witch some streams are muted while the audio path
44// is switched
45#define MUTE_TIME_MS 2000
46
47#define NUM_TEST_OUTPUTS 5
48
49#define NUM_VOL_CURVE_KNEES 2
50
51// Default minimum length allowed for offloading a compressed track
52// Can be overridden by the audio.offload.min.duration.secs property
53#define OFFLOAD_DEFAULT_MIN_DURATION_SECS 60
54
55// ----------------------------------------------------------------------------
56// AudioPolicyManager implements audio policy manager behavior common to all platforms.
57// ----------------------------------------------------------------------------
58
59class AudioPolicyManager: public AudioPolicyInterface
60#ifdef AUDIO_POLICY_TEST
61    , public Thread
62#endif //AUDIO_POLICY_TEST
63{
64
65public:
66                AudioPolicyManager(AudioPolicyClientInterface *clientInterface);
67        virtual ~AudioPolicyManager();
68
69        // AudioPolicyInterface
70        virtual status_t setDeviceConnectionState(audio_devices_t device,
71                                                          audio_policy_dev_state_t state,
72                                                          const char *device_address);
73        virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
74                                                                              const char *device_address);
75        virtual void setPhoneState(audio_mode_t state);
76        virtual void setForceUse(audio_policy_force_use_t usage,
77                                 audio_policy_forced_cfg_t config);
78        virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage);
79        virtual void setSystemProperty(const char* property, const char* value);
80        virtual status_t initCheck();
81        virtual audio_io_handle_t getOutput(audio_stream_type_t stream,
82                                            uint32_t samplingRate,
83                                            audio_format_t format,
84                                            audio_channel_mask_t channelMask,
85                                            audio_output_flags_t flags,
86                                            const audio_offload_info_t *offloadInfo);
87        virtual status_t startOutput(audio_io_handle_t output,
88                                     audio_stream_type_t stream,
89                                     int session = 0);
90        virtual status_t stopOutput(audio_io_handle_t output,
91                                    audio_stream_type_t stream,
92                                    int session = 0);
93        virtual void releaseOutput(audio_io_handle_t output);
94        virtual audio_io_handle_t getInput(audio_source_t inputSource,
95                                            uint32_t samplingRate,
96                                            audio_format_t format,
97                                            audio_channel_mask_t channelMask,
98                                            audio_in_acoustics_t acoustics);
99
100        // indicates to the audio policy manager that the input starts being used.
101        virtual status_t startInput(audio_io_handle_t input);
102
103        // indicates to the audio policy manager that the input stops being used.
104        virtual status_t stopInput(audio_io_handle_t input);
105        virtual void releaseInput(audio_io_handle_t input);
106        virtual void closeAllInputs();
107        virtual void initStreamVolume(audio_stream_type_t stream,
108                                                    int indexMin,
109                                                    int indexMax);
110        virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
111                                              int index,
112                                              audio_devices_t device);
113        virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
114                                              int *index,
115                                              audio_devices_t device);
116
117        // return the strategy corresponding to a given stream type
118        virtual uint32_t getStrategyForStream(audio_stream_type_t stream);
119
120        // return the enabled output devices for the given stream type
121        virtual audio_devices_t getDevicesForStream(audio_stream_type_t stream);
122
123        virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc = NULL);
124        virtual status_t registerEffect(const effect_descriptor_t *desc,
125                                        audio_io_handle_t io,
126                                        uint32_t strategy,
127                                        int session,
128                                        int id);
129        virtual status_t unregisterEffect(int id);
130        virtual status_t setEffectEnabled(int id, bool enabled);
131
132        virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const;
133        // return whether a stream is playing remotely, override to change the definition of
134        //   local/remote playback, used for instance by notification manager to not make
135        //   media players lose audio focus when not playing locally
136        virtual bool isStreamActiveRemotely(audio_stream_type_t stream, uint32_t inPastMs = 0) const;
137        virtual bool isSourceActive(audio_source_t source) const;
138
139        virtual status_t dump(int fd);
140
141        virtual bool isOffloadSupported(const audio_offload_info_t& offloadInfo);
142
143        virtual status_t listAudioPorts(audio_port_role_t role,
144                                        audio_port_type_t type,
145                                        unsigned int *num_ports,
146                                        struct audio_port *ports,
147                                        unsigned int *generation);
148        virtual status_t getAudioPort(struct audio_port *port);
149        virtual status_t createAudioPatch(const struct audio_patch *patch,
150                                           audio_patch_handle_t *handle,
151                                           uid_t uid);
152        virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
153                                              uid_t uid);
154        virtual status_t listAudioPatches(unsigned int *num_patches,
155                                          struct audio_patch *patches,
156                                          unsigned int *generation);
157        virtual status_t setAudioPortConfig(const struct audio_port_config *config);
158        virtual void clearAudioPatches(uid_t uid);
159
160protected:
161
162        enum routing_strategy {
163            STRATEGY_MEDIA,
164            STRATEGY_PHONE,
165            STRATEGY_SONIFICATION,
166            STRATEGY_SONIFICATION_RESPECTFUL,
167            STRATEGY_DTMF,
168            STRATEGY_ENFORCED_AUDIBLE,
169            NUM_STRATEGIES
170        };
171
172        // 4 points to define the volume attenuation curve, each characterized by the volume
173        // index (from 0 to 100) at which they apply, and the attenuation in dB at that index.
174        // we use 100 steps to avoid rounding errors when computing the volume in volIndexToAmpl()
175
176        enum { VOLMIN = 0, VOLKNEE1 = 1, VOLKNEE2 = 2, VOLMAX = 3, VOLCNT = 4};
177
178        class VolumeCurvePoint
179        {
180        public:
181            int mIndex;
182            float mDBAttenuation;
183        };
184
185        // device categories used for volume curve management.
186        enum device_category {
187            DEVICE_CATEGORY_HEADSET,
188            DEVICE_CATEGORY_SPEAKER,
189            DEVICE_CATEGORY_EARPIECE,
190            DEVICE_CATEGORY_CNT
191        };
192
193        class HwModule;
194
195        class AudioGain: public RefBase
196        {
197        public:
198            AudioGain();
199            virtual ~AudioGain() {}
200
201            void dump(int fd, int spaces, int index) const;
202
203            struct audio_gain mGain;
204        };
205
206        class AudioPort: public RefBase
207        {
208        public:
209            AudioPort(const String8& name, audio_port_type_t type,
210                      audio_port_role_t role, HwModule *module) :
211                mName(name), mType(type), mRole(role), mModule(module) {}
212            virtual ~AudioPort() {}
213
214            virtual void toAudioPort(struct audio_port *port) const;
215
216            void loadSamplingRates(char *name);
217            void loadFormats(char *name);
218            void loadOutChannels(char *name);
219            void loadInChannels(char *name);
220
221            audio_gain_mode_t loadGainMode(char *name);
222            void loadGain(cnode *root);
223            void loadGains(cnode *root);
224
225            void dump(int fd, int spaces) const;
226
227            String8           mName;
228            audio_port_type_t mType;
229            audio_port_role_t mRole;
230            // by convention, "0' in the first entry in mSamplingRates, mChannelMasks or mFormats
231            // indicates the supported parameters should be read from the output stream
232            // after it is opened for the first time
233            Vector <uint32_t> mSamplingRates; // supported sampling rates
234            Vector <audio_channel_mask_t> mChannelMasks; // supported channel masks
235            Vector <audio_format_t> mFormats; // supported audio formats
236            Vector < sp<AudioGain> > mGains; // gain controllers
237            HwModule *mModule;                 // audio HW module exposing this I/O stream
238        };
239
240        class AudioPatch: public RefBase
241        {
242        public:
243            AudioPatch(audio_patch_handle_t handle,
244                       const struct audio_patch *patch, uid_t uid) :
245                           mHandle(handle), mPatch(*patch), mUid(uid), mAfPatchHandle(0) {}
246
247            audio_patch_handle_t mHandle;
248            struct audio_patch mPatch;
249            uid_t mUid;
250            audio_patch_handle_t mAfPatchHandle;
251        };
252
253        class DeviceDescriptor: public AudioPort
254        {
255        public:
256            DeviceDescriptor(const String8& name, audio_devices_t type, String8 address,
257                             audio_channel_mask_t channelMask) :
258                                 AudioPort(name, AUDIO_PORT_TYPE_DEVICE,
259                                           audio_is_output_device(type) ? AUDIO_PORT_ROLE_SINK :
260                                                                          AUDIO_PORT_ROLE_SOURCE,
261                                         NULL),
262                                 mDeviceType(type), mAddress(address),
263                                 mChannelMask(channelMask), mId(0) {}
264
265            DeviceDescriptor(String8 name, audio_devices_t type) :
266                                AudioPort(name, AUDIO_PORT_TYPE_DEVICE,
267                                          audio_is_output_device(type) ? AUDIO_PORT_ROLE_SINK :
268                                                                         AUDIO_PORT_ROLE_SOURCE,
269                                        NULL),
270                                mDeviceType(type), mAddress(""),
271                                mChannelMask(0), mId(0) {}
272            virtual ~DeviceDescriptor() {}
273
274            bool equals(const sp<DeviceDescriptor>& other) const;
275            void toAudioPortConfig(struct audio_port_config *dstConfig,
276                                   const struct audio_port_config *srcConfig = NULL) const;
277
278            virtual void toAudioPort(struct audio_port *port) const;
279
280            status_t dump(int fd, int spaces, int index) const;
281
282            audio_devices_t mDeviceType;
283            String8 mAddress;
284            audio_channel_mask_t mChannelMask;
285            audio_port_handle_t mId;
286        };
287
288        class DeviceVector : public SortedVector< sp<DeviceDescriptor> >
289        {
290        public:
291            DeviceVector() : SortedVector(), mDeviceTypes(AUDIO_DEVICE_NONE) {}
292
293            ssize_t         add(const sp<DeviceDescriptor>& item);
294            ssize_t         remove(const sp<DeviceDescriptor>& item);
295            ssize_t         indexOf(const sp<DeviceDescriptor>& item) const;
296
297            audio_devices_t types() const { return mDeviceTypes; }
298
299            void loadDevicesFromType(audio_devices_t types);
300            void loadDevicesFromName(char *name, const DeviceVector& declaredDevices);
301
302            sp<DeviceDescriptor> getDevice(audio_devices_t type, String8 address) const;
303            DeviceVector getDevicesFromType(audio_devices_t types) const;
304            sp<DeviceDescriptor> getDeviceFromId(audio_port_handle_t id) const;
305            sp<DeviceDescriptor> getDeviceFromName(const String8& name) const;
306
307        private:
308            void refreshTypes();
309            audio_devices_t mDeviceTypes;
310        };
311
312        // the IOProfile class describes the capabilities of an output or input stream.
313        // It is currently assumed that all combination of listed parameters are supported.
314        // It is used by the policy manager to determine if an output or input is suitable for
315        // a given use case,  open/close it accordingly and connect/disconnect audio tracks
316        // to/from it.
317        class IOProfile : public AudioPort
318        {
319        public:
320            IOProfile(const String8& name, audio_port_role_t role, HwModule *module);
321            virtual ~IOProfile();
322
323            bool isCompatibleProfile(audio_devices_t device,
324                                     uint32_t samplingRate,
325                                     audio_format_t format,
326                                     audio_channel_mask_t channelMask,
327                                     audio_output_flags_t flags) const;
328
329            void dump(int fd);
330            void log();
331
332            DeviceVector  mSupportedDevices; // supported devices
333                                             // (devices this output can be routed to)
334            audio_output_flags_t mFlags; // attribute flags (e.g primary output,
335                                                // direct output...). For outputs only.
336        };
337
338        class HwModule {
339        public:
340                    HwModule(const char *name);
341                    ~HwModule();
342
343            status_t loadOutput(cnode *root);
344            status_t loadInput(cnode *root);
345            status_t loadDevice(cnode *root);
346
347            void dump(int fd);
348
349            const char *const mName; // base name of the audio HW module (primary, a2dp ...)
350            audio_module_handle_t mHandle;
351            Vector < sp<IOProfile> > mOutputProfiles; // output profiles exposed by this module
352            Vector < sp<IOProfile> > mInputProfiles;  // input profiles exposed by this module
353            DeviceVector             mDeclaredDevices; // devices declared in audio_policy.conf
354
355        };
356
357        // default volume curve
358        static const VolumeCurvePoint sDefaultVolumeCurve[AudioPolicyManager::VOLCNT];
359        // default volume curve for media strategy
360        static const VolumeCurvePoint sDefaultMediaVolumeCurve[AudioPolicyManager::VOLCNT];
361        // volume curve for media strategy on speakers
362        static const VolumeCurvePoint sSpeakerMediaVolumeCurve[AudioPolicyManager::VOLCNT];
363        // volume curve for sonification strategy on speakers
364        static const VolumeCurvePoint sSpeakerSonificationVolumeCurve[AudioPolicyManager::VOLCNT];
365        static const VolumeCurvePoint sSpeakerSonificationVolumeCurveDrc[AudioPolicyManager::VOLCNT];
366        static const VolumeCurvePoint sDefaultSystemVolumeCurve[AudioPolicyManager::VOLCNT];
367        static const VolumeCurvePoint sDefaultSystemVolumeCurveDrc[AudioPolicyManager::VOLCNT];
368        static const VolumeCurvePoint sHeadsetSystemVolumeCurve[AudioPolicyManager::VOLCNT];
369        static const VolumeCurvePoint sDefaultVoiceVolumeCurve[AudioPolicyManager::VOLCNT];
370        static const VolumeCurvePoint sSpeakerVoiceVolumeCurve[AudioPolicyManager::VOLCNT];
371        // default volume curves per stream and device category. See initializeVolumeCurves()
372        static const VolumeCurvePoint *sVolumeProfiles[AUDIO_STREAM_CNT][DEVICE_CATEGORY_CNT];
373
374        // descriptor for audio outputs. Used to maintain current configuration of each opened audio output
375        // and keep track of the usage of this output by each audio stream type.
376        class AudioOutputDescriptor
377        {
378        public:
379            AudioOutputDescriptor(const sp<IOProfile>& profile);
380
381            status_t    dump(int fd);
382
383            audio_devices_t device() const;
384            void changeRefCount(audio_stream_type_t stream, int delta);
385
386            bool isDuplicated() const { return (mOutput1 != NULL && mOutput2 != NULL); }
387            audio_devices_t supportedDevices();
388            uint32_t latency();
389            bool sharesHwModuleWith(const AudioOutputDescriptor *outputDesc);
390            bool isActive(uint32_t inPastMs = 0) const;
391            bool isStreamActive(audio_stream_type_t stream,
392                                uint32_t inPastMs = 0,
393                                nsecs_t sysTime = 0) const;
394            bool isStrategyActive(routing_strategy strategy,
395                             uint32_t inPastMs = 0,
396                             nsecs_t sysTime = 0) const;
397
398            void toAudioPortConfig(struct audio_port_config *dstConfig,
399                                   const struct audio_port_config *srcConfig = NULL) const;
400            void toAudioPort(struct audio_port *port) const;
401
402            audio_port_handle_t mId;
403            audio_io_handle_t mIoHandle;              // output handle
404            uint32_t mSamplingRate;             //
405            audio_format_t mFormat;             //
406            audio_channel_mask_t mChannelMask;     // output configuration
407            uint32_t mLatency;                  //
408            audio_output_flags_t mFlags;   //
409            audio_devices_t mDevice;                   // current device this output is routed to
410            audio_patch_handle_t mPatchHandle;
411            uint32_t mRefCount[AUDIO_STREAM_CNT]; // number of streams of each type using this output
412            nsecs_t mStopTime[AUDIO_STREAM_CNT];
413            AudioOutputDescriptor *mOutput1;    // used by duplicated outputs: first output
414            AudioOutputDescriptor *mOutput2;    // used by duplicated outputs: second output
415            float mCurVolume[AUDIO_STREAM_CNT];   // current stream volume
416            int mMuteCount[AUDIO_STREAM_CNT];     // mute request counter
417            const sp<IOProfile> mProfile;          // I/O profile this output derives from
418            bool mStrategyMutedByDevice[NUM_STRATEGIES]; // strategies muted because of incompatible
419                                                // device selection. See checkDeviceMuteStrategies()
420            uint32_t mDirectOpenCount; // number of clients using this output (direct outputs only)
421        };
422
423        // descriptor for audio inputs. Used to maintain current configuration of each opened audio input
424        // and keep track of the usage of this input.
425        class AudioInputDescriptor
426        {
427        public:
428            AudioInputDescriptor(const sp<IOProfile>& profile);
429
430            status_t    dump(int fd);
431
432            audio_port_handle_t mId;
433            audio_io_handle_t mIoHandle;              // input handle
434            uint32_t mSamplingRate;                     //
435            audio_format_t mFormat;                     // input configuration
436            audio_channel_mask_t mChannelMask;             //
437            audio_devices_t mDevice;                    // current device this input is routed to
438            audio_patch_handle_t mPatchHandle;
439            uint32_t mRefCount;                         // number of AudioRecord clients using this output
440            audio_source_t mInputSource;                // input source selected by application (mediarecorder.h)
441            const sp<IOProfile> mProfile;                  // I/O profile this output derives from
442
443            void toAudioPortConfig(struct audio_port_config *dstConfig,
444                                   const struct audio_port_config *srcConfig = NULL) const;
445            void toAudioPort(struct audio_port *port) const;
446        };
447
448        // stream descriptor used for volume control
449        class StreamDescriptor
450        {
451        public:
452            StreamDescriptor();
453
454            int getVolumeIndex(audio_devices_t device);
455            void dump(int fd);
456
457            int mIndexMin;      // min volume index
458            int mIndexMax;      // max volume index
459            KeyedVector<audio_devices_t, int> mIndexCur;   // current volume index per device
460            bool mCanBeMuted;   // true is the stream can be muted
461
462            const VolumeCurvePoint *mVolumeCurve[DEVICE_CATEGORY_CNT];
463        };
464
465        // stream descriptor used for volume control
466        class EffectDescriptor
467        {
468        public:
469
470            status_t dump(int fd);
471
472            int mIo;                // io the effect is attached to
473            routing_strategy mStrategy; // routing strategy the effect is associated to
474            int mSession;               // audio session the effect is on
475            effect_descriptor_t mDesc;  // effect descriptor
476            bool mEnabled;              // enabled state: CPU load being used or not
477        };
478
479        void addOutput(audio_io_handle_t output, AudioOutputDescriptor *outputDesc);
480        void addInput(audio_io_handle_t input, AudioInputDescriptor *inputDesc);
481
482        // return the strategy corresponding to a given stream type
483        static routing_strategy getStrategy(audio_stream_type_t stream);
484
485        // return appropriate device for streams handled by the specified strategy according to current
486        // phone state, connected devices...
487        // if fromCache is true, the device is returned from mDeviceForStrategy[],
488        // otherwise it is determine by current state
489        // (device connected,phone state, force use, a2dp output...)
490        // This allows to:
491        //  1 speed up process when the state is stable (when starting or stopping an output)
492        //  2 access to either current device selection (fromCache == true) or
493        // "future" device selection (fromCache == false) when called from a context
494        //  where conditions are changing (setDeviceConnectionState(), setPhoneState()...) AND
495        //  before updateDevicesAndOutputs() is called.
496        virtual audio_devices_t getDeviceForStrategy(routing_strategy strategy,
497                                                     bool fromCache);
498
499        // change the route of the specified output. Returns the number of ms we have slept to
500        // allow new routing to take effect in certain cases.
501        uint32_t setOutputDevice(audio_io_handle_t output,
502                             audio_devices_t device,
503                             bool force = false,
504                             int delayMs = 0,
505                             audio_patch_handle_t *patchHandle = NULL);
506        status_t resetOutputDevice(audio_io_handle_t output,
507                                   int delayMs = 0,
508                                   audio_patch_handle_t *patchHandle = NULL);
509        status_t setInputDevice(audio_io_handle_t input,
510                                audio_devices_t device,
511                                bool force = false,
512                                audio_patch_handle_t *patchHandle = NULL);
513        status_t resetInputDevice(audio_io_handle_t input,
514                                  audio_patch_handle_t *patchHandle = NULL);
515
516        // select input device corresponding to requested audio source
517        virtual audio_devices_t getDeviceForInputSource(audio_source_t inputSource);
518
519        // return io handle of active input or 0 if no input is active
520        //    Only considers inputs from physical devices (e.g. main mic, headset mic) when
521        //    ignoreVirtualInputs is true.
522        audio_io_handle_t getActiveInput(bool ignoreVirtualInputs = true);
523
524        // initialize volume curves for each strategy and device category
525        void initializeVolumeCurves();
526
527        // compute the actual volume for a given stream according to the requested index and a particular
528        // device
529        virtual float computeVolume(audio_stream_type_t stream, int index,
530                                    audio_io_handle_t output, audio_devices_t device);
531
532        // check that volume change is permitted, compute and send new volume to audio hardware
533        status_t checkAndSetVolume(audio_stream_type_t stream, int index, audio_io_handle_t output,
534                                   audio_devices_t device, int delayMs = 0, bool force = false);
535
536        // apply all stream volumes to the specified output and device
537        void applyStreamVolumes(audio_io_handle_t output, audio_devices_t device, int delayMs = 0, bool force = false);
538
539        // Mute or unmute all streams handled by the specified strategy on the specified output
540        void setStrategyMute(routing_strategy strategy,
541                             bool on,
542                             audio_io_handle_t output,
543                             int delayMs = 0,
544                             audio_devices_t device = (audio_devices_t)0);
545
546        // Mute or unmute the stream on the specified output
547        void setStreamMute(audio_stream_type_t stream,
548                           bool on,
549                           audio_io_handle_t output,
550                           int delayMs = 0,
551                           audio_devices_t device = (audio_devices_t)0);
552
553        // handle special cases for sonification strategy while in call: mute streams or replace by
554        // a special tone in the device used for communication
555        void handleIncallSonification(audio_stream_type_t stream, bool starting, bool stateChange);
556
557        // true if device is in a telephony or VoIP call
558        virtual bool isInCall();
559
560        // true if given state represents a device in a telephony or VoIP call
561        virtual bool isStateInCall(int state);
562
563        // when a device is connected, checks if an open output can be routed
564        // to this device. If none is open, tries to open one of the available outputs.
565        // Returns an output suitable to this device or 0.
566        // when a device is disconnected, checks if an output is not used any more and
567        // returns its handle if any.
568        // transfers the audio tracks and effects from one output thread to another accordingly.
569        status_t checkOutputsForDevice(audio_devices_t device,
570                                       audio_policy_dev_state_t state,
571                                       SortedVector<audio_io_handle_t>& outputs,
572                                       const String8 address);
573
574        status_t checkInputsForDevice(audio_devices_t device,
575                                      audio_policy_dev_state_t state,
576                                      SortedVector<audio_io_handle_t>& inputs,
577                                      const String8 address);
578
579        // close an output and its companion duplicating output.
580        void closeOutput(audio_io_handle_t output);
581
582        // checks and if necessary changes outputs used for all strategies.
583        // must be called every time a condition that affects the output choice for a given strategy
584        // changes: connected device, phone state, force use...
585        // Must be called before updateDevicesAndOutputs()
586        void checkOutputForStrategy(routing_strategy strategy);
587
588        // Same as checkOutputForStrategy() but for a all strategies in order of priority
589        void checkOutputForAllStrategies();
590
591        // manages A2DP output suspend/restore according to phone state and BT SCO usage
592        void checkA2dpSuspend();
593
594        // returns the A2DP output handle if it is open or 0 otherwise
595        audio_io_handle_t getA2dpOutput();
596
597        // selects the most appropriate device on output for current state
598        // must be called every time a condition that affects the device choice for a given output is
599        // changed: connected device, phone state, force use, output start, output stop..
600        // see getDeviceForStrategy() for the use of fromCache parameter
601        audio_devices_t getNewOutputDevice(audio_io_handle_t output, bool fromCache);
602
603        // updates cache of device used by all strategies (mDeviceForStrategy[])
604        // must be called every time a condition that affects the device choice for a given strategy is
605        // changed: connected device, phone state, force use...
606        // cached values are used by getDeviceForStrategy() if parameter fromCache is true.
607         // Must be called after checkOutputForAllStrategies()
608        void updateDevicesAndOutputs();
609
610        // selects the most appropriate device on input for current state
611        audio_devices_t getNewInputDevice(audio_io_handle_t input);
612
613        virtual uint32_t getMaxEffectsCpuLoad();
614        virtual uint32_t getMaxEffectsMemory();
615#ifdef AUDIO_POLICY_TEST
616        virtual     bool        threadLoop();
617                    void        exit();
618        int testOutputIndex(audio_io_handle_t output);
619#endif //AUDIO_POLICY_TEST
620
621        status_t setEffectEnabled(EffectDescriptor *pDesc, bool enabled);
622
623        // returns the category the device belongs to with regard to volume curve management
624        static device_category getDeviceCategory(audio_devices_t device);
625
626        // extract one device relevant for volume control from multiple device selection
627        static audio_devices_t getDeviceForVolume(audio_devices_t device);
628
629        SortedVector<audio_io_handle_t> getOutputsForDevice(audio_devices_t device,
630                        DefaultKeyedVector<audio_io_handle_t, AudioOutputDescriptor *> openOutputs);
631        bool vectorsEqual(SortedVector<audio_io_handle_t>& outputs1,
632                                           SortedVector<audio_io_handle_t>& outputs2);
633
634        // mute/unmute strategies using an incompatible device combination
635        // if muting, wait for the audio in pcm buffer to be drained before proceeding
636        // if unmuting, unmute only after the specified delay
637        // Returns the number of ms waited
638        uint32_t  checkDeviceMuteStrategies(AudioOutputDescriptor *outputDesc,
639                                            audio_devices_t prevDevice,
640                                            uint32_t delayMs);
641
642        audio_io_handle_t selectOutput(const SortedVector<audio_io_handle_t>& outputs,
643                                       audio_output_flags_t flags);
644        sp<IOProfile> getInputProfile(audio_devices_t device,
645                                   uint32_t samplingRate,
646                                   audio_format_t format,
647                                   audio_channel_mask_t channelMask);
648        sp<IOProfile> getProfileForDirectOutput(audio_devices_t device,
649                                                       uint32_t samplingRate,
650                                                       audio_format_t format,
651                                                       audio_channel_mask_t channelMask,
652                                                       audio_output_flags_t flags);
653
654        audio_io_handle_t selectOutputForEffects(const SortedVector<audio_io_handle_t>& outputs);
655
656        bool isNonOffloadableEffectEnabled();
657
658        status_t addAudioPatch(audio_patch_handle_t handle,
659                               const sp<AudioPatch>& patch);
660        status_t removeAudioPatch(audio_patch_handle_t handle);
661
662        AudioOutputDescriptor *getOutputFromId(audio_port_handle_t id) const;
663        AudioInputDescriptor *getInputFromId(audio_port_handle_t id) const;
664        HwModule *getModuleForDevice(audio_devices_t device) const;
665        HwModule *getModuleFromName(const char *name) const;
666        //
667        // Audio policy configuration file parsing (audio_policy.conf)
668        //
669        static uint32_t stringToEnum(const struct StringToEnum *table,
670                                     size_t size,
671                                     const char *name);
672        static const char *enumToString(const struct StringToEnum *table,
673                                      size_t size,
674                                      uint32_t value);
675        static bool stringToBool(const char *value);
676        static audio_output_flags_t parseFlagNames(char *name);
677        static audio_devices_t parseDeviceNames(char *name);
678        void loadHwModule(cnode *root);
679        void loadHwModules(cnode *root);
680        void loadGlobalConfig(cnode *root, HwModule *module);
681        status_t loadAudioPolicyConfig(const char *path);
682        void defaultAudioPolicyConfig(void);
683
684
685        uid_t mUidCached;
686        AudioPolicyClientInterface *mpClientInterface;  // audio policy client interface
687        audio_io_handle_t mPrimaryOutput;              // primary output handle
688        // list of descriptors for outputs currently opened
689        DefaultKeyedVector<audio_io_handle_t, AudioOutputDescriptor *> mOutputs;
690        // copy of mOutputs before setDeviceConnectionState() opens new outputs
691        // reset to mOutputs when updateDevicesAndOutputs() is called.
692        DefaultKeyedVector<audio_io_handle_t, AudioOutputDescriptor *> mPreviousOutputs;
693        DefaultKeyedVector<audio_io_handle_t, AudioInputDescriptor *> mInputs;     // list of input descriptors
694        DeviceVector  mAvailableOutputDevices; // all available output devices
695        DeviceVector  mAvailableInputDevices;  // all available input devices
696        int mPhoneState;                                                    // current phone state
697        audio_policy_forced_cfg_t mForceUse[AUDIO_POLICY_FORCE_USE_CNT];   // current forced use configuration
698
699        StreamDescriptor mStreams[AUDIO_STREAM_CNT];           // stream descriptors for volume control
700        bool    mLimitRingtoneVolume;                                       // limit ringtone volume to music volume if headset connected
701        audio_devices_t mDeviceForStrategy[NUM_STRATEGIES];
702        float   mLastVoiceVolume;                                           // last voice volume value sent to audio HAL
703
704        // Maximum CPU load allocated to audio effects in 0.1 MIPS (ARMv5TE, 0 WS memory) units
705        static const uint32_t MAX_EFFECTS_CPU_LOAD = 1000;
706        // Maximum memory allocated to audio effects in KB
707        static const uint32_t MAX_EFFECTS_MEMORY = 512;
708        uint32_t mTotalEffectsCpuLoad; // current CPU load used by effects
709        uint32_t mTotalEffectsMemory;  // current memory used by effects
710        KeyedVector<int, EffectDescriptor *> mEffects;  // list of registered audio effects
711        bool    mA2dpSuspended;  // true if A2DP output is suspended
712        sp<DeviceDescriptor> mDefaultOutputDevice; // output device selected by default at boot time
713        bool mSpeakerDrcEnabled;// true on devices that use DRC on the DEVICE_CATEGORY_SPEAKER path
714                                // to boost soft sounds, used to adjust volume curves accordingly
715
716        Vector <HwModule *> mHwModules;
717        volatile int32_t mNextUniqueId;
718        volatile int32_t mAudioPortGeneration;
719
720        DefaultKeyedVector<audio_patch_handle_t, sp<AudioPatch> > mAudioPatches;
721
722#ifdef AUDIO_POLICY_TEST
723        Mutex   mLock;
724        Condition mWaitWorkCV;
725
726        int             mCurOutput;
727        bool            mDirectOutput;
728        audio_io_handle_t mTestOutputs[NUM_TEST_OUTPUTS];
729        int             mTestInput;
730        uint32_t        mTestDevice;
731        uint32_t        mTestSamplingRate;
732        uint32_t        mTestFormat;
733        uint32_t        mTestChannels;
734        uint32_t        mTestLatencyMs;
735#endif //AUDIO_POLICY_TEST
736
737private:
738        static float volIndexToAmpl(audio_devices_t device, const StreamDescriptor& streamDesc,
739                int indexInUi);
740        // updates device caching and output for streams that can influence the
741        //    routing of notifications
742        void handleNotificationRoutingForStream(audio_stream_type_t stream);
743        static bool isVirtualInputDevice(audio_devices_t device);
744        uint32_t nextUniqueId();
745        uint32_t nextAudioPortGeneration();
746        uint32_t curAudioPortGeneration() const { return mAudioPortGeneration; }
747        // converts device address to string sent to audio HAL via setParameters
748        static String8 addressToParameter(audio_devices_t device, const String8 address);
749};
750
751};
752