granicus.if.org Git - imagemagick/blob - www/miff.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: Magick Image File Format</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <meta name="Keywords" content="magick, image, file, format, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  17   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../index.html">\r
  31   <img src="../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../index.html">\r
  40   <img src="../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <p class="navigation-index">[<a href="#header">MIFF Header</a> &bull; <a href="#binary">MIFF Binary Data</a>]</p>
 155
 156 <div class="doc-section">
 157 <p>The Magick Image File Format (MIFF) is ImageMagick's own platform-independent format for storing bitmap images.  It has an advantage over other image formats in that it stores all metadata known to ImageMagick (e.g. image color profiles, comments, author, copyright, etc.), whereas, other formats may only support a small portion of available metadata or none at all.  A MIFF image file consist of two sections.  The first section is a header composed of keys describing the image in text form.  The next section is the binary image data.  We discuss these sections in detail below.</p>
 158 </div>
 159
 160 <h2><a name="header"></a>MIFF Header</h2>
 161 <div class="doc-section">
 162
 163
 164 <p>The MIFF header is composed entirely of ISO-8859-1 characters.  The fields
 165 in the header are key and value combination in the <em>key = value</em> format, with each key and value separated by an equal sign (<kbd>=</kbd>).  Each <em>key = value</em> combination is delimited by at least one control or whitespace character.  Comments may appear in the header section and are always delimited by braces.  The MIFF header always ends with a colon (<kbd>:</kbd>) character, followed by a <em>ctrl-Z</em> character.  It is also common to proceed the colon with a <em>formfeed</em> and a <em>newline</em> character.  The <em>formfeed</em> prevents the listing of binary data when using the <kbd>more</kbd> Unix program, whereas, the <em>ctrl-Z</em> has the same effect with the <kbd>type</kbd> command on the Windows command line.</p>
 166
 167 <p>The following is a partial list of <em> key = value</em> combinations that are typically be found in a MIFF file:</p>
 168
 169 <dl class="doc">
 170 <dt class="doc">background-color = <em class="option">color</em></dt>
 171 <dt class="doc">border-color = <em class="option">color</em></dt>
 172 <dt class="doc">matte-color = <em class="option">color</em></dt>
 173   <dd>these optional keys reflect the image background, border, and matte colors respectively.  A <a href="../www/color.html">color</a> can be a name (e.g. white) or a hex value (e.g. #ccc).</dd>
 174 <dt class="doc">class = DirectClass</dt>
 175 <dt class="doc">class = PseudoClass</dt>
 176   <dd>the type of binary pixel data stored in the MIFF file.  If this key is not present, DirectClass pixel data is assumed.</dd>
 177 <dt class="doc">colors = <em class="option"> value</em></dt>
 178   <dd>the number of colors in a DirectClass image. For a PseudoClass image, this key specifies the number of entires in the colormap.  If this key is not present in the header, and the image is PseudoClass, a linear 256 color grayscale colormap is assumed.  The maximum number of colormap entries is 65536.</dd>
 179 <dt class="doc">colorspace = RGB</dt>
 180 <dt class="doc">colorspace = CMYK</dt>
 181   <dd>the colorspace of the pixel data.  The default is RGB.</dd>
 182 <dt class="doc">columns = value</dt>
 183   <dd>the width of the image in pixels.  This a required key and has no default value.</dd>
 184 <dt class="doc">compression = BZip</dt>
 185 <dt class="doc">compression = Fax</dt>
 186 <dt class="doc">compression = None</dt>
 187 <dt class="doc">compression = RLE</dt>
 188 <dt class="doc">compression = Zip</dt>
 189   <dd>the type of algorithm used to compress the image data.  If this key is not present, the pixel data is assumed to be uncompressed.</dd>
 190 <dt class="doc">delay = <em class="option">microseconds</em></dt>
 191  <dd>the interframe delay in an image sequence in microseconds.</dd>
 192 <dt class="doc">depth = 8</dt>
 193 <dt class="doc">depth = 16</dt>
 194 <dt class="doc">depth = 32</dt>
 195   <dd>the depth of a single color value representing values from 0 to 255 (depth 8), 0 - 65535 (depth 16), or 0 - 4294967295 (depth 32).  If this key is absent, a depth of 8 is assumed.</dd>
 196 <dt class="doc">dispose = <em class="option">value</em></dt>
 197   <dd>layer disposal method.</dd>
 198   <dd>Here are the valid values:
 199
 200         <dl>
 201           <dd>0. No disposal specified.</dd>
 202           <dd>1. Do not dispose between frames.</dd>
 203           <dd>2. Overwrite frame with background color from header.</dd>
 204           <dd>3. Overwrite with previous frame.</dd>
 205         </dl>
 206 </dd>
 207
 208 <dt class="doc">gamma = <em class="option">value</em></dt>
 209   <dd>the gamma of the image.  If it is not specified, a gamma of 1.0 (linear brightness response) is assumed.</dd>
 210
 211 <dt class="doc">id = ImageMagick</dt>
 212   <dd>identifies the file as a MIFF-format image file.  This key is required and has no default.  Although this key can appear anywhere in the header, it should start as the first key of the header in column 1.  This will allow programs like <kbd>file</kbd>(1) to easily identify the file as MIFF.</dd>
 213
 214 <dt class="doc">iterations = <em class="option">value</em></dt>
 215   <dd>the number of times an image sequence loops before stopping.</dd>
 216
 217 <dt class="doc">label = { <em class="option">string </em>]</dt>
 218   <dd>defines a short title or caption for the image.  If any whitespace appears in the label, it must be enclosed within braces.</dd>
 219
 220 <dt class="doc">matte = True</dt>
 221 <dt class="doc">matte = False</dt>
 222   <dd>specifies whether a the image has matte data.  Matte data is generally useful for image compositing.</dd>
 223
 224 <dt class="doc">montage = <em class="option">&lt;width&gt;x&lt;height&gt;[+-]&lt;x offset&gt;[+-]&lt;y offset&gt;</em></dt>
 225   <dd>size and location of the individual tiles of a composite image.</dd>
 226
 227   <dd>Use this key when the image is a composite of a number of different tiles.  A tile consists of an image and optionally a border and a label.  <em>Width</em> is the size in pixels of each individual tile in the horizontal direction and <em>height</em> is the size in the vertical direction.  Each tile must have an equal number of pixels in width and equal in height.  However, the width can differ from the height.  <em>X offset</em> is the offset in number of pixels from the vertical edge of the composite image where the first tile of a row begins and <em>y offset</em> is the offset from the horizontal edge where the first tile of a column begins.</dd>
 228
 229   <dd>If this key is specified, a directory of tile names must follow the image header.  The format of the directory is explained below.</dd>
 230
 231 <dt class="doc">page = <em class="option">value</em></dt>
 232   <dd>preferred size and location of an image canvas.</dd>
 233
 234 <dt class="doc">profile-icc = <em class="option">value</em></dt>
 235   <dd>the number of bytes in the International Color Consortium color profile.  The profile is defined by the ICC profile specification located at <a href="http://www.color.org/icc_specs2.html">http://www.color.org/icc_specs2.html</a>.</dd>
 236
 237 <dt class="doc">red-primary = <em class="option">x,y</em></dt>
 238 <dt class="doc">green-primary = <em class="option">x,y</em></dt>
 239 <dt class="doc">blue-primary = <em class="option">x,y</em></dt>
 240 <dt class="doc">white-point = <em class="option">x,y</em></dt>
 241   <dd>this optional key reflects the chromaticity primaries and white point.</dd>
 242
 243 <dt class="doc">rendering-intent = <em class="option">saturation</em></dt>
 244 <dt class="doc">rendering-intent = <em class="option">perceptual</em></dt>
 245 <dt class="doc">rendering-intent = <em class="option">absolute</em></dt>
 246 <dt class="doc">rendering-intent = <em class="option">relative</em></dt>
 247   <dd>Rendering intent is the CSS-1 property that has been defined by the International Color Consortium (<a href="http://www.color.org">http://www.color.org</a>).</dd>
 248
 249 <dt class="doc">resolution = <em class="option">&lt;x-resolution&gt;x&lt;y-resolution&gt;</em></dt>
 250   <dd>vertical and horizontal resolution of the image.  See units for the specific resolution units (e.g. pixels per inch).</dd>
 251
 252 <dt class="doc">rows = <em class="option">value</em></dt>
 253   <dd>the height of the image in pixels.  This a required key and has no default value.</dd>
 254
 255 <dt class="doc">scene = <em class="option">value</em></dt>
 256   <dd>the sequence number for this MIFF image file.  This optional key is useful when a MIFF image file is one in a sequence of files used in an animation.</dd>
 257
 258 <dt class="doc">signature = <em class="option">value</em></dt>
 259   <dd>this optional key contains a string that uniquely identifies the image pixel contents.  NIST's SHA-256 message digest algorithm is recommended.</dd>
 260
 261 <dt class="doc">units = pixels-per-inch</dt>
 262 <dt class="doc">units = pixels-per-centimeter</dt>
 263   <dd>image resolution units.</dd>
 264 </dl>
 265
 266 <p>Other key value pairs are permitted.  If a value contains whitespace it must be enclosed with braces as illustrated here:</p>
 267
 268 <pre class="text">
 269   id=ImageMagick
 270   class=PseudoClass  colors=256  matte=False
 271   columns=1280  rows=1024  depth=8
 272   compression=RLE
 273   colorspace=RGB
 274   copyright={Copyright (c) 1999-2007 ImageMagick Studio LLC}
 275   &#8942;
 276 </pre>
 277
 278 <p>Note that <em>key = value</em> combinations may be separated by <em>newlines</em> or spaces and may occur in any order within the header.  Comments (within braces) may appear anywhere before the colon.</p>
 279
 280 <p>If you specify the montage key in the header, follow the header with a directory of image tiles.  This directory consists of a name for each tile of the composite image separated by a <em>newline</em> character.  The list is terminated with a NULL character.</p>
 281
 282 <p>If you specify the color-profile key in the header, follow the header (or montage directory if the montage key is in the header) with the binary color profile.</p>
 283
 284 <p>The header is separated from the image data by a <kbd>:</kbd> character immediately followed by a <em>newline</em>.</p>
 285
 286 </div>
 287
 288 <h2><a name="binary"></a>MIFF Binary Data</h2>
 289 <div class="doc-section">
 290
 291 <p>Next comes the binary image data itself.  How the image data is formatted depends upon the class of the image as specified (or not specified) by the value of the class key in the header.</p>
 292
 293 <p>DirectClass images are continuous-tone, images stored as RGB (red, green, blue), RGBA (red, green, blue, alpha), CMYK (cyan, yellow, magenta, black), or CMYKA (cyan, yellow, magenta, black, alpha)  intensity values as defined by the colorspace key. Each intensity value is one byte in length for images of depth 8 (0..255), two bytes for a depth of 16 (0..65535), and images of depth 32 (0..4294967295) require four bytes in most significant byte first order.</p>
 294
 295 <p>PseudoClass images are colormapped RGB images. The colormap is stored as a series of red, green, and blue pixel values, each value being a byte in size. If the image depth is 16, each colormap entry consumes two bytes with the most significant byte being first. The number of colormap entries is defined by the colors key.  The colormap data occurs immediately following the header (or image directory if the montage key is in the header). PseudoClass image data is an array of index values into the color map. If there are 256
 296 or fewer colors in the image, each byte of image data contains an index value. If the image contains more than 256 colors or the image depth is 16, the index value is stored as two contiguous bytes with the most significant byte being first. If matte is true, each colormap index is followed by a 1 or 2-byte alpha value.</p>
 297
 298 <p>The image pixel data in a MIFF file may be uncompressed, runlength encoded, Zip compressed, or BZip compressed. The compression key in the header defines how the image data is compressed. Uncompressed pixels are stored one scanline at a time in row order. Runlength-encoded compression counts runs of identical adjacent pixels and stores the pixels followed by a length byte (the number of identical pixels minus 1). Zip and BZip compression compresses each row of an image and precedes the compressed row with the length of compressed pixel bytes as a word in most significant byte first order.</p>
 299
 300 <p>MIFF files may contain more than one image.  Simply concatenate each individual image (composed of a header and image data) into one file.</p>
 301
 302 </div>
 303 \r
 304 </div>\r
 305 \r
 306 <div id="linkbar">\r
 307  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 308     <span id="linkbar-center">\r
 309       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 310       <a href="../www/mailing-list.html">Mailing Lists</a> &bull;\r
 311     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 312     </span>\r
 313     <span id="linkbar-east">&nbsp;</span>\r
 314   </div>\r
 315   <div class="footer">\r
 316     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 317     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 318   </div>\r
 319   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 320 </body>\r
 321 </html>\r