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