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