libexif/exif-data.h

   1 /*! \file exif-data.h
   2  * \brief Defines the ExifData type and the associated functions.
   3  */
   4 /*
   5  * \author Lutz Mueller <lutz@users.sourceforge.net>
   6  * \date 2001-2005
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 #ifndef __EXIF_DATA_H__
  25 #define __EXIF_DATA_H__
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif /* __cplusplus */
  30
  31 #include <libexif/exif-byte-order.h>
  32 #include <libexif/exif-data-type.h>
  33 #include <libexif/exif-ifd.h>
  34 #include <libexif/exif-log.h>
  35 #include <libexif/exif-tag.h>
  36
  37 /*! Represents the entire EXIF data found in an image */
  38 typedef struct _ExifData        ExifData;
  39 typedef struct _ExifDataPrivate ExifDataPrivate;
  40
  41 #include <libexif/exif-content.h>
  42 #include <libexif/exif-mnote-data.h>
  43 #include <libexif/exif-mem.h>
  44
  45 /*! Represents the entire EXIF data found in an image */
  46 struct _ExifData
  47 {
  48         /*! Data for each IFD */
  49         ExifContent *ifd[EXIF_IFD_COUNT];
  50
  51         /*! Pointer to thumbnail image, or NULL if not available */
  52         unsigned char *data;
  53
  54         /*! Number of bytes in thumbnail image at \c data */
  55         unsigned int size;
  56
  57         ExifDataPrivate *priv;
  58 };
  59
  60 /*! Allocate a new, empty #ExifData.
  61  *
  62  * \return allocated #ExifData, or NULL on error
  63  */
  64 ExifData *exif_data_new           (void);
  65
  66 ExifData *exif_data_new_mem       (ExifMem *);
  67
  68 /*! Allocate a new #ExifData and load EXIF data from a JPEG file.
  69  * Uses an #ExifLoader internally to do the loading.
  70  *
  71  * \param[in] path filename including path
  72  * \return allocated #ExifData, or NULL on error
  73  */
  74 ExifData *exif_data_new_from_file (const char *path);
  75
  76 /*! Allocate a new #ExifData and load EXIF data from a memory buffer.
  77  *
  78  * \param[in] data pointer to raw JPEG or EXIF data
  79  * \param[in] size number of bytes of data at data
  80  * \return allocated #ExifData, or NULL on error
  81  */
  82 ExifData *exif_data_new_from_data (const unsigned char *data,
  83                                    unsigned int size);
  84
  85 /*! Load the #ExifData structure from the raw JPEG or EXIF data in the given
  86  * memory buffer. If the EXIF data contains a recognized MakerNote, it is
  87  * loaded and stored as well for later retrieval by #exif_data_get_mnote_data.
  88  *
  89  * \param[in,out] data EXIF data
  90  * \param[in] d pointer to raw JPEG or EXIF data
  91  * \param[in] size number of bytes of data at d
  92  */
  93 void      exif_data_load_data (ExifData *data, const unsigned char *d,
  94                                unsigned int size);
  95
  96 /*! Store raw EXIF data representing the #ExifData structure into a memory
  97  * buffer. The buffer is allocated by this function and must subsequently be
  98  * freed by the caller.
  99  *
 100  * \param[in] data EXIF data
 101  * \param[out] d pointer to buffer pointer containing raw EXIF data on return
 102  * \param[out] ds pointer to variable to hold the number of bytes of
 103  *   data at d, or set to 0 on error
 104  */
 105 void      exif_data_save_data (ExifData *data, unsigned char **d,
 106                                unsigned int *ds);
 107
 108 void      exif_data_ref   (ExifData *data);
 109 void      exif_data_unref (ExifData *data);
 110 void      exif_data_free  (ExifData *data);
 111
 112 /*! Return the byte order in use by this EXIF structure.
 113  *
 114  * \param[in] data EXIF data
 115  * \return byte order
 116  */
 117 ExifByteOrder exif_data_get_byte_order  (ExifData *data);
 118
 119 /*! Set the byte order to use for this EXIF data. If any tags already exist
 120  * (including MakerNote tags) they are are converted to the specified byte
 121  * order.
 122  *
 123  * \param[in,out] data EXIF data
 124  * \param[in] order byte order
 125  */
 126 void          exif_data_set_byte_order  (ExifData *data, ExifByteOrder order);
 127
 128 /*! Return the MakerNote data out of the EXIF data.  Only certain
 129  * MakerNote formats that are recognized by libexif are supported.
 130  *
 131  * \param[in] d EXIF data
 132  * \return MakerNote data, or NULL if not found or not supported
 133  */
 134 ExifMnoteData *exif_data_get_mnote_data (ExifData *d);
 135
 136 /*! Fix the EXIF data to bring it into specification. Call #exif_content_fix
 137  * on each IFD to fix existing entries, create any new entries that are
 138  * mandatory but do not yet exist, and remove any entries that are not
 139  * allowed.
 140  *
 141  * \param[in,out] d EXIF data
 142  */
 143 void           exif_data_fix (ExifData *d);
 144
 145 typedef void (* ExifDataForeachContentFunc) (ExifContent *, void *user_data);
 146
 147 /*! Execute a function on each IFD in turn.
 148  *
 149  * \param[in] data EXIF data over which to iterate
 150  * \param[in] func function to call for each entry
 151  * \param[in] user_data data to pass into func on each call
 152  */
 153 void          exif_data_foreach_content (ExifData *data,
 154                                          ExifDataForeachContentFunc func,
 155                                          void *user_data);
 156
 157 /*! Options to configure the behaviour of #ExifData */
 158 typedef enum {
 159         /*! Act as though unknown tags are not present */
 160         EXIF_DATA_OPTION_IGNORE_UNKNOWN_TAGS = 1 << 0,
 161
 162         /*! Fix the EXIF tags to follow the spec */
 163         EXIF_DATA_OPTION_FOLLOW_SPECIFICATION = 1 << 1,
 164
 165         /*! Leave the MakerNote alone, which could cause it to be corrupted */
 166         EXIF_DATA_OPTION_DONT_CHANGE_MAKER_NOTE = 1 << 2
 167 } ExifDataOption;
 168
 169 /*! Return a short textual description of the given #ExifDataOption.
 170  *
 171  * \param[in] o option
 172  * \return localized textual description of the option
 173  */
 174 const char *exif_data_option_get_name        (ExifDataOption o);
 175
 176 /*! Return a verbose textual description of the given #ExifDataOption.
 177  *
 178  * \param[in] o option
 179  * \return verbose localized textual description of the option
 180  */
 181 const char *exif_data_option_get_description (ExifDataOption o);
 182
 183 /*! Set the given option on the given #ExifData.
 184  *
 185  * \param[in] d EXIF data
 186  * \param[in] o option
 187  */
 188 void        exif_data_set_option             (ExifData *d, ExifDataOption o);
 189
 190 /*! Clear the given option on the given #ExifData.
 191  *
 192  * \param[in] d EXIF data
 193  * \param[in] o option
 194  */
 195 void        exif_data_unset_option           (ExifData *d, ExifDataOption o);
 196
 197 /*! Set the data type for the given #ExifData.
 198  *
 199  * \param[in] d EXIF data
 200  * \param[in] dt data type
 201  */
 202 void         exif_data_set_data_type (ExifData *d, ExifDataType dt);
 203
 204 /*! Return the data type for the given #ExifData.
 205  *
 206  * \param[in] d EXIF data
 207  * \return data type, or #EXIF_DATA_TYPE_COUNT on error
 208  */
 209 ExifDataType exif_data_get_data_type (ExifData *d);
 210
 211 /*! Dump all EXIF data to stdout.
 212  * This is intended for diagnostic purposes only.
 213  *
 214  * \param[in] data EXIF data
 215  */
 216 void exif_data_dump (ExifData *data);
 217
 218 /*! Set the log message object for all IFDs.
 219  *
 220  * \param[in] data EXIF data
 221  * \param[in] log #ExifLog
 222  */
 223 void exif_data_log  (ExifData *data, ExifLog *log);
 224
 225 /*! Return an #ExifEntry for the given tag if found in any IFD.
 226  * Each IFD is searched in turn and the first containing a tag with
 227  * this number is returned.
 228  *
 229  * \param[in] d #ExifData
 230  * \param[in] t #ExifTag
 231  * \return #ExifEntry* if found, else NULL if not found
 232  */
 233 #define exif_data_get_entry(d,t)                                        \
 234         (exif_content_get_entry(d->ifd[EXIF_IFD_0],t) ?                 \
 235          exif_content_get_entry(d->ifd[EXIF_IFD_0],t) :                 \
 236          exif_content_get_entry(d->ifd[EXIF_IFD_1],t) ?                 \
 237          exif_content_get_entry(d->ifd[EXIF_IFD_1],t) :                 \
 238          exif_content_get_entry(d->ifd[EXIF_IFD_EXIF],t) ?              \
 239          exif_content_get_entry(d->ifd[EXIF_IFD_EXIF],t) :              \
 240          exif_content_get_entry(d->ifd[EXIF_IFD_GPS],t) ?               \
 241          exif_content_get_entry(d->ifd[EXIF_IFD_GPS],t) :               \
 242          exif_content_get_entry(d->ifd[EXIF_IFD_INTEROPERABILITY],t) ?  \
 243          exif_content_get_entry(d->ifd[EXIF_IFD_INTEROPERABILITY],t) : NULL)
 244
 245 #ifdef __cplusplus
 246 }
 247 #endif /* __cplusplus */
 248
 249 #endif /* __EXIF_DATA_H__ */