1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
#------------------------------------------------------------------------------
# File: ZISRAW.pm
#
# Description: Read ZISRAW (CZI) meta information
#
# Revisions: 2020-08-07 - P. Harvey Created
#
# References: 1) https://www.zeiss.com/microscopy/us/products/microscope-software/zen/czi.html
#------------------------------------------------------------------------------
package Image::ExifTool::ZISRAW;
use strict;
use vars qw($VERSION);
use Image::ExifTool qw(:DataAccess :Utils);
$VERSION = '1.00';
%Image::ExifTool::ZISRAW::Main = (
PROCESS_PROC => \&Image::ExifTool::ProcessBinaryData,
GROUPS => { 0 => 'File', 1 => 'File', 2 => 'Image' },
NOTES => q{
As well as the header information listed below, ExifTool also extracts the
top-level XML-based metadata from Zeiss Integrated Software RAW (ZISRAW) CZI
files.
},
0x20 => {
Name => 'ZISRAWVersion',
Format => 'int32u[2]',
PrintConv => '$val =~ tr/ /./; $val',
},
0x30 => {
Name => 'PrimaryFileGUID',
Format => 'undef[16]',
ValueConv => 'unpack("H*",$val)',
},
0x40 => {
Name => 'FileGUID',
Format => 'undef[16]',
ValueConv => 'unpack("H*",$val)',
},
);
#------------------------------------------------------------------------------
# Extract metadata from a ZISRAW (CZI) image
# Inputs: 0) ExifTool object reference, 1) dirInfo reference
# Returns: 1 on success, 0 if this wasn't a valid CZI file
sub ProcessCZI($$)
{
my ($et, $dirInfo) = @_;
my $raf = $$dirInfo{RAF};
my ($buff, $tagTablePtr);
# verify this is a valid CZI file
return 0 unless $raf->Read($buff, 100) == 100;
return 0 unless $buff =~ /^ZISRAWFILE\0{6}/;
$et->SetFileType();
SetByteOrder('II');
my %dirInfo = (
DataPt => \$buff,
DirStart => 0,
DirLen => length($buff),
);
$tagTablePtr = GetTagTable('Image::ExifTool::ZISRAW::Main');
$et->ProcessDirectory(\%dirInfo, $tagTablePtr);
# read the metadata section
my $pos = Get64u(\$buff, 92) or return 1;
$raf->Seek($pos, 0) or $et->Warn('Error seeking to metadata'), return 0;
$raf->Read($buff, 288) == 288 or $et->Warn('Error reading metadata header'), return 0;
$buff =~ /^ZISRAWMETADATA\0\0/ or $et->Warn('Invalid metadata header'), return 0;
my $len = Get32u(\$buff, 32);
$len < 200000000 or $et->Warn('Metadata section too large. Ignoring'), return 0;
$raf->Read($buff, $len) or $et->Warn('Error reading XML metadata'), return 0;
$et->FoundTag('XML', $buff); # extract as a block
$tagTablePtr = GetTagTable('Image::ExifTool::XMP::XML');
$dirInfo{DirLen} = length $buff;
# shorten tag names somewhat by removing 'ImageDocumentMetadata' prefix from all
$$et{XmpIgnoreProps} = [ 'ImageDocument', 'Metadata' ];
$et->ProcessDirectory(\%dirInfo, $tagTablePtr);
return 1;
}
1; # end
__END__
=head1 NAME
Image::ExifTool::ZISRAW - Read ZISRAW (CZI) meta information
=head1 SYNOPSIS
This module is used by Image::ExifTool
=head1 DESCRIPTION
This module contains definitions required by Image::ExifTool to read
metadata from Zeiss Integrated Software RAW (ZISRAW) CZI files.
=head1 AUTHOR
Copyright 2003-2021, Phil Harvey (philharvey66 at gmail.com)
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 L<https://www.zeiss.com/microscopy/us/products/microscope-software/zen/czi.html>
=back
=head1 SEE ALSO
L<Image::ExifTool::TagNames/ZISRAW Tags>,
L<Image::ExifTool(3pm)|Image::ExifTool>
=cut
|
