Inheritance diagram for heif::Box:

Public Member Functions
int	append_child_box (std::shared_ptr< Box > box)

	Box ()

	Box (const BoxHeader &hdr)

virtual void	derive_box_version ()

void	derive_box_version_recursive ()

virtual std::string	dump (Indent &) const

const std::vector< std::shared_ptr< Box > > &	get_all_child_boxes () const

uint64_t	get_box_size () const

std::shared_ptr< Box >	get_child_box (uint32_t short_type) const

std::vector< std::shared_ptr< Box > >	get_child_boxes (uint32_t short_type) const

uint32_t	get_flags () const

uint32_t	get_header_size () const

uint32_t	get_short_type () const

std::vector< uint8_t >	get_type () const

std::string	get_type_string () const

uint8_t	get_version () const

bool	is_full_box_header () const

Error	parse_full_box_header (BitstreamRange &range)

Error	prepend_header (StreamWriter &, size_t box_start) const

size_t	reserve_box_header_space (StreamWriter &writer) const

void	set_flags (uint32_t flags)

void	set_is_full_box (bool flag=true)

void	set_short_type (uint32_t type)

void	set_version (uint8_t version)

virtual Error	write (StreamWriter &writer) const

Static Public Member Functions
static Error	read (BitstreamRange &range, std::shared_ptr< heif::Box > *box)

Static Public Attributes
constexpr static uint64_t	size_until_end_of_file = 0

Protected Member Functions
std::string	dump_children (Indent &) const

virtual Error	parse (BitstreamRange &range)

Error	read_children (BitstreamRange &range, int number=READ_CHILDREN_ALL)

Error	write_children (StreamWriter &writer) const

Protected Attributes
std::vector< std::shared_ptr< Box > >	m_children

Static Protected Attributes
static const int	READ_CHILDREN_ALL = -1

Constructor & Destructor Documentation

◆ Box() [1/2]

heif::Box::Box ( )

inline

◆ Box() [2/2]

heif::Box::Box ( const BoxHeader & hdr )

inline

Member Function Documentation

◆ append_child_box()

int heif::Box::append_child_box ( std::shared_ptr< Box > box )

inline

References m_children.

◆ derive_box_version()

virtual void heif::Box::derive_box_version ( )

inlinevirtual

Reimplemented in heif::Box_iref, heif::Box_ipma, heif::Box_iinf, heif::Box_infe, heif::Box_iloc, and heif::Box_pitm.

References heif::BoxHeader::set_version().

◆ derive_box_version_recursive()

void heif::Box::derive_box_version_recursive ( )

◆ dump()

virtual std::string heif::Box::dump ( Indent & ) const

virtual

Reimplemented from heif::BoxHeader.

Reimplemented in heif::Box_colr, heif::Box_pixi, heif::Box_url, heif::Box_dref, heif::Box_dinf, heif::Box_grpl, heif::Box_idat, heif::Box_hvcC, heif::Box_iref, heif::Box_clap, heif::Box_imir, heif::Box_irot, heif::Box_auxC, heif::Box_ipma, heif::Box_ispe, heif::Box_ipco, heif::Box_iprp, heif::Box_iinf, heif::Box_infe, heif::Box_iloc, heif::Box_pitm, heif::Box_hdlr, heif::Box_meta, and heif::Box_ftyp.

◆ dump_children()

std::string heif::Box::dump_children ( Indent & ) const

protected

◆ get_all_child_boxes()

const std::vector<std::shared_ptr<Box> >& heif::Box::get_all_child_boxes ( ) const

inline

References m_children.

◆ get_box_size()

uint64_t heif::BoxHeader::get_box_size ( ) const

inlineinherited

◆ get_child_box()

std::shared_ptr<Box> heif::Box::get_child_box ( uint32_t short_type ) const

◆ get_child_boxes()

std::vector<std::shared_ptr<Box> > heif::Box::get_child_boxes ( uint32_t short_type ) const

◆ get_flags()

uint32_t heif::BoxHeader::get_flags ( ) const

inlineinherited

◆ get_header_size()

uint32_t heif::BoxHeader::get_header_size ( ) const

inlineinherited

◆ get_short_type()

uint32_t heif::BoxHeader::get_short_type ( ) const

inlineinherited

◆ get_type()

std::vector<uint8_t> heif::BoxHeader::get_type ( ) const

inherited

◆ get_type_string()

std::string heif::BoxHeader::get_type_string ( ) const

inherited

◆ get_version()

uint8_t heif::BoxHeader::get_version ( ) const

inlineinherited

◆ is_full_box_header()

bool heif::BoxHeader::is_full_box_header ( ) const

inlineinherited

◆ parse()

virtual Error heif::Box::parse ( BitstreamRange & range )

protectedvirtual

◆ parse_full_box_header()

Error heif::BoxHeader::parse_full_box_header ( BitstreamRange & range )

inherited

◆ prepend_header()

Error heif::BoxHeader::prepend_header	(	StreamWriter &	,
		size_t	box_start
	)		const

inherited

◆ read()

static Error heif::Box::read	(	BitstreamRange &	range,
		std::shared_ptr< heif::Box > *	box
	)

static

◆ read_children()

Error heif::Box::read_children	(	BitstreamRange &	range,
		int	number = `READ_CHILDREN_ALL`
	)

protected

◆ reserve_box_header_space()

size_t heif::BoxHeader::reserve_box_header_space ( StreamWriter & writer ) const

inherited

◆ set_flags()

void heif::BoxHeader::set_flags ( uint32_t flags )

inlineinherited

◆ set_is_full_box()

void heif::BoxHeader::set_is_full_box ( bool flag = true )

inlineinherited

Referenced by heif::Box_auxC::Box_auxC(), heif::Box_colr::Box_colr(), heif::Box_ftyp::Box_ftyp(), heif::Box_hdlr::Box_hdlr(), heif::Box_hvcC::Box_hvcC(), heif::Box_iinf::Box_iinf(), heif::Box_iloc::Box_iloc(), heif::Box_infe::Box_infe(), heif::Box_ipco::Box_ipco(), heif::Box_ipma::Box_ipma(), heif::Box_iprp::Box_iprp(), heif::Box_iref::Box_iref(), heif::Box_ispe::Box_ispe(), heif::Box_meta::Box_meta(), heif::Box_pitm::Box_pitm(), and heif::Box_pixi::Box_pixi().

◆ set_short_type()

void heif::BoxHeader::set_short_type ( uint32_t type )

inlineinherited

Referenced by heif::Box_auxC::Box_auxC(), heif::Box_colr::Box_colr(), heif::Box_ftyp::Box_ftyp(), heif::Box_hdlr::Box_hdlr(), heif::Box_hvcC::Box_hvcC(), heif::Box_iinf::Box_iinf(), heif::Box_iloc::Box_iloc(), heif::Box_infe::Box_infe(), heif::Box_ipco::Box_ipco(), heif::Box_ipma::Box_ipma(), heif::Box_iprp::Box_iprp(), heif::Box_iref::Box_iref(), heif::Box_ispe::Box_ispe(), heif::Box_meta::Box_meta(), heif::Box_pitm::Box_pitm(), and heif::Box_pixi::Box_pixi().

◆ set_version()

void heif::BoxHeader::set_version ( uint8_t version )

inlineinherited

Referenced by derive_box_version().

◆ write()

virtual Error heif::Box::write ( StreamWriter & writer ) const

virtual

Reimplemented in heif::Box_colr, heif::Box_pixi, heif::Box_hvcC, heif::Box_iref, heif::Box_auxC, heif::Box_ipma, heif::Box_ispe, heif::Box_iinf, heif::Box_infe, heif::Box_iloc, heif::Box_pitm, heif::Box_hdlr, and heif::Box_ftyp.

◆ write_children()

Error heif::Box::write_children ( StreamWriter & writer ) const

protected

Member Data Documentation

◆ m_children

std::vector<std::shared_ptr<Box> > heif::Box::m_children

protected

Referenced by append_child_box(), and get_all_child_boxes().

◆ READ_CHILDREN_ALL

const int heif::Box::READ_CHILDREN_ALL = -1

staticprotected

◆ size_until_end_of_file

constexpr static uint64_t heif::BoxHeader::size_until_end_of_file = 0

staticconstexprinherited

The documentation for this class was generated from the following file:

core/libs/heifutils/libheif/box.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ Box() [1/2]

◆ Box() [2/2]

Member Function Documentation

◆ append_child_box()

◆ derive_box_version()

◆ derive_box_version_recursive()

◆ dump()

◆ dump_children()

◆ get_all_child_boxes()

◆ get_box_size()

◆ get_child_box()

◆ get_child_boxes()

◆ get_flags()

◆ get_header_size()

◆ get_short_type()

◆ get_type()

◆ get_type_string()

◆ get_version()

◆ is_full_box_header()

◆ parse()

◆ parse_full_box_header()

◆ prepend_header()

◆ read()

◆ read_children()

◆ reserve_box_header_space()

◆ set_flags()

◆ set_is_full_box()

◆ set_short_type()

◆ set_version()

◆ write()

◆ write_children()

Member Data Documentation

◆ m_children

◆ READ_CHILDREN_ALL

◆ size_until_end_of_file