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

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