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