src/exif.h

   1 /*
   2  * Copyright (C) 2006 John Ellis
   3  * Copyright (C) 2008 - 2016 The Geeqie Team
   4  *
   5  * Authors: Eric Swalens, Quy Tonthat, John Ellis
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef __EXIF_H
  23 #define __EXIF_H
  24
  25 #define EXIF_FORMATTED() "formatted."
  26 #define EXIF_FORMATTED_LEN (sizeof(EXIF_FORMATTED()) - 1)
  27
  28 /*
  29  *-----------------------------------------------------------------------------
  30  * Tag formats
  31  *-----------------------------------------------------------------------------
  32  */
  33
  34 #define EXIF_FORMAT_COUNT 13
  35
  36 enum ExifFormatType {
  37         EXIF_FORMAT_UNKNOWN             = 0,
  38         EXIF_FORMAT_BYTE_UNSIGNED       = 1,
  39         EXIF_FORMAT_STRING              = 2,
  40         EXIF_FORMAT_SHORT_UNSIGNED      = 3,
  41         EXIF_FORMAT_LONG_UNSIGNED       = 4,
  42         EXIF_FORMAT_RATIONAL_UNSIGNED   = 5,
  43         EXIF_FORMAT_BYTE                = 6,
  44         EXIF_FORMAT_UNDEFINED           = 7,
  45         EXIF_FORMAT_SHORT               = 8,
  46         EXIF_FORMAT_LONG                = 9,
  47         EXIF_FORMAT_RATIONAL            = 10,
  48         EXIF_FORMAT_FLOAT               = 11,
  49         EXIF_FORMAT_DOUBLE              = 12
  50 };
  51
  52
  53 /*
  54  *-----------------------------------------------------------------------------
  55  * Data storage
  56  *-----------------------------------------------------------------------------
  57  */
  58
  59 struct ExifItem;
  60
  61 struct ExifRational
  62 {
  63         guint32 num;
  64         guint32 den;
  65 };
  66
  67
  68 /* enums useful for image manipulation */
  69
  70 enum ExifOrientationType {
  71         EXIF_ORIENTATION_UNKNOWN        = 0,
  72         EXIF_ORIENTATION_TOP_LEFT       = 1,
  73         EXIF_ORIENTATION_TOP_RIGHT      = 2,
  74         EXIF_ORIENTATION_BOTTOM_RIGHT   = 3,
  75         EXIF_ORIENTATION_BOTTOM_LEFT    = 4,
  76         EXIF_ORIENTATION_LEFT_TOP       = 5,
  77         EXIF_ORIENTATION_RIGHT_TOP      = 6,
  78         EXIF_ORIENTATION_RIGHT_BOTTOM   = 7,
  79         EXIF_ORIENTATION_LEFT_BOTTOM    = 8
  80 };
  81
  82 enum ExifUnitType {
  83         EXIF_UNIT_UNKNOWN       = 0,
  84         EXIF_UNIT_NOUNIT        = 1,
  85         EXIF_UNIT_INCH          = 2,
  86         EXIF_UNIT_CENTIMETER    = 3
  87 };
  88
  89 struct ExifFormattedText
  90 {
  91         const gchar *key;
  92         const gchar *description;
  93         gchar *(*build_func)(ExifData *exif);
  94 };
  95
  96 /*
  97  *-----------------------------------------------------------------------------
  98  * functions
  99  *-----------------------------------------------------------------------------
 100  */
 101
 102 void exif_init();
 103
 104 ExifData *exif_read(gchar *path, gchar *sidecar_path, GHashTable *modified_xmp);
 105
 106 ExifData *exif_read_fd(FileData *fd);
 107 void exif_free_fd(FileData *fd, ExifData *exif);
 108
 109 /**
 110  * @headerfile exif_get_original
 111  * exif_read returns processed data (merged from image and sidecar, etc.)
 112  * this function gives access to the original data from the image.
 113  * original data are part of the processed data and should not be freed separately
 114  */
 115 ExifData *exif_get_original(ExifData *exif);
 116
 117
 118 gboolean exif_write(ExifData *exif);
 119 gboolean exif_write_sidecar(ExifData *exif, gchar *path);
 120
 121 void exif_free(ExifData *exif);
 122
 123 gchar *exif_get_data_as_text(ExifData *exif, const gchar *key);
 124 gint exif_get_integer(ExifData *exif, const gchar *key, gint *value);
 125 ExifRational *exif_get_rational(ExifData *exif, const gchar *key, gint *sign);
 126
 127 ExifItem *exif_get_item(ExifData *exif, const gchar *key);
 128 ExifItem *exif_get_first_item(ExifData *exif);
 129 ExifItem *exif_get_next_item(ExifData *exif);
 130
 131
 132 gchar *exif_item_get_tag_name(ExifItem *item);
 133 guint exif_item_get_tag_id(ExifItem *item);
 134 guint exif_item_get_elements(ExifItem *item);
 135 gchar *exif_item_get_data(ExifItem *item, guint *data_len);
 136 gchar *exif_item_get_description(ExifItem *item);
 137 guint exif_item_get_format_id(ExifItem *item);
 138 const gchar *exif_item_get_format_name(ExifItem *item, gboolean brief);
 139 gchar *exif_item_get_data_as_text(ExifItem *item);
 140 gint exif_item_get_integer(ExifItem *item, gint *value);
 141 ExifRational *exif_item_get_rational(ExifItem *item, gint *sign, guint n);
 142
 143 gchar *exif_item_get_string(ExifItem *item, gint idx);
 144
 145 gchar *exif_get_description_by_key(const gchar *key);
 146 gchar *exif_get_tag_description_by_key(const gchar *key);
 147
 148 gchar *exif_get_formatted_by_key(ExifData *exif, const gchar *key, gboolean *key_valid);
 149
 150 gint exif_update_metadata(ExifData *exif, const gchar *key, const GList *values);
 151 GList *exif_get_metadata(ExifData *exif, const gchar *key, MetadataFormat format);
 152
 153 guchar *exif_get_color_profile(ExifData *exif, guint *data_len);
 154
 155 /* jpeg embedded icc support */
 156
 157 void exif_add_jpeg_color_profile(ExifData *exif, guchar *cp_data, guint cp_length);
 158
 159
 160 gboolean exif_jpeg_parse_color(ExifData *exif, guchar *data, guint size);
 161
 162 /* support for so called "jpeg comment" */
 163 gchar* exif_get_image_comment(FileData* fd);
 164 void exif_set_image_comment(FileData* fd, const gchar* comment);
 165
 166 /*raw support */
 167 guchar *exif_get_preview(ExifData *exif, guint *data_len, gint requested_width, gint requested_height);
 168 void exif_free_preview(guchar *buf);
 169
 170 gchar *metadata_file_info(FileData *fd, const gchar *key, MetadataFormat format);
 171 gchar *metadata_lua_info(FileData *fd, const gchar *key, MetadataFormat format);
 172
 173 #endif
 174 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */