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