~berthold-daum/zora/trunk

« back to all changes in this revision

Viewing changes to com.bdaum.zoom.batch.unix/exiftool/lib/Image/ExifTool.pod

  • Committer: bdaum
  • Date: 2015-12-26 10:21:51 UTC
  • Revision ID: berthold.daum@bdaum.de-20151226102151-44f1j5113167thb9
VersionĀ 2.4.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
65
65
 
66
66
  File Types
67
67
  ------------+-------------+-------------+-------------+------------
68
 
  3FR   r     | DVB   r/w   | KDC   r     | OGG   r     | RSRC  r
69
 
  3G2   r/w   | DYLIB r     | KEY   r     | OGV   r     | RTF   r
70
 
  3GP   r/w   | EIP   r     | LA    r     | ORF   r/w   | RW2   r/w
71
 
  AA    r     | EPS   r/w   | LFP   r     | OTF   r     | RWL   r/w
72
 
  AAX   r/w   | EPUB  r     | LNK   r     | PAC   r     | RWZ   r
73
 
  ACR   r     | ERF   r/w   | M2TS  r     | PAGES r     | RM    r
74
 
  AFM   r     | EXE   r     | M4A/V r/w   | PBM   r/w   | SEQ   r
75
 
  AI    r/w   | EXIF  r/w/c | MEF   r/w   | PCD   r     | SO    r
76
 
  AIFF  r     | EXR   r     | MIE   r/w/c | PDB   r     | SR2   r/w
77
 
  APE   r     | EXV   r/w/c | MIFF  r     | PDF   r/w   | SRF   r
78
 
  ARW   r/w   | F4A/V r/w   | MKA   r     | PEF   r/w   | SRW   r/w
79
 
  ASF   r     | FFF   r/w   | MKS   r     | PFA   r     | SVG   r
80
 
  AVI   r     | FLA   r     | MKV   r     | PFB   r     | SWF   r
81
 
  AZW   r     | FLAC  r     | MNG   r/w   | PFM   r     | THM   r/w
82
 
  BMP   r     | FLV   r     | MOBI  r     | PGF   r     | TIFF  r/w
83
 
  BTF   r     | FPF   r     | MODD  r     | PGM   r/w   | TORRENT r
84
 
  CHM   r     | FPX   r     | MOI   r     | PLIST r     | TTC   r
85
 
  COS   r     | GIF   r/w   | MOS   r/w   | PICT  r     | TTF   r
86
 
  CR2   r/w   | GZ    r     | MOV   r/w   | PMP   r     | VCF   r
87
 
  CRW   r/w   | HDP   r/w   | MP3   r     | PNG   r/w   | VRD   r/w/c
88
 
  CS1   r/w   | HDR   r     | MP4   r/w   | PPM   r/w   | VSD   r
89
 
  DCM   r     | HTML  r     | MPC   r     | PPT   r     | WAV   r
90
 
  DCP   r/w   | ICC   r/w/c | MPG   r     | PPTX  r     | WDP   r/w
91
 
  DCR   r     | ICS   r     | MPO   r/w   | PS    r/w   | WEBP  r
92
 
  DFONT r     | IDML  r     | MQV   r/w   | PSB   r/w   | WEBM  r
93
 
  DIVX  r     | IIQ   r/w   | MRW   r/w   | PSD   r/w   | WMA   r
94
 
  DJVU  r     | IND   r/w   | MXF   r     | PSP   r     | WMV   r
95
 
  DLL   r     | INX   r     | NEF   r/w   | QTIF  r/w   | WV    r
96
 
  DNG   r/w   | ITC   r     | NRW   r/w   | RA    r     | X3F   r/w
97
 
  DOC   r     | J2C   r     | NUMBERS r   | RAF   r/w   | XCF   r
98
 
  DOCX  r     | JNG   r/w   | ODP   r     | RAM   r     | XLS   r
99
 
  DPX   r     | JP2   r/w   | ODS   r     | RAR   r     | XLSX  r
100
 
  DR4   r/w/c | JPEG  r/w   | ODT   r     | RAW   r/w   | XMP   r/w/c
101
 
  DV    r     | K25   r     | OFR   r     | RIFF  r     | ZIP   r
 
68
  3FR   r     | DVB   r/w   | KEY   r     | ORF   r/w   | RWL   r/w
 
69
  3G2   r/w   | DYLIB r     | LA    r     | OTF   r     | RWZ   r
 
70
  3GP   r/w   | EIP   r     | LFP   r     | PAC   r     | RM    r
 
71
  AA    r     | EPS   r/w   | LNK   r     | PAGES r     | SEQ   r
 
72
  AAX   r/w   | EPUB  r     | M2TS  r     | PBM   r/w   | SO    r
 
73
  ACR   r     | ERF   r/w   | M4A/V r/w   | PCD   r     | SR2   r/w
 
74
  AFM   r     | EXE   r     | MEF   r/w   | PDB   r     | SRF   r
 
75
  AI    r/w   | EXIF  r/w/c | MIE   r/w/c | PDF   r/w   | SRW   r/w
 
76
  AIFF  r     | EXR   r     | MIFF  r     | PEF   r/w   | SVG   r
 
77
  APE   r     | EXV   r/w/c | MKA   r     | PFA   r     | SWF   r
 
78
  ARW   r/w   | F4A/V r/w   | MKS   r     | PFB   r     | THM   r/w
 
79
  ASF   r     | FFF   r/w   | MKV   r     | PFM   r     | TIFF  r/w
 
80
  AVI   r     | FLA   r     | MNG   r/w   | PGF   r     | TORRENT r
 
81
  AZW   r     | FLAC  r     | MOBI  r     | PGM   r/w   | TTC   r
 
82
  BMP   r     | FLV   r     | MODD  r     | PLIST r     | TTF   r
 
83
  BTF   r     | FPF   r     | MOI   r     | PICT  r     | VCF   r
 
84
  CHM   r     | FPX   r     | MOS   r/w   | PMP   r     | VRD   r/w/c
 
85
  COS   r     | GIF   r/w   | MOV   r/w   | PNG   r/w   | VSD   r
 
86
  CR2   r/w   | GZ    r     | MP3   r     | PPM   r/w   | WAV   r
 
87
  CRW   r/w   | HDP   r/w   | MP4   r/w   | PPT   r     | WDP   r/w
 
88
  CS1   r/w   | HDR   r     | MPC   r     | PPTX  r     | WEBP  r
 
89
  DCM   r     | HTML  r     | MPG   r     | PS    r/w   | WEBM  r
 
90
  DCP   r/w   | ICC   r/w/c | MPO   r/w   | PSB   r/w   | WMA   r
 
91
  DCR   r     | ICS   r     | MQV   r/w   | PSD   r/w   | WMV   r
 
92
  DFONT r     | IDML  r     | MRW   r/w   | PSP   r     | WV    r
 
93
  DIVX  r     | IIQ   r/w   | MXF   r     | QTIF  r/w   | X3F   r/w
 
94
  DJVU  r     | IND   r/w   | NEF   r/w   | RA    r     | XCF   r
 
95
  DLL   r     | INX   r     | NRW   r/w   | RAF   r/w   | XLS   r
 
96
  DNG   r/w   | ITC   r     | NUMBERS r   | RAM   r     | XLSX  r
 
97
  DOC   r     | J2C   r     | ODP   r     | RAR   r     | XMP   r/w/c
 
98
  DOCX  r     | JNG   r/w   | ODS   r     | RAW   r/w   | ZIP   r
 
99
  DPX   r     | JP2   r/w   | ODT   r     | RIFF  r     |
 
100
  DR4   r/w/c | JPEG  r/w   | OFR   r     | RSRC  r     |
 
101
  DSS   r     | K25   r     | OGG   r     | RTF   r     |
 
102
  DV    r     | KDC   r     | OGV   r     | RW2   r/w   |
102
103
 
103
104
  Meta Information
104
105
  ----------------------+----------------------+---------------------
257
258
 
258
259
A reference to an open image file.  If you use this method (or a SCALAR
259
260
reference) to access information in an image, the FileName and Directory
260
 
tags will not be returned.  (Also, the FileSize, FileModifyDate and
261
 
FilePermissions tags will not be returned unless it is a plain file.)  Image
262
 
processing begins at the current file position, and on return the file
263
 
position is unspecified.  May be either a standard filehandle, or a
264
 
reference to a L<File::RandomAccess|File::RandomAccess> object.  Note that
265
 
the file remains open and must be closed by the caller after L</ImageInfo>
266
 
returns.
 
261
tags will not be returned.  (Also, a number of the File System tags will not
 
262
be returned unless it is a plain file.)  Image processing begins at the
 
263
current file position, and on return the file position is unspecified.  May
 
264
be either a standard filehandle, or a reference to a
 
265
L<File::RandomAccess|File::RandomAccess> object.  Note that the file remains
 
266
open and must be closed by the caller after L</ImageInfo> returns.
267
267
 
268
268
[Advanced:  To allow a non-rewindable stream (eg. a network socket) to be
269
269
re-read after processing with ExifTool, first wrap the file reference in a
589
589
     1   - read extended XMP with valid GUID only (default)
590
590
     2   - read extended XMP with any GUID
591
591
  <guid> - read extended XMP with a specific GUID
592
 
    
 
592
 
593
593
=item ExtractEmbedded
594
594
 
595
595
Flag to extract information from embedded documents in EPS files, embedded
611
611
only an initial guess at FileType and some pseudo tags are returned. 
612
612
Default is undef.
613
613
 
 
614
=item Filter
 
615
 
 
616
Perl expression used to filter values for all tags.  The expression acts on
 
617
the value of the Perl default variable ($_), and changes the value of this
 
618
variable as required.  Applies to all returned values unless PrintConv
 
619
option is disabled.
 
620
 
614
621
=item FixBase
615
622
 
616
623
Fix maker notes base offset.  A common problem with image editing software
746
753
If not set, a minor error is issued for missing values, or the value is set
747
754
to '' if L</IgnoreMinorErrors> is set.  Default is undef.
748
755
 
 
756
=item NoPDFList
 
757
 
 
758
Flag to avoid splitting PDF List-type tag values into separate items.
 
759
Default is undef.
 
760
 
749
761
=item Password
750
762
 
751
763
Password for reading/writing password-protected PDF documents.  Ignored if a
834
846
    2   - Read/copy both flattened and structured tags, but flag
835
847
          flattened tags as 'unsafe' for copying
836
848
 
 
849
=item SystemTags
 
850
 
 
851
Flag to extract the following additional File System tags:  FileAttributes,
 
852
FileDeviceNumber, FileInodeNumber, FileHardLinks, FileUserID, FileGroupID,
 
853
FileDeviceID, FileBlockSize and FileBlockCount.
 
854
 
837
855
=item TextOut
838
856
 
839
857
Output file reference for Verbose and HtmlDump options.  Default is
932
950
L</ExtractInfo>:
933
951
 
934
952
Binary, Charset, CharsetEXIF, CharsetFileName, CharsetID3, CharsetIPTC,
935
 
CharsetPhotoshop, CharsetQuickTime, Composite, ExtractEmbedded, FastScan,
936
 
FixBase, HtmlDump, HtmlDumpBase, IgnoreMinorErrors, Lang, LargeFileSupport,
937
 
MakerNotes, PNGEarlyXMP, ScanForXMP, Struct, TextOut, Unknown and Verbose.
 
953
CharsetPhotoshop, CharsetQuickTime, Composite, ExtendedXMP, ExtractEmbedded,
 
954
FastScan, FixBase, HtmlDump, HtmlDumpBase, IgnoreMinorErrors, Lang,
 
955
LargeFileSupport, MakerNotes, NoPDFList, PNGEarlyXMP, ScanForXMP, Struct,
 
956
TextOut, Unknown and Verbose.
938
957
 
939
958
=item Return Value:
940
959
 
968
987
Inputs are the same as L</ExtractInfo> and L</ImageInfo> except that an
969
988
image can not be specified.  Options in effect are:
970
989
 
971
 
Charset, CoordFormat, DateFormat, Duplicates, Escape, Exclude, Group#,
972
 
GlobalTimeShift, Lang, List, ListSep, PrintConv, Sort (if a tag list
973
 
reference is given) and StrictDate.
 
990
Charset, CoordFormat, DateFormat, Duplicates, Escape, Exclude, Filter,
 
991
Group#, GlobalTimeShift, Lang, List, ListItem, ListSep, PrintConv, Sort (if
 
992
a tag list reference is given) and StrictDate.
974
993
 
975
994
=item Return Value:
976
995
 
1178
1197
 
1179
1198
The following options are in effect when L</GetValue> is called:
1180
1199
 
1181
 
Charset, CoordFormat, DateFormat, Escape, GlobalTimeShift, Lang, List,
1182
 
ListSep, PrintConv and StrictDate.
 
1200
Charset, CoordFormat, DateFormat, Escape, Filter, GlobalTimeShift, Lang,
 
1201
List, ListItem, ListSep, PrintConv and StrictDate.
1183
1202
 
1184
1203
=over 4
1185
1204
 
1406
1425
 
1407
1426
=item Notes:
1408
1427
 
1409
 
When deleting groups of tags, the Replace option may be used as in the last
1410
 
example above to exclude specific groups from a mass delete.  However, this
1411
 
technique may not be used to exclude individual tags from a group delete
1412
 
(unless a family 2 group was specified in the delete).  Instead, use
1413
 
L</SetNewValuesFromFile> to recover the values of individual tags after
1414
 
deleting a group.
 
1428
When deleting groups of tags, the Replace option may be used to exclude
 
1429
specific groups from a mass delete.  However, this technique may not be used
 
1430
to exclude individual tags from a group delete (unless a family 2 group was
 
1431
specified in the delete).  Instead, use L</SetNewValuesFromFile> to recover
 
1432
the values of individual tags after deleting a group.
1415
1433
 
1416
1434
When deleting all tags from a JPEG image, the APP14 "Adobe" information is
1417
1435
not deleted by default because doing so may affect the appearance of the
1425
1443
Charset, Escape, IgnoreMinorErrors, Lang, ListSep, ListSplit, PrintConv,
1426
1444
Verbose and WriteMode.
1427
1445
 
 
1446
=head2 GetNewValue
 
1447
 
 
1448
Get the new Raw value for a tag.  This is the value set by L</SetNewValue>
 
1449
this is queued to be written to file.  List-type tags may return multiple
 
1450
values in list context.
 
1451
 
 
1452
    $rawVal = $exifTool->GetNewValue($tag);
 
1453
 
 
1454
    @rawVals = $exifTool->GetNewValue($tag);
 
1455
 
 
1456
=over 4
 
1457
 
 
1458
=item Inputs:
 
1459
 
 
1460
0) ExifTool object reference
 
1461
 
 
1462
1) Tag name (case sensitive, may be prefixed by family 0 or 1 group name)
 
1463
 
 
1464
=item Return Values:
 
1465
 
 
1466
List of new Raw tag values, or first value in list when called in scalar
 
1467
context.  The list may be empty either if the tag isn't being written, or if
 
1468
it is being deleted (ie. if L</SetNewValue> was called without a value).
 
1469
 
 
1470
=back
 
1471
 
1428
1472
=head2 SetNewValuesFromFile
1429
1473
 
1430
1474
A very powerful routine that sets new values for tags from information found
1556
1600
 
1557
1601
=back
1558
1602
 
1559
 
=head2 GetNewValues
1560
 
 
1561
 
Get list of new Raw values for the specified tag.  These are the values that
1562
 
will be written to file.  Most tags return only a single value, but
1563
 
List-type tags may return multiple values.
1564
 
 
1565
 
    $rawVal = $exifTool->GetNewValues($tag);
1566
 
 
1567
 
    @rawVals = $exifTool->GetNewValues($tag);
1568
 
 
1569
 
=over 4
1570
 
 
1571
 
=item Inputs:
1572
 
 
1573
 
0) ExifTool object reference
1574
 
 
1575
 
1) Tag name (case sensitive, may be prefixed by family 0 or 1 group name)
1576
 
 
1577
 
=item Return Values:
1578
 
 
1579
 
List of new Raw tag values, or first value in list when called in scalar
1580
 
context.  The list may be empty either if the tag isn't being written, or if
1581
 
it is being deleted (ie. if L</SetNewValue> was called without a value).
1582
 
 
1583
 
=back
1584
 
 
1585
1603
=head2 CountNewValues
1586
1604
 
1587
1605
Return the total number of new values set.
1940
1958
 
1941
1959
Tag values are calculated in alphabetical order unless a tag Require's or
1942
1960
Desire's another composite tag, in which case the calculation is deferred
1943
 
until after the other tag is calculated. Composite tags may need to read
1944
 
data from the image for their value to be determined, so for these
1945
 
L</BuildCompositeTags> must be called while the image is available.  This is
1946
 
only a problem if L</ImageInfo> is called with a filename (as opposed to a
1947
 
file reference or scalar reference) since in this case the file is closed
1948
 
before L</ImageInfo> returns.  However if you enable the Composite option,
1949
 
L</BuildCompositeTags> is called from within L</ImageInfo> before the file
1950
 
is closed.
 
1961
until after the other tag is calculated.
 
1962
 
 
1963
Composite tags may need to read data from the image for their value to be
 
1964
determined, and for these L</BuildCompositeTags> must be called while the
 
1965
image is available.  This is only a problem if L</ImageInfo> is called with
 
1966
a filename (as opposed to a file reference or scalar reference) since in
 
1967
this case the file is closed before L</ImageInfo> returns.  Here the
 
1968
Composite option may be used so that L</BuildCompositeTags> is called from
 
1969
within L</ImageInfo>, before the file is closed.
1951
1970
 
1952
1971
=back
1953
1972
 
2085
2104
MIE-Main, MIE-MakerNotes, MIE-Meta, MIE-Orient, MIE-Preview, MIE-Thumbnail,
2086
2105
MIE-UTM, MIE-Unknown, MIE-Video, MIFF, MNG, MOBI, MOI, MPC, MPEG, MPF0,
2087
2106
MPImage, MXF, MakerNotes, MakerUnknown, Matroska, MediaJukebox, MetaIFD,
2088
 
Microsoft, Minolta, MinoltaRaw, NITF, Nikon, NikonCapture, NikonCustom,
2089
 
NikonScan, Nintendo, Ocad, Ogg, Olympus, OpenEXR, PDF, PICT, PNG, PNG-pHYs,
2090
 
PSP, Palm, Panasonic, PanasonicRaw, Pentax, PhaseOne, PhotoCD,
2091
 
PhotoMechanic, Photoshop, PictureInfo, PostScript, PreviewIFD, PrintIM,
2092
 
ProfileIFD, Qualcomm, QuickTime, RAF, RAF2, RIFF, RMETA, RSRC, RTF,
 
2107
Microsoft, Minolta, MinoltaRaw, Motorola, NITF, Nikon, NikonCapture,
 
2108
NikonCustom, NikonScan, Nintendo, Ocad, Ogg, Olympus, OpenEXR, PDF, PICT,
 
2109
PNG, PNG-pHYs, PSP, Palm, Panasonic, PanasonicRaw, Pentax, PhaseOne,
 
2110
PhotoCD, PhotoMechanic, Photoshop, PictureInfo, PostScript, PreviewIFD,
 
2111
PrintIM, ProfileIFD, Qualcomm, QuickTime, RAF, RAF2, RIFF, RMETA, RSRC, RTF,
2093
2112
Radiance, Rawzor, Real, Real-CONT, Real-MDPR, Real-PROP, Real-RA3, Real-RA4,
2094
2113
Real-RA5, Real-RJMD, Reconyx, Ricoh, SPIFF, SR2, SR2DataIFD, SR2SubIFD,
2095
2114
SRF#, SVG, Samsung, Sanyo, Scalado, Sigma, SigmaRaw, Sony, SonyIDC, Stim,
2256
2275
=item Notes
2257
2276
 
2258
2277
Pre-existing tags with the same ID will be replaced in the destination
2259
 
table.
 
2278
table. See lib/Image/ExifTool/README in the full distribution for full
 
2279
details on the elements of the tag information hash.
2260
2280
 
2261
2281
=back
2262
2282
 
2406
2426
or if Latin encoding is specified; otherwise an iTXt chunk is used and the
2407
2427
text is converted from the specified character set and stored as UTF-8.
2408
2428
 
 
2429
=head2 JPEG Comment
 
2430
 
 
2431
The encoding for the JPEG Comment (COM segment) is not specified, so
 
2432
ExifTool reads/writes this text without conversion.
 
2433
 
2409
2434
=head2 ID3
2410
2435
 
2411
2436
The ID3v1 specification officially supports only ISO 8859-1 encoding (a