#!/usr/bin/perl -w #------------------------------------------------------------------------------ # File: exiftool # # Description: Read/write meta information # # Revisions: Nov. 12/03 - P. Harvey Created # (See html/history.html for revision history) #------------------------------------------------------------------------------ use strict; require 5.004; # add our 'lib' directory to the include list BEFORE 'use Image::ExifTool' my $exeDir; BEGIN { # get exe directory $exeDir = ($0 =~ /(.*)[\\\/]/) ? $1 : '.'; # add lib directory at start of include path unshift @INC, "$exeDir/lib"; } use Image::ExifTool qw{:Public}; sub SigInt(); sub Cleanup(); sub GetImageInfo($$); sub SetImageInfo($$); sub DoSetFromFile($$$); sub CleanFilename($); sub ScanDir($$); sub LoadPrintFormat($); sub FilenameSPrintf($;$); sub NextUnusedFilename($;$); sub CreateDirectory($); sub SourceFile($); sub OpenOutputFile($); sub AcceptFile($); sub SlurpFile($$); sub PrintTagList($@); sub PrintErrors($$$); # do cleanup on Ctrl-C $SIG{INT} = 'SigInt'; END { Cleanup(); } # declare all static variables my @commonArgs; # arguments common to all commands my @dynamicFiles; # list of -tagsFromFile files with dynamic names my @dynamicValues; # list of -TAG<=FMT pairs for setting new values my @exclude; # list of excluded tags my @files; # list of files and directories to scan my @ignore; # directory names to ignore my @newValues; # list of new tag values to set my @printFmt; # the contents of the print format file my @tags; # list of tags to extract my %excludeGrp; # hash of tags excluded by group my %filterExt; # lookup for filtered extensions my %setTags; # hash of list references for tags to set from files my %warnedOnce; # lookup for once-only warnings my $allGroup; # show group name for all tags my $allInGroup; # flag to show all tags in a group my $binaryOutput; # flag for binary output my $binaryStdout; # flag set if we output binary to stdout my $condition; # conditional processing of files my $count; # count of files scanned my $countBad; # count of files with errors my $countBadCr; # count files not created due to errors my $countBadWr; # count write errors my $countCreated; # count output files created my $countDir; # count of directories scanned my $countFailed; # count files that failed condition my $countGoodCr; # count files created OK my $countGoodWr; # count files written OK my $countNewDir; # count of directories created my $countSameWr; # count files written OK but not changed my $countCopyWr; # count of files copied without being changed my $disableOutput; # flag to disable normal output my $doGlob; # flag set to do filename wildcard expansion my $doSetFileName; # flag set if FileName may be written my $doUnzip; # flag to extract info from .gz and .bz2 files my $escapeHTML; # flag to escape printed values for html my $evalWarning; # warning from eval my $fileHeader; # header to print to output file (or console, once) my $fileTrailer; # trailer for output file my $filterFlag; # file filter flag (0x01=deny extensions, 0x02=allow extensions) my $forcePrint; # force printing of tags whose values weren't found my $helped; # flag to avoid printing help if no tags specified my $htmlOutput; # flag for html-formatted output my $isWriting; # flag set if we are writing tags my $listSep; # list item separator (', ' by default) my $mainTool; # main ExifTool object my $multiFile; # non-zero if we are scanning multiple files my $outFormat; # -1=Canon format, 0=same-line, 1=tag names, 2=values only my $outOpt; # output file or directory name my $outputExt; # extension for output file (or undef for no output) my $overwriteOrig; # flag to overwrite original file my $pause; # pause before returning my $preserveTime; # flag to preserve times of updated files my $quiet; # flag to disable printing of informational messages / warnings my $recurse; # recurse into subdirectories my $rtnVal; # command return value (0=success) my $scanWritable; # flag to process only writable file types my $setTagsFile; # filename for last TagsFromFile option my $setListSep; # flag indicating we used the -sep option my $showGroup; # number of group to show (may be zero or '') my $showTagID; # non-zero to show tag ID's my $srcFmt; # source file name format string my $tabFormat; # non-zero for tab output format my $tmpFile; # temporary file to delete on exit my $tmpText; # temporary text file my $xmlOutput; # flag to output in RDF/XML format my $verbose; # verbose setting # lookup for O/S names which may use a backslash as a directory separator # (ref File::Spec of PathTools-3.2701) my %hasBackslash = ( MSWin32 => 1, os2 => 1, dos => 1, NetWare => 1, symbian => 1, cygwin => 1 ); # exit routine sub Exit { if ($pause) { if (eval 'require Term::ReadKey') { print STDERR "-- press any key --"; Term::ReadKey::ReadMode('cbreak'); Term::ReadKey::ReadKey(0); print STDERR "\b \b" x 20; } else { print STDERR "-- press RETURN --\n"; ; } } exit shift; } # my warn and die routines sub Warn { warn(@_) if $quiet < 2 or $_[0] =~ /^Error/; } sub Die { Warn @_; Exit 1; } sub WarnOnce($) { Warn(@_) and $warnedOnce{$_[0]} = 1 unless $warnedOnce{$_[0]}; } # define signal handlers and cleanup routine sub SigInt() { Cleanup(); exit 1; } sub Cleanup() { unlink $tmpFile if defined $tmpFile; unlink $tmpText if defined $tmpText; } #------------------------------------------------------------------------------ # main script # # separate arguments common to all commands if (grep /^-common_args$/i, @ARGV) { my (@newArgs, $common); foreach (@ARGV) { if (/^-common_args$/i) { $common = 1; next; } elsif ($common) { push @commonArgs, $_; } push @newArgs, $_; } @ARGV = @newArgs; } # loop over sets of command-line arguments separated by "-execute" Command: while (@ARGV or not defined $rtnVal) { # local variables my $doneCommonArgs; $rtnVal = 0 unless defined $rtnVal; # initialize all static variables # (not done: @commonArgs, $helped, $mainTool, $pause, $rtnVal) undef @dynamicFiles; undef @dynamicValues; undef @exclude; undef @files; undef @ignore; undef @newValues; undef @printFmt; undef @tags; undef %excludeGrp; undef %filterExt; undef %setTags; undef %warnedOnce; undef $allGroup; undef $allInGroup; undef $binaryOutput; undef $binaryStdout; undef $condition; undef $disableOutput; undef $doGlob; undef $doSetFileName; undef $doUnzip; undef $escapeHTML; undef $evalWarning; undef $fileHeader; undef $fileTrailer; undef $forcePrint; undef $multiFile; undef $outOpt; undef $outputExt; undef $preserveTime; undef $recurse; undef $scanWritable; undef $setListSep; undef $setTagsFile; undef $showGroup; undef $showTagID; undef $srcFmt; undef $tmpFile; undef $tmpText; undef $verbose; $count = 0; $countBad = 0; $countBadCr = 0; $countBadWr = 0; $countCreated = 0; $countDir = 0; $countFailed = 0; $countGoodCr = 0; $countGoodWr = 0; $countNewDir = 0; $countSameWr = 0; $countCopyWr = 0; $filterFlag = 0; $htmlOutput = 0; $isWriting = 0; $listSep = ', '; $outFormat = 0; $overwriteOrig = 0; $quiet = 0; $tabFormat = 0; $xmlOutput = 0; # for Windows, use globbing for wildcard expansion if available - MK/20061010 if ($^O eq 'MSWin32' and eval "require File::Glob") { # override the core glob forcing case insensitivity import File::Glob qw(:globally :nocase); $doGlob = 1; } $mainTool = new Image::ExifTool; # create ExifTool object $mainTool->Options(Duplicates => 0); # don't extract duplicates by default # parse command-line options while ($_ = shift) { if (s/^-//) { if (/^list(w|f|wf|d|g(\d*))?$/i) { $helped = 1; if (not $1 or $1 eq 'w') { my $wr = $1; my $group; if ($ARGV[0] and $ARGV[0] =~ /^-(.+):(all|\*)$/i) { $group = $1; shift; $group =~ /IFD/i and warn("Can't list tags for specific IFD\n"), next; } my $msg = ($wr ? 'Writable' : 'Available') . ($group ? " $group" : '') . ' tags'; PrintTagList($msg, $wr ? GetWritableTags($group) : GetAllTags($group)); # also print shortcuts if listing all tags next if $group or $wr; my @tagList = GetShortcuts(); PrintTagList('Command-line shortcuts', @tagList) if @tagList; } elsif ($1 eq 'wf') { my @wf; CanWrite($_) and push @wf, $_ foreach GetFileType(); PrintTagList('Writable file extensions', @wf); } elsif ($1 eq 'f') { PrintTagList('Recognized file extensions', GetFileType()); } elsif ($1 eq 'd') { PrintTagList('Deletable groups', GetDeleteGroups()); } else { # 'g(\d*)' # list all groups in specified family my $family = $2 || 0; PrintTagList("Groups in family $family", GetAllGroups($family)); } next; } if (/^ver$/i) { print("$Image::ExifTool::VERSION$Image::ExifTool::RELEASE\n"); $helped = 1; next; } if (/^(all|add)?tagsfromfile(=.*)?$/i) { $setTagsFile = $2 ? substr($2,1) : (@ARGV ? shift : ''); $setTagsFile eq '' and Die "File must be specified for -TagsFromFile option\n"; push(@newValues, "TagsFromFile=$setTagsFile"); $setTags{$setTagsFile} or $setTags{$setTagsFile} = []; push @{$setTags{$setTagsFile}}, { Replace => ($1 and lc($1) eq 'add') ? 0 : 1 }; next; } if (/^\@$/) { my $argFile = shift or Die "Expecting filename for -\@ option\n"; unless (open(ARGFILE, "<$argFile")) { unless ($argFile !~ /^\// and open(ARGFILE, "<$exeDir/$argFile")) { Die "Error opening arg file $argFile\n"; } } my @newArgs; foreach () { s/^\s+//; s/\s+$//s; # remove leading/trailing white space # remove white space before, and single space after '=', '+=', '-=' or '<=' s/^([-\w]+)\s*([-+<]?=) ?/$1$2/; push @newArgs, $_ unless $_ eq '' or /^#/; } close(ARGFILE); unshift @ARGV, @newArgs; next; } /^(-?)a$/i and $mainTool->Options(Duplicates => ($1 ? 0 : 1)), next; /^b$/i and $mainTool->Options(Binary => 1), $binaryOutput = 1, next; /^c$/ and $mainTool->Options('CoordFormat', shift || Die "Expecting coordinate format for -c option\n"), next; /^d$/ and $mainTool->Options('DateFormat', shift || Die "Expecting date format for -d option\n"), next; /^D$/ and $showTagID = 'D', next; /^e$/ and $mainTool->Options(Composite => 0), next; /^E$/ and $escapeHTML = 1, next; # undocumented debugging option "-echo" /^echo$/i and print(shift,"\n"), $helped=1, next; if (/^execute$/i) { $helped = 1; last if $doneCommonArgs or not @commonArgs; # execute common arguments for each command unshift @ARGV, @commonArgs, '-execute'; $doneCommonArgs = 1; next; } if (/^-?ext$/i) { my $ext = shift; defined $ext or Die "Expecting extension for -ext option\n"; $ext =~ s/^\.//; # remove leading '.' if it exists my $flag = /^-/ ? 0 : 1; $filterFlag |= (0x01 << $flag); $filterExt{uc($ext)} = $flag; next; } if (/^f$/) { $forcePrint = 1; $mainTool->Options(MissingTagValue => '-'); next; } /^F([-+]?\d*)$/ and $mainTool->Options(FixBase => $1), next; /^fast$/i and $mainTool->Options(FastScan => 1), next; /^g(\d*)$/ and $showGroup = $1 || 0, next; /^G(\d*)$/ and $showGroup = $1 || 0, $allGroup=1, next; /^h$/ and $htmlOutput = 1, $escapeHTML = 1, $xmlOutput = 0, next; /^H$/ and $showTagID = 'H', next; if (/^htmldump([-+]?\d+)?$/i) { $verbose = ($verbose || 0) + 1; $htmlOutput = 2; $mainTool->Options(HtmlDumpBase => $1) if defined $1; next; } /^i$/i and push(@ignore,shift || Die "Expecting directory name for -i option\n"), next; if (/^if$/i) { my $cond = shift; defined $cond or Die("Expecting expression for -if option\n"); if (defined $condition) { $condition .= " and $cond"; } else { $condition = $cond; } next; } /^k$/i and $pause = 1, next; /^l$/ and --$outFormat, next; /^L$/ and $mainTool->Options(Charset => 'Latin'), next; /^m$/i and $mainTool->Options(IgnoreMinorErrors => 1), next; /^n$/i and $mainTool->Options(PrintConv => 0), next; if (/^o$/i) { $outOpt = shift || Die("Expected output file or directory name for -o option\n"); CleanFilename($outOpt); next; } /^overwrite_original$/i and $overwriteOrig = 1, next; /^overwrite_original_in_place$/i and $overwriteOrig = 2, next; /^p$/ and LoadPrintFormat(shift), next; /^P$/ and $preserveTime = 1, next; /^q$/i and ++$quiet, next; /^r$/i and $recurse = 1, next; /^s$/ and ++$outFormat, next; /^S$/ and $outFormat+=2, next; /^scanforxmp$/i and $mainTool->Options(ScanForXMP => 1), next; if (/^sep$/i) { $listSep = shift; defined $listSep or Die("Expecting list item separator for -sep option\n"); $mainTool->Options(ListSep => $listSep); $setListSep = 1; next; } /^srcfile$/i and $srcFmt = shift || Die("Expecting FMT for -srcfile option\n"), next; /^t$/ and $tabFormat = 1, next; if (/^T$/) { $tabFormat = 1; $outFormat+=2; ++$quiet; $forcePrint = 1; $mainTool->Options(MissingTagValue => '-'); next; } /^u$/ and $mainTool->Options(Unknown => $mainTool->Options('Unknown')+1), next; /^U$/ and $mainTool->Options(Unknown => 2), next; if (/^v(\d*)$/i) { $verbose = ($1 eq '') ? ($verbose || 0) + 1 : $1; next; } /^w$/i and $outputExt = shift || Die("Expecting output extension for -w option\n"), next; if (/^x$/) { my $tag = shift; defined $tag or Die "Expecting tag name for -x option\n"; $tag =~ s/\ball\b/\*/ig; # replace 'all' with '*' in tag names if ($setTagsFile) { push @{$setTags{$setTagsFile}}, "-$tag"; } else { push @exclude, $tag; } next; } /^X$/ and $xmlOutput = 1, $htmlOutput = 0, $mainTool->Options(Duplicates => 1), next; /^y$/i and $mainTool->Options(ExtractEmbedded => 1), next; #(undocumented option) /^z$/i and $doUnzip = 1, $mainTool->Options(Compress => 1), next; $_ eq '' and push(@files, '-'), next; # read STDIN length $_ eq 1 and Die "Unknown option -$_\n"; if (/^[^<]+()/) { # assume '-tagsFromFile @' if tags are being redirected # and -tagsFromFile hasn't already been specified $setTagsFile = '@'; push(@newValues, "TagsFromFile=@"); $setTags{$setTagsFile} or $setTags{$setTagsFile} = []; } if ($setTagsFile) { push @{$setTags{$setTagsFile}}, $_; $doSetFileName = 1 if /(^|>)(filename|directory)\b/i; } elsif (/^-(.*)/) { push @exclude, $1; } else { push @tags, $_; } } } else { # glob each filespec if necessary - MK/20061010 $_ = File::Glob::bsd_glob($_) if $doGlob and /[*?]/; CleanFilename($_); # change to forward slashes if necessary push @files, $_; } } # print help unless ((@tags and not $outOpt) or @files or @newValues) { if ($outOpt) { Warn "Nothing to write\n"; $rtnVal = 1; next; } unless ($helped) { # catch warnings if we have problems running perldoc local $SIG{'__WARN__'} = sub { $evalWarning = $_[0] }; my $dummy = \*SAVEERR; # avoid "used only once" warning open SAVEERR, ">&STDERR"; open STDERR, '>/dev/null'; if (system('perldoc',$0)) { print "Syntax: exiftool [OPTIONS] FILE\n\n"; print "Consult the exiftool documentation for a full list of options.\n"; } close STDERR; open STDERR, '>&SAVEERR'; } next; } if ($overwriteOrig > 1 and $outOpt) { Warn "Can't overwrite in place when -o option is used\n"; $rtnVal = 1; next; } # must be UTF8 for HTML conversion $mainTool->Options(Charset => 'UTF8') if $escapeHTML; # set up for RDF/XML output if ($xmlOutput) { require Image::ExifTool::XMP; # for EscapeXML() # set file header/trailer for XML output my $enc = $mainTool->Options('Charset') eq 'Latin' ? 'windows-1252' : 'UTF-8'; $fileHeader = "\n" . "\n"; $fileTrailer = "\n"; # extract list items as lists $mainTool->Options(List => 1) unless $setListSep; # always show group 1 $showGroup = $allGroup = 1; } # can't do anything if no file specified unless (@files) { unless ($outOpt) { Warn "No file specified\n"; $rtnVal = 1; next; } push @files, ''; # create file from nothing } # set Verbose and HtmlDump options if ($verbose) { $disableOutput = 1 unless @tags or @exclude; undef $binaryOutput; # disable conflicting option if ($htmlOutput) { $htmlOutput = 2; # flag for html dump $mainTool->Options(HtmlDump => $verbose); } else { $mainTool->Options(Verbose => $verbose); } } elsif (defined $verbose) { # auto-flush output when -v0 is used require FileHandle; STDOUT->autoflush(1); } # validate all tags we're writing if (@newValues) { my %addDelOpt = ( '+' => 'AddValue', '-' => 'DelValue' ); # add/delete option lookup foreach (@newValues) { /(.*?)=(.*)/s or next; my ($tag, $newVal) = ($1, $2); $tag =~ s/\ball\b/\*/ig; # replace 'all' with '*' in tag names $newVal eq '' and undef $newVal; # undefined to delete tag if ($tag =~ /^(All)?TagsFromFile$/i) { Die "Need file name for -TagsFromFile\n" unless defined $newVal; ++$isWriting; if ($newVal eq '@' or not defined FilenameSPrintf($newVal)) { push @dynamicFiles, $newVal unless grep /^$newVal$/, @dynamicFiles; next; # set tags from dynamic file later } unless (-e $newVal) { Warn "File '$newVal' does not exist for -TagsFromFile option\n"; $rtnVal = 1; next Command; } # set specified tags from this file $verbose and print("Setting new values from $newVal\n"); my $info = $mainTool->SetNewValuesFromFile($newVal, @{$setTags{$newVal}}); if ($info->{Error}) { my $err = $info->{Error}; delete $info->{Error}; delete $info->{Warning}; if (%$info) { $info->{Warning} = $err; # downgrade to a warning } else { # no tags set so error must have been fatal Warn "Error: $err - $newVal\n"; $rtnVal = 1; next Command; } } if ($info->{Warning}) { Warn "Warning: $info->{Warning} - $newVal\n"; delete $info->{Warning}; } %$info or Warn "No writable tags found - $newVal\n"; next; } elsif ($tag =~ /^PreviewImage$/i) { # can't delete preview image, so we can set it to '' $newVal = '' unless defined $newVal; } my %opts = ( Protected => 1, # allow writing of 'unsafe' tags Shift => 0, # shift values if possible instead of adding/deleting ); if ($tag =~ s/SetNewValue($tag, $newVal, %opts); ++$isWriting if $rtn; $wrn and Warn "$wrn\n"; } # exclude specified tags foreach (@exclude) { $mainTool->SetNewValue($_, undef, Replace => 2); } unless ($isWriting or $outOpt or @tags) { Warn "Nothing to do.\n"; $rtnVal = 1; next; } } elsif (grep /^(\*:)?\*$/, @exclude) { Warn "All tags excluded -- nothing to do.\n"; $rtnVal = 1; next; } # save current state of new values if setting values from target file # or if we may be translating to a different format $mainTool->SaveNewValues() if $outOpt or @dynamicFiles or @dynamicValues; $multiFile = 1 if @files > 1; @exclude and $mainTool->Options(Exclude => \@exclude); if ($binaryOutput) { $outFormat = 99; # shortest possible output format $mainTool->Options(PrintConv => 0); binmode(STDOUT); $binaryStdout = 1; # disable conflicting options undef $showGroup; $htmlOutput = $xmlOutput = 0; } # sort by groups to look nicer depending on options if (defined $showGroup and not (@tags and $allGroup)) { $mainTool->Options(Sort => "Group$showGroup"), } if (defined $outputExt) { CleanFilename($outputExt); # make all forward slashes # add '.' before output extension if necessary $outputExt = ".$outputExt" unless $outputExt =~ /[.%]/; } # determine if we should scan for only writable files if ($outOpt) { my $type = GetFileType($outOpt); if ($type) { unless (CanWrite($type)) { Warn "Can't write $type files\n"; $rtnVal = 1; next; } $scanWritable = $type unless CanCreate($type); } else { $scanWritable = 1; } $isWriting = 1; # set writing flag } elsif ($isWriting) { $scanWritable = 1; } # scan through all specified files my $file; foreach $file (@files) { if (-d $file) { $multiFile = 1; ScanDir($mainTool, $file); } else { next if $filterFlag and not AcceptFile($file); GetImageInfo($mainTool, $file); } } # print file trailer if necessary print $fileTrailer if $fileTrailer and not $outputExt and not $fileHeader; # print summary and exit my $tot = $count + $countBad; my $totWr = $countGoodWr + $countBadWr + $countSameWr + $countCopyWr + $countGoodCr + $countBadCr; if (($countDir or $totWr or $countFailed or $tot > 1 or $outputExt) and not ($binaryStdout or $quiet)) { my $o = (($htmlOutput or $xmlOutput) and not $outputExt) ? \*STDERR : \*STDOUT; printf($o "%5d directories scanned\n", $countDir) if $countDir; printf($o "%5d directories created\n", $countNewDir) if $countNewDir; printf($o "%5d files failed condition\n", $countFailed) if $countFailed; printf($o "%5d image files created\n", $countGoodCr) if $countGoodCr; printf($o "%5d image files updated\n", $countGoodWr) if $totWr - $countGoodCr - $countBadCr; printf($o "%5d image files unchanged\n", $countSameWr) if $countSameWr; printf($o "%5d image files copied\n", $countCopyWr) if $countCopyWr; printf($o "%5d files weren't updated due to errors\n", $countBadWr) if $countBadWr; printf($o "%5d files weren't created due to errors\n", $countBadCr) if $countBadCr; printf($o "%5d image files read\n", $count) if $tot>1 or ($countDir and not $totWr); printf($o "%5d files could not be read\n", $countBad) if $countBad; printf($o "%5d output files created\n", $countCreated) if $outputExt; } # set error status if we had any errors $rtnVal = 1 if $countBadWr or $countBadCr or $countBad; } # end "Command" loop Exit $rtnVal; # all done #------------------------------------------------------------------------------ # Get image information from EXIF data in file # Inputs: 0) ExifTool object reference, 1) file name sub GetImageInfo($$) { my ($exifTool, $orig) = @_; my (@foundTags, $info, $writeOnly); my $file = SourceFile($orig); my $pipe = $file; if ($doUnzip) { # pipe through gzip or bzip2 if necessary if ($file =~ /\.gz$/i) { $pipe = qq{gzip -dc "$file" |}; } elsif ($file =~ /\.bz2$/i) { $pipe = qq{bzip2 -dc "$file" |}; } } # evaluate -if expression for conditional processing if (defined $condition) { # catch run time errors as well as compile errors local $SIG{'__WARN__'} = sub { $evalWarning = $_[0] }; undef $evalWarning; my %info; # extract information and build expression for evaluation my $opts = { Duplicates => 1, Verbose => 0 }; $info = $exifTool->ImageInfo($pipe, \@foundTags, $opts); my $cond = $exifTool->InsertTagValues(\@foundTags, $condition, \%info); #### eval "-if" condition (%info) my $result = eval $cond; $@ and $evalWarning = $@; if ($evalWarning) { # fail condition if warning is issued undef $result; if ($verbose) { chomp $evalWarning; $evalWarning =~ s/ at \(eval .*//s; delete $SIG{'__WARN__'}; Warn "Condition: $evalWarning - $file\n"; } } unless ($result) { $verbose and print "-------- $file (failed condition)\n"; ++$countFailed; return; } } my ($fp, $outfile); if ($outputExt and $verbose) { ($fp, $outfile) = OpenOutputFile($orig); $fp or return; $tmpText = $outfile; # deletes file if we exit prematurely $exifTool->Options(TextOut => $fp); } if ($isWriting) { print "======== $file\n" if defined $verbose; my $success = SetImageInfo($exifTool, $orig); $info = $exifTool->GetInfo('Warning', 'Error'); PrintErrors($exifTool, $info, $file); # close output text file if necessary if ($outfile) { undef $tmpText; close($fp); $exifTool->Options(TextOut => \*STDOUT); if ($info->{Error}) { unlink $outfile; # erase bad file } else { ++$countCreated; } } return; } else { my $tag; # extract EXIF information from this file unless ($file eq '-' or -e $file) { Warn "File not found: $file\n"; $outfile and close($fp), unlink $outfile; return; } unless ($binaryOutput or $outputExt or @printFmt or $htmlOutput > 1) { if ($htmlOutput) { require Image::ExifTool::HTML; my $f = Image::ExifTool::HTML::EscapeHTML($file); print "\n"; } elsif (not $xmlOutput) { print "======== $file\n" if $multiFile and not $quiet; } } if ($info) { # get the information we wanted if (@tags and not @printFmt) { @foundTags = @tags; $info = $exifTool->GetInfo(\@foundTags); } } else { # request specified tags unless using print format option my $oldDups = $exifTool->Options('Duplicates'); if (@printFmt) { $exifTool->Options(Duplicates => 1); } else { @foundTags = @tags; } # extract the information $info = $exifTool->ImageInfo($pipe, \@foundTags); $exifTool->Options(Duplicates => $oldDups); } # all done now if we already wrote output file (ie. verbose option) if ($fp) { if ($outfile) { undef $tmpText; close($fp); $exifTool->Options(TextOut => \*STDOUT); if ($info->{Error}) { unlink $outfile; # erase bad file } else { ++$countCreated; } } if ($info->{Error}) { Warn "Error: $info->{Error} - $file\n"; ++$countBad; } return; } } # check for file error if ($info->{Error}) { Warn "Error: $info->{Error} - $file\n"; ++$countBad; return; } # print warnings to stderr if using binary output # (because we are likely ignoring them and piping stdout to file) # or if there is none of the requested information available if ($binaryOutput or not %$info) { my $errs = $exifTool->GetInfo('Warning', 'Error'); PrintErrors($exifTool, $errs, $file); } # escape characters for html or xml if necessary if ($escapeHTML) { require Image::ExifTool::HTML; my $v; foreach $v (values %$info) { if (ref $v) { next unless ref $v eq 'ARRAY'; $_ = Image::ExifTool::HTML::EscapeHTML($_) foreach @$v; } else { $v = Image::ExifTool::HTML::EscapeHTML($v); } } } # open output file (or stdout if no output file) ($fp, $outfile) = OpenOutputFile($orig); return unless $fp; # print the results for this file my $lineCount = 0; if (@printFmt) { # output using print format file (-p) option foreach (@printFmt) { my $line = $exifTool->InsertTagValues(\@foundTags, $_, 'Warn'); next unless defined $line; print $fp $line; ++$lineCount; } my $errs = $exifTool->GetInfo('Warning', 'Error'); PrintErrors($exifTool, $errs, $file); } elsif (not $disableOutput) { # print file header (only once) if ($fileHeader) { print $fp $fileHeader; undef $fileHeader unless $outputExt; } my ($tag, $line, %xmlAttr); if ($htmlOutput) { print $fp "\n"; } elsif ($xmlOutput) { my $f = Image::ExifTool::XMP::EscapeXML($file); print $fp "\nGetGroup($tag); unless ($grp1) { next unless $forcePrint; $grp = $grp1 = 'Unknown'; } next if $groups{$grp1}; $groups{$grp1} = 1; # include family 0 and 1 groups in URI except for internal tags # (this will put internal tags in the "XML" group on readback) $grp .= "/$grp1" unless $grp =~ /^(ExifTool|File|Composite|Unknown)$/; print $fp "\n xmlns:$grp1='http://ns.exiftool.ca/$grp/1.0/'"; } print $fp '>' if $outFormat < 1; # finish rdf:Description token unless short format } my $lastGroup = ''; my $indent = (defined $showGroup and not $allGroup) ? ' ' : ''; foreach $tag (@foundTags) { my $tagName = GetTagName($tag); my $group; # make sure this tag has a value my $val = $info->{$tag}; if (not defined $val) { # ignore tags that weren't found unless necessary next if $binaryOutput; next unless $forcePrint; $val = '-'; # forced to print all tag values } if (defined $showGroup) { $group = $exifTool->GetGroup($tag, $showGroup); unless ($allGroup) { if ($lastGroup ne $group) { if ($htmlOutput) { my $cols = 1; ++$cols if $outFormat==0 or $outFormat==1; ++$cols if $showTagID; print $fp "\n"; } else { print $fp "---- $group ----\n"; } $lastGroup = $group; } undef $group; # undefine so we don't print it below } } ++$lineCount; # we are printing something meaningful my $id; if ($binaryOutput) { # translate scalar reference to actual binary data if (ref $val eq 'SCALAR') { $val = $$val; } elsif (ref $val eq 'ARRAY') { $val = join "\n", @$val; } print $fp $val; next; } if ($showTagID) { $id = $exifTool->GetTagID($tag); if ($id =~ /^(\d+)(\.\d+)?$/) { # only print numeric ID's $id = sprintf("0x%.4x", $1) if $showTagID eq 'H'; } elsif ($xmlOutput) { $id = Image::ExifTool::XMP::EscapeXML($id); } else { $id = '-'; } } if (ref $val eq 'SCALAR') { if ($$val =~ /^Binary data/) { $val = $$val; } else { $val = 'Binary data ' . length($$val) . ' bytes'; } my $b = $xmlOutput ? '' : ', use -b option to extract'; $val = "($val$b)"; } elsif (ref $val eq 'ARRAY' and (not $xmlOutput or $setListSep or $outFormat > 0)) { # join array values $val = join($listSep, @$val) if ref $val eq 'ARRAY'; } # get description if we need it (use tag name if $outFormat > 0) my $desc = $outFormat > 0 ? $tagName : $exifTool->GetDescription($tag); # RDF/XML output format if ($xmlOutput) { my (@vals, $count); $group or $group = 'Unknown'; if (ref $val eq 'ARRAY') { unless ($escapeHTML) { $_ = Image::ExifTool::XMP::EscapeXML($_) foreach @$val; } $val = "\n \n " . join("\n ", @$val) . "\n \n "; } else { $val = Image::ExifTool::XMP::EscapeXML($val) unless $escapeHTML; } $val =~ s/\x00//g; # nulls would be bad if ($outFormat > 0) { my $tok = "$group:$tagName"; unless ($xmlAttr{$tok}) { print $fp "\n $group:$tagName='$val'"; # XML does not allow duplicate attributes $xmlAttr{$tok} = 1; } } else { my $xtra = $showTagID ? " et:tagid='$id'" : ''; if ($outFormat < 0) { $desc = Image::ExifTool::XMP::EscapeXML($desc); $xtra .= "\n et:desc='$desc'"; } print $fp "\n <$group:$tagName$xtra>$val"; } next; } # translate unprintable chars in value and remove trailing spaces $val =~ tr/\x01-\x1f\x7f/./; $val =~ s/\x00//g; $val =~ s/\s+$//; if ($htmlOutput) { print $fp ""; print $fp "" if defined $group; print $fp "" if $showTagID; if ($outFormat <= 1) { $desc = Image::ExifTool::HTML::EscapeHTML($desc); print $fp ""; } print $fp "\n"; } else { my $buff = ''; if ($tabFormat) { $buff = "$group\t" if defined $group; $buff .= "$id\t" if $showTagID; if ($outFormat <= 1) { $buff .= "$desc\t$val\n"; } elsif (defined $line) { $line .= "\t$val"; } else { $line = $val; } } elsif ($outFormat < 0) { # long format $buff = "[$group] " if defined $group; $buff .= "$id " if $showTagID; $buff .= "$desc\n $val\n"; } elsif ($outFormat == 0 or $outFormat == 1) { my $wid; my $len = 0; if (defined $group) { $buff = sprintf("%-15s ", "[$group]"); $len = 16; } if ($showTagID) { $wid = ($showTagID eq 'D') ? 5 : 6; $len += $wid + 1; ($wid = $len - length($buff) - 1) < 1 and $wid = 1; $buff .= sprintf "%${wid}s ", $id; } ($wid = 32 - (length($buff) - $len)) < 1 and $wid = 1; $buff .= sprintf "%-${wid}s: %s\n", $desc, $val; } elsif ($outFormat == 2) { $buff = "[$group] " if defined $group; $buff .= "$id " if $showTagID; $buff .= "$tagName: $val\n"; } else { $buff = "$group " if defined $group; $buff .= "$id " if $showTagID; $buff .= "$val\n"; } print $fp $buff; } } if ($htmlOutput) { print $fp "
$group
$group$id$desc$val
\n"; } elsif ($xmlOutput) { # close rdf:Description element print $fp $outFormat < 1 ? "\n\n" : "/>\n"; } elsif ($tabFormat and $outFormat > 1) { print $fp "$line\n" if defined $line; } } if ($outfile) { print $fp $fileTrailer if $fileTrailer; # write file trailer close($fp); if ($lineCount) { ++$countCreated; } else { unlink $outfile; # don't keep empty output files } } ++$count; } #------------------------------------------------------------------------------ # Set information in file # Inputs: 0) ExifTool object reference # 1) original source file name ('' to create from scratch) # Returns: true on success sub SetImageInfo($$) { my ($exifTool, $orig) = @_; my ($outfile, $restored, $isTemporary, $isStdout); my $file = SourceFile($orig); my $infile = $file; # save infile in case we change it again my $tagsFromSrc; undef $tmpFile; # make sure this isn't defined # clear any existing errors or warnings since we check these on return delete $exifTool->{VALUE}->{Error}; delete $exifTool->{VALUE}->{Warning}; # first, try to determine our output file name so we can return quickly # if it already exists (note: this test must be delayed until after we # set tags from dynamic files if writing FileName or Directory) if (defined $outOpt) { if ($outOpt eq '-') { $isStdout = 1; } else { $outfile = FilenameSPrintf($outOpt, $orig); if ($outfile eq '') { Warn "Can't create file with zero-length name from $orig\n"; ++$countBadCr; return 0; } if (-d $outfile or $outfile =~ /\/$/) { $outfile .= '/' unless $outfile =~ /\/$/; my $name = $file; $name =~ s/.*\///; # remove directory name $outfile .= $name; } else { my $srcType = GetFileType($file) || ''; my $outType = GetFileType($outfile); if ($outType and ($srcType ne $outType or $outType eq 'ICC')) { unless (CanCreate($outfile)) { my $what = $srcType ? 'other types' : 'scratch'; WarnOnce "Error: Can't create $outType files from $what\n"; ++$countBadCr; return 0; } if ($file ne '') { # restore previous new values unless done already $exifTool->RestoreNewValues(); $restored = 1; # translate to this type by setting specified tags from file my @setTags = @tags; foreach (@exclude) { push @setTags, "-$_"; } # force some tags to be copied for certain file types my %forceCopy = ( ICC => 'ICC_Profile', VRD => 'CanonVRD', ); push @setTags, $forceCopy{$outType} if $forceCopy{$outType}; # assume "-tagsFromFile @" unless -tagsFromFile already specified # (%setTags won't be empty if -tagsFromFile used) if (not %setTags or (@setTags and not $setTags{'@'})) { return 0 unless DoSetFromFile($exifTool, $file, \@setTags); } elsif (@setTags) { # add orphaned tags to existing "-tagsFromFile @" for this file only push @setTags, @{$setTags{'@'}}; $tagsFromSrc = \@setTags; } # all done with source file -- create from meta information alone $file = ''; } } } $outfile = NextUnusedFilename($outfile); if (-e $outfile and not $doSetFileName) { Warn "Error: '$outfile' already exists - $infile\n"; ++$countBadWr; return 0; } } } elsif ($file eq '-') { $isStdout = 1; } # set new values with dynamic file names if (@dynamicValues) { # restore previous values if necessary $exifTool->RestoreNewValues() unless $restored; $restored = 1; my ($dyVal, $buff); foreach $dyVal (@dynamicValues) { my $dyfile = FilenameSPrintf($$dyVal[1], $orig); my ($rtn, $wrn); if (defined $dyfile and SlurpFile($dyfile, \$buff)) { $verbose and print "Reading $$dyVal[0] from $dyfile\n"; ($rtn, $wrn) = $mainTool->SetNewValue($$dyVal[0], $buff, %{$$dyVal[2]}); $wrn and Warn "$wrn\n"; } # remove this tag if we couldn't set it properly $rtn or $mainTool->SetNewValue($$dyVal[0], undef, Replace => 2); } } # set tags from destination file if required if (@dynamicFiles) { # restore previous values if necessary $exifTool->RestoreNewValues() unless $restored; my $dyFile; foreach $dyFile (@dynamicFiles) { my ($fromFile, $setTags); if ($dyFile eq '@') { $fromFile = $orig; $setTags = $tagsFromSrc || $setTags{$dyFile}; } else { $fromFile = FilenameSPrintf($dyFile, $orig); ++$countBadWr, return 0 unless defined $fromFile; $setTags = $setTags{$dyFile}; } # set new values values from file return 0 unless DoSetFromFile($exifTool, $fromFile, $setTags); } } if ($isStdout) { # write to STDOUT $outfile = \*STDOUT; binmode(STDOUT); $binaryStdout = 1; } else { # determine what our output file name should be my $newFileName = $exifTool->GetNewValues('FileName'); my $newDir = $exifTool->GetNewValues('Directory'); if ($newFileName or $newDir or ($doSetFileName and defined $outfile)) { if ($newFileName) { $newFileName = FilenameSPrintf($newFileName, $orig); if (defined $outfile) { $outfile = Image::ExifTool::GetNewFileName($orig, $outfile) if $orig ne ''; $outfile = Image::ExifTool::GetNewFileName($outfile, $newFileName); } elsif ($orig ne '') { $outfile = Image::ExifTool::GetNewFileName($orig, $newFileName); } } if ($newDir) { $newDir = FilenameSPrintf($newDir, $orig); $outfile = Image::ExifTool::GetNewFileName(defined $outfile ? $outfile : $orig, $newDir); } $outfile = NextUnusedFilename($outfile, $infile); if (-e $outfile) { if ($infile ne $outfile) { Warn "Error: '$outfile' already exists - $infile\n"; ++$countBadWr; return 0; } undef $outfile; # not changing the file name after all } } if (defined $outfile) { $verbose and print "'$infile' --> '$outfile'\n"; # create output directory if necessary CreateDirectory($outfile); # set temporary file (automatically erased on abnormal exit) $tmpFile = $outfile if defined $outOpt; } unless (defined $tmpFile) { # count the number of tags and pseudo-tags we are writing my ($numSet, $numPseudo) = $exifTool->CountNewValues(); if (-e $file) { unless ($numSet) { # no need to write if no tags set ++$countSameWr; print "Nothing changed in $file\n" if defined $verbose; return 1; } } elsif (CanCreate($file)) { if ($numSet == $numPseudo) { # no need to write if no real tags Warn("Error: Nothing to write - $file\n"); ++$countBadWr; return 0; } unless (defined $outfile) { # create file from scratch $outfile = $file; $file = ''; } } else { # file doesn't exist, and we can't create it Warn("Error: File not found - $file\n"); ++$countBadWr; return 0; } # quickly rename file and/or set file date if this is all we are doing if ($numSet == $numPseudo) { my $r1 = $exifTool->SetFileModifyDate($file); my $r2 = 0; $r2 = $exifTool->SetFileName($file, $outfile) if defined $outfile; if ($r1 > 0 or $r2 > 0) { ++$countGoodWr; } elsif ($r1 < 0 or $r2 < 0) { ++$countBadWr; return 0; } else { ++$countSameWr; } return 1; } unless (defined $outfile) { # write to a truly temporary file $outfile = "${file}_exiftool_tmp"; if (-e $outfile) { Warn("Error: Temporary file already exists: $outfile\n"); ++$countBadWr; return 0; } $isTemporary = 1; } # new output file is temporary until we know it has been written properly $tmpFile = $outfile; } } # rewrite the file my $success = $exifTool->WriteInfo($file, $outfile); # get file time if preserving it my ($modTime, $accTime); if ($preserveTime and $success and -e $file) { $modTime = $^T - (-M $file) * (24 * 3600); $accTime = $^T - (-A $file) * (24 * 3600); } if ($success == 1) { # preserve the original file times if (defined $tmpFile) { if (-e $file) { if ($preserveTime and not utime($accTime, $modTime, $tmpFile)) { Warn "Error setting file time - $file\n"; } if ($isTemporary) { # move original out of the way my $original = "${file}_original"; if (not $overwriteOrig and not -e $original) { # rename the file and check again to be sure the file doesn't exist # (in case, say, the filesystem truncated the file extension) if (not rename($file, $original) or -e $file) { Die "Error renaming $file\n"; } } if ($overwriteOrig > 1) { # copy temporary file over top of original to preserve attributes my ($err, $buff); my $newFile = $tmpFile; open(NEW_FILE, "<$newFile") or Die "Error opening $newFile\n"; binmode(NEW_FILE); # must not erase temporary file now if interrupted undef $tmpFile; if (open(ORIG_FILE, ">$file")) { $tmpFile = $file; # original is now our temporary file binmode(ORIG_FILE); while (read(NEW_FILE, $buff, 65536)) { print ORIG_FILE $buff or $err = 1; } close(NEW_FILE); close(ORIG_FILE) or $err = 1; if ($err) { Warn "Couldn't overwrite in place - $file\n"; undef $tmpFile; rename($newFile, $file) or Die "Error renaming $newFile to $file\n"; } else { undef $tmpFile; unlink $newFile; if ($preserveTime and not utime($accTime, $modTime, $file)) { Warn "Error setting file time - $file\n"; } } ++$countGoodWr; } else { close(NEW_FILE); Warn "Error opening $file for writing\n"; unlink $newFile; ++$countBadWr; } # simply rename temporary file to replace original } elsif (rename($tmpFile, $file)) { ++$countGoodWr; } else { Warn "Error renaming temporary file to $file\n"; unlink $tmpFile; ++$countBadWr; } } elsif ($overwriteOrig) { # erase original file unlink $file or Warn "Error erasing original $file\n"; ++$countGoodWr; } else { ++$countGoodCr; } } else { # this file was created from scratch, not edited ++$countGoodCr; } } else { ++$countGoodWr; } } elsif ($success) { if ($isTemporary) { # just erase the temporary file since no changes were made unlink $tmpFile; ++$countSameWr; } else { if (defined $accTime and not utime($accTime, $modTime, $outfile)) { Warn "Error setting file time - $file\n"; } if ($overwriteOrig) { unlink $file or Warn "Error erasing original $file\n"; } ++$countCopyWr; } print "Nothing changed in $file\n" if defined $verbose; } else { unlink $tmpFile if defined $tmpFile; ++$countBadWr; } undef $tmpFile; return $success; } #------------------------------------------------------------------------------ # Set new values from file # Inputs: 0) exiftool ref, 1) filename, 2) reference to list of values to set # Returns: 0 on error (and increments $countBadWr) sub DoSetFromFile($$$) { my ($exifTool, $file, $setTags) = @_; $verbose and print "Setting new values from $file\n"; my $info = $exifTool->SetNewValuesFromFile($file, @$setTags); PrintErrors($exifTool, $info, $file); $info->{Error} and ++$countBadWr, return 0; return 1; } #------------------------------------------------------------------------------ # Translate backslashes to forward slashes in filename if necessary # Inputs: 0) Filename # Returns: nothing, but changes filename if necessary sub CleanFilename($) { $_[0] =~ tr/\\/\// if $hasBackslash{$^O}; } #------------------------------------------------------------------------------ # Scan directory for image files # Inputs: 0) ExifTool object reference, 1) directory name sub ScanDir($$) { my $exifTool = shift; my $dir = shift; opendir(DIR_HANDLE, $dir) or Die "Error opening directory $dir\n"; my @fileList = readdir(DIR_HANDLE); closedir(DIR_HANDLE); my $file; $dir =~ /\/$/ or $dir .= '/'; foreach $file (@fileList) { my $path = "$dir$file"; if (-d $path) { next if $file =~ /^\./; # ignore dirs starting with "." next if grep /^$file$/, @ignore; $recurse and ScanDir($exifTool, $path); next; } # apply rules from -ext options my $accepted; if ($filterFlag) { $accepted = AcceptFile($file) or next; # must be specifically accepted to bypass selection logic $accepted &= 0x01; } unless ($accepted) { # read/write this file if it is a recognized type if ($scanWritable) { if ($scanWritable eq '1') { next unless CanWrite($file); } else { my $type = GetFileType($file); next unless defined $type and $type eq $scanWritable; } } elsif (not GetFileType($file)) { next unless $doUnzip; next unless $file =~ /\.(gz|bz2)$/i; } } GetImageInfo($exifTool, $path); } ++$countDir; } #------------------------------------------------------------------------------ # Add print format entry # Inputs: 0) expression string sub AddPrintFormat($) { my $expr = shift; push @printFmt, $expr; # add to list of requested tags push @tags, $expr =~ /\$((?:[a-zA-Z0-9]+:)?[-a-zA-Z_0-9]+)/g; # tags contained in braces too... push @tags, $expr =~ /\$\{((?:[a-zA-Z0-9]+:)?[-a-zA-Z_0-9]+)\}/g; } #------------------------------------------------------------------------------ # Load print format file # Inputs: 0) file name # - saves lines of file to @printFmt list # - adds tag names to @tags list sub LoadPrintFormat($) { my $arg = shift || Die "Must specify file or expression for -p option\n"; if (open(FMT_FILE, "<$arg")) { foreach () { /^#/ and next; # ignore comments AddPrintFormat($_); } close(FMT_FILE); } else { Die "Can't open file: $arg\n" unless $arg =~ /\$/; AddPrintFormat($arg . "\n"); } @tags or Die "Print format file doesn't contain any tag names!\n"; } #------------------------------------------------------------------------------ # A sort of sprintf for filenames # Inputs: 0) format string (%d=dir, %f=file name, %e=ext), # 1) source filename or undef to test format string # Returns: new filename or undef on error (or if no file and fmt contains token) sub FilenameSPrintf($;$) { my ($fmt, $file) = @_; # return format string straight away if no tokens return $fmt unless $fmt =~ /%[-+]?\d*\.?\d*[lu]?[dfe]/; return undef unless defined $file; CleanFilename($file); # make sure we are using forward slashes # split filename into directory, file, extension my @parts = ($file =~ /^(.*?)([^\/]*?)[.]?([^.\/]*)$/); @parts or Warn("Error: Bad pattern match for file $file\n"), return undef; my %part; foreach ('d','f','e') { $part{$_} = shift @parts; } my ($filename, $pos) = ('', 0); while ($fmt =~ /(%([-+]?)(\d*)\.?(\d*)([lu]?)([dfe]))/g) { $filename .= substr($fmt, $pos, pos($fmt) - $pos - length($1)); $pos = pos($fmt); my ($sign, $wid, $skip, $mod, $code) = ($2, $3, $4 || 0, $5, $6); my $len = length $part{$code}; next unless $skip < $len; $wid = $len - $skip if $wid eq '' or $wid + $skip > $len; $skip = $len - $wid - $skip if $sign eq '-'; my $part = substr($part{$code}, $skip, $wid); $part = ($mod eq 'u') ? uc($part) : lc($part) if $mod; $filename .= $part; } $filename .= substr($fmt, $pos); # add rest of file name $filename =~ s{//}{/}g; # remove double slashes return $filename; } #------------------------------------------------------------------------------ # Expand '%c' codes if filename to get next unused file name # Inputs: 0) file name format string, 1) filename ok to use even if it exists # Returns: new file name sub NextUnusedFilename($;$) { my ($fmt, $okfile) = @_; return $fmt unless $fmt =~ /%[-+]?\d*\.?\d*[lun]?c/; my %sep = ( '-' => '-', '+' => '_' ); my ($copy, $alpha) = (0, 'a'); for (;;) { my ($filename, $pos) = ('', 0); while ($fmt =~ /(%([-+]?)(\d*)(\.?)(\d*)([lun]?)c)/g) { $filename .= substr($fmt, $pos, pos($fmt) - $pos - length($1)); $pos = pos($fmt); my ($sign, $wid, $dec, $wid2, $mod) = ($2, $3 || 0, $4, $5 || 0, $6); next unless $dec or $copy; # add dash or underline separator if '-' or '+' specified $filename .= $sep{$sign} if $sign; $wid = $wid2 if $wid < $wid2; if ($mod and $mod ne 'n') { my $str = ($wid and $wid > length $alpha) ? 'a' x ($wid - length($alpha)) : ''; $str .= $alpha; $str = uc $str if $mod eq 'u'; $filename .= $str; } else { my $num = $copy + ($mod ? 1 : 0); $filename .= $wid ? sprintf("%.${wid}d",$num) : $num; } } $filename .= substr($fmt, $pos); # add rest of file name # return now with filename unless file exists return $filename unless -e $filename; return $filename if defined $okfile and $filename eq $okfile; ++$copy; ++$alpha; } } #------------------------------------------------------------------------------ # Create directory for specified file # Inputs: 0) complete file name including path # Returns: true if a directory was created (dies if dir can't be created) sub CreateDirectory($) { my $file = shift; my ($dir, $created); ($dir = $file) =~ s/[^\/]*$//; # remove filename from path specification if ($dir and not -d $dir) { my @parts = split /\//, $dir; $dir = ''; foreach (@parts) { $dir .= $_; if (length $dir and not -d $dir) { # create directory since it doesn't exist mkdir($dir, 0777) or Die "Error creating directory $dir\n"; $verbose and print "Created directory $dir\n"; $created = 1; } $dir .= '/'; } } ++$countNewDir if $created; return $created; } #------------------------------------------------------------------------------ # Open output text file # Inputs: 0) file name format string # Returns: 0) file reference (or undef on error), 1) file name if opened sub OpenOutputFile($) { my $file = shift; my ($fp, $outfile); if ($outputExt) { $outfile = $file; CleanFilename($outfile); if ($outputExt =~ /%[-+]?\d*\.?\d*[lun]?[dfec]/) { # make filename from printf-like $outputExt $outfile = FilenameSPrintf($outputExt, $file); return () unless defined $outfile; $outfile = NextUnusedFilename($outfile); CreateDirectory($outfile); # create directory if necessary } else { $outfile =~ s/\.[^.\/]*$//; # remove extension if it exists $outfile .= $outputExt; } if (-e $outfile) { Warn "Output file $outfile already exists for $file\n"; return (); } open(OUTFILE, ">$outfile") or Die "Error creating $outfile\n"; binmode(OUTFILE) if $binaryOutput; $fp = \*OUTFILE; } else { $fp = \*STDOUT; } return($fp, $outfile); } #------------------------------------------------------------------------------ # Filter files based on extension # Inputs: 0) file name # Returns: 0 = rejected, 1 = specifically accepted, 2 = accepted by default # Notes: This routine should only be called if $filterFlag is set sub AcceptFile($) { my $file = shift; my $ext = ($file =~ /.*\.(.+)$/) ? uc($1) : ''; return $filterExt{$ext} if defined $filterExt{$ext}; return 0 if $filterFlag & 0x02; # reject if accepting specific extensions return 2; # accept by default } #------------------------------------------------------------------------------ # Slurp file into buffer # Inputs: 0) file name, 1) buffer reference # Returns: 1 on success sub SlurpFile($$) { my ($file, $buffPt) = @_; open(INFILE, "<$file") or Warn("Error opening file $file\n"), return 0; binmode(INFILE); my $maxSize = 16000000; my $num = read(INFILE, $$buffPt, $maxSize); close(INFILE); $num or Warn("Error reading $file\n"), return 0; $num < $maxSize or Warn("File exceeds size limit: $file\n"), return 0; return 1; } #------------------------------------------------------------------------------ # Print list of tags # Inputs: 0) message, 1-N) list of tag names sub PrintTagList($@) { my $msg = shift; print $msg, ":\n "; my $len = 1; my $tag; foreach $tag (@_) { my $taglen = length($tag); if ($len + $taglen > 78) { print "\n "; $len = 1; } print " $tag"; $len += $taglen + 1; } @_ or print ' [empty list]'; print "\n"; } #------------------------------------------------------------------------------ # Get source file name for specified file # Inputs: 0) file name sub SourceFile($) { my $file = shift; return $file unless $srcFmt; return FilenameSPrintf($srcFmt, $file); } #------------------------------------------------------------------------------ # Print warnings and errors from info hash # Inputs: 0) ExifTool object ref, 1) info hash, 2) file name sub PrintErrors($$$) { my ($exifTool, $info, $file) = @_; my ($tag, $key); foreach $tag (qw(Warning Error)) { next unless $$info{$tag}; my @keys = ( $tag ); push @keys, sort(grep /$tag /, keys %$info) if $exifTool->Options('Duplicates'); foreach $key (@keys) { Warn "$tag: $info->{$key} - $file\n"; } } } __END__ =head1 NAME exiftool - Read and write meta information in files =head1 SYNOPSIS B [I] [-I...] [--I...] I... B [I] -I[+-E]=[I]... I... B [I] B<-TagsFromFile> I [-I[EI]...] I... B [ B<-ver> | B<-list>[B|B|B[I]|B] ] For specific examples, see the L sections below. =head1 DESCRIPTION A command-line interface to L, used for reading and writing meta information in image, audio and video files. I is a source file name, directory name, or C<-> for the standard input. Information is read from the source file and output in readable form to the console (or written to an output text file with the B<-w> option). To write or copy information, new values are specified with the -I=[I] syntax or the B<-TagsFromFile> option. This causes I to be rewritten, and by default the original file is preserved with C<_original> appended to the file name. (Be sure to verify that the new file is OK before erasing the original.) Once in write mode, exiftool will ignore any read-specific options. Below is a list of file types and meta information formats currently supported by ExifTool (r = read, w = write, c = create): File Types | Meta Information --------------------------------------- | -------------------- 3FR r HTML r PPM r/w | EXIF r/w/c ACR r ICC r/w/c PPT r | GPS r/w/c AI r ITC r PS r/w | IPTC r/w/c AIFF r JNG r/w PSD r/w | XMP r/w/c APE r JP2 r/w QTIF r | MakerNotes r/w/c ARW r JPEG r/w RA r | Photoshop IRB r/w/c ASF r K25 r RAF r/w | ICC Profile r/w/c AVI r KDC r RAM r | MIE r/w/c BMP r M4A r RAW r/w | JFIF r/w/c BTF r MEF r/w RIFF r | Ducky APP12 r/w/c CR2 r/w MIE r/w/c RWZ r | PDF r/w/c CRW r/w MIFF r RM r | CIFF r/w CS1 r/w MNG r/w SO r | AFCP r/w DCM r MOS r/w SR2 r | JPEG 2000 r DCR r MOV r SRF r | DICOM r DIVX r MP3 r SVG r | Flash r DJVU r MP4 r SWF r | FlashPix r DLL r MPC r THM r/w | QuickTime r DNG r/w MPG r TIFF r/w | GeoTIFF r DOC r MRW r/w VRD r/w/c | PrintIM r DYLIB r NEF r/w WAV r | ID3 r EPS r/w OGG r WDP r/w | Kodak Meta r EXE r ORF r/w WMA r | Ricoh RMETA r ERF r/w PBM r/w WMV r | Picture Info r FLAC r PDF r/w X3F r | Adobe APP14 r FLV r PEF r/w XLS r | APE r FPX r PGM r/w XMP r/w/c | Vorbis r GIF r/w PICT r ZIP r | SPIFF r HDP r/w PNG r/w | (and more) Note: If I is a directory name, then only file types with recognized extensions are processed when reading, and only writable types are processed when any tag is written. However, the B<-ext> option may be used to force processing of files with any extension. =head1 OPTIONS Case is not significant for any command-line option (including tag and group names), except for single-character options if the corresponding upper case option is defined. Multiple options may NOT be combined into a single argument, because that would be interpreted as a tag name. =over 5 =item B<->I Extract information for specified tag (ie. C<-CreateDate>). See L for documentation on available tag names. A tag name may include a leading group name separated by a colon (ie. C<-XMP:Creator>). Any family 0 or 1 group name may be used, and the group name may be prefixed by a digit to specify family number (ie. C<-1IPTC:Keywords>). Use the B<-listg> or B<-listg1> option to list valid family 0 or 1 group names. A special tag name of C may be used to indicate all meta information. This is particularly useful when a group name is specified to extract all information in a group. (C<*> is a synonym for C, but must be quoted if used on the command line to prevent shell globbing.) If no tags are specified, all available information is extracted. Note: Descriptions, not tag names, are shown by default when extracting information. Use the B<-s> option to see the tag names instead. =item B<-->I Exclude specified tag from extracted information. Same as the B<-x> option. May also be used following a B<-TagsFromFile> option to exclude tags from being copied, or to exclude groups from being deleted when deleting all information (ie. C<-all= --exif:all> deletes all but EXIF information). Note that this will not exclude individual tags from a group delete. Instead, the tags must be recovered using the B<-TagsFromFile> option. =item B<->I[+-]B<=>[I] Write a new value for the specified tag (ie. C<-comment=wow>), or delete the tag if no I is given (ie. C<-comment=>). C<+=> and C<-=> are used to add or remove existing entries from a list, or to shift date/time values (see L for details), and C<-=> may be used to conditionally remove or replace a tag (see L for examples). If a group name is not specified for I, then the information is written to the preferred group, which is the first group in the following list where I is valid: 1) EXIF, 2) IPTC, 3) XMP, 4) MakerNotes. The special C tag may be used in this syntax only if a I is NOT given. This causes all meta information to be deleted (or all information in a group if C<-GROUP:All=> is used). Note that not all groups are deletable. Also, within an image some groups may be contained within others, and these groups are removed if the super group is deleted. Below are lists of these group dependencies: JPEG Image: - Deleting EXIF or IFD0 also deletes ExifIFD, GlobParamIFD, GPS, IFD1, InteropIFD, MakerNotes, PrintIM and SubIFD. - Deleting ExifIFD also deletes InteropIFD and MakerNotes. - Deleting Photoshop also deletes IPTC. TIFF Image: - Deleting EXIF only removes ExifIFD which also deletes InteropIFD and MakerNotes. =item B<->IE=I or B<->IE=I Set the value of a tag from the contents of file I. The file name may also be given by a I string where %d, %f and %e represent the directory, file name and extension of the original I (see the B<-w> option for more details). Note that quotes are required around this argument to prevent shell redirection since it contains a C> symbol. C<+E=> or C<-E=> may also be used to add or delete specific list entries, or to shift date/time values. =item B<-@> I Read command-line arguments from the specified file. The file contains one argument per line (NOT one option per line -- some options require additional arguments which must be placed on separate lines). Blank lines and lines beginning with C<#> and are ignored. Normal shell processing of arguments is not performed, which among other things means that arguments should not be quoted. I may exist relative to either the current directory or the exiftool directory unless an absolute pathname is given. For example, the following I will set the value of Copyright to "Copyright YYYY, Phil Harvey", where "YYYY" is the year of CreateDate: -d %Y -copyright, B<--a> Bllow (B<-a>) or supress (B<--a>) duplicate tag names in the output. By default, duplicate tags are suppressed unless the B<-X> option is used. =item B<-b> Output requested data in Binary format without tag names or descriptions. This option is mainly used for extracting embedded images or other binary data, but it may also be useful for some text strings since control characters (such as newlines) are not replaced by '.' as they are in the default output. =item B<-c> I Set the print format for GPS Boordinates. I uses the same syntax as the C format string. The specifiers correspond to degrees, minutes and seconds in that order, but minutes and seconds are optional. For example, the following table gives the output for the same coordinate using various formats: FMT Output ------------------- ------------------ "%d deg %d' %.2f"\" 54 deg 59' 22.80" (the default) "%d deg %.4f min" 54 deg 59.3800 min "%.6f degrees" 54.989667 degrees =item B<-d> I Set the format for Bate/time tag values. Consult C man page for I syntax. The default format is equivalent to "%Y:%m:%d %H:%M:%S". This option has no effect on date-only or time-only tags and ignores timezone information if present. The inverse operation (ie. un-formatting a date/time value) is currently not applied when writing a date/time tag. =item B<-D> Show tag ID number in Becimal. =item B<-e> Print Bxisting tags only -- don't calculate composite tags. =item B<-E> Bscape characters in output values for HTML. Implied with the B<-h> option. =item B<-ext> I, B<--ext> I Process only files with (B<-ext>) or without (B<--ext>) a specified extension. There may be multiple B<-ext> and B<--ext> options. Extensions may begin with a leading '.', and case is not significant. For example: exiftool -ext .JPG DIR # process only JPG files exiftool --ext crw --ext dng DIR # process all but CRW and DNG exiftool --ext . DIR # ignore if no extension =item B<-f> Borce printing of tags even if their values are not found. =item B<-F>[I] Fix the base for maker notes offsets. A common problem with some image editors is that offsets in the maker notes are not adjusted properly when the file is modified. This may cause the wrong values to be extracted for some maker note entries when reading the edited file. This option allows an integer I to be specified for adjusting the maker notes base offset. If no I is given, ExifTool takes its best guess at the correct base. Note that exiftool will automatically fix the offsets for images which store original offset information (ie. newer Canon models). Offsets are fixed permanently if used when writing an image. =item B<-fast> Increase speed of extracting information from JPEG images. With this option, ExifTool will not scan to the end of a JPEG image to check for an AFCP or PreviewImage trailer. The speed benefits are small when reading images directly from disk, but can be substantial if piping images through a network connection. =item B<-g>[I] Organize output by tag Broup. I specifies the group family number, and may be 0 (general location), 1 (specific location) or 2 (category). If not specified, B<-g0> is assumed. Use the B<-listg> option to list all group names for a specified family. =item B<-G>[I] Same as B<-g> but print Broup name for each tag. =item B<-h> Use BTML formatting for output. Implies B<-E> option. The formatting options B<-D>, B<-H>, B<-g>, B<-G>, B<-l> and B<-s> may be used in combination with B<-h> to influence the HTML format. =item B<-H> Show tag ID number in Bexadecimal. =item B<-htmlDump>[I] Generate a dynamic web page containing a hex dump of the EXIF information. This can be a very powerful tool for low-level analysis of EXIF information. The B<-htmlDump> option is also invoked if the B<-v> and B<-h> options are used together. The verbose level controls the maximum length of the blocks dumped. An I may be given to specify the base for displayed offsets. If not provided, the EXIF/TIFF base offset is used. Use B<-htmlDump0> for absolute offsets. Currently only EXIF and TIFF information is dumped, but the -u option can be used to give a raw hex dump of other file formats. =item B<-i> I Bgnore specified directory name. May be multiple B<-i> options. =item B<-if> I Specify a condition to be evaluated before processing each I. I is a Perl-like expression containing tag names prefixed by C<$> symbols. It is evaluated with the tags from each I in turn, and processing proceeds only if the expression returns true. Unlike Perl variable names, tag names are not case sensitive and may contain a hyphen or a leading group name separated by a colon. When multiple B<-if> options are used, all conditions must be satisfied to process the file. Below are a few examples: # extract shutterspeed from all Canon images in a directory exiftool -shutterspeed -if '$make eq "Canon"' dir # add one hour to all images created on or after Apr. 2, 2006 exiftool -alldates+=1 -if '$CreateDate ge "2006:04:02"' dir # set EXIF ISO value if possible, unless it is set already exiftool '-exif:iso Pause with the message C<-- press any key --> before terminating. This option is used to prevent the command window from closing when run as a Windows drag and drop application. =item B<-l> Use Bong 2-line Canon-style output format. Adds a description to the XML output when B<-X> is used. =item B<-L> Convert 16-bit Unicode characters in output to Windows Batin1 (cp1252) instead of the default UTF-8. When writing, -L is used to specify that input text values are Latin1 instead of UTF-8. =item B<-list>, B<-listw>, B<-listf>, B<-listwf>, B<-listg>[I], B<-listd> Print a B of all valid tag names (B<-list>), all Britable tag names (B<-listw>), all recognized Bile extensions (B<-listf>), all Britable Bile extensions (B<-listwf>), all tag Broups [in a specified family] (B<-listg>[I]), or all Beletable tag groups (B<-listd>). The B<-list> and B<-listw> options may be followed by an additional argument of the form C<-GROUP:All> to list all tags in a specific group. With B<-listg>, I may be given to specify the group family, otherwise family 0 is assumed. For example: -list # list all tag names -list -EXIF:All # list all EXIF tags -listw -XMP-dc:All # list all writable XMP-dc tags -listf # list all recognized file extensions -listwf # list all writable file extensions -listg1 # list all groups in family 1 -listd # list all deletable groups =item B<-m> Ignore Binor errors. Allows writing if some minor errors occur, or extraction of embedded images that aren't in standard JPG format. =item B<-n> Read and write values as Bumbers instead of words. This option disables the print conversion that is applied when extracting values to make them more readable, and the inverse print conversion when writing. For example: > exiftool -Orientation -S a.jpg Orientation: Rotate 90 CW > exiftool -Orientation -S -n a.jpg Orientation: 6 and the following two writing commands have the same effect > exiftool -Orientation='Rotate 90 CW' a.jpg > exiftool -Orientation=6 -n a.jpg =item B<-o> I or I Set the Butput file or directory name when writing information. (Without this option, the original file is renamed to C and output is sent to I.) The output file name may also be specified using a I string in which %d, %f and %e represent the directory, file name and extension of I. Also, %c may be used to add a copy number. See the B<-w> option for I string examples. The output file is taken to be a directory name if it already exists as a directory or if the name ends with '/'. Output directories are created if necessary. Existing files will not be overwritten. Combining the B<-overwrite_original> option with B<-o> causes the original source file to be erased after the output file is successfully written. A special feature of this option allows it to be used to create certain types of files from scratch. Currently, this can only be done with XMP and ICC/ICM files. The file is created from a combination of information in I and tag values assigned on the command line. This is done by specifying a file extension of '.XMP', '.ICC' or '.ICM' for I. The output file may be created even if no I is specified, provided some appropriate tag values are specified on the command line. =item B<-overwrite_original> Overwrite the original I (instead of preserving it by adding C<_original> to the file name) when writing information to an image. Caution: This option should only be used if you already have separate backup copies of your image files. The overwrite is implemented by renaming a temporary file. =item B<-overwrite_original_in_place> Similar to the B<-overwrite_original> option except that an extra step is added to allow the original file attributes to be preserved. On a Macintosh for example, this preserves the original file type, creator and icon. This is implemented by copying the contents of a temporary file over the original, then deleting the temporary file. The extra step results in slower performance, so the B<-overwrite_original> option should be used instead unless necessary. =item B<-p> I or I B

rint output in the format specified by the given file or string (and ignore other format options). Tag names in the format file or string begin with a C<$> symbol and may contain an optional group name. Case is not significant. Braces C<{}> may be used around the tag name to separate it from subsequent text. Use C<$$> to represent a C<$> symbol. C<$/> may be used for a newline. In the file, lines beginning with C<#> are ignored. For example, this format file: # this is a comment line File $FileName was created on $DateTimeOriginal (f/$Aperture, ${ShutterSpeed}s, ISO $EXIF:ISO) produces output like this: File test.jpg was created on 2003:10:31 15:44:19 (f/5.6, 1/60s, ISO 100) If a tag does not exist, the output value is set to '-' if the B<-f> option is used. Otherwise a minor warning is issued and the line with the missing tag is not printed. However, if the B<-m> option is used, minor warnings are ignored and the line is printed with an empty tag value. =item B<-P> B

reserve date/time of original file (C) when writing. =item B<-q> Buiet processing. One B<-q> suppresses normal informational messages, and a second B<-q> suppresses warnings as well. Error messages can not be suppressed, although minor errors may be downgraded to warnings with the B<-m> option. =item B<-r> Becursively scan subdirectories. Only meaningful if I is a directory name. =item B<-s> Print tag names instead of descriptions. This is the Bhort output format. Add up to 3 B<-s> options for even shorter formats: -s - print tag names instead of descriptions -s -s - no extra spaces to column-align values -s -s -s - print values only Also effective when combined with B<-t>, B<-h> or B<-X> options. =item B<-S> Very Bhort format. The same as two B<-s> options. Extra spaces used to column-align values are not printed. =item B<-ScanForXMP> Scan all files (even unrecognized formats) for XMP information unless found already. When combined with the B<-fast> option, only unrecognized file types are scanned. Warning: It can be time consuming to scan large files. =item B<-sep> I Specify separator for values in List-type tags. Default is ", ". =item B<-t> Output a Bab-delimited list of description/values (useful for database import). May be combined with B<-s> to print tag names instead of descriptions, or B<-S> to print tag values only, tab-delimited on a single line. =item B<-T> Output tag values in Bable form. (Equivalent to B<-t -S -q -f>.) =item B<-TagsFromFile> I or I Copy tag values from I to I. Tag names on the command line after this option specify the tags to be copied, or excluded from the copy. If no tags are specified, then all tags from the source file are copied. More than one B<-TagsFromFile> option may be used to copy tags from multiple files. By default, this option will commute information between same-named tags in different groups and write each tag to the preferred group. This allows information to be automatically translated when copying between images of different formats. However, if a group name is specified for a tag then the information is written to the original group (unless redirected to another group, see below). This works even if C is used as a group name, so C<-All:All> is used to specify that all information be copied to the same group in the destination file. I may be the same as I to move information around within a file. In this case, C<@> may be used to represent the source file (ie. C<-TagsFromFile @>), permitting this feature to be used for batch processing multiple files (see note 3 below). Specified tags are then copied from each file in turn as it is rewritten. For advanced batch use, the source file name may also be specified using a I string in which %d, %f and %e represent the directory, file name and extension of I. See B<-w> option for I string examples. A powerful redirection feature allows a destination tag to be specified for each extracted tag. With this feature, information may be written to a tag with a different name or group. This is done using E'-IEI'E on the command line after B<-TagsFromFile> (E'-IEI'E also works). Note that this argument must be quoted to prevent shell redirection, and there is no C<=> sign as when assigning new values. Both source and destination tags may be prefixed by a group name, and C or C<*> may be used as a tag or group name. If no destination group is specified, the information is written to the preferred group. As a convenience, C<-TagsFromFile @> is assumed for any redirected tags which are specified without a prior B<-TagsFromFile> option. Copied tags may also be added or deleted from a list with arguments of the form E'-I+EI'E or E'-I-EI'E. An extension of the redirection feature allows strings involving tag names to be used on the right hand side of the C> symbol with the syntax E'-IEI'E, where tag names in I are prefixed with a C<$> symbol. See the B<-p> option for more details about this syntax. Strings starting with a C<=> sign must insert a single space after the C> to avoid confusion with the C=> syntax which would otherwise attempt to set the tag value from the contents of a file. A single space at the start of the string is removed if it exists, but all other whitespace is preserved. See L for examples using B<-TagsFromFile>. Notes: 1) Be aware of the difference between excluding a tag from being copied (--I), and deleting a tag (-I=). Excluding a tag prevents it from being copied to the destination image, but deleting will remove a pre-existing tag from the image. 2) The maker note information is copied as a block, so it isn't affected like other information by subsequent tag assignments on the command line. Also, since the PreviewImage referenced from the maker notes may be rather large, it is not copied, and must be transferred separately if desired. 3) When performing complex batch processing, it is important to note that the order of operations is different for tags copied in batch mode. In general, tags are copied from batch-mode files after all other command-line arguments have been applied. (The exception is that a group delete is always performed last if there are no subsequent tag assignments on the command line.) For example, the following two commands are not equivalent: # (not batch mode): Sets xmp:title to 'NEW' exiftool -tagsfromfile a.jpg -xmp:title -xmp:title=NEW a.jpg # (batch mode): Preserves original title if it exists exiftool -tagsfromfile @ -xmp:title -xmp:title=NEW a.jpg 4) The normal behaviour of copied tags differs subtly from assigned tags for List-type tags. When copying to a list, each copied tag overrides any previous operations on the list. While this avoids duplicate list items when copying groups of tags from a file containing redundant information, it also prevents values from different tags from being copied into the same list when this is the intent. To change this, a B<-addTagsFromFile> option is provided to allow multiple items to be copied to the same list. Other than this difference, B<-addTagsFromFile> is equivalent to B<-tagsFromFile>. =item B<-u> Extract values of Bnknown tags. Add another B<-u> to also extract unknown information from binary data blocks. =item B<-U> Extract values of Bnknown tags as well as unknown information from binary data blocks. This is the same as two B<-u> options. =item B<-v>[I] Print Berbose messages. I specifies the level of verbosity in the range 0-5, with higher numbers being more verbose. If I is not given, then each B<-v> option increases the level of verbosity by 1. This option suppresses normal console output unless specific tags are being extracted. B<-v0> is used when writing to print only the processed file names, and the "Nothing changed" message for files that were not modified. =item B<-ver> Print version number and exit. =item B<-w> I or I Brite console output to a file with name ending in I for each source file. The output file name is obtained by replacing the source file extension (including the '.') with the specified extension (and a '.' is added to the start of I if it didn't contain one). Alternatively, a I string may be used to give more control over the output file name and directory. In the format string, %d, %f and %e represent the directory, filename and extension of the source file, and %c represents a copy number which is automatically incremented if the file already exists. %d includes the trailing '/' if necessary, but %e does not include the leading '.'. For example: -w %d%f.txt # same effect as "-w txt" -w dir/%f_%e.out # write files to "dir" as "FILE_EXT.out" -w dir2/%d%f.txt # write to "dir2", keeping dir structure -w a%c.txt # write to "a.txt" or "a1.txt" or "a2.txt"... Existing files will not be overwritten, and output directories are created automatically if necessary. Note: In a Windows BAT file the '%' character is represented by "%%", so an argument like "%d%f.txt" is written as "%%d%%f.txt". Advanced features: A substring of the original file name, directory or extension may be taken by specifying a field width immediately following the '%' character. If the width is negative, the substring is taken from the end. The substring position (characters to ignore at the start or end of the string) may be given by a second optional value after a decimal point. For example: Input File Name Format Specifier Output File Name ---------------- ---------------- ---------------- Picture-123.jpg %7f.txt Picture.txt Picture-123.jpg %-.4f.out Picture.out Picture-123.jpg %7f.%-3f Picture.123 Picture-123a.jpg Meta%-3.1f.txt Meta123.txt For %c, these modifiers have a different effects. If a field width is given, the copy number is padded with zeros to the specified width. A leading '-' adds a dash before the copy number, and a '+' adds an underline. By default, a copy number of zero is omitted, but this can be changed by adding a decimal point to the modifier. For example: -w A%-cZ.txt # AZ.txt, A-1Z.txt, A-2Z.txt ... -w B%5c.txt # B.txt, B00001.txt, B00002.txt ... -w C%.c.txt # C0.txt, C1.txt, C2.txt ... -w D%-.c.txt # D-0.txt, D-1.txt, D-2.txt ... -w E%-.4c.txt # E-0000.txt, E-0001.txt, E-0002.txt ... -w F%-.4nc.txt # F-0001.txt, F-0002.txt, F-0003.txt ... -w G%+c.txt # G.txt, G_1.txt G_2.txt ... -w H%-lc.txt # H.txt, H-b.txt, H-c.txt ... All format codes may be modified by 'l' or 'u' to specify lower or upper case respectively (ie. "%le" for a lower case file extension). When used to modify the copy number (%c), the numbers are changed to an alphabetical base (see example H above). Also, %c may be modified by 'n' to count using natural numbers starting from 1, instead of 0 (see example F). This same I syntax is used with the B<-o> and B<-TagsFromFile> options, although %c is only valid for output file names. =item B<-x> I EBclude the specified tag. There may be multiple B<-x> options. This has the same effect as --I on the command line. May also be used following a B<-TagsFromFile> option to exclude tags from being copied. =item B<-X> Use RDF/BML formatting for console output. Implies the B<-a> option so duplicate tags are extracted. The formatting options B<-D>, B<-H>, B<-l> and B<-s> may be used in combination with B<-X> to affect the output, but note that tag ID's (B<-D> and B<-H> options) may not be added to the short (B<-s>) output. Another restriction of B<-s> is that only one tag with a given group and name may appear in the output. By default, list-type tags with multiple values are formatted as an RDF Bag, but they are combined into a single string when B<-sep> or B<-s> is used. Using B<-L> changes the XML encoding from "UTF-8" to "windows-1252". =item B<-z> When reading, causes information to be extracted from .gB and .bB2 compressed images. (Only one image per archive.) When writing, causes compressed information to be written if supported by the image format. (ie. The PNG format supports compressed text.) =back =head2 Advanced Options The following options allow complex processing to be performed with a single command without the need for additional scripting. This may be particularly useful for implementations such as Windows drag-and-drop applications. These options may also be used to improve performance in multi-pass processing by reducing the overhead required to load exiftool for each invocation. =over 5 =item B<-common_args> Specifies that all arguments following this option are common to all executed commands when B<-execute> is used. This is the only option that may not be used inside a B<-@> I. =item B<-execute> Execute command for all arguments up to this point on the command line. Allows multiple commands to be executed from a single command line. =item B<-srcfile> I Specify a different source file to be processed based on the name of the original file. This may be useful in some special situations for processing related preview images or sidecar files. See the B<-w> option for a description of the I syntax. Note that file name I strings for all options are based on the original file name specified on the command line, not the name of the source file specified by B<-srcfile>. =back =head1 READING EXAMPLES =over 5 =item exiftool -a -u -g1 a.jpg Print all meta information in an image, including duplicate and unknown tags, sorted by group (for family 1). =item exiftool -common dir Print common meta information for all images in C

. =item exiftool -T -createdate -aperture -shutterspeed -iso dir > out.txt List meta information in tab-delimited column form for all images in "dir" to an output text file named "out.txt". =item exiftool -s -ImageSize -ExposureTime b.jpg Print ImageSize and ExposureTime tag names and values. =item exiftool -l -canon c.jpg d.jpg Print standard Canon information from two image files. =item exiftool -r -w .txt -common pictures Recursively extract common meta information from files in C directory, writing text output into files with the same names but with a C<.txt> extension. =item exiftool -p '$filename has date $dateTimeOriginal' -q -f dir Print one line of output containing the file name and DateTimeOriginal for each image in directory C. =item exiftool -b -ThumbnailImage image.jpg > thumbnail.jpg Save thumbnail image from C to a file called C. =item exiftool -b -PreviewImage 118_1834.JPG > preview.jpg Extract preview image from JPG file and write it to C. =item exiftool -b -JpgFromRaw -w _JFR.JPG -ext CRW -r . Recursively extract JPG image from all Canon CRW files in the current directory, adding C<_JFR.JPG> for the name of the output JPG files. =item exiftool -d '%r %a, %B %e, %Y' -DateTimeOriginal -S -s *.jpg Print formatted date/time for all JPG files in a directory. =item exiftool -IFD1:XResolution -IFD1:YResolution Extract image resolution from EXIF IFD1 information (thumbnail image IFD). =item exiftool -xmp -b a.jpg > out.xmp Extract complete XMP data record intact from C and write it to C using the special C tag (see the Extra tags in L<Image::ExifTool::TagNames|Image::ExifTool::TagNames>). =item exiftool -icc_profile -b -w icc image.jpg Save complete ICC_Profile from an image to an output file with the same name and an extension of C<.icc>. =item exiftool -htmldump -w tmp/%f_%e.html t/images Generate HTML pages from a hex dump of EXIF information in all images from the C<t/images> directory. The output HTML files are written to the C<tmp> directory (which is created if it didn't exist), with names of the form 'FILENAME_EXT.html'. =back =head1 WRITING EXAMPLES Note that quotes are necessary around arguments which contain certain special characters such as C<E<gt>>, C<E<lt>> or any white space. These quoting techniques are shell dependent, but the examples below will work for most Unix shells. With the Windows cmd shell however, double quotes should be used (ie. -Comment="This is a new comment"). =over 5 =item exiftool -Comment='This is a new comment' dst.jpg Write new comment to a JPG image (replaces any existing comment). =item exiftool -comment= -o newdir *.jpg Remove comment from all JPG images in the current directory, writing the modified images to a new directory. =item exiftool -keywords=EXIF -keywords=editor dst.jpg Replace existing keyword list with two new keywords (C<EXIF> and C<editor>). =item exiftool -Keywords+=word -o newfile.jpg src.jpg Copy a source image to a new file, and add a keyword (C<word>) to the current list of keywords. =item exiftool -credit-=xxx dir Delete Credit information from all files in a directory where the Credit value was (C<xxx>). =item exiftool -all= dst.jpg Delete all meta information from an image. =item exiftool -all= -comment='lonely' dst.jpg Delete all meta information from an image and add a comment back in. (Note that the order is important: C<-comment='lonely' -all=> would also delete the new comment.) =item exiftool -all= --jfif:all dst.jpg Delete all meta information except JFIF group from an image. =item exiftool -Photoshop:All= dst.jpg Delete Photoshop meta information from an image (note that the Photoshop information also includes IPTC). =item exiftool -r -XMP-crss:all= DIR Recursively delete all XMP-crss information from images in a directory. =item exiftool '-ThumbnailImageE<lt>=thumb.jpg' dst.jpg Set the thumbnail image from specified file (Note: The quotes are neccessary to prevent shell redirection). =item exiftool '-JpgFromRawE<lt>=%d%f_JFR.JPG' -ext CRW -r . Recursively write JPEG images with filenames ending in C<_JFR.JPG> to the JpgFromRaw tag of like-named files with extension C<.CRW> in the current directory. (This is the inverse of the C<-JpgFromRaw> command of the L</READING EXAMPLES> section above.) =item exiftool -DateTimeOriginal-='0:0:0 1:30:0' dir Adjust original date/time of all images in directory C<dir> by subtracting one hour and 30 minutes. (This is equivalent to C<-DateTimeOriginal-=1.5>. See L<Image::ExifTool::Shift.pl|Image::ExifTool::Shift.pl> for details.) =item exiftool -createdate+=3 -modifydate+=3 a.jpg b.jpg Add 3 hours to the CreateDate and ModifyDate timestamps of two images. =item exiftool -AllDates+=1:30 -if '$make eq "Canon"' dir Shift the values of DateTimeOriginal, CreateDate and ModifyDate forward by 1 hour and 30 minutes for all Canon images in a directory. (The AllDates tag is provided as a shortcut for these three tags, allowing them to be accessed via a single tag.) =item exiftool -xmp:city=Kingston image1.jpg image2.nef Write a tag to the XMP group of two images. (Without the C<xmp:> this tag would get written to the IPTC group since C<City> exists in both, and IPTC is preferred by default.) =item exiftool -LightSource-='Unknown (0)' dst.tiff Delete C<LightSource> tag only if it is unknown with a value of 0. =item exiftool -whitebalance-=auto -WhiteBalance=tung dst.jpg Set C<WhiteBalance> to C<Tungsten> only if it was previously C<Auto>. =item exiftool -o %d%f.xmp dir Create XMP meta information data files for all images in C<dir>. =item exiftool -o test.xmp -owner=Phil -title='XMP File' Create an XMP data file only from tags defined on the command line. =item exiftool '-ICC_Profile<=%d%f.icc' image.jpg Write ICC_Profile to an image from a C<.icc> file of the same name. =back =head1 COPYING EXAMPLES These examples demonstrate the ability to copy tag values between files. =over 5 =item exiftool -TagsFromFile src.crw dst.jpg Copy the values of all writable tags from C<src.crw> to C<dst.jpg>, writing the information to the preferred groups. =item exiftool -TagsFromFile src.jpg -all:all dst.jpg Copy the values of all writable tags from C<src.jpg> to C<dst.jpg>, preserving the original tag groups. =item exiftool -all= -tagsfromfile src.jpg -exif:all dst.jpg Erase all meta information from C<dst.jpg> image, then copy EXIF tags from C<src.jpg>. =item exiftool -tagsfromfile a.jpg out.xmp Copy meta information C<a.jpg> to an XMP data file. If the XMP data file C<out.xmp> already exists, it will be updated with the new information. Otherwise the XMP data file will be created. Only XMP, ICC and MIE files may be created like this (other file types may be edited but not created). See L</WRITING EXAMPLES> above for another technique to generate XMP files. =item exiftool -tagsFromFile a.jpg -XMP:All= -ThumbnailImage= -m b.jpg Copy all meta information from C<a.jpg> to C<b.jpg>, deleting all XMP information and the thumbnail image from the destination. =item exiftool -TagsFromFile src.jpg -title -author=Phil dst.jpg Copy title from one image to another and set a new author name. =item exiftool -TagsFromFile a.jpg -ISO -TagsFromFile b.jpg -comment dst.jpg Copy ISO from one image and Comment from another image to a destination image. =item exiftool -tagsfromfile src.jpg -exif:all --subifd:all dst.jpg Copy only the EXIF information from one image to another, excluding SubIFD tags. =item exiftool '-DateTimeOriginal>FileModifyDate' dir Use the original date from the meta information to set the same file's filesystem modification date for all images in a directory. (Note that C<-TagsFromFile @> is assumed if no other B<-TagsFromFile> is specified when redirecting information as in this example.) =item exiftool -TagsFromFile src.jpg '-all>xmp:all' dst.jpg Copy all possible information from C<src.jpg> and write in XMP format to C<dst.jpg>. =item exiftool -@ iptc2xmp.args -iptc:all= a.jpg Translate IPTC information to XMP with appropriate tag name conversions, and delete the original IPTC information from an image. This example uses iptc2xmp.args, which is a file included with the ExifTool distribution that contains the required arguments to convert IPTC information to XMP format. Also included with the distribution is xmp2iptc.args, which performs the inverse conversion. =item exiftool -tagsfromfile %d%f.CRW -r -ext JPG dir Recursively rewrite all C<JPG> images in C<dir> with information copied from the corresponding C<CRW> images in the same directories. =item exiftool '-make+>keywords' image.jpg Add camera make to list of keywords. =item exiftool '-comment<ISO=$exif:iso Exposure=${shutterspeed}' dir Set the Comment tag of all images in C<dir> from the values of the EXIF:ISO and ShutterSpeed tags. The resulting comment will be in the form "ISO=100 Exposure=1/60". =item exiftool -TagsFromFile src.jpg -icc_profile dst.jpg Copy ICC_Profile from one image to another. =item exiftool -TagsFromFile src.jpg -all:all dst.mie Copy all meta information in its original form from a JPEG image to a MIE file. The MIE file will be created if it doesn't exist. This technique can be used to store the metadata of an image so it can be inserted back into the image (with the inverse command) later in a workflow. =item exiftool -o dst.mie -all:all src.jpg This command performs exactly the same task as the command above, except that the C<-o> option will not write to an output file that already exists. =item exiftool -if '$jpgfromraw' -b -jpgfromraw -w %d%f_%ue.jpg -execute -if '$previewimage' -b -previewimage -w %d%f_%ue.jpg -execute -tagsfromfile @ -srcfile %d%f_%ue.jpg -overwrite_original -common_args --ext jpg DIR [Advanced] Extract JpgFromRaw or PreviewImage from all but JPG files in DIR, saving them with file names like C<image_EXT.jpg>, then add all meta information from the original files to the extracted images. Here, the command line is broken into three sections (separated by B<-execute> options), and each is executed as if it were a separate command. The B<-common_args> option causes the C<--ext jpg DIR> arguments to be applied to all three commands, and the B<-srcfile> option allows the extracted JPG image to be the source file for the third command (whereas the RAW files are the source files for the other two commands). =back =head1 RENAMING EXAMPLES By writing the C<FileName> and C<Directory> tags, files are renamed and/or moved to new directories. This can be particularly useful and powerful for organizing files by date when combined with the B<-d> option. New directories are created as necessary, but existing files will not be overwritten. The format codes %d, %f and %e may be used in the new file name to represent the directory, name and extension of the original file, and %c may be used to add a copy number if the file already exists (see the B<-w> option for details). Note that if used within a date format string, an extra '%' must be added to pass these codes through the date/time parser. (And further note that in a Windows batch file, all '%' characters must also be escaped, so in this extreme case '%%%%f' is necessary to pass a simple '%f' through the two levels of parsing.) =over 5 =item exiftool -filename=new.jpg dir/old.jpg Rename C<old.jpg> to C<new.jpg> in directory C<dir>. =item exiftool -directory=%e dir Move all files from directory C<dir> into directories named by the original file extensions. =item exiftool '-Directory<DateTimeOriginal' -d %Y/%m/%d dir Move all files in C<dir> into a directory hierarchy based on year, month and day of C<DateTimeOriginal>. ie) This command would move the file C<dir/image.jpg> with a C<DateTimeOriginal> of C<2005:10:12 16:05:56> to C<2005/10/12/image.jpg>. =item exiftool '-filename<%f_${focallength}.%e' dir Rename all files in C<dir> by adding FocalLength to the file name. =item exiftool '-FileName<CreateDate' -d %Y%m%d_%H%M%S%%-c.%%e dir Rename all images in C<dir> according to the C<CreateDate> date and time, adding a copy number with leading '-' if the file already exists (C<%-c>), and preserving the original file extension (C<%e>). Note the extra '%' necessary to escape the filename codes (C<%c> and C<%e>) in the date format string. =item exiftool -r '-FileName<CreateDate' -d %Y-%m-%d/%H%M_%%f.%%e dir Both the directory and the filename may be changed together via the C<FileName> tag if the new C<FileName> contains a '/'. The example above recursively renames all images in a directory by adding a C<CreateDate> timestamp to the start of the filename, then moves them into new directories named by date. =item exiftool '-FileName<${CreateDate}_$filenumber.jpg' -d %Y%m%d *.jpg Set the filename of all JPG images in the current directory from the CreateDate and FileNumber tags, in the form "20060507_118-1861.jpg". =back =head1 PIPING EXAMPLES =over 5 =item cat a.jpg | exiftool - Extract information from stdin. =item exiftool image.jpg -thumbnailimage -b | exiftool - Extract information from an embedded thumbnail image. =item cat a.jpg | exiftool -iptc:keywords+=fantastic - > b.jpg Add an IPTC keyword in a pipeline, saving output to a new file. =item wget -qO - http://a.domain.com/bigfile.jpg | exiftool -fast - Extract information from an image over the internet using the GNU wget utility. The B<-fast> option prevents exiftool from scanning for trailer information, so only the meta information header is transferred. =item exiftool a.jpg -thumbnailimage -b | exiftool -comment=wow - | exiftool a.jpg -thumbnailimage'<=-' Add a comment to an embedded thumbnail image. (Why anyone would want to do this I don't know, but I've included this as an example to illustrate the flexibility of ExifTool.) =back =head1 BUGS ExifTool does not handle information stored in the resource fork on Macintosh filesystems. =head1 AUTHOR Copyright 2003-2008, Phil Harvey This is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =head1 SEE ALSO L<Image::ExifTool(3pm)|Image::ExifTool>, L<Image::ExifTool::TagNames(3pm)|Image::ExifTool::TagNames>, L<Image::ExifTool::Shortcuts(3pm)|Image::ExifTool::Shortcuts>, L<Image::ExifTool::Shift.pl|Image::ExifTool::Shift.pl> =cut #------------------------------------------------------------------------------ # end