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