CodecIBXM (Forge-1.12.2-14.23.5.2854)

java.lang.Object
- paulscode.sound.codecs.CodecIBXM

All Implemented Interfaces:

paulscode.sound.ICodec
```
public class CodecIBXM
extends java.lang.Object
implements paulscode.sound.ICodec
```
The CodecIBXM class provides an ICodec interface for reading from MOD/S3M/XM files via the IBXM library. SoundSystem CodecIBXM Class License:

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:
1) You may not falsely claim to be the author of this class or any unmodified portion of it.
2) You may not copyright this class or a modified version of it and then sue me for copyright infringement.
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.
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
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.
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.

Author: Paul Lamb
http://www.paulscode.com

This software is based on or using the IBXM library available from http://www.geocities.com/sunet2000/

IBXM is copyright (c) 2007, Martin Cameron, and is licensed under the BSD License.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

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.

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.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`endOfStream` True if there is no more data to read in.
`private static boolean`	`GET` Used to return a current value from one of the synchronized boolean-interface methods.
`private IBXM`	`ibxm` IBXM decoder.
`private boolean`	`initialized` True if the stream has finished initializing.
`private paulscode.sound.SoundSystemLogger`	`logger` Processes status messages, warnings, and error messages.
`private Module`	`module` Module instance to be played.
`private javax.sound.sampled.AudioFormat`	`myAudioFormat` Format the converted audio will be in.
`private int`	`playPosition` Audio read position (in frames).
`private boolean`	`reverseBytes` True if the using library requires data read by this codec to be reverse-ordered before returning it from methods read() and readAll().
`private static boolean`	`SET` Used to set the value in one of the synchronized boolean-interface methods.
`private int`	`songDuration` Duration of the audio (in frames).
`private static boolean`	`XXX` Used when a parameter for one of the synchronized boolean-interface methods is not aplicable.

Constructor Summary

Constructors
Constructor and Description

CodecIBXM()
Constructor: Grabs a handle to the logger.

Constructors
Constructor and Description
`CodecIBXM()` Constructor: Grabs a handle to the logger.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private static byte[]`	`appendByteArrays(byte[] arrayOne, byte[] arrayTwo, int length)` Creates a new array with the second array appended to the end of the first array.
`void`	`cleanup()` Closes the audio stream and remove references to all instantiated objects.
`private static byte[]`	`convertAudioBytes(byte[] audio_bytes, boolean two_bytes_data)` Converts sound bytes to little-endian format.
`boolean`	`endOfStream()` Returns false if there is still more data available to be read in.
`private boolean`	`endOfStream(boolean action, boolean value)` Internal method for synchronizing access to the boolean 'endOfStream'.
`private void`	`errorMessage(java.lang.String message)` Prints an error message.
`javax.sound.sampled.AudioFormat`	`getAudioFormat()` Returns the audio format of the data being returned by the read() and readAll() methods.
`boolean`	`initialize(java.net.URL url)` Prepares an audio stream to read from.
`boolean`	`initialized()` Returns false if the stream is busy initializing.
`private boolean`	`initialized(boolean action, boolean value)` Internal method for synchronizing access to the boolean 'initialized'.
`private static Module`	`loadModule(java.io.InputStream input)` Decodes the data in the specified InputStream into an instance of ibxm.Module.
`private void`	`printStackTrace(java.lang.Exception e)` Prints an exception's error message followed by the stack trace.
`paulscode.sound.SoundBuffer`	`read()` Reads in one stream buffer worth of audio data.
`paulscode.sound.SoundBuffer`	`readAll()` Reads in all the audio data from the stream (up to the default "maximum file size".
`void`	`reverseByteOrder(boolean b)` Tells this codec when it will need to reverse the byte order of the data before returning it in the read() and readAll() methods.
`static void`	`reverseBytes(byte[] buffer)` Reverse-orders all bytes contained in the specified array.
`static void`	`reverseBytes(byte[] buffer, int offset, int size)` Reverse-orders the specified range of bytes contained in the specified array.
`private void`	`setModule(Module m)` Sets the Module instance to be played.
`private static byte[]`	`trimArray(byte[] array, int maxLength)` Trims down the size of the array if it is larger than the specified maximum length.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GET
```
private static final boolean GET
```
    Used to return a current value from one of the synchronized boolean-interface methods.
    
    See Also:
    
    Constant Field Values
  - SET
```
private static final boolean SET
```
    Used to set the value in one of the synchronized boolean-interface methods.
    
    See Also:
    
    Constant Field Values
  - XXX
```
private static final boolean XXX
```
    Used when a parameter for one of the synchronized boolean-interface methods is not aplicable.
    
    See Also:
    
    Constant Field Values
  - endOfStream
```
private boolean endOfStream
```
    True if there is no more data to read in.
  - initialized
```
private boolean initialized
```
    True if the stream has finished initializing.
  - myAudioFormat
```
private javax.sound.sampled.AudioFormat myAudioFormat
```
    Format the converted audio will be in.
  - reverseBytes
```
private boolean reverseBytes
```
    True if the using library requires data read by this codec to be reverse-ordered before returning it from methods read() and readAll().
  - ibxm
```
private IBXM ibxm
```
    IBXM decoder.
  - module
```
private Module module
```
    Module instance to be played.
  - songDuration
```
private int songDuration
```
    Duration of the audio (in frames).
  - playPosition
```
private int playPosition
```
    Audio read position (in frames).
  - logger
```
private paulscode.sound.SoundSystemLogger logger
```
    Processes status messages, warnings, and error messages.
- Constructor Detail
  - CodecIBXM
```
public CodecIBXM()
```
    Constructor: Grabs a handle to the logger.
- Method Detail
  - reverseByteOrder
```
public void reverseByteOrder(boolean b)
```
    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.
    
    Specified by:
    
    reverseByteOrder in interface paulscode.sound.ICodec
    
    Parameters:
    
    b - True if the calling audio library requires byte-reversal.
  - initialize
```
public boolean initialize(java.net.URL url)
```
    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.
    
    Specified by:
    
    initialize in interface paulscode.sound.ICodec
    
    Parameters:
    
    url - URL to an audio file to stream from.
    
    Returns:
    
    False if an error occurred or if end of stream was reached.
  - initialized
```
public boolean initialized()
```
    Returns false if the stream is busy initializing.
    
    Specified by:
    
    initialized in interface paulscode.sound.ICodec
    
    Returns:
    
    True if steam is initialized.
  - read
```
public paulscode.sound.SoundBuffer read()
```
    Reads in one stream buffer worth of audio data. See SoundSystemConfig for more information about accessing and changing default settings.
    
    Specified by:
    
    read in interface paulscode.sound.ICodec
    
    Returns:
    
    The audio data wrapped into a SoundBuffer context.
  - readAll
```
public paulscode.sound.SoundBuffer readAll()
```
    Reads in all the audio data from the stream (up to the default "maximum file size". See SoundSystemConfig for more information about accessing and changing default settings.
    
    Specified by:
    
    readAll in interface paulscode.sound.ICodec
    
    Returns:
    
    the audio data wrapped into a SoundBuffer context.
  - endOfStream
```
public boolean endOfStream()
```
    Returns false if there is still more data available to be read in.
    
    Specified by:
    
    endOfStream in interface paulscode.sound.ICodec
    
    Returns:
    
    True if end of stream was reached.
  - cleanup
```
public void cleanup()
```
    Closes the audio stream and remove references to all instantiated objects.
    
    Specified by:
    
    cleanup in interface paulscode.sound.ICodec
  - getAudioFormat
```
public javax.sound.sampled.AudioFormat getAudioFormat()
```
    Returns the audio format of the data being returned by the read() and readAll() methods.
    
    Specified by:
    
    getAudioFormat in interface paulscode.sound.ICodec
    
    Returns:
    
    Information wrapped into an AudioFormat context.
  - loadModule
```
private static Module loadModule(java.io.InputStream input)
                          throws java.lang.IllegalArgumentException,
                                 java.io.IOException
```
    Decodes the data in the specified InputStream into an instance of ibxm.Module.
    
    Parameters:
    
    input - an InputStream containing the module file to be decoded.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the data is not recognised as a module file.
    
    java.io.IOException
  - setModule
```
private void setModule(Module m)
```
    Sets the Module instance to be played.
  - initialized
```
private boolean initialized(boolean action,
                            boolean value)
```
    Internal method for synchronizing access to the boolean 'initialized'.
    
    Parameters:
    
    action - GET or SET.
    
    value - New value if action == SET, or XXX if action == GET.
    
    Returns:
    
    True if steam is initialized.
  - endOfStream
```
private boolean endOfStream(boolean action,
                            boolean value)
```
    Internal method for synchronizing access to the boolean 'endOfStream'.
    
    Parameters:
    
    action - GET or SET.
    
    value - New value if action == SET, or XXX if action == GET.
    
    Returns:
    
    True if end of stream was reached.
  - trimArray
```
private static byte[] trimArray(byte[] array,
                                int maxLength)
```
    Trims down the size of the array if it is larger than the specified maximum length.
    
    Parameters:
    
    array - Array containing audio data.
    
    maxLength - Maximum size this array may be.
    
    Returns:
    
    New array.
  - reverseBytes
```
public static void reverseBytes(byte[] buffer)
```
    Reverse-orders all bytes contained in the specified array.
    
    Parameters:
    
    buffer - Array containing audio data.
  - reverseBytes
```
public static void reverseBytes(byte[] buffer,
                                int offset,
                                int size)
```
    Reverse-orders the specified range of bytes contained in the specified array.
    
    Parameters:
    
    buffer - Array containing audio data.
    
    offset - Array index to begin.
    
    size - number of bytes to reverse-order.
  - convertAudioBytes
```
private static byte[] convertAudioBytes(byte[] audio_bytes,
                                        boolean two_bytes_data)
```
    Converts sound bytes to little-endian format.
    
    Parameters:
    
    audio_bytes - The original wave data
    
    two_bytes_data - For stereo sounds.
    
    Returns:
    
    byte array containing the converted data.
  - appendByteArrays
```
private static byte[] appendByteArrays(byte[] arrayOne,
                                       byte[] arrayTwo,
                                       int length)
```
    Creates a new array with the second array appended to the end of the first array.
    
    Parameters:
    
    arrayOne - The first array.
    
    arrayTwo - The second array.
    
    length - How many bytes to append from the second array.
    
    Returns:
    
    Byte array containing information from both arrays.
  - errorMessage
```
private void errorMessage(java.lang.String message)
```
    Prints an error message.
    
    Parameters:
    
    message - Message to print.
  - printStackTrace
```
private void printStackTrace(java.lang.Exception e)
```
    Prints an exception's error message followed by the stack trace.
    
    Parameters:
    
    e - Exception containing the information to print.

Class CodecIBXM

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GET

SET

XXX

endOfStream

initialized

myAudioFormat

reverseBytes

ibxm

module

songDuration

playPosition

logger

Constructor Detail

CodecIBXM

Method Detail

reverseByteOrder

initialize

initialized

read

readAll

endOfStream

cleanup

getAudioFormat

loadModule

setModule

initialized

endOfStream

trimArray

reverseBytes

reverseBytes

convertAudioBytes

appendByteArrays

errorMessage

printStackTrace