jpeg_metadata_tk/documentation/xmp.html


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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

<html>
        <head>
                <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
                <link rel=StyleSheet href="style.css" type="text/css">
                <META NAME="keywords" CONTENT="JPEG Metadata Application Segments APP0 APP1 APP2 APP3 APP12 APP13 APP14 EXIF DCF XMP RDF Photoshop IRB IPTC DCMI JFIF">

                <title>The PHP JPEG Metadata Toolkit - Documentation</title>
        </head>

        <body>
                <div class="headerbar">
                        <H1 align="center" style="padding:15">The PHP JPEG Metadata Toolkit - Documentation</H1>
                </div>

                <a href="index.html">Go to Documentation - Home</a>

                <div class="maintext">

                <h2>XMP / RDF / Dublin Core Function Reference</h2>
                <p>
                        The Extensible Metadata Platform (XMP) information resides in
                        the &quot;App 1&quot; segment of a JPEG image.
                        An XMP segment is XML based and contains
                        Resource Description Framework (RDF) data, which itself can
                        contain the Dublin Core Metadata Initiative (DCMI) information.
                </p>

                <br>
                <br>

                <table border cellpadding=8 cellspacing=0>
                        <tr>
                                <td>Function:</td>
                                <td colspan=2><b>get_XMP_text</b></td>
                        </tr>
                        <tr>
                                <td>Description:</td>
                                <td colspan=2>
                                        Retrieves the Extensible Metadata Platform (XMP) information
                                        from an App1 JPEG segment and returns the raw XML text as a
                                        string. This includes the Resource Description Framework (RDF)
                                        information and may include Dublin Core Metadata Initiative (DCMI)
                                        information. Uses information supplied by the get_jpeg_header_data
                                        function
                                </td>
                        <tr>
                        <tr>
                                <td>Parameters:</td>
                                <td width=1%>jpeg_header_data</td>
                                <td>a JPEG header data array in the same format as from get_jpeg_header_data</td>
                        </tr>
                        <tr>
                                <td rowspan=2>Returns:</td>
                                <td>xmp_data</td>
                                <td>the string of raw XML text</td>
                        </tr>
                        <tr>
                                <td>FALSE</td>
                                <td>if an APP 1 XMP segment could not be found, or if an error occured</td>
                        </tr>
                </table>


                <br>
                <br>
                <br>
                <br>

                <table border cellpadding=8 cellspacing=0>
                        <tr>
                                <td>Function:</td>
                                <td colspan=2><b>put_XMP_text</b></td>
                        </tr>
                        <tr>
                                <td>Description:</td>
                                <td colspan=2>
                                        Adds or modifies the Extensible Metadata Platform (XMP) information
                                        in an App1 JPEG segment. If a XMP segment already exists, it is
                                        replaced, otherwise a new one is inserted, using the supplied data.
                                        Uses information supplied by the get_jpeg_header_data function
                                </td>
                        <tr>
                        <tr>
                                <td rowspan=2>Parameters:</td>
                                <td width=1%>jpeg_header_data</td>
                                <td>a JPEG header data array in the same format as from get_jpeg_header_data</td>
                        </tr>
                        <tr>
                                <td width=1%>newXMP</td>
                                <td>a string containing the XMP text to be stored in the XMP segment. Should be constructed using the write_XMP_array_to_text function</td>
                        </tr>
                        <tr>
                                <td rowspan=2>Returns:</td>
                                <td>jpeg_header_data</td>
                                <td>the JPEG header data array with the XMP segment added.</td>
                        </tr>
                        <tr>
                                <td>FALSE</td>
                                <td>if an error occured</td>
                        </tr>
                </table>


                <br>
                <br>
                <br>
                <br>


                <table border cellpadding=8 cellspacing=0>
                        <tr>
                                <td>Function:</td>
                                <td colspan=2><b>read_XMP_array_from_text</b></td>
                        </tr>
                        <tr>
                                <td>Description:</td>
                                <td colspan=2>
                                        <p>
                                                An alias for read_xml_array_from_text.<br>
                                                Parses a string containing XMP data (XML), and returns the resulting
                                                tree structure array, which contains all the XMP (XML) information.<br>
                                                Note: White space and comments in the XMP data (XML) are ignored<br>
                                                Note: All text information contained in the tree structure<br>
                                                is encoded as Unicode UTF-8. Hence text will appear as
                                                normal ASCII except where there is an extended character.
                                        </p>
                                </td>
                        <tr>
                        <tr>
                                <td rowspan=1>Parameters:</td>
                                <td width=1%>xmptext</td>
                                <td>a string containing the XMP data (XML) to be parsed</td>
                        </tr>
                        <tr>
                                <td rowspan=2>Returns:</td>
                                <td>output</td>
                                <td>the tree structure array containing the XMP (XML) information</td>
                        </tr>
                        <tr>
                                <td>FALSE</td>
                                <td>if an error occured</td>
                        </tr>
                </table>


                <br>
                <br>
                <br>
                <br>


                <table border cellpadding=8 cellspacing=0>
                        <tr>
                                <td>Function:</td>
                                <td colspan=2><b>write_XMP_array_to_text</b></td>
                        </tr>
                        <tr>
                                <td>Description:</td>
                                <td colspan=2>
                                        <p>
                                                Takes a tree structure array containing XMP (in the same format
                                                as returned by read_XMP_array_from_text, and constructs a string
                                                containing the equivalent XMP, including the XMP Packet header
                                                and trailer. Produces XMP text which has correct indents, encoded
                                                using UTF-8.<br>
                                                Note: All text information contained in the tree structure
                                                can be either 7-bit ASCII or encoded as Unicode UTF-8,
                                                since UTF-8 passes 7-bit ASCII text unchanged.
                                        </p>
                                </td>
                        <tr>
                        <tr>
                                <td rowspan=1>Parameters:</td>
                                <td width=1%>xmparray</td>
                                <td>the tree structure array containing the information to be converted to XMP text</td>
                        </tr>
                        <tr>
                                <td rowspan=1>Returns:</td>
                                <td>output_XMP_text</td>
                                <td>the string containing the equivalent XMP text</td>
                        </tr>
                </table>


                <br>
                <br>
                <br>
                <br>


                <table border cellpadding=8 cellspacing=0>
                        <tr>
                                <td>Function:</td>
                                <td colspan=2><b>Interpret_XMP_to_HTML</b></td>
                        </tr>
                        <tr>
                                <td>Description:</td>
                                <td colspan=2>
                                        <p>
                                                Generates html showing the information contained in an Extensible
                                                Metadata Platform (XMP) tree structure array, as retrieved
                                                with read_XMP_array_from_text
                                        </p>
                                </td>
                        <tr>
                        <tr>
                                <td rowspan=1>Parameters:</td>
                                <td width=1%>XMP_array</td>
                                <td>a XMP tree structure array as from read_XMP_array_from_text</td>
                        </tr>
                        <tr>
                                <td rowspan=1>Returns:</td>
                                <td>output</td>
                                <td>the HTML string</td>
                        </tr>
                </table>


                <br>
                <br>
                <br>
                <br>


                </div>

        </body>
</html>