digiKam
heif::HeifFile Class Reference

Public Member Functions

void add_hvcC_property (heif_item_id id)
 
void add_iref_reference (heif_item_id from, uint32_t type, std::vector< heif_item_id > to)
 
void add_ispe_property (heif_item_id id, uint32_t width, uint32_t height)
 
heif_item_id add_new_image (const char *item_type)
 
std::shared_ptr< Box_infeadd_new_infe_box (const char *item_type)
 
Error append_hvcC_nal_data (heif_item_id id, const std::vector< uint8_t > &data)
 
Error append_hvcC_nal_data (heif_item_id id, const uint8_t *data, size_t size)
 
void append_iloc_data (heif_item_id id, const std::vector< uint8_t > &nal_packets)
 
void append_iloc_data_with_4byte_size (heif_item_id id, const uint8_t *data, size_t size)
 
std::string debug_dump_boxes () const
 
int get_chroma_bits_per_pixel_from_configuration (heif_item_id imageID) const
 
Error get_compressed_image_data (heif_item_id ID, std::vector< uint8_t > *out_data) const
 
std::string get_content_type (heif_item_id ID) const
 
heif_chroma get_image_chroma_from_configuration (heif_item_id imageID) const
 
std::shared_ptr< Box_infeget_infe_box (heif_item_id imageID)
 
std::shared_ptr< Box_ipcoget_ipco_box ()
 
std::shared_ptr< Box_ipmaget_ipma_box ()
 
std::shared_ptr< Box_irefget_iref_box ()
 
std::vector< heif_item_idget_item_IDs () const
 
std::string get_item_type (heif_item_id ID) const
 
int get_luma_bits_per_pixel_from_configuration (heif_item_id imageID) const
 
int get_num_images () const
 
heif_item_id get_primary_image_ID () const
 
Error get_properties (heif_item_id imageID, std::vector< Box_ipco::Property > &properties) const
 
heif_item_id get_unused_item_id () const
 
 HeifFile ()
 
bool image_exists (heif_item_id ID) const
 
void new_empty_file ()
 
Error read (std::shared_ptr< StreamReader > reader)
 
Error read_from_file (const char *input_filename)
 
Error read_from_memory (const void *data, size_t size, bool copy)
 
void set_auxC_property (heif_item_id id, std::string type)
 
void set_color_profile (heif_item_id id, const std::shared_ptr< const color_profile > profile)
 
Error set_hvcC_configuration (heif_item_id id, const Box_hvcC::configuration &config)
 
void set_primary_item_id (heif_item_id id)
 
void write (StreamWriter &writer)
 
 ~HeifFile ()
 

Constructor & Destructor Documentation

◆ HeifFile()

heif::HeifFile::HeifFile ( )

◆ ~HeifFile()

heif::HeifFile::~HeifFile ( )

Member Function Documentation

◆ add_hvcC_property()

void heif::HeifFile::add_hvcC_property ( heif_item_id  id)

◆ add_iref_reference()

void heif::HeifFile::add_iref_reference ( heif_item_id  from,
uint32_t  type,
std::vector< heif_item_id to 
)

◆ add_ispe_property()

void heif::HeifFile::add_ispe_property ( heif_item_id  id,
uint32_t  width,
uint32_t  height 
)

◆ add_new_image()

heif_item_id heif::HeifFile::add_new_image ( const char *  item_type)

◆ add_new_infe_box()

std::shared_ptr<Box_infe> heif::HeifFile::add_new_infe_box ( const char *  item_type)

◆ append_hvcC_nal_data() [1/2]

Error heif::HeifFile::append_hvcC_nal_data ( heif_item_id  id,
const std::vector< uint8_t > &  data 
)

◆ append_hvcC_nal_data() [2/2]

Error heif::HeifFile::append_hvcC_nal_data ( heif_item_id  id,
const uint8_t *  data,
size_t  size 
)

◆ append_iloc_data()

void heif::HeifFile::append_iloc_data ( heif_item_id  id,
const std::vector< uint8_t > &  nal_packets 
)

◆ append_iloc_data_with_4byte_size()

void heif::HeifFile::append_iloc_data_with_4byte_size ( heif_item_id  id,
const uint8_t *  data,
size_t  size 
)

◆ debug_dump_boxes()

std::string heif::HeifFile::debug_dump_boxes ( ) const

◆ get_chroma_bits_per_pixel_from_configuration()

int heif::HeifFile::get_chroma_bits_per_pixel_from_configuration ( heif_item_id  imageID) const

◆ get_compressed_image_data()

Error heif::HeifFile::get_compressed_image_data ( heif_item_id  ID,
std::vector< uint8_t > *  out_data 
) const

◆ get_content_type()

std::string heif::HeifFile::get_content_type ( heif_item_id  ID) const

◆ get_image_chroma_from_configuration()

heif_chroma heif::HeifFile::get_image_chroma_from_configuration ( heif_item_id  imageID) const

◆ get_infe_box()

std::shared_ptr<Box_infe> heif::HeifFile::get_infe_box ( heif_item_id  imageID)
inline

◆ get_ipco_box()

std::shared_ptr<Box_ipco> heif::HeifFile::get_ipco_box ( )
inline

◆ get_ipma_box()

std::shared_ptr<Box_ipma> heif::HeifFile::get_ipma_box ( )
inline

◆ get_iref_box()

std::shared_ptr<Box_iref> heif::HeifFile::get_iref_box ( )
inline

◆ get_item_IDs()

std::vector<heif_item_id> heif::HeifFile::get_item_IDs ( ) const

◆ get_item_type()

std::string heif::HeifFile::get_item_type ( heif_item_id  ID) const

◆ get_luma_bits_per_pixel_from_configuration()

int heif::HeifFile::get_luma_bits_per_pixel_from_configuration ( heif_item_id  imageID) const

◆ get_num_images()

int heif::HeifFile::get_num_images ( ) const
inline

◆ get_primary_image_ID()

heif_item_id heif::HeifFile::get_primary_image_ID ( ) const
inline

◆ get_properties()

Error heif::HeifFile::get_properties ( heif_item_id  imageID,
std::vector< Box_ipco::Property > &  properties 
) const

◆ get_unused_item_id()

heif_item_id heif::HeifFile::get_unused_item_id ( ) const

◆ image_exists()

bool heif::HeifFile::image_exists ( heif_item_id  ID) const

◆ new_empty_file()

void heif::HeifFile::new_empty_file ( )

◆ read()

Error heif::HeifFile::read ( std::shared_ptr< StreamReader reader)

◆ read_from_file()

Error heif::HeifFile::read_from_file ( const char *  input_filename)

◆ read_from_memory()

Error heif::HeifFile::read_from_memory ( const void *  data,
size_t  size,
bool  copy 
)

◆ set_auxC_property()

void heif::HeifFile::set_auxC_property ( heif_item_id  id,
std::string  type 
)

◆ set_color_profile()

void heif::HeifFile::set_color_profile ( heif_item_id  id,
const std::shared_ptr< const color_profile profile 
)

◆ set_hvcC_configuration()

Error heif::HeifFile::set_hvcC_configuration ( heif_item_id  id,
const Box_hvcC::configuration config 
)

◆ set_primary_item_id()

void heif::HeifFile::set_primary_item_id ( heif_item_id  id)

◆ write()

void heif::HeifFile::write ( StreamWriter writer)

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