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