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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html version="-//W3C//DTD XHTML 1.1//EN"
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   8 <head>
   9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
  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 automagically."/>
  17   <meta name="application-url" content="http://www.imagemagick.org"/>
  18   <meta name="generator" content="PHP"/>
  19   <meta name="keywords" content="architecture, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  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-2013 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="canonical" href="http://www.imagemagick.org" />
  31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  32   <!-- Add jQuery library -->
  33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  34
  35   <!-- Optionaly include easing and/or mousewheel plugins -->
  36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
  38
  39   <!-- Add fancyBox -->
  40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
  42
  43   <!-- Optionaly include button and/or thumbnail helpers -->
  44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
  45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
  46
  47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
  48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
  49   <script type="text/javascript">
  50         $(document).ready(function() {
  51                 $(".fancybox").fancybox();
  52         });
  53   </script>
  54   <!-- ImageMagick style -->
  55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
  56   <style type="text/css" media="all">
  57     @import url("../www/magick.css");
  58   </style>
  59 </head>
  60
  61 <body id="www-imagemagick-org">
  62 <div class="titlebar">
  63 <div style="margin: 17px auto; float: left;">
  64   <script type="text/javascript">
  65   <!--
  66     google_ad_client = "pub-3129977114552745";
  67     google_ad_slot = "5439289906";
  68     google_ad_width = 728;
  69     google_ad_height = 90;
  70   //-->
  71   </script>
  72   <script type="text/javascript"
  73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  74   </script>
  75 </div>
  76 <a href="../discourse-server">
  77   <img src="../images/logo.jpg"
  78   alt="ImageMagick Logo"
  79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  80 <a href="../index.html">
  81   <img src="../images/sprite.jpg"
  82   alt="ImageMagick Sprite"
  83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  84 </div>
  85
  86 <div class="westbar">
  87
  88 <div class="menu">
  89   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  90 </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
 105 </div>
 106 <div class="sep"></div>
 107 <div class="menu">
 108   <a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
 112 </div>
 113 <div class="sub">
 114     <a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 118 </div>
 119 <div class="menu">
 120   <a title="Program Interfaces" href="api.html">Program Interfaces</a>
 121 </div>
 122 <div class="sub">
 123     <a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
 124 </div>
 125 <div class="sub">
 126     <a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
 133 </div>
 134 <div class="sep"></div>
 135 <div  class="menu">
 136    <a title="Install from Source" href="install-source.html">Install from Source</a>
 137 </div>
 138 <div class="sub">
 139     <a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
 140 </div>
 141 <div class="sub">
 142     <a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
 143  </div>
 144 <div class="menu">
 145   <a title="Resources" href="resources.html">Resources</a>
 146 </div>
 147 <div class="menu">
 148   <a title="Architecture" href="architecture.html">Architecture</a>
 149 </div>
 150 <div class="menu">
 151   <a title="Download" href="download.html">Download</a>
 152 </div>
 153 <div class="sep"></div>
 154 <div class="menu">
 155   <a title="Search" href="search.html">Search</a>
 156 </div>
 157 <div class="sep"></div>
 158 <div class="menu">
 159   <a title="Site Map" href="sitemap.html">Site Map</a>
 160 </div>
 161 <div  class="sub">
 162   <a title="Site Map: Links" href="links.html">Links</a>
 163 </div>
 164 <div class="sep"></div>
 165 <div class="menu">
 166   <a rel="follow" title="Sponsors" href="sponsors.html">Sponsors:</a>
 167
 168   <a href="http://www.networkredux.com"> <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 170 <div class="sponsbox">
 171 <div class="sponsor">
 172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 173 </div>
 174 <div class="sponsor">
 175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 176 </div>
 177 <div class="sponsor">
 178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 179 </div>
 180 <div class="sponsor">
 181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 182 </div>
 183 <div class="sponsor">
 184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 185 </div>
 186 <div class="sponsor">
 187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 188 </div>
 189 <div class="sponsor">
 190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 191 </div>
 192 <div class="sponsor">
 193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 194 </div>
 195 <div class="sponsor">
 196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 197 </div>
 198 <div class="sponsor">
 199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 200 </div>
 201 <div class="sponsor">
 202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 203 </div>
 204 <div class="sponsor">
 205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 206 </div>
 207 <div class="sponsor">
 208    <a rel="follow" title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 209 </div>
 210 <div class="sponsor">
 211    <a rel="follow" title="Sponsor: Fototapete - Tapetendruck" href="http://www.druck-expert.com/Fototapete-Tapetendruck,category,8830.html">Fototapete - Tapetendruck</a><!-- 2012100100155 info@druck-->
 212 </div>
 213 </div>
 214 </div>
 215 </div>
 216
 217 <div class="eastbar">
 218   <div class="g-plusone" id="gplusone"></div>
 219   <script type="text/javascript">
 220     window.___gcfg = {
 221       lang: 'en-US'
 222     };
 223
 224     (function() {
 225       var po = document.createElement('script');
 226       po.type = 'text/javascript'; po.async = true;
 227       po.src = 'https://apis.google.com/js/plusone.js';
 228       var script = document.getElementsByTagName('script')[0];
 229       script.parentNode.insertBefore(po, script);
 230     })();
 231     var gplusone = document.getElementById("gplusone");
 232     gplusone.setAttribute("data-size","medium");
 233     gplusone.setAttribute("data-count","false");
 234   </script>
 235 </div>
 236
 237 <div class="main">
 238
 239
 240
 241 <h1>The <em>Magick</em> Behind ImageMagick</h1>
 242 <p class="navigation-index">[<a href="architecture.html#overview">Architecture Overview</a> &bull; <a href="architecture.html#cache">The Pixel Cache</a> &bull; <a href="architecture.html#stream">Streaming Pixels</a> &bull; <a href="architecture.html#properties">Image Properties and Profiles</a> &bull; <a href="architecture.html#tera-pixel">Large Image Support</a> &bull; <a href="architecture.html#threads">Threads of Execution</a> &bull; <a href="architecture.html#distributed">Heterogeneous Distributed Processing</a> &bull; <a href="architecture.html#coders">Custom Image Coders</a> &bull; <a href="architecture.html#filters">Custom Image Filters</a>]</p>
 243
 244
 245 <div class="doc-section">
 246 <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>
 247 </div>
 248
 249 <h2><a id="overview"></a>Architecture Overview</h2>
 250 <div class="doc-section">
 251
 252 <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>
 253
 254 <ul>
 255   <li>colorspace (e.g RGB, CMYK, YUV, Lab, etc.)</li>
 256   <li>bit depth (.e.g 1, 4, 8, 12, 16, etc.)</li>
 257   <li>storage format (e.g. unsigned, signed, float, double, etc.)</li>
 258   <li>compression (e.g. uncompressed, RLE, Zip, BZip, etc.)</li>
 259   <li>orientation (i.e. top-to-bottom, right-to-left, etc.),</li>
 260   <li>layout (.e.g. raw, interspersed with opcodes, etc.)</li>
 261 </ul>
 262
 263 <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>
 264
 265 <p>An efficient implementation of an image processing algorithm may require we get or set:</p>
 266
 267 <ul>
 268   <li>one pixel a time (e.g. pixel at location 10,3)</li>
 269   <li>a single scanline (e.g. all pixels from row 4)</li>
 270   <li>a few scanlines at once (e.g. pixel rows 4-7)</li>
 271   <li>a single column or columns of pixels (e.g. all pixels from column 11)</li>
 272   <li>an arbitrary region of pixels from the image (e.g. pixels defined at 10,7 to 10,19)</li>
 273   <li>a pixel in random order (e.g. pixel at 14,15 and 640,480)</li>
 274   <li>pixels from two different images (e.g. pixel at 5,1 from image 1 and pixel at 5,1 from image 2)</li>
 275   <li>pixels outside the boundaries of the image (e.g. pixel at -1,-3)</li>
 276   <li>a pixel component that is unsigned or in a floating-point representation (e.g. 0.17836)</li>
 277   <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>
 278   <li>one or more pixels simultaneously in different threads of execution</li>
 279   <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>
 280 </ul>
 281
 282 <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>
 283
 284 <p>Given the varied image formats and image processing requirements, we implemented the ImageMagick <a href="architecture.html#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="architecture.html#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="architecture.html#virtual-pixels">virtual pixels</a>).</p>
 285
 286 <p>In addition to pixels, images have a plethora of <a href="architecture.html#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>
 287
 288 <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="architecture.html#threads">thread</a> of execution.  In the final sections, we discuss <a href="architecture.html#coders">image coders</a> to read or write a particular image format followed by a few words on creating a <a href="architecture.html#filters">filter</a> to access or update pixels based on your custom requirements.</p>
 289
 290 </div>
 291
 292 <h2><a id="cache"></a>The Pixel Cache</h2>
 293 <div class="doc-section">
 294
 295 <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="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>
 296
 297 <h3>Create the Pixel Cache</h3>
 298 <div class="doc-section">
 299
 300 <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>
 301
 302 <dl>
 303 <dt>Create an image canvas initialized to the background color:</dt>
 304 <dd><p class="code">
 305   image=AllocateImage(image_info);
 306   if (SetImageExtent(image,640,480) == MagickFalse)
 307     { /* an exception was thrown */ }
 308   (void) QueryMagickColor("red",&amp;image-&gt;background_color,&amp;image-&gt;exception);
 309   SetImageBackgroundColor(image);
 310 </p></dd>
 311
 312 <dt>Create an image from a JPEG image on disk:</dt>
 313 <dd><p class="code">
 314   (void) strcpy(image_info-&gt;filename,"image.jpg"):
 315   image=ReadImage(image_info,exception);
 316   if (image == (Image *) NULL)
 317     { /* an exception was thrown */ }
 318 </p></dd>
 319 <dt>Create an image from a memory based image:</dt>
 320 <dd><p class="code">
 321   image=BlobToImage(blob_info,blob,extent,exception);
 322   if (image == (Image *) NULL)
 323     { /* an exception was thrown */ }
 324 </p></dd>
 325 </dl>
 326
 327 <p>In our discussion of the pixel cache, we use the <a href="magick-core.html">MagickCore API</a> to illustrate our points, however, the principles are the same for other program interfaces to ImageMagick.</p>
 328
 329 <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="command-line-options.html#version">&#x2011;version</a> option: </p>
 330
 331 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>identify -version</span><span class='crtout'>Version: ImageMagick 6.7.7-5 2012-05-18 Q16 http://www.imagemagick.org</span></p>
 332 <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>
 333 </div>
 334
 335 <h3><a id="authentic-pixels"></a>Access the Pixel Cache</h3>
 336 <div class="doc-section">
 337
 338 <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>
 339 <ul>
 340   <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>
 341   <li><a href="../www/api/cache.html#GetAuthenticPixels">GetAuthenticPixels()</a> gets pixels that you intend to modify</li>
 342   <li><a href="../www/api/cache.html#QueueAuthenticPixels">QueueAuthenticPixels()</a> queue pixels that you intend to modify</li>
 343   <li><a href="../www/api/cache.html#SyncAuthenticPixels">SyncAuthenticPixels()</a> update the pixel cache with any modified pixels</li>
 344 </ul>
 345
 346 <p>Here is a typical <a href="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>
 347
 348 <div class="viewport">
 349   const PixelPacket
 350     *p;
 351
 352   PixelPacket
 353     *q;
 354
 355   ssize_t
 356     x,
 357     y;
 358
 359   destination=CloneImage(source,source->columns,source->rows,MagickTrue,
 360     exception);
 361   if (destination  == (Image *) NULL)
 362     { /* an exception was thrown */ }
 363   for (y=0; y &lt; (ssize_t) source-&gt;rows; y++)
 364   {
 365     p=GetVirtualPixels(source,0,y,source-&gt;columns,1,exception);
 366     q=GetAuthenticPixels(destination,0,y,destination-&gt;columns,1,exception);
 367     if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL)
 368       break;
 369     for (x=0; x &lt; (ssize_t) source-&gt;columns; x++)
 370     {
 371       SetPixelRed(q,90*p-&gt;red/100);
 372       SetPixelGreen(q,90*p-&gt;green/100);
 373       SetPixelBlue(q,90*p-&gt;blue/100);
 374       SetPixelOpacity(q,90*p-&gt;opacity/100);
 375       p++;
 376       q++;
 377     }
 378     if (SyncAuthenticPixels(destination,exception) == MagickFalse)
 379       break;
 380   }
 381   if (y &lt; (ssize_t) source-&gt;rows)
 382     { /* an exception was thrown */ }
 383 </div>
 384
 385 <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>
 386
 387 <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#GetVirtualIndexQueue">GetVirtualIndexQueue()</a> (to read the indexes) or <a href="../www/api/cache.html#GetAuthenticIndexQueue">GetAuthenticIndexQueue()</a> (to update the indexes) to gain access to this channel.  For example, to print the colormap indexes, use:</p>
 388
 389 <pre class="code">
 390   const IndexPacket
 391     *indexes;
 392
 393   for (y=0; y &lt; (ssize_t) source-&gt;rows; y++)
 394   {
 395     p=GetVirtualPixels(source,0,y,source-&gt;columns,1);
 396     if (p == (const PixelPacket *) NULL)
 397       break;
 398     indexes=GetVirtualIndexQueue(source);
 399     for (x=0; x &lt; (ssize_t) source-&gt;columns; x++)
 400       (void) printf("%d\n",GetPixelIndex(indexes+x));
 401   }
 402   if (y &lt; (ssize_t) source-&gt;rows)
 403     /* an exception was thrown */
 404 </pre>
 405
 406 <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>
 407
 408 <pre class="code">
 409   p=GetVirtualPixels(source,-3,-3,source-&gt;columns+3,6,exception);
 410 </pre>
 411
 412 <p>gives you the pixels you asked for without complaint, even though some are not within the confines of the image region.</p>
 413 </div>
 414
 415 <h3><a id="virtual-pixels"></a>Virtual Pixels</h3>
 416 <div class="doc-section">
 417
 418 <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>
 419  <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="command-line-options.html#virtual-pixel">&#x2011;virtual&#x2011;pixel</a> option from the command line.  The methods include:</p>
 420
 421 <pre class="text" style="font-size: 83.3333%;">
 422   background:           the area surrounding the image is the background color
 423   black:                the area surrounding the image is black
 424   checker-tile:         alternate squares with image and background color
 425   dither:               non-random 32x32 dithered pattern
 426   edge:                 extend the edge pixel toward infinity (default)
 427   gray:                 the area surrounding the image is gray
 428   horizontal-tile:      horizontally tile the image, background color above/below
 429   horizontal-tile-edge: horizontally tile the image and replicate the side edge pixels
 430   mirror:               mirror tile the image
 431   random:               choose a random pixel from the image
 432   tile:                 tile the image
 433   transparent:          the area surrounding the image is transparent blackness
 434   vertical-tile:        vertically tile the image, sides are background color
 435   vertical-tile-edge:   vertically tile the image and replicate the side edge pixels
 436   white:                the area surrounding the image is white
 437 </pre>
 438
 439 </div>
 440
 441 <h3>Cache Storage and Resource Requirements</h3>
 442 <div class="doc-section">
 443
 444 <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>
 445
 446 <dl class="doc">
 447   <dt class="doc">files</dt>
 448   <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>
 449   <dt class="doc">area</dt>
 450   <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 and optionally memory-mapped.</dd>
 451   <dt class="doc">memory</dt>
 452   <dd>maximum amount of memory in bytes to allocate for the pixel cache from the anonymous mapped memory or the heap.</dd>
 453   <dt class="doc">map</dt>
 454   <dd>maximum amount of memory map in bytes to allocate for the pixel cache.</dd>
 455   <dt class="doc">disk</dt>
 456   <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>
 457   <dt class="doc">thread</dt>
 458   <dd>maximum number of threads that are permitted to run in parallel.</dd>
 459   <dt class="doc">time</dt>
 460   <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>
 461 </dl>
 462
 463 <p>To determine the current setting of these limits, use this command:</p>
 464
 465 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>identify -list resource</span></p><pre class="text">
 466 File         Area       Memory          Map         Disk    Thread         Time
 467 -------------------------------------------------------------------------------
 468  768     1.0386GB    3.8692GiB    7.7384GiB    unlimited         4    unlimited
 469 </pre>
 470
 471 <p>You can set these limits either as a <a href="resources.html#configure">policy</a> (see <a href="../www/source/policy.xml">policy.xml</a>), with an <a href="resources.html#environment">environment variable</a>, with the <a href="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>
 472
 473 <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>
 474 </div>
 475
 476 <h3>Cache Views</h3>
 477 <div class="doc-section">
 478
 479 <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>
 480
 481 <pre class="code">
 482   CacheView
 483     *view_1,
 484     *view_2;
 485
 486   view_1=AcquireCacheView(source);
 487   view_2=AcquireCacheView(source);
 488   for (y=0; y &lt; (ssize_t) source-&gt;rows; y++)
 489   {
 490     u=GetCacheViewVirtualPixels(view_1,0,y,source-&gt;columns,1,exception);
 491     v=GetCacheViewVirtualPixels(view_2,0,source-&gt;rows-y-1,source-&gt;columns,1,
 492       exception);
 493     if ((u == (const PixelPacket *) NULL) || (v == (const PixelPacket *) NULL))
 494       break;
 495     for (x=0; x &lt; (ssize_t) source-&gt;columns; x++)
 496     {
 497       /* do something with u &amp; v here */
 498     }
 499   }
 500   view_2=DestroyCacheView(view_2);
 501   view_1=DestroyCacheView(view_1);
 502   if (y &lt; (ssize_t) source-&gt;rows)
 503     { /* an exception was thrown */ }
 504 </pre>
 505 </div>
 506
 507 <h3>Magick Persistent Cache Format</h3>
 508 <div class="doc-section">
 509
 510 <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>
 511 <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>
 512 </div>
 513
 514 <h3>Best Practices</h3>
 515 <div class="doc-section">
 516
 517 <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 performance boost if you access scanlines from the first row of the image to the last, in sequentual order.</p>
 518
 519 <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>
 520
 521 <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>
 522
 523 <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="architecture.html#threads">thread of execution</a> is accessing the image.</p>
 524
 525 <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>
 526
 527 <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>
 528
 529 <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>
 530
 531 <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="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>
 532
 533 <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>
 534
 535 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>export MAGICK_TEMPORARY_PATH=/data/magick</span></p>
 536
 537 <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>
 538
 539 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.tif image.mpc</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>convert image.mpc -crop 100x100+0+0 +repage 1.png</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>convert image.mpc -crop 100x100+100+0 +repage 2.png</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>convert image.mpc -crop 100x100+200+0 +repage 3.png</span></p>
 540 <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>
 541 </div>
 542
 543 </div>
 544
 545 <h2><a id="stream"></a>Streaming Pixels</h2>
 546 <div class="doc-section">
 547
 548 <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>
 549
 550 <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>
 551
 552 <pre class="code">
 553 static size_t StreamPixels(const Image *image,const void *pixels,
 554   const size_t columns)
 555 {
 556   register const PixelPacket
 557     *p;
 558
 559   MyData
 560     *my_data;
 561
 562   my_data=(MyData *) image->client_data;
 563   p=(PixelPacket *) pixels;
 564   if (p != (const PixelPacket *) NULL)
 565     {
 566       /* process pixels here */
 567     }
 568   return(columns);
 569 }
 570
 571 ...
 572 /* invoke the pixel stream here */
 573 image_info->client_data=(void *) MyData;
 574 image=ReadStream(image_info,&amp;StreamPixels,exception);
 575 </pre>
 576
 577 <p>We also provide a lightweight tool, <a href="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="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>
 578
 579 </div>
 580
 581 <h2><a id="properties"></a>Image Properties and Profiles</h2>
 582 <div class="doc-section">
 583
 584 <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>
 585
 586 <pre class="code">
 587   (void) printf("image width: %lu, height: %lu\n",image-&gt;columns,image-&gt;rows);
 588 </pre>
 589
 590 <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>
 591
 592 <pre class="code">
 593   const char
 594     *comment;
 595
 596   (void) SetImageProperty(image,"comment","This space for rent");
 597   comment=GetImageProperty(image,"comment");
 598   if (comment == (const char *) NULL)
 599     (void) printf("Image comment: %s\n",comment);
 600 </pre>
 601
 602 <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>
 603
 604 <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>
 605
 606 <pre class="code">
 607   StringInfo
 608     *profile;
 609
 610   profile=AcquireStringInfo(length);
 611   SetStringInfoDatum(profile,my_exif_profile);
 612   (void) SetImageProfile(image,"EXIF",profile);
 613   DestroyStringInfo(profile);
 614   profile=GetImageProfile(image,"EXIF");
 615   if (profile != (StringInfo *) NULL)
 616     (void) PrintStringInfo(stdout,"EXIF",profile);
 617 </pre>
 618
 619 </div>
 620
 621 <h2><a id="tera-pixel"></a>Large Image Support</h2>
 622 <div class="doc-section">
 623 <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>
 624
 625 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert logo: -resize 250000x250000 logo.miff</span></p>
 626 <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>
 627
 628 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -define registry:temporary-path=/data/tmp logo:  \ <br/>     -resize 250000x250000 logo.miff</span></p>
 629 <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>
 630
 631 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -define registry:temporary-path=/data/tmp -limit memory 16mb  \ <br/>     logo: -resize 250000x250000 logo.miff</span></p>
 632 <p>Here we force all image pixels to disk:</p>
 633
 634 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -define registry:temporary-path=/data/tmp -limit area 0  \ <br/>     logo: -resize 250000x250000 logo.miff</span></p>
 635 <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>
 636
 637 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert -monitor -define registry:temporary-path=/data/tmp -limit area 0  \ <br/>     logo: -resize 250000x250000 logo.miff</span></p></div>
 638
 639 <h2><a id="threads"></a>Threads of Execution</h2>
 640 <div class="doc-section">
 641
 642 <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="magick-wand.html">MagickWand API</a>, are completely thread safe so there are no special precautions for threads of execution.</p>
 643
 644 <p>Here is an MagickCore code snippet that takes advantage of threads of execution with the <a href="parallel.html">OpenMP</a> programming paradigm:</p>
 645
 646 <div class="viewport">
 647 {
 648   CacheView
 649     *image_view;
 650
 651   MagickBooleanType
 652     status;
 653
 654   ssize_t
 655     y;
 656
 657   status=MagickTrue;
 658   image_view=AcquireCacheView(image);
 659   #pragma omp parallel for schedule(dynamic,4) shared(status)
 660   for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
 661   {
 662     register IndexPacket
 663       *indexes;
 664
 665     register PixelPacket
 666       *q;
 667
 668     register ssize_t
 669       x;
 670
 671     if (status == MagickFalse)
 672       continue;
 673     q=GetCacheViewAuthenticPixels(image_view,0,y,image-&gt;columns,1,exception);
 674     if (q == (PixelPacket *) NULL)
 675       {
 676         status=MagickFalse;
 677         continue;
 678       }
 679     indexes=GetCacheViewAuthenticIndexQueue(image_view);
 680     for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
 681     {
 682       SetPixelRed(q,...);
 683       SetPixelGreen(q,...);
 684       SetPixelBlue(q,...);
 685       SetPixelOpacity(q,...);
 686       if (indexes != (IndexPacket *) NULL)
 687         SetPixelIndex(indexes+x,...);
 688       q++;
 689     }
 690     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
 691       status=MagickFalse;
 692   }
 693   image_view=DestroyCacheView(image_view);
 694   if (status == MagickFalse)
 695     perror("something went wrong");
 696 }
 697 </div>
 698 <p>This code snippet converts an uncompressed Windows bitmap to a Magick++ image:</p>
 699 <div class="viewport">
 700 #include "Magick++.h"
 701 #include &lt;assert.h&gt;
 702 #include "omp.h"
 703
 704 void ConvertBMPToImage(const BITMAPINFOHEADER *bmp_info,
 705   const unsigned char *restrict pixels,Magick::Image *image)
 706 {
 707   /*
 708     Prepare the image so that we can modify the pixels directly.
 709   */
 710   assert(bmp_info->biCompression == BI_RGB);
 711   assert(bmp_info->biWidth == image->columns());
 712   assert(abs(bmp_info->biHeight) == image->rows());
 713   image->modifyImage();
 714   if (bmp_info->biBitCount == 24)
 715     image->type(MagickCore::TrueColorType);
 716   else
 717     image->type(MagickCore::TrueColorMatteType);
 718   register unsigned int bytes_per_row=bmp_info->biWidth*bmp_info->biBitCount/8;
 719   if (bytes_per_row % 4 != 0) {
 720     bytes_per_row=bytes_per_row+(4-bytes_per_row % 4);  // divisible by 4.
 721   }
 722   /*
 723     Copy all pixel data, row by row.
 724   */
 725   #pragma omp parallel for
 726   for (int y=0; y &lt; int(image->rows()); y++)
 727   {
 728     int
 729       row;
 730
 731     register const unsigned char
 732       *restrict p;
 733
 734     register MagickCore::PixelPacket
 735       *restrict q;
 736
 737     row=(bmp_info->biHeight > 0) ? (image->rows()-y-1) : y;
 738     p=pixels+row*bytes_per_row;
 739     q=image->setPixels(0,y,image->columns(),1);
 740     for (int x=0; x &lt; int(image->columns()); x++)
 741     {
 742       SetPixelBlue(q,p[0]);
 743       SetPixelGreen(q,p[1]);
 744       SetPixelRed(q,p[2]);
 745       if (bmp_info->biBitCount == 32) {
 746         SetPixelOpacity(q,p[3]);
 747       }
 748       q++;
 749       p+=bmp_info->biBitCount/8;
 750     }
 751     image->syncPixels();  // sync pixels to pixel cache.
 752   }
 753   return;
 754 }
 755 </div>
 756
 757 <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>
 758
 759 <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="magick-wand.html#wand-view">MagickWand</a> and <a href="magick-core.html#image-view">MagickCore</a>.</p>
 760
 761 <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="resources.html#configure">policy</a> or the <a href="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>
 762
 763 <pre class="text">
 764   &lt;policy domain="resource" name="thread" value="2"/>
 765 </pre>
 766
 767 <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>
 768
 769 <pre class="text">
 770   export MAGICK_THREAD_LIMIT=12
 771 </pre>
 772
 773 <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>
 774
 775 <h4>Threading Performance</h4>
 776 <p>It can be difficult to predict behavior in a parallel environment.   Performance might depend on a number of factors including the compiler, the version of the OpenMP library, the processor type, the number of cores, the amount of memory, whether hyperthreading is enabled, the mix of applications that are executing concurrently with ImageMagick, or the particular image-processing algorithm you utilize.  The only way to be certain of optimal performance, in terms of the number of threads, is to benchmark.   ImageMagick includes progressive threading when benchmarking a command and returns the elapsed time and efficiency for one or more threads.  This can help you identify how many threads is the most efficient in your environment.  Here is an example benchmark for threads 1-8:</p>
 777 <pre class="text">
 778 convert -bench 40 model.png -sharpen 0x1 null:
 779 Performance[1]: 10i 0.712ips 1.000e 14.000u 0:14.040
 780 Performance[2]: 10i 1.362ips 0.657e 14.550u 0:07.340
 781 Performance[3]: 10i 2.033ips 0.741e 14.530u 0:04.920
 782 Performance[4]: 10i 2.667ips 0.789e 14.590u 0:03.750
 783 Performance[5]: 10i 3.236ips 0.820e 14.970u 0:03.090
 784 Performance[6]: 10i 3.802ips 0.842e 15.280u 0:02.630
 785 Performance[7]: 10i 4.274ips 0.857e 15.540u 0:02.340
 786 Performance[8]: 10i 4.831ips 0.872e 15.680u 0:02.070
 787 </pre>
 788 <p>In certain cases, it might be optimal to set the number of threads to 1 or to disable OpenMP completely.</p>
 789 </div>
 790
 791 <h2><a id="distributed"></a>Heterogeneous Distributed Processing</h2>
 792 <div class="doc-section">
 793 <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>
 794
 795 <p>First verify that your version of ImageMagick includes support for the OpenCL feature:</p>
 796
 797 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>identify -version</span><span class='crtout'>Features: OpenMP OpenCL</span></p>
 798 <p>If so, run this command to realize a significant speed-up for image convolution:</p>
 799
 800 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert image.png -convolve '-1, -1, -1, -1, 9, -1, -1, -1, -1'  \ <br/> convolve.png</span></p>
 801 <p>If an accelerator is not available or if the accelerator fails to respond, ImageMagick reverts to the non-accelerated convolution algorithm.</p>
 802
 803 <p>Here is an example OpenCL kernel that convolves an image:</p>
 804
 805 <div class="viewport">
 806 static inline long ClampToCanvas(const long offset,const ulong range)
 807 {
 808   if (offset &lt; 0L)
 809     return(0L);
 810   if (offset >= range)
 811     return((long) (range-1L));
 812   return(offset);
 813 }
 814
 815 static inline CLQuantum ClampToQuantum(const float value)
 816 {
 817   if (value &lt; 0.0)
 818     return((CLQuantum) 0);
 819   if (value >= (float) QuantumRange)
 820     return((CLQuantum) QuantumRange);
 821   return((CLQuantum) (value+0.5));
 822 }
 823
 824 __kernel void Convolve(const __global CLPixelType *source,__constant float *filter,
 825   const ulong width,const ulong height,__global CLPixelType *destination)
 826 {
 827   const ulong columns = get_global_size(0);
 828   const ulong rows = get_global_size(1);
 829
 830   const long x = get_global_id(0);
 831   const long y = get_global_id(1);
 832
 833   const float scale = (1.0/QuantumRange);
 834   const long mid_width = (width-1)/2;
 835   const long mid_height = (height-1)/2;
 836   float4 sum = { 0.0, 0.0, 0.0, 0.0 };
 837   float gamma = 0.0;
 838   register ulong i = 0;
 839
 840   for (long v=(-mid_height); v &lt;= mid_height; v++)
 841   {
 842     for (long u=(-mid_width); u &lt;= mid_width; u++)
 843     {
 844       register const ulong index=ClampToCanvas(y+v,rows)*columns+ClampToCanvas(x+u,
 845         columns);
 846       const float alpha=scale*(QuantumRange-source[index].w);
 847       sum.x+=alpha*filter[i]*source[index].x;
 848       sum.y+=alpha*filter[i]*source[index].y;
 849       sum.z+=alpha*filter[i]*source[index].z;
 850       sum.w+=filter[i]*source[index].w;
 851       gamma+=alpha*filter[i];
 852       i++;
 853     }
 854   }
 855
 856   gamma=1.0/(fabs(gamma) &lt;= MagickEpsilon ? 1.0 : gamma);
 857   const ulong index=y*columns+x;
 858   destination[index].x=ClampToQuantum(gamma*sum.x);
 859   destination[index].y=ClampToQuantum(gamma*sum.y);
 860   destination[index].z=ClampToQuantum(gamma*sum.z);
 861   destination[index].w=ClampToQuantum(sum.w);
 862 };
 863 </div>
 864
 865 <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>
 866
 867 </div>
 868
 869 <h2><a id="coders"></a>Custom Image Coders</h2>
 870 <div class="doc-section">
 871
 872 <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>
 873
 874 <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>
 875
 876 <div class="viewport">
 877 /*
 878   Include declarations.
 879 */
 880 #include "magick/studio.h"
 881 #include "magick/blob.h"
 882 #include "magick/blob-private.h"
 883 #include "magick/colorspace.h"
 884 #include "magick/exception.h"
 885 #include "magick/exception-private.h"
 886 #include "magick/image.h"
 887 #include "magick/image-private.h"
 888 #include "magick/list.h"
 889 #include "magick/magick.h"
 890 #include "magick/memory_.h"
 891 #include "magick/monitor.h"
 892 #include "magick/monitor-private.h"
 893 #include "magick/quantum-private.h"
 894 #include "magick/static.h"
 895 #include "magick/string_.h"
 896 #include "magick/module.h"
 897
 898 /*
 899   Forward declarations.
 900 */
 901 static MagickBooleanType
 902   WriteMGKImage(const ImageInfo *,Image *);
 903
 904 /*
 905 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 906 %                                                                             %
 907 %                                                                             %
 908 %                                                                             %
 909 %   I s M G K                                                                 %
 910 %                                                                             %
 911 %                                                                             %
 912 %                                                                             %
 913 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 914 %
 915 %  IsMGK() returns MagickTrue if the image format type, identified by the
 916 %  magick string, is MGK.
 917 %
 918 %  The format of the IsMGK method is:
 919 %
 920 %      MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)
 921 %
 922 %  A description of each parameter follows:
 923 %
 924 %    o magick: This string is generally the first few bytes of an image file
 925 %      or blob.
 926 %
 927 %    o length: Specifies the length of the magick string.
 928 %
 929 */
 930 static MagickBooleanType IsMGK(const unsigned char *magick,const size_t length)
 931 {
 932   if (length &lt; 7)
 933     return(MagickFalse);
 934   if (LocaleNCompare((char *) magick,"id=mgk",7) == 0)
 935     return(MagickTrue);
 936   return(MagickFalse);
 937 }
 938
 939 /*
 940 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 941 %                                                                             %
 942 %                                                                             %
 943 %                                                                             %
 944 %   R e a d M G K I m a g e                                                   %
 945 %                                                                             %
 946 %                                                                             %
 947 %                                                                             %
 948 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 949 %
 950 %  ReadMGKImage() reads a MGK image file and returns it.  It allocates
 951 %  the memory necessary for the new Image structure and returns a pointer to
 952 %  the new image.
 953 %
 954 %  The format of the ReadMGKImage method is:
 955 %
 956 %      Image *ReadMGKImage(const ImageInfo *image_info,ExceptionInfo *exception)
 957 %
 958 %  A description of each parameter follows:
 959 %
 960 %    o image_info: the image info.
 961 %
 962 %    o exception: return any errors or warnings in this structure.
 963 %
 964 */
 965 static Image *ReadMGKImage(const ImageInfo *image_info,
 966   ExceptionInfo *exception)
 967 {
 968   char
 969     buffer[MaxTextExtent];
 970
 971   Image
 972     *image;
 973
 974   MagickBooleanType
 975     status;
 976
 977   register PixelPacket
 978     *q;
 979
 980   register size_t
 981     x;
 982
 983   register unsigned char
 984     *p;
 985
 986   ssize_t
 987     count,
 988     y;
 989
 990   unsigned char
 991     *pixels;
 992
 993   unsigned long
 994     columns,
 995     rows;
 996
 997   /*
 998     Open image file.
 999   */
1000   assert(image_info != (const ImageInfo *) NULL);
1001   assert(image_info-&gt;signature == MagickSignature);
1002   if (image_info-&gt;debug != MagickFalse)
1003     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image_info-&gt;filename);
1004   assert(exception != (ExceptionInfo *) NULL);
1005   assert(exception-&gt;signature == MagickSignature);
1006   image=AcquireImage(image_info);
1007   status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
1008   if (status == MagickFalse)
1009     {
1010       image=DestroyImageList(image);
1011       return((Image *) NULL);
1012     }
1013   /*
1014     Read MGK image.
1015   */
1016   (void) ReadBlobString(image,buffer);  /* read magic number */
1017   if (IsMGK(buffer,7) == MagickFalse)
1018     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
1019   (void) ReadBlobString(image,buffer);
1020   count=(ssize_t) sscanf(buffer,"%lu %lu\n",&amp;columns,&amp;rows);
1021   if (count &lt;= 0)
1022     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
1023   do
1024   {
1025     /*
1026       Initialize image structure.
1027     */
1028     image-&gt;columns=columns;
1029     image-&gt;rows=rows;
1030     image-&gt;depth=8;
1031     if ((image_info-&gt;ping != MagickFalse) &amp;&amp; (image_info-&gt;number_scenes != 0))
1032       if (image-&gt;scene >= (image_info-&gt;scene+image_info-&gt;number_scenes-1))
1033         break;
1034     /*
1035       Convert MGK raster image to pixel packets.
1036     */
1037     if (SetImageExtent(image,0,0) == MagickFalse)
1038       {
1039         InheritException(exception,&amp;image-&gt;exception);
1040         return(DestroyImageList(image));
1041       }
1042     pixels=(unsigned char *) AcquireQuantumMemory((size_t) image-&gt;columns,3UL*sizeof(*pixels));
1043     if (pixels == (unsigned char *) NULL)
1044       ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
1045     for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
1046     {
1047       count=(ssize_t) ReadBlob(image,(size_t) (3*image-&gt;columns),pixels);
1048       if (count != (ssize_t) (3*image-&gt;columns))
1049         ThrowReaderException(CorruptImageError,"UnableToReadImageData");
1050       p=pixels;
1051       q=QueueAuthenticPixels(image,0,y,image-&gt;columns,1,exception);
1052       if (q == (PixelPacket *) NULL)
1053         break;
1054       for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
1055       {
1056         SetPixelRed(q,ScaleCharToQuantum(*p++));
1057         SetPixelGreen(q,ScaleCharToQuantum(*p++));
1058         SetPixelBlue(q,ScaleCharToQuantum(*p++));
1059         q++;
1060       }
1061       if (SyncAuthenticPixels(image,exception) == MagickFalse)
1062         break;
1063       if ((image-&gt;previous == (Image *) NULL) &amp;&amp;
1064           (SetImageProgress(image,LoadImageTag,y,image&gt;>rows) == MagickFalse))
1065         break;
1066     }
1067     pixels=(unsigned char *) RelinquishMagickMemory(pixels);
1068     if (EOFBlob(image) != MagickFalse)
1069       {
1070         ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",image-&gt;filename);
1071         break;
1072       }
1073     /*
1074       Proceed to next image.
1075     */
1076     if (image_info-&gt;number_scenes != 0)
1077       if (image-&gt;scene >= (image_info-&gt;scene+image_info-&gt;number_scenes-1))
1078         break;
1079     *buffer='\0';
1080     (void) ReadBlobString(image,buffer);
1081     count=(ssize_t) sscanf(buffer,"%lu %lu\n",&amp;columns,&amp;rows);
1082     if (count != 0)
1083       {
1084         /*
1085           Allocate next image structure.
1086         */
1087         AcquireNextImage(image_info,image);
1088         if (GetNextImageInList(image) == (Image *) NULL)
1089           {
1090             image=DestroyImageList(image);
1091             return((Image *) NULL);
1092           }
1093         image=SyncNextImageInList(image);
1094         status=SetImageProgress(image,LoadImageTag,TellBlob(image),GetBlobSize(image));
1095         if (status == MagickFalse)
1096           break;
1097       }
1098   } while (count != 0);
1099   (void) CloseBlob(image);
1100   return(GetFirstImageInList(image));
1101 }
1102
1103 /*
1104 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1105 %                                                                             %
1106 %                                                                             %
1107 %                                                                             %
1108 %   R e g i s t e r M G K I m a g e                                           %
1109 %                                                                             %
1110 %                                                                             %
1111 %                                                                             %
1112 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1113 %
1114 %  RegisterMGKImage() adds attributes for the MGK image format to
1115 %  the list of supported formats.  The attributes include the image format
1116 %  tag, a method to read and/or write the format, whether the format
1117 %  supports the saving of more than one frame to the same file or blob,
1118 %  whether the format supports native in-memory I/O, and a brief
1119 %  description of the format.
1120 %
1121 %  The format of the RegisterMGKImage method is:
1122 %
1123 %      unsigned long RegisterMGKImage(void)
1124 %
1125 */
1126 ModuleExport unsigned long RegisterMGKImage(void)
1127 {
1128   MagickInfo
1129     *entry;
1130
1131   entry=SetMagickInfo("MGK");
1132   entry-&gt;decoder=(DecodeImageHandler *) ReadMGKImage;
1133   entry-&gt;encoder=(EncodeImageHandler *) WriteMGKImage;
1134   entry-&gt;magick=(IsImageFormatHandler *) IsMGK;
1135   entry-&gt;description=ConstantString("MGK");
1136   entry-&gt;module=ConstantString("MGK");
1137   (void) RegisterMagickInfo(entry);
1138   return(MagickImageCoderSignature);
1139 }
1140
1141 /*
1142 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1143 %                                                                             %
1144 %                                                                             %
1145 %                                                                             %
1146 %   U n r e g i s t e r M G K I m a g e                                       %
1147 %                                                                             %
1148 %                                                                             %
1149 %                                                                             %
1150 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1151 %
1152 %  UnregisterMGKImage() removes format registrations made by the
1153 %  MGK module from the list of supported formats.
1154 %
1155 %  The format of the UnregisterMGKImage method is:
1156 %
1157 %      UnregisterMGKImage(void)
1158 %
1159 */
1160 ModuleExport void UnregisterMGKImage(void)
1161 {
1162   (void) UnregisterMagickInfo("MGK");
1163 }
1164
1165 /*
1166 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1167 %                                                                             %
1168 %                                                                             %
1169 %                                                                             %
1170 %   W r i t e M G K I m a g e                                                 %
1171 %                                                                             %
1172 %                                                                             %
1173 %                                                                             %
1174 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1175 %
1176 %  WriteMGKImage() writes an image to a file in red, green, and blue
1177 %  MGK rasterfile format.
1178 %
1179 %  The format of the WriteMGKImage method is:
1180 %
1181 %      MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)
1182 %
1183 %  A description of each parameter follows.
1184 %
1185 %    o image_info: the image info.
1186 %
1187 %    o image:  The image.
1188 %
1189 */
1190 static MagickBooleanType WriteMGKImage(const ImageInfo *image_info,Image *image)
1191 {
1192   char
1193     buffer[MaxTextExtent];
1194
1195   MagickBooleanType
1196     status;
1197
1198   MagickOffsetType
1199     scene;
1200
1201   register const PixelPacket
1202     *p;
1203
1204   register ssize_t
1205     x;
1206
1207   register unsigned char
1208     *q;
1209
1210   ssize_t
1211     y;
1212
1213   unsigned char
1214     *pixels;
1215
1216   /*
1217     Open output image file.
1218   */
1219   assert(image_info != (const ImageInfo *) NULL);
1220   assert(image_info-&gt;signature == MagickSignature);
1221   assert(image != (Image *) NULL);
1222   assert(image-&gt;signature == MagickSignature);
1223   if (image-&gt;debug != MagickFalse)
1224     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image-&gt;filename);
1225   status=OpenBlob(image_info,image,WriteBinaryBlobMode,&amp;image-&gt;exception);
1226   if (status == MagickFalse)
1227     return(status);
1228   scene=0;
1229   do
1230   {
1231     /*
1232       Allocate memory for pixels.
1233     */
1234     if (image-&gt;colorspace != RGBColorspace)
1235       (void) SetImageColorspace(image,RGBColorspace);
1236     pixels=(unsigned char *) AcquireQuantumMemory((size_t) image-&gt;columns,
1237       3UL*sizeof(*pixels));
1238     if (pixels == (unsigned char *) NULL)
1239       ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
1240     /*
1241       Initialize raster file header.
1242     */
1243     (void) WriteBlobString(image,"id=mgk\n");
1244     (void) FormatMagickString(buffer,MaxTextExtent,"%lu %lu\n",
1245       image-&gt;columns,image-&gt;rows);
1246     (void) WriteBlobString(image,buffer);
1247     for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
1248     {
1249       p=GetVirtualPixels(image,0,y,image-&gt;columns,1,&amp;image-&gt;exception);
1250       if (p == (const PixelPacket *) NULL)
1251         break;
1252       q=pixels;
1253       for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
1254       {
1255         *q++=ScaleQuantumToChar(GetPixelRed(p));
1256         *q++=ScaleQuantumToChar(GetPixelGreen(p));
1257         *q++=ScaleQuantumToChar(GetPixelBlue(p));
1258         p++;
1259       }
1260       (void) WriteBlob(image,(size_t) (q-pixels),pixels);
1261       if ((image-&gt;previous == (Image *) NULL) &amp;&amp;
1262           (SetImageProgress(image,SaveImageTag,y,image-&gt;rows) == MagickFalse))
1263         break;
1264     }
1265     pixels=(unsigned char *) RelinquishMagickMemory(pixels);
1266     if (GetNextImageInList(image) == (Image *) NULL)
1267       break;
1268     image=SyncNextImageInList(image);
1269     status=SetImageProgress(image,SaveImagesTag,scene,
1270       GetImageListLength(image));
1271     if (status == MagickFalse)
1272       break;
1273     scene++;
1274   } while (image_info-&gt;adjoin != MagickFalse);
1275   (void) CloseBlob(image);
1276   return(MagickTrue);
1277 }
1278 </div>
1279
1280 <p>To invoke the custom coder from the command line, use these commands:</p>
1281
1282 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert logo: logo.mgk</span><span class='crtout'></span><span class="crtprompt"> $ </span><span class='crtin'>display logo.mgk</span></p>
1283 <p>We provide the <a href="http://www.imagemagick.org/download/kits/MagickCoderKit-1.0.0.tar.gz">Magick Coder Kit</a> to help you get started writing your own custom coder.</p>
1284
1285 </div>
1286
1287 <h2><a id="filters"></a>Custom Image Filters</h2>
1288 <div class="doc-section">
1289
1290 <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="command-line-options.html#process">-process</a> option or from the MagickCore API method <a href="../www/api/module.html#ExecuteModuleProcess">ExecuteModuleProcess()</a>.</p>
1291
1292 <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>
1293
1294 <div class="viewport">
1295 #include &lt;stdio.h&gt;
1296 #include &lt;stdlib.h&gt;
1297 #include &lt;string.h&gt;
1298 #include &lt;time.h&gt;
1299 #include &lt;assert.h&gt;
1300 #include &lt;math.h&gt;
1301 #include "magick/MagickCore.h"
1302
1303 /*
1304 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1305 %                                                                             %
1306 %                                                                             %
1307 %                                                                             %
1308 %   a n a l y z e I m a g e                                                   %
1309 %                                                                             %
1310 %                                                                             %
1311 %                                                                             %
1312 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1313 %
1314 %  analyzeImage() computes the brightness and saturation mean,  standard
1315 %  deviation, kurtosis and skewness and stores these values as attributes
1316 %  of the image.
1317 %
1318 %  The format of the analyzeImage method is:
1319 %
1320 %      size_t analyzeImage(Image *images,const int argc,char **argv,
1321 %        ExceptionInfo *exception)
1322 %
1323 %  A description of each parameter follows:
1324 %
1325 %    o image: the address of a structure of type Image.
1326 %
1327 %    o argc: Specifies a pointer to an integer describing the number of
1328 %      elements in the argument vector.
1329 %
1330 %    o argv: Specifies a pointer to a text array containing the command line
1331 %      arguments.
1332 %
1333 %    o exception: return any errors or warnings in this structure.
1334 %
1335 */
1336 ModuleExport size_t analyzeImage(Image **images,const int argc,const char **argv,
1337   ExceptionInfo *exception)
1338 {
1339   char
1340     text[MaxTextExtent];
1341
1342   double
1343     area,
1344     brightness,
1345     brightness_mean,
1346     brightness_standard_deviation,
1347     brightness_kurtosis,
1348     brightness_skewness,
1349     brightness_sum_x,
1350     brightness_sum_x2,
1351     brightness_sum_x3,
1352     brightness_sum_x4,
1353     hue,
1354     saturation,
1355     saturation_mean,
1356     saturation_standard_deviation,
1357     saturation_kurtosis,
1358     saturation_skewness,
1359     saturation_sum_x,
1360     saturation_sum_x2,
1361     saturation_sum_x3,
1362     saturation_sum_x4;
1363
1364   Image
1365     *image;
1366
1367   assert(images != (Image **) NULL);
1368   assert(*images != (Image *) NULL);
1369   assert((*images)-&gt;signature == MagickSignature);
1370   (void) argc;
1371   (void) argv;
1372   image=(*images);
1373   for ( ; image != (Image *) NULL; image=GetNextImageInList(image))
1374   {
1375     CacheView
1376       *image_view;
1377
1378     MagickBooleanType
1379       status;
1380
1381     ssize_t
1382       y;
1383
1384     brightness_sum_x=0.0;
1385     brightness_sum_x2=0.0;
1386     brightness_sum_x3=0.0;
1387     brightness_sum_x4=0.0;
1388     brightness_mean=0.0;
1389     brightness_standard_deviation=0.0;
1390     brightness_kurtosis=0.0;
1391     brightness_skewness=0.0;
1392     saturation_sum_x=0.0;
1393     saturation_sum_x2=0.0;
1394     saturation_sum_x3=0.0;
1395     saturation_sum_x4=0.0;
1396     saturation_mean=0.0;
1397     saturation_standard_deviation=0.0;
1398     saturation_kurtosis=0.0;
1399     saturation_skewness=0.0;
1400     area=0.0;
1401     status=MagickTrue;
1402     image_view=AcquireCacheView(image);
1403 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1404     #pragma omp parallel for schedule(dynamic,4) shared(status)
1405 #endif
1406     for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
1407     {
1408       register const PixelPacket
1409         *p;
1410
1411       register ssize_t
1412         x;
1413
1414       if (status == MagickFalse)
1415         continue;
1416       p=GetCacheViewVirtualPixels(image_view,0,y,image-&gt;columns,1,exception);
1417       if (p == (const PixelPacket *) NULL)
1418         {
1419           status=MagickFalse;
1420           continue;
1421         }
1422       for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
1423       {
1424         ConvertRGBToHSB(GetPixelRed(p),GetPixelGreen(p),GetPixelBue(p),&amp;hue,&amp;saturation,&amp;brightness);
1425         brightness*=QuantumRange;
1426         brightness_sum_x+=brightness;
1427         brightness_sum_x2+=brightness*brightness;
1428         brightness_sum_x3+=brightness*brightness*brightness;
1429         brightness_sum_x4+=brightness*brightness*brightness*brightness;
1430         saturation*=QuantumRange;
1431         saturation_sum_x+=saturation;
1432         saturation_sum_x2+=saturation*saturation;
1433         saturation_sum_x3+=saturation*saturation*saturation;
1434         saturation_sum_x4+=saturation*saturation*saturation*saturation;
1435         area++;
1436         p++;
1437       }
1438     }
1439     image_view=DestroyCacheView(image_view);
1440     if (area &lt;= 0.0)
1441       break;
1442     brightness_mean=brightness_sum_x/area;
1443     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_mean);
1444     (void) SetImageProperty(image,"filter:brightness:mean",text);
1445     brightness_standard_deviation=sqrt(brightness_sum_x2/area-(brightness_sum_x/
1446       area*brightness_sum_x/area));
1447     (void) FormatMagickString(text,MaxTextExtent,"%g",
1448       brightness_standard_deviation);
1449     (void) SetImageProperty(image,"filter:brightness:standard-deviation",text);
1450     if (brightness_standard_deviation != 0)
1451       brightness_kurtosis=(brightness_sum_x4/area-4.0*brightness_mean*
1452         brightness_sum_x3/area+6.0*brightness_mean*brightness_mean*
1453         brightness_sum_x2/area-3.0*brightness_mean*brightness_mean*
1454         brightness_mean*brightness_mean)/(brightness_standard_deviation*
1455         brightness_standard_deviation*brightness_standard_deviation*
1456         brightness_standard_deviation)-3.0;
1457     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_kurtosis);
1458     (void) SetImageProperty(image,"filter:brightness:kurtosis",text);
1459     if (brightness_standard_deviation != 0)
1460       brightness_skewness=(brightness_sum_x3/area-3.0*brightness_mean*
1461         brightness_sum_x2/area+2.0*brightness_mean*brightness_mean*
1462         brightness_mean)/(brightness_standard_deviation*
1463         brightness_standard_deviation*brightness_standard_deviation);
1464     (void) FormatMagickString(text,MaxTextExtent,"%g",brightness_skewness);
1465     (void) SetImageProperty(image,"filter:brightness:skewness",text);
1466     saturation_mean=saturation_sum_x/area;
1467     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_mean);
1468     (void) SetImageProperty(image,"filter:saturation:mean",text);
1469     saturation_standard_deviation=sqrt(saturation_sum_x2/area-(saturation_sum_x/
1470       area*saturation_sum_x/area));
1471     (void) FormatMagickString(text,MaxTextExtent,"%g",
1472       saturation_standard_deviation);
1473     (void) SetImageProperty(image,"filter:saturation:standard-deviation",text);
1474     if (saturation_standard_deviation != 0)
1475       saturation_kurtosis=(saturation_sum_x4/area-4.0*saturation_mean*
1476         saturation_sum_x3/area+6.0*saturation_mean*saturation_mean*
1477         saturation_sum_x2/area-3.0*saturation_mean*saturation_mean*
1478         saturation_mean*saturation_mean)/(saturation_standard_deviation*
1479         saturation_standard_deviation*saturation_standard_deviation*
1480         saturation_standard_deviation)-3.0;
1481     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_kurtosis);
1482     (void) SetImageProperty(image,"filter:saturation:kurtosis",text);
1483     if (saturation_standard_deviation != 0)
1484       saturation_skewness=(saturation_sum_x3/area-3.0*saturation_mean*
1485         saturation_sum_x2/area+2.0*saturation_mean*saturation_mean*
1486         saturation_mean)/(saturation_standard_deviation*
1487         saturation_standard_deviation*saturation_standard_deviation);
1488     (void) FormatMagickString(text,MaxTextExtent,"%g",saturation_skewness);
1489     (void) SetImageProperty(image,"filter:saturation:skewness",text);
1490   }
1491   return(MagickImageFilterSignature);
1492 }
1493 </div>
1494
1495 <p>To invoke the custom filter from the command line, use this command:</p>
1496
1497 <p class='crt'><span class="crtprompt"> $ </span><span class='crtin'>convert logo: -process "analyze" -verbose info:</span><span class='crtout'>Image: logo: <br/>
1498     Format: LOGO (ImageMagick Logo)  <br/>
1499     Class: PseudoClass  <br/>
1500     Geometry: 640x480  <br/>
1501     ...  <br/>
1502     filter:brightness:kurtosis: 8.17947 <br/>
1503     filter:brightness:mean: 60632.1 <br/>
1504     filter:brightness:skewness: -2.97118 <br/>
1505     filter:brightness:standard-deviation: 13742.1 <br/>
1506     filter:saturation:kurtosis: 4.33554 <br/>
1507     filter:saturation:mean: 5951.55 <br/>
1508     filter:saturation:skewness: 2.42848 <br/>
1509     filter:saturation:standard-deviation: 15575.9</span></p>
1510
1511 <p>We provide the <a href="http://www.imagemagick.org/download/kits/MagickFilterKit-1.0.0.tar.gz">Magick Filter Kit</a> to help you get started writing your own custom image filter.</p>
1512
1513 </div>
1514
1515 </div>
1516
1517 <div id="linkbar">
1518     <span id="linkbar-west">&nbsp;</span>
1519     <span id="linkbar-center">
1520       <a href="../discourse-server">Discourse Server</a> &bull;
1521       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
1522     </span>
1523     <span id="linkbar-east">&nbsp;</span>
1524   </div>
1525   <div class="footer">
1526     <span id="footer-west">&copy; 1999-2013 ImageMagick Studio LLC</span>
1527     <span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>
1528   </div>
1529   <div style="clear: both; margin: 0; width: 100%; "></div>
1530   <script type="text/javascript">
1531     var _gaq = _gaq || [];
1532     _gaq.push(['_setAccount', 'UA-17690367-1']);
1533     _gaq.push(['_trackPageview']);
1534
1535     (function() {
1536       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
1537       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
1538       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
1539     })();
1540   </script>
1541 </body>
1542 </html>