1 <!doctype html>
2 <html lang="en">
3 <head>
4 <meta charset="utf-8"/>
5 <title>Standard Metadata Format Specification</title>
6 </head>
7 <!--
8 Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
9 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
10
11 This code is free software; you can redistribute it and/or modify it
12 under the terms of the GNU General Public License version 2 only, as
13 published by the Free Software Foundation. Oracle designates this
14 particular file as subject to the "Classpath" exception as provided
15 by Oracle in the LICENSE file that accompanied this code.
16
17 This code is distributed in the hope that it will be useful, but WITHOUT
18 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 version 2 for more details (a copy is included in the LICENSE file that
21 accompanied this code).
22
23 You should have received a copy of the GNU General Public License version
24 2 along with this work; if not, write to the Free Software Foundation,
25 Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
26
27 Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
28 or visit www.oracle.com if you need additional information or have any
29 questions.
30 -->
31
32 <body>
33 <main role="main">
34 <div class="contentContainer">
35 <h1>Standard (Plug-in Neutral) Metadata Format Specification</h1>
36
37 <p> The plug-in neutral "javax_imageio_1.0" format consists
38 of a root node named "javax_imageio_1.0" which has child
39 nodes "chroma", "compression", "dimension", "document", "text",
40 "tile", and "transparency". The format is described by the
41 following DTD:
42
43 <pre>
44 <!DOCTYPE "javax_imageio_1.0" [
45
46 <!ELEMENT "javax_imageio_1.0" (Chroma?, Compression?, Data?, Dimension?,
47 Document?, Text?, Transparency?)>
48
49 <!ELEMENT "Chroma" (ColorSpaceType?, NumChannels?, Gamma?,
50 BlackIsZero?, Palette?, BackgroundIndex?, BackgroundColor?)>
51 <!-- Chroma (color) information -->
52
53 <!ELEMENT "ColorSpaceType" EMPTY>
54 <!-- The raw color space of the image -->
55 <!ATTLIST "ColorSpaceType" "name" ("XYZ" | "Lab" | "Luv" |
56 "YCbCr" | "Yxy" | "YCCK" | "PhotoYCC" | "RGB" | "GRAY" | "HSV" |
57 "HLS" | "CMYK" | "CMY" | "2CLR" | "3CLR" | "4CLR" | "5CLR" |
58 "6CLR" | "7CLR" | "8CLR" | "9CLR" | "ACLR" | "BCLR" | "CCLR" |
59 "DCLR" | "ECLR" | "FCLR") #REQUIRED>
60
61 <!ELEMENT "NumChannels" EMPTY>
62 <!-- The number of channels in the raw image, including alpha -->
63 <!ATTLIST "NumChannels" "value" #CDATA #REQUIRED>
64 <!-- Data type: List of Integer -->
65
66 <!ELEMENT "Gamma" EMPTY>
67 <!-- The image gamma -->
68 <!ATTLIST "Gamma" "value" #CDATA #REQUIRED>
69 <!-- Data type: Float -->
70
71 <!ELEMENT "BlackIsZero" EMPTY>
72 <!-- True if smaller values represent darker shades -->
73 <!ATTLIST "BlackIsZero" "value" ("TRUE" | "FALSE") "TRUE">
74
75 <!ELEMENT "Palette" (PaletteEntry)*>
76 <!-- Palette-color information -->
77
78 <!ELEMENT "PaletteEntry" EMPTY>
79 <!-- A palette entry -->
80 <!ATTLIST "PaletteEntry" "index" #CDATA #REQUIRED>
81 <!-- The index of the palette entry -->
82 <!-- Data type: Integer -->
83 <!ATTLIST "PaletteEntry" "red" #CDATA #REQUIRED>
84 <!-- The red value for the palette entry -->
85 <!-- Data type: Integer -->
86 <!ATTLIST "PaletteEntry" "green" #CDATA #REQUIRED>
87 <!-- The green value for the palette entry -->
88 <!-- Data type: Integer -->
89 <!ATTLIST "PaletteEntry" "blue" #CDATA #REQUIRED>
90 <!-- The blue value for the palette entry -->
91 <!-- Data type: Integer -->
92 <!ATTLIST "PaletteEntry" "alpha" #CDATA "255">
93 <!-- The alpha value for the palette entry -->
94 <!-- Data type: Integer -->
95
96 <!ELEMENT "BackgroundIndex" EMPTY>
97 <!-- A palette index to be used as a background -->
98 <!ATTLIST "BackgroundIndex" "value" #CDATA #REQUIRED>
99 <!-- Data type: Integer -->
100
101 <!ELEMENT "BackgroundColor" EMPTY>
102 <!-- An RGB triple to be used as a background -->
103 <!ATTLIST "BackgroundColor" "red" #CDATA #REQUIRED>
104 <!-- The red background value -->
105 <!-- Data type: Integer -->
106 <!ATTLIST "BackgroundColor" "green" #CDATA #REQUIRED>
107 <!-- The green background value -->
108 <!-- Data type: Integer -->
109 <!ATTLIST "BackgroundColor" "blue" #CDATA #REQUIRED>
110 <!-- The blue background value -->
111 <!-- Data type: Integer -->
112
113 <!ELEMENT "Compression" (CompressionTypeName?, Lossless?,
114 NumProgressiveScans?, BitRate?)>
115 <!-- Compression information -->
116
117 <!ELEMENT "CompressionTypeName" EMPTY>
118 <!-- The name of the compression scheme in use -->
119 <!ATTLIST "CompressionTypeName" "value" #CDATA #REQUIRED>
120 <!-- Data type: String -->
121
122 <!ELEMENT "Lossless" EMPTY>
123 <!-- True if the compression scheme is lossless -->
124 <!ATTLIST "Lossless" "value" ("TRUE" | "FALSE") "TRUE">
125
126 <!ELEMENT "NumProgressiveScans" EMPTY>
127 <!-- The number of progressive scans used in the image encoding -->
128 <!ATTLIST "NumProgressiveScans" "value" #CDATA #REQUIRED>
129 <!-- Data type: Integer -->
130
131 <!ELEMENT "BitRate" EMPTY>
132 <!-- The estimated bit rate of the compression scheme -->
133 <!ATTLIST "BitRate" "value" #CDATA #REQUIRED>
134 <!-- Data type: Float -->
135
136 <!ELEMENT "Data" (PlanarConfiguration?, SampleFormat?, BitsPerSample?,
137 SignificantBitsPerSample?, SampleMSB?)>
138 <!-- Information on the image layout -->
139
140 <!ELEMENT "PlanarConfiguration" EMPTY>
141 <!-- The organization of image samples in the stream -->
142 <!ATTLIST "PlanarConfiguration" "value" ("PixelInterleaved" |
143 "PlaneInterleaved" | "LineInterleaved" | "TileInterleaved")
144 #REQUIRED>
145
146 <!ELEMENT "SampleFormat" EMPTY>
147 <!-- The numeric format of image samples -->
148 <!ATTLIST "SampleFormat" "value" ("SignedIntegral" |
149 "UnsignedIntegral" | "Real" | "Index") #REQUIRED>
150
151 <!ELEMENT "BitsPerSample" EMPTY>
152 <!-- The number of bits per sample -->
153 <!ATTLIST "BitsPerSample" "value" #CDATA #REQUIRED>
154 <!-- A list of integers, one per channel -->
155 <!-- Data type: List of Integer -->
156 <!-- Min length: 1 -->
157
158 <!ELEMENT "SignificantBitsPerSample" EMPTY>
159 <!-- The number of significant bits per sample -->
160 <!ATTLIST "SignificantBitsPerSample" "value" #CDATA #REQUIRED>
161 <!-- A list of integers, one per channel -->
162 <!-- Data type: List of Integer -->
163 <!-- Min length: 1 -->
164
165 <!ELEMENT "SampleMSB" EMPTY>
166 <!-- The position of the most significant bit of each sample -->
167 <!ATTLIST "SampleMSB" "value" #CDATA #REQUIRED>
168 <!-- A list of integers, one per channel -->
169 <!-- Data type: List of Integer -->
170 <!-- Min length: 1 -->
171
172 <!ELEMENT "Dimension" (PixelAspectRatio?, ImageOrientation?,
173 HorizontalPixelSize?, VerticalPixelSize?,
174 HorizontalPhysicalPixelSpacing?, VerticalPhysicalPixelSpacing?,
175 HorizontalPosition?, VerticalPosition?, HorizontalPixelOffset?,
176 VerticalPixelOffset?, HorizontalScreenSize?, VerticalScreenSize?)>
177 <!-- Dimension information -->
178
179 <!ELEMENT "PixelAspectRatio" EMPTY>
180 <!-- The width of a pixel divided by its height -->
181 <!ATTLIST "PixelAspectRatio" "value" #CDATA #REQUIRED>
182 <!-- Data type: Float -->
183
184 <!ELEMENT "ImageOrientation" EMPTY>
185 <!-- The desired orientation of the image in terms of flips and
186 counter-clockwise rotations -->
187 <!ATTLIST "ImageOrientation" "value" ("Normal" | "Rotate90" |
188 "Rotate180" | "Rotate270" | "FlipH" | "FlipV" |
189 "FlipHRotate90" | "FlipVRotate90") #REQUIRED>
190
191 <!ELEMENT "HorizontalPixelSize" EMPTY>
192 <!-- The width of a pixel, in millimeters, as it should be rendered
193 on media -->
194 <!ATTLIST "HorizontalPixelSize" "value" #CDATA #REQUIRED>
195 <!-- Data type: Float -->
196
197 <!ELEMENT "VerticalPixelSize" EMPTY>
198 <!-- The height of a pixel, in millimeters, as it should be
199 rendered on media -->
200 <!ATTLIST "VerticalPixelSize" "value" #CDATA #REQUIRED>
201 <!-- Data type: Float -->
202
203 <!ELEMENT "HorizontalPhysicalPixelSpacing" EMPTY>
204 <!-- The horizontal distance in the subject of the image, in
205 millimeters, represented by one pixel at the center of the
206 image -->
207 <!ATTLIST "HorizontalPhysicalPixelSpacing" "value" #CDATA #REQUIRED>
208 <!-- Data type: Float -->
209
210 <!ELEMENT "VerticalPhysicalPixelSpacing" EMPTY>
211 <!-- The vertical distance in the subject of the image, in
212 millimeters, represented by one pixel at the center of the
213 image -->
214 <!ATTLIST "VerticalPhysicalPixelSpacing" "value" #CDATA #REQUIRED>
215 <!-- Data type: Float -->
216
217 <!ELEMENT "HorizontalPosition" EMPTY>
218 <!-- The horizontal position, in millimeters, where the image
219 should be rendered on media -->
220 <!ATTLIST "HorizontalPosition" "value" #CDATA #REQUIRED>
221 <!-- Data type: Float -->
222
223 <!ELEMENT "VerticalPosition" EMPTY>
224 <!-- The vertical position, in millimeters, where the image should
225 be rendered on media -->
226 <!ATTLIST "VerticalPosition" "value" #CDATA #REQUIRED>
227 <!-- Data type: Float -->
228
229 <!ELEMENT "HorizontalPixelOffset" EMPTY>
230 <!-- The horizontal position, in pixels, where the image should be
231 rendered onto a raster display -->
232 <!ATTLIST "HorizontalPixelOffset" "value" #CDATA #REQUIRED>
233 <!-- Data type: Integer -->
234
235 <!ELEMENT "VerticalPixelOffset" EMPTY>
236 <!-- The vertical position, in pixels, where the image should be
237 rendered onto a raster display -->
238 <!ATTLIST "VerticalPixelOffset" "value" #CDATA #REQUIRED>
239 <!-- Data type: Integer -->
240
241 <!ELEMENT "HorizontalScreenSize" EMPTY>
242 <!-- The width, in pixels, of the raster display into which the
243 image should be rendered -->
244 <!ATTLIST "HorizontalScreenSize" "value" #CDATA #REQUIRED>
245 <!-- Data type: Integer -->
246
247 <!ELEMENT "VerticalScreenSize" EMPTY>
248 <!-- The height, in pixels, of the raster display into which the
249 image should be rendered -->
250 <!ATTLIST "VerticalScreenSize" "value" #CDATA #REQUIRED>
251 <!-- Data type: Integer -->
252
253 <!ELEMENT "Document" (FormatVersion?, SubimageInterpretation?,
254 ImageCreationTime?, ImageModificationTime?)>
255 <!-- Document information -->
256
257 <!ELEMENT "FormatVersion" EMPTY>
258 <!-- The version of the format used by the stream -->
259 <!ATTLIST "FormatVersion" "value" #CDATA #REQUIRED>
260 <!-- Data type: String -->
261
262 <!ELEMENT "SubimageInterpretation" EMPTY>
263 <!-- The interpretation of this image in relation to the other
264 images stored in the same stream -->
265 <!ATTLIST "SubimageInterpretation" "value" ("Standalone" |
266 "SinglePage" | "FullResolution" | "ReducedResolution" |
267 "PyramidLayer" | "Preview" | "VolumeSlice" | "ObjectView" |
268 "Panorama" | "AnimationFrame" | "TransparencyMask" |
269 "CompositingLayer" | "SpectralSlice" | "Unknown") #REQUIRED>
270
271 <!ELEMENT "ImageCreationTime" EMPTY>
272 <!-- The time of image creation -->
273 <!ATTLIST "ImageCreationTime" "year" #CDATA #REQUIRED>
274 <!-- The full year (e.g., 1967, not 67) -->
275 <!-- Data type: Integer -->
276 <!ATTLIST "ImageCreationTime" "month" #CDATA #REQUIRED>
277 <!-- The month, with January = 1 -->
278 <!-- Data type: Integer -->
279 <!-- Min value: 1 (inclusive) -->
280 <!-- Max value: 12 (inclusive) -->
281 <!ATTLIST "ImageCreationTime" "day" #CDATA #REQUIRED>
282 <!-- The day of the month -->
283 <!-- Data type: Integer -->
284 <!-- Min value: 1 (inclusive) -->
285 <!-- Max value: 31 (inclusive) -->
286 <!ATTLIST "ImageCreationTime" "hour" #CDATA "0">
287 <!-- The hour from 0 to 23 -->
288 <!-- Data type: Integer -->
289 <!-- Min value: 0 (inclusive) -->
290 <!-- Max value: 23 (inclusive) -->
291 <!ATTLIST "ImageCreationTime" "minute" #CDATA "0">
292 <!-- The minute from 0 to 59 -->
293 <!-- Data type: Integer -->
294 <!-- Min value: 0 (inclusive) -->
295 <!-- Max value: 59 (inclusive) -->
296 <!ATTLIST "ImageCreationTime" "second" #CDATA "0">
297 <!-- The second from 0 to 60 (60 = leap second) -->
298 <!-- Data type: Integer -->
299 <!-- Min value: 0 (inclusive) -->
300 <!-- Max value: 60 (inclusive) -->
301
302 <!ELEMENT "ImageModificationTime" EMPTY>
303 <!-- The time of the last image modification -->
304 <!ATTLIST "ImageModificationTime" "year" #CDATA #REQUIRED>
305 <!-- The full year (e.g., 1967, not 67) -->
306 <!-- Data type: Integer -->
307 <!ATTLIST "ImageModificationTime" "month" #CDATA #REQUIRED>
308 <!-- The month, with January = 1 -->
309 <!-- Data type: Integer -->
310 <!-- Min value: 1 (inclusive) -->
311 <!-- Max value: 12 (inclusive) -->
312 <!ATTLIST "ImageModificationTime" "day" #CDATA #REQUIRED>
313 <!-- The day of the month -->
314 <!-- Data type: Integer -->
315 <!-- Min value: 1 (inclusive) -->
316 <!-- Max value: 31 (inclusive) -->
317 <!ATTLIST "ImageModificationTime" "hour" #CDATA "0">
318 <!-- The hour from 0 to 23 -->
319 <!-- Data type: Integer -->
320 <!-- Min value: 0 (inclusive) -->
321 <!-- Max value: 23 (inclusive) -->
322 <!ATTLIST "ImageModificationTime" "minute" #CDATA "0">
323 <!-- The minute from 0 to 59 -->
324 <!-- Data type: Integer -->
325 <!-- Min value: 0 (inclusive) -->
326 <!-- Max value: 59 (inclusive) -->
327 <!ATTLIST "ImageModificationTime" "second" #CDATA "0">
328 <!-- The second from 0 to 60 (60 = leap second) -->
329 <!-- Data type: Integer -->
330 <!-- Min value: 0 (inclusive) -->
331 <!-- Max value: 60 (inclusive) -->
332
333 <!ELEMENT "Text" (TextEntry)*>
334 <!-- Text information -->
335
336 <!ELEMENT "TextEntry" EMPTY>
337 <!-- A text entry -->
338 <!ATTLIST "TextEntry" "keyword" #CDATA #IMPLIED>
339 <!-- A keyword associated with the text entry -->
340 <!-- Data type: String -->
341 <!ATTLIST "TextEntry" "value" #CDATA #REQUIRED>
342 <!-- the text entry -->
343 <!-- Data type: String -->
344 <!ATTLIST "TextEntry" "language" #CDATA #IMPLIED>
345 <!-- The language of the text -->
346 <!-- Data type: String -->
347 <!ATTLIST "TextEntry" "encoding" #CDATA #IMPLIED>
348 <!-- The encoding of the text -->
349 <!-- Data type: String -->
350 <!ATTLIST "TextEntry" "compression" ("none" | "lzw" | "zip" |
351 "bzip" | "other") "none">
352 <!-- The method used to compress the text -->
353
354 <!ELEMENT "Transparency" (Alpha?, TransparentIndex?,
355 TransparentColor?, TileTransparencies?, TileOpacities?)>
356 <!-- Transparency information -->
357
358 <!ELEMENT "Alpha" EMPTY>
359 <!-- The type of alpha information contained in the image -->
360 <!ATTLIST "Alpha" "value" ("none" | "premultiplied" |
361 "nonpremultiplied") "none">
362
363 <!ELEMENT "TransparentIndex" EMPTY>
364 <!-- A palette index to be treated as transparent -->
365 <!ATTLIST "TransparentIndex" "value" #CDATA #REQUIRED>
366 <!-- Data type: Integer -->
367
368 <!ELEMENT "TransparentColor" EMPTY>
369 <!-- An RGB color to be treated as transparent -->
370 <!ATTLIST "TransparentColor" "value" #CDATA #REQUIRED>
371 <!-- Data type: List of Integer -->
372
373 <!ELEMENT "TileTransparencies" (TransparentTile)*>
374 <!-- A list of completely transparent tiles -->
375
376 <!ELEMENT "TransparentTile" EMPTY>
377 <!-- The index of a completely transparent tile -->
378 <!ATTLIST "TransparentTile" "x" #CDATA #REQUIRED>
379 <!-- The tile's X index -->
380 <!-- Data type: Integer -->
381 <!ATTLIST "TransparentTile" "y" #CDATA #REQUIRED>
382 <!-- The tile's Y index -->
383 <!-- Data type: Integer -->
384
385 <!ELEMENT "TileOpacities" (OpaqueTile)*>
386 <!-- A list of completely opaque tiles -->
387
388 <!ELEMENT "OpaqueTile" EMPTY>
389 <!-- The index of a completely opaque tile -->
390 <!ATTLIST "OpaqueTile" "x" #CDATA #REQUIRED>
391 <!-- The tile's X index -->
392 <!-- Data type: Integer -->
393 <!ATTLIST "OpaqueTile" "y" #CDATA #REQUIRED>
394 <!-- The tile's Y index -->
395 <!-- Data type: Integer -->
396 ]>
397 </pre>
398 </div>
399 </main>
400 </body>
401 </html>