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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_65) on Thu Feb 05 20:10:18 EST 2015 -->
<title>CodecIBXM (Forge API)</title>
<meta name="date" content="2015-02-05">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CodecIBXM (Forge API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?paulscode/sound/codecs/CodecIBXM.html" target="_top">Frames</a></li>
<li><a href="CodecIBXM.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">paulscode.sound.codecs</div>
<h2 title="Class CodecIBXM" class="title">Class CodecIBXM</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>paulscode.sound.codecs.CodecIBXM</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>paulscode.sound.ICodec</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">CodecIBXM</span>
extends java.lang.Object
implements paulscode.sound.ICodec</pre>
<div class="block">The CodecIBXM class provides an ICodec interface for reading from MOD/S3M/XM
files via the IBXM library.
<b><i> SoundSystem CodecIBXM Class License:</b></i><br><b><br>
You are free to use this class for any purpose, commercial or otherwise.
You may modify this class or source code, and distribute it any way you
like, provided the following conditions are met:
<br>
1) You may not falsely claim to be the author of this class or any
unmodified portion of it.
<br>
2) You may not copyright this class or a modified version of it and then
sue me for copyright infringement.
<br>
3) If you modify the source code, you must clearly document the changes
made before redistributing the modified source code, so other users know
it is not the original code.
<br>
4) You are not required to give me credit for this class in any derived
work, but if you do, you must also mention my website:
http://www.paulscode.com
<br>
5) I the author will not be responsible for any damages (physical,
financial, or otherwise) caused by the use if this class or any portion
of it.
<br>
6) I the author do not guarantee, warrant, or make any representations,
either expressed or implied, regarding the use of this class or any
portion of it.
<br><br>
Author: Paul Lamb
<br>
http://www.paulscode.com
</b><br><br>
<b>
This software is based on or using the IBXM library available from
http://www.geocities.com/sunet2000/
</b><br><br>
<br><b>
IBXM is copyright (c) 2007, Martin Cameron, and is licensed under the BSD
License.
<br><br>
All rights reserved.
<br><br>
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
<br><br>
Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer. Redistributions in binary
form must reproduce the above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or other materials
provided with the distribution. Neither the name of mumart nor the names of
its contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
<br><br>
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
<br><br><br></b></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#CodecIBXM()">CodecIBXM</a></strong>()</code>
<div class="block">Constructor: Grabs a handle to the logger.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#cleanup()">cleanup</a></strong>()</code>
<div class="block">Closes the audio stream and remove references to all instantiated objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#endOfStream()">endOfStream</a></strong>()</code>
<div class="block">Returns false if there is still more data available to be read in.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>javax.sound.sampled.AudioFormat</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#getAudioFormat()">getAudioFormat</a></strong>()</code>
<div class="block">Returns the audio format of the data being returned by the read() and
readAll() methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#initialize(java.net.URL)">initialize</a></strong>(java.net.URL url)</code>
<div class="block">Prepares an audio stream to read from.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#initialized()">initialized</a></strong>()</code>
<div class="block">Returns false if the stream is busy initializing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>paulscode.sound.SoundBuffer</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#read()">read</a></strong>()</code>
<div class="block">Reads in one stream buffer worth of audio data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>paulscode.sound.SoundBuffer</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#readAll()">readAll</a></strong>()</code>
<div class="block">Reads in all the audio data from the stream (up to the default
"maximum file size".</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#reverseByteOrder(boolean)">reverseByteOrder</a></strong>(boolean b)</code>
<div class="block">Tells this codec when it will need to reverse the byte order of
the data before returning it in the read() and readAll() methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#reverseBytes(byte[])">reverseBytes</a></strong>(byte[] buffer)</code>
<div class="block">Reverse-orders all bytes contained in the specified array.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../paulscode/sound/codecs/CodecIBXM.html#reverseBytes(byte[],%20int,%20int)">reverseBytes</a></strong>(byte[] buffer,
int offset,
int size)</code>
<div class="block">Reverse-orders the specified range of bytes contained in the specified array.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CodecIBXM()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CodecIBXM</h4>
<pre>public CodecIBXM()</pre>
<div class="block">Constructor: Grabs a handle to the logger.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="reverseByteOrder(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reverseByteOrder</h4>
<pre>public void reverseByteOrder(boolean b)</pre>
<div class="block">Tells this codec when it will need to reverse the byte order of
the data before returning it in the read() and readAll() methods. The
IBXM library produces audio data in a format that some external audio
libraries require to be reversed. Derivatives of the Library and Source
classes for audio libraries which require this type of data to be reversed
will call the reverseByteOrder() method.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>reverseByteOrder</code> in interface <code>paulscode.sound.ICodec</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - True if the calling audio library requires byte-reversal.</dd></dl>
</li>
</ul>
<a name="initialize(java.net.URL)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public boolean initialize(java.net.URL url)</pre>
<div class="block">Prepares an audio stream to read from. If another stream is already opened,
it will be closed and a new audio stream opened in its place.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>initialize</code> in interface <code>paulscode.sound.ICodec</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - URL to an audio file to stream from.</dd>
<dt><span class="strong">Returns:</span></dt><dd>False if an error occurred or if end of stream was reached.</dd></dl>
</li>
</ul>
<a name="initialized()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialized</h4>
<pre>public boolean initialized()</pre>
<div class="block">Returns false if the stream is busy initializing.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>initialized</code> in interface <code>paulscode.sound.ICodec</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>True if steam is initialized.</dd></dl>
</li>
</ul>
<a name="read()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>read</h4>
<pre>public paulscode.sound.SoundBuffer read()</pre>
<div class="block">Reads in one stream buffer worth of audio data. See
<code>SoundSystemConfig</code> for more
information about accessing and changing default settings.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>read</code> in interface <code>paulscode.sound.ICodec</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The audio data wrapped into a SoundBuffer context.</dd></dl>
</li>
</ul>
<a name="readAll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readAll</h4>
<pre>public paulscode.sound.SoundBuffer readAll()</pre>
<div class="block">Reads in all the audio data from the stream (up to the default
"maximum file size". See
<code>SoundSystemConfig</code> for more
information about accessing and changing default settings.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>readAll</code> in interface <code>paulscode.sound.ICodec</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the audio data wrapped into a SoundBuffer context.</dd></dl>
</li>
</ul>
<a name="endOfStream()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endOfStream</h4>
<pre>public boolean endOfStream()</pre>
<div class="block">Returns false if there is still more data available to be read in.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>endOfStream</code> in interface <code>paulscode.sound.ICodec</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>True if end of stream was reached.</dd></dl>
</li>
</ul>
<a name="cleanup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanup</h4>
<pre>public void cleanup()</pre>
<div class="block">Closes the audio stream and remove references to all instantiated objects.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>cleanup</code> in interface <code>paulscode.sound.ICodec</code></dd>
</dl>
</li>
</ul>
<a name="getAudioFormat()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAudioFormat</h4>
<pre>public javax.sound.sampled.AudioFormat getAudioFormat()</pre>
<div class="block">Returns the audio format of the data being returned by the read() and
readAll() methods.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getAudioFormat</code> in interface <code>paulscode.sound.ICodec</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>Information wrapped into an AudioFormat context.</dd></dl>
</li>
</ul>
<a name="reverseBytes(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reverseBytes</h4>
<pre>public static void reverseBytes(byte[] buffer)</pre>
<div class="block">Reverse-orders all bytes contained in the specified array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - Array containing audio data.</dd></dl>
</li>
</ul>
<a name="reverseBytes(byte[], int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reverseBytes</h4>
<pre>public static void reverseBytes(byte[] buffer,
int offset,
int size)</pre>
<div class="block">Reverse-orders the specified range of bytes contained in the specified array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - Array containing audio data.</dd><dd><code>offset</code> - Array index to begin.</dd><dd><code>size</code> - number of bytes to reverse-order.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?paulscode/sound/codecs/CodecIBXM.html" target="_top">Frames</a></li>
<li><a href="CodecIBXM.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|
