Bento4 MP4 SDK: AP4_Atom Class Reference

Bento4 MP4 SDK

previous page next page

AP4_Atom Class Reference

Abstract base class for all atom types. More...

#include <Ap4Atom.h>

Public Types
typedef AP4_UI32	Type
Public Member Functions
	AP4_Atom (Type type, AP4_UI32 size=AP4_ATOM_HEADER_SIZE)
	Create a simple atom with a specified type and 32-bit size.
	AP4_Atom (Type type, AP4_UI64 size, bool force_64=false)
	Create a simple atom with a specified type and 64-bit size.
	AP4_Atom (Type type, AP4_UI32 size, AP4_UI32 version, AP4_UI32 flags)
	Create a full atom with a specified type, 32-bit size, version and flags.
	AP4_Atom (Type type, AP4_UI64 size, bool force_64, AP4_UI32 version, AP4_UI32 flags)
	Create a full atom with a specified type, 64-bit size, version and flags.
virtual	~AP4_Atom ()
AP4_UI32	GetFlags () const
void	SetFlags (AP4_UI32 flags)
Type	GetType () const
void	SetType (Type type)
virtual AP4_Size	GetHeaderSize () const
AP4_UI64	GetSize () const
void	SetSize (AP4_UI64 size, bool force_64=false)
AP4_UI32	GetSize32 () const
void	SetSize32 (AP4_UI32 size)
AP4_UI64	GetSize64 () const
void	SetSize64 (AP4_UI64 size)
virtual AP4_Result	Write (AP4_ByteStream &stream)
virtual AP4_Result	WriteHeader (AP4_ByteStream &stream)
virtual AP4_Result	WriteFields (AP4_ByteStream &stream)=0
virtual AP4_Result	Inspect (AP4_AtomInspector &inspector)
virtual AP4_Result	InspectHeader (AP4_AtomInspector &inspector)
virtual AP4_Result	InspectFields (AP4_AtomInspector &)
virtual AP4_Result	SetParent (AP4_AtomParent *parent)
virtual AP4_AtomParent *	GetParent ()
virtual AP4_Result	Detach ()
virtual AP4_Atom *	Clone ()
	Create a clone of the object.
Static Public Member Functions
static Type	TypeFromString (const char *four_cc)
static AP4_Result	ReadFullHeader (AP4_ByteStream &stream, AP4_UI32 &version, AP4_UI32 &flags)
Protected Attributes
Type	m_Type
AP4_UI32	m_Size32
AP4_UI64	m_Size64
bool	m_IsFull
AP4_UI32	m_Version
AP4_UI32	m_Flags
AP4_AtomParent *	m_Parent

Detailed Description

Abstract base class for all atom types.

Definition at line 152 of file Ap4Atom.h.

Member Typedef Documentation

typedef AP4_UI32 AP4_Atom::Type

Definition at line 157 of file Ap4Atom.h.

Constructor & Destructor Documentation

AP4_Atom::AP4_Atom	(	Type	type,
		AP4_UI32	size = `AP4_ATOM_HEADER_SIZE`
	)			`[explicit]`

Create a simple atom with a specified type and 32-bit size.

AP4_Atom::AP4_Atom	(	Type	type,
		AP4_UI64	size,
		bool	force_64 = `false`
	)			`[explicit]`

Create a simple atom with a specified type and 64-bit size.

AP4_Atom::AP4_Atom	(	Type	type,
		AP4_UI32	size,
		AP4_UI32	version,
		AP4_UI32	flags
	)			`[explicit]`

Create a full atom with a specified type, 32-bit size, version and flags.

AP4_Atom::AP4_Atom	(	Type	type,
		AP4_UI64	size,
		bool	force_64,
		AP4_UI32	version,
		AP4_UI32	flags
	)			`[explicit]`

Create a full atom with a specified type, 64-bit size, version and flags.

virtual AP4_Atom::~AP4_Atom ( ) [inline, virtual]

Definition at line 194 of file Ap4Atom.h.

Member Function Documentation

virtual AP4_Atom* AP4_Atom::Clone ( ) [virtual]

Create a clone of the object.

This method returns a clone of the atom, or NULL if the atom cannot be cloned. Override this if your want to make an atom cloneable in a more efficient way than the default implementation.

Reimplemented in AP4_UnknownAtom, AP4_ContainerAtom, AP4_GrpiAtom, AP4_IkmsAtom, AP4_IsfmAtom, and AP4_OhdrAtom.

virtual AP4_Result AP4_Atom::Detach ( ) [virtual]