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