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 #include "typedefs.h"
  26
  27 struct ExifData;
  28 struct ExifItem;
  29 struct FileData;
  30
  31 #define EXIF_FORMATTED() "formatted."
  32 #define EXIF_FORMATTED_LEN (sizeof(EXIF_FORMATTED()) - 1)
  33
  34 /*
  35  *-----------------------------------------------------------------------------
  36  * Tag formats
  37  *-----------------------------------------------------------------------------
  38  */
  39
  40 #define EXIF_FORMAT_COUNT 13
  41
  42 enum ExifFormatType {
  43         EXIF_FORMAT_UNKNOWN             = 0,
  44         EXIF_FORMAT_BYTE_UNSIGNED       = 1,
  45         EXIF_FORMAT_STRING              = 2,
  46         EXIF_FORMAT_SHORT_UNSIGNED      = 3,
  47         EXIF_FORMAT_LONG_UNSIGNED       = 4,
  48         EXIF_FORMAT_RATIONAL_UNSIGNED   = 5,
  49         EXIF_FORMAT_BYTE                = 6,
  50         EXIF_FORMAT_UNDEFINED           = 7,
  51         EXIF_FORMAT_SHORT               = 8,
  52         EXIF_FORMAT_LONG                = 9,
  53         EXIF_FORMAT_RATIONAL            = 10,
  54         EXIF_FORMAT_FLOAT               = 11,
  55         EXIF_FORMAT_DOUBLE              = 12
  56 };
  57
  58
  59 /*
  60  *-----------------------------------------------------------------------------
  61  * Data storage
  62  *-----------------------------------------------------------------------------
  63  */
  64
  65 struct ExifRational
  66 {
  67         guint32 num;
  68         guint32 den;
  69 };
  70
  71
  72 /* enums useful for image manipulation */
  73
  74 enum ExifOrientationType {
  75         EXIF_ORIENTATION_UNKNOWN        = 0,
  76         EXIF_ORIENTATION_TOP_LEFT       = 1,
  77         EXIF_ORIENTATION_TOP_RIGHT      = 2,
  78         EXIF_ORIENTATION_BOTTOM_RIGHT   = 3,
  79         EXIF_ORIENTATION_BOTTOM_LEFT    = 4,
  80         EXIF_ORIENTATION_LEFT_TOP       = 5,
  81         EXIF_ORIENTATION_RIGHT_TOP      = 6,
  82         EXIF_ORIENTATION_RIGHT_BOTTOM   = 7,
  83         EXIF_ORIENTATION_LEFT_BOTTOM    = 8
  84 };
  85
  86 enum ExifUnitType {
  87         EXIF_UNIT_UNKNOWN       = 0,
  88         EXIF_UNIT_NOUNIT        = 1,
  89         EXIF_UNIT_INCH          = 2,
  90         EXIF_UNIT_CENTIMETER    = 3
  91 };
  92
  93 struct ExifFormattedText
  94 {
  95         const gchar *key;
  96         const gchar *description;
  97         gchar *(*build_func)(ExifData *exif);
  98 };
  99
 100 /*
 101  *-----------------------------------------------------------------------------
 102  * functions
 103  *-----------------------------------------------------------------------------
 104  */
 105
 106 void exif_init();
 107
 108 ExifData *exif_read(gchar *path, gchar *sidecar_path, GHashTable *modified_xmp);
 109
 110 ExifData *exif_read_fd(FileData *fd);
 111 void exif_free_fd(FileData *fd, ExifData *exif);
 112
 113 /**
 114  * @headerfile exif_get_original
 115  * exif_read returns processed data (merged from image and sidecar, etc.)
 116  * this function gives access to the original data from the image.
 117  * original data are part of the processed data and should not be freed separately
 118  */
 119 ExifData *exif_get_original(ExifData *exif);
 120
 121
 122 gboolean exif_write(ExifData *exif);
 123 gboolean exif_write_sidecar(ExifData *exif, gchar *path);
 124
 125 void exif_free(ExifData *exif);
 126
 127 gchar *exif_get_data_as_text(ExifData *exif, const gchar *key);
 128 gint exif_get_integer(ExifData *exif, const gchar *key, gint *value);
 129 ExifRational *exif_get_rational(ExifData *exif, const gchar *key, gint *sign);
 130
 131 ExifItem *exif_get_item(ExifData *exif, const gchar *key);
 132 ExifItem *exif_get_first_item(ExifData *exif);
 133 ExifItem *exif_get_next_item(ExifData *exif);
 134
 135
 136 gchar *exif_item_get_tag_name(ExifItem *item);
 137 guint exif_item_get_tag_id(ExifItem *item);
 138 guint exif_item_get_elements(ExifItem *item);
 139 gchar *exif_item_get_data(ExifItem *item, guint *data_len);
 140 gchar *exif_item_get_description(ExifItem *item);
 141 guint exif_item_get_format_id(ExifItem *item);
 142 const gchar *exif_item_get_format_name(ExifItem *item, gboolean brief);
 143 gchar *exif_item_get_data_as_text(ExifItem *item, ExifData *exif);
 144 gint exif_item_get_integer(ExifItem *item, gint *value);
 145 ExifRational *exif_item_get_rational(ExifItem *item, gint *sign, guint n);
 146
 147 gchar *exif_item_get_string(ExifItem *item, gint idx);
 148
 149 gchar *exif_get_description_by_key(const gchar *key);
 150 gchar *exif_get_tag_description_by_key(const gchar *key);
 151
 152 gchar *exif_get_formatted_by_key(ExifData *exif, const gchar *key, gboolean *key_valid);
 153
 154 gint exif_update_metadata(ExifData *exif, const gchar *key, const GList *values);
 155 GList *exif_get_metadata(ExifData *exif, const gchar *key, MetadataFormat format);
 156
 157 guchar *exif_get_color_profile(ExifData *exif, guint *data_len);
 158
 159 /* jpeg embedded icc support */
 160
 161 void exif_add_jpeg_color_profile(ExifData *exif, guchar *cp_data, guint cp_length);
 162
 163
 164 gboolean exif_jpeg_parse_color(ExifData *exif, guchar *data, guint size);
 165
 166 /* support for so called "jpeg comment" */
 167 gchar* exif_get_image_comment(FileData* fd);
 168 void exif_set_image_comment(FileData* fd, const gchar* comment);
 169
 170 /*raw support */
 171 guchar *exif_get_preview(ExifData *exif, guint *data_len, gint requested_width, gint requested_height);
 172 void exif_free_preview(const guchar *buf);
 173
 174 gchar *metadata_file_info(FileData *fd, const gchar *key, MetadataFormat format);
 175 gchar *metadata_lua_info(FileData *fd, const gchar *key, MetadataFormat format);
 176
 177 #endif
 178 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */