data_members.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  2. "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
  3. <html>
  4. <head>
  5. <title>ExifTool Object Data Members</title>
  6. <link rel=stylesheet type='text/css' href='style.css' title='Style'>
  7. </head>
  8. <body>
  9. <h2 class='up'>ExifTool Object Data Members</h2>
  10. <p>The following table lists the data members of the ExifTool object. (If this
  11. was C++, these would be documented next to the definitions in the header file,
  12. but this is Perl, so I couldn't do that...)</p>
  13. <p>Aside from the variables defined below, there may be other temporary
  14. variables added by individual modules. Temporary variables are identified by at
  15. least one lower case letter in their name, and are deleted automatically before
  16. reading or writing each new image. Make, Model and CameraType are temporary
  17. variables like this, but these three are special because they are initialized to
  18. an empty string instead of being deleted at the start of processing for each
  19. image, which allows them to be tested without having to check for an undefined
  20. value.</p>
  21. <blockquote><table class='norm'><tr><th>Name</th><th>Description</th></tr>
  22. <tr><td>ADD_DIRS</td><td>Hash of parent directories for each directory added during
  23. writing (Note: entry may exist but be undefined for top-level
  24. directory!)</td></tr>
  25. <tr><td>BASE</td><td>Absolute position of current image in containing file
  26. (for example, when processing JPEG image in FujiFilm RAF file)</td></tr>
  27. <tr><td>BOTH</td><td>Reference to HASH of ValueConv/PrintConv arrays, saved for
  28. tags when GetValue is called for 'Both' values, and used to avoid having to
  29. recalculate both values again (which speeds up building the Composite tags
  30. because often the same tag is Require'd by multiple Composite tags).</td></tr>
  31. <tr><td>CameraType</td><td>Camera type used for decoding some Olympus tags</td></tr>
  32. <tr><td>CHANGED</td><td>Number of tags changed during writing</td></tr>
  33. <tr><td>CHARSET</td><td>Lookup table for current Charset setting</td></tr>
  34. <tr><td>CHECK_WARN</td><td>Used to return CHECK_PROC warnings</td></tr>
  35. <tr><td>CUR_LANG</td><td>Hash reference for localized language lookup corresponding
  36. to current 'Lang' options setting.</td></tr>
  37. <tr><td>CUR_WRITE_GROUP</td><td>Current family 1 group while writing. Currently
  38. used only when writing QuickTime tracks.</td></tr>
  39. <tr><td>DEL_GROUP</td><td>Hash of groups to delete. Value is 1 to delete group
  40. completely, or 2 if tags were added back after deleting the group. May
  41. have a leading "-" if excluded from a delete.</td></tr>
  42. <tr><td>DEL_PREVIEW</td><td>Flag to delete preview from after JPEG EOI</td></tr>
  43. <tr><td>DemoteErrors</td><td>Errors are demoted to warnings and this count is
  44. incremented if non-zero to begin with</td></tr>
  45. <tr><td>DIR_COUNT</td><td>Hash reference for counters of various types of directorys (ICC, IPTC,...)</td></tr>
  46. <tr><td>DIR_NAME</td><td>Name of directory currently being processed</td></tr>
  47. <tr><td>DOC_COUNT</td><td>Number of top-level embedded sub-documents processed while
  48. extracting, or 0 if none were processed</td></tr>
  49. <tr><td>DOC_NUM</td><td>Current document number while extracting (0, '' or undef for the
  50. main document)</td></tr>
  51. <tr><td>DoneID3</td><td>Set to 1 if audio file was scanned for ID3,
  52. or 2 if there was an ID3v1 trailer found</td></tr>
  53. <tr><td>DROP_TAGS</td><td>Flag to exclude "Drop" tags when writing</td></tr>
  54. <tr><td>DUPL_TAG</td><td>Hash of last used tag key index numbers for each duplicate tag.</td></tr>
  55. <tr><td>EDIT_DIRS</td><td>Hash of parent directories for each directory edited during
  56. writing (Note: entry may exist but be undefined for top-level
  57. directory!)</td></tr>
  58. <tr><td>ESCAPE_PROC</td><td>Routine for XML or HTML escaping if Escape option is set</td></tr>
  59. <tr><td>EXCL_TAG_LOOKUP</td><td>Hash for looking up excluded tags (keys are lower case tag names)</td></tr>
  60. <tr><td>EXIF_DATA</td><td>EXIF data block (valid while reading from file)</td></tr>
  61. <tr><td>EXIF_POS</td><td>Position of EXIF data in file</td></tr>
  62. <tr><td>FILENAME</td><td>Name of input file while extracting (only if we opened it, '' otherwise)</td></tr>
  63. <tr><td>FILE_ORDER</td><td>Hash of numbers to give the sequence the tags were
  64. extracted from file, keyed by tag key</td></tr>
  65. <tr><td>FILE_EXT</td><td>File extension (JPG, PEF, AVI, etc...) May be undefined if
  66. file has no extension.</td></tr>
  67. <tr><td>FILE_SEQUENCE</td><td>File sequence number when extracting information</td></tr>
  68. <tr><td>FILE_TYPE</td><td>Root file format type (JPEG, TIFF, RIFF, etc...)</td></tr>
  69. <tr><td>FIRST_EXIF_POS</td><td>Position of first EXIF in file</td></tr>
  70. <tr><td>FOUND_TAGS</td><td>Found tags with proper case and order</td></tr>
  71. <tr><td>GLOBAL_TIME_OFFSET</td><td>Time offset hash for first shifted date/time value of GlobalTimeShift option</td></tr>
  72. <tr><td>HTML_DUMP</td><td>Reference to HtmlDump object when using HtmlDump feature</td></tr>
  73. <tr><td>INDENT</td><td>Indent string for verbose output</td></tr>
  74. <tr><td>IN_RESOURCE</td><td>Flag indicates we are processing the resource fork of a Mac OS file</td></tr>
  75. <tr><td>IO_TAG_LIST</td><td>List for output of requested tags in proper case and order</td></tr>
  76. <tr><td>LIST_TAGS</td><td>Hash of tag keys by tagInfo reference for active list-type
  77. tags. This hash is cleared at the start of processing for each directory.
  78. Not used during when writing.</td></tr>
  79. <tr><td>LOW_PRIORITY_DIR</td><td>Lookup based on directory name for directories where
  80. undefined Priority tags get set to Priority 0 (eg. PreviewIFD in all images,
  81. and IFD1 in JPEG images). This is equivalent to setting PRIORITY to 0 for
  82. the tag table only for a specific directory name.</td></tr>
  83. <tr><td>Make</td><td>Camera make set during reading and writing</td></tr>
  84. <tr><td>MAKER_NOTE_BYTE_ORDER</td><td>Byte order of extracted maker notes if extracted
  85. as a block.</td></tr>
  86. <tr><td>MAKER_NOTE_INFO</td><td>Used by Image::ExifTool::CanonRaw as temporary storage for
  87. maker note information when synthesizing maker notes from CRW file with the
  88. MakerNotes option.</td></tr>
  89. <tr><td>MAKER_NOTE_FIXUP</td><td>Fixup information for maker notes extracted with the MakerNotes
  90. option (unless MakerNotes option is 2). Used by SetNewValuesFromFile() to adjust offsets
  91. in maker note IFD</td></tr>
  92. <tr><td>Model</td><td>Camera model name set during reading and writing</td></tr>
  93. <tr><td>MOVED_KEY</td><td>Tag key of last tag replaced by a higher priority tag
  94. in a call to FoundTag().</td></tr>
  95. <tr><td>NEW_VALUE</td><td>Hash of new value information keyed by tag info reference.
  96. Elements of new value information hash are:
  97. <table class='clear'><tr><td>TagInfo</td><td>-</td><td>tag information reference</td></tr>
  98. <tr><td>DelValue</td><td>-</td><td>list of specific values to delete</td></tr>
  99. <tr><td>Value</td><td>-</td><td>list of values to add</td></tr>
  100. <tr valign='top'><td>IsCreating</td><td>-</td><td>must be set for the tag to be added, otherwise just
  101. changed if it already exists. A value of 2 will create a new tag if its group already
  102. exists, but won't add a new group</td></tr>
  103. <tr valign='top'><td>Next</td><td>-</td><td>reference to next new value hash in linked list
  104. if there is more than one new value hash (for writing to different groups) for this
  105. tagInfo</td></tr>
  106. <tr valign='top'><td>Save</td><td>-</td><td>flag set by call to SaveNewValues() if this value
  107. should be saved</td></tr>
  108. </table></td></tr>
  109. <tr><td>NewIPTCDigest</td><td>MD5 digest for most recently written IPTC data (undefined if IPTC doesn't
  110. exist or if it was deleted). Calculated only if a value of 'new' is being written/deleted
  111. to/from the Photoshop:IPTCDigest tag</td></tr>
  112. <tr><td>NO_LIST</td><td>Set if List tags shouldn't be accumulated into a list. Undefined to
  113. accumulate lists as usual, or 0 to accumulate lists in TAG_EXTRA "NoList" element (and
  114. set a TAG_EXTRA "NoListDel" flag for tags that wouldn't have been created).</td></tr>
  115. <tr><td>NO_STRUCT</td><td>Set if structures shouldn't be restored for this metadata. Used
  116. to avoid restoring structures for non-XMP (eg. XML) information.</td></tr>
  117. <tr><td>NO_STRUCT_WARN</td><td>Set if structures warnings should be ignored when rebuilding
  118. structures (for questionable XML).</td></tr>
  119. <tr><td>NO_UNKNOWN</td><td>Don't generate unknown tags automatically even if Unknown option is set</td></tr>
  120. <tr><td>NUM_FOUND</td><td>Number of tags found</td></tr>
  121. <tr><td>OldIPTCDigest</td><td>MD5 digest for original IPTC data (undefined if IPTC didn't
  122. exist). Calculated only if a value of 'old' is being written/deleted to/from the
  123. Photoshop:IPTCDigest tag</td></tr>
  124. <tr><td>OPTIONS</td><td>ExifTool options</td></tr>
  125. <tr><td>PATH</td><td>List reference to SubDirectory path. eg)
  126. [qw(JPEG APP13 Photoshop IPTC)]</td></tr>
  127. <tr><td>PDF_CAPTURE</td><td>Used by PDF module to store information when writing</td></tr>
  128. <tr><td>PreferredGroup</td><td>Preferred family 1 group for writing tags to the current file.
  129. Not defined to use the default group priorities. Set in call to InitWriteDirs().</td></tr>
  130. <tr><td>PREVIEW_INFO</td><td>Information about preview image used while writing JPEG
  131. images only. This is a reference to a hash with the following entries:
  132. <table class='clear'>
  133. <tr valign='top'><td>Absolute</td><td>-</td><td>flag set if PreviewImage pointer is relative to the
  134. start of file</td></tr>
  135. <tr><td>BaseShift</td><td>-</td><td>shift for base of pointer offsets</td></tr>
  136. <tr valign='top'><td>Data</td><td>-</td><td>data for PreviewImage to be written (may either be data
  137. for the old or new image, or 'LOAD_PREVIEW' to indicate that the data must be loaded from outside
  138. the EXIF segment)</td></tr>
  139. <tr><td>Fixup</td><td>-</td><td>[mandatory] fixup for PreviewImage pointers when writing JPEG images</td></tr>
  140. <tr valign='top'><td>IsShort</td><td>-</td><td>flag indicates PreviewImage pointers
  141. are 2-byte (instead of 4-byte) integers</td></tr>
  142. <tr valign='top'><td>IsTrailer</td><td>-</td><td>flag indicates image should always be written as a JPEG
  143. trailer, even if it fits inside the APP1 EXIF segment (as with Samsung STMN maker notes)</td></tr>
  144. <tr><td>Relative</td><td>-</td><td>flag to indicate that pointer offsets are relative</td></tr>
  145. </table></td></tr>
  146. <tr><td>PRIORITY</td><td>Hash of tag Priority values for current tag, keyed by tag name (not tag key!)</td></tr>
  147. <tr><td>PRIORITY_DIR</td><td>Name of priority directory (ie. the IFD for the full resolution image)</td></tr>
  148. <tr><td>PROCESSED</td><td>Reference to hash of address/directory names which were processed
  149. during reading and/or writing</td></tr>
  150. <tr><td>RAF</td><td>Random access file object for reading from input file</td></tr>
  151. <tr><td>RATIONAL</td><td>Hash of rational values as a string fraction keyed by tag key</td></tr>
  152. <tr><td>Recreated</td><td>Directories recreated when writing (used to prevent recreating
  153. multiple directories of the same type)</td></tr>
  154. <tr><td>REQUESTED_TAGS</td><td>List of requested tags in original case</td></tr>
  155. <tr><td>REQ_TAG_LOOKUP</td><td>Hash for looking up requested tags (keys are lower case tag names)</td></tr>
  156. <tr><td>SAVE_COUNT</td><td>Counts number of times SaveNewValues() has been called</td></tr>
  157. <tr><td>SAVE_DEL_GROUP</td><td>Hash of saved DEL_GROUP entries</td></tr>
  158. <tr><td>SAVE_NEW_VALUE</td><td>Hash of new value information which was overwritten after
  159. a call to SaveNewValues()</td></tr>
  160. <tr><td>SET_GROUP0</td><td>Value to use for family 0 group name when new tags
  161. are found</td></tr>
  162. <tr><td>SET_GROUP1</td><td>Value to use for family 1 group name when new tags
  163. are found. May start with a '+' sign to add to existing group name</td></tr>
  164. <tr><td>TAG_EXTRA</td><td>Hash of extra tag information keyed by tag key. Current extra
  165. information may include:
  166. <table class='clear'>
  167. <tr valign='top'><td>G0</td><td>-</td><td>override for family 0 group name</td></tr>
  168. <tr valign='top'><td>G1</td><td>-</td><td>dynamic family 1 group name (eg. IFD name or XMP
  169. namespace), with a leading '+' to add value to the existing group 1 name</td></tr>
  170. <tr valign='top'><td>G3</td><td>-</td><td>number for embedded documents (eg. 1, 2, etc)</td></tr>
  171. </table></td></tr>
  172. <tr><td>TAG_INFO</td><td>Hash of tagInfo hash references, keyed by tag key</td></tr>
  173. <tr><td>TAGS_FROM_FILE</td><td>Flag used during extraction when called from SetNewValuesFromFile().
  174. Test this flag when extracting tags that are not normally extracted.</td></tr>
  175. <tr><td>TIFF_END</td><td>Location of end of regular TIFF file set by WriteExif()</td></tr>
  176. <tr><td>TIFF_TYPE</td><td>Type of TIFF data, only set if FILE_TYPE is TIFF. Valid values
  177. are APP1, APP3, TIFF, CR2, MRW, JP2, JPX, NEF, PEF, ORF, DNG, etc.</td></tr>
  178. <tr><td>VALUE</td><td>Hash of raw tag values keyed by tag key</td></tr>
  179. <tr><td>WARNED_ONCE</td><td>Hash of warning messages that have been issued once already</td></tr>
  180. <tr><td>WRITE_GROUPS</td><td>List of write groups in order of priority</td></tr>
  181. <tr><td>WRITE_PRIORITY</td><td>Hash of write priority values keyed by group name</td></tr>
  182. <tr><td>WRITTEN</td><td>Hash of tags written (currently used only for filesystem date/time tags)</td></tr>
  183. <tr><td>XMP_CAPTURE</td><td>Hash of tag information (value, attribute hash) keyed by XMP
  184. property path, used by XMP module during writing</td></tr>
  185. <tr><td>XMP_ERROR</td><td>Error string used by XMP module during writing</td></tr>
  186. <tr><td>XMP_NS</td><td>Hash of URI's keyed by namespace prefix, used by XMP module
  187. during writing to remember all used namespaces</td></tr>
  188. </table></blockquote>
  189. <hr>
  190. <p class='lf'><a href="index.html">&lt;-- Back to ExifTool home page</a></p>
  191. </body>
  192. </html>