com.coremedia.iso.boxes
Class AbstractBox

java.lang.Object
  com.coremedia.iso.boxes.AbstractBox

All Implemented Interfaces:

Box

Direct Known Subclasses:

AbstractAppleMetaDataBox, AbstractContainerBox, AbstractFullBox, AC3SpecificBox, AmrSpecificBox, AvcConfigurationBox, AvcNalUnitStorageBox, BitRateBox, DTSSpecificBox, EC3SpecificBox, FileTypeBox, FontTableBox, FreeBox, FreeSpaceBox, ItemDataBox, MLPSpecificBox, OriginalFormatBox, SampleEntry, TrackReferenceTypeBox, UnknownBox, UserBox

public abstract class AbstractBox
extends java.lang.Object
implements Box

A basic ISO box. No full box.

Field Summary

protected java.nio.ByteBuffer	deadBytes
protected java.lang.String	type

Constructor Summary

protected

AbstractBox(java.lang.String type)

Method Summary

abstract void	_parseDetails(java.nio.ByteBuffer content) Implement the actual parsing of the box's fields here.
void	getBox(java.nio.channels.WritableByteChannel os)
protected abstract void	getContent(java.nio.ByteBuffer bb) Writes the box's content into the given ByteBuffer.
protected abstract long	getContentSize() Gets the box's content size.
java.nio.ByteBuffer	getDeadBytes()
void	getHeader(java.nio.ByteBuffer byteBuffer)
IsoFile	getIsoFile()
ContainerBox	getParent()
long	getSize()
java.lang.String	getType()
byte[]	getUserType()
boolean	isParsed()
void	parse(java.nio.channels.ReadableByteChannel in, java.nio.ByteBuffer header, long contentSize, BoxParser boxParser) Pareses the given IsoBufferWrapper and returns the remaining bytes.
void	parseDetails() Parses the boxes fields.
void	setDeadBytes(java.nio.ByteBuffer newDeadBytes)
void	setParent(ContainerBox parent)
void	setUserType(byte[] userType)

Methods inherited from class java.lang.Object

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

Field Detail

type

protected java.lang.String type

deadBytes

protected java.nio.ByteBuffer deadBytes

Constructor Detail

AbstractBox

protected AbstractBox(java.lang.String type)

Method Detail

getSize

public long getSize()

Specified by:

getSize in interface Box

isParsed

public boolean isParsed()

getContentSize

protected abstract long getContentSize()

Gets the box's content size. This excludes all header fields:

• 4 byte size
• 4 byte type
• (large length - 8 bytes)
• (user type - 16 bytes)

Flags and version of a full box need to be taken into account.

Returns:

Gets the box's content size in bytes

getType

@DoNotParseDetail
public java.lang.String getType()

Specified by:

getType in interface Box

getUserType

@DoNotParseDetail
public byte[] getUserType()

setUserType

@DoNotParseDetail
public void setUserType(byte[] userType)

getParent

@DoNotParseDetail
public ContainerBox getParent()

Specified by:

getParent in interface Box

setParent

@DoNotParseDetail
public void setParent(ContainerBox parent)

Specified by:

setParent in interface Box

getIsoFile

@DoNotParseDetail
public IsoFile getIsoFile()

parse

@DoNotParseDetail
public void parse(java.nio.channels.ReadableByteChannel in,
                                   java.nio.ByteBuffer header,
                                   long contentSize,
                                   BoxParser boxParser)
           throws java.io.IOException

Pareses the given IsoBufferWrapper and returns the remaining bytes.

Specified by:

parse in interface Box

Parameters:

in - the (part of the) iso file to parse

contentSize - expected contentSize of the box

boxParser - creates inner boxes

Throws:

java.io.IOException - in case of an I/O error.

parseDetails

public final void parseDetails()

Parses the boxes fields.

_parseDetails

public abstract void _parseDetails(java.nio.ByteBuffer content)

Implement the actual parsing of the box's fields here. External classes will always call parseDetails() which encapsulates the call to this method with some safeguards.

Parameters:

content -

getDeadBytes

public java.nio.ByteBuffer getDeadBytes()

setDeadBytes

public void setDeadBytes(java.nio.ByteBuffer newDeadBytes)

getHeader

public void getHeader(java.nio.ByteBuffer byteBuffer)

getBox

public void getBox(java.nio.channels.WritableByteChannel os)
            throws java.io.IOException

Specified by:

getBox in interface Box

Throws:

java.io.IOException

getContent

protected abstract void getContent(java.nio.ByteBuffer bb)
                            throws java.io.IOException

Writes the box's content into the given ByteBuffer. This must include flags and version in case of a full box. bb has been initialized with getSize() bytes.

Parameters:

bb - the box's content-sink.

Throws:

java.io.IOException - in case of an exception in the underlying OutputStream.