digiKam
heif::HeifContext Class Reference
+ Inheritance diagram for heif::HeifContext:

Classes

class  Image
 

Public Member Functions

Error add_exif_metadata (std::shared_ptr< Image > master_image, const void *data, int size)
 
Error add_generic_metadata (std::shared_ptr< Image > master_image, const void *data, int size, const char *item_type, const char *content_type)
 
Error add_XMP_metadata (std::shared_ptr< Image > master_image, const void *data, int size)
 
Error assign_thumbnail (std::shared_ptr< Image > master_image, std::shared_ptr< Image > thumbnail_image)
 
std::string debug_dump_boxes () const
 
Error decode_image (heif_item_id ID, std::shared_ptr< HeifPixelImage > &img, const struct heif_decoding_options *options=nullptr) const
 
Error encode_image (std::shared_ptr< HeifPixelImage > image, struct heif_encoder *encoder, const struct heif_encoding_options *options, enum heif_image_input_class input_class, std::shared_ptr< Image > &out_image)
 
Error encode_thumbnail (std::shared_ptr< HeifPixelImage > image, struct heif_encoder *encoder, const struct heif_encoding_options *options, int bbox_size, std::shared_ptr< Image > &out_image_handle)
 
const char * get_error () const
 
std::shared_ptr< Imageget_primary_image ()
 
std::vector< std::shared_ptr< Image > > get_top_level_images ()
 
 HeifContext ()
 
bool is_image (heif_item_id ID) const
 
bool is_primary_image_set () const
 
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 register_decoder (const heif_decoder_plugin *decoder_plugin)
 
void reset_to_empty_heif ()
 
void set_error (std::string err)
 
void set_max_decoding_threads (int max_threads)
 
void set_maximum_image_size_limit (int maximum_size)
 
void set_primary_image (std::shared_ptr< Image > image)
 
Error set_primary_item (heif_item_id id)
 
void set_success ()
 
void write (StreamWriter &writer)
 
 ~HeifContext ()
 

Constructor & Destructor Documentation

◆ HeifContext()

heif::HeifContext::HeifContext ( )

◆ ~HeifContext()

heif::HeifContext::~HeifContext ( )

Member Function Documentation

◆ add_exif_metadata()

Error heif::HeifContext::add_exif_metadata ( std::shared_ptr< Image master_image,
const void *  data,
int  size 
)

◆ add_generic_metadata()

Error heif::HeifContext::add_generic_metadata ( std::shared_ptr< Image master_image,
const void *  data,
int  size,
const char *  item_type,
const char *  content_type 
)

◆ add_XMP_metadata()

Error heif::HeifContext::add_XMP_metadata ( std::shared_ptr< Image master_image,
const void *  data,
int  size 
)

◆ assign_thumbnail()

Error heif::HeifContext::assign_thumbnail ( std::shared_ptr< Image master_image,
std::shared_ptr< Image thumbnail_image 
)

◆ debug_dump_boxes()

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

◆ decode_image()

Error heif::HeifContext::decode_image ( heif_item_id  ID,
std::shared_ptr< HeifPixelImage > &  img,
const struct heif_decoding_options options = nullptr 
) const

◆ encode_image()

Error heif::HeifContext::encode_image ( std::shared_ptr< HeifPixelImage image,
struct heif_encoder encoder,
const struct heif_encoding_options options,
enum heif_image_input_class  input_class,
std::shared_ptr< Image > &  out_image 
)

◆ encode_thumbnail()

Error heif::HeifContext::encode_thumbnail ( std::shared_ptr< HeifPixelImage image,
struct heif_encoder encoder,
const struct heif_encoding_options options,
int  bbox_size,
std::shared_ptr< Image > &  out_image_handle 
)

◆ get_error()

const char* heif::ErrorBuffer::get_error ( ) const
inlineinherited

◆ get_primary_image()

std::shared_ptr<Image> heif::HeifContext::get_primary_image ( )
inline

◆ get_top_level_images()

std::vector<std::shared_ptr<Image> > heif::HeifContext::get_top_level_images ( )
inline

◆ is_image()

bool heif::HeifContext::is_image ( heif_item_id  ID) const

◆ is_primary_image_set()

bool heif::HeifContext::is_primary_image_set ( ) const
inline

◆ read()

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

◆ read_from_file()

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

◆ read_from_memory()

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

◆ register_decoder()

void heif::HeifContext::register_decoder ( const heif_decoder_plugin decoder_plugin)

◆ reset_to_empty_heif()

void heif::HeifContext::reset_to_empty_heif ( )

◆ set_error()

void heif::ErrorBuffer::set_error ( std::string  err)
inlineinherited

◆ set_max_decoding_threads()

void heif::HeifContext::set_max_decoding_threads ( int  max_threads)
inline

◆ set_maximum_image_size_limit()

void heif::HeifContext::set_maximum_image_size_limit ( int  maximum_size)
inline

◆ set_primary_image()

void heif::HeifContext::set_primary_image ( std::shared_ptr< Image image)

◆ set_primary_item()

Error heif::HeifContext::set_primary_item ( heif_item_id  id)

◆ set_success()

void heif::ErrorBuffer::set_success ( )
inlineinherited

◆ write()

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

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