#------------------------------------------------------------------------------
# File: QuickTimeStream.pl
#
# Description: Extract embedded information from QuickTime movie data
#
# Revisions: 2018-01-03 - P. Harvey Created
#
# References: 1) https://developer.apple.com/library/content/documentation/QuickTime/QTFF/QTFFChap3/qtff3.html#//apple_ref/doc/uid/TP40000939-CH205-SW130
# 2) http://sergei.nz/files/nvtk_mp42gpx.py
# 3) https://forum.flitsservice.nl/dashcam-info/dod-ls460w-gps-data-uit-mov-bestand-lezen-t87926.html
#------------------------------------------------------------------------------
package Image::ExifTool::QuickTime;
use strict;
# QuickTime data types that have ExifTool equivalents
# (ref https://developer.apple.com/library/content/documentation/QuickTime/QTFF/Metadata/Metadata.html#//apple_ref/doc/uid/TP40000939-CH1-SW35)
my %qtFmt = (
0 => 'undef',
1 => 'string', # (UTF-8)
# 2 - UTF-16
# 3 - shift-JIS
# 4 - UTF-8 sort
# 5 - UTF-16 sort
# 13 - JPEG image
# 14 - PNG image
# 21 - signed integer (1,2,3 or 4 bytes)
# 22 - unsigned integer (1,2,3 or 4 bytes)
23 => 'float',
24 => 'double',
# 27 - BMP image
# 28 - QuickTime atom
65 => 'int8s',
66 => 'int16s',
67 => 'int32s',
70 => 'float', # float[2] x,y
71 => 'float', # float[2] width,height
72 => 'float', # float[4] x,y,width,height
74 => 'int64s',
75 => 'int8u',
76 => 'int16u',
77 => 'int32u',
78 => 'int64u',
79 => 'float', # float[9] transform matrix
80 => 'float', # float[8] face coordinates
);
# maximums for validating H,M,S,d,m,Y from "freeGPS " metadata
my @dateMax = ( 24, 59, 59, 2200, 12, 31 );
# size of freeGPS block
my $gpsBlockSize = 0x8000;
# conversion factors
my $knotsToKph = 1.852; # knots --> km/h
my $mpsToKph = 3.6; # m/s --> km/h
# tags extracted from various QuickTime data streams
%Image::ExifTool::QuickTime::Stream = (
GROUPS => { 2 => 'Location' },
NOTES => q{
Timed metadata extracted from QuickTime movie data and some AVI videos when
the ExtractEmbedded option is used.
},
VARS => { NO_ID => 1 },
GPSLatitude => { PrintConv => 'Image::ExifTool::GPS::ToDMS($self, $val, 1, "N")' },
GPSLongitude => { PrintConv => 'Image::ExifTool::GPS::ToDMS($self, $val, 1, "E")' },
GPSAltitude => { PrintConv => '(sprintf("%.4f", $val) + 0) . " m"' }, # round to 4 decimals
GPSSpeed => { PrintConv => 'sprintf("%.4f", $val) + 0' }, # round to 4 decimals
GPSSpeedRef => { PrintConv => { K => 'km/h', M => 'mph', N => 'knots' } },
GPSTrack => { PrintConv => 'sprintf("%.4f", $val) + 0' }, # round to 4 decimals
GPSTrackRef => { PrintConv => { M => 'Magnetic North', T => 'True North' } },
GPSDateTime => { PrintConv => '$self->ConvertDateTime($val)', Groups => { 2 => 'Time' } },
Accelerometer=> { Notes => 'right/up/backward acceleration in units of g' },
RawGSensor => {
# (same as GSensor, but offset by some unknown value)
ValueConv => 'my @a=split " ",$val; $_/=1000 foreach @a; "@a"',
},
Text => { Groups => { 2 => 'Other' } },
TimeCode => { Groups => { 2 => 'Video' } },
FrameNumber => { Groups => { 2 => 'Video' } },
SampleTime => { Groups => { 2 => 'Video' }, PrintConv => 'ConvertDuration($val)', Notes => 'sample decoding time' },
SampleDuration=>{ Groups => { 2 => 'Video' }, PrintConv => 'ConvertDuration($val)' },
#
# timed metadata decoded based on MetaFormat (format of 'meta' or 'data' sample description)
# [or HandlerType, or specific 'vide' type if specified]
#
mebx => {
Name => 'mebx',
SubDirectory => {
TagTable => 'Image::ExifTool::QuickTime::Keys',
ProcessProc => \&ProcessMebx,
},
},
gpmd => {
Name => 'gpmd',
SubDirectory => { TagTable => 'Image::ExifTool::GoPro::GPMF' },
},
fdsc => {
Name => 'fdsc',
Condition => '$$valPt =~ /^GPRO/',
# (other types of "fdsc" samples aren't yet parsed: /^GP\x00/ and /^GP\x04/)
SubDirectory => { TagTable => 'Image::ExifTool::GoPro::fdsc' },
},
rtmd => {
Name => 'rtmd',
SubDirectory => { TagTable => 'Image::ExifTool::Sony::rtmd' },
},
CTMD => { # (Canon Timed MetaData)
Name => 'CTMD',
SubDirectory => { TagTable => 'Image::ExifTool::Canon::CTMD' },
},
RVMI => [{ # data "OtherFormat" written by unknown software
Name => 'RVMI_gReV',
Condition => '$$valPt =~ /^gReV/', # GPS data
SubDirectory => {
TagTable => 'Image::ExifTool::QuickTime::RVMI_gReV',
ByteOrder => 'Little-endian',
},
},{
Name => 'RVMI_sReV',
Condition => '$$valPt =~ /^sReV/', # sensor data
SubDirectory => {
TagTable => 'Image::ExifTool::QuickTime::RVMI_sReV',
ByteOrder => 'Little-endian',
},
# (there is also "tReV" data that hasn't been decoded yet)
}],
camm => { # (written by Insta360) - [HandlerType, not MetaFormat]
Name => 'camm6',
Condition => '$$valPt =~ /^\0\0\x06\0/',
SubDirectory => {
TagTable => 'Image::ExifTool::QuickTime::camm6',
ByteOrder => 'Little-Endian',
},
},
JPEG => { # (in CR3 images) - [vide HandlerType with JPEG in SampleDescription, not MetaFormat]
Name => 'JpgFromRaw',
Groups => { 2 => 'Preview' },
RawConv => '$self->ValidateImage(\$val,$tag)',
},
);
# tags found in 'camm' type 6 timed metadata (ref PH, Insta360)
%Image::ExifTool::QuickTime::camm6 = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Location' },
FIRST_ENTRY => 0,
NOTES => q{
Tags extracted from record type 6 of the 'camm' timed metadata of MP4 videos
from cameras such as the Insta360.
},
# 0x0c - int32u, seen: 3 (GPSMeasureMode?)
0x10 => {
Name => 'GPSLatitude',
Format => 'double',
ValueConv => 'Image::ExifTool::GPS::ToDegrees($val, 1)',
PrintConv => 'Image::ExifTool::GPS::ToDMS($self, $val, 1, "N")',
},
0x18 => {
Name => 'GPSLongitude',
Format => 'double',
ValueConv => 'Image::ExifTool::GPS::ToDegrees($val, 1)',
PrintConv => 'Image::ExifTool::GPS::ToDMS($self, $val, 1, "E")',
},
0x20 => {
Name => 'GPSAltitude',
Format => 'float',
PrintConv => '$_ = sprintf("%.3f", $val); s/\.?0+$//; "$_ m"',
},
# 0x30 - float (GPSSpeed?)
);
# tags found in 'RVMI' 'gReV' timed metadata (ref PH)
%Image::ExifTool::QuickTime::RVMI_gReV = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Location' },
FIRST_ENTRY => 0,
NOTES => q{
GPS information extracted from the RVMI box of MOV videos.
},
4 => {
Name => 'GPSLatitude',
Format => 'int32s',
ValueConv => 'Image::ExifTool::GPS::ToDegrees($val/1e6, 1)',
PrintConv => 'Image::ExifTool::GPS::ToDMS($self, $val, 1, "N")',
},
8 => {
Name => 'GPSLongitude',
Format => 'int32s',
ValueConv => 'Image::ExifTool::GPS::ToDegrees($val/1e6, 1)',
PrintConv => 'Image::ExifTool::GPS::ToDMS($self, $val, 1, "E")',
},
# 12 - int32s: space for altitude? (always zero in my sample)
16 => {
Name => 'GPSSpeed', # km/h
Format => 'int16s',
ValueConv => '$val / 10',
},
18 => {
Name => 'GPSTrack',
Format => 'int16u',
ValueConv => '$val * 2',
},
);
# tags found in 'RVMI' 'sReV' timed metadata (ref PH)
%Image::ExifTool::QuickTime::RVMI_sReV = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 2 => 'Location' },
FIRST_ENTRY => 0,
NOTES => q{
G-sensor information extracted from the RVMI box of MOV videos.
},
4 => {
Name => 'GSensor',
Format => 'int16s[3]', # X Y Z
ValueConv => 'my @a=split " ",$val; $_/=1000 foreach @a; "@a"',
},
);
#------------------------------------------------------------------------------
# Save information from keys in OtherSampleDesc directory for processing timed metadata
# Inputs: 0) ExifTool object ref, 1) dirInfo ref, 2) tag table ref
# Returns: 1 on success
# (ref "Timed Metadata Media" here:
# https://developer.apple.com/library/content/documentation/QuickTime/QTFF/QTFFChap3/qtff3.html)
sub SaveMetaKeys($$$)
{
local $_;
my ($et, $dirInfo, $tagTbl) = @_;
my $dataPt = $$dirInfo{DataPt};
my $dirLen = length $$dataPt;
return 0 unless $dirLen > 8;
my $pos = 0;
my $verbose = $$et{OPTIONS}{Verbose};
my $oldIndent = $$et{INDENT};
my $ee = $$et{ee};
$ee or $ee = $$et{ee} = { };
$verbose and $et->VerboseDir($$dirInfo{DirName}, undef, $dirLen);
# loop through metadata key table
while ($pos + 8 < $dirLen) {
my $size = Get32u($dataPt, $pos);
my $id = substr($$dataPt, $pos+4, 4);
my $end = $pos + $size;
$end = $dirLen if $end > $dirLen;
$pos += 8;
my ($tagID, $format, $pid);
if ($verbose) {
$pid = PrintableTagID($id,1);
$et->VPrint(0, "$oldIndent+ [Metdata Key entry, Local ID=$pid, $size bytes]\n");
$$et{INDENT} .= '| ';
}
while ($pos + 4 < $end) {
my $len = unpack("x${pos}N", $$dataPt);
last if $len < 8 or $pos + $len > $end;
my $tag = substr($$dataPt, $pos + 4, 4);
$pos += 8; $len -= 8;
my $val = substr($$dataPt, $pos, $len);
$pos += $len;
my $str;
if ($tag eq 'keyd') {
($tagID = $val) =~ s/^(mdta|fiel)com\.apple\.quicktime\.//;
$tagID = "Tag_$val" unless $tagID;
($str = $val) =~ s/(.{4})/$1 / if $verbose;
} elsif ($tag eq 'dtyp') {
next if length $val < 4;
if (length $val >= 4) {
my $ns = unpack('N', $val);
if ($ns == 0) {
length $val >= 8 or $et->Warn('Short dtyp data'), next;
$str = unpack('x4N',$val);
$format = $qtFmt{$str} || 'undef';
} elsif ($ns == 1) {
$str = substr($val, 4);
$format = 'undef';
} else {
$format = 'undef';
}
$str .= " ($format)" if $verbose and defined $str;
}
}
if ($verbose > 1) {
if (defined $str) {
$str =~ tr/\x00-\x1f\x7f-\xff/./;
$str = " = $str";
} else {
$str = '';
}
$et->VPrint(1, $$et{INDENT}."- Tag '".PrintableTagID($tag)."' ($len bytes)$str\n");
$et->VerboseDump(\$val);
}
}
if (defined $tagID and defined $format) {
if ($verbose) {
my $t2 = PrintableTagID($tagID);
$et->VPrint(0, "$$et{INDENT}Added Local ID $pid = $t2 ($format)\n");
}
$$ee{'keys'}{$id} = { TagID => $tagID, Format => $format };
}
$$et{INDENT} = $oldIndent;
}
return 1;
}
#------------------------------------------------------------------------------
# We found some tags for this sample, so set document number and save timing information
# Inputs: 0) ExifTool ref, 1) tag table ref, 2) sample time, 3) sample duration
sub FoundSomething($$$$)
{
my ($et, $tagTbl, $time, $dur) = @_;
$$et{DOC_NUM} = ++$$et{DOC_COUNT};
$et->HandleTag($tagTbl, SampleTime => $time) if defined $time;
$et->HandleTag($tagTbl, SampleDuration => $dur) if defined $dur;
}
#------------------------------------------------------------------------------
# Exract embedded metadata from media samples
# Inputs: 0) ExifTool ref
# Notes: Also accesses ExifTool RAF*, SET_GROUP1, HandlerType, MetaFormat,
# ee*, and avcC elements (* = must exist)
sub ProcessSamples($)
{
my $et = shift;
my ($raf, $ee) = @$et{qw(RAF ee)};
my ($i, $buff, $pos, $hdrLen, $hdrFmt, @time, @dur, $oldIndent);
return unless $ee;
delete $$et{ee}; # use only once
# only process specific types of video streams
my $type = $$et{HandlerType} || '';
if ($type eq 'vide') {
if ($$ee{avcC}) { $type = 'avcC' }
elsif ($$ee{JPEG}) { $type = 'JPEG' }
else { return }
}
my ($start, $size) = @$ee{qw(start size)};
#
# determine sample start offsets from chunk offsets (stco) and sample-to-chunk table (stsc),
# and sample time/duration from time-to-sample (stts)
#
unless ($start and $size) {
return unless $size;
my ($stco, $stsc, $stts) = @$ee{qw(stco stsc stts)};
return unless $stco and $stsc and @$stsc;
$start = [ ];
my ($nextChunk, $iChunk) = (0, 1);
my ($chunkStart, $startChunk, $samplesPerChunk, $descIdx, $timeCount, $timeDelta, $time);
if ($stts and @$stts > 1) {
$time = 0;
$timeCount = shift @$stts;
$timeDelta = shift @$stts;
}
my $ts = $$et{MediaTS} || 1;
foreach $chunkStart (@$stco) {
if ($iChunk >= $nextChunk and @$stsc) {
($startChunk, $samplesPerChunk, $descIdx) = @{shift @$stsc};
$nextChunk = $$stsc[0][0] if @$stsc;
}
@$size < @$start + $samplesPerChunk and $et->WarnOnce('Sample size error'), return;
my $sampleStart = $chunkStart;
for ($i=0; ; ) {
push @$start, $sampleStart;
if (defined $time) {
until ($timeCount) {
if (@$stts < 2) {
undef $time;
last;
}
$timeCount = shift @$stts;
$timeDelta = shift @$stts;
}
push @time, $time / $ts;
push @dur, $timeDelta / $ts;
$time += $timeDelta;
--$timeCount;
}
# (eventually should use the description indices: $descIdx)
last if ++$i >= $samplesPerChunk;
$sampleStart += $$size[$#$start];
}
++$iChunk;
}
@$start == @$size or $et->WarnOnce('Incorrect sample start/size count'), return;
}
#
# extract and parse the sample data
#
my $tagTbl = GetTagTable('Image::ExifTool::QuickTime::Stream');
my $verbose = $et->Options('Verbose');
my $metaFormat = $$et{MetaFormat} || '';
my $tell = $raf->Tell();
if ($verbose) {
$et->VPrint(0, "---- Extract Embedded ----\n");
$oldIndent = $$et{INDENT};
$$et{INDENT} = '';
}
# get required information from avcC box if parsing video data
if ($type eq 'avcC') {
$hdrLen = (Get8u(\$$ee{avcC}, 4) & 0x03) + 1;
$hdrFmt = ($hdrLen == 4 ? 'N' : $hdrLen == 2 ? 'n' : 'C');
require Image::ExifTool::H264;
}
# loop through all samples
for ($i=0; $i<@$start and $i<@$size; ++$i) {
# read the sample data
my $size = $$size[$i];
next unless $raf->Seek($$start[$i], 0) and $raf->Read($buff, $size) == $size;
if ($type eq 'avcC') {
next if length($buff) <= $hdrLen;
# scan through all NAL units and send them to ParseH264Video()
for ($pos=0; ; ) {
my $len = unpack("x$pos$hdrFmt", $buff);
last if $pos + $hdrLen + $len > length($buff);
my $tmp = "\0\0\0\x01" . substr($buff, $pos+$hdrLen, $len);
Image::ExifTool::H264::ParseH264Video($et, \$tmp);
$pos += $hdrLen + $len;
last if $pos + $hdrLen >= length($buff);
}
next;
}
if ($verbose > 1) {
my $hdr = $$et{SET_GROUP1} ? "$$et{SET_GROUP1} Type='${type}' Format='${metaFormat}'" : "Type='${type}'";
$et->VPrint(1, "${hdr}, Sample ".($i+1).' of '.scalar(@$start)." ($size bytes)\n");
$et->VerboseDump(\$buff, Addr => $$start[$i]);
}
if ($type eq 'text') {
FoundSomething($et, $tagTbl, $time[$i], $dur[$i]);
unless ($buff =~ /^\$BEGIN/) {
# remove ending "encd" box if it exists
$buff =~ s/\0\0\0\x0cencd\0\0\x01\0$// and $size -= 12;
# cameras such as the CanonPowerShotN100 store ASCII time codes with a
# leading 2-byte integer giving the length of the string
# (and chapter names start with a 2-byte integer too)
if ($size >= 2 and unpack('n',$buff) == $size - 2) {
next if $size == 2;
$buff = substr($buff,2);
}
my $val;
# check for encrypted GPS text as written by E-PRANCE B47FS camera
if ($buff =~ /^\0/ and $buff =~ /\x0a$/ and length($buff) > 5) {
# decode simple ASCII difference cipher,
# based on known value of 4th-last char = '*'
my $dif = ord('*') - ord(substr($buff, -4, 1));
my $tmp = pack 'C*',map { $_=($_+$dif)&0xff } unpack 'C*',substr $buff,1,-1;
if ($tmp =~ /^(.*?)(\$[A-Z]{2}RMC.*)/s) {
($val, $buff) = ($1, $2);
$val =~ tr/\t/ /;
$et->HandleTag($tagTbl, RawGSensor => $val) if length $val;
}
}
unless (defined $val) {
$et->HandleTag($tagTbl, Text => $buff); # just store any other text
next;
}
}
while ($buff =~ /\$(\w+)([^\$]*)/g) {
my ($tag, $dat) = ($1, $2);
if ($tag =~ /^[A-Z]{2}RMC$/ and $dat =~ /^,(\d{2})(\d{2})(\d+(\.\d*)?),A?,(\d*?)(\d{1,2}\.\d+),([NS]),(\d*?)(\d{1,2}\.\d+),([EW]),(\d*\.?\d*),(\d*\.?\d*),(\d{2})(\d{2})(\d+)/) {
$et->HandleTag($tagTbl, GPSLatitude => (($5 || 0) + $6/60) * ($7 eq 'N' ? 1 : -1));
$et->HandleTag($tagTbl, GPSLongitude => (($8 || 0) + $9/60) * ($10 eq 'E' ? 1 : -1));
if (length $11) {
$et->HandleTag($tagTbl, GPSSpeed => $11 * $knotsToKph);
$et->HandleTag($tagTbl, GPSSpeedRef => 'K');
}
if (length $12) {
$et->HandleTag($tagTbl, GPSTrack => $11);
$et->HandleTag($tagTbl, GPSTrackRef => 'T');
}
my $year = $15 + ($15 >= 70 ? 1900 : 2000);
my $str = sprintf('%.4d:%.2d:%.2d %.2d:%.2d:%.2dZ', $year, $14, $13, $1, $2, $3);
$et->HandleTag($tagTbl, GPSDateTime => $str);
} elsif ($tag eq 'BEGINGSENSOR' and $dat =~ /^:([-+]\d+\.\d+):([-+]\d+\.\d+):([-+]\d+\.\d+)/) {
$et->HandleTag($tagTbl, Accelerometer => "$1 $2 $3");
} elsif ($tag eq 'TIME' and $dat =~ /^:(\d+)/) {
$et->HandleTag($tagTbl, TimeCode => $1 / ($$et{MediaTS} || 1));
} elsif ($tag eq 'BEGIN') {
$et->HandleTag($tagTbl, Text => $dat) if length $dat;
} elsif ($tag ne 'END') {
$et->HandleTag($tagTbl, Text => "\$$tag$dat");
}
}
} elsif ($type eq 'meta' or $type eq 'data') {
if ($$tagTbl{$metaFormat}) {
my $tagInfo = $et->GetTagInfo($tagTbl, $metaFormat, \$buff);
if ($tagInfo) {
FoundSomething($et, $tagTbl, $time[$i], $dur[$i]);
$$et{ee} = $ee; # need ee information for 'keys'
$et->HandleTag($tagTbl, $metaFormat, undef,
DataPt => \$buff,
Base => $$start[$i],
TagInfo => $tagInfo,
);
delete $$et{ee};
}
} elsif ($verbose) {
$et->VPrint(0, "Unknown meta format ($metaFormat)");
}
} elsif ($type eq 'gps ') {
# decode Novatek GPS data (ref 2)
next unless $buff =~ /^....freeGPS /s and length $buff >= 92;
# (see comments in ScanMovieData() below for structure details)
my ($hr,$min,$sec,$yr,$mon,$day,$stat,$latRef,$lonRef,$lat,$lon,$spd,$trk) =
unpack('x48V6a1a1a1x1V4', $buff);
# ignore invalid fixes
next unless $stat eq 'A' and ($latRef eq 'N' or $latRef eq 'S') and
($lonRef eq 'E' or $lonRef eq 'W');
($lat,$lon,$spd,$trk) = unpack 'f*', pack 'L*', $lat, $lon, $spd, $trk;
FoundSomething($et, $tagTbl, $time[$i], $dur[$i]);
# lat/long are in DDDmm.mmmm format
my $deg = int($lat / 100);
$lat = ($deg + ($lat - $deg * 100) / 60) * ($latRef eq 'S' ? -1 : 1);
$deg = int($lon / 100);
$lon = ($deg + ($lon - $deg * 100) / 60) * ($lonRef eq 'W' ? -1 : 1);
$yr += $yr >= 70 ? 1900 : 2000;
my $time = sprintf('%.4d:%.2d:%.2d %.2d:%.2d:%.2dZ',$yr,$mon,$day,$hr,$min,$sec);
$et->HandleTag($tagTbl, GPSDateTime => $time);
$et->HandleTag($tagTbl, GPSLatitude => $lat);
$et->HandleTag($tagTbl, GPSLongitude => $lon);
$et->HandleTag($tagTbl, GPSSpeed => $spd * $knotsToKph);
$et->HandleTag($tagTbl, GPSSpeedRef => 'K');
$et->HandleTag($tagTbl, GPSTrack => $trk); #PH (NC, could be GPSImageDirection)
$et->HandleTag($tagTbl, GPSTrackRef => 'T');
} elsif ($$tagTbl{$type}) {
my $tagInfo = $et->GetTagInfo($tagTbl, $type, \$buff);
if ($tagInfo) {
FoundSomething($et, $tagTbl, $time[$i], $dur[$i]);
$et->HandleTag($tagTbl, $type, undef,
DataPt => \$buff,
Base => $$start[$i],
TagInfo => $tagInfo,
);
}
}
}
if ($verbose) {
$$et{INDENT} = $oldIndent;
$et->VPrint(0, "--------------------------\n");
}
# clean up
$raf->Seek($tell, 0); # restore original file position
$$et{DOC_NUM} = 0;
$$et{HandlerType} = $$et{HanderDesc} = '';
}
#------------------------------------------------------------------------------
# Extract embedded information referenced from a track
# Inputs: 0) ExifTool ref, 1) tag name, 2) data ref
sub ParseTag($$$)
{
local $_;
my ($et, $tag, $dataPt) = @_;
my $dataLen = length $$dataPt;
if ($tag eq 'stsz' or $tag eq 'stz2' and $dataLen > 12) {
# read the sample sizes
my ($sz, $num) = unpack('x4N2', $$dataPt);
my $size = $$et{ee}{size} = [ ];
if ($tag eq 'stsz') {
if ($sz == 0) {
@$size = ReadValue($dataPt, 12, 'int32u', $num, $dataLen-12);
} else {
@$size = ($sz) x $num;
}
} else {
$sz &= 0xff;
if ($sz == 4) {
my @tmp = ReadValue($dataPt, 12, 'int8u', int(($num+1)/2), $dataLen-12);
foreach (@tmp) {
push @$size, $_ >> 4;
push @$size, $_ & 0xff;
}
} elsif ($sz == 8 || $sz == 16) {
@$size = ReadValue($dataPt, 12, "int${sz}u", $num, $dataLen-12);
}
}
} elsif ($tag eq 'stco' or $tag eq 'co64' and $dataLen > 8) {
# read the chunk offsets
my $num = unpack('x4N', $$dataPt);
my $stco = $$et{ee}{stco} = [ ];
@$stco = ReadValue($dataPt, 8, $tag eq 'stco' ? 'int32u' : 'int64u', $num, $dataLen-8);
} elsif ($tag eq 'stsc' and $dataLen > 8) {
# read the sample-to-chunk box
my $num = unpack('x4N', $$dataPt);
if ($dataLen >= 8 + $num * 12) {
my ($i, @stsc);
for ($i=0; $i<$num; ++$i) {
# list of (first-chunk, samples-per-chunk, sample-description-index)
push @stsc, [ unpack('x'.(8+$i*12).'N3', $$dataPt) ];
}
$$et{ee}{stsc} = \@stsc;
}
} elsif ($tag eq 'stts' and $dataLen > 8) {
# read the time-to-sample box
my $num = unpack('x4N', $$dataPt);
if ($dataLen >= 8 + $num * 8) {
$$et{ee}{stts} = [ unpack('x8N'.($num*2), $$dataPt) ];
}
} elsif ($tag eq 'avcC') {
# read the AVC compressor configuration
$$et{ee}{avcC} = $$dataPt if $dataLen >= 7; # (minimum length is 7)
} elsif ($tag eq 'JPEG') {
$$et{ee}{JPEG} = $$dataPt;
} elsif ($tag eq 'gps ' and $dataLen > 8) {
# decode Novatek 'gps ' box (ref 2)
my $num = Get32u($dataPt, 4);
$num = int(($dataLen - 8) / 8) if $num * 8 + 8 > $dataLen;
my $start = $$et{ee}{start} = [ ];
my $size = $$et{ee}{size} = [ ];
my $i;
for ($i=0; $i<$num; ++$i) {
push @$start, Get32u($dataPt, 8 + $i * 8);
push @$size, Get32u($dataPt, 12 + $i * 8);
}
$$et{HandlerType} = $tag; # fake handler type
ProcessSamples($et); # we have all we need to process sample data now
}
}
#------------------------------------------------------------------------------
# Process QuickTime 'mebx' timed metadata
# Inputs: 0) ExifTool ref, 1) dirInfo ref, 2) tag table ref
# Returns: 1 on success
# - uses tag ID keys stored in the ExifTool ee data member by a previous call to SaveMetaKeys
sub ProcessMebx($$$)
{
my ($et, $dirInfo, $tagTbl) = @_;
my $ee = $$et{ee} or return 0;
return 0 unless $$ee{'keys'};
my $dataPt = $$dirInfo{DataPt};
# parse using information from 'keys' table (eg. Apple iPhone7+ hevc 'Core Media Data Handler')
$et->VerboseDir('mebx', undef, length $$dataPt);
my $pos = 0;
while ($pos + 8 < length $$dataPt) {
my $len = Get32u($dataPt, $pos);
last if $len < 8 or $pos + $len > length $$dataPt;
my $id = substr($$dataPt, $pos+4, 4);
my $info = $$ee{'keys'}{$id};
if ($info) {
my $tag = $$info{TagID};
unless ($$tagTbl{$tag}) {
next unless $tag =~ /^[-\w.]+$/;
# create info for tags with reasonable id's
my $name = $tag;
$name =~ s/[-.](.)/\U$1/g;
AddTagToTable($tagTbl, $tag, { Name => ucfirst($name) });
}
my $val = ReadValue($dataPt, $pos+8, $$info{Format}, undef, $len-8);
$et->HandleTag($tagTbl, $tag, $val,
DataPt => $dataPt,
Base => $$dirInfo{Base},
Start => $pos + 8,
Size => $len - 8,
);
} else {
$et->WarnOnce('No key information for mebx ID ' . PrintableTagID($id,1));
}
$pos += $len;
}
return 1;
}
#------------------------------------------------------------------------------
# Scan movie data for "freeGPS" metadata if not found already (ref PH)
# Inputs: 0) ExifTool ref
sub ScanMovieData($)
{
my $et = shift;
return if $$et{DOC_COUNT}; # don't scan if we already found embedded metadata
my $raf = $$et{RAF} or return;
my $dataPos = $$et{VALUE}{MovieDataOffset} or return;
my $dataLen = $$et{VALUE}{MovieDataSize} or return;
$raf->Seek($dataPos, 0) or return;
my @then = (0) x 6;
my ($pos, $recentRecPos, $buf2) = (0, 0, '');
my ($tagTbl, $oldByteOrder, $verbose, $buff);
# loop through 'mdat' movie data looking for GPS information
for (;;) {
last if $pos + $gpsBlockSize > $dataLen;
last unless $raf->Read($buff, $gpsBlockSize);
$buff = $buf2 . $buff if length $buf2;
last if length $buff < $gpsBlockSize;
# look for "freeGPS " block
# (always found on an absolute 0x8000-byte boundary in all of
# my samples, but allow for any alignment when searching)
if ($buff !~ /\0\0\x80\0freeGPS /g) {
$buf2 = substr($buff,-12);
$pos += length($buff)-12;
# in all of my samples the first freeGPS block is within 2 MB of the start
# of the mdat, so limit the scan to the first 20 MB to be fast and safe
next if $tagTbl or $pos < 20e6;
last;
} elsif (not $tagTbl) {
# initialize variables for extracting metadata from this block
$tagTbl = GetTagTable('Image::ExifTool::QuickTime::Stream');
$verbose = $$et{OPTIONS}{Verbose};
$oldByteOrder = GetByteOrder();
SetByteOrder('II');
$et->VPrint(0, "---- Extract Embedded ----\n");
$$et{INDENT} .= '| ';
}
my $gpsPos = pos($buff) - 12;
# make sure we have the full 0x8000-byte freeGPS record
my $more = $gpsBlockSize - (length($buff) - $gpsPos);
if ($more > 0) {
last unless $raf->Read($buf2, $more) == $more;
$buff .= $buf2;
}
if ($verbose) {
$et->VerboseDir('GPS', undef, $gpsBlockSize);
$et->VerboseDump(\$buff, Start => $gpsPos, DataPos => $pos + $dataPos);
}
# Loop through records in the ATC-type GPS block until we find the most recent.
# If we have alread found one, then we only need to check the first record
# (in case the buffer wrapped around), and the record after the position of
# the last record we found, because the others will be old. Odd, but this
# is the way it is done... I have only seen one new 52-byte record in the
# entire 32 kB block, but the entire device ring buffer (containing 30
# entries in my samples) is stored every time. The code below allows for
# the possibility of missing blocks and multiple new records in a single
# block, but I have never seen this. Note that there may be some earlier
# GPS records at the end of the first block that we will miss decoding, but
# these should (I believe) be before the start of the video
my ($recPos, $lastRecPos, $foundNew);
ATCRec: for ($recPos = 0x30; $recPos + 52 < $gpsBlockSize; $recPos += 52) {
# identify one type of GPS record using "ATC" string
unless (substr($buff, $recPos + $gpsPos + 0x15, 3) eq 'ATC') {
my ($yr, $mon, $day, $hr, $min, $sec);
my ($lat, $latRef, $lon, $lonRef, $spd, $trk);
# check for other known GPS record types
# Type 2 (ref PH):
# 0x30 - int32u hour
# 0x34 - int32u minute
# 0x38 - int32u second
# 0x3c - int32u GPS status ('A' or 'V')
# 0x40 - double latitude (DDMM.MMMMMM)
# 0x48 - int32u latitude ref ('N' or 'S')
# 0x50 - double longitude (DDMM.MMMMMM)
# 0x58 - int32u longitude ref ('E' or 'W')
# 0x60 - double speed (knots)
# 0x68 - double heading (deg)
# 0x70 - int32u year - 2000
# 0x74 - int32u month
# 0x78 - int32u day
if ($buff =~ /^.{$gpsPos}.{60}A\0.{10}([NS])\0.{14}([EW])\0/s) {
($latRef, $lonRef) = ($1, $2);
($hr,$min,$sec,$yr,$mon,$day) = unpack('x'.($gpsPos+0x30).'V3x52V3', $buff);
$lat = GetDouble(\$buff, $gpsPos + 0x40);
$lon = GetDouble(\$buff, $gpsPos + 0x50);
$spd = GetDouble(\$buff, $gpsPos + 0x60);
$trk = GetDouble(\$buff, $gpsPos + 0x68);
# Type 3 (Novatek GPS, ref 2): (in case it wasn't decoded via 'gps ' atom)
# 0x30 - int32u hour
# 0x34 - int32u minute
# 0x38 - int32u second
# 0x3c - int32u year - 2000
# 0x40 - int32u month
# 0x44 - int32u day
# 0x48 - int8u GPS status ('A' or 'V')
# 0x49 - int8u latitude ref ('N' or 'S')
# 0x4a - int8u longitude ref ('E' or 'W')
# 0x4b - 0
# 0x4c - float latitude (DDMM.MMMMMM)
# 0x50 - float longitude (DDMM.MMMMMM)
# 0x54 - float speed (knots)
# 0x58 - float heading (deg)
} elsif ($buff =~ /^.{$gpsPos}.{72}A([NS])([EW])/s) {
($latRef, $lonRef) = ($1, $2);
($hr,$min,$sec,$yr,$mon,$day) = unpack('x'.($gpsPos+0x30).'V6', $buff);
$lat = GetFloat(\$buff, $gpsPos + 0x4c);
$lon = GetFloat(\$buff, $gpsPos + 0x50);
$spd = GetFloat(\$buff, $gpsPos + 0x54);
$trk = GetFloat(\$buff, $gpsPos + 0x58);
} else {
last; # not a recognized or valid freeGPS block
}
last if $mon < 1 or $mon > 12; # quick sanity check
$$et{DOC_NUM} = ++$$et{DOC_COUNT};
$yr += 2000 if $yr < 2000;
my $time = sprintf('%.4d:%.2d:%.2d %.2d:%.2d:%.2dZ', $yr, $mon, $day, $hr, $min, $sec);
# convert from DDMM.MMMMMM to DD.DDDDDD format
my $deg = int($lat / 100);
$lat = $deg + ($lat - $deg * 100) / 60;
$deg = int($lon / 100);
$lon = $deg + ($lon - $deg * 100) / 60;
$et->HandleTag($tagTbl, GPSDateTime => $time);
$et->HandleTag($tagTbl, GPSLatitude => $lat * ($latRef eq 'S' ? -1 : 1));
$et->HandleTag($tagTbl, GPSLongitude => $lon * ($lonRef eq 'W' ? -1 : 1));
$et->HandleTag($tagTbl, GPSSpeed => $spd * $knotsToKph);
$et->HandleTag($tagTbl, GPSSpeedRef => 'K');
$et->HandleTag($tagTbl, GPSTrack => $trk);
$et->HandleTag($tagTbl, GPSTrackRef => 'T');
last;
}
my $a = substr($buff, $recPos + $gpsPos, 52); # isolate a single record
# decrypt record
my @a = unpack('C*', $a);
my ($key1, $key2) = @a[0x14, 0x1c];
$a[$_] ^= $key1 foreach 0x00..0x14, 0x18..0x1b;
$a[$_] ^= $key2 foreach 0x1c, 0x20..0x32;
my $b = pack 'C*', @a;
# unpack and validate date/time
my @now = unpack 'x13C3x28vC2', $b; # (H-1,M,S,Y,m,d)
$now[0] = ($now[0] + 1) & 0xff; # increment hour
my $i;
for ($i=0; $i<@dateMax; ++$i) {
next if $now[$i] <= $dateMax[$i];
$et->WarnOnce('Invalid GPS date/time');
next ATCRec; # ignore this record
}
# look for next ATC record in temporal sequence
foreach $i (3..5, 0..2) {
if ($now[$i] < $then[$i]) {
last ATCRec if $foundNew;
last;
}
next if $now[$i] == $then[$i];
# we found a more recent record -- extract it and remember its location
if ($verbose) {
$et->VPrint(2, " Encrypted GPS record:\n");
$et->VerboseDump(\$a, DataPos => $pos + $dataPos + $gpsPos + $recPos);
$et->VPrint(0, " Decrypted GPS record:\n");
$et->VerboseDump(\$b);
my @v = unpack 'H8VVC4V!CA3V!CA3VvvV!vCCCCH4', $b;
$et->VPrint(1, " Unpacked: @v\n");
# values unpacked above (ref PH):
# 0) 0x00 4 bytes - byte 0=1, 1=counts to 255, 2=record index, 3=0 (ref 3)
# 1) 0x04 4 bytes - int32u: bits 0-4=day, 5-8=mon, 9-19=year (ref 3)
# 2) 0x08 4 bytes - int32u: bits 0-5=sec, 6-11=min, 12-16=hour (ref 3)
# 3) 0x0c 1 byte - seen values of 0,1,2 - GPS status maybe?
# 4) 0x0d 1 byte - hour minus 1
# 5) 0x0e 1 byte - minute
# 6) 0x0f 1 byte - second
# 7) 0x10 4 bytes - int32s latitude * 1e7
# 8) 0x14 1 byte - always 0 (used for decryption)
# 9) 0x15 3 bytes - always "ATC"
# 10) 0x18 4 bytes - int32s longitude * 1e7
# 11) 0x1c 1 byte - always 0 (used for decryption)
# 12) 0x1d 3 bytes - always "001"
# 13) 0x20 4 bytes - int32s speed * 100 (m/s)
# 14) 0x24 2 bytes - int16u heading * 100 (-180 to 180 deg)
# 15) 0x26 2 bytes - always zero
# 16) 0x28 4 bytes - int32s altitude * 1000 (ref 3)
# 17) 0x2c 2 bytes - int16u year
# 18) 0x2e 1 byte - month
# 19) 0x2f 1 byte - day
# 20) 0x30 1 byte - unknown
# 21) 0x31 1 byte - always zero
# 22) 0x32 2 bytes - checksum ?
}
@then = @now;
$$et{DOC_NUM} = ++$$et{DOC_COUNT};
my $trk = Get16s(\$b, 0x24) / 100;
$trk += 360 if $trk < 0;
my $time = sprintf('%.4d:%.2d:%.2d %.2d:%.2d:%.2dZ', @now[3..5, 0..2]);
$et->HandleTag($tagTbl, GPSDateTime => $time);
$et->HandleTag($tagTbl, GPSLatitude => Get32s(\$b, 0x10) / 1e7);
$et->HandleTag($tagTbl, GPSLongitude => Get32s(\$b, 0x18) / 1e7);
$et->HandleTag($tagTbl, GPSSpeed => Get32s(\$b, 0x20) / 100 * $mpsToKph);
$et->HandleTag($tagTbl, GPSSpeedRef => 'K');
$et->HandleTag($tagTbl, GPSTrack => $trk);
$et->HandleTag($tagTbl, GPSTrackRef => 'T');
$et->HandleTag($tagTbl, GPSAltitude => Get32s(\$b, 0x28) / 1000);
$lastRecPos = $recPos;
$foundNew = 1;
# don't skip to location of previous recent record in ring buffer
# since we found a more recent record here
undef $recentRecPos;
last;
}
# skip older records
$recPos = $recentRecPos if $recentRecPos and $recPos < $recentRecPos;
}
$recentRecPos = $lastRecPos;
$pos += $gpsPos + $gpsBlockSize;
$buf2 = substr($buff, $gpsPos + $gpsBlockSize);
}
if ($tagTbl) {
$$et{DOC_NUM} = 0;
$et->VPrint(0, "--------------------------\n");
SetByteOrder($oldByteOrder);
$$et{INDENT} = substr $$et{INDENT}, 0, -2;
}
}
1; # end
__END__
=head1 NAME
Image::ExifTool::QuickTime - Extract embedded information from movie data
=head1 SYNOPSIS
These routines are autoloaded by Image::ExifTool::QuickTime.
=head1 DESCRIPTION
This file contains routines used by Image::ExifTool to extract embedded
information like GPS tracks from MOV and MP4 movie data.
=head1 AUTHOR
Copyright 2003-2018, Phil Harvey (phil at owl.phy.queensu.ca)
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=head1 REFERENCES
=over 4
=item Lhttps://developer.apple.com/library/content/documentation/QuickTime/QTFF/QTFFChap3/qtff3.html#//apple_ref/doc/uid/TP40000939-CH205-SW130>
=item L<http://sergei.nz/files/nvtk_mp42gpx.py>
=item L<https://forum.flitsservice.nl/dashcam-info/dod-ls460w-gps-data-uit-mov-bestand-lezen-t87926.html>
=back
=head1 SEE ALSO
L<Image::ExifTool::QuickTime(3pm)|Image::ExifTool::QuickTime>,
L<Image::ExifTool::TagNames/QuickTime Stream Tags>,
L<Image::ExifTool::TagNames/GoPro GPMF Tags>,
L<Image::ExifTool::TagNames/Sony rtmd Tags>,
L<Image::ExifTool(3pm)|Image::ExifTool>
=cut