• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*! \file exif-tag.h
2  *  \brief Handling EXIF tags
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., 51 Franklin Street, Fifth Floor,
20  * Boston, MA  02110-1301  USA.
21  */
22 
23 #ifndef LIBEXIF_EXIF_TAG_H
24 #define LIBEXIF_EXIF_TAG_H
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29 
30 #include <libexif/exif-ifd.h>
31 #include <libexif/exif-data-type.h>
32 
33 /*! EXIF tags */
34 typedef enum {
35 	EXIF_TAG_GPS_VERSION_ID        = 0x0000,
36 	EXIF_TAG_GPS_LATITUDE_REF      = 0x0001, /* INTEROPERABILITY_INDEX   */
37 	EXIF_TAG_GPS_LATITUDE          = 0x0002, /* INTEROPERABILITY_VERSION */
38 	EXIF_TAG_GPS_LONGITUDE_REF     = 0x0003,
39 	EXIF_TAG_GPS_LONGITUDE         = 0x0004,
40 	EXIF_TAG_GPS_ALTITUDE_REF      = 0x0005,
41 	EXIF_TAG_GPS_ALTITUDE          = 0x0006,
42 	EXIF_TAG_GPS_TIME_STAMP        = 0x0007,
43 	EXIF_TAG_GPS_SATELLITES        = 0x0008,
44 	EXIF_TAG_GPS_STATUS            = 0x0009,
45 	EXIF_TAG_GPS_MEASURE_MODE      = 0x000a,
46 	EXIF_TAG_GPS_DOP               = 0x000b,
47 	EXIF_TAG_GPS_SPEED_REF         = 0x000c,
48 	EXIF_TAG_GPS_SPEED             = 0x000d,
49 	EXIF_TAG_GPS_TRACK_REF         = 0x000e,
50 	EXIF_TAG_GPS_TRACK             = 0x000f,
51 	EXIF_TAG_GPS_IMG_DIRECTION_REF = 0x0010,
52 	EXIF_TAG_GPS_IMG_DIRECTION     = 0x0011,
53 	EXIF_TAG_GPS_MAP_DATUM         = 0x0012,
54 	EXIF_TAG_GPS_DEST_LATITUDE_REF = 0x0013,
55 	EXIF_TAG_GPS_DEST_LATITUDE     = 0x0014,
56 	EXIF_TAG_GPS_DEST_LONGITUDE_REF = 0x0015,
57 	EXIF_TAG_GPS_DEST_LONGITUDE     = 0x0016,
58 	EXIF_TAG_GPS_DEST_BEARING_REF   = 0x0017,
59 	EXIF_TAG_GPS_DEST_BEARING       = 0x0018,
60 	EXIF_TAG_GPS_DEST_DISTANCE_REF  = 0x0019,
61 	EXIF_TAG_GPS_DEST_DISTANCE      = 0x001a,
62 	EXIF_TAG_GPS_PROCESSING_METHOD  = 0x001b,
63 	EXIF_TAG_GPS_AREA_INFORMATION   = 0x001c,
64 	EXIF_TAG_GPS_DATE_STAMP         = 0x001d,
65 	EXIF_TAG_GPS_DIFFERENTIAL       = 0x001e,
66 	EXIF_TAG_GPS_H_POSITIONING_ERROR = 0x001f,
67 	EXIF_TAG_INTEROPERABILITY_INDEX		= 0x0001,
68 	EXIF_TAG_INTEROPERABILITY_VERSION	= 0x0002,
69 	EXIF_TAG_NEW_SUBFILE_TYPE		= 0x00fe,
70 	EXIF_TAG_IMAGE_WIDTH 			= 0x0100,
71 	EXIF_TAG_IMAGE_LENGTH 			= 0x0101,
72 	EXIF_TAG_BITS_PER_SAMPLE 		= 0x0102,
73 	EXIF_TAG_COMPRESSION 			= 0x0103,
74 	EXIF_TAG_PHOTOMETRIC_INTERPRETATION 	= 0x0106,
75 	EXIF_TAG_FILL_ORDER 			= 0x010a,
76 	EXIF_TAG_DOCUMENT_NAME 			= 0x010d,
77 	EXIF_TAG_IMAGE_DESCRIPTION 		= 0x010e,
78 	EXIF_TAG_MAKE 				= 0x010f,
79 	EXIF_TAG_MODEL 				= 0x0110,
80 	EXIF_TAG_STRIP_OFFSETS 			= 0x0111,
81 	EXIF_TAG_ORIENTATION 			= 0x0112,
82 	EXIF_TAG_SAMPLES_PER_PIXEL 		= 0x0115,
83 	EXIF_TAG_ROWS_PER_STRIP 		= 0x0116,
84 	EXIF_TAG_STRIP_BYTE_COUNTS		= 0x0117,
85 	EXIF_TAG_X_RESOLUTION 			= 0x011a,
86 	EXIF_TAG_Y_RESOLUTION 			= 0x011b,
87 	EXIF_TAG_PLANAR_CONFIGURATION 		= 0x011c,
88 	EXIF_TAG_RESOLUTION_UNIT 		= 0x0128,
89 	EXIF_TAG_TRANSFER_FUNCTION 		= 0x012d,
90 	EXIF_TAG_SOFTWARE 			= 0x0131,
91 	EXIF_TAG_DATE_TIME			= 0x0132,
92 	EXIF_TAG_ARTIST				= 0x013b,
93 	EXIF_TAG_WHITE_POINT			= 0x013e,
94 	EXIF_TAG_PRIMARY_CHROMATICITIES		= 0x013f,
95 	EXIF_TAG_SUB_IFDS			= 0x014a,
96 	EXIF_TAG_TRANSFER_RANGE			= 0x0156,
97 	EXIF_TAG_JPEG_PROC			= 0x0200,
98 	EXIF_TAG_JPEG_INTERCHANGE_FORMAT	= 0x0201,
99 	EXIF_TAG_JPEG_INTERCHANGE_FORMAT_LENGTH	= 0x0202,
100 	EXIF_TAG_YCBCR_COEFFICIENTS		= 0x0211,
101 	EXIF_TAG_YCBCR_SUB_SAMPLING		= 0x0212,
102 	EXIF_TAG_YCBCR_POSITIONING		= 0x0213,
103 	EXIF_TAG_REFERENCE_BLACK_WHITE		= 0x0214,
104 	EXIF_TAG_XML_PACKET			= 0x02bc,
105 	EXIF_TAG_RELATED_IMAGE_FILE_FORMAT	= 0x1000,
106 	EXIF_TAG_RELATED_IMAGE_WIDTH		= 0x1001,
107 	EXIF_TAG_RELATED_IMAGE_LENGTH		= 0x1002,
108 	EXIF_TAG_IMAGE_DEPTH			= 0x80e5,
109 	EXIF_TAG_CFA_REPEAT_PATTERN_DIM		= 0x828d,
110 	EXIF_TAG_CFA_PATTERN			= 0x828e,
111 	EXIF_TAG_BATTERY_LEVEL			= 0x828f,
112 	EXIF_TAG_COPYRIGHT			= 0x8298,
113 	EXIF_TAG_EXPOSURE_TIME			= 0x829a,
114 	EXIF_TAG_FNUMBER			= 0x829d,
115 	EXIF_TAG_IPTC_NAA			= 0x83bb,
116 	EXIF_TAG_IMAGE_RESOURCES		= 0x8649,
117 	EXIF_TAG_EXIF_IFD_POINTER		= 0x8769,
118 	EXIF_TAG_INTER_COLOR_PROFILE		= 0x8773,
119 	EXIF_TAG_EXPOSURE_PROGRAM		= 0x8822,
120 	EXIF_TAG_SPECTRAL_SENSITIVITY		= 0x8824,
121 	EXIF_TAG_GPS_INFO_IFD_POINTER		= 0x8825,
122 	EXIF_TAG_ISO_SPEED_RATINGS		= 0x8827,
123 	EXIF_TAG_OECF				= 0x8828,
124 	EXIF_TAG_TIME_ZONE_OFFSET		= 0x882a,
125 	EXIF_TAG_SENSITIVITY_TYPE		= 0x8830,
126 	EXIF_TAG_STANDARD_OUTPUT_SENSITIVITY	= 0x8831,
127 	EXIF_TAG_RECOMMENDED_EXPOSURE_INDEX	= 0x8832,
128 	EXIF_TAG_ISO_SPEED			= 0x8833,
129 	EXIF_TAG_ISO_SPEEDLatitudeYYY		= 0x8834,
130 	EXIF_TAG_ISO_SPEEDLatitudeZZZ		= 0x8835,
131 	EXIF_TAG_EXIF_VERSION			= 0x9000,
132 	EXIF_TAG_DATE_TIME_ORIGINAL		= 0x9003,
133 	EXIF_TAG_DATE_TIME_DIGITIZED		= 0x9004,
134 	EXIF_TAG_OFFSET_TIME			= 0x9010,
135 	EXIF_TAG_OFFSET_TIME_ORIGINAL		= 0x9011,
136 	EXIF_TAG_OFFSET_TIME_DIGITIZED		= 0x9012,
137 	EXIF_TAG_COMPONENTS_CONFIGURATION	= 0x9101,
138 	EXIF_TAG_COMPRESSED_BITS_PER_PIXEL	= 0x9102,
139 	EXIF_TAG_SHUTTER_SPEED_VALUE		= 0x9201,
140 	EXIF_TAG_APERTURE_VALUE			= 0x9202,
141 	EXIF_TAG_BRIGHTNESS_VALUE		= 0x9203,
142 	EXIF_TAG_EXPOSURE_BIAS_VALUE		= 0x9204,
143 	EXIF_TAG_MAX_APERTURE_VALUE		= 0x9205,
144 	EXIF_TAG_SUBJECT_DISTANCE		= 0x9206,
145 	EXIF_TAG_METERING_MODE			= 0x9207,
146 	EXIF_TAG_LIGHT_SOURCE			= 0x9208,
147 	EXIF_TAG_FLASH				= 0x9209,
148 	EXIF_TAG_FOCAL_LENGTH			= 0x920a,
149 	EXIF_TAG_SUBJECT_AREA			= 0x9214,
150 	EXIF_TAG_TIFF_EP_STANDARD_ID		= 0x9216,
151 	EXIF_TAG_MAKER_NOTE			= 0x927c,
152 	EXIF_TAG_USER_COMMENT			= 0x9286,
153 	EXIF_TAG_SUB_SEC_TIME			= 0x9290,
154 	EXIF_TAG_SUB_SEC_TIME_ORIGINAL		= 0x9291,
155 	EXIF_TAG_SUB_SEC_TIME_DIGITIZED		= 0x9292,
156 	EXIF_TAG_XP_TITLE			= 0x9c9b,
157 	EXIF_TAG_XP_COMMENT			= 0x9c9c,
158 	EXIF_TAG_XP_AUTHOR			= 0x9c9d,
159 	EXIF_TAG_XP_KEYWORDS			= 0x9c9e,
160 	EXIF_TAG_XP_SUBJECT			= 0x9c9f,
161 	EXIF_TAG_FLASH_PIX_VERSION		= 0xa000,
162 	EXIF_TAG_COLOR_SPACE			= 0xa001,
163 	EXIF_TAG_PIXEL_X_DIMENSION		= 0xa002,
164 	EXIF_TAG_PIXEL_Y_DIMENSION		= 0xa003,
165 	EXIF_TAG_RELATED_SOUND_FILE		= 0xa004,
166 	EXIF_TAG_INTEROPERABILITY_IFD_POINTER	= 0xa005,
167 	EXIF_TAG_FLASH_ENERGY			= 0xa20b,
168 	EXIF_TAG_SPATIAL_FREQUENCY_RESPONSE	= 0xa20c,
169 	EXIF_TAG_FOCAL_PLANE_X_RESOLUTION	= 0xa20e,
170 	EXIF_TAG_FOCAL_PLANE_Y_RESOLUTION	= 0xa20f,
171 	EXIF_TAG_FOCAL_PLANE_RESOLUTION_UNIT	= 0xa210,
172 	EXIF_TAG_SUBJECT_LOCATION		= 0xa214,
173 	EXIF_TAG_EXPOSURE_INDEX			= 0xa215,
174 	EXIF_TAG_SENSING_METHOD			= 0xa217,
175 	EXIF_TAG_FILE_SOURCE			= 0xa300,
176 	EXIF_TAG_SCENE_TYPE			= 0xa301,
177 	EXIF_TAG_NEW_CFA_PATTERN		= 0xa302,
178 	EXIF_TAG_CUSTOM_RENDERED		= 0xa401,
179 	EXIF_TAG_EXPOSURE_MODE			= 0xa402,
180 	EXIF_TAG_WHITE_BALANCE			= 0xa403,
181 	EXIF_TAG_DIGITAL_ZOOM_RATIO		= 0xa404,
182 	EXIF_TAG_FOCAL_LENGTH_IN_35MM_FILM	= 0xa405,
183 	EXIF_TAG_SCENE_CAPTURE_TYPE		= 0xa406,
184 	EXIF_TAG_GAIN_CONTROL			= 0xa407,
185 	EXIF_TAG_CONTRAST			= 0xa408,
186 	EXIF_TAG_SATURATION			= 0xa409,
187 	EXIF_TAG_SHARPNESS			= 0xa40a,
188 	EXIF_TAG_DEVICE_SETTING_DESCRIPTION	= 0xa40b,
189 	EXIF_TAG_SUBJECT_DISTANCE_RANGE		= 0xa40c,
190 	EXIF_TAG_IMAGE_UNIQUE_ID		= 0xa420,
191 	EXIF_TAG_CAMERA_OWNER_NAME 		= 0xa430,
192 	EXIF_TAG_BODY_SERIAL_NUMBER 		= 0xa431,
193 	EXIF_TAG_LENS_SPECIFICATION 		= 0xa432,
194 	EXIF_TAG_LENS_MAKE	 		= 0xa433,
195 	EXIF_TAG_LENS_MODEL	 		= 0xa434,
196 	EXIF_TAG_LENS_SERIAL_NUMBER 		= 0xa435,
197 	EXIF_TAG_COMPOSITE_IMAGE 		= 0xa460,
198 	EXIF_TAG_SOURCE_IMAGE_NUMBER_OF_COMPOSITE_IMAGE 		= 0xa461,
199 	EXIF_TAG_SOURCE_EXPOSURE_TIMES_OF_COMPOSITE_IMAGE 		= 0xa462,
200 	EXIF_TAG_GAMMA				= 0xa500,
201 	EXIF_TAG_PRINT_IMAGE_MATCHING		= 0xc4a5,
202 	EXIF_TAG_PADDING			= 0xea1c
203 } ExifTag;
204 
205 /* GPS tags overlap with above ones. */
206 
207 
208 /*! What level of support a tag enjoys in the EXIF standard */
209 typedef enum {
210 	/*! The meaning of this tag is unknown */
211 	EXIF_SUPPORT_LEVEL_UNKNOWN = 0,
212 
213 	/*! This tag is not allowed in the given IFD */
214 	EXIF_SUPPORT_LEVEL_NOT_RECORDED,
215 
216 	/*! This tag is mandatory in the given IFD */
217 	EXIF_SUPPORT_LEVEL_MANDATORY,
218 
219 	/*! This tag is optional in the given IFD */
220 	EXIF_SUPPORT_LEVEL_OPTIONAL
221 } ExifSupportLevel;
222 
223 /*! Return the tag ID given its unique textual name.
224  *
225  * \param[in] name tag name
226  * \return tag ID, or 0 if tag not found
227  * \note The tag not found value cannot be distinguished from a legitimate
228  *   tag number 0.
229  */
230 ExifTag          exif_tag_from_name                (const char *name);
231 
232 /*! Return a textual name of the given tag when found in the given IFD. The
233  * name is a short, unique, non-localized text string containing only
234  * US-ASCII alphanumeric characters.
235  *
236  * \param[in] tag EXIF tag
237  * \param[in] ifd IFD
238  * \return textual name of the tag, or NULL if the tag is unknown
239  */
240 const char      *exif_tag_get_name_in_ifd          (ExifTag tag, ExifIfd ifd);
241 
242 /*! Return a textual title of the given tag when found in the given IFD.
243  * The title is a short, localized description of the tag.
244  *
245  * \param[in] tag EXIF tag
246  * \param[in] ifd IFD
247  * \return textual title of the tag, or NULL if the tag is unknown
248  */
249 const char      *exif_tag_get_title_in_ifd         (ExifTag tag, ExifIfd ifd);
250 
251 /*! Return a verbose textual description of the given tag when found in the
252  * given IFD. The description is a verbose, localized description of the tag.
253  *
254  * \param[in] tag EXIF tag
255  * \param[in] ifd IFD
256  * \return textual description of the tag, or NULL if the tag is unknown
257  */
258 const char      *exif_tag_get_description_in_ifd   (ExifTag tag, ExifIfd ifd);
259 
260 /*! Return whether the given tag is mandatory or not in the given IFD and
261  * data type according to the EXIF specification. If the IFD given is
262  * EXIF_IFD_COUNT, the result is EXIF_SUPPORT_LEVEL_UNKNOWN. If the data
263  * type is EXIF_DATA_TYPE_UNKNOWN, the result is
264  * EXIF_SUPPORT_LEVEL_UNKNOWN unless the support level is the same for
265  * all data types.
266  *
267  * \param[in] tag EXIF tag
268  * \param[in] ifd IFD or EXIF_IFD_COUNT
269  * \param[in] t data type or EXIF_DATA_TYPE_UNKNOWN
270  * \return the level of support for this tag
271  */
272 ExifSupportLevel exif_tag_get_support_level_in_ifd (ExifTag tag, ExifIfd ifd,
273                                                     ExifDataType t);
274 
275 /* Don't use these functions. They are here for compatibility only. */
276 
277 /*! \deprecated Use #exif_tag_get_name_in_ifd instead */
278 const char     *exif_tag_get_name        (ExifTag tag);
279 
280 /*! \deprecated Use #exif_tag_get_title_in_ifd instead */
281 const char     *exif_tag_get_title       (ExifTag tag);
282 
283 /*! \deprecated Use #exif_tag_get_description_in_ifd instead */
284 const char     *exif_tag_get_description (ExifTag tag);
285 
286 
287 /* For now, do not use these functions. */
288 
289 /*! \internal */
290 ExifTag      exif_tag_table_get_tag  (unsigned int n);
291 
292 /*! \internal */
293 const char  *exif_tag_table_get_name (unsigned int n);
294 
295 /*! \internal */
296 unsigned int exif_tag_table_count    (void);
297 
298 
299 /* Don't use these definitions. They are here for compatibility only. */
300 
301 /*! \deprecated Use EXIF_TAG_PRINT_IMAGE_MATCHING instead. */
302 #define EXIF_TAG_UNKNOWN_C4A5 EXIF_TAG_PRINT_IMAGE_MATCHING
303 
304 #ifdef __cplusplus
305 }
306 #endif /* __cplusplus */
307 
308 #endif /* !defined(LIBEXIF_EXIF_TAG_H) */
309