org.gagravarr.theora

Class TheoraFile

java.lang.Object

org.gagravarr.ogg.HighLevelOggStreamPacket

org.gagravarr.theora.TheoraFile

All Implemented Interfaces:

Closeable, AutoCloseable, OggStreamPacket

public class TheoraFile
extends HighLevelOggStreamPacket
implements Closeable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TheoraFile.AudioVisualDataAndSid

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	addSoundtrack(OggAudioHeaders audio) Adds a new soundtrack to the video
void	close() In Reading mode, will close the underlying ogg file and free its resources.
void	ensureSkeleton()
TheoraComments	getComments()
TheoraInfo	getInfo()
OggStreamAudioVisualData	getNextAudioVisualPacket() Returns the next audio or video packet across any supported stream, or null if no more remain
OggStreamAudioVisualData	getNextAudioVisualPacket(Set<Integer> sids) Returns the next audio or video packet from any of the specified streams, or null if no more remain
OggFile	getOggFile() Returns the underlying Ogg File instance
TheoraSetup	getSetup()
int	getSid() Returns the Ogg Stream ID
SkeletonStream	getSkeleton() Returns the Skeleton data describing all the streams, or null if the file has no Skeleton stream
Collection<? extends OggAudioHeaders>	getSoundtracks() Returns all the soundtracks
Map<Integer,? extends OggAudioHeaders>	getSoundtrackStreams() Returns the soundtracks and their stream IDs
void	writeAudioData(OggStreamAudioData data, int audioSid) Buffers the given audio ready for writing out, to a given (pre-existing) audio stream.
void	writeVideoData(TheoraVideoData data) Buffers the given video ready for writing out.

Methods inherited from class org.gagravarr.ogg.HighLevelOggStreamPacket

getData, getOggOverheadSize, getOggPacket, setData, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TheoraFile

public TheoraFile(File f)
           throws IOException,
                  FileNotFoundException

Opens the given file for reading

Throws:

IOException

FileNotFoundException

TheoraFile

public TheoraFile(OggFile ogg)
           throws IOException

Opens the given file for reading

Throws:

IOException

TheoraFile

public TheoraFile(OggPacketReader r)
           throws IOException

Loads a Theora File from the given packet reader.

Throws:

IOException

TheoraFile

public TheoraFile(OutputStream out)

Opens for writing.

TheoraFile

public TheoraFile(OutputStream out,
                  TheoraInfo info,
                  TheoraComments comments,
                  TheoraSetup setup)

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

TheoraFile

public TheoraFile(OutputStream out,
                  int sid,
                  TheoraInfo info,
                  TheoraComments comments,
                  TheoraSetup 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

getSid

public int getSid()

Returns the Ogg Stream ID

getInfo

public TheoraInfo getInfo()

getComments

public TheoraComments getComments()

getSetup

public TheoraSetup getSetup()

getSkeleton

public SkeletonStream getSkeleton()

Returns the Skeleton data describing all the streams, or null if the file has no Skeleton stream

ensureSkeleton

public void ensureSkeleton()

getSoundtrackStreams

public Map<Integer,? extends OggAudioHeaders> getSoundtrackStreams()

Returns the soundtracks and their stream IDs

getSoundtracks

public Collection<? extends OggAudioHeaders> getSoundtracks()

Returns all the soundtracks

addSoundtrack

public int addSoundtrack(OggAudioHeaders audio)

Adds a new soundtrack to the video

Returns:

the serial id (sid) of the new soundtrack

getNextAudioVisualPacket

public OggStreamAudioVisualData getNextAudioVisualPacket()
                                                  throws IOException

Returns the next audio or video packet across any supported stream, or null if no more remain

Throws:

IOException

getNextAudioVisualPacket

public OggStreamAudioVisualData getNextAudioVisualPacket(Set<Integer> sids)
                                                  throws IOException

Returns the next audio or video packet from any of the specified streams, or null if no more remain

Throws:

IOException

writeVideoData

public void writeVideoData(TheoraVideoData data)

Buffers the given video 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

writeAudioData

public void writeAudioData(OggStreamAudioData data,
                           int audioSid)

Buffers the given audio ready for writing out, to a given (pre-existing) audio stream. 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, Comment Tags objects, and then the video and 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: