net.sourceforge.jaad.mp4.boxes

Class BoxImpl

java.lang.Object

net.sourceforge.jaad.mp4.boxes.BoxImpl

All Implemented Interfaces:

Box

Direct Known Subclasses:

BitRateBox, CleanApertureBox, CodecSpecificBox, FairPlayDataBox, FileTypeBox, FreeSpaceBox, FullBox, MediaDataBox, NeroMetadataTagsBox, OriginalFormatBox, PixelAspectRatioBox, SampleEntry, SampleGroupDescriptionEntry, TrackReferenceBox

public class BoxImpl
extends java.lang.Object
implements Box

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Box>	children
protected long	offset
protected Box	parent
protected long	size
protected long	type

Constructor Summary

Constructors

Constructor and Description
BoxImpl(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(MP4InputStream in) Decodes the given input stream by reading this box and all of its children (if any).
Box	getChild(long type) Returns the child box with the specified type.
java.util.List<Box>	getChildren() Returns an ordered and unmodifiable list of all direct children of this box.
java.util.List<Box>	getChildren(long type) Returns an ordered and unmodifiable list of all direct children of this box with the specified type.
protected long	getLeft(MP4InputStream in)
java.lang.String	getName() Returns the name of this box as a human-readable string (e.g.
long	getOffset() Returns the offset of this box in the stream/file.
Box	getParent()
long	getSize() Returns the size of this box including its header.
long	getType() Returns the type of this box as a 4CC converted to a long.
boolean	hasChild(long type) Indicated if the box has a child with the given type.
boolean	hasChildren() Indicates if this box has children.
protected void	readChildren(MP4InputStream in)
protected void	readChildren(MP4InputStream in, int len)
void	setParams(Box parent, long size, long type, long offset)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

size

protected long size

type

protected long type

offset

protected long offset

parent

protected Box parent

children

protected final java.util.List<Box> children

Constructor Detail

BoxImpl

public BoxImpl(java.lang.String name)

Method Detail

setParams

public void setParams(Box parent,
             long size,
             long type,
             long offset)

getLeft

protected long getLeft(MP4InputStream in)
                throws java.io.IOException

Throws:

java.io.IOException

decode

public void decode(MP4InputStream in)
            throws java.io.IOException

Decodes the given input stream by reading this box and all of its children (if any).

Parameters:

in - an input stream

Throws:

java.io.IOException - if an error occurs while reading

getType

public long getType()

Description copied from interface: Box

Returns the type of this box as a 4CC converted to a long.

Specified by:

getType in interface Box

Returns:

this box's type

getSize

public long getSize()

Description copied from interface: Box

Returns the size of this box including its header.

Specified by:

getSize in interface Box

Returns:

this box's size

getOffset

public long getOffset()

Description copied from interface: Box

Returns the offset of this box in the stream/file. This is needed as a seek point for random access.

Specified by:

getOffset in interface Box

Returns:

this box's offset

getParent

public Box getParent()

Specified by:

getParent in interface Box

getName

public java.lang.String getName()

Description copied from interface: Box

Returns the name of this box as a human-readable string (e.g. "Track Header Box").

Specified by:

getName in interface Box

Returns:

this box's name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hasChildren

public boolean hasChildren()

Description copied from interface: Box

Indicates if this box has children.

Specified by:

hasChildren in interface Box

Returns:

true if this box contains at least one child

hasChild

public boolean hasChild(long type)

Description copied from interface: Box

Indicated if the box has a child with the given type.

Specified by:

hasChild in interface Box

Parameters:

type - the type of child box to look for

Returns:

true if this box contains at least one child with the given type

getChild

public Box getChild(long type)

Description copied from interface: Box

Returns the child box with the specified type. If this box has no child with the given type, null is returned. To check if there is such a child hasChild(type) can be used. If more than one child exists with the same type, the first one will always be returned. A list of all children with that type can be received via getChildren(type).

Specified by:

getChild in interface Box

Parameters:

type - the type of child box to look for

Returns:

the first child box with the given type, or null if none is found

getChildren

public java.util.List<Box> getChildren()

Description copied from interface: Box

Returns an ordered and unmodifiable list of all direct children of this box. The list does not contain the children's children.

Specified by:

getChildren in interface Box

Returns:

this box's children

getChildren

public java.util.List<Box> getChildren(long type)

Description copied from interface: Box

Returns an ordered and unmodifiable list of all direct children of this box with the specified type. The list does not contain the children's children. If there is no child with the given type, the list will be empty.

Specified by:

getChildren in interface Box

Parameters:

type - the type of child boxes to look for

Returns:

this box's children with the given type

readChildren

protected void readChildren(MP4InputStream in)
                     throws java.io.IOException

Throws:

java.io.IOException

readChildren

protected void readChildren(MP4InputStream in,
                int len)
                     throws java.io.IOException

Throws:

java.io.IOException