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#pragma once
18
19#include <stdint.h>
20#include <sys/types.h>
21#include <cutils/config_utils.h>
22#include <cutils/misc.h>
23#include <utils/Timers.h>
24#include <utils/Errors.h>
25#include <utils/KeyedVector.h>
26#include <utils/SortedVector.h>
27#include <media/AudioParameter.h>
28#include <media/AudioPolicy.h>
29#include "AudioPolicyInterface.h"
30
31#include <AudioPolicyManagerInterface.h>
32#include <AudioPolicyManagerObserver.h>
33#include <AudioGain.h>
34#include <AudioPort.h>
35#include <AudioPatch.h>
36#include <DeviceDescriptor.h>
37#include <IOProfile.h>
38#include <HwModule.h>
39#include <AudioInputDescriptor.h>
40#include <AudioOutputDescriptor.h>
41#include <AudioPolicyMix.h>
42#include <EffectDescriptor.h>
43#include <SoundTriggerSession.h>
44#include <SessionRoute.h>
45#include <VolumeCurve.h>
46
47namespace android {
48
49// ----------------------------------------------------------------------------
50
51// Attenuation applied to STRATEGY_SONIFICATION streams when a headset is connected: 6dB
52#define SONIFICATION_HEADSET_VOLUME_FACTOR_DB (-6)
53// Min volume for STRATEGY_SONIFICATION streams when limited by music volume: -36dB
54#define SONIFICATION_HEADSET_VOLUME_MIN_DB  (-36)
55// Max volume difference on A2DP between playing media and STRATEGY_SONIFICATION streams: 12dB
56#define SONIFICATION_A2DP_MAX_MEDIA_DIFF_DB (12)
57
58// Time in milliseconds during which we consider that music is still active after a music
59// track was stopped - see computeVolume()
60#define SONIFICATION_HEADSET_MUSIC_DELAY  5000
61
62// Time in milliseconds during witch some streams are muted while the audio path
63// is switched
64#define MUTE_TIME_MS 2000
65
66#define NUM_TEST_OUTPUTS 5
67
68#define NUM_VOL_CURVE_KNEES 2
69
70// Default minimum length allowed for offloading a compressed track
71// Can be overridden by the audio.offload.min.duration.secs property
72#define OFFLOAD_DEFAULT_MIN_DURATION_SECS 60
73
74// ----------------------------------------------------------------------------
75// AudioPolicyManager implements audio policy manager behavior common to all platforms.
76// ----------------------------------------------------------------------------
77
78class AudioPolicyManager : public AudioPolicyInterface, public AudioPolicyManagerObserver
79
80#ifdef AUDIO_POLICY_TEST
81    , public Thread
82#endif //AUDIO_POLICY_TEST
83{
84
85public:
86        explicit AudioPolicyManager(AudioPolicyClientInterface *clientInterface);
87        virtual ~AudioPolicyManager();
88
89        // AudioPolicyInterface
90        virtual status_t setDeviceConnectionState(audio_devices_t device,
91                                                          audio_policy_dev_state_t state,
92                                                          const char *device_address,
93                                                          const char *device_name);
94        virtual audio_policy_dev_state_t getDeviceConnectionState(audio_devices_t device,
95                                                                              const char *device_address);
96        virtual status_t handleDeviceConfigChange(audio_devices_t device,
97                                                  const char *device_address,
98                                                  const char *device_name);
99        virtual void setPhoneState(audio_mode_t state);
100        virtual void setForceUse(audio_policy_force_use_t usage,
101                                 audio_policy_forced_cfg_t config);
102        virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage);
103
104        virtual void setSystemProperty(const char* property, const char* value);
105        virtual status_t initCheck();
106        virtual audio_io_handle_t getOutput(audio_stream_type_t stream,
107                                            uint32_t samplingRate,
108                                            audio_format_t format,
109                                            audio_channel_mask_t channelMask,
110                                            audio_output_flags_t flags,
111                                            const audio_offload_info_t *offloadInfo);
112        virtual status_t getOutputForAttr(const audio_attributes_t *attr,
113                                          audio_io_handle_t *output,
114                                          audio_session_t session,
115                                          audio_stream_type_t *stream,
116                                          uid_t uid,
117                                          const audio_config_t *config,
118                                          audio_output_flags_t flags,
119                                          audio_port_handle_t *selectedDeviceId,
120                                          audio_port_handle_t *portId);
121        virtual status_t startOutput(audio_io_handle_t output,
122                                     audio_stream_type_t stream,
123                                     audio_session_t session);
124        virtual status_t stopOutput(audio_io_handle_t output,
125                                    audio_stream_type_t stream,
126                                    audio_session_t session);
127        virtual void releaseOutput(audio_io_handle_t output,
128                                   audio_stream_type_t stream,
129                                   audio_session_t session);
130        virtual status_t getInputForAttr(const audio_attributes_t *attr,
131                                         audio_io_handle_t *input,
132                                         audio_session_t session,
133                                         uid_t uid,
134                                         const audio_config_base_t *config,
135                                         audio_input_flags_t flags,
136                                         audio_port_handle_t *selectedDeviceId,
137                                         input_type_t *inputType,
138                                         audio_port_handle_t *portId);
139
140        // indicates to the audio policy manager that the input starts being used.
141        virtual status_t startInput(audio_io_handle_t input,
142                                    audio_session_t session,
143                                    concurrency_type__mask_t *concurrency);
144
145        // indicates to the audio policy manager that the input stops being used.
146        virtual status_t stopInput(audio_io_handle_t input,
147                                   audio_session_t session);
148        virtual void releaseInput(audio_io_handle_t input,
149                                  audio_session_t session);
150        virtual void closeAllInputs();
151        virtual void initStreamVolume(audio_stream_type_t stream,
152                                                    int indexMin,
153                                                    int indexMax);
154        virtual status_t setStreamVolumeIndex(audio_stream_type_t stream,
155                                              int index,
156                                              audio_devices_t device);
157        virtual status_t getStreamVolumeIndex(audio_stream_type_t stream,
158                                              int *index,
159                                              audio_devices_t device);
160
161        // return the strategy corresponding to a given stream type
162        virtual uint32_t getStrategyForStream(audio_stream_type_t stream);
163        // return the strategy corresponding to the given audio attributes
164        virtual uint32_t getStrategyForAttr(const audio_attributes_t *attr);
165
166        // return the enabled output devices for the given stream type
167        virtual audio_devices_t getDevicesForStream(audio_stream_type_t stream);
168
169        virtual audio_io_handle_t getOutputForEffect(const effect_descriptor_t *desc = NULL);
170        virtual status_t registerEffect(const effect_descriptor_t *desc,
171                                        audio_io_handle_t io,
172                                        uint32_t strategy,
173                                        int session,
174                                        int id);
175        virtual status_t unregisterEffect(int id)
176        {
177            return mEffects.unregisterEffect(id);
178        }
179        virtual status_t setEffectEnabled(int id, bool enabled)
180        {
181            return mEffects.setEffectEnabled(id, enabled);
182        }
183
184        virtual bool isStreamActive(audio_stream_type_t stream, uint32_t inPastMs = 0) const;
185        // return whether a stream is playing remotely, override to change the definition of
186        //   local/remote playback, used for instance by notification manager to not make
187        //   media players lose audio focus when not playing locally
188        //   For the base implementation, "remotely" means playing during screen mirroring which
189        //   uses an output for playback with a non-empty, non "0" address.
190        virtual bool isStreamActiveRemotely(audio_stream_type_t stream,
191                                            uint32_t inPastMs = 0) const;
192
193        virtual bool isSourceActive(audio_source_t source) const;
194
195        virtual status_t dump(int fd);
196
197        virtual bool isOffloadSupported(const audio_offload_info_t& offloadInfo);
198
199        virtual status_t listAudioPorts(audio_port_role_t role,
200                                        audio_port_type_t type,
201                                        unsigned int *num_ports,
202                                        struct audio_port *ports,
203                                        unsigned int *generation);
204        virtual status_t getAudioPort(struct audio_port *port);
205        virtual status_t createAudioPatch(const struct audio_patch *patch,
206                                           audio_patch_handle_t *handle,
207                                           uid_t uid);
208        virtual status_t releaseAudioPatch(audio_patch_handle_t handle,
209                                              uid_t uid);
210        virtual status_t listAudioPatches(unsigned int *num_patches,
211                                          struct audio_patch *patches,
212                                          unsigned int *generation);
213        virtual status_t setAudioPortConfig(const struct audio_port_config *config);
214
215        virtual void releaseResourcesForUid(uid_t uid);
216
217        virtual status_t acquireSoundTriggerSession(audio_session_t *session,
218                                               audio_io_handle_t *ioHandle,
219                                               audio_devices_t *device);
220
221        virtual status_t releaseSoundTriggerSession(audio_session_t session)
222        {
223            return mSoundTriggerSessions.releaseSession(session);
224        }
225
226        virtual status_t registerPolicyMixes(const Vector<AudioMix>& mixes);
227        virtual status_t unregisterPolicyMixes(Vector<AudioMix> mixes);
228
229        virtual status_t startAudioSource(const struct audio_port_config *source,
230                                          const audio_attributes_t *attributes,
231                                          audio_patch_handle_t *handle,
232                                          uid_t uid);
233        virtual status_t stopAudioSource(audio_patch_handle_t handle);
234
235        virtual status_t setMasterMono(bool mono);
236        virtual status_t getMasterMono(bool *mono);
237        virtual float    getStreamVolumeDB(
238                    audio_stream_type_t stream, int index, audio_devices_t device);
239
240        // return the strategy corresponding to a given stream type
241        routing_strategy getStrategy(audio_stream_type_t stream) const;
242
243protected:
244        // From AudioPolicyManagerObserver
245        virtual const AudioPatchCollection &getAudioPatches() const
246        {
247            return mAudioPatches;
248        }
249        virtual const SoundTriggerSessionCollection &getSoundTriggerSessionCollection() const
250        {
251            return mSoundTriggerSessions;
252        }
253        virtual const AudioPolicyMixCollection &getAudioPolicyMixCollection() const
254        {
255            return mPolicyMixes;
256        }
257        virtual const SwAudioOutputCollection &getOutputs() const
258        {
259            return mOutputs;
260        }
261        virtual const AudioInputCollection &getInputs() const
262        {
263            return mInputs;
264        }
265        virtual const DeviceVector &getAvailableOutputDevices() const
266        {
267            return mAvailableOutputDevices;
268        }
269        virtual const DeviceVector &getAvailableInputDevices() const
270        {
271            return mAvailableInputDevices;
272        }
273        virtual IVolumeCurvesCollection &getVolumeCurves() { return *mVolumeCurves; }
274        virtual const sp<DeviceDescriptor> &getDefaultOutputDevice() const
275        {
276            return mDefaultOutputDevice;
277        }
278protected:
279        void addOutput(audio_io_handle_t output, const sp<SwAudioOutputDescriptor>& outputDesc);
280        void removeOutput(audio_io_handle_t output);
281        void addInput(audio_io_handle_t input, const sp<AudioInputDescriptor>& inputDesc);
282
283        // return appropriate device for streams handled by the specified strategy according to current
284        // phone state, connected devices...
285        // if fromCache is true, the device is returned from mDeviceForStrategy[],
286        // otherwise it is determine by current state
287        // (device connected,phone state, force use, a2dp output...)
288        // This allows to:
289        //  1 speed up process when the state is stable (when starting or stopping an output)
290        //  2 access to either current device selection (fromCache == true) or
291        // "future" device selection (fromCache == false) when called from a context
292        //  where conditions are changing (setDeviceConnectionState(), setPhoneState()...) AND
293        //  before updateDevicesAndOutputs() is called.
294        virtual audio_devices_t getDeviceForStrategy(routing_strategy strategy,
295                                                     bool fromCache);
296
297        bool isStrategyActive(const sp<AudioOutputDescriptor>& outputDesc, routing_strategy strategy,
298                              uint32_t inPastMs = 0, nsecs_t sysTime = 0) const;
299
300        // change the route of the specified output. Returns the number of ms we have slept to
301        // allow new routing to take effect in certain cases.
302        virtual uint32_t setOutputDevice(const sp<AudioOutputDescriptor>& outputDesc,
303                             audio_devices_t device,
304                             bool force = false,
305                             int delayMs = 0,
306                             audio_patch_handle_t *patchHandle = NULL,
307                             const char* address = NULL);
308        status_t resetOutputDevice(const sp<AudioOutputDescriptor>& outputDesc,
309                                   int delayMs = 0,
310                                   audio_patch_handle_t *patchHandle = NULL);
311        status_t setInputDevice(audio_io_handle_t input,
312                                audio_devices_t device,
313                                bool force = false,
314                                audio_patch_handle_t *patchHandle = NULL);
315        status_t resetInputDevice(audio_io_handle_t input,
316                                  audio_patch_handle_t *patchHandle = NULL);
317
318        // select input device corresponding to requested audio source
319        virtual audio_devices_t getDeviceForInputSource(audio_source_t inputSource);
320
321        // compute the actual volume for a given stream according to the requested index and a particular
322        // device
323        virtual float computeVolume(audio_stream_type_t stream,
324                                    int index,
325                                    audio_devices_t device);
326
327        // check that volume change is permitted, compute and send new volume to audio hardware
328        virtual status_t checkAndSetVolume(audio_stream_type_t stream, int index,
329                                           const sp<AudioOutputDescriptor>& outputDesc,
330                                           audio_devices_t device,
331                                           int delayMs = 0, bool force = false);
332
333        // apply all stream volumes to the specified output and device
334        void applyStreamVolumes(const sp<AudioOutputDescriptor>& outputDesc,
335                                audio_devices_t device, int delayMs = 0, bool force = false);
336
337        // Mute or unmute all streams handled by the specified strategy on the specified output
338        void setStrategyMute(routing_strategy strategy,
339                             bool on,
340                             const sp<AudioOutputDescriptor>& outputDesc,
341                             int delayMs = 0,
342                             audio_devices_t device = (audio_devices_t)0);
343
344        // Mute or unmute the stream on the specified output
345        void setStreamMute(audio_stream_type_t stream,
346                           bool on,
347                           const sp<AudioOutputDescriptor>& outputDesc,
348                           int delayMs = 0,
349                           audio_devices_t device = (audio_devices_t)0);
350
351        // handle special cases for sonification strategy while in call: mute streams or replace by
352        // a special tone in the device used for communication
353        void handleIncallSonification(audio_stream_type_t stream, bool starting, bool stateChange);
354
355        audio_mode_t getPhoneState();
356
357        // true if device is in a telephony or VoIP call
358        virtual bool isInCall();
359        // true if given state represents a device in a telephony or VoIP call
360        virtual bool isStateInCall(int state);
361
362        // when a device is connected, checks if an open output can be routed
363        // to this device. If none is open, tries to open one of the available outputs.
364        // Returns an output suitable to this device or 0.
365        // when a device is disconnected, checks if an output is not used any more and
366        // returns its handle if any.
367        // transfers the audio tracks and effects from one output thread to another accordingly.
368        status_t checkOutputsForDevice(const sp<DeviceDescriptor>& devDesc,
369                                       audio_policy_dev_state_t state,
370                                       SortedVector<audio_io_handle_t>& outputs,
371                                       const String8& address);
372
373        status_t checkInputsForDevice(const sp<DeviceDescriptor>& devDesc,
374                                      audio_policy_dev_state_t state,
375                                      SortedVector<audio_io_handle_t>& inputs,
376                                      const String8& address);
377
378        // close an output and its companion duplicating output.
379        void closeOutput(audio_io_handle_t output);
380
381        // close an input.
382        void closeInput(audio_io_handle_t input);
383
384        // checks and if necessary changes outputs used for all strategies.
385        // must be called every time a condition that affects the output choice for a given strategy
386        // changes: connected device, phone state, force use...
387        // Must be called before updateDevicesAndOutputs()
388        void checkOutputForStrategy(routing_strategy strategy);
389
390        // Same as checkOutputForStrategy() but for a all strategies in order of priority
391        void checkOutputForAllStrategies();
392
393        // manages A2DP output suspend/restore according to phone state and BT SCO usage
394        void checkA2dpSuspend();
395
396        // selects the most appropriate device on output for current state
397        // must be called every time a condition that affects the device choice for a given output is
398        // changed: connected device, phone state, force use, output start, output stop..
399        // see getDeviceForStrategy() for the use of fromCache parameter
400        audio_devices_t getNewOutputDevice(const sp<AudioOutputDescriptor>& outputDesc,
401                                           bool fromCache);
402
403        // updates cache of device used by all strategies (mDeviceForStrategy[])
404        // must be called every time a condition that affects the device choice for a given strategy is
405        // changed: connected device, phone state, force use...
406        // cached values are used by getDeviceForStrategy() if parameter fromCache is true.
407         // Must be called after checkOutputForAllStrategies()
408        void updateDevicesAndOutputs();
409
410        // selects the most appropriate device on input for current state
411        audio_devices_t getNewInputDevice(const sp<AudioInputDescriptor>& inputDesc);
412
413        virtual uint32_t getMaxEffectsCpuLoad()
414        {
415            return mEffects.getMaxEffectsCpuLoad();
416        }
417
418        virtual uint32_t getMaxEffectsMemory()
419        {
420            return mEffects.getMaxEffectsMemory();
421        }
422#ifdef AUDIO_POLICY_TEST
423        virtual     bool        threadLoop();
424                    void        exit();
425        int testOutputIndex(audio_io_handle_t output);
426#endif //AUDIO_POLICY_TEST
427
428        SortedVector<audio_io_handle_t> getOutputsForDevice(audio_devices_t device,
429                                                            const SwAudioOutputCollection& openOutputs);
430        bool vectorsEqual(SortedVector<audio_io_handle_t>& outputs1,
431                                           SortedVector<audio_io_handle_t>& outputs2);
432
433        // mute/unmute strategies using an incompatible device combination
434        // if muting, wait for the audio in pcm buffer to be drained before proceeding
435        // if unmuting, unmute only after the specified delay
436        // Returns the number of ms waited
437        virtual uint32_t  checkDeviceMuteStrategies(const sp<AudioOutputDescriptor>& outputDesc,
438                                            audio_devices_t prevDevice,
439                                            uint32_t delayMs);
440
441        audio_io_handle_t selectOutput(const SortedVector<audio_io_handle_t>& outputs,
442                                       audio_output_flags_t flags,
443                                       audio_format_t format);
444        // samplingRate, format, channelMask are in/out and so may be modified
445        sp<IOProfile> getInputProfile(audio_devices_t device,
446                                      const String8& address,
447                                      uint32_t& samplingRate,
448                                      audio_format_t& format,
449                                      audio_channel_mask_t& channelMask,
450                                      audio_input_flags_t flags);
451        sp<IOProfile> getProfileForDirectOutput(audio_devices_t device,
452                                                       uint32_t samplingRate,
453                                                       audio_format_t format,
454                                                       audio_channel_mask_t channelMask,
455                                                       audio_output_flags_t flags);
456
457        audio_io_handle_t selectOutputForMusicEffects();
458
459        virtual status_t addAudioPatch(audio_patch_handle_t handle, const sp<AudioPatch>& patch)
460        {
461            return mAudioPatches.addAudioPatch(handle, patch);
462        }
463        virtual status_t removeAudioPatch(audio_patch_handle_t handle)
464        {
465            return mAudioPatches.removeAudioPatch(handle);
466        }
467
468        audio_devices_t availablePrimaryOutputDevices() const
469        {
470            if (!hasPrimaryOutput()) {
471                return AUDIO_DEVICE_NONE;
472            }
473            return mPrimaryOutput->supportedDevices() & mAvailableOutputDevices.types();
474        }
475        audio_devices_t availablePrimaryInputDevices() const
476        {
477            if (!hasPrimaryOutput()) {
478                return AUDIO_DEVICE_NONE;
479            }
480            return mAvailableInputDevices.getDevicesFromHwModule(mPrimaryOutput->getModuleHandle());
481        }
482
483        uint32_t updateCallRouting(audio_devices_t rxDevice, uint32_t delayMs = 0);
484
485        // if argument "device" is different from AUDIO_DEVICE_NONE,  startSource() will force
486        // the re-evaluation of the output device.
487        status_t startSource(const sp<AudioOutputDescriptor>& outputDesc,
488                             audio_stream_type_t stream,
489                             audio_devices_t device,
490                             const char *address,
491                             uint32_t *delayMs);
492        status_t stopSource(const sp<AudioOutputDescriptor>& outputDesc,
493                            audio_stream_type_t stream,
494                            bool forceDeviceUpdate);
495
496        void clearAudioPatches(uid_t uid);
497        void clearSessionRoutes(uid_t uid);
498        void checkStrategyRoute(routing_strategy strategy, audio_io_handle_t ouptutToSkip);
499
500        status_t hasPrimaryOutput() const { return mPrimaryOutput != 0; }
501
502        status_t connectAudioSource(const sp<AudioSourceDescriptor>& sourceDesc);
503        status_t disconnectAudioSource(const sp<AudioSourceDescriptor>& sourceDesc);
504
505        sp<AudioSourceDescriptor> getSourceForStrategyOnOutput(audio_io_handle_t output,
506                                                               routing_strategy strategy);
507
508        void cleanUpForDevice(const sp<DeviceDescriptor>& deviceDesc);
509
510        void clearAudioSources(uid_t uid);
511
512        static bool isConcurrentSource(audio_source_t source);
513
514        bool isConcurentCaptureAllowed(const sp<AudioInputDescriptor>& inputDesc,
515                const sp<AudioSession>& audioSession);
516
517        static bool streamsMatchForvolume(audio_stream_type_t stream1,
518                                          audio_stream_type_t stream2);
519
520        uid_t mUidCached;
521        AudioPolicyClientInterface *mpClientInterface;  // audio policy client interface
522        sp<SwAudioOutputDescriptor> mPrimaryOutput;     // primary output descriptor
523        // list of descriptors for outputs currently opened
524
525        SwAudioOutputCollection mOutputs;
526        // copy of mOutputs before setDeviceConnectionState() opens new outputs
527        // reset to mOutputs when updateDevicesAndOutputs() is called.
528        SwAudioOutputCollection mPreviousOutputs;
529        AudioInputCollection mInputs;     // list of input descriptors
530
531        DeviceVector  mAvailableOutputDevices; // all available output devices
532        DeviceVector  mAvailableInputDevices;  // all available input devices
533
534        SessionRouteMap mOutputRoutes = SessionRouteMap(SessionRouteMap::MAPTYPE_OUTPUT);
535        SessionRouteMap mInputRoutes = SessionRouteMap(SessionRouteMap::MAPTYPE_INPUT);
536
537        IVolumeCurvesCollection *mVolumeCurves; // Volume Curves per use case and device category
538
539        bool    mLimitRingtoneVolume;        // limit ringtone volume to music volume if headset connected
540        audio_devices_t mDeviceForStrategy[NUM_STRATEGIES];
541        float   mLastVoiceVolume;            // last voice volume value sent to audio HAL
542
543        EffectDescriptorCollection mEffects;  // list of registered audio effects
544        bool    mA2dpSuspended;  // true if A2DP output is suspended
545        sp<DeviceDescriptor> mDefaultOutputDevice; // output device selected by default at boot time
546        HwModuleCollection mHwModules;
547
548        volatile int32_t mAudioPortGeneration;
549
550        AudioPatchCollection mAudioPatches;
551
552        SoundTriggerSessionCollection mSoundTriggerSessions;
553
554        sp<AudioPatch> mCallTxPatch;
555        sp<AudioPatch> mCallRxPatch;
556
557        HwAudioOutputCollection mHwOutputs;
558        AudioSourceCollection mAudioSources;
559
560        // for supporting "beacon" streams, i.e. streams that only play on speaker, and never
561        // when something other than STREAM_TTS (a.k.a. "Transmitted Through Speaker") is playing
562        enum {
563            STARTING_OUTPUT,
564            STARTING_BEACON,
565            STOPPING_OUTPUT,
566            STOPPING_BEACON
567        };
568        uint32_t mBeaconMuteRefCount;   // ref count for stream that would mute beacon
569        uint32_t mBeaconPlayingRefCount;// ref count for the playing beacon streams
570        bool mBeaconMuted;              // has STREAM_TTS been muted
571        bool mTtsOutputAvailable;       // true if a dedicated output for TTS stream is available
572
573        bool mMasterMono;               // true if we wish to force all outputs to mono
574        AudioPolicyMixCollection mPolicyMixes; // list of registered mixes
575        audio_io_handle_t mMusicEffectOutput;     // output selected for music effects
576
577
578#ifdef AUDIO_POLICY_TEST
579        Mutex   mLock;
580        Condition mWaitWorkCV;
581
582        int             mCurOutput;
583        bool            mDirectOutput;
584        audio_io_handle_t mTestOutputs[NUM_TEST_OUTPUTS];
585        int             mTestInput;
586        uint32_t        mTestDevice;
587        uint32_t        mTestSamplingRate;
588        uint32_t        mTestFormat;
589        uint32_t        mTestChannels;
590        uint32_t        mTestLatencyMs;
591#endif //AUDIO_POLICY_TEST
592
593        uint32_t nextAudioPortGeneration();
594
595        // Audio Policy Engine Interface.
596        AudioPolicyManagerInterface *mEngine;
597private:
598        // Add or remove AC3 DTS encodings based on user preferences.
599        void filterSurroundFormats(FormatVector *formatsPtr);
600        void filterSurroundChannelMasks(ChannelsVector *channelMasksPtr);
601
602        // If any, resolve any "dynamic" fields of an Audio Profiles collection
603        void updateAudioProfiles(audio_devices_t device, audio_io_handle_t ioHandle,
604                AudioProfileVector &profiles);
605
606        // Notify the policy client of any change of device state with AUDIO_IO_HANDLE_NONE,
607        // so that the client interprets it as global to audio hardware interfaces.
608        // It can give a chance to HAL implementer to retrieve dynamic capabilities associated
609        // to this device for example.
610        // TODO avoid opening stream to retrieve capabilities of a profile.
611        void broadcastDeviceConnectionState(audio_devices_t device,
612                                            audio_policy_dev_state_t state,
613                                            const String8 &device_address);
614
615        // updates device caching and output for streams that can influence the
616        //    routing of notifications
617        void handleNotificationRoutingForStream(audio_stream_type_t stream);
618        // find the outputs on a given output descriptor that have the given address.
619        // to be called on an AudioOutputDescriptor whose supported devices (as defined
620        //   in mProfile->mSupportedDevices) matches the device whose address is to be matched.
621        // see deviceDistinguishesOnAddress(audio_devices_t) for whether the device type is one
622        //   where addresses are used to distinguish between one connected device and another.
623        void findIoHandlesByAddress(const sp<SwAudioOutputDescriptor>& desc /*in*/,
624                const audio_devices_t device /*in*/,
625                const String8& address /*in*/,
626                SortedVector<audio_io_handle_t>& outputs /*out*/);
627        uint32_t curAudioPortGeneration() const { return mAudioPortGeneration; }
628        // internal method to return the output handle for the given device and format
629        audio_io_handle_t getOutputForDevice(
630                audio_devices_t device,
631                audio_session_t session,
632                audio_stream_type_t stream,
633                uint32_t samplingRate,
634                audio_format_t format,
635                audio_channel_mask_t channelMask,
636                audio_output_flags_t flags,
637                const audio_offload_info_t *offloadInfo);
638        // internal method to return the input handle for the given device and format
639        audio_io_handle_t getInputForDevice(audio_devices_t device,
640                String8 address,
641                audio_session_t session,
642                uid_t uid,
643                audio_source_t inputSource,
644                uint32_t samplingRate,
645                audio_format_t format,
646                audio_channel_mask_t channelMask,
647                audio_input_flags_t flags,
648                AudioMix *policyMix);
649
650        // internal function to derive a stream type value from audio attributes
651        audio_stream_type_t streamTypefromAttributesInt(const audio_attributes_t *attr);
652        // event is one of STARTING_OUTPUT, STARTING_BEACON, STOPPING_OUTPUT, STOPPING_BEACON
653        // returns 0 if no mute/unmute event happened, the largest latency of the device where
654        //   the mute/unmute happened
655        uint32_t handleEventForBeacon(int event);
656        uint32_t setBeaconMute(bool mute);
657        bool     isValidAttributes(const audio_attributes_t *paa);
658
659        // select input device corresponding to requested audio source and return associated policy
660        // mix if any. Calls getDeviceForInputSource().
661        audio_devices_t getDeviceAndMixForInputSource(audio_source_t inputSource,
662                                                        AudioMix **policyMix = NULL);
663
664        // Called by setDeviceConnectionState().
665        status_t setDeviceConnectionStateInt(audio_devices_t device,
666                                                          audio_policy_dev_state_t state,
667                                                          const char *device_address,
668                                                          const char *device_name);
669        void updateMono(audio_io_handle_t output) {
670            AudioParameter param;
671            param.addInt(String8(AudioParameter::keyMonoOutput), (int)mMasterMono);
672            mpClientInterface->setParameters(output, param.toString());
673        }
674
675        bool soundTriggerSupportsConcurrentCapture();
676        bool mSoundTriggerSupportsConcurrentCapture;
677        bool mHasComputedSoundTriggerSupportsConcurrentCapture;
678};
679
680};
681