com.googlecode.mp4parser

Class AbstractContainerBox

java.lang.Object

com.googlecode.mp4parser.BasicContainer

com.googlecode.mp4parser.AbstractContainerBox

All Implemented Interfaces:

Box, Container, Closeable, AutoCloseable, Iterator<Box>

Direct Known Subclasses:

AbstractSampleEntry, AppleItemListBox, AppleReferenceMovieBox, AppleReferenceMovieDescriptorBox, AppleWaveBox, DataInformationBox, DataReferenceBox, EditBox, FullContainerBox, GenericMediaHeaderAtom, ItemProtectionBox, MediaBox, MediaInformationBox, MetaBox, MovieBox, MovieExtendsBox, MovieFragmentBox, MovieFragmentRandomAccessBox, ProtectionSchemeInformationBox, SampleDescriptionBox, SampleTableBox, SchemeInformationBox, TrackApertureModeDimensionAtom, TrackBox, TrackFragmentBox, TrackReferenceBox, UserDataBox

public class AbstractContainerBox
extends BasicContainer
implements Box

Abstract base class suitable for most boxes acting purely as container for other boxes.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	largeBox
protected String	type

Fields inherited from class com.googlecode.mp4parser.BasicContainer

boxParser, dataSource

Constructor Summary

Constructors

Constructor and Description
AbstractContainerBox(String type)

Method Summary

Modifier and Type	Method and Description
void	getBox(WritableByteChannel writableByteChannel) Writes the complete box - size | 4-cc | content - to the given writableByteChannel.
protected ByteBuffer	getHeader()
long	getOffset() Returns the position of the box in the original file.
Container	getParent()
long	getSize()
String	getType() The box's 4-cc type.
void	initContainer(DataSource dataSource, long containerSize, BoxParser boxParser)
void	parse(DataSource dataSource, ByteBuffer header, long contentSize, BoxParser boxParser) Parses the box excluding the already parsed header (size, 4cc, [long-size], [user-type]).
void	setParent(Container parent)

Methods inherited from class com.googlecode.mp4parser.BasicContainer

addBox, close, getBoxes, getBoxes, getBoxes, getByteBuffer, getContainerSize, hasNext, next, remove, setBoxes, toString, writeContainer

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

type

protected String type

largeBox

protected boolean largeBox

Constructor Detail

AbstractContainerBox

public AbstractContainerBox(String type)

Method Detail

getParent

public Container getParent()

Specified by:

getParent in interface Box

getOffset

public long getOffset()

Description copied from interface: Box

Returns the position of the box in the original file.

Specified by:

getOffset in interface Box

Returns:

the start offset in the source file

setParent

public void setParent(Container parent)

Specified by:

setParent in interface Box

getSize

public long getSize()

Specified by:

getSize in interface Box

getType

public String getType()

Description copied from interface: Box

The box's 4-cc type.

Specified by:

getType in interface Box

Returns:

the 4 character type of the box

getHeader

protected ByteBuffer getHeader()

parse

public void parse(DataSource dataSource,
                  ByteBuffer header,
                  long contentSize,
                  BoxParser boxParser)
           throws IOException

Description copied from interface: Box

Parses the box excluding the already parsed header (size, 4cc, [long-size], [user-type]). The remaining size of the box is the contentSize, contentSize number of bytes should be read from the box source (readableByteChannel). If you need the header buffer at a later stage you have to create a copy.

Specified by:

parse in interface Box

Parameters:

dataSource - the source for this box

header - the box' already parsed header (create copy if you need it later as it will be overwritten)

contentSize - remaining bytes of this box

boxParser - use it to parse sub-boxes.

Throws:

IOException - in case of an error during a read operation

getBox

public void getBox(WritableByteChannel writableByteChannel)
            throws IOException

Description copied from interface: Box

Writes the complete box - size | 4-cc | content - to the given writableByteChannel.

Specified by:

getBox in interface Box

Parameters:

writableByteChannel - the box's sink

Throws:

IOException - in case of problems with the Channel

initContainer

public void initContainer(DataSource dataSource,
                          long containerSize,
                          BoxParser boxParser)
                   throws IOException

Overrides:

initContainer in class BasicContainer

Throws:

IOException