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