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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
  11   <title>ImageMagick: Architecture</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="Application-name" content="ImageMagick"/>
  16   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
  17   <meta name="Application-url" content="http://www.imagemagick.org"/>
  18   <meta name="Generator" content="PHP"/>
  19   <meta name="Keywords" content="architecture, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28   <link rel="icon" href="../images/wand.png"/>
  29   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  31   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  32   <style type="text/css" media="all">\r
  33     @import url("../www/magick.css");\r
  34   </style>\r
  35   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  36   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  37   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  38   <script type="text/javascript">\r
  39     $(document).ready(function() {\r
  40       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  41         'transitionIn'  : 'elastic',\r
  42         'transitionOut' : 'elastic',\r
  43         'overlayShow'   : false,\r
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \r
  50 <body id="www-imagemagick-org">\r
  51 <div class="titlebar">\r
  52 <div style="margin: 17px auto; float: left;">\r
  53   <script type="text/javascript">\r
  54   <!--\r
  55     google_ad_client = "pub-3129977114552745";\r
  56     google_ad_slot = "5439289906";\r
  57     google_ad_width = 728;\r
  58     google_ad_height = 90;\r
  59   //-->\r
  60   </script>\r
  61   <script type="text/javascript"\r
  62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  63   </script>\r
  64 </div>\r
  65 <a href="http://www.imagemagick.org/discourse-server/">\r
  66   <img src="../images/logo.jpg"\r
  67   alt="ImageMagick Logo"\r
  68   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  69 <a href="../index.html">\r
  70   <img src="../images/sprite.jpg"\r
  71   alt="ImageMagick Sprite"\r
  72   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  73 </div>\r
  74 \r
  75 <div class="westbar">\r
  76 \r
  77 <div class="menu">
  78   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Binary Release: iPhone" href="../www/binary-releases.html#iPhone">iPhone</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
  95 </div>
  96 <div class="sep"></div>\r
  97 <div class="menu">
  98   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 108 </div>
 109 <div class="menu">
 110   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
 117 </div>
 118 <div class="sub">
 119     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
 133  </div>
 134 <div class="menu">
 135   <a title="Resources" href="../www/resources.html">Resources</a>
 136 </div>
 137 <div class="menu">
 138   <a title="Architecture" href="../www/architecture.html">Architecture</a>
 139 </div>
 140 <div class="menu">
 141   <a title="Download" href="../www/download.html">Download</a>
 142 </div>
 143 <div class="sep"></div>\r
 144 <div class="menu">
 145   <a title="Search" href="../www/search.html">Search</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div class="menu">
 149   <a title="Site Map" href="../www/sitemap.html">Site Map</a>
 150 </div>
 151 <div  class="sub">
 152   <a title="Site Map: Links" href="../www/links.html">Links</a>
 153 </div>
 154 <div class="sep"></div>\r
 155 <div  class="menu">
 156   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 157
 158 <a href="http://www.networkredux.com">
 159   <img src="../images/networkredux.png" alt="[sponsor]"
 160   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 161 <div class="sponsbox">
 162 <div  class="sponsor">
 163   <a title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201109010090 alexanian media -->
 164 </div>
 165 <div  class="sponsor">
 166   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 167 </div>
 168 <div  class="sponsor">
 169   <a title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 170 </div>
 171 <div  class="sponsor">
 172   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 173 </div>
 174 <div  class="sponsor">
 175   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 176 </div>
 177 <div  class="sponsor">
 178   <a title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 179 </div>
 180 <div  class="sponsor">
 181   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 182 </div>
 183 <div  class="sponsor">
 184   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 185 </div>
 186 <div  class="sponsor">
 187    <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 188 </div>
 189 </div>
 190 </div>
 191 </div>\r
 192 \r
 193 <div class="eastbar">\r
 194 \r
 195 </div>\r
 196 \r
 197 <div class="main">\r
 198 \r
 199 \r
 200 \r
 201 <h1>The <em>Magick</em> Behind ImageMagick</h1>
 202 <p class="navigation-index">[<a href="#overview">Architecture Overview</a> &bull; <a href="#cache">The Pixel Cache</a> &bull; <a href="#stream">Streaming Pixels</a> &bull; <a href="#properties">Image Properties and Profiles</a> &bull; <a href="#tera-pixel">Large Image Support</a> &bull; <a href="#threads">Threads of Execution</a> &bull; <a href="#distributed">Heterogeneous Distributed Processing</a> &bull; <a href="#coders">Custom Image Coders</a> &bull; <a href="#filters">Custom Image Filters</a>]</p>
 203
 204
 205 <div class="doc-section">
 206 <p>The citizens of Oz were quite content with their benefactor, the all-powerful Wizard.  They accepted his wisdom and benevolence without ever questioning the who, why, and where of his power.  Like the citizens of Oz, if you feel comfortable that ImageMagick can help you convert, edit, or compose your images without knowing what goes on behind the curtain, feel free to skip this section.  However, if you want to know more about the software and algorithms behind ImageMagick, read on.  To fully benefit from this discussion, you should be comfortable with image nomenclature and be familiar with computer programming.</p>
 207 </div>
 208
 209 <h2><a id="overview"></a>Architecture Overview</h2>
 210 <div class="doc-section">
 211
 212 <p>An image typically consists of a rectangular region of pixels and metadata.  To convert, edit, or compose an image in an efficient manner we need convenient access to any pixel anywhere within the region (and sometimes outside the region).  And in the case of an image sequence, we need access to any pixel of any region of any image in the sequence.  However, there are hundreds of image formats such JPEG, TIFF, PNG, GIF, etc., that makes it difficult to access pixels on demand.  Within these formats we find differences in:</p>
 213
 214 <ul>
 215   <li>colorspace (e.g RGB, CMYK, YUV, Lab, etc.)</li>
 216   <li>bit depth (.e.g 1, 4, 8, 12, 16, etc.)</li>
 217   <li>storage format (e.g. unsigned, signed, float, double, etc.)</li>
 218   <li>compression (e.g. uncompressed, RLE, Zip, BZip, etc.)</li>
 219   <li>orientation (i.e. top-to-bottom, right-to-left, etc.),</li>
 220   <li>layout (.e.g. raw, interspersed with opcodes, etc.)</li>
 221 </ul>
 222
 223 <p>In addition, some image pixels may require attenuation, some formats permit more than one frame, and some formats contain vector graphics that must first be rasterized (converted from vector to pixels).</p>
 224
 225 <p>An efficient implementation of an image processing algorithm may require we get or set:</p>
 226
 227 <ul>
 228   <li>one pixel a time (e.g. pixel at location 10,3)</li>
 229   <li>a single scanline (e.g. all pixels from row 4)</li>
 230   <li>a few scanlines at once (e.g. pixel rows 4-7)</li>
 231   <li>a single column or columns of pixels (e.g. all pixels from column 11)</li>
 232   <li>an arbitrary region of pixels from the image (e.g. pixels defined at 10,7 to 10,19)</li>
 233   <li>a pixel in random order (e.g. pixel at 14,15 and 640,480)</li>
 234   <li>pixels from two different images (e.g. pixel at 5,1 from image 1 and pixel at 5,1 from image 2)</li>
 235   <li>pixels outside the boundaries of the image (e.g. pixel at -1,-3)</li>
 236   <li>a pixel component that is unsigned or in a floating-point representation (e.g. 0.17836)</li>
 237   <li>a high-dynamic range pixel that can include negative values as well as values that exceed the quantum depth (e.g. -0.00716)</li>
 238   <li>one or more pixels simultaneously in different threads of execution</li>
 239   <li>all the pixels in memory to take advantage of speed-ups offered by executing in concert across heterogeneous platforms consisting of CPUs, GPUs, and other processors</li>
 240 </ul>
 241
 242 <p>In addition, some images include a clip mask that define which pixels are eligible to be updated.  Pixels outside the area defined by the clip mask remain untouched.</p>
 243
 244 <p>Given the varied image formats and image processing requirements, we implemented the ImageMagick <a href="#cache">pixel cache</a> to provide convenient sequential or parallel access to any pixel on demand anywhere inside the image region (we call these <a href="#authentic-pixels">authentic pixels</a>)  and from any image in a sequence.  In addition, the pixel cache permits access to pixels outside the boundaries defined by the image (we call these <a href="#virtual-pixels">virtual pixels</a>).</p>
 245
 246 <p>In addition to pixels, images have a plethora of <a href="#properties">image properties and profiles</a>.  Properties include the well known attributes such as width, height, depth, and colorspace.  An image may have optional properties which might include the image author, a comment, a create date, and others.  Some images also include profiles for color management, or EXIF, IPTC, 8BIM, or XMP informational profiles.  ImageMagick provides command line options and programming methods to get, set, or view image properties or profiles or apply profiles.</p>
 247
 248 <p>ImageMagick consists of more than 400,000 lines of C code and optionally depends on several million lines of code in dependent libraries (e.g. JPEG, PNG, TIFF libraries).  Given that, one might expect a huge architecture document.  However, a great majority of image processing is simply accessing pixels and its metadata and our simple and elegant implementation makes this easy for the ImageMagick developer.  We discuss the implementation of the pixel cache and getting and setting image properties and profiles in the next few sections. Next, we discuss using ImageMagick within a <a href="#threads">thread</a> of execution.  In the final sections, we discuss <a href="#coders">image coders</a> to read or write a particular image format followed by a few words on creating a <a href="#filters">filter</a> to access or update pixels based on your custom requirements.</p>
 249
 250 </div>
 251
 252 <h2><a id="cache"></a>The Pixel Cache</h2>
 253 <div class="doc-section">
 254
 255 <p>The ImageMagick pixel cache is a repository for image pixels with up to 5 channels.  The first 4 channels are stored contiguously and an optional second area follows with 1 channel.  The channels are at the depth specified when ImageMagick was built.  The channel depths are 8 bits-per-pixel component for the Q8 version of ImageMagick, 16 bits-per-pixel component for the Q16 version, and 32 bits-per-pixel component for the Q32 version.  By default pixel components are unsigned quantities, however, if you use the <a href="../www/high-dynamic-range.html">high dynamic-range</a> version of ImageMagick, the components are 32-bit floating point. The primary 4 channels can hold any value but typically contain red, green, blue, and alpha intensities or cyan, magenta, yellow, and alpha intensities.  The optional fifth channel contains the colormap indexes for colormapped images or the black channel for CMYK images.  The pixel cache storage may be heap memory, anonymous memory mapped memory, disk-backed memory mapped, or on disk.  The pixel cache is reference-counted.  Only the cache properties are copied when the cache is cloned.  The cache pixels are subsequently copied only when you signal your intention to update any of the pixels.</p>
 256
 257 <h3>Create the Pixel Cache</h3>
 258 <div class="doc-section">
 259
 260 <p>The pixel cache is associated with an image when it is created and it is initialized when you try to get or put pixels.  Here are three common methods to associate a pixel cache with an image:</p>
 261
 262 <dl>
 263 <dt>Create an image canvas initialized to the background color:</dt>
 264 <dd><p class="code">
 265   image=AllocateImage(image_info);
 266   if (SetImageExtent(image,640,480) == MagickFalse)
 267     { /* an exception was thrown */ }
 268   (void) QueryMagickColor("red",&amp;image-&gt;background_color,&amp;image-&gt;exception);
 269   SetImageBackgroundColor(image);
 270 </p></dd>
 271
 272 <dt>Create an image from a JPEG image on disk:</dt>
 273 <dd><p class="code">
 274   (void) strcpy(image_info-&gt;filename,"image.jpg"):
 275   image=ReadImage(image_info,exception);
 276   if (image == (Image *) NULL)
 277     { /* an exception was thrown */ }
 278 </p></dd>
 279 <dt>Create an image from a memory based image:</dt>
 280 <dd><p class="code">
 281   image=BlobToImage(blob_info,blob,extent,exception);
 282   if (image == (Image *) NULL)
 283     { /* an exception was thrown */ }
 284 </p></dd>
 285 </dl>
 286
 287 <p>In our discussion of the pixel cache, we use the <a href="../www/magick-core.html">MagickCore API</a> to illustrate our points, however, the principles are the same for other program interfaces to ImageMagick.</p>
 288
 289 <p>When the pixel cache is initialized, pixels are scaled from whatever bit depth they originated from to that required by the pixel cache.  For example, a 1-channel 1-bit monochrome PBM image is scaled to a 4 channel 8-bit RGBA image, if you are using the Q8 version of ImageMagick, and 16-bit RGBA for the Q16 version.  You can determine which version you have with the <a href="../www/command-line-options.html#version">&#x2011;version</a> option: </p>
 290
 291 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -version</span><span class='crtout'>Version: ImageMagick 6.6.9-8 2011-04-06 Q16 http://www.imagemagick.org</span></p>
 292 <p>As you can see, the convenience of the pixel cache sometimes comes with a trade-off in storage (e.g. storing a 1-bit monochrome image as 16-bit RGBA is wasteful) and speed (i.e. storing the entire image in memory is generally slower than accessing one scanline of pixels at a time).  In most cases, the benefits of the pixel cache typically outweigh any disadvantages.</p>
 293 </div>
 294
 295 <h3><a id="authentic-pixels"></a>Access the Pixel Cache</h3>
 296 <div class="doc-section">
 297
 298 <p>Once the pixel cache is associated with an image, you typically want to get, update, or put pixels into it.  We refer to pixels inside the image region as <em>authentic pixels</em> and outside the region as <em>virtual pixels</em>.  Use these methods to access the pixels in the cache:</p>
 299 <ul>
 300   <li><a href="../www/api/cache.html#GetVirtualPixels">GetVirtualPixels()</a> gets pixels that you do not intend to modify or pixels that lie outside the image region (e.g. pixel @ -1,-3)</li>
 301   <li><a href="../www/api/cache.html#GetAuthenticPixels">GetAuthenticPixels()</a> gets pixels that you intend to modify</li>
 302   <li><a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a> queue pixels that you intend to modify</li>
 303   <li><a href="../www/api/cache.html#SyncAuthenticPixels">SyncAuthenticPixels()</a> update the pixel cache with any modified pixels</li>
 304 </ul>
 305
 306 <p>Here is a typical <a href="../www/magick-core.html">MagickCore</a> code snippet for manipulating pixels in the pixel cache.  In our example, we copy pixels from the input image to the output image and decrease the intensity by 10%:</p>
 307
 308 <div class="viewport">
 309   const PixelPacket
 310     *p;
 311
 312   PixelPacket
 313     *q;
 314
 315   ssize_t
 316     x,
 317     y;
 318
 319   destination=CloneImage(source,source->columns,source->rows,MagickTrue,
 320     exception);
 321   if (destination  == (Image *) NULL)
 322     { /* an exception was thrown */ }
 323   for (y=0; y &lt; (ssize_t) source-&gt;rows; y++)
 324   {
 325     p=GetVirtualPixels(source,0,y,source-&gt;columns,1,exception);
 326     q=GetAuthenticPixels(destination,0,y,destination-&gt;columns,1,exception);
 327     if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL)
 328       break;
 329     for (x=0; x &lt; (ssize_t) source-&gt;columns; x++)
 330     {
 331       q-&gt;red=90*p-&gt;red/100;
 332       q-&gt;green=90*p-&gt;green/100;
 333       q-&gt;blue=90*p-&gt;blue/100;
 334       q-&gt;opacity=90*p-&gt;opacity/100;
 335       p++;
 336       q++;
 337     }
 338     if (SyncAuthenticPixels(destination,exception) == MagickFalse)
 339       break;
 340   }
 341   if (y &lt; (ssize_t) source-&gt;rows)
 342     { /* an exception was thrown */ }
 343 </div>
 344
 345 <p>When we first create the destination image by cloning the source image, the pixel cache pixels are not copied.  They are only copied when you signal your intentions to modify the pixel cache by calling <a href="../www/api/cache.html#GetAuthenticPixels">GetAuthenticPixels()</a> or <a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a>. Use <a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a> if you want to set new pixel values rather than update existing ones.  You could use GetAuthenticPixels() to set pixel values but it is slightly more efficient to use QueueAuthenticPixels() instead. Finally, use <a href="../www/api/cache.html#SyncAuthenticPixels">SyncAuthenticPixels()</a> to ensure any updated pixels are pushed to the pixel cache.</p>
 346
 347 <p>Recall how we mentioned that the indexes of a colormapped image or the black channel of a CMYK image are stored separately.  Use  <a href="../www/api/cache.html#GetVirtualIndexes">GetVirtualIndexes()</a> (to read the indexes) or <a href="../www/api/cache.html#GetAuthenticIndexes">GetAuthenticIndexes()</a> (to update the indexes) to gain access to this channel.  For example, to print the colormap indexes, use:</p>
 348
 349 <pre class="code">
 350   const IndexPacket
 351     *indexes;
 352
 353   for (y=0; y &lt; (ssize_t) source-&gt;rows; y++)
 354   {
 355     p=GetVirtualPixels(source,0,y,source-&gt;columns,1);
 356     if (p == (const PixelPacket *) NULL)
 357       break;
 358     indexes=GetVirtualIndexes(source);
 359     for (x=0; x &lt; (ssize_t) source-&gt;columns; x++)
 360       (void) printf("%d\n",GetIndexPixelComponent(indexes+x));
 361   }
 362   if (y &lt; (ssize_t) source-&gt;rows)
 363     /* an exception was thrown */
 364 </pre>
 365
 366 <p>The pixel cache manager decides whether to give you direct or indirect access to the image pixels.  In some cases the pixels are staged to an intermediate buffer-- and that is why you must call SyncAuthenticPixels() to ensure this buffer is <em>pushed</em> out to the pixel cache to guarantee the corresponding pixels in the cache are updated.  For this reason we recommend that you only read or update a scanline or a few scanlines of pixels at a time.  However, you can get any rectangular region of pixels you want.  GetAuthenticPixels() requires that the region you request is within the bounds of the image area.  For a 640 by 480 image, you can get a scanline of 640 pixels at row 479 but if you ask for a scanline at row 480, an exception is returned (rows are numbered starting at 0).  GetVirtualPixels() does not have this constraint.  For example,</p>
 367
 368 <pre class="code">
 369   p=GetVirtualPixels(source,-3,-3,source-&gt;columns+3,6,exception);
 370 </pre>
 371
 372 <p>gives you the pixels you asked for without complaint, even though some are not within the confines of the image region.</p>
 373 </div>
 374
 375 <h3><a id="virtual-pixels"></a>Virtual Pixels</h3>
 376 <div class="doc-section">
 377
 378 <p>There are a plethora of image processing algorithms that require a neighborhood of pixels about a pixel of interest.  The algorithm typically includes a caveat concerning how to handle pixels around the image boundaries, known as edge pixels.  With virtual pixels, you do not need to concern yourself about special edge processing other than choosing  which virtual pixel method is most appropriate for your algorithm.</p>
 379  <p>Access to the virtual pixels are controlled by the <a href="../www/api/cache.html#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod()</a> method from the MagickCore API or the <a href="../www/command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a> option from the command line.  The methods include:</p>
 380
 381 <pre class="text" style="font-size: 83.3333%;">
 382   background:           the area surrounding the image is the background color
 383   black:                the area surrounding the image is black
 384   checker-tile:         alternate squares with image and background color
 385   dither:               non-random 32x32 dithered pattern
 386   edge:                 extend the edge pixel toward infinity (default)
 387   gray:                 the area surrounding the image is gray
 388   horizontal-tile:      horizontally tile the image, background color above/below
 389   horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
 390   mirror:               mirror tile the image
 391   random:               choose a random pixel from the image
 392   tile:                 tile the image
 393   transparent:          the area surrounding the image is transparent blackness
 394   vertical-tile:        vertically tile the image, sides are background color
 395   vertical-tile-edge:   vertically tile the image and replicate the side edge pixels
 396   white:                the area surrounding the image is white
 397 </pre>
 398
 399 </div>
 400
 401 <h3>Cache Storage and Resource Requirements</h3>
 402 <div class="doc-section">
 403
 404 <p>Recall that this simple and elegant design of the ImageMagick pixel cache comes at a cost in terms of storage and processing speed.  The pixel cache storage requirements scales with the area of the image and the bit depth of the pixel components.  For example, if we have a 640 by 480 image and we are using the Q16 version of ImageMagick, the pixel cache consumes image <em>width * height * bit-depth / 8 * channels</em> bytes or approximately 2.3 mebibytes (i.e. 640 * 480 * 2 * 4).  Not too bad, but what if your image is 25000 by 25000 pixels?  The pixel cache requires approximately 4.7 gibibytes of storage.  Ouch.  ImageMagick accounts for possible huge storage requirements by caching large images to disk rather than memory.  Typically the pixel cache is stored in memory using heap memory. If heap memory is exhausted, pixels are stored in in an anonymous map; if the anonymous memory map is exhausted, we create the pixel cache on disk and attempt to memory-map it; and if memory-map memory is exhausted, we simply use standard disk I/O.  Disk storage is cheap but it is also very slow, upwards of 1000 times slower than memory.  We can get some speed improvements, up to 5 times, if we use memory mapping to the disk-based cache.  These decisions about storage are made <em>automagically</em> by the pixel cache manager negotiating with the operating system.  However, you can influence how the pixel cache manager allocates the pixel cache with <em>cache resource limits</em>.  The limits include:</p>
 405
 406 <dl class="doc">
 407   <dt class="doc">files</dt>
 408   <dd>maximum number of open pixel cache files.  When this limit is exceeded, any subsequent pixels cached to disk are closed and reopened on demand. This behavior permits a large number of images to be accessed simultaneously on disk, but without a speed penalty due to repeated open/close calls.</dd>
 409   <dt class="doc">area</dt>
 410   <dd>maximum area in bytes of any one image that can reside in the pixel cache memory.  If this limit is exceeded, the image is automagically cached to disk.</dd>
 411   <dt class="doc">memory</dt>
 412   <dd>maximum amount of memory in bytes to allocate for the pixel cache from the anonymous mapped memory or the heap.</dd>
 413   <dt class="doc">map</dt>
 414   <dd>maximum amount of memory map in bytes to allocate for the pixel cache.</dd>
 415   <dt class="doc">disk</dt>
 416   <dd>maximum amount of disk space in bytes permitted for use by the pixel cache.  If this limit is exceeded, the pixel cache is not created and a fatal exception is thrown.</dd>
 417   <dt class="doc">thread</dt>
 418   <dd>maximum number of threads that are permitted to run in parallel.</dd>
 419   <dt class="doc">time</dt>
 420   <dd>maximum number of seconds that the process is permitted to execute.  When this limit is exceeded, an exception is thrown and processing stops.</dd>
 421 </dl>
 422
 423 <p>To determine the current setting of these limits, use this command:</p>
 424
 425 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -list resource</span></p><pre class="text">
 426 File         Area       Memory          Map         Disk    Thread         Time
 427 -------------------------------------------------------------------------------
 428  768     1.0386GB    3.8692GiB    7.7384GiB    unlimited         4    unlimited
 429 </pre>
 430
 431 <p>You can set these limits either as a <a href="../www/resources.html#configure">policy</a> (see <a href="../www/source/policy.xml">policy.xml</a>), with an <a href="../www/resources.html#environment">environment variable</a>, with the <a href="../www/command-line-options.html#limit">-limit</a> command line option, or with the <a href="../www/api/resource.html#SetMagickResourceLimit">SetMagickResourceLimit()</a> MagickCore API method. As an example, our online web interface to ImageMagick, <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">ImageMagick Studio</a>, has an area limit of 64 megabytes, a memory limit of 128 mebibytes and a map limit of 256 mebibytes and a disk limit of 1 gigabytes.  Since we process multiple simultaneous sessions, we don't want any one session consuming all the available memory.  Instead large images are cached to disk.  If the image is too large and exceeds the pixel cache disk limit, the program exits.  In addition, we place a 60 second time limit to prevent any run-away processing tasks.</p>
 432
 433 <p>Note, the cache limits are global, meaning if you create several images, the combined resource requirements are compared to the limit to determine the pixel cache storage disposition.</p>
 434 </div>
 435
 436 <h3>Cache Views</h3>
 437 <div class="doc-section">
 438
 439 <p>GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels(), and SyncAuthenticPixels() from the MagickCore API can only deal with one pixel cache area per image at a time.  Suppose you want to access the first and last scanline from the same image at the same time?  The solution is to use a <em>cache view</em>.  A cache view permits you to access as many areas simultaneously in the pixel cache as you require.  The cache view <a href="../www/api/cache-view.html">methods</a> behave like the previous methods except you must first open a view and close it when you are finished with it. Here is a snippet of MagickCore code that permits us to access two areas of an image simultaneously:</p>
 440
 441 <pre class="code">
 442   CacheView
 443     *view_1,
 444     *view_2;
 445
 446   view_1=AcquireCacheView(source);
 447   view_2=AcquireCacheView(source);
 448   for (y=0; y &lt; (ssize_t) source-&gt;rows; y++)
 449   {
 450     u=GetCacheViewVirtualPixels(view_1,0,y,source-&gt;columns,1,exception);
 451     v=GetCacheViewVirtualPixels(view_2,0,source-&gt;rows-y-1,source-&gt;columns,1,
 452       exception);
 453     if ((u == (const PixelPacket *) NULL) || (v == (const PixelPacket *) NULL))
 454       break;
 455     for (x=0; x &lt; (ssize_t) source-&gt;columns; x++)
 456     {
 457       /* do something with u &amp; v here */
 458     }
 459   }
 460   view_2=DestroyCacheView(view_2);
 461   view_1=DestroyCacheView(view_1);
 462   if (y &lt; (ssize_t) source-&gt;rows)
 463     { /* an exception was thrown */ }
 464 </pre>
 465 </div>
 466
 467 <h3>Magick Persistent Cache Format</h3>
 468 <div class="doc-section">
 469
 470 <p>Recall that each image format is decoded by ImageMagick and the pixels are deposited in the pixel cache.  If you write an image, the pixels are read from the pixel cache and encoded as required by the format you are writing (e.g. GIF, PNG, etc.).  The Magick Persistent Cache (MPC) format is designed to eliminate the overhead of decoding and encoding pixels to and from an image format.  MPC writes two files.  One, with the extension <kbd>.mpc</kbd>, retains all the properties associated with the image or image sequence (e.g. width, height, colorspace, etc.) and the second, with the extension <kbd>.cache</kbd>, is the pixel cache in the native raw format.  When reading an MPC image file, ImageMagick reads the image properties and memory maps the pixel cache on disk eliminating the need for decoding the image pixels.  The tradeoff is in disk space.  MPC is generally larger in file size than most other image formats.</p>
 471 <p>The most efficient use of MPC image files is a write-once, read-many-times pattern.  For example, your workflow requires extracting random blocks of pixels from the source image.  Rather than re-reading and possibly decompressing the source image each time, we use MPC and map the image directly to memory.</p>
 472 </div>
 473
 474 <h3>Best Practices</h3>
 475 <div class="doc-section">
 476
 477 <p>Although you can request any pixel from the pixel cache, any block of pixels, any scanline, multiple scanlines, any row, or multiple rows with the GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels, GetCacheViewVirtualPixels(), GetCacheViewAuthenticPixels(), and QueueCacheViewAuthenticPixels() methods, ImageMagick is optimized to return a few pixels or a few pixels rows at time.  There are additional optimizations if you request a single scanline or a few scanlines at a time.  These methods also permit random access to the pixel cache, however, ImageMagick is optimized for sequential access.  Although you can access scanlines of pixels sequentially from the last row of the image to the first, you may get a perfomance boost if you access scanlines from the first row of the image to the last, in sequentual order.</p>
 478
 479 <p>If you update pixels returned from GetAuthenticPixels() or GetCacheViewAuthenticPixels(), don't forget to call SyncAuthenticPixels() or SyncCacheViewAuthenticPixels() respectively to ensure your changes are synchronized with the pixel cache.</p>
 480
 481 <p>Use QueueAuthenticPixels() or QueueCacheViewAuthenticPixels() if you are setting an initial pixel value.  The GetAuthenticPixels() or GetCacheViewAuthenticPixels() method reads pixels from the cache and if you are setting an initial pixel value, this read is unnecessary. Don't forget to call SyncAuthenticPixels() or SyncCacheViewAuthenticPixels() respectively to push your updates to the pixel cache.</p>
 482
 483 <p>GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels(), and SyncAuthenticPixels() are slightly more efficient than their cache view counter-parts.  However, cache views are required if you need access to more than one region of the image simultaneously or if more than one <a href="#threads">thread of execution</a> is accessing the image.</p>
 484
 485 <p>You can request pixels outside the bounds of the image with GetVirtualPixels() or GetCacheViewVirtualPixels(), however, it is more efficient to request pixels within the confines of the image region.</p>
 486
 487 <p>Although you can force the pixel cache to disk using appropriate resource limits, disk access can be upwards of 1000 times slower than memory access.  For fast, efficient, access to the pixel cache, try to keep the pixel cache in heap memory or anonymous mapped memory.</p>
 488
 489 <p>The ImageMagick Q16 version of ImageMagick permits you to read and write 16 bit images without scaling but the pixel cache consumes twice as much resources as the Q8 version.  If your system has constrained memory or disk resources, consider the Q8 version of ImageMagick.  In addition, the Q8 version typically executes faster than the Q16 version.</p>
 490
 491 <p>A great majority of image formats and algorithms restrict themselves to a fixed range of pixel values from 0 to some maximum value, for example, the Q16 version of ImageMagick permit intensities from 0 to 65535.  High dynamic-range imaging (HDRI), however, permits a far greater dynamic range of exposures (i.e. a large difference between light and dark areas) than standard digital imaging techniques. HDRI accurately represents the wide range of intensity levels found in real scenes ranging from the brightest direct sunlight to the deepest darkest shadows.  Enable <a href="../www/high-dynamic-range.html">HDRI</a> at ImageMagick build time to deal with high dynamic-range images, but be mindful that each pixel component is a 32-bit floating point value. In addition, pixel values are not clamped by default so some algorithms may perform differently than the non-HDRI version.</p>
 492
 493 <p>If you are dealing with large images, make sure the pixel cache is written to a disk area with plenty of free space.  Under Unix, this is typically <kbd>/tmp</kbd> and for Windows, <kbd>c:/temp</kbd>.  You can tell ImageMagick to write the pixel cache to an alternate location with the MAGICK_TEMPORARY_PATH environment variable.  For example,</p>
 494
 495 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>export MAGICK_TEMPORARY_PATH=/data/magick</span></p>
 496
 497 <p>If you plan on processing the same image many times, consider the MPC format.  Reading a MPC image has near-zero overhead because its in the native pixel cache format eliminating the need for decoding the image pixels.  Here is an example:</p>
 498
 499 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.tif image.mpc</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.mpc -crop 100x100+0+0 +repage 1.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.mpc -crop 100x100+100+0 +repage 2.png</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.mpc -crop 100x100+200+0 +repage 3.png</span></p>
 500 <p>MPC is ideal for web sites.  It reduces the overhead of reading and writing an image.  We use it exclusively at our <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">online image studio</a>.</p>
 501 </div>
 502
 503 </div>
 504
 505 <h2><a id="stream"></a>Streaming Pixels</h2>
 506 <div class="doc-section">
 507
 508 <p>ImageMagick provides for streaming pixels as they are read from or written to an image.  This has several advantages over the pixel cache.  The time and resources consumed by the pixel cache scale with the area of an image, whereas the pixel stream resources scale with the width of an image.  The disadvantage is the pixels must be consumed as they are streamed so there is no persistence.</p>
 509
 510 <p>Use <a href="../www/api/stream.html#ReadStream">ReadStream()</a> or <a href="../www/api/stream.html#WriteStream">WriteStream()</a> with an appropriate callback method in your MagickCore program to consume the pixels as they are streaming.  Here's an abbreviated example of using ReadStream:</p>
 511
 512 <pre class="code">
 513 static size_t StreamPixels(const Image *image,const void *pixels,
 514   const size_t columns)
 515 {
 516   register const PixelPacket
 517     *p;
 518
 519   MyData
 520     *my_data;
 521
 522   my_data=(MyData *) image->client_data;
 523   p=(PixelPacket *) pixels;
 524   if (p != (const PixelPacket *) NULL)
 525     {
 526       /* process pixels here */
 527     }
 528   return(columns);
 529 }
 530
 531 ...
 532 /* invoke the pixel stream here */
 533 image_info->client_data=(void *) MyData;
 534 image=ReadStream(image_info,&amp;StreamPixels,exception);
 535 </pre>
 536
 537 <p>We also provide a lightweight tool, <a href="../www/stream.html">stream</a>, to stream one or more pixel components of the image or portion of the image to your choice of storage formats.  It writes the pixel components as they are read from the input image a row at a time making <a href="../www/stream.html">stream</a> desirable when working with large images or when you require raw pixel components.  A majority of the image formats stream pixels (red, green, and blue) from left to right and top to bottom.  However, a few formats do not support this common ordering (e.g. the PSD format).</p>
 538
 539 </div>
 540
 541 <h2><a id="properties"></a>Image Properties and Profiles</h2>
 542 <div class="doc-section">
 543
 544 <p>Images have metadata associated with them in the form of properties (e.g. width, height, description, etc.) and profiles (e.g. EXIF, IPTC, color management).  ImageMagick provides convenient methods to get, set, or update image properties and get, set, update, or apply profiles.  Some of the more popular image properties are associated with the Image structure in the MagickCore API.  For example:</p>
 545
 546 <pre class="code">
 547   (void) printf("image width: %lu, height: %lu\n",image-&gt;columns,image-&gt;rows);
 548 </pre>
 549
 550 <p>For a great majority of image properties, such as an image comment or description, we use the <a href="../www/api/property.html#GetImageProperty">GetImageProperty()</a> and <a href="../www/api/property.html#SetImageProperty">SetImageProperty()</a> methods.  Here we set a property and fetch it right back:</p>
 551
 552 <pre class="code">
 553   const char
 554     *comment;
 555
 556   (void) SetImageProperty(image,"comment","This space for rent");
 557   comment=GetImageProperty(image,"comment");
 558   if (comment == (const char *) NULL)
 559     (void) printf("Image comment: %s\n",comment);
 560 </pre>
 561
 562 <p>ImageMagick supports artifacts with the GetImageArtifact() and SetImageArtifact() methods.  Artifacts are stealth properties that are not exported to image formats (e.g. PNG).</p>
 563
 564 <p>Image profiles are handled with <a href="../www/api/profile.html#GetImageProfile">GetImageProfile()</a>, <a href="../www/api/profile.html#SetImageProfile">SetImageProfile()</a>, and <a href="../www/api/profile.html#ProfileImage">ProfileImage()</a> methods.  Here we set a profile and fetch it right back:</p>
 565
 566 <pre class="code">
 567   StringInfo
 568     *profile;
 569
 570   profile=AcquireStringInfo(length);
 571   SetStringInfoDatum(profile,my_exif_profile);
 572   (void) SetImageProfile(image,"EXIF",profile);
 573   DestroyStringInfo(profile);
 574   profile=GetImageProfile(image,"EXIF");
 575   if (profile != (StringInfo *) NULL)
 576     (void) PrintStringInfo(stdout,"EXIF",profile);
 577 </pre>
 578
 579 </div>
 580
 581 <h2><a id="tera-pixel"></a>Large Image Support</h2>
 582 <div class="doc-section">
 583 <p>ImageMagick can read, process, or write mega-, giga-, or tera-pixel image sizes.  An image width or height can range from 1 to 2 giga-pixels on a 32 bit OS and up to 9 exa-pixels on a 64-bit OS.  Note, that some image formats have restrictions on image size.  For example, Photoshop images are limited to 300,000 pixels for width or height.  Here we resize an image to a quarter million pixels square:</p>
 584
 585 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -resize 250000x250000 logo.miff</span></p>
 586 <p>For large images, ImageMagick will likely create a pixel cache on disk.  Make sure you have plenty of temporary disk space.  If your default temporary disk partition is too small, tell ImageMagick to use another partition with plenty of free space.  For example:</p>
 587
 588 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -define registry:temporary-path=/data/tmp logo:  \ <br/>     -resize 250000x250000 logo.miff</span></p>
 589 <p>To ensure large images do not consume all the memory on your system, force the image pixels to memory-mapped disk with resource limits:</p>
 590
 591 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -define registry:temporary-path=/data/tmp -limit memory 16mb  \ <br/>     logo: -resize 250000x250000 logo.miff</span></p>
 592 <p>Here we force all image pixels to disk:</p>
 593
 594 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -define registry:temporary-path=/data/tmp -limit area 0  \ <br/>     logo: -resize 250000x250000 logo.miff</span></p>
 595 <p>Caching pixels to disk is about 1000 times slower than memory.  Expect long run times when processing large images on disk with ImageMagick.  You can monitor progress with this command:</p>
 596
 597 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert -monitor -define registry:temporary-path=/data/tmp -limit area 0  \ <br/>     logo: -resize 250000x250000 logo.miff</span></p></div>
 598
 599 <h2><a id="threads"></a>Threads of Execution</h2>
 600 <div class="doc-section">
 601
 602 <p>Many of ImageMagick's internal algorithms are threaded to take advantage of speed-ups offered by the multicore processor chips. However, you are welcome to use ImageMagick algorithms in your threads of execution with the exception of the MagickCore's GetVirtualPixels(), GetAuthenticPixels(), QueueAuthenticPixels(), or SyncAuthenticPixels() pixel cache methods.  These methods are intended for one thread of execution only with the exception of an OpenMP parallel section.  To access the pixel cache with more than one thread of execution, use a cache view.  We do this for the <a href="../www/api/composite.html#CompositeImage">CompositeImage()</a> method, for example.  Suppose we want to composite a single image over a different image in each thread of execution.  If we use GetVirtualPixels(), the results are unpredictable because multiple threads would likely be asking for different areas of the pixel cache simultaneously.  Instead we use GetCacheViewVirtualPixels() which creates a unique view for each thread of execution ensuring our program behaves properly regardless of how many threads are invoked.  The other program interfaces, such as the <a href="../www/magick-wand.html">MagickWand API</a>, are completely thread safe so there are no special precautions for threads of execution.</p>
 603
 604 <p>Here is an MagickCore code snippet that takes advantage of threads of execution with the <a href="http://en.wikipedia.org/wiki/OpenMP">OpenMP</a> programming paradigm:</p>
 605
 606 <div class="viewport">
 607 {
 608   CacheView
 609     *image_view;
 610
 611   MagickBooleanType
 612     status;
 613
 614   ssize_t
 615     y;
 616
 617   status=MagickTrue;
 618   image_view=AcquireCacheView(image);
 619   #pragma omp parallel for schedule(dynamic,4) shared(status)
 620   for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
 621   {
 622     register IndexPacket
 623       *indexes;
 624
 625     register PixelPacket
 626       *q;
 627
 628     register ssize_t
 629       x;
 630
 631     if (status == MagickFalse)
 632       continue;
 633     q=GetCacheViewAuthenticPixels(image_view,0,y,image-&gt;columns,1,exception);
 634     if (q == (PixelPacket *) NULL)
 635       {
 636         status=MagickFalse;
 637         continue;
 638       }
 639     indexes=GetCacheViewAuthenticIndexQueue(image_view);
 640     for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
 641     {
 642       SetRedPixelComponent(q,...);
 643       SetGreenPixelComponent(q,...);
 644       SetBluePixelComponent(q,...);
 645       SetOpacityPixelComponent(q,...);
 646       if (indexes != (IndexPacket *) NULL)
 647         SetIndexPixelComponent(indexes+x,...);
 648       q++;
 649     }
 650     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
 651       status=MagickFalse;
 652   }
 653   image_view=DestroyCacheView(image_view);
 654   if (status == MagickFalse)
 655     perror("something went wrong");
 656 }
 657 </div>
 658 <p>This code snippet converts an uncompressed Windows bitmap to a Magick++ image:</p>
 659 <div class="viewport">
 660 #include "Magick++.h"
 661 #include &lt;assert.h&gt;
 662 #include "omp.h"
 663
 664 void ConvertBMPToImage(const BITMAPINFOHEADER *bmp_info,
 665   const unsigned char *restrict pixels,Magick::Image *image)
 666 {
 667   /*
 668     Prepare the image so that we can modify the pixels directly.
 669   */
 670   assert(bmp_info->biCompression == BI_RGB);
 671   assert(bmp_info->biWidth == image->columns());
 672   assert(abs(bmp_info->biHeight) == image->rows());
 673   image->modifyImage();
 674   if (bmp_info->biBitCount == 24)
 675     image->type(MagickCore::TrueColorType);
 676   else
 677     image->type(MagickCore::TrueColorMatteType);
 678   register unsigned int bytes_per_row=bmp_info->biWidth*bmp_info->biBitCount/8;
 679   if (bytes_per_row % 4 != 0) {
 680     bytes_per_row=bytes_per_row+(4-bytes_per_row % 4);  // divisible by 4.
 681   }
 682   /*
 683     Copy all pixel data, row by row.
 684   */
 685   #pragma omp parallel for
 686   for (int y=0; y &lt; int(image->rows()); y++)
 687   {
 688     int row=(bmp_info->biHeight > 0) ? (image->rows()-y-1) : y;
 689     register const unsigned char *restrict p=pixels+row*bytes_per_row;
 690     register MagickCore::PixelPacket *restrict q=
 691       image->setPixels(0,y,image->columns(),1);
 692     for (int x=0; x &lt; int(image->columns()); x++)
 693     {
 694       SetBluePixelComponent(q,p[0]);
 695       SetGreenPixelComponent(q,p[1]);
 696       SetRedPixelComponent(q,p[2]);
 697       if (bmp_info->biBitCount == 32) {
 698         SetOpacityPixelComponent(q,p[3]);
 699       }
 700       q++;
 701       p+=bmp_info->biBitCount/8;
 702     }
 703     image->syncPixels();  // sync pixels to pixel cache.
 704   }
 705   return;
 706 }
 707 </div>
 708
 709 <p>If you call the ImageMagick API from your OpenMP-enabled application and you intend to dynamically increase the number of threads available in subsequent parallel regions, be sure to perform the increase <em>before</em> you call the API otherwise ImageMagick may fault.</p>
 710
 711 <p><a href="../www/api/wand-view.html">MagickWand</a> supports wand views.  A view iterates over the entire, or portion, of the image in parallel and for each row of pixels, it invokes a callback method you provide.  This limits most of your parallel programming activity to just that one module.  There are similar methods in <a href="../www/api/image-view.html">MagickCore</a>.  For an example, see the same sigmoidal contrast algorithm implemented in both <a href="../www/magick-wand.html#wand-view">MagickWand</a> and <a href="../www/magick-core.html#image-view">MagickCore</a>.</p>
 712
 713 <p>In most circumstances, the default number of threads is set to the number of processor cores on your system for optimal performance.  However, if your system is hyperthreaded or if you are running on a virtual host and only a subset of the processors are available to your server instance, you might get an increase in performance by setting the thread <a href="../www/resources.html#configure">policy</a> or the <a href="../www/resources.html#environment">MAGICK_THREAD_LIMIT</a> environment variable.  For example, your virtual host has 8 processors but only 2 are assigned to your server instance.  The default of 8 threads can cause severe performance problems.  One solution is to limit the number of threads to the available processors in your <a href="../www/source/policy.xml">policy.xml</a> configuration file:</p>
 714
 715 <pre class="text">
 716   &lt;policy domain="resource" name="thread" value="2"/>
 717 </pre>
 718
 719 <p>Or suppose your 12 core hyperthreaded computer defaults to 24 threads.  Set the MAGICK_THREAD_LIMIT environment variable and you will likely get improved performance:</p>
 720
 721 <pre class="text">
 722   export MAGICK_THREAD_LIMIT=12
 723 </pre>
 724
 725 <p>The OpenMP committee has not defined the behavior of mixing OpenMP with other threading models such as Posix threads.  However, using modern releases of Linux, OpenMP and Posix threads appear to interoperate without complaint.  If you want to use Posix threads from a program module that calls one of the ImageMagick application programming interfaces (e.g. MagickCore, MagickWand, Magick++, etc.) from Mac OS X or an older Linux release, you may need to disable OpenMP support within ImageMagick.  Add the <kbd>--disable-openmp</kbd> option to the configure script command line and rebuild and reinstall ImageMagick.</p>
 726
 727 </div>
 728
 729 <h2><a id="distributed"></a>Heterogeneous Distributed Processing</h2>
 730 <div class="doc-section">
 731 <p>ImageMagick includes support for heterogeneous distributed processing with the <a href="http://en.wikipedia.org/wiki/OpenCL">OpenCL</a> framework.  OpenCL kernels within ImageMagick permit image processing algorithms to execute across heterogeneous platforms consisting of CPUs, GPUs, and other processors.  Depending on your platform, speed-ups can be an order of magnitude faster than the traditional single CPU.</p>
 732
 733 <p>First verify that your version of ImageMagick includes support for the OpenCL feature:</p>
 734
 735 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>identify -version</span><span class='crtout'>Features: OpenMP OpenCL</span></p>
 736 <p>If so, run this command to realize a significant speed-up for image convolution:</p>
 737
 738 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert image.png convolve '-1, -1, -1, -1, 9, -1, -1, -1, -1'  \ <br/> convolve.png</span></p>
 739 <p>If an accelerator is not available or if the accelerator fails to respond, ImageMagick reverts to the non-accelerated convolution algorithm.</p>
 740
 741 <p>Here is an example OpenCL kernel that convolves an image:</p>
 742
 743 <div class="viewport">
 744 static inline long ClampToCanvas(const long offset,const ulong range)
 745 {
 746   if (offset &lt; 0L)
 747     return(0L);
 748   if (offset >= range)
 749     return((long) (range-1L));
 750   return(offset);
 751 }
 752
 753 static inline CLQuantum ClampToQuantum(const double value)
 754 {
 755   if (value &lt; 0.0)
 756     return((CLQuantum) 0);
 757   if (value >= (double) QuantumRange)
 758     return((CLQuantum) QuantumRange);
 759   return((CLQuantum) (value+0.5));
 760 }
 761
 762 __kernel void Convolve(const __global CLPixelType *source,__constant double *filter,
 763   const ulong width,const ulong height,__global CLPixelType *destination)
 764 {
 765   const ulong columns = get_global_size(0);
 766   const ulong rows = get_global_size(1);
 767
 768   const long x = get_global_id(0);
 769   const long y = get_global_id(1);
 770
 771   const double scale = (1.0/QuantumRange);
 772   const long mid_width = (width-1)/2;
 773   const long mid_height = (height-1)/2;
 774   double4 sum = { 0.0, 0.0, 0.0, 0.0 };
 775   double gamma = 0.0;
 776   register ulong i = 0;
 777
 778   for (long v=(-mid_height); v &lt;= mid_height; v++)
 779   {
 780     for (long u=(-mid_width); u &lt;= mid_width; u++)
 781     {
 782       register const ulong index=ClampToCanvas(y+v,rows)*columns+ClampToCanvas(x+u,
 783         columns);
 784       const double alpha=scale*(QuantumRange-source[index].w);
 785       sum.x+=alpha*filter[i]*source[index].x;
 786       sum.y+=alpha*filter[i]*source[index].y;
 787       sum.z+=alpha*filter[i]*source[index].z;
 788       sum.w+=filter[i]*source[index].w;
 789       gamma+=alpha*filter[i];
 790       i++;
 791     }
 792   }
 793
 794   gamma=1.0/(fabs(gamma) &lt;= MagickEpsilon ? 1.0 : gamma);
 795   const ulong index=y*columns+x;
 796   destination[index].x=ClampToQuantum(gamma*sum.x);
 797   destination[index].y=ClampToQuantum(gamma*sum.y);
 798   destination[index].z=ClampToQuantum(gamma*sum.z);
 799   destination[index].w=ClampToQuantum(sum.w);
 800 };
 801 </div>
 802
 803 <p>See <a href="http://trac.imagemagick.org/browser/ImageMagick/trunk/magick/accelerate.c">magick/accelerate.c</a> for a complete implementation of image convolution with an OpenCL kernel.</p>
 804
 805 </div>
 806
 807 <h2><a id="coders"></a>Custom Image Coders</h2>
 808 <div class="doc-section">
 809
 810 <p>An image coder (i.e. encoder / decoder) is responsible for registering, optionally classifying, optionally reading, optionally writing, and unregistering one image format (e.g.  PNG, GIF, JPEG, etc.).  Registering an image coder alerts ImageMagick a particular format is available to read or write.  While unregistering tells ImageMagick the format is no longer available.  The classifying method looks at the first few bytes of an image and determines if the image is in the expected format.  The reader sets the image size, colorspace, and other properties and loads the pixel cache with the pixels.  The reader returns a single image or an image sequence (if the format supports multiple images per file), or if an error occurs, an exception and a null image.  The writer does the reverse.  It takes the image properties and unloads the pixel cache and writes them as required by the image format.</p>
 811
 812 <p>Here is a listing of a sample <a href="../www/source/mgk.c">custom coder</a>.  It reads and writes images in the MGK image format which is simply an ID followed by the image width and height followed by the RGB pixel values.</p>
 813
 814 <div class="viewport">
 815 /*
 816   Include declarations.
 817 */
 818 #include "magick/studio.h"
 819 #include "magick/blob.h"
 820 #include "magick/blob-private.h"
 821 #include "magick/colorspace.h"
 822 #include "magick/exception.h"
 823 #include "magick/exception-private.h"
 824 #include "magick/image.h"
 825 #include "magick/image-private.h"
 826 #include "magick/list.h"
 827 #include "magick/magick.h"
 828 #include "magick/memory_.h"
 829 #include "magick/monitor.h"
 830 #include "magick/monitor-private.h"
 831 #include "magick/quantum-private.h"
 832 #include "magick/static.h"
 833 #include "magick/string_.h"
 834 #include "magick/module.h"
 835
 836 /*
 837   Forward declarations.
 838 */
 839 static MagickBooleanType
 840   WriteMGKImage(const ImageInfo *,Image *);
 841
 842 /*
 843 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 844 %                                                                             %
 845 %                                                                             %
 846 %                                                                             %
 847 %   I s M G K                                                                 %
 848 %                                                                             %
 849 %                                                                             %
 850 %                                                                             %
 851 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 852 %
 853 %  IsMGK() returns MagickTrue if the image format type, identified by the
 854 %  magick string, is MGK.
 855 %
 856 %  The format of the IsMGK method is:
 857 %
 858 %      MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)
 859 %
 860 %  A description of each parameter follows:
 861 %
 862 %    o magick: This string is generally the first few bytes of an image file
 863 %      or blob.
 864 %
 865 %    o length: Specifies the length of the magick string.
 866 %
 867 */
 868 static MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)
 869 {
 870   if (length &lt; 7)
 871     return(MagickFalse);
 872   if (LocaleNCompare((char *) magick,"id=mgk",7) == 0)
 873     return(MagickTrue);
 874   return(MagickFalse);
 875 }
 876
 877 /*
 878 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 879 %                                                                             %
 880 %                                                                             %
 881 %                                                                             %
 882 %   R e a d M G K I m a g e                                                   %
 883 %                                                                             %
 884 %                                                                             %
 885 %                                                                             %
 886 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 887 %
 888 %  ReadMGKImage() reads a MGK image file and returns it.  It allocates
 889 %  the memory necessary for the new Image structure and returns a pointer to
 890 %  the new image.
 891 %
 892 %  The format of the ReadMGKImage method is:
 893 %
 894 %      Image *ReadMGKImage(const ImageInfo *image_info,ExceptionInfo *exception)
 895 %
 896 %  A description of each parameter follows:
 897 %
 898 %    o image_info: the image info.
 899 %
 900 %    o exception: return any errors or warnings in this structure.
 901 %
 902 */
 903 static Image *ReadMGKImage(const ImageInfo *image_info,
 904   ExceptionInfo *exception)
 905 {
 906   char
 907     buffer[MaxTextExtent];
 908
 909   Image
 910     *image;
 911
 912   MagickBooleanType
 913     status;
 914
 915   register PixelPacket
 916     *q;
 917
 918   register size_t
 919     x;
 920
 921   register unsigned char
 922     *p;
 923
 924   ssize_t
 925     count,
 926     y;
 927
 928   unsigned char
 929     *pixels;
 930
 931   unsigned long
 932     columns,
 933     rows;
 934
 935   /*
 936     Open image file.
 937   */
 938   assert(image_info != (const ImageInfo *) NULL);
 939   assert(image_info-&gt;signature == MagickSignature);
 940   if (image_info-&gt;debug != MagickFalse)
 941     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image_info-&gt;filename);
 942   assert(exception != (ExceptionInfo *) NULL);
 943   assert(exception-&gt;signature == MagickSignature);
 944   image=AcquireImage(image_info);
 945   status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
 946   if (status == MagickFalse)
 947     {
 948       image=DestroyImageList(image);
 949       return((Image *) NULL);
 950     }
 951   /*
 952     Read MGK image.
 953   */
 954   (void) ReadBlobString(image,buffer);  /* read magic number */
 955   if (IsMGK(buffer,7) == MagickFalse)
 956     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
 957   (void) ReadBlobString(image,buffer);
 958   count=(ssize_t) sscanf(buffer,"%lu %lu\n",&amp;columns,&amp;rows);
 959   if (count &lt;= 0)
 960     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
 961   do
 962   {
 963     /*
 964       Initialize image structure.
 965     */
 966     image-&gt;columns=columns;
 967     image-&gt;rows=rows;
 968     image-&gt;depth=8;
 969     if ((image_info-&gt;ping != MagickFalse) &amp;&amp; (image_info-&gt;number_scenes != 0))
 970       if (image-&gt;scene >= (image_info-&gt;scene+image_info-&gt;number_scenes-1))
 971         break;
 972     /*
 973       Convert MGK raster image to pixel packets.
 974     */
 975     if (SetImageExtent(image,0,0) == MagickFalse)
 976       {
 977         InheritException(exception,&amp;image-&gt;exception);
 978         return(DestroyImageList(image));
 979       }
 980     pixels=(unsigned char *) AcquireQuantumMemory((size_t) image-&gt;columns,3UL*sizeof(*pixels));
 981     if (pixels == (unsigned char *) NULL)
 982       ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
 983     for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
 984     {
 985       count=(ssize_t) ReadBlob(image,(size_t) (3*image-&gt;columns),pixels);
 986       if (count != (ssize_t) (3*image-&gt;columns))
 987         ThrowReaderException(CorruptImageError,"UnableToReadImageData");
 988       p=pixels;
 989       q=QueueAuthenticPixels(image,0,y,image-&gt;columns,1,exception);
 990       if (q == (PixelPacket *) NULL)
 991         break;
 992       for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
 993       {
 994         q-&gt;red=ScaleCharToQuantum(*p++);
 995         q-&gt;green=ScaleCharToQuantum(*p++);
 996         q-&gt;blue=ScaleCharToQuantum(*p++);
 997         q++;
 998       }
 999       if (SyncAuthenticPixels(image,exception) == MagickFalse)
1000         break;
1001       if ((image-&gt;previous == (Image *) NULL) &amp;&amp;
1002           (SetImageProgress(image,LoadImageTag,y,image&gt;>rows) == MagickFalse))
1003         break;
1004     }
1005     pixels=(unsigned char *) RelinquishMagickMemory(pixels);
1006     if (EOFBlob(image) != MagickFalse)
1007       {
1008         ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",image-&gt;filename);
1009         break;
1010       }
1011     /*
1012       Proceed to next image.
1013     */
1014     if (image_info-&gt;number_scenes != 0)
1015       if (image-&gt;scene >= (image_info-&gt;scene+image_info-&gt;number_scenes-1))
1016         break;
1017     *buffer='\0';
1018     (void) ReadBlobString(image,buffer);
1019     count=(ssize_t) sscanf(buffer,"%lu %lu\n",&amp;columns,&amp;rows);
1020     if (count != 0)
1021       {
1022         /*
1023           Allocate next image structure.
1024         */
1025         AcquireNextImage(image_info,image);
1026         if (GetNextImageInList(image) == (Image *) NULL)
1027           {
1028             image=DestroyImageList(image);
1029             return((Image *) NULL);
1030           }
1031         image=SyncNextImageInList(image);
1032         status=SetImageProgress(image,LoadImageTag,TellBlob(image),GetBlobSize(image));
1033         if (status == MagickFalse)
1034           break;
1035       }
1036   } while (count != 0);
1037   (void) CloseBlob(image);
1038   return(GetFirstImageInList(image));
1039 }
1040
1041 /*
1042 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1043 %                                                                             %
1044 %                                                                             %
1045 %                                                                             %
1046 %   R e g i s t e r M G K I m a g e                                           %
1047 %                                                                             %
1048 %                                                                             %
1049 %                                                                             %
1050 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1051 %
1052 %  RegisterMGKImage() adds attributes for the MGK image format to
1053 %  the list of supported formats.  The attributes include the image format
1054 %  tag, a method to read and/or write the format, whether the format
1055 %  supports the saving of more than one frame to the same file or blob,
1056 %  whether the format supports native in-memory I/O, and a brief
1057 %  description of the format.
1058 %
1059 %  The format of the RegisterMGKImage method is:
1060 %
1061 %      unsigned long RegisterMGKImage(void)
1062 %
1063 */
1064 ModuleExport unsigned long RegisterMGKImage(void)
1065 {
1066   MagickInfo
1067     *entry;
1068
1069   entry=SetMagickInfo("MGK");
1070   entry-&gt;decoder=(DecodeImageHandler *) ReadMGKImage;
1071   entry-&gt;encoder=(EncodeImageHandler *) WriteMGKImage;
1072   entry-&gt;magick=(IsImageFormatHandler *) IsMGK;
1073   entry-&gt;description=ConstantString("MGK");
1074   entry-&gt;module=ConstantString("MGK");
1075   (void) RegisterMagickInfo(entry);
1076   return(MagickImageCoderSignature);
1077 }
1078
1079 /*
1080 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1081 %                                                                             %
1082 %                                                                             %
1083 %                                                                             %
1084 %   U n r e g i s t e r M G K I m a g e                                       %
1085 %                                                                             %
1086 %                                                                             %
1087 %                                                                             %
1088 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1089 %
1090 %  UnregisterMGKImage() removes format registrations made by the
1091 %  MGK module from the list of supported formats.
1092 %
1093 %  The format of the UnregisterMGKImage method is:
1094 %
1095 %      UnregisterMGKImage(void)
1096 %
1097 */
1098 ModuleExport void UnregisterMGKImage(void)
1099 {
1100   (void) UnregisterMagickInfo("MGK");
1101 }
1102
1103 /*
1104 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1105 %                                                                             %
1106 %                                                                             %
1107 %                                                                             %
1108 %   W r i t e M G K I m a g e                                                 %
1109 %                                                                             %
1110 %                                                                             %
1111 %                                                                             %
1112 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1113 %
1114 %  WriteMGKImage() writes an image to a file in red, green, and blue
1115 %  MGK rasterfile format.
1116 %
1117 %  The format of the WriteMGKImage method is:
1118 %
1119 %      MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)
1120 %
1121 %  A description of each parameter follows.
1122 %
1123 %    o image_info: the image info.
1124 %
1125 %    o image:  The image.
1126 %
1127 */
1128 static MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)
1129 {
1130   char
1131     buffer[MaxTextExtent];
1132
1133   MagickBooleanType
1134     status;
1135
1136   MagickOffsetType
1137     scene;
1138
1139   register const PixelPacket
1140     *p;
1141
1142   register ssize_t
1143     x;
1144
1145   register unsigned char
1146     *q;
1147
1148   ssize_t
1149     y;
1150
1151   unsigned char
1152     *pixels;
1153
1154   /*
1155     Open output image file.
1156   */
1157   assert(image_info != (const ImageInfo *) NULL);
1158   assert(image_info-&gt;signature == MagickSignature);
1159   assert(image != (Image *) NULL);
1160   assert(image-&gt;signature == MagickSignature);
1161   if (image-&gt;debug != MagickFalse)
1162     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image-&gt;filename);
1163   status=OpenBlob(image_info,image,WriteBinaryBlobMode,&amp;image-&gt;exception);
1164   if (status == MagickFalse)
1165     return(status);
1166   scene=0;
1167   do
1168   {
1169     /*
1170       Allocate memory for pixels.
1171     */
1172     if (image-&gt;colorspace != RGBColorspace)
1173       (void) SetImageColorspace(image,RGBColorspace);
1174     pixels=(unsigned char *) AcquireQuantumMemory((size_t) image-&gt;columns,
1175       3UL*sizeof(*pixels));
1176     if (pixels == (unsigned char *) NULL)
1177       ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
1178     /*
1179       Initialize raster file header.
1180     */
1181     (void) WriteBlobString(image,"id=mgk\n");
1182     (void) FormatMagickString(buffer,MaxTextExtent,"%lu %lu\n",
1183       image-&gt;columns,image-&gt;rows);
1184     (void) WriteBlobString(image,buffer);
1185     for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
1186     {
1187       p=GetVirtualPixels(image,0,y,image-&gt;columns,1,&amp;image-&gt;exception);
1188       if (p == (const PixelPacket *) NULL)
1189         break;
1190       q=pixels;
1191       for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
1192       {
1193         *q++=ScaleQuantumToChar(p-&gt;red);
1194         *q++=ScaleQuantumToChar(p-&gt;green);
1195         *q++=ScaleQuantumToChar(p-&gt;blue);
1196         p++;
1197       }
1198       (void) WriteBlob(image,(size_t) (q-pixels),pixels);
1199       if ((image-&gt;previous == (Image *) NULL) &amp;&amp;
1200           (SetImageProgress(image,SaveImageTag,y,image-&gt;rows) == MagickFalse))
1201         break;
1202     }
1203     pixels=(unsigned char *) RelinquishMagickMemory(pixels);
1204     if (GetNextImageInList(image) == (Image *) NULL)
1205       break;
1206     image=SyncNextImageInList(image);
1207     status=SetImageProgress(image,SaveImagesTag,scene,
1208       GetImageListLength(image));
1209     if (status == MagickFalse)
1210       break;
1211     scene++;
1212   } while (image_info-&gt;adjoin != MagickFalse);
1213   (void) CloseBlob(image);
1214   return(MagickTrue);
1215 }
1216 </div>
1217
1218 <p>To invoke the custom coder from the command line, use these commands:</p>
1219
1220 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: logo.mgk</span><span class='crtout'></span><span class="crtprompt"> $magick&gt; </span><span class='crtin'>display logo.mgk</span></p>
1221 <p>We provide the <a href="ftp://ftp.imagemagick.org/pub/ImageMagick/kits/MagickCoderKit-1.0.0.tar.gz">Magick Coder Kit</a> to help you get started writing your own custom coder.</p>
1222
1223 </div>
1224
1225 <h2><a id="filters"></a>Custom Image Filters</h2>
1226 <div class="doc-section">
1227
1228 <p>ImageMagick provides a convenient mechanism for adding your own custom image processing algorithms.  We call these image filters and they are invoked from the command line with the <a href="../www/command-line-options.html#process">-process</a> option or from the MagickCore API method <a href="../www/api/module.html#ExecuteModuleProcess">ExecuteModuleProcess()</a>.</p>
1229
1230 <p>Here is a listing of a sample <a href="../www/source/analyze.c">custom image filter</a>.  It computes a few statistics such as the pixel brightness and saturation mean and standard-deviation.</p>
1231
1232 <div class="viewport">
1233 #include &lt;stdio.h&gt;
1234 #include &lt;stdlib.h&gt;
1235 #include &lt;string.h&gt;
1236 #include &lt;time.h&gt;
1237 #include &lt;assert.h&gt;
1238 #include &lt;math.h&gt;
1239 #include "magick/MagickCore.h"
1240
1241 /*
1242 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1243 %                                                                             %
1244 %                                                                             %
1245 %                                                                             %
1246 %   a n a l y z e I m a g e                                                   %
1247 %                                                                             %
1248 %                                                                             %
1249 %                                                                             %
1250 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1251 %
1252 %  analyzeImage() computes the brightness and saturation mean,  standard
1253 %  deviation, kurtosis and skewness and stores these values as attributes
1254 %  of the image.
1255 %
1256 %  The format of the analyzeImage method is:
1257 %
1258 %      size_t analyzeImage(Image *images,const int argc,char **argv,
1259 %        ExceptionInfo *exception)
1260 %
1261 %  A description of each parameter follows:
1262 %
1263 %    o image: the address of a structure of type Image.
1264 %
1265 %    o argc: Specifies a pointer to an integer describing the number of
1266 %      elements in the argument vector.
1267 %
1268 %    o argv: Specifies a pointer to a text array containing the command line
1269 %      arguments.
1270 %
1271 %    o exception: return any errors or warnings in this structure.
1272 %
1273 */
1274 ModuleExport size_t analyzeImage(Image **images,const int argc,const char **argv,
1275   ExceptionInfo *exception)
1276 {
1277   char
1278     text[MaxTextExtent];
1279
1280   double
1281     area,
1282     brightness,
1283     brightness_mean,
1284     brightness_standard_deviation,
1285     brightness_kurtosis,
1286     brightness_skewness,
1287     brightness_sum_x,
1288     brightness_sum_x2,
1289     brightness_sum_x3,
1290     brightness_sum_x4,
1291     hue,
1292     saturation,
1293     saturation_mean,
1294     saturation_standard_deviation,
1295     saturation_kurtosis,
1296     saturation_skewness,
1297     saturation_sum_x,
1298     saturation_sum_x2,
1299     saturation_sum_x3,
1300     saturation_sum_x4;
1301
1302   Image
1303     *image;
1304
1305   assert(images != (Image **) NULL);
1306   assert(*images != (Image *) NULL);
1307   assert((*images)-&gt;signature == MagickSignature);
1308   (void) argc;
1309   (void) argv;
1310   image=(*images);
1311   for ( ; image != (Image *) NULL; image=GetNextImageInList(image))
1312   {
1313     CacheView
1314       *image_view;
1315
1316     MagickBooleanType
1317       status;
1318
1319     ssize_t
1320       y;
1321
1322     brightness_sum_x=0.0;
1323     brightness_sum_x2=0.0;
1324     brightness_sum_x3=0.0;
1325     brightness_sum_x4=0.0;
1326     brightness_mean=0.0;
1327     brightness_standard_deviation=0.0;
1328     brightness_kurtosis=0.0;
1329     brightness_skewness=0.0;
1330     saturation_sum_x=0.0;
1331     saturation_sum_x2=0.0;
1332     saturation_sum_x3=0.0;
1333     saturation_sum_x4=0.0;
1334     saturation_mean=0.0;
1335     saturation_standard_deviation=0.0;
1336     saturation_kurtosis=0.0;
1337     saturation_skewness=0.0;
1338     area=0.0;
1339     status=MagickTrue;
1340     image_view=AcquireCacheView(image);
1341 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1342     #pragma omp parallel for schedule(dynamic,4) shared(status)
1343 #endif
1344     for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
1345     {
1346       register const PixelPacket
1347         *p;
1348
1349       register ssize_t
1350         x;
1351
1352       if (status == MagickFalse)
1353         continue;
1354       p=GetCacheViewVirtualPixels(image_view,0,y,image-&gt;columns,1,exception);
1355       if (p == (const PixelPacket *) NULL)
1356         {
1357           status=MagickFalse;
1358           continue;
1359         }
1360       for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
1361       {
1362         ConvertRGBToHSB(p-&gt;red,p-&gt;green,p-&gt;blue,&amp;hue,&amp;saturation,&amp;brightness);
1363         brightness*=QuantumRange;
1364         brightness_sum_x+=brightness;
1365         brightness_sum_x2+=brightness*brightness;
1366         brightness_sum_x3+=brightness*brightness*brightness;
1367         brightness_sum_x4+=brightness*brightness*brightness*brightness;
1368         saturation*=QuantumRange;
1369         saturation_sum_x+=saturation;
1370         saturation_sum_x2+=saturation*saturation;
1371         saturation_sum_x3+=saturation*saturation*saturation;
1372         saturation_sum_x4+=saturation*saturation*saturation*saturation;
1373         area++;
1374         p++;
1375       }
1376     }
1377     image_view=DestroyCacheView(image_view);
1378     if (area &lt;= 0.0)
1379       break;
1380     brightness_mean=brightness_sum_x/area;
1381     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_mean);
1382     (void) SetImageProperty(image,"filter:brightness:mean",text);
1383     brightness_standard_deviation=sqrt(brightness_sum_x2/area-(brightness_sum_x/
1384       area*brightness_sum_x/area));
1385     (void) FormatMagickString(text,MaxTextExtent,"%g",
1386       brightness_standard_deviation);
1387     (void) SetImageProperty(image,"filter:brightness:standard-deviation",text);
1388     if (brightness_standard_deviation != 0)
1389       brightness_kurtosis=(brightness_sum_x4/area-4.0*brightness_mean*
1390         brightness_sum_x3/area+6.0*brightness_mean*brightness_mean*
1391         brightness_sum_x2/area-3.0*brightness_mean*brightness_mean*
1392         brightness_mean*brightness_mean)/(brightness_standard_deviation*
1393         brightness_standard_deviation*brightness_standard_deviation*
1394         brightness_standard_deviation)-3.0;
1395     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_kurtosis);
1396     (void) SetImageProperty(image,"filter:brightness:kurtosis",text);
1397     if (brightness_standard_deviation != 0)
1398       brightness_skewness=(brightness_sum_x3/area-3.0*brightness_mean*
1399         brightness_sum_x2/area+2.0*brightness_mean*brightness_mean*
1400         brightness_mean)/(brightness_standard_deviation*
1401         brightness_standard_deviation*brightness_standard_deviation);
1402     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_skewness);
1403     (void) SetImageProperty(image,"filter:brightness:skewness",text);
1404     saturation_mean=saturation_sum_x/area;
1405     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_mean);
1406     (void) SetImageProperty(image,"filter:saturation:mean",text);
1407     saturation_standard_deviation=sqrt(saturation_sum_x2/area-(saturation_sum_x/
1408       area*saturation_sum_x/area));
1409     (void) FormatMagickString(text,MaxTextExtent,"%g",
1410       saturation_standard_deviation);
1411     (void) SetImageProperty(image,"filter:saturation:standard-deviation",text);
1412     if (saturation_standard_deviation != 0)
1413       saturation_kurtosis=(saturation_sum_x4/area-4.0*saturation_mean*
1414         saturation_sum_x3/area+6.0*saturation_mean*saturation_mean*
1415         saturation_sum_x2/area-3.0*saturation_mean*saturation_mean*
1416         saturation_mean*saturation_mean)/(saturation_standard_deviation*
1417         saturation_standard_deviation*saturation_standard_deviation*
1418         saturation_standard_deviation)-3.0;
1419     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_kurtosis);
1420     (void) SetImageProperty(image,"filter:saturation:kurtosis",text);
1421     if (saturation_standard_deviation != 0)
1422       saturation_skewness=(saturation_sum_x3/area-3.0*saturation_mean*
1423         saturation_sum_x2/area+2.0*saturation_mean*saturation_mean*
1424         saturation_mean)/(saturation_standard_deviation*
1425         saturation_standard_deviation*saturation_standard_deviation);
1426     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_skewness);
1427     (void) SetImageProperty(image,"filter:saturation:skewness",text);
1428   }
1429   return(MagickImageFilterSignature);
1430 }
1431 </div>
1432
1433 <p>To invoke the custom filter from the command line, use this command:</p>
1434
1435 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>convert logo: -process "analyze" -verbose info:</span><span class='crtout'>Image: logo: <br/>
1436     Format: LOGO (ImageMagick Logo)  <br/>
1437     Class: PseudoClass  <br/>
1438     Geometry: 640x480  <br/>
1439     ...  <br/>
1440     filter:brightness:kurtosis: 8.17947 <br/>
1441     filter:brightness:mean: 60632.1 <br/>
1442     filter:brightness:skewness: -2.97118 <br/>
1443     filter:brightness:standard-deviation: 13742.1 <br/>
1444     filter:saturation:kurtosis: 4.33554 <br/>
1445     filter:saturation:mean: 5951.55 <br/>
1446     filter:saturation:skewness: 2.42848 <br/>
1447     filter:saturation:standard-deviation: 15575.9</span></p>
1448
1449 <p>We provide the <a href="ftp://ftp.imagemagick.org/pub/ImageMagick/kits/MagickFilterKit-1.0.0.tar.gz">Magick Filter Kit</a> to help you get started writing your own custom image filter.</p>
1450
1451 </div>
1452 \r
1453 </div>\r
1454 \r
1455 <div id="linkbar">\r
1456     <span id="linkbar-west">&nbsp;</span>\r
1457     <span id="linkbar-center">\r
1458       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
1459       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
1460     </span>\r
1461     <span id="linkbar-east">&nbsp;</span>\r
1462   </div>\r
1463   <div class="footer">\r
1464     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
1465     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
1466   </div>\r
1467   <div style="clear: both; margin: 0; width: 100%; "></div>\r
1468   <script type="text/javascript">\r
1469     var _gaq = _gaq || [];\r
1470     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
1471     _gaq.push(['_trackPageview']);\r
1472 \r
1473     (function() {\r
1474       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
1475       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
1476       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
1477     })();\r
1478   </script>\r
1479 </body>\r
1480 </html>\r