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