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