CodecJLayerMP3 (Etyl Commons 1.0.2 API)

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

All Implemented Interfaces:

ICodec
```
public class CodecJLayerMP3
extends Object
implements ICodec
```
The CodecJLayer class provides an ICodec interface to the external JLayer library.

This software is based on or using the JLayer and mp3spi library from http://www.javazoom.net/javalayer/javalayer.html and Tritonus library from http://www.tritonus.org/. JLayer, mp3spi and Tritonus library are released under the conditions of GNU Library General Public License version 2 or (at your option) any later version of the License.

Author:

fireandfuel This Class was moved from package de.cuina.firefuel for organization reasons

Constructor Summary

Constructors
Constructor and Description

CodecJLayerMP3()

Constructors
Constructor and Description
`CodecJLayerMP3()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanup()` Should close any open streams and remove references to all instantiated objects.
`boolean`	`endOfStream()` Should return false if there is still more data available to be read in.
`AudioFormat`	`getAudioFormat()` Should return the audio format of the data being returned by the read() and readAll() methods.
`boolean`	`initialize(URL url)` Should make any preperations required before reading from the audio stream.
`boolean`	`initialized()` Should return false if the stream is busy initializing.
`SoundBuffer`	`read()` Should read in one stream buffer worth of audio data.
`SoundBuffer`	`readAll()` Should read in all the audio data from the stream (up to the default "maximum file size".
`void`	`reverseByteOrder(boolean b)` Should tell derived classes when they may 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.

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

- Constructor Detail
  - CodecJLayerMP3
```
public CodecJLayerMP3()
```
- Method Detail
  - reverseByteOrder
```
public void reverseByteOrder(boolean b)
```
    Description copied from interface: ICodec
    
    Should tell derived classes when they may need to reverse the byte order of the data before returning it in the read() and readAll() methods. The reason for the reversBytOrder method is because some external codec libraries produce 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 should call the reverseByteOrder() method for all instances of ICodec that they use. Derivatives of the ICodec interface for codec libraries which which produce this type of data should use the reverseByteOrder() method to know when the data needs to be reversed before returning it in the read() and readAll() methods. If a particular codec library does not produce this type of data, its derived ICodec class may disregard any calls to the reverseByteOrder() method.
    
    Specified by:
    
    reverseByteOrder in interface ICodec
    
    Parameters:
    
    b - True if the calling audio library requires byte-reversal by some codec libraries.
  - initialize
```
public boolean initialize(URL url)
```
    Description copied from interface: ICodec
    
    Should make any preperations required before reading from the audio stream. If another stream is already opened, it should be closed and a new audio stream opened in its place. This method is used internally by SoundSystem not only to initialize a stream, but also to rewind streams and to switch stream sources on the fly.
    
    Specified by:
    
    initialize in interface ICodec
    
    Returns:
    
    False if an error occurred or if end of stream was reached.
  - initialized
```
public boolean initialized()
```
    Description copied from interface: ICodec
    
    Should return false if the stream is busy initializing. To prevent bad data from being returned by this method, derived classes should internally synchronize with any elements used by both the initialized() and initialize() methods.
    
    Specified by:
    
    initialized in interface ICodec
    
    Returns:
    
    True if steam is initialized.
  - read
```
public SoundBuffer read()
```
    Description copied from interface: ICodec
    
    Should read in one stream buffer worth of audio data. See SoundSystemConfig for more information about accessing and changing default settings.
    
    Specified by:
    
    read in interface ICodec
    
    Returns:
    
    The audio data wrapped into a SoundBuffer context.
  - readAll
```
public SoundBuffer readAll()
```
    Description copied from interface: ICodec
    
    Should read 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 ICodec
    
    Returns:
    
    the audio data wrapped into a SoundBuffer context.
  - endOfStream
```
public boolean endOfStream()
```
    Description copied from interface: ICodec
    
    Should return false if there is still more data available to be read in. To prevent bad data from being returned by this method, derived classes should internally synchronize with any elements used in both the endOfStream() and the read() or readAll() methods.
    
    Specified by:
    
    endOfStream in interface ICodec
    
    Returns:
    
    True if end of stream was reached.
  - cleanup
```
public void cleanup()
```
    Description copied from interface: ICodec
    
    Should close any open streams and remove references to all instantiated objects.
    
    Specified by:
    
    cleanup in interface ICodec
  - getAudioFormat
```
public AudioFormat getAudioFormat()
```
    Description copied from interface: ICodec
    
    Should return the audio format of the data being returned by the read() and readAll() methods.
    
    Specified by:
    
    getAudioFormat in interface ICodec
    
    Returns:
    
    Information wrapped into an AudioFormat context.
  - 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.

Class CodecJLayerMP3

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CodecJLayerMP3

Method Detail

reverseByteOrder

initialize

initialized

read

readAll

endOfStream

cleanup

getAudioFormat

reverseBytes

reverseBytes