]> granicus.if.org Git - imagemagick/blob - www/porting.html
b3769af8d42a59375d30d84d6cea5f7aee84b26f
[imagemagick] / www / porting.html
1 \r
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
3   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
4 <html version="-//W3C//DTD XHTML 1.1//EN"\r
5       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
6       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
7       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
8                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
9 <head>\r
10   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
11   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
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"/>
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."/>
18   <meta name="Application-url" content="http://www.imagemagick.org"/>
19   <meta name="Generator" content="PHP"/>
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"/>
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="canonical" href="http://www.imagemagick.org" />\r
32   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
33   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
34   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
35   <style type="text/css" media="all">\r
36     @import url("../www/magick.css");\r
37   </style>\r
38   <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>\r
39   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
40   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
41   <script type="text/javascript">\r
42     $(document).ready(function() {\r
43       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
44         'transitionIn'  : 'elastic',\r
45         'transitionOut' : 'elastic',\r
46         'overlayShow'   : false,\r
47         'opacity'       : true\r
48       });\r
49     });\r
50   </script>\r
51 </head>\r
52 \r
53 <body id="www-imagemagick-org">\r
54 <div class="titlebar">\r
55 <div style="margin: 17px auto; float: left;">\r
56   <script type="text/javascript">\r
57   <!--\r
58     google_ad_client = "pub-3129977114552745";\r
59     google_ad_slot = "5439289906";\r
60     google_ad_width = 728;\r
61     google_ad_height = 90;\r
62   //-->\r
63   </script>\r
64   <script type="text/javascript"\r
65     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
66   </script>\r
67 </div>\r
68 <a href="http://www.imagemagick.org/discourse-server/">\r
69   <img src="../images/logo.jpg"\r
70   alt="ImageMagick Logo"\r
71   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
72 <a href="../index.html">\r
73   <img src="../images/sprite.jpg"\r
74   alt="ImageMagick Sprite"\r
75   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
76 </div>\r
77 \r
78 <div class="westbar">\r
79 \r
80 <div class="menu">
81   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
82 </div>
83 <div class="menu">
84   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
85 </div>
86 <div class="sub">
87     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
88 </div>
89 <div class="sub">
90     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
91 </div>
92 <div class="sub">
93     <a title="Binary Release: iOS" href="../www/binary-releases.html#iOS">iOS</a>
94 </div>
95 <div class="sub">
96     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
97 </div>
98 <div class="sep"></div>\r
99 <div class="menu">
100   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
101 </div>
102 <div class="sub">
103     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
104 </div>
105 <div class="sub">
106     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
107 </div>
108 <div class="sub">
109     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
110 </div>
111 <div class="menu">
112   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
113 </div>
114 <div class="sub">
115     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
116 </div>
117 <div class="sub">
118     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
119 </div>
120 <div class="sub">
121     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
122 </div>
123 <div class="sub">
124     <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
125 </div>
126 <div class="sep"></div>\r
127 <div  class="menu">
128    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
129 </div>
130 <div class="sub">
131     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
132 </div>
133 <div class="sub">
134     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
135  </div>
136 <div class="menu">
137   <a title="Resources" href="../www/resources.html">Resources</a>
138 </div>
139 <div class="menu">
140   <a title="Architecture" href="../www/architecture.html">Architecture</a>
141 </div>
142 <div class="menu">
143   <a title="Download" href="../www/download.html">Download</a>
144 </div>
145 <div class="sep"></div>\r
146 <div class="menu">
147   <a title="Search" href="../www/search.html">Search</a>
148 </div>
149 <div class="sep"></div>\r
150 <div class="menu">
151   <a title="Site Map" href="../www/sitemap.html">Site Map</a>
152 </div>
153 <div  class="sub">
154   <a title="Site Map: Links" href="../www/links.html">Links</a>
155 </div>
156 <div class="sep"></div>\r
157 <div  class="menu">
158   <a rel="follow" title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
159
160 <a href="http://www.networkredux.com">
161   <img src="../images/networkredux.png" alt="[sponsor]"
162   style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
163 <div class="sponsbox">
164 <div  class="sponsor">
165   <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
166 </div>
167 <div  class="sponsor">
168   <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
169 </div>
170 <div  class="sponsor">
171   <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
172 </div>
173 <div  class="sponsor">
174   <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
175 </div>
176 <div  class="sponsor">
177   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
178 </div>
179 <div  class="sponsor">
180   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
181 </div>
182 <div  class="sponsor">
183   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
184 </div>
185 <div  class="sponsor">
186   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
187 </div>
188 <div  class="sponsor">
189   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
190 </div>
191 <div  class="sponsor">
192   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
193 </div>
194 <div  class="sponsor">
195   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
196 </div>
197 <div  class="sponsor">
198   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
199 </div>
200 <div  class="sponsor">
201   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
202 </div>
203 <div  class="sponsor">
204    <a rel="follow" title="Sponsor: Bildbearbeitung" href="http://www.bildschliff.de">Bildbearbeitung</a><!-- 2012060100300 strait.de-->
205 </div>
206 </div>
207 </div>
208 </div>\r
209 \r
210 <div class="eastbar">\r
211 <div style="margin: 9pt 9pt 9pt 9pt;">\r
212   <div class="g-plusone" data-size="standard" data-count="false"></div>\r
213 </div>\r
214 </div>\r
215 \r
216 <div class="main">\r
217 \r
218 <h1>ImageMagick Version 7 Porting Guide</h1>
219
220 <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>
221
222 <p>The design of ImageMagick is an evolutionary process, with the design and implementation efforts serving to influence and guide further progress in the other.  With ImageMagick version 7 we aim to improve the design based on lessons learned from the version 6 implementation.  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.  Other design changes are in the works and we will document them here so be sure to revisit periodically.</p>
223
224 <p>To support variable pixel channels in the MagickCore API, pixel handling has changed and now requires accessors to get or set the pixel components.  There are some modest changes to the MagickWand API.   Magick++ and PerlMagick should behave exactly as it does for ImageMagick version 6.</p>
225
226 <p>We intend to make ImageMagick version 7 available as an Alpha release by the end-of-year 2011.  Look for a Beta release sometime in 2012.  An official ImageMagick version 7 release will depend on how smoothly the Beta cycle progresses.  During the Beta cycle, version 6 developers can attempt to port their software to version 7.<p>
227
228 <p>During the ImageMagick version 7 development cycle and release, we will continue to support and enhance version 6 for a minimum of 10 years.</p>
229 <h2><a id="headers"></a>Header Files</h2>
230 <div class="doc-section">
231 <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>
232 <pre class="code">
233 #include &lt;MagickCore/MagickCore.h>
234 #include &lt;MagickWand/MagickWand.h>
235 </pre>
236 </div>
237
238 <h2><a id="channels"></a>Pixel Channels</h2>
239 <div class="doc-section">
240 <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>
241
242 <pre class="code">
243   for (y=0; y &lt; (ssize_t) image->rows; y++)
244   {
245     register IndexPacket
246       *indexes;
247
248     register PixelPacket
249       *q;
250
251     q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
252     if (q == (PixelPacket *) NULL)
253       {
254         status=MagickFalse;
255         continue;
256       }
257     indexes=GetCacheViewAuthenticIndexQueue(image_view);
258     for (x=0; x &lt; (ssize_t) image->columns; x++)
259     {
260       if ((channels & RedChannel) != 0)
261         q->red=(Quantum) QuantumRange-q->red;
262       if ((channels & GreenChannel) != 0)
263         q->green=(Quantum) QuantumRange-q->green;
264       if ((channels & BlueChannel) != 0)
265         q->blue=(Quantum) QuantumRange-q->blue;
266       if ((channels & OpacityChannel) != 0)
267         q->opacity=(Quantum) QuantumRange-q->opacity;
268       if (((channels & IndexChannel) != 0) &&
269           (image->colorspace == CMYKColorspace))
270         indexes[x]=(IndexPacket) QuantumRange-indexes[x];
271       q++;
272     }
273     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
274       status=MagickFalse;
275   }
276 </pre>
277
278 <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 naively refactor the version 6 code snippet from above so it works with the ImageMagick version 7 API:</p>
279
280 <pre class="code">
281   for (y=0; y &lt; (ssize_t) image->rows; y++)
282   {
283     register Quantum
284       *q;
285
286     q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
287     if (q == (Quantum *) NULL)
288       {
289         status=MagickFalse;
290         continue;
291       }
292     for (x=0; x &lt; (ssize_t) image->columns; x++)
293     {
294       if ((channels & RedChannel) != 0)
295         SetPixelRed(image,QuantumRange-GetPixelRed(image,q),q);
296       if ((channels & GreenChannel) != 0)
297         SetPixelGreen(image,QuantumRange-GetPixelGreen(image,q),q);
298       if ((channels & BlueChannel) != 0)
299         SetPixelBlue(image,QuantumRange-GetPixelBlue(image,q),q);
300       if (((channels & IndexChannel) != 0) &&
301           (image->colorspace == CMYKColorspace))
302         SetPixelBlack(image,QuantumRange-GetPixelBlack(image,q),q);
303       if ((channels & OpacityChannel) != 0)
304         SetPixelAlpha(image,QuantumRange-GetPixelAlpha(image,q),q);
305       q+=GetImagePixelChannels(image);
306     }
307     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
308       status=MagickFalse;
309   }
310 </pre>
311
312 <p>Let's do that again but take full advantage of the new variable pixel channel support:</p>
313 <pre class="code">
314   for (y=0; y &lt; (ssize_t) image->rows; y++)
315   {
316     register Quantum
317       *q;
318
319     q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
320     if (q == (Quantum *) NULL)
321       {
322         status=MagickFalse;
323         continue;
324       }
325     for (x=0; x &lt; (ssize_t) image->columns; x++)
326       for (channel=0; channel &lt; GetImagePixelChannels(image); channel++)
327       {
328         if ((channels & (1 &lt;&lt; channel)) != 0)
329           *q=(Quantum) QuantumRange-(*q);
330         q++;
331       }
332     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
333       status=MagickFalse;
334   }
335 </pre>
336
337 <p>Use GetImagePixelChannels() to advance to the next set of pixel channels.</p>
338
339 <h4></a>Pixel Accessors</h4>
340 <p>Use accessors to get or set pixel components (e.g. GetPixelRed(), SetPixelRed()).  You can find these accessors defined in the header file, <kbd>MagickCore/pixel-accessor.h</kbd></p>
341
342 <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 GetPixelIndex(), SetPixelIndex(), GetPixelBlack(), and SetPixelBlack().</li>
343
344 <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>
345
346 <h4></a>Associated Pixel Channels</h4>
347 <p>In version 7, we introduce <em>associated</em> pixel channels.  These pixel channels are for your exclusive use and are accessed with these MagickCore API methods:</p>
348 <dl>
349 <li>SetImageAssociatedPixelChannels()</li>
350 <li>GetImageAssociatedPixelChannels()</li>
351 <li>GetVirtualAssociatedPixels</li>
352 <li>GetAuthenticAssociatedPixels</li>
353 <li>GetCacheViewAuthenticAssociatedPixels</li>
354 <li>GetCacheViewVirtualAssociatedPixels</li>
355 </dl>
356 </div>
357
358 <h2><a id="alpha"></a>Alpha</h2>
359 <div class="doc-section">
360 <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>
361 </div>
362
363 <h2><a id="deprecate"></a>Deprecated Features Removed</h2>
364 <div class="doc-section">
365 <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>
366
367 <pre class="code">
368   MagickCore-config
369   MagickWand-config
370 </pre>
371
372 <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>
373 </div>
374 <h2><a id="summary"></a>Version 7 Change Summary</h2>
375 <div class="doc-section">
376 <p>Changes from ImageMagick version 6 to version 7 are summarized here:</p>
377 <h5>Pixels</h5>
378 <dl>
379 <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[PixelRed]).</li>
380 <li>Use convenience macros to access pixel components (e.g. GetPixelRed(), SetPixelRed()).</li>
381 <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 GetPixelBlack() and SetPixelBlack().</li>
382 <li>Use the index channel to address colormapped indexes.  It no longer hosts the black channel for CMYK and CMYKA images.</li>
383 <li>Use GetImagePixelChannels() to advance to the next set of pixel channels.</li>
384 <li>Use <em>associated</em> pixel channels for your own use.</li>
385 </dl>
386 <h5>Alpha</h5>
387 <dl>
388 <li>We support alpha rather than opacity (0 transparent; QuantumRange opaque).</li>
389 <li>Use GetPixelAlpha() or SetPixelAlpha() to get or set the alpha pixel component value.</li>
390 </dl>
391 <h5>Deprecated Methods</h5>
392 <dl>
393 <li>All ImageMagick version 6 MagickCore and MagickWand deprecated methods are removed and no longer available in ImageMagick version 7.</li>
394 </dl>
395 </div>
396 \r
397 </div>\r
398 \r
399 <div id="linkbar">\r
400     <span id="linkbar-west">&nbsp;</span>\r
401     <span id="linkbar-center">\r
402       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
403       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
404     </span>\r
405     <span id="linkbar-east">&nbsp;</span>\r
406   </div>\r
407   <div class="footer">\r
408     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
409     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
410   </div>\r
411   <div style="clear: both; margin: 0; width: 100%; "></div>\r
412   <script type="text/javascript">\r
413     var _gaq = _gaq || [];\r
414     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
415     _gaq.push(['_trackPageview']);\r
416 \r
417     (function() {\r
418       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
419       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
420       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
421     })();\r
422   </script>\r
423 </body>\r
424 </html>\r