libexif/exif-content.h

   1 /*! \file exif-content.h
   2  *  \brief Handling EXIF IFDs
   3  */
   4 /*
   5  * Copyright (c) 2001 Lutz Mueller <lutz@users.sourceforge.net>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library 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 GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifndef __EXIF_CONTENT_H__
  24 #define __EXIF_CONTENT_H__
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif /* __cplusplus */
  29
  30 /*! Holds all EXIF tags in a single IFD */
  31 typedef struct _ExifContent        ExifContent;
  32 typedef struct _ExifContentPrivate ExifContentPrivate;
  33
  34 #include <libexif/exif-tag.h>
  35 #include <libexif/exif-entry.h>
  36 #include <libexif/exif-data.h>
  37 #include <libexif/exif-log.h>
  38 #include <libexif/exif-mem.h>
  39
  40 struct _ExifContent
  41 {
  42         ExifEntry **entries;
  43         unsigned int count;
  44
  45         /* Data containing this content */
  46         ExifData *parent;
  47
  48         ExifContentPrivate *priv;
  49 };
  50
  51 /* Lifecycle */
  52 ExifContent *exif_content_new     (void);
  53 ExifContent *exif_content_new_mem (ExifMem *);
  54 void         exif_content_ref     (ExifContent *content);
  55 void         exif_content_unref   (ExifContent *content);
  56 void         exif_content_free    (ExifContent *content);
  57
  58 /*! Add an EXIF tag to an IFD.
  59  * If this tag already exists in the IFD, this function does nothing.
  60  *
  61  * \param[out] c IFD
  62  * \param[in] entry EXIF entry to add
  63  */
  64 void         exif_content_add_entry    (ExifContent *c, ExifEntry *entry);
  65
  66 /*! Remove an EXIF tag from an IFD.
  67  * If this tag does not exist in the IFD, this function does nothing.
  68  *
  69  * \param[out] c IFD
  70  * \param[in] e EXIF entry to remove
  71  */
  72 void         exif_content_remove_entry (ExifContent *c, ExifEntry *e);
  73
  74 /*! Return the #ExifEntry in this IFD corresponding to the given tag.
  75  *
  76  * \param[in] content EXIF content for an IFD
  77  * \param[in] tag EXIF tag to return
  78  * \return #ExifEntry of the tag, or NULL on error
  79  */
  80 ExifEntry   *exif_content_get_entry    (ExifContent *content, ExifTag tag);
  81
  82 /*! Fix the IFD to bring it into specification. Call #exif_entry_fix on
  83  * each entry in this IFD to fix existing entries, create any new entries
  84  * that are mandatory in this IFD but do not yet exist, and remove any
  85  * entries that are not allowed in this IFD.
  86  *
  87  * \param[in,out] c EXIF content for an IFD
  88  */
  89 void         exif_content_fix          (ExifContent *c);
  90
  91 typedef void (* ExifContentForeachEntryFunc) (ExifEntry *, void *user_data);
  92
  93 /*! Executes function on each EXIF tag in this IFD in turn.
  94  *
  95  * \param[in,out] content IFD over which to iterate
  96  * \param[in] func function to call for each entry
  97  * \param[in] user_data data to pass into func on each call
  98  */
  99 void         exif_content_foreach_entry (ExifContent *content,
 100                                          ExifContentForeachEntryFunc func,
 101                                          void *user_data);
 102
 103 /*! Return the IFD number in which the given #ExifContent is found.
 104  *
 105  * \param[in] c an #ExifContent*
 106  * \return IFD number, or #EXIF_IFD_COUNT on error
 107  */
 108 ExifIfd exif_content_get_ifd (ExifContent *c);
 109
 110 /*! Return a textual representation of the EXIF data for a tag.
 111  *
 112  * \param[in] c #ExifContent* for an IFD
 113  * \param[in] t #ExifTag to return
 114  * \param[out] v char* buffer in which to store value
 115  * \param[in] m unsigned int length of the buffer v
 116  * \return the v pointer, or NULL on error
 117  */
 118 #define exif_content_get_value(c,t,v,m)                                 \
 119         (exif_content_get_entry (c,t) ?                                 \
 120          exif_entry_get_value (exif_content_get_entry (c,t),v,m) : NULL)
 121
 122 /*! Dump contents of the IFD to stdout.
 123  * This is intended for diagnostic purposes only.
 124  *
 125  * \param[in] content IFD data
 126  * \param[in] indent how many levels deep to indent the data
 127  */
 128 void exif_content_dump  (ExifContent *content, unsigned int indent);
 129
 130 /*! Set the log message object for this IFD.
 131  *
 132  * \param[in] content IFD
 133  * \param[in] log #ExifLog*
 134  */
 135 void exif_content_log   (ExifContent *content, ExifLog *log);
 136
 137 #ifdef __cplusplus
 138 }
 139 #endif /* __cplusplus */
 140
 141 #endif /* __EXIF_CONTENT_H__ */