Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / d0c5146baf2b7536cea0e846e8a6879d069d9c12 / . / www / porting.html
blob: d4ffe0865996a342bfe92b9d3666eee5655e73cd [file] [log] [blame]
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html version="-//W3C//DTD XHTML 1.1//EN"
5 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
6 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
7 xsi:schemaLocation="http://www.w3.org/1999/xhtml
8 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
9<head>
10 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
11 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
12 <title>ImageMagick: Porting to ImageMagick Version 7</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]17 <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."/>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]18 <meta name="Application-url" content="http://www.imagemagick.org"/>
19 <meta name="Generator" content="PHP"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]20 <meta name="Keywords" content="porting, to, imagemagick, version, 7, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]21 <meta name="Rating" content="GENERAL"/>
22 <meta name="Robots" content="INDEX, FOLLOW"/>
23 <meta name="Generator" content="ImageMagick Studio LLC"/>
24 <meta name="Author" content="ImageMagick Studio LLC"/>
25 <meta name="Revisit-after" content="2 DAYS"/>
26 <meta name="Resource-type" content="document"/>
27 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
28 <meta name="Distribution" content="Global"/>
29 <link rel="icon" href="../images/wand.png"/>
30 <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"/>
31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
32 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
33 <style type="text/css" media="all">
34 @import url("../www/magick.css");
35 </style>
36 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
37 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
38 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
39 <script type="text/javascript">
40 $(document).ready(function() {
41 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
42 'transitionIn' : 'elastic',
43 'transitionOut' : 'elastic',
44 'overlayShow' : false,
45 'opacity' : true
46 });
47 });
48 </script>
49</head>
50
51<body id="www-imagemagick-org">
52<div class="titlebar">
53<div style="margin: 17px auto; float: left;">
54 <script type="text/javascript">
55 <!--
56 google_ad_client = "pub-3129977114552745";
57 google_ad_slot = "5439289906";
58 google_ad_width = 728;
59 google_ad_height = 90;
60 //-->
61 </script>
62 <script type="text/javascript"
63 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
64 </script>
65</div>
66<a href="http://www.imagemagick.org/discourse-server/">
67 <img src="../images/logo.jpg"
68 alt="ImageMagick Logo"
69 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
70<a href="../index.html">
71 <img src="../images/sprite.jpg"
72 alt="ImageMagick Sprite"
73 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
74</div>
75
76<div class="westbar">
77
78<div class="menu">
79 <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
80</div>
81<div class="sep"></div>
82<div class="menu">
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>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]93</div>
94<div class="sub">
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">
99 <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
100</div>
101<div class="sub">
102 <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
103</div>
104<div class="sub">
105 <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
106</div>
107<div class="sub">
108 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
109</div>
110<div class="menu">
111 <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
112</div>
113<div class="sub">
114 <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
115</div>
116<div class="sub">
117 <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
118</div>
119<div class="sub">
120 <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
121</div>
122<div class="sub">
123 <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
124</div>
125<div class="sep"></div>
126<div class="menu">
127 <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
128</div>
129<div class="sub">
130 <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
131</div>
132<div class="sub">
133 <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
134 </div>
135<div class="menu">
136 <a title="Resources" href="../www/resources.html">Resources</a>
137</div>
138<div class="menu">
139 <a title="Architecture" href="../www/architecture.html">Architecture</a>
140</div>
141<div class="menu">
142 <a title="Download" href="../www/download.html">Download</a>
143</div>
144<div class="sep"></div>
145<div class="menu">
146 <a title="Search" href="../www/search.html">Search</a>
147</div>
148<div class="sep"></div>
149<div class="menu">
150 <a title="Site Map" href="../www/sitemap.html">Site Map</a>
151</div>
152<div class="sub">
153 <a title="Site Map: Links" href="../www/links.html">Links</a>
154</div>
155<div class="sep"></div>
156<div class="menu">
157 <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
158
159<a href="http://www.networkredux.com">
160 <img src="../images/networkredux.png" alt="[sponsor]"
161 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
162<div class="sponsbox">
163<div class="sponsor">
cristy81492d62011-06-07 16:41:42 +0000[diff] [blame]164 <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
165</div>
166<div class="sponsor">
167 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
168</div>
169<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]170 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
171</div>
172<div class="sponsor">
173 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
174</div>
175<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]176 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
177</div>
178<div class="sponsor">
179 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
180</div>
181<div class="sponsor">
182 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
183</div>
184<div class="sponsor">
185 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
186</div>
187<div class="sponsor">
188 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
189</div>
190<div class="sponsor">
191 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
192</div>
193<div class="sponsor">
194 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
195</div>
196<div class="sponsor">
197 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
198</div>
199<div class="sponsor">
cristy2dcd6822011-06-13 16:21:20 +0000[diff] [blame]200 <a rel="follow" title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]201</div>
202</div>
203</div>
204</div>
205
206<div class="eastbar">
207
208</div>
209
210<div class="main">
211
212<p class="navigation-index">[<a href="#headers">Header Files</a> &bull; <a href="#channels">Pixel Channels</a> &bull; <a href="#alpha">Alpha</a> &bull; <a href="#depecate">Deprecated Features Removed</a> &bull; <a href="#summary">Version 7 Change Summary</a> ]</p>
213
214<h1>ImageMagick Version 7 Porting Guide</h1>
215
cristy2dcd6822011-06-13 16:21:20 +0000[diff] [blame]216<p>ImageMagick was originally designed to display RGB images to an X Windows server. Over time we extended support to RGBA images and then to the CMYK and CMYKA image format. With ImageMagick version 7, we extend support to arbitrary colorspaces with an arbitrary number of pixel channels. We intend to continue to maintain ImageMagick version 6 for at least 10 years.</p>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]217
218<h2><a id="headers"></a>Header Files</h2>
219<div class="doc-section">
220<p>Prior versions of ImageMagick (4-6) references the ImageMagick header files as <kbd>magick/</kbd> and <kbd>wand/</kbd>. ImageMagick 7 instead uses <kbd>MagickCore/</kbd> and <kbd>MagickWand/</kbd> respectively. For example,</p>
221<pre class="code">
222#include &lt;MagickCore/MagickCore.h>
223#include &lt;MagickWand/MagickWand.h>
224</pre>
225</div>
226
227<h2><a id="channels"></a>Pixel Channels</h2>
228<div class="doc-section">
229<p>Prior versions of ImageMagick (4-6), supports 4 to 5 pixel channels (RGBA or CMYKA). The first 4 channels are accessed with the PixelPacket data structure. The structure includes 4 members of type Quantum (typically 16-bits) of red, green, blue, and opacity. The black channel or colormap indexes are supported by a separate method and structure, IndexPacket. As an example, here is a code snippet from ImageMagick version 6 that negates image pixels:</p>
230
231<pre class="code">
232 for (y=0; y &lt; (ssize_t) image->rows; y++)
233 {
234 register IndexPacket
235 *indexes;
236
237 register PixelPacket
238 *q;
239
240 q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
241 if (q == (PixelPacket *) NULL)
242 {
243 status=MagickFalse;
244 continue;
245 }
246 indexes=GetCacheViewAuthenticIndexQueue(image_view);
247 for (x=0; x &lt; (ssize_t) image->columns; x++)
248 {
249 if ((channels & RedChannel) != 0)
250 q->red=(Quantum) QuantumRange-q->red;
251 if ((channels & GreenChannel) != 0)
252 q->green=(Quantum) QuantumRange-q->green;
253 if ((channels & BlueChannel) != 0)
254 q->blue=(Quantum) QuantumRange-q->blue;
255 if ((channels & OpacityChannel) != 0)
256 q->opacity=(Quantum) QuantumRange-q->opacity;
257 if (((channels & IndexChannel) != 0) &&
258 (image->colorspace == CMYKColorspace))
259 indexes[x]=(IndexPacket) QuantumRange-indexes[x];
260 q++;
261 }
262 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
263 status=MagickFalse;
264 }
265</pre>
266
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]267<p>ImageMagick version 7 supports any number of channels from 1 to 100 (and beyond) and simplifies access with a single method that returns an array of pixel channels of type Quantum. Source code that compiles against prior versions of ImageMagick will require refactoring to work with ImageMagick version 7. We illustrate with an example. Let's refactor the version 6 code snippet from above so it works with the ImageMagick version 7 API:</p>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]268
269<pre class="code">
270 for (y=0; y &lt; (ssize_t) image->rows; y++)
271 {
272 register Quantum
273 *q;
274
275 q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
276 if (q == (Quantum *) NULL)
277 {
278 status=MagickFalse;
279 continue;
280 }
281 for (x=0; x &lt; (ssize_t) image->columns; x++)
282 for (channel=0; channel &lt; GetCacheViewChannels(image_view); channel++)
283 {
284 if ((channels & (1 &lt;&lt; channel)) != 0)
285 *q=(Quantum) QuantumRange-(*q);
286 q++;
287 }
288 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
289 status=MagickFalse;
290 }
291</pre>
292
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]293<p>Use GetImageChannels() or GetCacheViewChannels() to advance to the next set of pixel channels.</p>
294
cristy2dcd6822011-06-13 16:21:20 +0000[diff] [blame]295<p>Use convenience macros to access pixel components (e.g. GetRedPixelComponent(image,p), SetRedPixelComponent(image,red,q)).</p>
296
297<li>The colormap indexes and black pixel component (for the CMYK colorspace) are no longer stored in the index channel, previously accessed with GetAuthenticIndexQueue() and GetCacheViewAuthenticIndexQueue((). Instead they are now a pixel channel and accessed with the convenience pixel macros GetIndexPixelComponent(), SetIndexPixelComponent(), GetBlackPixelComponent(), and SetBlackPixelComponent().</li>
298
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]299<p>In addition to supporting any number of channels, version 7 simplifies working with channels and provides opportunity for compiler optimiziations that were previously not possible. Our benchmarking shows version 7 has increased performance for virtually all image operations.</p>
300</div>
301
302<h2><a id="alpha"></a>Alpha</h2>
303<div class="doc-section">
cristy2dcd6822011-06-13 16:21:20 +0000[diff] [blame]304<p>We support alpha now, previously opacity. With alpha, a value of 0 means that the pixel does not have any coverage information and is transparent; i.e. there was no color contribution from any geometry because the geometry did not overlap this pixel. A value of QuantumRange means that the pixel is opaque because the geometry completely overlapped the pixel. As a consequence, in version 7, the PixelPacket structure member alpha has replaced the previous opacity member.</p>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]305</div>
306
307<h2><a id="deprecate"></a>Deprecated Features Removed</h2>
308<div class="doc-section">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]309<p>All deprecated features from ImageMagick version 6 are removed in version 7. These include the <kbd>Magick-config</kbd> and <kbd>Wand-config</kbd> configuration utilities. Instead use:</p>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]310
311<pre class="code">
312 MagickCore-config
313 MagickWand-config
314</pre>
315
316<p>In addition, all deprecated <a href="http://magick.imagemagick.org/api/deprecate.html">MagickCore</a> and <a href="http://magick.imagemagick.org/api/magick-deprecate.html">MagickWand</a> methods are no longer available in version 7.</p>
317</div>
318<h2><a id="summary"></a>Version 7 Change Summary</h2>
319<div class="doc-section">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]320<p>Changes from ImageMagick version 6 to version 7 are summarized here:</p>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]321<h5>Pixels</h5>
322<dl>
323<li>Pixels are no longer addressed with PixelPacket structure members (e.g. red, green, blue, opacity) but as an array of channels (e.g. p[RedPixelComponent]).</li>
cristy2dcd6822011-06-13 16:21:20 +0000[diff] [blame]324<li>Use convenience macros to access pixel components (e.g. GetRedPixelComponent(image,p), SetRedPixelComponent(image,red,q)).</li>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]325<li>The black channel for the CMYK colorspace is no longer stored in the index channel, previously accessed with GetAuthenticIndexQueue() and GetCacheViewAuthenticIndexQueue((). Instead its now a pixel channel and accessed with the convenience pixel macros GetBlackPixelComponent(p) and SetBlackPixelComponent(q).</li>
326<li>Use the index channel to address colormapped indexes. It no longer hosts the black channel for CMYK and CMYKA images.</li>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]327<li>Use GetImageChannels() or GetCacheViewChannels() to advance to the next set of pixel channels.</li>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]328</dl>
329<h5>Alpha</h5>
330<dl>
331<li>We support alpha rather than opacity (0 transparent; QuantumRange opaque).</li>
332<li>The PixelPacket structure member alpha has replaced the previous opacity member.</li>
333</dl>
334<h5>Deprecated Methods</h5>
335<dl>
cristy2dcd6822011-06-13 16:21:20 +0000[diff] [blame]336<li>All ImageMagick version 6 MagickCore and MagickWand deprecated methods are removed and no longer available in ImageMagick version 7.</li>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]337</dl>
338</div>
339
340</div>
341
342<div id="linkbar">
343 <span id="linkbar-west">&nbsp;</span>
344 <span id="linkbar-center">
345 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
346 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
347 </span>
348 <span id="linkbar-east">&nbsp;</span>
349 </div>
350 <div class="footer">
351 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
352 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
353 </div>
354 <div style="clear: both; margin: 0; width: 100%; "></div>
355 <script type="text/javascript">
356 var _gaq = _gaq || [];
357 _gaq.push(['_setAccount', 'UA-17690367-1']);
358 _gaq.push(['_trackPageview']);
359
360 (function() {
361 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
362 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
363 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
364 })();
365 </script>
366</body>
367</html>