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

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