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
68 * A one dimentional array of all Exif tags that we'd want to save in
69 * the database or present on a page.
80 * Page numbers here refer to pages in the EXIF 2.2 standard
82 * @link http://exif.org/Exif2-2.PDF The Exif 2.2 specification
85 # TIFF Rev. 6.0 Attribute Information (p22)
87 # Tags relating to image structure
89 'ImageWidth' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Image width
90 'ImageLength' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Image height
91 'BitsPerSample' => MW_EXIF_SHORT
, # Number of bits per component
92 # "When a primary image is JPEG compressed, this designation is not"
93 # "necessary and is omitted." (p23)
94 'Compression' => MW_EXIF_SHORT
, # Compression scheme #p23
95 'PhotometricInterpretation' => MW_EXIF_SHORT
, # Pixel composition #p23
96 'Orientation' => MW_EXIF_SHORT
, # Orientation of image #p24
97 'SamplesPerPixel' => MW_EXIF_SHORT
, # Number of components
98 'PlanarConfiguration' => MW_EXIF_SHORT
, # Image data arrangement #p24
99 'YCbCrSubSampling' => MW_EXIF_SHORT
, # Subsampling ratio of Y to C #p24
100 'YCbCrPositioning' => MW_EXIF_SHORT
, # Y and C positioning #p24-25
101 'XResolution' => MW_EXIF_RATIONAL
, # Image resolution in width direction
102 'YResolution' => MW_EXIF_RATIONAL
, # Image resolution in height direction
103 'ResolutionUnit' => MW_EXIF_SHORT
, # Unit of X and Y resolution #(p26)
106 # Tags relating to recording offset
108 'StripOffsets' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Image data location
109 'RowsPerStrip' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Number of rows per strip
110 'StripByteCounts' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Bytes per compressed strip
111 'JPEGInterchangeFormat' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Offset to JPEG SOI
112 'JPEGInterchangeFormatLength' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Bytes of JPEG data
115 # Tags relating to image data characteristics
116 'characteristics' => array(
117 'TransferFunction' => MW_EXIF_SHORT
, # Transfer function
118 'WhitePoint' => MW_EXIF_RATIONAL
, # White point chromaticity
119 'PrimaryChromaticities' => MW_EXIF_RATIONAL
, # Chromaticities of primarities
120 'YCbCrCoefficients' => MW_EXIF_RATIONAL
, # Color space transformation matrix coefficients #p27
121 'ReferenceBlackWhite' => MW_EXIF_RATIONAL
# Pair of black and white reference values
126 'DateTime' => MW_EXIF_ASCII
, # File change date and time
127 'ImageDescription' => MW_EXIF_ASCII
, # Image title
128 'Make' => MW_EXIF_ASCII
, # Image input equipment manufacturer
129 'Model' => MW_EXIF_ASCII
, # Image input equipment model
130 'Software' => MW_EXIF_ASCII
, # Software used
131 'Artist' => MW_EXIF_ASCII
, # Person who created the image
132 'Copyright' => MW_EXIF_ASCII
, # Copyright holder
136 # Exif IFD Attribute Information (p30-31)
138 # Tags relating to version
140 # TODO: NOTE: Nonexistence of this field is taken to mean nonconformance
141 # to the EXIF 2.1 AND 2.2 standards
142 'ExifVersion' => MW_EXIF_UNDEFINED
, # Exif version
143 'FlashpixVersion' => MW_EXIF_UNDEFINED
, # Supported Flashpix version #p32
146 # Tags relating to Image Data Characteristics
147 'characteristics' => array(
148 'ColorSpace' => MW_EXIF_SHORT
, # Color space information #p32
151 # Tags relating to image configuration
152 'configuration' => array(
153 'ComponentsConfiguration' => MW_EXIF_UNDEFINED
, # Meaning of each component #p33
154 'CompressedBitsPerPixel' => MW_EXIF_RATIONAL
, # Image compression mode
155 'PixelYDimension' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Valid image width
156 'PixelXDimension' => MW_EXIF_SHORT
.','.MW_EXIF_LONG
, # Valind image height
159 # Tags relating to related user information
161 'MakerNote' => MW_EXIF_UNDEFINED
, # Manufacturer notes
162 'UserComment' => MW_EXIF_UNDEFINED
, # User comments #p34
165 # Tags relating to related file information
167 'RelatedSoundFile' => MW_EXIF_ASCII
, # Related audio file
170 # Tags relating to date and time
171 'dateandtime' => array(
172 'DateTimeOriginal' => MW_EXIF_ASCII
, # Date and time of original data generation #p36
173 'DateTimeDigitized' => MW_EXIF_ASCII
, # Date and time of original data generation
174 'SubSecTime' => MW_EXIF_ASCII
, # DateTime subseconds
175 'SubSecTimeOriginal' => MW_EXIF_ASCII
, # DateTimeOriginal subseconds
176 'SubSecTimeDigitized' => MW_EXIF_ASCII
, # DateTimeDigitized subseconds
179 # Tags relating to picture-taking conditions (p31)
180 'conditions' => array(
181 'ExposureTime' => MW_EXIF_RATIONAL
, # Exposure time
182 'FNumber' => MW_EXIF_RATIONAL
, # F Number
183 'ExposureProgram' => MW_EXIF_SHORT
, # Exposure Program #p38
184 'SpectralSensitivity' => MW_EXIF_ASCII
, # Spectral sensitivity
185 'ISOSpeedRatings' => MW_EXIF_SHORT
, # ISO speed rating
186 'OECF' => MW_EXIF_UNDEFINED
, # Optoelectronic conversion factor
187 'ShutterSpeedValue' => MW_EXIF_SRATIONAL
, # Shutter speed
188 'ApertureValue' => MW_EXIF_RATIONAL
, # Aperture
189 'BrightnessValue' => MW_EXIF_SRATIONAL
, # Brightness
190 'ExposureBiasValue' => MW_EXIF_SRATIONAL
, # Exposure bias
191 'MaxApertureValue' => MW_EXIF_RATIONAL
, # Maximum land aperture
192 'SubjectDistance' => MW_EXIF_RATIONAL
, # Subject distance
193 'MeteringMode' => MW_EXIF_SHORT
, # Metering mode #p40
194 'LightSource' => MW_EXIF_SHORT
, # Light source #p40-41
195 'Flash' => MW_EXIF_SHORT
, # Flash #p41-42
196 'FocalLength' => MW_EXIF_RATIONAL
, # Lens focal length
197 'SubjectArea' => MW_EXIF_SHORT
, # Subject area
198 'FlashEnergy' => MW_EXIF_RATIONAL
, # Flash energy
199 'SpatialFrequencyResponse' => MW_EXIF_UNDEFINED
, # Spatial frequency response
200 'FocalPlaneXResolution' => MW_EXIF_RATIONAL
, # Focal plane X resolution
201 'FocalPlaneYResolution' => MW_EXIF_RATIONAL
, # Focal plane Y resolution
202 'FocalPlaneResolutionUnit' => MW_EXIF_SHORT
, # Focal plane resolution unit
203 'SubjectLocation' => MW_EXIF_SHORT
, # Subject location
204 'ExposureIndex' => MW_EXIF_RATIONAL
, # Exposure index
205 'SensingMethod' => MW_EXIF_SHORT
, # Sensing method #p46
206 'FileSource' => MW_EXIF_UNDEFINED
, # File source #p47
207 'SceneType' => MW_EXIF_UNDEFINED
, # Scene type #p47
208 'CFAPattern' => MW_EXIF_UNDEFINED
, # CFA pattern
209 'CustomRendered' => MW_EXIF_SHORT
, # Custom image processing #p48
210 'ExposureMode' => MW_EXIF_SHORT
, # Exposure mode #p48
211 'WhiteBalance' => MW_EXIF_SHORT
, # White Balance #p49
212 'DigitalZoomRatio' => MW_EXIF_RATIONAL
, # Digital zoom ration
213 'FocalLengthIn35mmFilm' => MW_EXIF_SHORT
, # Focal length in 35 mm film
214 'SceneCaptureType' => MW_EXIF_SHORT
, # Scene capture type #p49
215 'GainControl' => MW_EXIF_RATIONAL
, # Scene control #p49-50
216 'Contrast' => MW_EXIF_SHORT
, # Contrast #p50
217 'Saturation' => MW_EXIF_SHORT
, # Saturation #p50
218 'Sharpness' => MW_EXIF_SHORT
, # Sharpness #p50
219 'DeviceSettingDescription' => MW_EXIF_UNDEFINED
, # Desice settings description
220 'SubjectDistanceRange' => MW_EXIF_SHORT
, # Subject distance range #p51
224 'ImageUniqueID' => MW_EXIF_ASCII
, # Unique image ID
228 # GPS Attribute Information (p52)
230 'GPSVersionID' => MW_EXIF_BYTE
, # GPS tag version
231 'GPSLatitudeRef' => MW_EXIF_ASCII
, # North or South Latitude #p52-53
232 'GPSLatitude' => MW_EXIF_RATIONAL
, # Latitude
233 'GPSLongitudeRef' => MW_EXIF_ASCII
, # East or West Longitude #p53
234 'GPSLongitude' => MW_EXIF_RATIONAL
, # Longitude
235 'GPSAltitudeRef' => MW_EXIF_BYTE
, # Altitude reference
236 'GPSAltitude' => MW_EXIF_RATIONAL
, # Altitude
237 'GPSTimeStamp' => MW_EXIF_RATIONAL
, # GPS time (atomic clock)
238 'GPSSatellites' => MW_EXIF_ASCII
, # Satellites used for measurement
239 'GPSStatus' => MW_EXIF_ASCII
, # Receiver status #p54
240 'GPSMeasureMode' => MW_EXIF_ASCII
, # Measurement mode #p54-55
241 'GPSDOP' => MW_EXIF_RATIONAL
, # Measurement precision
242 'GPSSpeedRef' => MW_EXIF_ASCII
, # Speed unit #p55
243 'GPSSpeed' => MW_EXIF_RATIONAL
, # Speed of GPS receiver
244 'GPSTrackRef' => MW_EXIF_ASCII
, # Reference for direction of movement #p55
245 'GPSTrack' => MW_EXIF_RATIONAL
, # Direction of movement
246 'GPSImgDirectionRef' => MW_EXIF_ASCII
, # Reference for direction of image #p56
247 'GPSImgDirection' => MW_EXIF_RATIONAL
, # Direction of image
248 'GPSMapDatum' => MW_EXIF_ASCII
, # Geodetic survey data used
249 'GPSDestLatitudeRef' => MW_EXIF_ASCII
, # Reference for latitude of destination #p56
250 'GPSDestLatitude' => MW_EXIF_RATIONAL
, # Latitude destination
251 'GPSDestLongitudeRef' => MW_EXIF_ASCII
, # Reference for longitude of destination #p57
252 'GPSDestLongitude' => MW_EXIF_RATIONAL
, # Longitude of destination
253 'GPSDestBearingRef' => MW_EXIF_ASCII
, # Reference for bearing of destination #p57
254 'GPSDestBearing' => MW_EXIF_RATIONAL
, # Bearing of destination
255 'GPSDestDistanceRef' => MW_EXIF_ASCII
, # Reference for distance to destination #p57-58
256 'GPSDestDistance' => MW_EXIF_RATIONAL
, # Distance to destination
257 'GPSProcessingMethod' => MW_EXIF_UNDEFINED
, # Name of GPS processing method
258 'GPSAreaInformation' => MW_EXIF_UNDEFINED
, # Name of GPS area
259 'GPSDateStamp' => MW_EXIF_ASCII
, # GPS date
260 'GPSDifferential' => MW_EXIF_SHORT
, # GPS differential correction
264 $this->makeFlatExifTags();
265 $this->makeValidExifTags();
269 * Get the raw list of exiftags
279 * Generate a flat list of the exif tags
281 function makeFlatExifTags() {
282 $exif = $this->getExif();
283 $this->extractTags( $exif );
287 * A recursing extractor function used by makeFlatExifTags()
289 * Note: This used to use an array_walk function, but it made PHP5
290 * segfault, see `cvs diff -u -r 1.4 -r 1.5 Exif.php`
292 function extractTags( $tagset ) {
293 foreach( $tagset as $key => $val ) {
294 if( is_array( $val ) ) {
295 $this->extractTags( $val );
297 $this->mFlatExif
[$key] = $val;
303 * Produce a list of all Exif tags appropriate for user output
305 * Produce a list of all tags that we want to show in output, in order not to
306 * output binary gibberish such as raw thumbnails we strip all tags
307 * with the datatype of UNDEFINED.
309 * @todo We might actually want to display some of the UNDEFINED
310 * stuff, but we strip it for now.
312 function makeValidExifTags() {
313 foreach( $this->mFlatExif
as $key => $val ) {
314 if( strpos( $val, (string)MW_EXIF_UNDEFINED
) !== false ) {
317 $this->mValidExif
[] = $key;
322 * The version of the output format
324 * Before the actual metadata information is saved in the database we
325 * strip some of it since we don't want to save things like thumbnails
326 * which usually accompany Exif data. This value gets saved in the
327 * database along with the actual Exif data, and if the version in the
328 * database doesn't equal the value returned by this function the Exif
329 * data is regenerated.
334 return 1; // We don't need no bloddy constants!
338 * Validates if a tag value is of the type it should be according to the Exif spec
340 * @param mixed $in The input value to check
343 function isByte( $in ) {
345 if ( is_numeric( $in ) && $in >= 0 && $in <= 255 ) {
346 wfDebug("Exif::$fname: accepted: '$in' (type: " . gettype( $in ) . ")\n");
349 wfDebug("Exif::$fname: rejected: '$in' (type: " . gettype( $in ) . ")\n");
354 function isASCII( $in ) {
355 wfDebug("Exif::isASCII: input was '$in'\n");
356 return true; // TODO: FIXME
359 function isShort( $in ) {
361 if ( is_numeric( $in ) && $in >= 0 && $in <= 65536 ) {
362 wfDebug("Exif::$fname: accepted: '$in' (type: " . gettype( $in ) . ")\n");
365 wfDebug("Exif::$fname: rejected: '$in' (type: " . gettype( $in ) . ")\n");
370 function isLong( $in ) {
372 if ( is_numeric( $in ) && $in >= 0 && $in <= 4294967296 ) {
373 wfDebug("Exif::$fname: accepted: '$in' (type: " . gettype( $in ) . ")\n");
376 wfDebug("Exif::$fname: rejected: '$in' (type: " . gettype( $in ) . ")\n");
381 function isRational( $in ) {
382 $fname = 'isRational';
383 $a = explode( '/', $in, 2 );
384 if ( $this->isLong( $a[0] ) && $this->isLong( $a[1] ) ) {
385 wfDebug("Exif::$fname: accepted: '$in' (type: " . gettype( $in ) . ")\n");
388 wfDebug("Exif::$fname: rejected: '$in' (type: " . gettype( $in ) . ")\n");
393 function isUndefined( $in ) {
394 $fname = 'isUndefined';
395 wfDebug("Exif::$fname: input was '$in'\n");
399 function isSlong( $in ) {
401 if ( $this->isLong( abs( $in ) ) ) {
402 wfDebug("Exif::$fname: accepted: '$in' (type: " . gettype( $in ) . ")\n");
405 wfDebug("Exif::$fname: rejected: '$in' (type: " . gettype( $in ) . ")\n");
410 function isSrational( $in ) {
411 $fname = 'isSrational';
412 $a = explode( '/', $in, 2 );
413 if ( $this->isSlong( $a[0] ) && $this->isSlong( $a[1] ) ) {
414 wfDebug("Exif::$fname: accepted: '$in' (type: " . gettype( $in ) . ")\n");
417 wfDebug("Exif::$fname: rejected: '$in' (type: " . gettype( $in ) . ")\n");
424 * Validates if a tag has a legal value according to the Exif spec, presumes
425 * that the given tag is valid ( has been checked in advance with
426 * $this->mValidExif )
428 * @param string $tag The tag to check
429 * @param mixed $val The value of the tag
432 function validate( $tag, $val ) {
433 // Fucks up if not typecast
434 switch( (string)$this->mFlatExif
[$tag] ) {
435 case (string)MW_EXIF_BYTE
:
436 return $this->isByte( $val );
437 case (string)MW_EXIF_ASCII
:
438 return $this->isASCII( $val );
439 case (string)MW_EXIF_SHORT
:
440 return $this->isShort( $val );
441 case (string)MW_EXIF_LONG
:
442 return $this->isLong( $val );
443 case (string)MW_EXIF_RATIONAL
:
444 return $this->isRational( $val );
445 case (string)MW_EXIF_UNDEFINED
:
446 return $this->isUndefined( $val );
447 case (string)MW_EXIF_SLONG
:
448 return $this->isSlong( $val );
449 case (string)MW_EXIF_SRATIONAL
:
450 return $this->isSrational( $val );
451 case (string)MW_EXIF_SHORT
.','.MW_EXIF_LONG
:
452 return $this->isShort( $val ) ||
$this->isLong( $val );
454 wfDebug( "Exif::validate: The tag \"$tag\" had an invalid value: \"$val\"\n" );
460 * Numbers given by Exif user agents are often magical, that is they
461 * should be replaced by a detailed explanation depending on their
462 * value which most of the time are plain integers. This function
463 * formats Exif values into human readable form.
465 * @param string $tag The tag to be formatted
466 * @param mixed $val The value of the tag
469 function format( $tag, $val ) {
476 return $this->msg( $tag, $val );
480 case 'PhotometricInterpretation':
483 return $this->msg( $tag, $val );
489 case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8:
490 return $this->msg( $tag, $val );
494 case 'PlanarConfiguration':
497 return $this->msg( $tag, $val );
501 // TODO: YCbCrSubSampling
502 // TODO: YCbCrPositioning
503 // TODO: If this field does not exists use 2
504 case 'ResolutionUnit': #p26
507 return $this->msg( $tag, $val );
511 // TODO: YCbCrCoefficients #p27 (see annex E)
512 case 'ExifVersion': case 'FlashpixVersion':
517 case 1: case 'FFFF.H':
518 return $this->msg( $tag, $val );
522 case 'ComponentsConfiguration':
524 case 0: case 1: case 2: case 3: case 4: case 5: case 6:
525 return $this->msg( $tag, $val );
530 case 'DateTimeOriginal':
531 case 'DateTimeDigitized':
532 return $wgLang->timeanddate( wfTimestamp(TS_MW
, $val) );
534 case 'ExposureProgram':
536 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8:
537 return $this->msg( $tag, $val );
543 case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 255:
544 return $this->msg( $tag, $val );
550 case 0: case 1: case 2: case 3: case 4: case 9: case 10: case 11:
551 case 12: case 13: case 14: case 15: case 17: case 18: case 19: case 20:
552 case 21: case 22: case 23: case 24: case 255:
553 return $this->msg( $tag, $val );
558 case 'SensingMethod':
560 case 1: case 2: case 3: case 4: case 5: case 7: case 8:
561 return $this->msg( $tag, $val );
568 return $this->msg( $tag, $val );
575 return $this->msg( $tag, $val );
579 case 'CustomRendered':
582 return $this->msg( $tag, $val );
588 case 0: case 1: case 2:
589 return $this->msg( $tag, $val );
596 return $this->msg( $tag, $val );
600 case 'SceneCaptureType':
602 case 0: case 1: case 2: case 3:
603 return $this->msg( $tag, $val );
609 case 0: case 1: case 2: case 3: case 4:
610 return $this->msg( $tag, $val );
616 case 0: case 1: case 2:
617 return $this->msg( $tag, $val );
623 case 0: case 1: case 2:
624 return $this->msg( $tag, $val );
630 case 0: case 1: case 2:
631 return $this->msg( $tag, $val );
635 case 'SubjectDistanceRange':
637 case 0: case 1: case 2: case 3:
638 return $this->msg( $tag, $val );
642 case 'GPSLatitudeRef':
645 return $this->msg( $tag, $val );
649 case 'GPSLongitudeRef':
652 return $this->msg( $tag, $val );
659 return $this->msg( $tag, $val );
663 case 'GPSMeasureMode':
666 return $this->msg( $tag, $val );
672 case 'K': case 'M': case 'N':
673 return $this->msg( $tag, $val );
680 return $this->msg( $tag, $val );
684 case 'GPSImgDirectionRef':
687 return $this->msg( $tag, $val );
691 case 'GPSDestLatitudeRef':
694 return $this->msg( $tag, $val );
698 case 'GPSDestLongitudeRef':
701 return $this->msg( $tag, $val );
705 case 'GPSDestBearingRef':
708 return $this->msg( $tag, $val );
712 return $wgLang->date( substr( $val, 0, 4 ) . substr( $val, 5, 2 ) . substr( $val, 8, 2 ) . '000000' );
714 // This is not in the Exif standard, just a special
715 // case for our purposes which enables wikis to wikify
716 // the make, model and software name to link to their articles.
720 return wfMsg( strtolower( "exif-$tag-value" ), $val );
727 * Conviniance function for format()
729 * @param string $tag The tag name to pass on
730 * @param string $val The value of the tag
731 * @return string A wfMsg of "exif-$tag-$val" in lower case
733 function msg( $tag, $val ) {
734 return wfMsg( strtolower("exif-$tag-$val") );