1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include <AudioPolicyManagerObserver.h>
#include <RoutingStrategy.h>
#include <Volume.h>
#include <HwModule.h>
#include <DeviceDescriptor.h>
#include <system/audio.h>
#include <system/audio_policy.h>
#include <utils/Errors.h>
#include <utils/Vector.h>
namespace android {
/**
* This interface is dedicated to the policy manager that a Policy Engine shall implement.
*/
class AudioPolicyManagerInterface
{
public:
/**
* Checks if the engine was correctly initialized.
*
* @return NO_ERROR if initialization has been done correctly, error code otherwise..
*/
virtual status_t initCheck() = 0;
/**
* Sets the Manager observer that allows the engine to retrieve information on collection
* of devices, streams, HwModules, ...
*
* @param[in] observer handle on the manager.
*/
virtual void setObserver(AudioPolicyManagerObserver *observer) = 0;
/**
* Get the input device selected for a given input source.
*
* @param[in] inputSource to get the selected input device associated to
*
* @return selected input device for the given input source, may be none if error.
*/
virtual audio_devices_t getDeviceForInputSource(audio_source_t inputSource) const = 0;
/**
* Get the output device associated to a given strategy.
*
* @param[in] stream type for which the selected ouput device is requested.
*
* @return selected ouput device for the given strategy, may be none if error.
*/
virtual audio_devices_t getDeviceForStrategy(routing_strategy stategy) const = 0;
/**
* Get the strategy selected for a given stream type.
*
* @param[in] stream: for which the selected strategy followed by is requested.
*
* @return strategy to be followed.
*/
virtual routing_strategy getStrategyForStream(audio_stream_type_t stream) = 0;
/**
* Get the strategy selected for a given usage.
*
* @param[in] usage to get the selected strategy followed by.
*
* @return strategy to be followed.
*/
virtual routing_strategy getStrategyForUsage(audio_usage_t usage) = 0;
/**
* Set the Telephony Mode.
*
* @param[in] mode: Android Phone state (normal, ringtone, csv, in communication)
*
* @return NO_ERROR if Telephony Mode set correctly, error code otherwise.
*/
virtual status_t setPhoneState(audio_mode_t mode) = 0;
/**
* Get the telephony Mode
*
* @return the current telephony mode
*/
virtual audio_mode_t getPhoneState() const = 0;
/**
* Set Force Use config for a given usage.
*
* @param[in] usage for which a configuration shall be forced.
* @param[in] config wished to be forced for the given usage.
*
* @return NO_ERROR if the Force Use config was set correctly, error code otherwise (e.g. config not
* allowed a given usage...)
*/
virtual status_t setForceUse(audio_policy_force_use_t usage,
audio_policy_forced_cfg_t config) = 0;
/**
* Get Force Use config for a given usage.
*
* @param[in] usage for which a configuration shall be forced.
*
* @return config wished to be forced for the given usage.
*/
virtual audio_policy_forced_cfg_t getForceUse(audio_policy_force_use_t usage) const = 0;
/**
* Set the connection state of device(s).
*
* @param[in] devDesc for which the state has changed.
* @param[in] state of availability of this(these) device(s).
*
* @return NO_ERROR if devices criterion updated correctly, error code otherwise.
*/
virtual status_t setDeviceConnectionState(const android::sp<android::DeviceDescriptor> devDesc,
audio_policy_dev_state_t state) = 0;
/**
* Translate a volume index given by the UI to an amplification value for a stream type
* and a device category.
*
* @param[in] deviceCategory for which the conversion is requested.
* @param[in] stream type for which the conversion is requested.
* @param[in] indexInUi index received from the UI to be translated.
*
* @return amplification value matching the UI index for this given device and stream.
*/
virtual float volIndexToAmpl(Volume::device_category deviceCategory, audio_stream_type_t stream,
int indexInUi) = 0;
/**
* Initialize the min / max index of volume applicable for a given stream type. These indexes
* will be used upon conversion of UI index to volume amplification.
*
* @param[in] stream type for which the indexes need to be set
* @param[in] indexMin Minimum index allowed for this stream.
* @param[in] indexMax Maximum index allowed for this stream.
*/
virtual status_t initStreamVolume(audio_stream_type_t stream, int indexMin, int indexMax) = 0;
/**
* Initialize volume curves for each strategy and device category
*
* @param[in] isSpeakerDrcEnabled true on devices that use DRC on the DEVICE_CATEGORY_SPEAKER
path to boost soft sounds, used to adjust volume curves accordingly
*/
virtual void initializeVolumeCurves(bool isSpeakerDrcEnabled) = 0;
protected:
virtual ~AudioPolicyManagerInterface() {}
};
}; // namespace android
|
