heif_text.h

Go to the documentation of this file.

/*
 * HEIF codec.
 * Copyright (c) 2023 Dirk Farin <dirk.farin@gmail.com>
 * Copyright (c) 2025 Brad Hards <bradh@frogmouth.net>
 *
 * This file is part of libheif.
 *
 * libheif is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * libheif is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libheif.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBHEIF_HEIF_TEXT_H
#define LIBHEIF_HEIF_TEXT_H
 
#include "heif_image_handle.h"
#include "heif_library.h"
#include "heif_error.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
// --- text items and fonts
 
// See ISO/IEC 23008-12:2025 Section 6.10 "Text and font items"
 
typedef struct heif_text_item heif_text_item;

LIBHEIF_API
int heif_image_handle_get_number_of_text_items(const heif_image_handle* image_handle);

LIBHEIF_API
int heif_image_handle_get_list_of_text_item_ids(const heif_image_handle* image_handle,
                                                heif_item_id* text_item_ids_array,
                                                int max_count);
 

LIBHEIF_API
heif_error heif_context_get_text_item(const heif_context* context,
                                      heif_item_id text_item_id,
                                      heif_text_item** out);

LIBHEIF_API
heif_item_id heif_text_item_get_id(heif_text_item* text_item);

LIBHEIF_API
const char* heif_text_item_get_content(heif_text_item* text_item);

LIBHEIF_API
heif_error heif_text_item_get_property_extended_language(const heif_text_item* text_item,
                                                         char** out_language);
 
// --- adding text items

LIBHEIF_API
heif_error heif_image_handle_add_text_item(heif_image_handle *image_handle,
                                           const char *content_type,
                                           const char *text,
                                           heif_text_item** out_text_item);

LIBHEIF_API
void heif_text_item_release(heif_text_item* text_item);

LIBHEIF_API
heif_error heif_text_item_set_extended_language(heif_text_item* text_item,
                                                const char *language,
                                                heif_property_id* out_optional_propertyId);
 
#ifdef __cplusplus
}
#endif
 
#endif