| blob | e0a491cbcfc6037098549f429b5db4d2f306ba37 |
1 <?php
2 /**
3 * Definitions for XMPReader class.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Media
22 */
24 /**
25 * This class is just a container for a big array
26 * used by XMPReader to determine which XMP items to
27 * extract.
28 */
30 /** Get the items array
31 * @return array XMP item configuration array.
32 */
35 // This is for if someone makes a custom metadata extension.
36 // For example, a medical wiki might want to decode DICOM xmp properties.
39 }
42 }
46 /**
47 * XMPInfo::$items keeps a list of all the items
48 * we are interested to extract, as well as
49 * information about the item like what type
50 * it is.
51 *
52 * Format is an array of namespaces,
53 * each containing an array of tags
54 * each tag is an array of information about the
55 * tag, including:
56 * * map_group - What group (used for precedence during conflicts).
57 * * mode - What type of item (self::MODE_SIMPLE usually, see above for
58 * all values).
59 * * validate - Method to validate input. Could also post-process the
60 * input. A string value is assumed to be a static method of
61 * XMPValidate. Can also take a array( 'className', 'methodName' ).
62 * * choices - Array of potential values (format of 'value' => true ).
63 * Only used with validateClosed.
64 * * rangeLow and rangeHigh - Alternative to choices for numeric ranges.
65 * Again for validateClosed only.
66 * * children - For MODE_STRUCT items, allowed children.
67 * * structPart - Indicates that this element can only appear as a member
68 * of a structure.
69 *
70 * Currently this just has a bunch of EXIF values as this class is only half-done.
71 */
78 ),
83 ),
88 ),
93 ),
98 ),
103 ),
108 ),
113 ),
118 ),
123 ),
128 ),
133 ),
138 ),
143 ),
148 ),
153 ),
158 ),
163 ),
168 ),
173 ),
178 ),
183 ),
184 /* Flash */
193 ),
196 ),
202 ),
208 ),
216 ),
224 ),
230 ),
231 /* End Flash */
236 ),
237 /* end rational things */
243 ),
250 ),
256 ),
262 ),
267 ),
272 ),
273 /* todo: there might be interesting information in
274 * exif:DeviceSettingDescription, but need to find an
275 * example
276 */
280 ),
287 ),
294 ),
300 ),
304 ),
309 ),
315 ),
322 ),
323 /* this value is post-processed out later */
329 ),
333 ),
339 ),
346 ),
351 ),
356 ),
362 ),
368 ),
373 ),
378 ),
382 ),
388 ),
392 ),
396 ),
403 ),
409 ),
412 // Note: in exif, GPSDateStamp does not include
413 // the time, where here it does.
417 ),
423 ),
427 ),
431 ),
436 /* can't use a range, as it skips... */
447 ),
448 ),
456 ),
457 /* Pixel(X|Y)Dimension are rather useless, but for
458 * completeness since we do it with exif.
459 */
464 ),
469 ),
476 ),
483 ),
489 ),
490 // Note, 6 is not valid SensingMethod.
498 ),
505 ),
509 ),
510 // This tag should perhaps be displayed to user better.
515 ),
522 ),
527 ),
531 ),
537 ),
538 ),
543 ),
548 ),
554 ),
555 /* this prop should not be used in XMP. dc:rights is the correct prop */
559 ),
564 ),
568 ),
573 ),
578 ),
582 ),
586 ),
587 /**** Do not extract this property
588 * It interferes with auto exif rotation.
589 * 'Orientation' => array(
590 * 'map_group' => 'exif',
591 * 'mode' => XMPReader::MODE_SIMPLE,
592 * 'validate' => 'validateClosed',
593 * 'choices' => array( '1' => true, '2' => true, '3' => true, '4' => true, 5 => true,
594 * '6' => true, '7' => true, '8' => true ),
595 *),
596 ******/
602 ),
608 ),
613 ),
618 ),
624 ),
629 ),
633 ),
634 /* ignore TransferFunction */
639 ),
644 ),
649 ),
654 ),
660 ),
661 /********
662 * Disable extracting this property (bug 31944)
663 * Several files have a string instead of a Seq
664 * for this property. XMPReader doesn't handle
665 * mismatched types very gracefully (it marks
666 * the entire file as invalid, instead of just
667 * the relavent prop). Since this prop
668 * doesn't communicate all that useful information
669 * just disable this prop for now, until such
670 * XMPReader is more graceful (bug 32172)
671 * 'YCbCrSubSampling' => array(
672 * 'map_group' => 'exif',
673 * 'mode' => XMPReader::MODE_SEQ,
674 * 'validate' => 'validateClosed',
675 * 'choices' => array( '1' => true, '2' => true ),
676 * ),
677 */
678 ),
683 ),
687 ),
692 ),
693 ),
699 ),
704 ),
709 ),
714 ),
719 ),
722 // Note, not mapped with other date properties, as this type of date is
723 // non-specific: "A point or period of time associated with an event in
724 // the lifecycle of the resource"
728 ),
729 /* Do not extract dc:format, as we've got better ways to determine MIME type */
734 ),
740 ),
745 ),
746 // for related images/resources
751 ),
756 ),
757 // Note: source is not mapped with iptc source, since iptc
758 // source describes the source of the image in terms of a person
759 // who provided the image, where this is to describe an image that the
760 // current one is based on.
765 ),
770 ),
775 ),
776 ),
783 ),
788 ),
792 ),
796 ),
802 ),
806 // map_name to be consistent with other date names.
809 ),
813 ),
818 ),
819 ),
825 ),
831 ),
836 ),
837 // this seems similar to dc:rights.
841 ),
845 ),
846 ),
847 // XMP media management.
849 // if we extract the exif UniqueImageID, might
850 // as well do this too.
854 ),
855 // It might also be useful to do xmpMM:LastURL
856 // and xmpMM:DerivedFrom as you can potentially,
857 // get the url of this document/source for this
858 // document. However whats more likely is you'd
859 // get a file:// url for the path of the doc,
860 // which is somewhat of a privacy issue.
861 ),
867 ),
872 ),
877 ),
882 ),
883 ),
884 //Note, this property affects how jpeg metadata is extracted.
889 ),
890 ),
891 /* Note, in iptc schemas, the legacy properties are denoted
892 * as deprecated, since other properties should used instead,
893 * and properties marked as deprecated in the standard are
894 * are marked as general here as they don't have replacements
895 */
901 ),
906 ),
911 ),
914 // marking as deprecated as the xmp prop preferred
918 // note this prop is an XMP, not IPTC date
919 ),
924 ),
929 ),
934 ),
936 /* This corresponds with 2:85
937 * By-line Title, which needs to be
938 * handled weirdly to correspond
939 * with iptc/exif. */
942 ),
946 ),
950 ),
954 ),
956 // Note, this prop is deprecated, but in general
957 // group since it doesn't have a replacement.
961 ),
966 ),
970 ),
971 ),
977 ),
981 ),
982 // Note, this is a six digit code.
983 // See: http://cv.iptc.org/newscodes/scene/
984 // Since these aren't really all that common,
985 // we just show the number.
991 ),
992 /* Note: SubjectCode should be an 8 ascii digits.
993 * it is not really an integer (has leading 0's,
994 * cannot have a +/- sign), but validateInteger
995 * will let it through.
996 */
1002 ),
1007 ),
1009 /* Note this maps to 2:118 in iim
1010 * (Contact) field. However those field
1011 * types are slightly different - 2:118
1012 * is free form text field, where this
1013 * is more structured.
1014 */
1027 ),
1028 ),
1033 ),
1038 ),
1043 ),
1048 ),
1053 ),
1058 ),
1063 ),
1068 ),
1069 /* End contact info struct properties */
1070 ),
1075 ),
1080 ),
1084 ),
1090 ),
1096 ),
1097 // LocationShown and LocationCreated are handled
1098 // specially because they are hierarchical, but we
1099 // also want to merge with the old non-hierarchical.
1110 ),
1111 ),
1122 ),
1123 ),
1128 ),
1133 ),
1139 ),
1145 ),
1150 ),
1155 ),
1157 /* Other props that might be interesting but
1158 * Not currently extracted:
1159 * ArtworkOrObject, (info about objects in picture)
1160 * DigitalSourceType
1161 * RegistryId
1162 */
1163 ),
1165 /* Plus props we might want to consider:
1166 * (Note: some of these have unclear/incomplete definitions
1167 * from the iptc4xmp standard).
1168 * ImageSupplier (kind of like iptc source field)
1169 * ImageSupplierId (id code for image from supplier)
1170 * CopyrightOwner
1171 * ImageCreator
1172 * Licensor
1173 * Various model release fields
1174 * Property release fields.
1175 */
1176 );
1177 }