-
Notifications
You must be signed in to change notification settings - Fork 1
/
IOAudioLevelControl.h
205 lines (177 loc) · 8.74 KB
/
IOAudioLevelControl.h
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*
* Copyright (c) 1998-2010 Apple Computer, Inc. All rights reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* The contents of this file constitute Original Code as defined in and
* are subject to the Apple Public Source License Version 1.1 (the
* "License"). You may not use this file except in compliance with the
* License. Please obtain a copy of the License at
* http://www.apple.com/publicsource and read it before using this file.
*
* This Original Code and all software distributed under the License are
* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
* License for the specific language governing rights and limitations
* under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#ifndef _IOKIT_IOAUDIOLEVELCONTROL_H
#define _IOKIT_IOAUDIOLEVELCONTROL_H
#ifndef IOAUDIOFAMILY_SELF_BUILD
#include <IOKit/audio/IOAudioControl.h>
#else
#include "IOAudioControl.h"
#endif
class OSArray;
/*!
* @class IOAudioLevelControl
* @abstract
* @discussion
*/
class IOAudioLevelControl : public IOAudioControl
{
OSDeclareDefaultStructors(IOAudioLevelControl)
protected:
SInt32 minValue;
SInt32 maxValue;
IOFixed minDB;
IOFixed maxDB;
OSArray *ranges;
protected:
struct ExpansionData { };
ExpansionData *reserved;
public:
static IOAudioLevelControl *createPassThruVolumeControl (SInt32 initialValue,
SInt32 minValue,
SInt32 maxValue,
IOFixed minDB,
IOFixed maxDB,
UInt32 channelID,
const char *channelName,
UInt32 cntrlID);
// OSMetaClassDefineReservedUnused(IOAudioLevelControl, 0);
/*!
* @function setLinearScale
* @abstract This function tells CoreAudio if it should apply a curve to the scaler representation of the volume.
* @param useLinearScale TRUE instructs CoreAudio to not apply a curve to the scaler representation of the volume,
* FALSE instructs CoreAudio to apply a curve, which is CoreAudio's default behavior.
*/
virtual void setLinearScale(bool useLinearScale);
private:
OSMetaClassDeclareReservedUsed(IOAudioLevelControl, 0);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 1);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 2);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 3);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 4);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 5);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 6);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 7);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 8);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 9);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 10);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 11);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 12);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 13);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 14);
OSMetaClassDeclareReservedUnused(IOAudioLevelControl, 15);
public:
/*!
* @function create
* @abstract Allocates a new level control with the given attributes
* @param initialValue The initial value of the control
* @param minValue The lowest possible value the control may have
* @param maxValue The highest possible value the control may have
* @param minDB A fixed point representation of the db value matching minValue
* @param maxDB A fixed point representation of the db value matching maxValue
* @param channelID The ID of the channel(s) that the control acts on. Common IDs are located in IOAudioTypes.h.
* @param channelName An optional name for the channel. Common names are located in IOAudioTypes.h.
* @param cntrlID An optional ID for the control that can be used to uniquely identify controls.
* @result Returns a newly allocted and initialized level IOAudioControl
*/
static IOAudioLevelControl *create(SInt32 initialValue,
SInt32 minValue,
SInt32 maxValue,
IOFixed minDB,
IOFixed maxDB,
UInt32 channelID,
const char *channelName = 0,
UInt32 cntrlID = 0,
UInt32 subType = 0,
UInt32 usage = 0);
static IOAudioLevelControl *createVolumeControl(SInt32 initialValue,
SInt32 minValue,
SInt32 maxValue,
IOFixed minDB,
IOFixed maxDB,
UInt32 channelID,
const char *channelName = 0,
UInt32 cntrlID = 0,
UInt32 usage = 0);
/*!
* @function init
* @abstract Initializes a newly allocated IOAudioLevelControl with the given attributes
* @param initialValue The initial value of the control
* @param minValue The lowest possible value the control may have
* @param maxValue The highest possible value the control may have
* @param minDB A fixed point representation of the db value matching minValue
* @param maxDB A fixed point representation of the db value matching maxValue
* @param channelID The ID of the channel(s) that the control acts on. Common IDs are located in IOAudioTypes.h.
* @param channelName An optional name for the channel. Common names are located in IOAudioTypes.h.
* @param cntrlID An optional ID for the control that can be used to uniquely identify controls.
* @param properties Standard property list passed to the init() function of any new IOService. This dictionary
* gets stored in the registry entry for this service.
* @result Returns true on success
*/
virtual bool init(SInt32 initialValue,
SInt32 minValue,
SInt32 maxValue,
IOFixed minDB,
IOFixed maxDB,
UInt32 channelID,
const char *channelName = 0,
UInt32 cntrlID = 0,
UInt32 subType = 0,
UInt32 usage = 0,
OSDictionary *properties = 0);
virtual void free();
/*!
* @function setMinValue
* @abstract Sets the minimum value the control may have
* @param minValue The minimum value for the control
*/
virtual void setMinValue(SInt32 minValue);
virtual SInt32 getMinValue();
/*!
* @function setMaxValue
* @abstract Sets the maximum value the control may have
* @param maxValue The maximum value for the control
*/
virtual void setMaxValue(SInt32 maxValue);
virtual SInt32 getMaxValue();
/*!
* @function setMinDB
* @abstract Sets the minimum value in db that the control may have
* @discussion This value is represented as an IOFixed value which is a fixed point number. The IOFixed
* type is a 16.16 fixed point value.
* @param minDB The minimum value in db for the control
*/
virtual void setMinDB(IOFixed minDB);
virtual IOFixed getMinDB();
/*!
* @function setMaxDB
* @abstract Sets the maximum value in db that the control may have
* @discussion This value is represented as an IOFixed value which is a fixed point number. The IOFixed
* type is a 16.16 fixed point value.
* @param maxDB The maximum value in db for the control
*/
virtual void setMaxDB(IOFixed maxDB);
virtual IOFixed getMaxDB();
virtual IOReturn addRange(SInt32 minValue, SInt32 maxValue, IOFixed minDB, IOFixed maxDB);
virtual IOReturn addNegativeInfinity(SInt32 negativeInfinityValue);
virtual IOReturn validateValue(OSObject *newValue);
};
#endif /* _IOKIT_IOAUDIOLEVELCONTROL_H */