AudioPolicyManager.h revision 7e45ef9db7446d33c941961c14555413641e444b
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(int index, bool useInChannelMask);
199            virtual ~AudioGain() {}
200
201            void dump(int fd, int spaces, int index) const;
202
203            void getDefaultConfig(struct audio_gain_config *config);
204            status_t checkConfig(const struct audio_gain_config *config);
205            int               mIndex;
206            struct audio_gain mGain;
207            bool              mUseInChannelMask;
208        };
209
210        class AudioPort: public virtual RefBase
211        {
212        public:
213            AudioPort(const String8& name, audio_port_type_t type,
214                      audio_port_role_t role, const sp<HwModule>& module);
215            virtual ~AudioPort() {}
216
217            virtual void toAudioPort(struct audio_port *port) const;
218
219            void loadSamplingRates(char *name);
220            void loadFormats(char *name);
221            void loadOutChannels(char *name);
222            void loadInChannels(char *name);
223
224            audio_gain_mode_t loadGainMode(char *name);
225            void loadGain(cnode *root, int index);
226            void loadGains(cnode *root);
227
228            status_t checkSamplingRate(uint32_t samplingRate) const;
229            status_t checkChannelMask(audio_channel_mask_t channelMask) const;
230            status_t checkFormat(audio_format_t format) const;
231            status_t checkGain(const struct audio_gain_config *gainConfig, int index) const;
232
233            void dump(int fd, int spaces) const;
234
235            String8           mName;
236            audio_port_type_t mType;
237            audio_port_role_t mRole;
238            bool              mUseInChannelMask;
239            // by convention, "0' in the first entry in mSamplingRates, mChannelMasks or mFormats
240            // indicates the supported parameters should be read from the output stream
241            // after it is opened for the first time
242            Vector <uint32_t> mSamplingRates; // supported sampling rates
243            Vector <audio_channel_mask_t> mChannelMasks; // supported channel masks
244            Vector <audio_format_t> mFormats; // supported audio formats
245            Vector < sp<AudioGain> > mGains; // gain controllers
246            sp<HwModule> mModule;                 // audio HW module exposing this I/O stream
247        };
248
249        class AudioPortConfig: public virtual RefBase
250        {
251        public:
252            AudioPortConfig();
253            virtual ~AudioPortConfig() {}
254
255            status_t applyAudioPortConfig(const struct audio_port_config *config,
256                                          struct audio_port_config *backupConfig = NULL);
257            virtual void toAudioPortConfig(struct audio_port_config *dstConfig,
258                                   const struct audio_port_config *srcConfig = NULL) const = 0;
259            sp<AudioPort> mAudioPort;
260            uint32_t mSamplingRate;
261            audio_format_t mFormat;
262            audio_channel_mask_t mChannelMask;
263            struct audio_gain_config mGain;
264        };
265
266
267        class AudioPatch: public RefBase
268        {
269        public:
270            AudioPatch(audio_patch_handle_t handle,
271                       const struct audio_patch *patch, uid_t uid) :
272                           mHandle(handle), mPatch(*patch), mUid(uid), mAfPatchHandle(0) {}
273
274            audio_patch_handle_t mHandle;
275            struct audio_patch mPatch;
276            uid_t mUid;
277            audio_patch_handle_t mAfPatchHandle;
278        };
279
280        class DeviceDescriptor: public AudioPort, public AudioPortConfig
281        {
282        public:
283            DeviceDescriptor(const String8& name, audio_devices_t type);
284
285            virtual ~DeviceDescriptor() {}
286
287            bool equals(const sp<DeviceDescriptor>& other) const;
288            virtual void toAudioPortConfig(struct audio_port_config *dstConfig,
289                                   const struct audio_port_config *srcConfig = NULL) const;
290
291            virtual void toAudioPort(struct audio_port *port) const;
292
293            status_t dump(int fd, int spaces, int index) const;
294
295            audio_devices_t mDeviceType;
296            String8 mAddress;
297            audio_channel_mask_t mChannelMask;
298            audio_port_handle_t mId;
299        };
300
301        class DeviceVector : public SortedVector< sp<DeviceDescriptor> >
302        {
303        public:
304            DeviceVector() : SortedVector(), mDeviceTypes(AUDIO_DEVICE_NONE) {}
305
306            ssize_t         add(const sp<DeviceDescriptor>& item);
307            ssize_t         remove(const sp<DeviceDescriptor>& item);
308            ssize_t         indexOf(const sp<DeviceDescriptor>& item) const;
309
310            audio_devices_t types() const { return mDeviceTypes; }
311
312            void loadDevicesFromType(audio_devices_t types);
313            void loadDevicesFromName(char *name, const DeviceVector& declaredDevices);
314
315            sp<DeviceDescriptor> getDevice(audio_devices_t type, String8 address) const;
316            DeviceVector getDevicesFromType(audio_devices_t types) const;
317            sp<DeviceDescriptor> getDeviceFromId(audio_port_handle_t id) const;
318            sp<DeviceDescriptor> getDeviceFromName(const String8& name) const;
319
320        private:
321            void refreshTypes();
322            audio_devices_t mDeviceTypes;
323        };
324
325        // the IOProfile class describes the capabilities of an output or input stream.
326        // It is currently assumed that all combination of listed parameters are supported.
327        // It is used by the policy manager to determine if an output or input is suitable for
328        // a given use case,  open/close it accordingly and connect/disconnect audio tracks
329        // to/from it.
330        class IOProfile : public AudioPort
331        {
332        public:
333            IOProfile(const String8& name, audio_port_role_t role, const sp<HwModule>& module);
334            virtual ~IOProfile();
335
336            bool isCompatibleProfile(audio_devices_t device,
337                                     uint32_t samplingRate,
338                                     audio_format_t format,
339                                     audio_channel_mask_t channelMask,
340                                     audio_output_flags_t flags) const;
341
342            void dump(int fd);
343            void log();
344
345            DeviceVector  mSupportedDevices; // supported devices
346                                             // (devices this output can be routed to)
347            audio_output_flags_t mFlags; // attribute flags (e.g primary output,
348                                                // direct output...). For outputs only.
349        };
350
351        class HwModule : public RefBase{
352        public:
353                    HwModule(const char *name);
354                    ~HwModule();
355
356            status_t loadOutput(cnode *root);
357            status_t loadInput(cnode *root);
358            status_t loadDevice(cnode *root);
359
360            void dump(int fd);
361
362            const char *const        mName; // base name of the audio HW module (primary, a2dp ...)
363            uint32_t                 mHalVersion; // audio HAL API version
364            audio_module_handle_t    mHandle;
365            Vector < sp<IOProfile> > mOutputProfiles; // output profiles exposed by this module
366            Vector < sp<IOProfile> > mInputProfiles;  // input profiles exposed by this module
367            DeviceVector             mDeclaredDevices; // devices declared in audio_policy.conf
368
369        };
370
371        // default volume curve
372        static const VolumeCurvePoint sDefaultVolumeCurve[AudioPolicyManager::VOLCNT];
373        // default volume curve for media strategy
374        static const VolumeCurvePoint sDefaultMediaVolumeCurve[AudioPolicyManager::VOLCNT];
375        // volume curve for media strategy on speakers
376        static const VolumeCurvePoint sSpeakerMediaVolumeCurve[AudioPolicyManager::VOLCNT];
377        static const VolumeCurvePoint sSpeakerMediaVolumeCurveDrc[AudioPolicyManager::VOLCNT];
378        // volume curve for sonification strategy on speakers
379        static const VolumeCurvePoint sSpeakerSonificationVolumeCurve[AudioPolicyManager::VOLCNT];
380        static const VolumeCurvePoint sSpeakerSonificationVolumeCurveDrc[AudioPolicyManager::VOLCNT];
381        static const VolumeCurvePoint sDefaultSystemVolumeCurve[AudioPolicyManager::VOLCNT];
382        static const VolumeCurvePoint sDefaultSystemVolumeCurveDrc[AudioPolicyManager::VOLCNT];
383        static const VolumeCurvePoint sHeadsetSystemVolumeCurve[AudioPolicyManager::VOLCNT];
384        static const VolumeCurvePoint sDefaultVoiceVolumeCurve[AudioPolicyManager::VOLCNT];
385        static const VolumeCurvePoint sSpeakerVoiceVolumeCurve[AudioPolicyManager::VOLCNT];
386        // default volume curves per stream and device category. See initializeVolumeCurves()
387        static const VolumeCurvePoint *sVolumeProfiles[AUDIO_STREAM_CNT][DEVICE_CATEGORY_CNT];
388
389        // descriptor for audio outputs. Used to maintain current configuration of each opened audio output
390        // and keep track of the usage of this output by each audio stream type.
391        class AudioOutputDescriptor: public AudioPortConfig
392        {
393        public:
394            AudioOutputDescriptor(const sp<IOProfile>& profile);
395
396            status_t    dump(int fd);
397
398            audio_devices_t device() const;
399            void changeRefCount(audio_stream_type_t stream, int delta);
400
401            bool isDuplicated() const { return (mOutput1 != NULL && mOutput2 != NULL); }
402            audio_devices_t supportedDevices();
403            uint32_t latency();
404            bool sharesHwModuleWith(const sp<AudioOutputDescriptor> outputDesc);
405            bool isActive(uint32_t inPastMs = 0) const;
406            bool isStreamActive(audio_stream_type_t stream,
407                                uint32_t inPastMs = 0,
408                                nsecs_t sysTime = 0) const;
409            bool isStrategyActive(routing_strategy strategy,
410                             uint32_t inPastMs = 0,
411                             nsecs_t sysTime = 0) const;
412
413            virtual void toAudioPortConfig(struct audio_port_config *dstConfig,
414                                   const struct audio_port_config *srcConfig = NULL) const;
415            void toAudioPort(struct audio_port *port) const;
416
417            audio_port_handle_t mId;
418            audio_io_handle_t mIoHandle;              // output handle
419            uint32_t mLatency;                  //
420            audio_output_flags_t mFlags;   //
421            audio_devices_t mDevice;                   // current device this output is routed to
422            audio_patch_handle_t mPatchHandle;
423            uint32_t mRefCount[AUDIO_STREAM_CNT]; // number of streams of each type using this output
424            nsecs_t mStopTime[AUDIO_STREAM_CNT];
425            sp<AudioOutputDescriptor> mOutput1;    // used by duplicated outputs: first output
426            sp<AudioOutputDescriptor> mOutput2;    // used by duplicated outputs: second output
427            float mCurVolume[AUDIO_STREAM_CNT];   // current stream volume
428            int mMuteCount[AUDIO_STREAM_CNT];     // mute request counter
429            const sp<IOProfile> mProfile;          // I/O profile this output derives from
430            bool mStrategyMutedByDevice[NUM_STRATEGIES]; // strategies muted because of incompatible
431                                                // device selection. See checkDeviceMuteStrategies()
432            uint32_t mDirectOpenCount; // number of clients using this output (direct outputs only)
433        };
434
435        // descriptor for audio inputs. Used to maintain current configuration of each opened audio input
436        // and keep track of the usage of this input.
437        class AudioInputDescriptor: public AudioPortConfig
438        {
439        public:
440            AudioInputDescriptor(const sp<IOProfile>& profile);
441
442            status_t    dump(int fd);
443
444            audio_port_handle_t mId;
445            audio_io_handle_t mIoHandle;              // input handle
446            audio_devices_t mDevice;                    // current device this input is routed to
447            audio_patch_handle_t mPatchHandle;
448            uint32_t mRefCount;                         // number of AudioRecord clients using this output
449            audio_source_t mInputSource;                // input source selected by application (mediarecorder.h)
450            const sp<IOProfile> mProfile;                  // I/O profile this output derives from
451
452            virtual void toAudioPortConfig(struct audio_port_config *dstConfig,
453                                   const struct audio_port_config *srcConfig = NULL) const;
454            void toAudioPort(struct audio_port *port) const;
455        };
456
457        // stream descriptor used for volume control
458        class StreamDescriptor
459        {
460        public:
461            StreamDescriptor();
462
463            int getVolumeIndex(audio_devices_t device);
464            void dump(int fd);
465
466            int mIndexMin;      // min volume index
467            int mIndexMax;      // max volume index
468            KeyedVector<audio_devices_t, int> mIndexCur;   // current volume index per device
469            bool mCanBeMuted;   // true is the stream can be muted
470
471            const VolumeCurvePoint *mVolumeCurve[DEVICE_CATEGORY_CNT];
472        };
473
474        // stream descriptor used for volume control
475        class EffectDescriptor : public RefBase
476        {
477        public:
478
479            status_t dump(int fd);
480
481            int mIo;                // io the effect is attached to
482            routing_strategy mStrategy; // routing strategy the effect is associated to
483            int mSession;               // audio session the effect is on
484            effect_descriptor_t mDesc;  // effect descriptor
485            bool mEnabled;              // enabled state: CPU load being used or not
486        };
487
488        void addOutput(audio_io_handle_t output, sp<AudioOutputDescriptor> outputDesc);
489        void addInput(audio_io_handle_t input, sp<AudioInputDescriptor> inputDesc);
490
491        // return the strategy corresponding to a given stream type
492        static routing_strategy getStrategy(audio_stream_type_t stream);
493
494        // return appropriate device for streams handled by the specified strategy according to current
495        // phone state, connected devices...
496        // if fromCache is true, the device is returned from mDeviceForStrategy[],
497        // otherwise it is determine by current state
498        // (device connected,phone state, force use, a2dp output...)
499        // This allows to:
500        //  1 speed up process when the state is stable (when starting or stopping an output)
501        //  2 access to either current device selection (fromCache == true) or
502        // "future" device selection (fromCache == false) when called from a context
503        //  where conditions are changing (setDeviceConnectionState(), setPhoneState()...) AND
504        //  before updateDevicesAndOutputs() is called.
505        virtual audio_devices_t getDeviceForStrategy(routing_strategy strategy,
506                                                     bool fromCache);
507
508        // change the route of the specified output. Returns the number of ms we have slept to
509        // allow new routing to take effect in certain cases.
510        uint32_t setOutputDevice(audio_io_handle_t output,
511                             audio_devices_t device,
512                             bool force = false,
513                             int delayMs = 0,
514                             audio_patch_handle_t *patchHandle = NULL);
515        status_t resetOutputDevice(audio_io_handle_t output,
516                                   int delayMs = 0,
517                                   audio_patch_handle_t *patchHandle = NULL);
518        status_t setInputDevice(audio_io_handle_t input,
519                                audio_devices_t device,
520                                bool force = false,
521                                audio_patch_handle_t *patchHandle = NULL);
522        status_t resetInputDevice(audio_io_handle_t input,
523                                  audio_patch_handle_t *patchHandle = NULL);
524
525        // select input device corresponding to requested audio source
526        virtual audio_devices_t getDeviceForInputSource(audio_source_t inputSource);
527
528        // return io handle of active input or 0 if no input is active
529        //    Only considers inputs from physical devices (e.g. main mic, headset mic) when
530        //    ignoreVirtualInputs is true.
531        audio_io_handle_t getActiveInput(bool ignoreVirtualInputs = true);
532
533        // initialize volume curves for each strategy and device category
534        void initializeVolumeCurves();
535
536        // compute the actual volume for a given stream according to the requested index and a particular
537        // device
538        virtual float computeVolume(audio_stream_type_t stream, int index,
539                                    audio_io_handle_t output, audio_devices_t device);
540
541        // check that volume change is permitted, compute and send new volume to audio hardware
542        status_t checkAndSetVolume(audio_stream_type_t stream, int index, audio_io_handle_t output,
543                                   audio_devices_t device, int delayMs = 0, bool force = false);
544
545        // apply all stream volumes to the specified output and device
546        void applyStreamVolumes(audio_io_handle_t output, audio_devices_t device, int delayMs = 0, bool force = false);
547
548        // Mute or unmute all streams handled by the specified strategy on the specified output
549        void setStrategyMute(routing_strategy strategy,
550                             bool on,
551                             audio_io_handle_t output,
552                             int delayMs = 0,
553                             audio_devices_t device = (audio_devices_t)0);
554
555        // Mute or unmute the stream on the specified output
556        void setStreamMute(audio_stream_type_t stream,
557                           bool on,
558                           audio_io_handle_t output,
559                           int delayMs = 0,
560                           audio_devices_t device = (audio_devices_t)0);
561
562        // handle special cases for sonification strategy while in call: mute streams or replace by
563        // a special tone in the device used for communication
564        void handleIncallSonification(audio_stream_type_t stream, bool starting, bool stateChange);
565
566        // true if device is in a telephony or VoIP call
567        virtual bool isInCall();
568
569        // true if given state represents a device in a telephony or VoIP call
570        virtual bool isStateInCall(int state);
571
572        // when a device is connected, checks if an open output can be routed
573        // to this device. If none is open, tries to open one of the available outputs.
574        // Returns an output suitable to this device or 0.
575        // when a device is disconnected, checks if an output is not used any more and
576        // returns its handle if any.
577        // transfers the audio tracks and effects from one output thread to another accordingly.
578        status_t checkOutputsForDevice(audio_devices_t device,
579                                       audio_policy_dev_state_t state,
580                                       SortedVector<audio_io_handle_t>& outputs,
581                                       const String8 address);
582
583        status_t checkInputsForDevice(audio_devices_t device,
584                                      audio_policy_dev_state_t state,
585                                      SortedVector<audio_io_handle_t>& inputs,
586                                      const String8 address);
587
588        // close an output and its companion duplicating output.
589        void closeOutput(audio_io_handle_t output);
590
591        // checks and if necessary changes outputs used for all strategies.
592        // must be called every time a condition that affects the output choice for a given strategy
593        // changes: connected device, phone state, force use...
594        // Must be called before updateDevicesAndOutputs()
595        void checkOutputForStrategy(routing_strategy strategy);
596
597        // Same as checkOutputForStrategy() but for a all strategies in order of priority
598        void checkOutputForAllStrategies();
599
600        // manages A2DP output suspend/restore according to phone state and BT SCO usage
601        void checkA2dpSuspend();
602
603        // returns the A2DP output handle if it is open or 0 otherwise
604        audio_io_handle_t getA2dpOutput();
605
606        // selects the most appropriate device on output for current state
607        // must be called every time a condition that affects the device choice for a given output is
608        // changed: connected device, phone state, force use, output start, output stop..
609        // see getDeviceForStrategy() for the use of fromCache parameter
610        audio_devices_t getNewOutputDevice(audio_io_handle_t output, bool fromCache);
611
612        // updates cache of device used by all strategies (mDeviceForStrategy[])
613        // must be called every time a condition that affects the device choice for a given strategy is
614        // changed: connected device, phone state, force use...
615        // cached values are used by getDeviceForStrategy() if parameter fromCache is true.
616         // Must be called after checkOutputForAllStrategies()
617        void updateDevicesAndOutputs();
618
619        // selects the most appropriate device on input for current state
620        audio_devices_t getNewInputDevice(audio_io_handle_t input);
621
622        virtual uint32_t getMaxEffectsCpuLoad();
623        virtual uint32_t getMaxEffectsMemory();
624#ifdef AUDIO_POLICY_TEST
625        virtual     bool        threadLoop();
626                    void        exit();
627        int testOutputIndex(audio_io_handle_t output);
628#endif //AUDIO_POLICY_TEST
629
630        status_t setEffectEnabled(const sp<EffectDescriptor>& effectDesc, bool enabled);
631
632        // returns the category the device belongs to with regard to volume curve management
633        static device_category getDeviceCategory(audio_devices_t device);
634
635        // extract one device relevant for volume control from multiple device selection
636        static audio_devices_t getDeviceForVolume(audio_devices_t device);
637
638        SortedVector<audio_io_handle_t> getOutputsForDevice(audio_devices_t device,
639                        DefaultKeyedVector<audio_io_handle_t, sp<AudioOutputDescriptor> > openOutputs);
640        bool vectorsEqual(SortedVector<audio_io_handle_t>& outputs1,
641                                           SortedVector<audio_io_handle_t>& outputs2);
642
643        // mute/unmute strategies using an incompatible device combination
644        // if muting, wait for the audio in pcm buffer to be drained before proceeding
645        // if unmuting, unmute only after the specified delay
646        // Returns the number of ms waited
647        uint32_t  checkDeviceMuteStrategies(sp<AudioOutputDescriptor> outputDesc,
648                                            audio_devices_t prevDevice,
649                                            uint32_t delayMs);
650
651        audio_io_handle_t selectOutput(const SortedVector<audio_io_handle_t>& outputs,
652                                       audio_output_flags_t flags);
653        sp<IOProfile> getInputProfile(audio_devices_t device,
654                                   uint32_t samplingRate,
655                                   audio_format_t format,
656                                   audio_channel_mask_t channelMask);
657        sp<IOProfile> getProfileForDirectOutput(audio_devices_t device,
658                                                       uint32_t samplingRate,
659                                                       audio_format_t format,
660                                                       audio_channel_mask_t channelMask,
661                                                       audio_output_flags_t flags);
662
663        audio_io_handle_t selectOutputForEffects(const SortedVector<audio_io_handle_t>& outputs);
664
665        bool isNonOffloadableEffectEnabled();
666
667        status_t addAudioPatch(audio_patch_handle_t handle,
668                               const sp<AudioPatch>& patch);
669        status_t removeAudioPatch(audio_patch_handle_t handle);
670
671        sp<AudioOutputDescriptor> getOutputFromId(audio_port_handle_t id) const;
672        sp<AudioInputDescriptor> getInputFromId(audio_port_handle_t id) const;
673        sp<HwModule> getModuleForDevice(audio_devices_t device) const;
674        sp<HwModule> getModuleFromName(const char *name) const;
675        //
676        // Audio policy configuration file parsing (audio_policy.conf)
677        //
678        static uint32_t stringToEnum(const struct StringToEnum *table,
679                                     size_t size,
680                                     const char *name);
681        static const char *enumToString(const struct StringToEnum *table,
682                                      size_t size,
683                                      uint32_t value);
684        static bool stringToBool(const char *value);
685        static audio_output_flags_t parseFlagNames(char *name);
686        static audio_devices_t parseDeviceNames(char *name);
687        void loadHwModule(cnode *root);
688        void loadHwModules(cnode *root);
689        void loadGlobalConfig(cnode *root, const sp<HwModule>& module);
690        status_t loadAudioPolicyConfig(const char *path);
691        void defaultAudioPolicyConfig(void);
692
693
694        uid_t mUidCached;
695        AudioPolicyClientInterface *mpClientInterface;  // audio policy client interface
696        audio_io_handle_t mPrimaryOutput;              // primary output handle
697        // list of descriptors for outputs currently opened
698        DefaultKeyedVector<audio_io_handle_t, sp<AudioOutputDescriptor> > mOutputs;
699        // copy of mOutputs before setDeviceConnectionState() opens new outputs
700        // reset to mOutputs when updateDevicesAndOutputs() is called.
701        DefaultKeyedVector<audio_io_handle_t, sp<AudioOutputDescriptor> > mPreviousOutputs;
702        DefaultKeyedVector<audio_io_handle_t, sp<AudioInputDescriptor> > mInputs;     // list of input descriptors
703        DeviceVector  mAvailableOutputDevices; // all available output devices
704        DeviceVector  mAvailableInputDevices;  // all available input devices
705        int mPhoneState;                                                    // current phone state
706        audio_policy_forced_cfg_t mForceUse[AUDIO_POLICY_FORCE_USE_CNT];   // current forced use configuration
707
708        StreamDescriptor mStreams[AUDIO_STREAM_CNT];           // stream descriptors for volume control
709        bool    mLimitRingtoneVolume;                                       // limit ringtone volume to music volume if headset connected
710        audio_devices_t mDeviceForStrategy[NUM_STRATEGIES];
711        float   mLastVoiceVolume;                                           // last voice volume value sent to audio HAL
712
713        // Maximum CPU load allocated to audio effects in 0.1 MIPS (ARMv5TE, 0 WS memory) units
714        static const uint32_t MAX_EFFECTS_CPU_LOAD = 1000;
715        // Maximum memory allocated to audio effects in KB
716        static const uint32_t MAX_EFFECTS_MEMORY = 512;
717        uint32_t mTotalEffectsCpuLoad; // current CPU load used by effects
718        uint32_t mTotalEffectsMemory;  // current memory used by effects
719        KeyedVector<int, sp<EffectDescriptor> > mEffects;  // list of registered audio effects
720        bool    mA2dpSuspended;  // true if A2DP output is suspended
721        sp<DeviceDescriptor> mDefaultOutputDevice; // output device selected by default at boot time
722        bool mSpeakerDrcEnabled;// true on devices that use DRC on the DEVICE_CATEGORY_SPEAKER path
723                                // to boost soft sounds, used to adjust volume curves accordingly
724
725        Vector < sp<HwModule> > mHwModules;
726        volatile int32_t mNextUniqueId;
727        volatile int32_t mAudioPortGeneration;
728
729        DefaultKeyedVector<audio_patch_handle_t, sp<AudioPatch> > mAudioPatches;
730
731#ifdef AUDIO_POLICY_TEST
732        Mutex   mLock;
733        Condition mWaitWorkCV;
734
735        int             mCurOutput;
736        bool            mDirectOutput;
737        audio_io_handle_t mTestOutputs[NUM_TEST_OUTPUTS];
738        int             mTestInput;
739        uint32_t        mTestDevice;
740        uint32_t        mTestSamplingRate;
741        uint32_t        mTestFormat;
742        uint32_t        mTestChannels;
743        uint32_t        mTestLatencyMs;
744#endif //AUDIO_POLICY_TEST
745
746private:
747        static float volIndexToAmpl(audio_devices_t device, const StreamDescriptor& streamDesc,
748                int indexInUi);
749        // updates device caching and output for streams that can influence the
750        //    routing of notifications
751        void handleNotificationRoutingForStream(audio_stream_type_t stream);
752        static bool isVirtualInputDevice(audio_devices_t device);
753        uint32_t nextUniqueId();
754        uint32_t nextAudioPortGeneration();
755        uint32_t curAudioPortGeneration() const { return mAudioPortGeneration; }
756        // converts device address to string sent to audio HAL via setParameters
757        static String8 addressToParameter(audio_devices_t device, const String8 address);
758};
759
760};
761