summaryrefslogtreecommitdiff
path: root/libs/appleutility/CoreAudio/AudioCodecs/ACPublic/ACCodecDispatchTypes.h
blob: 1969d744da8ca95b8e1d514f8825f7d34edeb71c (plain)
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
/*
     File: ACCodecDispatchTypes.h
 Abstract: Part of CoreAudio Utility Classes
  Version: 1.1

 Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple
 Inc. ("Apple") in consideration of your agreement to the following
 terms, and your use, installation, modification or redistribution of
 this Apple software constitutes acceptance of these terms.  If you do
 not agree with these terms, please do not use, install, modify or
 redistribute this Apple software.

 In consideration of your agreement to abide by the following terms, and
 subject to these terms, Apple grants you a personal, non-exclusive
 license, under Apple's copyrights in this original Apple software (the
 "Apple Software"), to use, reproduce, modify and redistribute the Apple
 Software, with or without modifications, in source and/or binary forms;
 provided that if you redistribute the Apple Software in its entirety and
 without modifications, you must retain this notice and the following
 text and disclaimers in all such redistributions of the Apple Software.
 Neither the name, trademarks, service marks or logos of Apple Inc. may
 be used to endorse or promote products derived from the Apple Software
 without specific prior written permission from Apple.  Except as
 expressly stated in this notice, no other rights or licenses, express or
 implied, are granted by Apple herein, including but not limited to any
 patent rights that may be infringed by your derivative works or by other
 works in which the Apple Software may be incorporated.

 The Apple Software is provided by Apple on an "AS IS" basis.  APPLE
 MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
 THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
 FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
 OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

 IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
 MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
 AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
 STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.

 Copyright (C) 2014 Apple Inc. All Rights Reserved.

*/
#if !defined(__ACCodecDispatchTypes_h__)
#define __ACCodecDispatchTypes_h__

//=============================================================================
//	Includes
//=============================================================================

//	note that AudioCodec.h needs to be included prior to including this file
#if !defined(__AudioCodec_h__)
	#error	AudioCodec.h needs to be included prior to including this file
#endif

//=============================================================================
//	Parameter Blocks for AudioCodec Component Routines
//
//	Note that the arguments for all the AudioCodec component routines are
//	4 bytes in size (assuming pointers are 4 bytes). This means that even on
//	Windows (where all arguments are forced into SInt32s), we can get away with
//	mass casting the argument list through the appropriate paramblock structure.
//	This gets around the fact that the component glue passes the arguments in
//	a different order depending on the platform and therefore makes writing the
//	 calling glue and the dispatcher much simpler.
//=============================================================================

#if PRAGMA_STRUCT_ALIGN
	#pragma options align=mac68k
#elif PRAGMA_STRUCT_PACKPUSH
	#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
	#pragma pack(2)
#endif

#define	AudioCodecStandardGluePBFields	UInt8 componentFlags; UInt8 componentParamSize; SInt16 componentWhat

#if	!TARGET_OS_WIN32
struct AudioCodecOpenGluePB {
	AudioCodecStandardGluePBFields;
	AudioCodec						inCodec;
	void*							unused;
};
#else
struct AudioCodecOpenGluePB {
	AudioCodecStandardGluePBFields;
	AudioCodec						inCodec;
};
#endif
typedef struct AudioCodecOpenGluePB	AudioCodecOpenGluePB;

#if	!TARGET_OS_WIN32
struct AudioCodecGetPropertyInfoGluePB
{
	AudioCodecStandardGluePBFields;
	Boolean*						outWritable;
	UInt32*							outSize;
	AudioCodecPropertyID			inPropertyID;
	AudioCodec						inCodec;
};
#else
struct AudioCodecGetPropertyInfoGluePB
{
	AudioCodecStandardGluePBFields;
	AudioCodecPropertyID			inPropertyID;
	UInt32*							outSize;
	Boolean*						outWritable;
};
#endif
typedef struct AudioCodecGetPropertyInfoGluePB	AudioCodecGetPropertyInfoGluePB;

#if	!TARGET_OS_WIN32
struct AudioCodecGetPropertyGluePB
{
	AudioCodecStandardGluePBFields;
	void*							outPropertyData;
	UInt32*							ioPropertyDataSize;
	AudioCodecPropertyID			inPropertyID;
	AudioCodec						inCodec;
};
#else
struct AudioCodecGetPropertyGluePB
{
	AudioCodecStandardGluePBFields;
	AudioCodecPropertyID			inPropertyID;
	UInt32*							ioPropertyDataSize;
	void*							outPropertyData;
};
#endif
typedef struct AudioCodecGetPropertyGluePB	AudioCodecGetPropertyGluePB;

#if	!TARGET_OS_WIN32
struct AudioCodecSetPropertyGluePB
{
	AudioCodecStandardGluePBFields;
	const void*						inPropertyData;
	UInt32							inPropertyDataSize;
	AudioCodecPropertyID			inPropertyID;
	AudioCodec						inCodec;
};
#else
struct AudioCodecSetPropertyGluePB
{
	AudioCodecStandardGluePBFields;
	AudioCodecPropertyID			inPropertyID;
	UInt32							inPropertyDataSize;
	const void*						inPropertyData;
};
#endif
typedef struct AudioCodecSetPropertyGluePB	AudioCodecSetPropertyGluePB;

#if	!TARGET_OS_WIN32
struct AudioCodecInitializeGluePB
{
	AudioCodecStandardGluePBFields;
	UInt32								inMagicCookieByteSize;
	const void*							inMagicCookie;
	const AudioStreamBasicDescription*	inOutputFormat;
	const AudioStreamBasicDescription*	inInputFormat;
	AudioCodec							inCodec;
};
#else
struct AudioCodecInitializeGluePB
{
	AudioCodecStandardGluePBFields;
	const AudioStreamBasicDescription*	inInputFormat;
	const AudioStreamBasicDescription*	inOutputFormat;
	const void*							inMagicCookie;
	UInt32								inMagicCookieByteSize;
};
#endif
typedef struct AudioCodecInitializeGluePB	AudioCodecInitializeGluePB;

#if	!TARGET_OS_WIN32
struct AudioCodecUninitializeGluePB
{
	AudioCodecStandardGluePBFields;
	AudioCodec						inCodec;
};
#else
struct AudioCodecUninitializeGluePB
{
	AudioCodecStandardGluePBFields;
};
#endif
typedef struct AudioCodecUninitializeGluePB	AudioCodecUninitializeGluePB;

#if	!TARGET_OS_WIN32
struct AudioCodecAppendInputDataGluePB
{
	AudioCodecStandardGluePBFields;
	const AudioStreamPacketDescription*	inPacketDescription;
	UInt32*								ioNumberPackets;
	UInt32*								ioInputDataByteSize;
	const void*							inInputData;
	AudioCodec							inCodec;
};
#else
struct AudioCodecAppendInputDataGluePB
{
	AudioCodecStandardGluePBFields;
	const void*							inInputData;
	UInt32*								ioInputDataByteSize;
	UInt32*								ioNumberPackets;
	const AudioStreamPacketDescription*	inPacketDescription;
};
#endif
typedef struct AudioCodecAppendInputDataGluePB	AudioCodecAppendInputDataGluePB;

#if	!TARGET_OS_WIN32
struct AudioCodecProduceOutputPacketsGluePB
{
	AudioCodecStandardGluePBFields;
	UInt32*							outStatus;
	AudioStreamPacketDescription*	outPacketDescription;
	UInt32*							ioNumberPackets;
	UInt32*							ioOutputDataByteSize;
	void*							outOutputData;
	AudioCodec						inCodec;
};
#else
struct AudioCodecProduceOutputPacketsGluePB
{
	AudioCodecStandardGluePBFields;
	void*							outOutputData;
	UInt32*							ioOutputDataByteSize;
	UInt32*							ioNumberPackets;
	AudioStreamPacketDescription*	outPacketDescription;
	UInt32*							outStatus;
};
#endif
typedef struct AudioCodecProduceOutputPacketsGluePB	AudioCodecProduceOutputPacketsGluePB;

#if	!TARGET_OS_WIN32
struct AudioCodecResetGluePB
{
	AudioCodecStandardGluePBFields;
	AudioCodec						inCodec;
};
#else
struct AudioCodecResetGluePB
{
	AudioCodecStandardGluePBFields;
};
#endif
typedef struct AudioCodecResetGluePB	AudioCodecResetGluePB;

#if PRAGMA_STRUCT_ALIGN
	#pragma options align=reset
#elif PRAGMA_STRUCT_PACKPUSH
	#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
	#pragma pack()
#endif

#endif