org.gagravarr.vorbis

Class VorbisFile

java.lang.Object

org.gagravarr.vorbis.VorbisFile

All Implemented Interfaces:

Closeable, AutoCloseable, OggAudioHeaders, OggAudioStream

public class VorbisFile
extends Object
implements OggAudioStream, OggAudioHeaders, Closeable

This is a wrapper around an OggFile that lets you get at all the interesting bits of a Vorbis file.

Constructor Summary

Constructors

Constructor and Description
VorbisFile(File f) Opens the given file for reading
VorbisFile(OggFile ogg) Opens the given file for reading
VorbisFile(OggPacketReader r) Loads a Vorbis File from the given packet reader.
VorbisFile(OutputStream out) Opens for writing.
VorbisFile(OutputStream out, int sid, VorbisInfo info, VorbisComments comments, VorbisSetup setup) Opens for writing, based on the settings from a pre-read file, with a specific Steam ID (SID).
VorbisFile(OutputStream out, VorbisInfo info, VorbisComments comments, VorbisSetup setup) Opens for writing, based on the settings from a pre-read file.

Method Summary

Modifier and Type	Method and Description
void	close() In Reading mode, will close the underlying ogg file and free its resources.
VorbisComments	getComment()
VorbisInfo	getInfo()
VorbisAudioData	getNextAudioPacket() Returns the next OggStreamAudioData packet in the stream, or null if no more remain
OggFile	getOggFile() Returns the underlying Ogg File instance
VorbisSetup	getSetup()
int	getSid() Returns the Ogg Stream ID
VorbisComments	getTags()
OggStreamIdentifier.OggStreamType	getType() This is a Vorbis file
void	skipToGranule(long granulePosition) Skips the audio data to the next packet with a granule of at least the given granule position.
void	writeAudioData(VorbisAudioData data) Buffers the given audio ready for writing out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VorbisFile

public VorbisFile(File f)
           throws IOException,
                  FileNotFoundException

Opens the given file for reading

Throws:

IOException

FileNotFoundException

VorbisFile

public VorbisFile(OggFile ogg)
           throws IOException

Opens the given file for reading

Throws:

IOException

VorbisFile

public VorbisFile(OggPacketReader r)
           throws IOException

Loads a Vorbis File from the given packet reader.

Throws:

IOException

VorbisFile

public VorbisFile(OutputStream out)

Opens for writing.

VorbisFile

public VorbisFile(OutputStream out,
                  VorbisInfo info,
                  VorbisComments comments,
                  VorbisSetup setup)

Opens for writing, based on the settings from a pre-read file. The Steam ID (SID) is automatically allocated for you.

VorbisFile

public VorbisFile(OutputStream out,
                  int sid,
                  VorbisInfo info,
                  VorbisComments comments,
                  VorbisSetup setup)

Opens for writing, based on the settings from a pre-read file, with a specific Steam ID (SID). You should only set the SID when copying one file to another!

Method Detail

getNextAudioPacket

public VorbisAudioData getNextAudioPacket()
                                   throws IOException

Description copied from interface: OggAudioStream

Returns the next OggStreamAudioData packet in the stream, or null if no more remain

Specified by:

getNextAudioPacket in interface OggAudioStream

Throws:

IOException

skipToGranule

public void skipToGranule(long granulePosition)
                   throws IOException

Skips the audio data to the next packet with a granule of at least the given granule position. Note that skipping backwards is not currently supported!

Specified by:

skipToGranule in interface OggAudioStream

Throws:

IOException

getSid

public int getSid()

Returns the Ogg Stream ID

Specified by:

getSid in interface OggAudioHeaders

Returns:

The stream id of the overall audio stream

getType

public OggStreamIdentifier.OggStreamType getType()

This is a Vorbis file

Specified by:

getType in interface OggAudioHeaders

Returns:

The type of the audio stream

getInfo

public VorbisInfo getInfo()

Specified by:

getInfo in interface OggAudioHeaders

Returns:

The information / identification of the stream and audio encoding

getComment

public VorbisComments getComment()

getTags

public VorbisComments getTags()

Specified by:

getTags in interface OggAudioHeaders

Returns:

The Tags / Comments describing the stream

getSetup

public VorbisSetup getSetup()

Specified by:

getSetup in interface OggAudioHeaders

Returns:

The Setup information for the audio encoding, if used in the format

writeAudioData

public void writeAudioData(VorbisAudioData data)

Buffers the given audio ready for writing out. Data won't be written out yet, you need to call close() to do that, because we assume you'll still be populating the Info/Comment/Setup objects

close

public void close()
           throws IOException

In Reading mode, will close the underlying ogg file and free its resources. In Writing mode, will write out the Info, Comments and Setup objects, and then the audio data.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getOggFile

public OggFile getOggFile()

Returns the underlying Ogg File instance

Returns: