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

   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="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
  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, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  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-2012 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" />
  32   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  33   <!-- Add jQuery library -->
  34   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  35
  36   <!-- Optionaly include easing and/or mousewheel plugins -->
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
  38   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
  39
  40   <!-- Add fancyBox -->
  41   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
  42   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
  43
  44   <!-- Optionaly include button and/or thumbnail helpers -->
  45   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
  46   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
  47
  48   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
  49   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
  50   <script type="text/javascript">
  51         $(document).ready(function() {
  52                 $(".fancybox").fancybox();
  53         });
  54   </script>
  55   <!-- ImageMagick style -->
  56   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
  57   <style type="text/css" media="all">
  58     @import url("../www/magick.css");
  59   </style>
  60 </head>
  61
  62 <body id="www-imagemagick-org">
  63 <div class="titlebar">
  64 <div style="margin: 17px auto; float: left;">
  65   <script type="text/javascript">
  66   <!--
  67     google_ad_client = "pub-3129977114552745";
  68     google_ad_slot = "5439289906";
  69     google_ad_width = 728;
  70     google_ad_height = 90;
  71   //-->
  72   </script>
  73   <script type="text/javascript"
  74     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  75   </script>
  76 </div>
  77 <a href="../discourse-server">
  78   <img src="../images/logo.jpg"
  79   alt="ImageMagick Logo"
  80   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  81 <a href="../index.html">
  82   <img src="../images/sprite.jpg"
  83   alt="ImageMagick Sprite"
  84   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  85 </div>
  86
  87 <div class="westbar">
  88
  89 <div class="menu">
  90   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  91 </div>
  92 <div class="menu">
  93   <a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
 103 </div>
 104 <div class="sub">
 105     <a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
 106 </div>
 107 <div class="sep"></div>
 108 <div class="menu">
 109   <a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
 110 </div>
 111 <div class="sub">
 112     <a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
 113 </div>
 114 <div class="sub">
 115     <a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
 116 </div>
 117 <div class="sub">
 118     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 119 </div>
 120 <div class="menu">
 121   <a title="Program Interfaces" href="api.html">Program Interfaces</a>
 122 </div>
 123 <div class="sub">
 124     <a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
 125 </div>
 126 <div class="sub">
 127     <a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
 128 </div>
 129 <div class="sub">
 130     <a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
 131 </div>
 132 <div class="sub">
 133     <a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
 134 </div>
 135 <div class="sep"></div>
 136 <div  class="menu">
 137    <a title="Install from Source" href="install-source.html">Install from Source</a>
 138 </div>
 139 <div class="sub">
 140     <a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
 141 </div>
 142 <div class="sub">
 143     <a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
 144  </div>
 145 <div class="menu">
 146   <a title="Resources" href="resources.html">Resources</a>
 147 </div>
 148 <div class="menu">
 149   <a title="Architecture" href="architecture.html">Architecture</a>
 150 </div>
 151 <div class="menu">
 152   <a title="Download" href="download.html">Download</a>
 153 </div>
 154 <div class="sep"></div>
 155 <div class="menu">
 156   <a title="Search" href="search.html">Search</a>
 157 </div>
 158 <div class="sep"></div>
 159 <div class="menu">
 160   <a title="Site Map" href="sitemap.html">Site Map</a>
 161 </div>
 162 <div  class="sub">
 163   <a title="Site Map: Links" href="links.html">Links</a>
 164 </div>
 165 <div class="sep"></div>
 166 <div class="menu">
 167   <a rel="follow" title="Sponsors" href="sponsors.html">Sponsors:</a>
 168
 169   <a href="http://www.networkredux.com"> <img src="../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 170   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 171 <div class="sponsbox">
 172 <div class="sponsor">
 173   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 174 </div>
 175 <div class="sponsor">
 176   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 177 </div>
 178 <div class="sponsor">
 179   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 180 </div>
 181 <div class="sponsor">
 182   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 183 </div>
 184 <div class="sponsor">
 185   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 186 </div>
 187 <div class="sponsor">
 188   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 189 </div>
 190 <div class="sponsor">
 191   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 192 </div>
 193 <div class="sponsor">
 194   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 195 </div>
 196 <div class="sponsor">
 197    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 198 </div>
 199 <div class="sponsor">
 200    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 201 </div>
 202 <div class="sponsor">
 203   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 204 </div>
 205 <div class="sponsor">
 206   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 207 </div>
 208 <div class="sponsor">
 209    <a rel="follow" title="Sponsor: Notebook Reparatur" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur</a><!-- 2012080100300 atlas-multimedia-->
 210 </div>
 211 <div class="sponsor">
 212    <a rel="follow" title="Sponsor: Waschmaschinen Reparatur Berlin" href="http://www.waschmaschinen-reparaturen-berlin.de">Waschmaschinen Reparatur Berlin</a><!-- 2012070100030 Temurbas@autoteile-->
 213 </div>
 214 </div>
 215 </div>
 216 </div>
 217
 218 <div class="eastbar">
 219   <div class="g-plusone" id="gplusone"></div>
 220   <script type="text/javascript">
 221     window.___gcfg = {
 222       lang: 'en-US'
 223     };
 224
 225     (function() {
 226       var po = document.createElement('script');
 227       po.type = 'text/javascript'; po.async = true;
 228       po.src = 'https://apis.google.com/js/plusone.js';
 229       var script = document.getElementsByTagName('script')[0];
 230       script.parentNode.insertBefore(po, script);
 231     })();
 232     var gplusone = document.getElementById("gplusone");
 233     gplusone.setAttribute("data-size","medium");
 234     gplusone.setAttribute("data-count","false");
 235   </script>
 236 </div>
 237
 238 <div class="main">
 239
 240 <h1>ImageMagick Version 7 Porting Guide</h1>
 241
 242 <p class="navigation-index">[<a href="porting.html#imv7">ImageMagick Version 7</a> &bull; <a href="porting.html#channels">Pixel Channels</a> &bull; <a href="porting.html#alpha">Alpha</a> &bull; <a href="porting.html#grayscale">Grayscale</a> &bull; <a href="porting.html#core">MagickCore API</a> &bull; <a href="porting.html#headers">Header Files</a>  &bull; <a href="porting.html#depecate">Deprecated Features Removed</a> &bull; <a href="porting.html#cli">Command-line Interface</a> &bull; <a href="porting.html#summary">Version 7 Change Summary</a> ]</p>
 243
 244 <h2><a id="imv7"></a>ImageMagick Version 7</h2>
 245 <div class="doc-section">
 246 <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>
 247
 248 <p>To support variable pixel channels in the MagickCore API, pixel handling has changed when getting or setting the pixel channels.  You can access channels as an array, <em>pixel[i]</em>, or use an accessor such as GetPixelRed() or SetPixelRed().  There are some modest changes to the MagickWand API.   Magick++ and PerlMagick should behave exactly as it does for ImageMagick version 6.</p>
 249
 250 <p>The shell API (command line) of ImageMagick version 7 is also undergoing
 251 a major overhaul, with specific emphasis on the ability to read 'options' not
 252 only from the command line, but also from scripts, and file streams. This
 253 allows for the use of 'co-processing' programming techniques or performing
 254 image handling using 'deamon/server backends', and even multi-machine
 255 distributed processing.</p>
 256
 257 <p>With shell API overhaul other improvements are being made, including:
 258 better reporting of which option failed, the consolidation and depreciation of
 259 options, and more global use of 'image properities' (more commonly known as
 260 'percent escapes' in option arguments. </p>
 261
 262 <p>We intend to make ImageMagick version 7 available as an Alpha release by the mid-year 2012.  Look for a Beta release sometime in late 2012.  An official ImageMagick version 7 release depends on how smoothly the Beta cycle progresses.  During the Beta cycle, version 6 developers can attempt to port their software to version 7.<p>
 263
 264 <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>
 265 </div>
 266
 267 <h2><a id="channels"></a>Pixel Channels</h2>
 268 <div class="doc-section">
 269 <p>A pixel is comprised of one or more color values, or <em>channels</em> (e.g. red pixel channel).</p>
 270 <p>Prior versions of ImageMagick (4-6), support 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 the color components (but not the alpha component) of the image pixels:</p>
 271
 272 <pre class="code">
 273   for (y=0; y &lt; (ssize_t) image->rows; y++)
 274   {
 275     register IndexPacket
 276       *indexes;
 277
 278     register PixelPacket
 279       *q;
 280
 281     q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
 282     if (q == (PixelPacket *) NULL)
 283       {
 284         status=MagickFalse;
 285         continue;
 286       }
 287     indexes=GetCacheViewAuthenticIndexQueue(image_view);
 288     for (x=0; x &lt; (ssize_t) image->columns; x++)
 289     {
 290       if ((channel & RedChannel) != 0)
 291         q->red=(Quantum) QuantumRange-q->red;
 292       if ((channel & GreenChannel) != 0)
 293         q->green=(Quantum) QuantumRange-q->green;
 294       if ((channel & BlueChannel) != 0)
 295         q->blue=(Quantum) QuantumRange-q->blue;
 296       if (((channel & IndexChannel) != 0) &&
 297           (image->colorspace == CMYKColorspace))
 298         indexes[x]=(IndexPacket) QuantumRange-indexes[x];
 299       q++;
 300     }
 301     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
 302       status=MagickFalse;
 303   }
 304 </pre>
 305
 306 <p>ImageMagick version 7 supports any number of channels from 1 to 32 (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 requires 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>
 307
 308 <pre class="code">
 309   for (y=0; y &lt; (ssize_t) image->rows; y++)
 310   {
 311     register Quantum
 312       *q;
 313
 314     q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
 315     if (q == (Quantum *) NULL)
 316       {
 317         status=MagickFalse;
 318         continue;
 319       }
 320     for (x=0; x &lt; (ssize_t) image->columns; x++)
 321     {
 322       if ((GetPixelRedTraits(image) & UpdatePixelTrait) != 0)
 323         SetPixelRed(image,QuantumRange-GetPixelRed(image,q),q);
 324       if ((GetPixelGreenTraits(image) & UpdatePixelTrait) != 0)
 325         SetPixelGreen(image,QuantumRange-GetPixelGreen(image,q),q);
 326       if ((GetPixelBlueTraits(image) & UpdatePixelTrait) != 0)
 327         SetPixelBlue(image,QuantumRange-GetPixelBlue(image,q),q);
 328       if ((GetPixelBlackTraits(image) & UpdatePixelTrait) != 0)
 329         SetPixelBlack(image,QuantumRange-GetPixelBlack(image,q),q);
 330       if ((GetPixelAlphaTraits(image) & UpdatePixelTrait) != 0)
 331         SetPixelAlpha(image,QuantumRange-GetPixelAlpha(image,q),q);
 332       q+=GetPixelChannels(image);
 333     }
 334     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
 335       status=MagickFalse;
 336   }
 337 </pre>
 338
 339 <p>Let's do that again but take full advantage of the new variable pixel channel support:</p>
 340 <pre class="code">
 341   for (y=0; y &lt; (ssize_t) image->rows; y++)
 342   {
 343     register Quantum
 344       *q;
 345
 346     q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
 347     if (q == (Quantum *) NULL)
 348       {
 349         status=MagickFalse;
 350         continue;
 351       }
 352     for (x=0; x &lt; (ssize_t) image->columns; x++)
 353     {
 354       register ssize_t
 355         i;
 356
 357       for (i=0; i &lt; (ssize_t) GetPixelChannels(image); i++)
 358       {
 359         PixelChannel
 360           channel;
 361
 362         PixelTrait
 363           traits;
 364
 365         channel=GetPixelChannelMapChannel(image,i);
 366         traits=GetPixelChannelMapTraits(image,channel);
 367         if (((traits &amp; UpdatePixelTrait) == 0) || (GetPixelMask(image,q) != 0))
 368           continue
 369         q[i]=QuantumRange-q[i];
 370       }
 371       q+=GetPixelChannels(image);
 372     }
 373     if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
 374       status=MagickFalse;
 375   }
 376 </pre>
 377
 378 <p>Note, how we use GetPixelChannels() to advance to the next set of pixel channels.</p>
 379
 380 <p>The colormap indexes and black pixel channel (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 accessor methods GetPixelIndex(), SetPixelIndex(), GetPixelBlack(), and SetPixelBlack().</p>
 381
 382 <h4></a>Pixel Accessors</h4>
 383 <p>Use accessors to get or set pixel channels:</p>
 384
 385 <pre class="text">
 386   GetPixelAlpha()
 387   GetPixelBlack()
 388   GetPixelBlue()
 389   GetPixelCb()
 390   GetPixelChannels()
 391   GetPixelCr()
 392   GetPixelCyan()
 393   GetPixelGray()
 394   GetPixelGreen()
 395   GetPixelIndex()
 396   GetPixelInfoIntensity()
 397   GetPixelInfoLuminance()
 398   GetPixelMagenta()
 399   GetPixelRed()
 400   GetPixelPacket()
 401   GetPixelPacketIntensity()
 402   GetPixelY()
 403   GetPixelYellow()
 404   GetPixelIntensity()
 405   SetPixelAlpha()
 406   SetPixelBlack()
 407   SetPixelBlue()
 408   SetPixelCb()
 409   SetPixelChannels()
 410   SetPixelCr()
 411   SetPixelCyan()
 412   SetPixelGray()
 413   SetPixelGreen()
 414   SetPixelIndex()
 415   SetPixelInfo()
 416   SetPixelInfoBias()
 417   SetPixelInfoPacket()
 418   SetPixelMagenta()
 419   SetPixelRed()
 420   SetPixelPacket()
 421   SetPixelPixelInfo()
 422   SetPixelYellow()
 423   SetPixelY()
 424 </pre>
 425
 426 <p>You can find these accessors defined in the header file, <kbd>MagickCore/pixel-accessor.h</kbd></p>
 427
 428 <h4></a>Pixel Traits</h4>
 429 <p>Each pixel channel includes one or more of these traits:</p>
 430 <dl>
 431 <dt>Undefined</dt>
 432 <dd>no traits associated with this pixel channel<dd>
 433 <dt>Copy</dt>
 434 <dd>do not update this pixel channel, just copy it<dd>
 435 <dt>Update</dt>
 436 <dd>update this pixel channel<dd>
 437 <dt>Blend</dt>
 438 <dd>blend this pixel channel with the alpha mask if it's enabled<dd>
 439 </dl>
 440 <p>We provide these methods to set and get pixel traits:</p>
 441 <pre class="text">
 442   GetPixelAlphaTraits()
 443   GetPixelBlackTraits()
 444   GetPixelBlueTraits()
 445   GetPixelCbTraits()
 446   GetPixelCrTraits()
 447   GetPixelCyanTraits()
 448   GetPixelGrayTraits()
 449   GetPixelGreenTraits()
 450   GetPixelIndexTraits()
 451   GetPixelMagentaTraits()
 452   GetPixelRedTraits()
 453   GetPixelChannelTraits()
 454   GetPixelYTraits()
 455   GetPixelYellowTraits()
 456   SetPixelAlphaTraits()
 457   SetPixelBlackTraits()
 458   SetPixelBlueTraits()
 459   SetPixelCbTraits()
 460   SetPixelChannelTraits()
 461   SetPixelCrTraits()
 462   SetPixelGrayTraits()
 463   SetPixelGreenTraits()
 464   SetPixelIndexTraits()
 465   SetPixelMagentaTraits()
 466   SetPixelRedTraits()
 467   SetPixelYellowTraits()
 468   SetPixelYTraits()
 469 </pre>
 470 <p>For convenience you can set the active trait for a set of pixel channels with a channel mask and these methods:</p>
 471 <pre class="text">
 472   PopPixelChannelMap()
 473   SetPixelChannelMap()
 474   SetPixelChannelMask()
 475 </pre>
 476
 477 <p>Previously MagickCore methods had channel analogs, for example, NegateImage() and NegateImageChannels().  The channel analog methods are no longer necessary because the pixel channel traits specify whether to act on a particular pixel channel and whether to blend with the alpha mask.  For example, instead of</p>
 478 <pre class="text">
 479   NegateImageChannel(image,channel);
 480 </pre>
 481 <p>we use:</p>
 482 <pre class="text">
 483   channel_mask=SetPixelChannelMask(image,channel);
 484   NegateImage(image,exception);
 485   (void) SetPixelChannelMap(image,channel_mask);
 486 </pre>
 487
 488 <h4></a>Pixel User Channels</h4>
 489 <p>In version 7, we introduce pixel user channels.  Traditionally we utilize 4 channels, red, green, blue, and alpha.   For CMYK we also have a black channel.  User channels are designed to contain whatever additional channel information that makes sense for your application.  Some examples include extra channels in TIFF or PSD images or perhaps you require a channel with infrared information for the pixel.  You can associate traits with the user channels so that they when they are acted upon by an image processing algorithm (e.g. blur) the pixels are copied, acted upon by the algorithm, or even blended with the alpha channel if that makes sense.</p>
 490 <h4></a>Pixel Metacontent</h4>
 491 <p>In version 7, we introduce pixel metacontent.  Metacontent is content about content. So rather than being the content itself, it's something that describes or is associated with the content.  Here the content is a pixel.  The pixel metacontent is for your exclusive use and is accessed with these MagickCore API methods:</p>
 492 <pre class="text">
 493   SetImageMetacontentExtent()
 494   GetImageMetacontentExtent()
 495   GetVirtualMetacontent()
 496   GetAuthenticMetacontent()
 497   GetCacheViewAuthenticMetacontent()
 498   GetCacheViewVirtualMetacontent()
 499 </pre>
 500 </div>
 501
 502 <h2><a id="alpha"></a>Alpha</h2>
 503 <div class="doc-section">
 504 <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 PixelInfo structure member alpha has replaced the previous opacity member.</p>
 505 </div>
 506 <h2><a id="grayscale"></a>Grayscale</h2>
 507 <div class="doc-section">
 508 <p>Previously, grayscale images consumed 4 channels: red, green, blue, and alpha.  With version 7, grayscale consumes only 1 channel consuming far less resources as a result.  However, there may be unintended consequences.  With 1 channel, all image processing algorithms write to this one channel.  Drawing yellow text on a grayscale image will produce gray lettering.  To get the expected results, simply modify the colorspace to RGB (e.g. -colorspace rgb).</p>
 509 </div>
 510
 511 <h2><a id="core"></a>MagickCore API</h2>
 512 <div class="doc-section">
 513 <p>Almost all image processing algorithms are now channel aware.</p>
 514 <p>MagickCore, version 7, adds an ExceptionInfo argument to those methods that lacked it in version 6, e.g. NegateImage(image,MagickTrue,exception);</p>
 515 <p>All method channel analogs have been removed (e.g. BlurImageChannel()), they are no longer necessary, use pixel traits instead.</p>
 516 <p>Public and private API calls are now declared with the GCC visibility attribute.  The MagickCore and MagickWand dynamic libraries now only export public struct and function declarations.</p>
 517 <p>The InterpolatePixelMethod enum is now PixelInterpolateMethod.</p>
 518 <p>The IntegerPixel storage type is removed (use LongPixel instead) and LongLongPixel is added</p>
 519 <p>Image signatures have changed to account for variable pixel channels.</p>
 520 <p>All color packet structures, PixelPacket, LongPacket, and DoublePacket, are consolidated to a single color structure, PixelInfo.</p>
 521 </div>
 522 <h2><a id="headers"></a>Header Files</h2>
 523 <div class="doc-section">
 524 <p>Prior versions of ImageMagick (4-6) reference 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>
 525 <pre class="code">
 526 #include &lt;MagickCore/MagickCore.h>
 527 #include &lt;MagickWand/MagickWand.h>
 528 </pre>
 529 </div>
 530
 531 <h2><a id="deprecate"></a>Deprecated Features Removed</h2>
 532 <div class="doc-section">
 533 <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>
 534
 535 <pre class="code">
 536   MagickCore-config
 537   MagickWand-config
 538 </pre>
 539 <p>The FilterImage() method has been removed.  Use ConvolveImage() instead.</p>
 540
 541 <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>
 542 </div>
 543
 544
 545 <h2><a id="cli"></a>Shell API or Command-line Interface</h2>
 546 <div class="doc-section">
 547
 548 <p>As mentioned the primary focus of the changes to the Shell API or Command
 549 Line Interface is the the abstration so that not only can 'options' be read
 550 from command line arguments, but also from a file (script) or from a file
 551 stream (interactive commands, or co-processing). </p>
 552
 553 <p>To do this the CLI parser needed to be re-written, so as to always perform
 554 all options, in a strict, do-it-as-you-see it order. Previously in IMv6
 555 options were performed in groups (known as 'FireOptions), this awkwardness is
 556 now gone.  However the strict order means that you can no long give operations
 557 before providing an image for the operations to work on.  To do so will now
 558 produce an error. </p>
 559
 560 <p>Error reporting is now reporting exactly which option (by argument count on
 561 command line, or line,column in scripts) caused the 'exception'.  This is not
 562 complete as yet but getting better. Also not complete is 'regard-warnings'
 563 handling or its replacement, which will allow you to ignore reported errors
 564 and continue processing (as appropriate due to error) in co-processes or
 565 interactive usage. </p>
 566
 567 <p>The parenthesis options used to 'push' the current image list, and image
 568 settings (EG: '<kbd>(</kbd>' and '<kbd>)</kbd>' ) on to a stack now has
 569 a completely seperate image settings stack. That is parenthesis 'push/pull'
 570 image lists, and curly braces (EG: '<kbd>{</kbd>' and '<kbd>}</kbd>' ) will
 571 'push/pull' image settings. </p>
 572
 573 <p>Of course due to the previously reported changes to the underlying channel
 574 handling will result be many side effects to almost all options. Here are some
 575 specific </p>
 576
 577 <p>Most algorithms update the red, green, blue, black (for CMYK), and alpha
 578 channels.  Most operators will blend alpha the other color channels, but other
 579 operators (and situations) may require this blending to be disabled, and is
 580 currently done by removing alpha from teh active channels via
 581 <kbd>-channel</kbd> option.  (e.g. <kbd>convert castle.gif -channel RGB
 582 -negate castle.png</kbd>). </p>
 583
 584 <p>Reading gray-scale images will generate a image with only one channel. If
 585 that image is to then accept color the <kbd>-colorspace</kbd> setting needs to
 586 be applied to expand the one channel into separate RGB (or other) channels.
 587 </p>
 588
 589 <h3>Command Changes</h3>
 590 <dl>
 591 <dt>magick</dt>
 592 <dd>The "<kbd>magick</kbd>" command is the new primary command of the Shell
 593     API, replacing the old "<kbd>convert</kbd>" command. This allows you to
 594     create a 'magick script' of the form  "<kbd>#!/path/to/command/magick
 595     -script</kbd>", or pipe options into a command "<kbd>magick -script
 596     -</kbd>, as abackground process. </dd>
 597
 598 <dt>magick-script</dt>
 599 <dd>This the same as "<kbd>magick</kbd>", (only command name is different)
 600     but which has an implict "<kbd>-script</kbd>" option.  This allows you to
 601     use it in an "<kbd>env</kbd>" style script form.  That is a magick script
 602     starts with the 'she-bang' line of "<kbd>#!/usr/bin/env
 603     magick-script</kbd>" allowing the script interpreter to be found anywhere
 604     on the users command "<kbd>PATH</kbd>".  This is required to get around
 605     a "one argument she-bang bug" that is common on most UNIX systems
 606     (including Linux, but not MacOSX).</dd>
 607
 608 </dl>
 609
 610 <h3>New Options</h3>
 611 <p>ImageMagick version 7 supports these new options, though most are limited
 612 to the "<kbd>magick</kbd>" command, or to use in "<kbd>magick</kbd>"
 613 scripts.</p>
 614
 615 <dl>
 616 <dt>{ ... }</dt>
 617 <dd>Save (and restore) the current image settings (internally known as the
 618     "image_info" structure).  This is automatically done with parenthesis (EG:
 619     '<kbd>(</kbd>' and '<kbd>)</kbd>') is "<kbd>-regard-parenthesis</kbd>" has
 620     been set, just as in IMv6.  Caution is advised to prevent un-balanced
 621     braces errors.</dd> </dd>
 622
 623 <dt>--</dt>
 624 <dd>End of options, to be used in IMv7 "<kbd>mogrify</kbd>" command to
 625     explictally separate the operations to be applied and the images that
 626     are to be processed 'in-place'.  (not yet implemented).  However if
 627     not provided, "<kbd>-read</kbd>" can still be used to differentiate
 628     secondary image reads (for use in things like alpha composition) from
 629     the 'in-place' image being processed. </dd>
 630
 631 <dd>In other commands (such as "magick") it is equivelent to a explict
 632     "<kbd>-read</kbd>" (see below) of the next option as a image (as it was in
 633     IMv6).  </dd>
 634
 635 <dt>-channel-fx <em class="arg">expression</em> </dt>
 636 <dd>
 637 <p>exchange, extract, or copy one or more image channels.</p>
 638
 639 <p>The expression consists of one or more channels, either mnemonic or numeric (e.g. red, 1), separated by certain operation symbols as follows:</p>
 640
 641 <pre class="text">
 642   &lt;=&gt;     exchange two channels (e.g. red&lt;=&gt;blue)
 643   =&gt;      copy one channel to another channel (e.g. red=&gt;green)
 644   =       assign a constant value to a channel (e.g. red=50%)
 645   ,       write new image with channels in the specified order (e.g. red, green)
 646   ;       add a new output image for the next set of channel operations
 647   |       move to the next input image for the source of channel data
 648 </pre>
 649
 650 <p>For example, to create 3 grayscale images from the red, green, and blue channels of an image, use:</p>
 651
 652 <pre class="text">
 653   -channel-fx "red; green; blue"
 654 </pre>
 655
 656 <p>A channel without an operation symbol implies separate (i.e, semicolon).</p>
 657
 658 </dd>
 659
 660 <dt>-exit</dt>
 661 <dd>Stop processing at this point. No further options will be processed after
 662     this option. Can be used in a script to force the "<kbd>magick</kbd>"
 663     command to exit, without actually closing the pipeline that it is
 664     processing options from. </dd>
 665
 666 <dd>May also be used as a 'final' option on the "<kbd>magick</kbd>" command
 667     line, instead of a implicit output image, to completely prevent any image
 668     write. ASIDE: even the "<kbd>NULL:</kbd>" coder requires at least one
 669     image, for it to 'not write'! This option does not require any images at
 670     all. </dd>
 671
 672 <dt>-read {image}</dt>
 673 <dd>Explicit read of an image, rather than an implicit read.  This allows you
 674     to read from filenames that start with an 'option' character, and which
 675     otherwise could be mistaken as an option (unknown or otherwise). This will
 676     eventually be used in "<kbd>mogrify</kbd>" to allow the reading of
 677     secondary images, and allow the use of image list operations within that
 678     command. </dd>
 679
 680 <dt>-region</dt>
 681 <dd>not yet implemented in "<kbd>magick</kbd>". (very soon)</dd>
 682
 683 <dt>-script {file}</dt>
 684 <dd>In "<kbd>magick</kbd>", stop the processing of command line arguments as
 685     image operations, and read all further options from the given file or
 686     pipeline.</dd>
 687
 688 </dl>
 689
 690 <h3>Changed Options</h3>
 691 <p>These options are known to have changed, in some way.</p>
 692 <dl>
 693 <dt>-negate</dt>
 694 <dd>currently negates all channels, including alpha if present.  As such you
 695     may need to use the -channel option to prevent alpha negation.  </dd>
 696
 697 <dt>-convolve</dt>
 698 <dd>option no longer normalizes the kernel argument (unless some type of
 699     masking is involved, such as alpha blending) and accepts named kernels
 700     (see <a href="http://www.imagemagick.org/Usage/convolve/" >IM Examples,
 701     Convolve</a> ) as well as non-square <a
 702     href="http://www.imagemagick.org/Usage/morphology/#user">user defined
 703     kernels</a>. Use <kbd>-define convolve:normalize=true</kbd> on the command-line to force normalization.</dd>
 704
 705 </dl>
 706
 707 <h3>Depreciated warning given, but will work (for now)</h3>
 708 <dl>
 709 <dt>-affine</dt>
 710 <dd>Replaced by <kbd>-draw "affine ..."</kbd>. (see transform)</dd>
 711 <dt>-average</dt>
 712 <dd>Replaced by <kbd>-evaluate-sequence Mean</kbd>.</dd>
 713 <dt>-box</dt>
 714 <dd>Replaced by <kbd>-undercolor</kbd>.</dd>
 715 <dt>-deconstruct</dt>
 716 <dd>Replaced by <kbd>-layers CompareAny</kbd>.</dd>
 717 <dt>-gaussian</dt>
 718 <dd>Replaced by <kbd>-gaussian-blur</kbd>.</dd>
 719 <dt>-/+map</dt>
 720 <dd>Replaced by <kbd>-/+remap</kbd>.</dd>
 721 <dt>-/+matte</dt>
 722 <dd>Replaced by <kbd>-alpha Set/Off</kbd>.</dd>
 723 <dt>-transform</dt>
 724 <dd>Replaced by <kbd>-distort Affine "..."</kbd>.</dd>
 725 </dl>
 726
 727 <h3>Depreciated warning given, and ignored (for now)</h3>
 728 <p>Almost 'plus' (+) option that did not do anything has been marked as
 729 depreciated, and does nothing. It does not even have associated code.  For
 730 example "+annotate", "+resize", "+clut", and "+draw" .</p>
 731
 732 <dl>
 733 <dt>-affinity</dt>
 734 <dd>Replaced by <dd>-affinity</kbd>.</dd>
 735 <dt>-maximum</dt>
 736 <dd>Replaced by <kbd>-evaluate-sequence Max</kbd>.</dd>
 737 <dt>-median</dt>
 738 <dd>Replaced by <kbd>-evaluate-sequence Median</kbd>.</dd>
 739 <dt>-minimum</dt>
 740 <dd>Replaced by <kbd>-evaluate-sequence Min</kbd>.</dd>
 741 <dt>-recolor</dt>
 742 <dd>Replaced by <dd>-color-matrix</kbd>.</dd>
 743 </dl>
 744
 745 <h3>Removed / Replaced Options ("no such option" error and abort)</h3>
 746
 747 <dl>
 748 <dt>-origin</dt>
 749 <dd>old option, unknown meaning.</dd>
 750 <dt>-pen</dt>
 751 <dd>Replaced by <dd>-fill</kbd>.</dd>
 752 <dt>-passphrase</dt>
 753 <dd>old option, unknown meaning</dd>
 754 </dl>
 755
 756 </div>
 757 <h2><a id="summary"></a>Version 7 Change Summary</h2>
 758 <div class="doc-section">
 759 <p>Changes from ImageMagick version 6 to version 7 are summarized here:</p>
 760 <h5>Pixels</h5>
 761 <dl>
 762 <li>Pixels are no longer addressed with PixelPacket structure members (e.g. red, green, blue, opacity) but as an array of channels (e.g. pixel[PixelRedChannel]).</li>
 763 <li>Use convenience macros to access pixel channels (e.g. GetPixelRed(), SetPixelRed()).</li>
 764 <li>The black channel for the CMYK colorspace is no longer stored in the index channel, previously accessed with GetAuthenticIndexQueue() and GetCacheViewAuthenticIndexQueue(().  Instead it is now a pixel channel and accessed with the convenience pixel macros GetPixelBlack() and SetPixelBlack().</li>
 765 <li>The index channel for colormapped images is no longer stored in the index channel, previously accessed with GetAuthenticIndexQueue() and GetCacheViewAuthenticIndexQueue(().  Instead it is now a pixel channel and accessed with the convenience pixel macros GetPixelIndex() and SetPixelIndex().</li>
 766 <li>Use GetPixelChannels() to advance to the next set of pixel channels.</li>
 767 <li>Use the <em>metacontent</em> channel  to associate metacontent with each pixel.</li>
 768 <li>All color packet structures, PixelPacket, LongPacket, and DoublePacket, are consolidated to a single color structure, PixelInfo.</li>
 769 </dl>
 770 <h5>Alpha</h5>
 771 <dl>
 772 <li>We support alpha rather than opacity (0 transparent; QuantumRange opaque).</li>
 773 <li>Use GetPixelAlpha() or SetPixelAlpha() to get or set the alpha pixel channel value.</li>
 774 </dl>
 775 <h5>Grayscale</h5>
 776 <dl>
 777 <li>Grayscale images consume one pixel channel in ImageMagick version 7.  To process RGB, set the colorspace to RGB (e.g. -colorspace rgb).</li>
 778 </dl>
 779 <h5>MagickCore API</h5>
 780 <dl>
 781 <li>Almost all image processing algorithms are now channel aware.</li>
 782 <li>MagickCore, version 7, adds an ExceptionInfo argument to those methods that lacked it in version 6, e.g. NegateImage(image,MagickTrue,exception);</li>
 783 <li>All method channel analogs have been removed (e.g. BlurImageChannel()), they are no longer necessary, use pixel traits instead.</li>
 784 <li>Public and private API calls are now declared with the GCC visibility attribute.  The MagickCore and MagickWand dynamic libraries now only export public struct and function declarations.</li>
 785 <li>The InterpolatePixelMethod enum is now PixelInterpolateMethod.</li>
 786 <li>To account for variable pixel channels, images may now return a different signature.</li>
 787 </dl>
 788 <h5>Deprecated Methods</h5>
 789 <dl>
 790 <li>All ImageMagick version 6 MagickCore and MagickWand deprecated methods are removed and no longer available in ImageMagick version 7.</li>
 791 <li>All MagickCore channel method analogs are removed (e.g. NegateImageChannels()).  For version 7, use pixel traits instead.</li>
 792 <li>The FilterImage() method has been removed.  Use ConvolveImage() instead.</li>
 793 </dl>
 794 </div>
 795
 796
 797 </div>
 798
 799 <div id="linkbar">
 800     <span id="linkbar-west">&nbsp;</span>
 801     <span id="linkbar-center">
 802       <a href="../discourse-server">Discourse Server</a> &bull;
 803       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 804     </span>
 805     <span id="linkbar-east">&nbsp;</span>
 806   </div>
 807   <div class="footer">
 808     <span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>
 809     <span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>
 810   </div>
 811   <div style="clear: both; margin: 0; width: 100%; "></div>
 812   <script type="text/javascript">
 813     var _gaq = _gaq || [];
 814     _gaq.push(['_setAccount', 'UA-17690367-1']);
 815     _gaq.push(['_trackPageview']);
 816
 817     (function() {
 818       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 819       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 820       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 821     })();
 822   </script>
 823 </body>
 824 </html>