CodecJOgg (Etyl Commons 1.0.2 API)

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

All Implemented Interfaces:

ICodec
```
public class CodecJOgg
extends Object
implements ICodec
```
The CodecJOgg class provides an ICodec interface to the external J-Ogg library.

This software is based on or using the J-Ogg library available from http://www.j-ogg.de and copyrighted by Tor-Einar Jarnbjo.

J-Ogg License:
You are free to use, modify, resdistribute or include this software in your own free or commercial software. The only restriction is, that you make it obvious that your software is based on J-Ogg by including this notice in the documentation, about box or whereever you feel apropriate:
"This software is based on or using the J-Ogg library available from http://www.j-ogg.de and copyrighted by Tor-Einar Jarnbjo."

SoundSystem CodecJOgg 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 must abide by the conditions of the aforementioned J-Ogg License.
2) You may not falsely claim to be the author of this class or any unmodified portion of it.
3) You may not copyright this class or a modified version of it and then sue me for copyright infringement.
4) 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.
5) 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
6) 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.
7) 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

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanup()` Closes the audio stream and remove references to all instantiated objects.
`boolean`	`endOfStream()` Returns false if there is still more data available to be read in.
`AudioFormat`	`getAudioFormat()` Returns the audio format of the data being returned by the read() and readAll() methods.
`boolean`	`initialize(URL url)` Prepares an audio stream to read from.
`boolean`	`initialized()` Returns false if the stream is busy initializing.
`SoundBuffer`	`read()` Reads in one stream buffer worth of audio data.
`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.

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

- Constructor Detail
  - CodecJOgg
```
public CodecJOgg()
```
    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 J-Ogg 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 ICodec
    
    Parameters:
    
    b - True if the calling audio library requires byte-reversal.
  - initialize
```
public boolean initialize(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 ICodec
    
    Parameters:
    
    url - URL to an ogg 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 ICodec
    
    Returns:
    
    True if steam is initialized.
  - read
```
public 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 ICodec
    
    Returns:
    
    The audio data wrapped into a SoundBuffer context.
  - readAll
```
public 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 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 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 ICodec
  - getAudioFormat
```
public AudioFormat getAudioFormat()
```
    Returns 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 CodecJOgg

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CodecJOgg

Method Detail

reverseByteOrder

initialize

initialized

read

readAll

endOfStream

cleanup

getAudioFormat

reverseBytes

reverseBytes