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