2 if (defined('MEDIAWIKI')) {
7 * @author Ævar Arnfjörð Bjarmason <avarab@gmail.com>
8 * @copyright Copyright © 2005, Ævar Arnfjörð Bjarmason
9 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * http://www.gnu.org/copyleft/gpl.html
26 * @link http://exif.org/Exif2-2.PDF The Exif 2.2 specification
31 * Exif tag type definition
33 define('MW_EXIF_BYTE', 1); # An 8-bit unsigned integer.
34 define('MW_EXIF_ASCII', 2); # An 8-bit byte containing one 7-bit ASCII code. The final byte is terminated with NULL.
35 define('MW_EXIF_SHORT', 3); # A 16-bit (2-byte) unsigned integer.
36 define('MW_EXIF_LONG', 4); # A 32-bit (4-byte) unsigned integer.
37 define('MW_EXIF_RATIONAL', 5); # Two LONGs. The first LONG is the numerator and the second LONG expresses the denominator
38 define('MW_EXIF_UNDEFINED', 7); # An 8-bit byte that can take any value depending on the field definition
39 define('MW_EXIF_SLONG', 9); # A 32-bit (4-byte) signed integer (2's complement notation),
40 define('MW_EXIF_SRATIONAL', 10); # Two SLONGs. The first SLONG is the numerator and the second SLONG is the denominator.
46 * @subpackage Metadata
54 * Exif tags grouped by category, the tagname itself is the key and the type
55 * is the value, in the case of more than one possible value type they are
56 * seperated by commas.
63 * A one dimentional array of all Exif tags
74 * Page numbers here refer to pages in the EXIF 2.2 standard
76 * @link http://exif.org/Exif2-2.PDF The Exif 2.2 specification
79 # TIFF Rev. 6.0 Attribute Information (p22)
81 # Tags relating to image structure
83 'ImageWidth' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Image width
84 'ImageLength' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Image height
85 'BitsPerSample' => MW_EXIF_SHORT
, # Number of bits per component
86 # "When a primary image is JPEG compressed, this designation is not"
87 # "necessary and is omitted." (p23)
88 'Compression' => MW_EXIF_SHORT
, # Compression scheme #p23
89 'PhotometricInterpretation' => MW_EXIF_SHORT
, # Pixel composition #p23
90 'Orientation' => MW_EXIF_SHORT
, # Orientation of image #p24
91 'SamplesPerPixel' => MW_EXIF_SHORT
, # Number of components
92 'PlanarConfiguration' => MW_EXIF_SHORT
, # Image data arrangement #p24
93 'YCbCrSubSampling' => MW_EXIF_SHORT
, # Subsampling ratio of Y to C #p24
94 'YCbCrPositioning' => MW_EXIF_SHORT
, # Y and C positioning #p24-25
95 'XResolution' => MW_EXIF_RATIONAL
, # Image resolution in width direction
96 'YResolution' => MW_EXIF_RATIONAL
, # Image resolution in height direction
97 'ResolutionUnit' => MW_EXIF_SHORT
, # Unit of X and Y resolution #(p26)
100 # Tags relating to recording offset
102 'StripOffsets' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Image data location
103 'RowsPerStrip' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Number of rows per strip
104 'StripByteCounts' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Bytes per compressed strip
105 'JPEGInterchangeFormat' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Offset to JPEG SOI
106 'JPEGInterchangeFormatLength' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Bytes of JPEG data
109 # Tags relating to image data characteristics
110 'characteristics' => array(
111 'TransferFunction' => MW_EXIF_SHORT
, # Transfer function
112 'WhitePoint' => MW_EXIF_RATIONAL
, # White point chromaticity
113 'PrimaryChromaticities' => MW_EXIF_RATIONAL
, # Chromaticities of primarities
114 'YCbCrCoefficients' => MW_EXIF_RATIONAL
, # Color space transformation matrix coefficients #p27
115 'ReferenceBlackWhite' => MW_EXIF_RATIONAL
# Pair of black and white reference values
120 'DateTime' => MW_EXIF_ASCII
, # File change date and time
121 'ImageDescription' => MW_EXIF_ASCII
, # Image title
122 'Make' => MW_EXIF_ASCII
, # Image input equipment manufacturer
123 'Model' => MW_EXIF_ASCII
, # Image input equipment model
124 'Software' => MW_EXIF_ASCII
, # Software used
125 'Artist' => MW_EXIF_ASCII
, # Person who created the image
126 'Copyright' => MW_EXIF_ASCII
, # Copyright holder
130 # Exif IFD Attribute Information (p30-31)
132 # Tags relating to version
134 # TODO: NOTE: Nonexistence of this field is taken to mean nonconformance
135 # to the EXIF 2.1 AND 2.2 standards
136 'ExifVersion' => MW_EXIF_UNDEFINED
, # Exif version
137 'FlashpixVersion' => MW_EXIF_UNDEFINED
, # Supported Flashpix version #p32
140 # Tags relating to Image Data Characteristics
141 'characteristics' => array(
142 'ColorSpace' => MW_EXIF_SHORT
, # Color space information #p32
145 # Tags relating to image configuration
146 'configuration' => array(
147 'ComponentsConfiguration' => MW_EXIF_UNDEFINED
, # Meaning of each component #p33
148 'CompressedBitsPerPixel' => MW_EXIF_RATIONAL
, # Image compression mode
149 'PixelYDimension' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Valid image width
150 'PixelXDimension' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Valind image height
153 # Tags relating to related user information
155 'MakerNote' => MW_EXIF_UNDEFINED
, # Manufacturer notes
156 'UserComment' => MW_EXIF_UNDEFINED
, # User comments #p34
159 # Tags relating to related file information
161 'RelatedSoundFile' => MW_EXIF_ASCII
, # Related audio file
164 # Tags relating to date and time
165 'dateandtime' => array(
166 'DateTimeOriginal' => MW_EXIF_ASCII
, # Date and time of original data generation #p36
167 'DateTimeDigitized' => MW_EXIF_ASCII
, # Date and time of original data generation
168 'SubSecTime' => MW_EXIF_ASCII
, # DateTime subseconds
169 'SubSecTimeOriginal' => MW_EXIF_ASCII
, # DateTimeOriginal subseconds
170 'SubSecTimeDigitized' => MW_EXIF_ASCII
, # DateTimeDigitized subseconds
173 # Tags relating to picture-taking conditions (p31)
174 'conditions' => array(
175 'ExposureTime' => MW_EXIF_RATIONAL
, # Exposure time
176 'FNumber' => MW_EXIF_RATIONAL
, # F Number
177 'ExposureProgram' => MW_EXIF_SHORT
, # Exposure Program #p38
178 'SpectralSensitivity' => MW_EXIF_ASCII
, # Spectral sensitivity
179 'ISOSpeedRatings' => MW_EXIF_SHORT
, # ISO speed rating
180 'OECF' => MW_EXIF_UNDEFINED
, # Optoelectronic conversion factor
181 'ShutterSpeedValue' => MW_EXIF_SRATIONAL
, # Shutter speed
182 'ApertureValue' => MW_EXIF_RATIONAL
, # Aperture
183 'BrightnessValue' => MW_EXIF_SRATIONAL
, # Brightness
184 'ExposureBiasValue' => MW_EXIF_SRATIONAL
, # Exposure bias
185 'MaxApertureValue' => MW_EXIF_RATIONAL
, # Maximum land aperture
186 'SubjectDistance' => MW_EXIF_RATIONAL
, # Subject distance
187 'MeteringMode' => MW_EXIF_SHORT
, # Metering mode #p40
188 'LightSource' => MW_EXIF_SHORT
, # Light source #p40-41
189 'Flash' => MW_EXIF_SHORT
, # Flash #p41-42
190 'FocalLength' => MW_EXIF_RATIONAL
, # Lens focal length
191 'SubjectArea' => MW_EXIF_SHORT
, # Subject area
192 'FlashEnergy' => MW_EXIF_RATIONAL
, # Flash energy
193 'SpatialFrequencyResponse' => MW_EXIF_UNDEFINED
, # Spatial frequency response
194 'FocalPlaneXResolution' => MW_EXIF_RATIONAL
, # Focal plane X resolution
195 'FocalPlaneYResolution' => MW_EXIF_RATIONAL
, # Focal plane Y resolution
196 'FocalPlaneResolutionUnit' => MW_EXIF_SHORT
, # Focal plane resolution unit
197 'SubjectLocation' => MW_EXIF_SHORT
, # Subject location
198 'ExposureIndex' => MW_EXIF_RATIONAL
, # Exposure index
199 'SensingMethod' => MW_EXIF_SHORT
, # Sensing method #p46
200 'FileSource' => MW_EXIF_UNDEFINED
, # File source #p47
201 'SceneType' => MW_EXIF_UNDEFINED
, # Scene type #p47
202 'CFAPattern' => MW_EXIF_UNDEFINED
, # CFA pattern
203 'CustomRendered' => MW_EXIF_SHORT
, # Custom image processing #p48
204 'ExposureMode' => MW_EXIF_SHORT
, # Exposure mode #p48
205 'WhiteBalance' => MW_EXIF_SHORT
, # White Balance #p49
206 'DigitalZoomRatio' => MW_EXIF_RATIONAL
, # Digital zoom ration
207 'FocalLengthIn35mmFilm' => MW_EXIF_SHORT
, # Focal length in 35 mm film
208 'SceneCaptureType' => MW_EXIF_SHORT
, # Scene capture type #p49
209 'GainControl' => MW_EXIF_RATIONAL
, # Scene control #p49-50
210 'Contrast' => MW_EXIF_SHORT
, # Contrast #p50
211 'Saturation' => MW_EXIF_SHORT
, # Saturation #p50
212 'Sharpness' => MW_EXIF_SHORT
, # Sharpness #p50
213 'DeviceSettingDescription' => MW_EXIF_UNDEFINED
, # Desice settings description
214 'SubjectDistanceRange' => MW_EXIF_SHORT
, # Subject distance range #p51
218 'ImageUniqueID' => MW_EXIF_ASCII
, # Unique image ID
222 # GPS Attribute Information (p52)
224 'GPSVersionID' => MW_EXIF_BYTE
, # GPS tag version
225 'GPSLatitudeRef' => MW_EXIF_ASCII
, # North or South Latitude #p52-53
226 'GPSLatitude' => MW_EXIF_RATIONAL
, # Latitude
227 'GPSLongitudeRef' => MW_EXIF_ASCII
, # East or West Longitude #p53
228 'GPSLongitude' => MW_EXIF_RATIONAL
, # Longitude
229 'GPSAltitudeRef' => MW_EXIF_BYTE
, # Altitude reference
230 'GPSAltitude' => MW_EXIF_RATIONAL
, # Altitude
231 'GPSTimeStamp' => MW_EXIF_RATIONAL
, # GPS time (atomic clock)
232 'GPSSatellites' => MW_EXIF_ASCII
, # Satellites used for measurement
233 'GPSStatus' => MW_EXIF_ASCII
, # Receiver status #p54
234 'GPSMeasureMode' => MW_EXIF_ASCII
, # Measurement mode #p54-55
235 'GPSDOP' => MW_EXIF_RATIONAL
, # Measurement precision
236 'GPSSpeedRef' => MW_EXIF_ASCII
, # Speed unit #p55
237 'GPSSpeed' => MW_EXIF_RATIONAL
, # Speed of GPS receiver
238 'GPSTrackRef' => MW_EXIF_ASCII
, # Reference for direction of movement #p55
239 'GPSTrack' => MW_EXIF_RATIONAL
, # Direction of movement
240 'GPSImgDirectionRef' => MW_EXIF_ASCII
, # Reference for direction of image #p56
241 'GPSImgDirection' => MW_EXIF_RATIONAL
, # Direction of image
242 'GPSMapDatum' => MW_EXIF_ASCII
, # Geodetic survey data used
243 'GPSDestLatitudeRef' => MW_EXIF_ASCII
, # Reference for latitude of destination #p56
244 'GPSDestLatitude' => MW_EXIF_RATIONAL
, # Latitude destination
245 'GPSDestLongitudeRef' => MW_EXIF_ASCII
, # Reference for longitude of destination #p57
246 'GPSDestLongitude' => MW_EXIF_RATIONAL
, # Longitude of destination
247 'GPSDestBearingRef' => MW_EXIF_ASCII
, # Reference for bearing of destination #p57
248 'GPSDestBearing' => MW_EXIF_RATIONAL
, # Bearing of destination
249 'GPSDestDistanceRef' => MW_EXIF_ASCII
, # Reference for distance to destination #p57-58
250 'GPSDestDistance' => MW_EXIF_RATIONAL
, # Distance to destination
251 'GPSProcessingMethod' => MW_EXIF_UNDEFINED
, # Name of GPS processing method
252 'GPSAreaInformation' => MW_EXIF_UNDEFINED
, # Name of GPS area
253 'GPSDateStamp' => MW_EXIF_ASCII
, # GPS date
254 'GPSDifferential' => MW_EXIF_SHORT
, # GPS differential correction
258 $this->makeFlatExifTags();
262 * Generate a flat list of the exif tags
264 function makeFlatExifTags() {
265 $this->extractTags( $this->mExif
);
269 * A recursing extractor function used by makeFlatExifTags()
271 * Note: This used to use an array_walk function, but it made PHP5
272 * segfault, see `cvs diff -u -r 1.4 -r 1.5 Exif.php`
274 function extractTags( $tagset ) {
275 foreach( $tagset as $key => $val ) {
276 if( is_array( $val ) ) {
277 $this->extractTags( $val );
279 $this->mFlatExif
[$key] = $val;
285 * The version of the output format
287 * Before the actual metadata information is saved in the database we
288 * strip some of it since we don't want to save things like thumbnails
289 * which usually accompany Exif data. This value gets saved in the
290 * database along with the actual Exif data, and if the version in the
291 * database doesn't equal the value returned by this function the Exif
292 * data is regenerated.
297 return 1; // We don't need no bloddy constants!
301 * Validates if a tag value is of the type it should be according to the Exif spec
303 * @param mixed $in The input value to check
306 function isByte( $in ) {
307 if ( sprintf('%d', $in) === $in && $in >= 0 && $in <= 255 ) {
308 $this->debug( $in, __FUNCTION__
, true );
311 $this->debug( $in, __FUNCTION__
, false );
316 function isASCII( $in ) {
317 if ( preg_match( "/[^\x0a\x20-\x7e]/", $in ) ) {
318 $this->debug( $in, __FUNCTION__
, 'found a character not in our whitelist' );
322 if ( preg_match( "/^\s*$/", $in ) ) {
323 $this->debug( $in, __FUNCTION__
, 'input consisted solely of whitespace' );
327 if ( strlen($in) > 1024 ) {
328 $this->debug( $in, __FUNCTION__
, 'input was too long' );
335 function isShort( $in ) {
336 if ( sprintf('%d', $in) === $in && $in >= 0 && $in <= 65536 ) {
337 $this->debug( $in, __FUNCTION__
, true );
340 $this->debug( $in, __FUNCTION__
, true );
345 function isLong( $in ) {
346 if ( sprintf('%d', $in) === $in && $in >= 0 && $in <= 4294967296 ) {
347 $this->debug( $in, __FUNCTION__
, true );
350 $this->debug( $in, __FUNCTION__
, false );
355 function isRational( $in ) {
356 if ( preg_match( "/^(\d+)\/(\d+[1-9]|[1-9]\d*)$/", $in, $m ) ) { # Avoid division by zero
357 return $this->isLong( $m[1] ) && $this->isLong( $m[2] );
359 $this->debug( $in, __FUNCTION__
, 'fed a non-fraction value' );
364 function isUndefined( $in ) {
365 $this->debug( $in, __FUNCTION__
);
366 if ( preg_match( "/^\d{4}$/", $in ) ) { // Allow ExifVersion and FlashpixVersion
373 function isSlong( $in ) {
374 if ( $this->isLong( abs( $in ) ) ) {
375 $this->debug( $in, __FUNCTION__
, true );
378 $this->debug( $in, __FUNCTION__
, false );
383 function isSrational( $in ) {
384 if ( preg_match( "/^(\d+)\/(\d+[1-9]|[1-9]\d*)$/", $in, $m ) ) { # Avoid division by zero
385 return $this->isSlong( $m[0] ) && $this->isSlong( $m[1] );
387 $this->debug( $in, __FUNCTION__
, 'fed a non-fraction value' );
394 * Validates if a tag has a legal value according to the Exif spec
396 * @param string $tag The tag to check
397 * @param mixed $val The value of the tag
400 function validate( $tag, $val ) {
401 // Fucks up if not typecast
402 switch( (string)$this->mFlatExif
[$tag] ) {
403 case (string)MW_EXIF_BYTE
:
404 return $this->isByte( $val );
405 case (string)MW_EXIF_ASCII
:
406 return $this->isASCII( $val );
407 case (string)MW_EXIF_SHORT
:
408 return $this->isShort( $val );
409 case (string)MW_EXIF_LONG
:
410 return $this->isLong( $val );
411 case (string)MW_EXIF_RATIONAL
:
412 return $this->isRational( $val );
413 case (string)MW_EXIF_UNDEFINED
:
414 return $this->isUndefined( $val );
415 case (string)MW_EXIF_SLONG
:
416 return $this->isSlong( $val );
417 case (string)MW_EXIF_SRATIONAL
:
418 return $this->isSrational( $val );
419 case (string)MW_EXIF_SHORT
.','.MW_EXIF_LONG
:
420 return $this->isShort( $val ) ||
$this->isLong( $val );
422 wfDebug( ucfirst( __CLASS__
) . '::' . __FUNCTION__
.
423 ": The tag '$tag' in unknown (type: " . gettype( $val ) . "; content: '$val')\n" );
429 * Numbers given by Exif user agents are often magical, that is they
430 * should be replaced by a detailed explanation depending on their
431 * value which most of the time are plain integers. This function
432 * formats Exif values into human readable form.
434 * @param string $tag The tag to be formatted
435 * @param mixed $val The value of the tag
438 function format( $tag, $val ) {
445 return $this->msg( $tag, $val );
450 case 'PhotometricInterpretation':
453 return $this->msg( $tag, $val );
460 case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8:
461 return $this->msg( $tag, $val );
466 case 'PlanarConfiguration':
469 return $this->msg( $tag, $val );
474 // TODO: YCbCrSubSampling
475 // TODO: YCbCrPositioning
476 // TODO: If this field does not exists use 2
477 case 'ResolutionUnit': #p26
480 return $this->msg( $tag, $val );
485 // TODO: YCbCrCoefficients #p27 (see annex E)
486 case 'ExifVersion': case 'FlashpixVersion':
491 case 1: case 'FFFF.H':
492 return $this->msg( $tag, $val );
497 case 'ComponentsConfiguration':
499 case 0: case 1: case 2: case 3: case 4: case 5: case 6:
500 return $this->msg( $tag, $val );
506 case 'DateTimeOriginal':
507 case 'DateTimeDigitized':
508 return $wgLang->timeanddate( wfTimestamp(TS_MW
, $val) );
510 case 'ExposureProgram':
512 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8:
513 return $this->msg( $tag, $val );
520 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 255:
521 return $this->msg( $tag, $val );
528 case 0: case 1: case 2: case 3: case 4: case 9: case 10: case 11:
529 case 12: case 13: case 14: case 15: case 17: case 18: case 19: case 20:
530 case 21: case 22: case 23: case 24: case 255:
531 return $this->msg( $tag, $val );
537 case 'SensingMethod':
539 case 1: case 2: case 3: case 4: case 5: case 7: case 8:
540 return $this->msg( $tag, $val );
548 return $this->msg( $tag, $val );
556 return $this->msg( $tag, $val );
561 case 'CustomRendered':
564 return $this->msg( $tag, $val );
571 case 0: case 1: case 2:
572 return $this->msg( $tag, $val );
580 return $this->msg( $tag, $val );
585 case 'SceneCaptureType':
587 case 0: case 1: case 2: case 3:
588 return $this->msg( $tag, $val );
595 case 0: case 1: case 2: case 3: case 4:
596 return $this->msg( $tag, $val );
603 case 0: case 1: case 2:
604 return $this->msg( $tag, $val );
611 case 0: case 1: case 2:
612 return $this->msg( $tag, $val );
619 case 0: case 1: case 2:
620 return $this->msg( $tag, $val );
625 case 'SubjectDistanceRange':
627 case 0: case 1: case 2: case 3:
628 return $this->msg( $tag, $val );
633 case 'GPSLatitudeRef':
636 return $this->msg( $tag, $val );
641 case 'GPSLongitudeRef':
644 return $this->msg( $tag, $val );
652 return $this->msg( $tag, $val );
657 case 'GPSMeasureMode':
660 return $this->msg( $tag, $val );
667 case 'K': case 'M': case 'N':
668 return $this->msg( $tag, $val );
676 return $this->msg( $tag, $val );
681 case 'GPSImgDirectionRef':
684 return $this->msg( $tag, $val );
689 case 'GPSDestLatitudeRef':
692 return $this->msg( $tag, $val );
697 case 'GPSDestLongitudeRef':
700 return $this->msg( $tag, $val );
705 case 'GPSDestBearingRef':
708 return $this->msg( $tag, $val );
714 return $wgLang->date( substr( $val, 0, 4 ) . substr( $val, 5, 2 ) . substr( $val, 8, 2 ) . '000000' );
716 // This is not in the Exif standard, just a special
717 // case for our purposes which enables wikis to wikify
718 // the make, model and software name to link to their articles.
722 return wfMsg( strtolower( "exif-$tag-value" ), $val );
724 if ( preg_match( '/^(\d+)\/(\d+)$/', $val, $m ) ) {
725 return $m[2] != 0 ?
$m[1]/$m[2] : $val;
732 * Conviniance function for format()
734 * @param string $tag The tag name to pass on
735 * @param string $val The value of the tag
736 * @return string A wfMsg of "exif-$tag-$val" in lower case
738 function msg( $tag, $val ) {
739 return wfMsg( strtolower("exif-$tag-$val") );
743 * Conviniance function for debugging output
746 * @param string $fname
747 * @param mixed $action
749 function debug( $in, $fname, $action = null ) {
750 $type = gettype( $in );
751 $class = ucfirst( __CLASS__
);
752 if ( $type === 'array' )
753 $in = print_r( $in, true );
755 if ( $action === true )
756 wfDebug( "$class::$fname: accepted: '$in' (type: $type)\n");
757 elseif ( $action === false )
758 wfDebug( "$class::$fname: rejected: '$in' (type: $type)\n");
759 elseif ( $action === null )
760 wfDebug( "$class::$fname: input was: '$in' (type: $type)\n");
762 wfDebug( "$class::$fname: $action (type: $type; content: '$in')\n");