org.gagravarr.ogg

Class OggPacketWriter

java.lang.Object

org.gagravarr.ogg.OggPacketWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class OggPacketWriter
extends Object
implements Closeable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OggPacketWriter(OggFile parentFile, int sid)

Method Summary

Methods

Modifier and Type	Method and Description
void	bufferPacket(OggPacket packet) Buffers the given packet up ready for writing to the stream, but doesn't write it to disk yet.
void	bufferPacket(OggPacket packet, boolean flush) Buffers the given packet up ready for writing to the file, and then writes it to the stream if indicated.
void	bufferPacket(OggPacket packet, long granulePosition) Buffers the given packet up ready for writing to the stream, but doesn't write it to disk yet.
void	close() Writes all pending packets to the stream, with the last one containing the End Of Stream Flag, and then closes down.
void	flush() Writes all pending packets to the stream, splitting across pages as needed.
long	getCurrentGranulePosition()
int	getCurrentPageSize() Returns the size of the page currently being written to, including its headers.
int	getSid()
int	getSizePendingFlush() Returns the number of bytes (excluding headers) currently waiting to be written to disk.
void	setGranulePosition(long position) Sets the current granule position.

Methods inherited from class java.lang.Object

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

Constructor Detail

OggPacketWriter

protected OggPacketWriter(OggFile parentFile,
               int sid)

Method Detail

setGranulePosition

public void setGranulePosition(long position)

Sets the current granule position. The granule position will be applied to all un-flushed packets, and all future packets. As such, you should normally either call a flush just before or just after this call.

getCurrentGranulePosition

public long getCurrentGranulePosition()

getSid

public int getSid()

bufferPacket

public void bufferPacket(OggPacket packet)

Buffers the given packet up ready for writing to the stream, but doesn't write it to disk yet. The granule position is unchanged.

bufferPacket

public void bufferPacket(OggPacket packet,
                long granulePosition)

Buffers the given packet up ready for writing to the stream, but doesn't write it to disk yet. The granule position is updated on the page. If writing the packet requires a new page, then the updated granule position only applies to the new page

bufferPacket

public void bufferPacket(OggPacket packet,
                boolean flush)
                  throws IOException

Buffers the given packet up ready for writing to the file, and then writes it to the stream if indicated.

Throws:

IOException

getSizePendingFlush

public int getSizePendingFlush()

Returns the number of bytes (excluding headers) currently waiting to be written to disk. RFC 3533 suggests that pages should normally be in the 4-8kb range. If this size exceeds just shy of 64kb, then multiple pages will be needed in the underlying stream.

getCurrentPageSize

public int getCurrentPageSize()

Returns the size of the page currently being written to, including its headers. For a new stream, or a stream that has just been flushed, will return zero.

Returns:

Current page size, or 27 (the minimum) if no current page

flush

public void flush()
           throws IOException

Writes all pending packets to the stream, splitting across pages as needed.

Throws:

IOException

close

public void close()
           throws IOException

Writes all pending packets to the stream, with the last one containing the End Of Stream Flag, and then closes down.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException