-
Notifications
You must be signed in to change notification settings - Fork 3
/
listing5.html
executable file
·437 lines (376 loc) · 15.8 KB
/
listing5.html
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>SampleUSBAudioPlugin - /SampleUSBAudioPlugin.cpp</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/Darwin/index.html">Darwin</a> > <a href="../../samplecode/Darwin/idxHardwareDrivers-date.html">Hardware & Drivers</a> > <A HREF="javascript:location.replace('index.html');">SampleUSBAudioPlugin</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">SampleUSBAudioPlugin</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/SampleUSBAudioPlugin.cpp</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/AppleUSBAudioPlugin.h</option>
<option value="listing2.html">/ProcessFloatSamples.cpp</option>
<option value="listing3.html">/ProcessFloatSamples.h</option>
<option value="listing4.html">/Readme.txt</option>
<option value="listing5.html">/SampleUSBAudioPlugin.cpp</option>
<option value="listing6.html">/SampleUSBAudioPlugin.h</option></select>
</p>
</form>
<p><strong><a href="SampleUSBAudioPlugin.zip">Download Sample</a></strong> (“SampleUSBAudioPlugin.zip”, 17.3K)<BR>
<strong><a href="SampleUSBAudioPlugin.dmg">Download Sample</a></strong> (“SampleUSBAudioPlugin.dmg”, 70.9K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
* File: SampleUSBAudioPlugin.cpp
*
* Contains: com_MySoftwareCompany_driver_SampleUSBAudioPlugin Implementation
*
* A simple USB audio plug-in that performs a lowpass filtering operation on audio streamed
* through the Griffin iMic. The target SampleUSBAudioPlugin.kext must be copied to the
* /System/Library/Extensions folder of the boot volume by an administrator using a
* command like (from the project folder):
*
* sudo cp -rf ./build/SampleUSBAudioPlugin.kext /System/Library/Extensions
*
* Then you must notify the operating system that the contents of the kernel extension directory has
* changed by "touching the directory":
*
* sudo touch /System/Library/Extensions
*
* Restart the system.
*
* After restarting the system, the plug-in should automatically load when the device
* specified in the Info.plist is plugged in. Plug-in logging can be observed by viewing
* the system log using Console in /Applications/Utilities.
*
*
* Version: 1.0
*
* Created: 11-23-2004
*
* © Copyright 2004 Apple Computer, Inc. All rights reserved.
*
* Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Computer, 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 Computer, 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.
*
*/
#include <IOKit/IOLib.h>
#include "SampleUSBAudioPlugin.h"
#define super AppleUSBAudioPlugin
OSDefineMetaClassAndStructors (com_MySoftwareCompany_driver_SampleUSBAudioPlugin, AppleUSBAudioPlugin);
// AppleUSBAudioPlugin methods
/*****************************************************
*
* com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginInit (IOService * provider, UInt16 vendorID, UInt16 productID)
*
* Purpose:
*
* Inputs: provider - AppleUSBAudioEngine object associated with device
* vendorID - idVendor
* productID - idProduct
*
* Returns: IOReturn result - (0 == no error)
*/
IOReturn com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginInit (IOService * provider, UInt16 vendorID, UInt16 productID)
{
IOReturn result;
//IOUSBDevRequest myRequest;
// Init our superclass first
result = super::pluginInit (provider, vendorID, productID);
#warning Change the idVendor & idProduct here (and in Info.plist) to match the audio device you want to use!
// Double check that we're loaded on the device that we want to be;
if (vendorID != 0x5FC || productID != 0x7849)
{
//NOTE: Avoid logging this type of information (idVendor, idProduct) in a released product
//The plug-in should fail silently, if the incorrect (idVendor, idProduct) is given.
//Only log this type of information during development!
//IOLog ("vendorID = %u, productID = %u", vendorID, productID);
return kIOReturnNoDevice;
}
/* pluginDeviceRequest is not used in this example, but it could be implemented here if there were a need to communicate
directly to the USB audio hardware. More information on device requests can be found at http://developer.apple.com/devicedrivers/ .
As defined in IOKit/usb/USB.h
typedef struct {
UInt8 bmRequestType;
UInt8 bRequest;
UInt16 wValue;
UInt16 wIndex;
UInt16 wLength;
void * pData;
UInt32 wLenDone;
} IOUSBDevRequest;
*/
// Prepare to make the device request
/*
theData = IOMalloc (4);
if (!theData)
{
return kIOReturnNoMemory;
}
myRequest.bmRequestType = ;
myRequest.bRequest = ;
myRequest.wValue = ;
myRequest.wIndex = ;
myRequest.wLength = ;
myRequest.pData = theData;
result = pluginDeviceRequest (&myRequest);
*/
if (result == kIOReturnSuccess)
{
// Do our one time initialization
IOLog ("com_MySoftwareCompany_driver_SampleUSBAudioPlugin initialized successfully\n");
/* Just initialize to some random values to verify that pluginSetFormat is working.
These values should be overwritten by the device's actual format when pluginSetFormat is called. */
mSampleRate = 44101;
mNumChannels = 3;
setProcessingParameters (&mParamStruct, mSampleRate, mNumChannels);
}
return result;
}
/*****************************************************
*
* com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginStart ()
*
* Purpose: Start processing audio
*
* Inputs: (void)
*
* Returns: IOReturn result - (0 == no error)
*/
IOReturn com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginStart ()
{
IOReturn result;
// Start our superclass first
result = super::pluginStart ();
if (result == kIOReturnSuccess)
{
// Do our every time initialization
resetProcessingState (&mStateStruct);
IOLog ("com_MySoftwareCompany_driver_SampleUSBAudioPlugin starting.\n");
}
return result;
}
/*****************************************************
*
* com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginReset ()
*
* Purpose: Reset processing parameters and state.
*
* Inputs: (void)
*
* Returns: IOReturn result - (0 == no error)
*/
IOReturn com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginReset ()
{
IOReturn result;
IOLog ("com_MySoftwareCompany_driver_SampleUSBAudioPlugin resetting...\n");
// Reset the plugin's state
setProcessingParameters (&mParamStruct, mSampleRate, mNumChannels);
resetProcessingState (&mStateStruct);
// No need to call super::pluginReset
result = kIOReturnSuccess;
return result;
}
/*****************************************************
*
* com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginSetFormat(const IOAudioStreamFormat * const newFormat, const IOAudioSampleRate * const newSampleRate)
*
* Purpose: Changes the current audio stream format
*
* Inputs: newFormat - new audio stream format
* newSampleRate- new sample rate
*
* Returns: IOReturn result - (0 == no error)
*/
IOReturn com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginSetFormat (const IOAudioStreamFormat * const newFormat, const IOAudioSampleRate * const newSampleRate)
{
IOReturn result;
IOLog ("com_MySoftwareCompany_driver_SampleUSBAudioPlugin changing format\n");
// If parameters depend on sample rate or number of channels (or other format info), update them here
if (NULL != newSampleRate)
{
mSampleRate = newSampleRate->whole;
}
if (NULL != newFormat)
{
mNumChannels = newFormat->fNumChannels;
}
setProcessingParameters (&mParamStruct, mSampleRate, mNumChannels);
IOLog ("mSampleRate = %ld, mNumChannels = %ld\n", mSampleRate, mNumChannels);
// No need to call super::pluginProcess
result = kIOReturnSuccess;
return result;
}
/*****************************************************
*
* com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginProcess (float * mixBuf, UInt32 numSampleFrames, UInt32 numChannels)
*
* Purpose: Calls processSamples() (low pass filter) to process audio data
*
* Inputs: mixBuf - pointer to the mixed buffer samples
* numSampleFrames - number of sample frames in mixed buffer
* numChannels - number of channels that are interleaved in the mixed buffer
*
* Returns: IOReturn result - (kIOReturnSuccess == no error)
*/
IOReturn com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginProcess (float * mixBuf, UInt32 numSampleFrames, UInt32 numChannels)
{
IOReturn result;
// Do our data processing methods
if ( (mSampleRate == 44100)
&& (mNumChannels <= 2))
{
processSamples (mixBuf, numSampleFrames, numChannels, &mParamStruct, &mStateStruct);
}
// No need to call super::pluginProcess
result = kIOReturnSuccess;
return result;
}
/*****************************************************
*
* com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginStop ()
*
* Purpose: Start processing audio
*
* Inputs: (void)
*
* Returns: IOReturn result - (0 == no error)
*/
IOReturn com_MySoftwareCompany_driver_SampleUSBAudioPlugin::pluginStop ()
{
IOReturn result;
// Do our stop work first, then call super
IOLog ("com_MySoftwareCompany_driver_SampleUSBAudioPlugin stopping.\n");
pluginReset ();
result = super::pluginStop ();
return result;
}
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/SampleUSBAudioPlugin/listing5.html%3Fid%3DDTS10003471-1.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/SampleUSBAudioPlugin/listing5.html%3Fid%3DDTS10003471-1.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/SampleUSBAudioPlugin/listing5.html%3Fid%3DDTS10003471-1.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>