AudioPolicyManager.h revision 4d41695d45e2c7211899afa94b20e32120b2b7e0
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            status_t dump(int fd, int spaces, int index) const;
313
314            audio_patch_handle_t mHandle;
315            struct audio_patch mPatch;
316            uid_t mUid;
317            audio_patch_handle_t mAfPatchHandle;
318        };
319
320        class DeviceDescriptor: public AudioPort, public AudioPortConfig
321        {
322        public:
323            DeviceDescriptor(const String8& name, audio_devices_t type);
324
325            virtual ~DeviceDescriptor() {}
326
327            bool equals(const sp<DeviceDescriptor>& other) const;
328            virtual void toAudioPortConfig(struct audio_port_config *dstConfig,
329                                   const struct audio_port_config *srcConfig = NULL) const;
330
331            virtual void toAudioPort(struct audio_port *port) const;
332
333            status_t dump(int fd, int spaces, int index) const;
334
335            audio_devices_t mDeviceType;
336            String8 mAddress;
337            audio_port_handle_t mId;
338        };
339
340        class DeviceVector : public SortedVector< sp<DeviceDescriptor> >
341        {
342        public:
343            DeviceVector() : SortedVector(), mDeviceTypes(AUDIO_DEVICE_NONE) {}
344
345            ssize_t         add(const sp<DeviceDescriptor>& item);
346            ssize_t         remove(const sp<DeviceDescriptor>& item);
347            ssize_t         indexOf(const sp<DeviceDescriptor>& item) const;
348
349            audio_devices_t types() const { return mDeviceTypes; }
350
351            void loadDevicesFromType(audio_devices_t types);
352            void loadDevicesFromName(char *name, const DeviceVector& declaredDevices);
353
354            sp<DeviceDescriptor> getDevice(audio_devices_t type, String8 address) const;
355            DeviceVector getDevicesFromType(audio_devices_t types) const;
356            sp<DeviceDescriptor> getDeviceFromId(audio_port_handle_t id) const;
357            sp<DeviceDescriptor> getDeviceFromName(const String8& name) const;
358            DeviceVector getDevicesFromTypeAddr(audio_devices_t type, String8 address)
359                    const;
360
361        private:
362            void refreshTypes();
363            audio_devices_t mDeviceTypes;
364        };
365
366        // the IOProfile class describes the capabilities of an output or input stream.
367        // It is currently assumed that all combination of listed parameters are supported.
368        // It is used by the policy manager to determine if an output or input is suitable for
369        // a given use case,  open/close it accordingly and connect/disconnect audio tracks
370        // to/from it.
371        class IOProfile : public AudioPort
372        {
373        public:
374            IOProfile(const String8& name, audio_port_role_t role, const sp<HwModule>& module);
375            virtual ~IOProfile();
376
377            // This method is used for both output and input.
378            // If parameter updatedSamplingRate is non-NULL, it is assigned the actual sample rate.
379            // For input, flags is interpreted as audio_input_flags_t.
380            // TODO: merge audio_output_flags_t and audio_input_flags_t.
381            bool isCompatibleProfile(audio_devices_t device,
382                                     uint32_t samplingRate,
383                                     uint32_t *updatedSamplingRate,
384                                     audio_format_t format,
385                                     audio_channel_mask_t channelMask,
386                                     audio_output_flags_t flags) const;
387
388            void dump(int fd);
389            void log();
390
391            DeviceVector  mSupportedDevices; // supported devices
392                                             // (devices this output can be routed to)
393        };
394
395        class HwModule : public RefBase
396        {
397        public:
398                    HwModule(const char *name);
399                    ~HwModule();
400
401            status_t loadOutput(cnode *root);
402            status_t loadInput(cnode *root);
403            status_t loadDevice(cnode *root);
404
405            void dump(int fd);
406
407            const char *const        mName; // base name of the audio HW module (primary, a2dp ...)
408            uint32_t                 mHalVersion; // audio HAL API version
409            audio_module_handle_t    mHandle;
410            Vector < sp<IOProfile> > mOutputProfiles; // output profiles exposed by this module
411            Vector < sp<IOProfile> > mInputProfiles;  // input profiles exposed by this module
412            DeviceVector             mDeclaredDevices; // devices declared in audio_policy.conf
413
414        };
415
416        // default volume curve
417        static const VolumeCurvePoint sDefaultVolumeCurve[AudioPolicyManager::VOLCNT];
418        // default volume curve for media strategy
419        static const VolumeCurvePoint sDefaultMediaVolumeCurve[AudioPolicyManager::VOLCNT];
420        // volume curve for non-media audio on ext media outputs (HDMI, Line, etc)
421        static const VolumeCurvePoint sExtMediaSystemVolumeCurve[AudioPolicyManager::VOLCNT];
422        // volume curve for media strategy on speakers
423        static const VolumeCurvePoint sSpeakerMediaVolumeCurve[AudioPolicyManager::VOLCNT];
424        static const VolumeCurvePoint sSpeakerMediaVolumeCurveDrc[AudioPolicyManager::VOLCNT];
425        // volume curve for sonification strategy on speakers
426        static const VolumeCurvePoint sSpeakerSonificationVolumeCurve[AudioPolicyManager::VOLCNT];
427        static const VolumeCurvePoint sSpeakerSonificationVolumeCurveDrc[AudioPolicyManager::VOLCNT];
428        static const VolumeCurvePoint sDefaultSystemVolumeCurve[AudioPolicyManager::VOLCNT];
429        static const VolumeCurvePoint sDefaultSystemVolumeCurveDrc[AudioPolicyManager::VOLCNT];
430        static const VolumeCurvePoint sHeadsetSystemVolumeCurve[AudioPolicyManager::VOLCNT];
431        static const VolumeCurvePoint sDefaultVoiceVolumeCurve[AudioPolicyManager::VOLCNT];
432        static const VolumeCurvePoint sSpeakerVoiceVolumeCurve[AudioPolicyManager::VOLCNT];
433        // default volume curves per stream and device category. See initializeVolumeCurves()
434        static const VolumeCurvePoint *sVolumeProfiles[AUDIO_STREAM_CNT][DEVICE_CATEGORY_CNT];
435
436        // descriptor for audio outputs. Used to maintain current configuration of each opened audio output
437        // and keep track of the usage of this output by each audio stream type.
438        class AudioOutputDescriptor: public AudioPortConfig
439        {
440        public:
441            AudioOutputDescriptor(const sp<IOProfile>& profile);
442
443            status_t    dump(int fd);
444
445            audio_devices_t device() const;
446            void changeRefCount(audio_stream_type_t stream, int delta);
447
448            bool isDuplicated() const { return (mOutput1 != NULL && mOutput2 != NULL); }
449            audio_devices_t supportedDevices();
450            uint32_t latency();
451            bool sharesHwModuleWith(const sp<AudioOutputDescriptor> outputDesc);
452            bool isActive(uint32_t inPastMs = 0) const;
453            bool isStreamActive(audio_stream_type_t stream,
454                                uint32_t inPastMs = 0,
455                                nsecs_t sysTime = 0) const;
456            bool isStrategyActive(routing_strategy strategy,
457                             uint32_t inPastMs = 0,
458                             nsecs_t sysTime = 0) const;
459
460            virtual void toAudioPortConfig(struct audio_port_config *dstConfig,
461                                   const struct audio_port_config *srcConfig = NULL) const;
462            void toAudioPort(struct audio_port *port) const;
463
464            audio_port_handle_t mId;
465            audio_io_handle_t mIoHandle;              // output handle
466            uint32_t mLatency;                  //
467            audio_output_flags_t mFlags;   //
468            audio_devices_t mDevice;                   // current device this output is routed to
469            audio_patch_handle_t mPatchHandle;
470            uint32_t mRefCount[AUDIO_STREAM_CNT]; // number of streams of each type using this output
471            nsecs_t mStopTime[AUDIO_STREAM_CNT];
472            sp<AudioOutputDescriptor> mOutput1;    // used by duplicated outputs: first output
473            sp<AudioOutputDescriptor> mOutput2;    // used by duplicated outputs: second output
474            float mCurVolume[AUDIO_STREAM_CNT];   // current stream volume
475            int mMuteCount[AUDIO_STREAM_CNT];     // mute request counter
476            const sp<IOProfile> mProfile;          // I/O profile this output derives from
477            bool mStrategyMutedByDevice[NUM_STRATEGIES]; // strategies muted because of incompatible
478                                                // device selection. See checkDeviceMuteStrategies()
479            uint32_t mDirectOpenCount; // number of clients using this output (direct outputs only)
480        };
481
482        // descriptor for audio inputs. Used to maintain current configuration of each opened audio input
483        // and keep track of the usage of this input.
484        class AudioInputDescriptor: public AudioPortConfig
485        {
486        public:
487            AudioInputDescriptor(const sp<IOProfile>& profile);
488
489            status_t    dump(int fd);
490
491            audio_port_handle_t           mId;
492            audio_io_handle_t             mIoHandle;       // input handle
493            audio_devices_t               mDevice;         // current device this input is routed to
494            audio_patch_handle_t          mPatchHandle;
495            uint32_t                      mRefCount;       // number of AudioRecord clients using
496                                                           // this input
497            uint32_t                      mOpenRefCount;
498            audio_source_t                mInputSource;    // input source selected by application
499                                                           //(mediarecorder.h)
500            const sp<IOProfile>           mProfile;        // I/O profile this output derives from
501            SortedVector<audio_session_t> mSessions;       // audio sessions attached to this input
502            bool                          mIsSoundTrigger; // used by a soundtrigger capture
503
504            virtual void toAudioPortConfig(struct audio_port_config *dstConfig,
505                                   const struct audio_port_config *srcConfig = NULL) const;
506            void toAudioPort(struct audio_port *port) const;
507        };
508
509        // stream descriptor used for volume control
510        class StreamDescriptor
511        {
512        public:
513            StreamDescriptor();
514
515            int getVolumeIndex(audio_devices_t device);
516            void dump(int fd);
517
518            int mIndexMin;      // min volume index
519            int mIndexMax;      // max volume index
520            KeyedVector<audio_devices_t, int> mIndexCur;   // current volume index per device
521            bool mCanBeMuted;   // true is the stream can be muted
522
523            const VolumeCurvePoint *mVolumeCurve[DEVICE_CATEGORY_CNT];
524        };
525
526        // stream descriptor used for volume control
527        class EffectDescriptor : public RefBase
528        {
529        public:
530
531            status_t dump(int fd);
532
533            int mIo;                // io the effect is attached to
534            routing_strategy mStrategy; // routing strategy the effect is associated to
535            int mSession;               // audio session the effect is on
536            effect_descriptor_t mDesc;  // effect descriptor
537            bool mEnabled;              // enabled state: CPU load being used or not
538        };
539
540        void addOutput(audio_io_handle_t output, sp<AudioOutputDescriptor> outputDesc);
541        void addInput(audio_io_handle_t input, sp<AudioInputDescriptor> inputDesc);
542
543        // return the strategy corresponding to a given stream type
544        static routing_strategy getStrategy(audio_stream_type_t stream);
545
546        // return appropriate device for streams handled by the specified strategy according to current
547        // phone state, connected devices...
548        // if fromCache is true, the device is returned from mDeviceForStrategy[],
549        // otherwise it is determine by current state
550        // (device connected,phone state, force use, a2dp output...)
551        // This allows to:
552        //  1 speed up process when the state is stable (when starting or stopping an output)
553        //  2 access to either current device selection (fromCache == true) or
554        // "future" device selection (fromCache == false) when called from a context
555        //  where conditions are changing (setDeviceConnectionState(), setPhoneState()...) AND
556        //  before updateDevicesAndOutputs() is called.
557        virtual audio_devices_t getDeviceForStrategy(routing_strategy strategy,
558                                                     bool fromCache);
559
560        // change the route of the specified output. Returns the number of ms we have slept to
561        // allow new routing to take effect in certain cases.
562        uint32_t setOutputDevice(audio_io_handle_t output,
563                             audio_devices_t device,
564                             bool force = false,
565                             int delayMs = 0,
566                             audio_patch_handle_t *patchHandle = NULL,
567                             const char* address = NULL);
568        status_t resetOutputDevice(audio_io_handle_t output,
569                                   int delayMs = 0,
570                                   audio_patch_handle_t *patchHandle = NULL);
571        status_t setInputDevice(audio_io_handle_t input,
572                                audio_devices_t device,
573                                bool force = false,
574                                audio_patch_handle_t *patchHandle = NULL);
575        status_t resetInputDevice(audio_io_handle_t input,
576                                  audio_patch_handle_t *patchHandle = NULL);
577
578        // select input device corresponding to requested audio source
579        virtual audio_devices_t getDeviceForInputSource(audio_source_t inputSource);
580
581        // return io handle of active input or 0 if no input is active
582        //    Only considers inputs from physical devices (e.g. main mic, headset mic) when
583        //    ignoreVirtualInputs is true.
584        audio_io_handle_t getActiveInput(bool ignoreVirtualInputs = true);
585
586        uint32_t activeInputsCount() const;
587
588        // initialize volume curves for each strategy and device category
589        void initializeVolumeCurves();
590
591        // compute the actual volume for a given stream according to the requested index and a particular
592        // device
593        virtual float computeVolume(audio_stream_type_t stream, int index,
594                                    audio_io_handle_t output, audio_devices_t device);
595
596        // check that volume change is permitted, compute and send new volume to audio hardware
597        status_t checkAndSetVolume(audio_stream_type_t stream, int index, audio_io_handle_t output,
598                                   audio_devices_t device, int delayMs = 0, bool force = false);
599
600        // apply all stream volumes to the specified output and device
601        void applyStreamVolumes(audio_io_handle_t output, audio_devices_t device, int delayMs = 0, bool force = false);
602
603        // Mute or unmute all streams handled by the specified strategy on the specified output
604        void setStrategyMute(routing_strategy strategy,
605                             bool on,
606                             audio_io_handle_t output,
607                             int delayMs = 0,
608                             audio_devices_t device = (audio_devices_t)0);
609
610        // Mute or unmute the stream on the specified output
611        void setStreamMute(audio_stream_type_t stream,
612                           bool on,
613                           audio_io_handle_t output,
614                           int delayMs = 0,
615                           audio_devices_t device = (audio_devices_t)0);
616
617        // handle special cases for sonification strategy while in call: mute streams or replace by
618        // a special tone in the device used for communication
619        void handleIncallSonification(audio_stream_type_t stream, bool starting, bool stateChange);
620
621        // true if device is in a telephony or VoIP call
622        virtual bool isInCall();
623
624        // true if given state represents a device in a telephony or VoIP call
625        virtual bool isStateInCall(int state);
626
627        // when a device is connected, checks if an open output can be routed
628        // to this device. If none is open, tries to open one of the available outputs.
629        // Returns an output suitable to this device or 0.
630        // when a device is disconnected, checks if an output is not used any more and
631        // returns its handle if any.
632        // transfers the audio tracks and effects from one output thread to another accordingly.
633        status_t checkOutputsForDevice(audio_devices_t device,
634                                       audio_policy_dev_state_t state,
635                                       SortedVector<audio_io_handle_t>& outputs,
636                                       const String8 address);
637
638        status_t checkInputsForDevice(audio_devices_t device,
639                                      audio_policy_dev_state_t state,
640                                      SortedVector<audio_io_handle_t>& inputs,
641                                      const String8 address);
642
643        // close an output and its companion duplicating output.
644        void closeOutput(audio_io_handle_t output);
645
646        // checks and if necessary changes outputs used for all strategies.
647        // must be called every time a condition that affects the output choice for a given strategy
648        // changes: connected device, phone state, force use...
649        // Must be called before updateDevicesAndOutputs()
650        void checkOutputForStrategy(routing_strategy strategy);
651
652        // Same as checkOutputForStrategy() but for a all strategies in order of priority
653        void checkOutputForAllStrategies();
654
655        // manages A2DP output suspend/restore according to phone state and BT SCO usage
656        void checkA2dpSuspend();
657
658        // returns the A2DP output handle if it is open or 0 otherwise
659        audio_io_handle_t getA2dpOutput();
660
661        // selects the most appropriate device on output for current state
662        // must be called every time a condition that affects the device choice for a given output is
663        // changed: connected device, phone state, force use, output start, output stop..
664        // see getDeviceForStrategy() for the use of fromCache parameter
665        audio_devices_t getNewOutputDevice(audio_io_handle_t output, bool fromCache);
666
667        // updates cache of device used by all strategies (mDeviceForStrategy[])
668        // must be called every time a condition that affects the device choice for a given strategy is
669        // changed: connected device, phone state, force use...
670        // cached values are used by getDeviceForStrategy() if parameter fromCache is true.
671         // Must be called after checkOutputForAllStrategies()
672        void updateDevicesAndOutputs();
673
674        // selects the most appropriate device on input for current state
675        audio_devices_t getNewInputDevice(audio_io_handle_t input);
676
677        virtual uint32_t getMaxEffectsCpuLoad();
678        virtual uint32_t getMaxEffectsMemory();
679#ifdef AUDIO_POLICY_TEST
680        virtual     bool        threadLoop();
681                    void        exit();
682        int testOutputIndex(audio_io_handle_t output);
683#endif //AUDIO_POLICY_TEST
684
685        status_t setEffectEnabled(const sp<EffectDescriptor>& effectDesc, bool enabled);
686
687        // returns the category the device belongs to with regard to volume curve management
688        static device_category getDeviceCategory(audio_devices_t device);
689
690        // extract one device relevant for volume control from multiple device selection
691        static audio_devices_t getDeviceForVolume(audio_devices_t device);
692
693        SortedVector<audio_io_handle_t> getOutputsForDevice(audio_devices_t device,
694                        DefaultKeyedVector<audio_io_handle_t, sp<AudioOutputDescriptor> > openOutputs);
695        bool vectorsEqual(SortedVector<audio_io_handle_t>& outputs1,
696                                           SortedVector<audio_io_handle_t>& outputs2);
697
698        // mute/unmute strategies using an incompatible device combination
699        // if muting, wait for the audio in pcm buffer to be drained before proceeding
700        // if unmuting, unmute only after the specified delay
701        // Returns the number of ms waited
702        uint32_t  checkDeviceMuteStrategies(sp<AudioOutputDescriptor> outputDesc,
703                                            audio_devices_t prevDevice,
704                                            uint32_t delayMs);
705
706        audio_io_handle_t selectOutput(const SortedVector<audio_io_handle_t>& outputs,
707                                       audio_output_flags_t flags);
708        // samplingRate parameter is an in/out and so may be modified
709        sp<IOProfile> getInputProfile(audio_devices_t device,
710                                   uint32_t& samplingRate,
711                                   audio_format_t format,
712                                   audio_channel_mask_t channelMask,
713                                   audio_input_flags_t flags);
714        sp<IOProfile> getProfileForDirectOutput(audio_devices_t device,
715                                                       uint32_t samplingRate,
716                                                       audio_format_t format,
717                                                       audio_channel_mask_t channelMask,
718                                                       audio_output_flags_t flags);
719
720        audio_io_handle_t selectOutputForEffects(const SortedVector<audio_io_handle_t>& outputs);
721
722        bool isNonOffloadableEffectEnabled();
723
724        status_t addAudioPatch(audio_patch_handle_t handle,
725                               const sp<AudioPatch>& patch);
726        status_t removeAudioPatch(audio_patch_handle_t handle);
727
728        sp<AudioOutputDescriptor> getOutputFromId(audio_port_handle_t id) const;
729        sp<AudioInputDescriptor> getInputFromId(audio_port_handle_t id) const;
730        sp<HwModule> getModuleForDevice(audio_devices_t device) const;
731        sp<HwModule> getModuleFromName(const char *name) const;
732        audio_devices_t availablePrimaryOutputDevices();
733        audio_devices_t availablePrimaryInputDevices();
734
735        void updateCallRouting(audio_devices_t rxDevice, int delayMs = 0);
736
737        //
738        // Audio policy configuration file parsing (audio_policy.conf)
739        //
740        static uint32_t stringToEnum(const struct StringToEnum *table,
741                                     size_t size,
742                                     const char *name);
743        static const char *enumToString(const struct StringToEnum *table,
744                                      size_t size,
745                                      uint32_t value);
746        static bool stringToBool(const char *value);
747        static audio_output_flags_t parseFlagNames(char *name);
748        static audio_devices_t parseDeviceNames(char *name);
749        void loadHwModule(cnode *root);
750        void loadHwModules(cnode *root);
751        void loadGlobalConfig(cnode *root, const sp<HwModule>& module);
752        status_t loadAudioPolicyConfig(const char *path);
753        void defaultAudioPolicyConfig(void);
754
755
756        uid_t mUidCached;
757        AudioPolicyClientInterface *mpClientInterface;  // audio policy client interface
758        audio_io_handle_t mPrimaryOutput;              // primary output handle
759        // list of descriptors for outputs currently opened
760        DefaultKeyedVector<audio_io_handle_t, sp<AudioOutputDescriptor> > mOutputs;
761        // copy of mOutputs before setDeviceConnectionState() opens new outputs
762        // reset to mOutputs when updateDevicesAndOutputs() is called.
763        DefaultKeyedVector<audio_io_handle_t, sp<AudioOutputDescriptor> > mPreviousOutputs;
764        DefaultKeyedVector<audio_io_handle_t, sp<AudioInputDescriptor> > mInputs;     // list of input descriptors
765        DeviceVector  mAvailableOutputDevices; // all available output devices
766        DeviceVector  mAvailableInputDevices;  // all available input devices
767        int mPhoneState;                                                    // current phone state
768        audio_policy_forced_cfg_t mForceUse[AUDIO_POLICY_FORCE_USE_CNT];   // current forced use configuration
769
770        StreamDescriptor mStreams[AUDIO_STREAM_CNT];           // stream descriptors for volume control
771        bool    mLimitRingtoneVolume;                                       // limit ringtone volume to music volume if headset connected
772        audio_devices_t mDeviceForStrategy[NUM_STRATEGIES];
773        float   mLastVoiceVolume;                                           // last voice volume value sent to audio HAL
774
775        // Maximum CPU load allocated to audio effects in 0.1 MIPS (ARMv5TE, 0 WS memory) units
776        static const uint32_t MAX_EFFECTS_CPU_LOAD = 1000;
777        // Maximum memory allocated to audio effects in KB
778        static const uint32_t MAX_EFFECTS_MEMORY = 512;
779        uint32_t mTotalEffectsCpuLoad; // current CPU load used by effects
780        uint32_t mTotalEffectsMemory;  // current memory used by effects
781        KeyedVector<int, sp<EffectDescriptor> > mEffects;  // list of registered audio effects
782        bool    mA2dpSuspended;  // true if A2DP output is suspended
783        sp<DeviceDescriptor> mDefaultOutputDevice; // output device selected by default at boot time
784        bool mSpeakerDrcEnabled;// true on devices that use DRC on the DEVICE_CATEGORY_SPEAKER path
785                                // to boost soft sounds, used to adjust volume curves accordingly
786
787        Vector < sp<HwModule> > mHwModules;
788        volatile int32_t mNextUniqueId;
789        volatile int32_t mAudioPortGeneration;
790
791        DefaultKeyedVector<audio_patch_handle_t, sp<AudioPatch> > mAudioPatches;
792
793        DefaultKeyedVector<audio_session_t, audio_io_handle_t> mSoundTriggerSessions;
794
795        sp<AudioPatch> mCallTxPatch;
796        sp<AudioPatch> mCallRxPatch;
797
798#ifdef AUDIO_POLICY_TEST
799        Mutex   mLock;
800        Condition mWaitWorkCV;
801
802        int             mCurOutput;
803        bool            mDirectOutput;
804        audio_io_handle_t mTestOutputs[NUM_TEST_OUTPUTS];
805        int             mTestInput;
806        uint32_t        mTestDevice;
807        uint32_t        mTestSamplingRate;
808        uint32_t        mTestFormat;
809        uint32_t        mTestChannels;
810        uint32_t        mTestLatencyMs;
811#endif //AUDIO_POLICY_TEST
812
813private:
814        static float volIndexToAmpl(audio_devices_t device, const StreamDescriptor& streamDesc,
815                int indexInUi);
816        // updates device caching and output for streams that can influence the
817        //    routing of notifications
818        void handleNotificationRoutingForStream(audio_stream_type_t stream);
819        static bool isVirtualInputDevice(audio_devices_t device);
820        static bool deviceDistinguishesOnAddress(audio_devices_t device);
821        // find the outputs on a given output descriptor that have the given address.
822        // to be called on an AudioOutputDescriptor whose supported devices (as defined
823        //   in mProfile->mSupportedDevices) matches the device whose address is to be matched.
824        // see deviceDistinguishesOnAddress(audio_devices_t) for whether the device type is one
825        //   where addresses are used to distinguish between one connected device and another.
826        void findIoHandlesByAddress(sp<AudioOutputDescriptor> desc /*in*/,
827                const String8 address /*in*/,
828                SortedVector<audio_io_handle_t>& outputs /*out*/);
829        uint32_t nextUniqueId();
830        uint32_t nextAudioPortGeneration();
831        uint32_t curAudioPortGeneration() const { return mAudioPortGeneration; }
832        // internal method to return the output handle for the given device and format
833        audio_io_handle_t getOutputForDevice(
834                audio_devices_t device,
835                audio_stream_type_t stream,
836                uint32_t samplingRate,
837                audio_format_t format,
838                audio_channel_mask_t channelMask,
839                audio_output_flags_t flags,
840                const audio_offload_info_t *offloadInfo);
841        // internal function to derive a stream type value from audio attributes
842        audio_stream_type_t streamTypefromAttributesInt(const audio_attributes_t *attr);
843};
844
845};
846