Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 43b536b279b6060bff3a5455e031da025e44321b / . / www / porting.html
blob: 4dd410602c26bb33c640737a693ff68075f5d913 [file] [log] [blame]
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]1<!DOCTYPE html>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]2<html lang="en">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]3<head>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]4 <title>ImageMagick: Porting to ImageMagick Version 7</title>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]6 <meta name="application-name" content="ImageMagick">
7 <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
8 <meta name="application-url" content="http://www.imagemagick.org">
9 <meta name="generator" content="PHP">
10 <meta name="keywords" content="porting, to, imagemagick, version, 7, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
11 <meta name="rating" content="GENERAL">
12 <meta name="robots" content="INDEX, FOLLOW">
13 <meta name="generator" content="ImageMagick Studio LLC">
14 <meta name="author" content="ImageMagick Studio LLC">
15 <meta name="revisit-after" content="2 DAYS">
16 <meta name="resource-type" content="document">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]17 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]18 <meta name="distribution" content="Global">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]19 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
cristy354f1172015-07-29 14:03:48 +0000[diff] [blame]20 <link rel="icon" href="../images/wand.png">
21 <link rel="shortcut icon" href="../images/wand.ico">
22 <link rel="stylesheet" href="../css/magick.html">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]23</head>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]24<body>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]25<div class="main">
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]26<div class="magick-masthead">
27 <div class="container">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]28 <script async src="http://localhost/pagead/js/adsbygoogle.js"></script>
29 <ins class="adsbygoogle" style="display:block" data-ad-client="ca-pub-3129977114552745" data-ad-slot="6345125851" data-ad-format="auto"></ins>
30 <script>
31 (adsbygoogle = window.adsbygoogle || []).push({});
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]32 </script>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]33 <nav class="magick-nav">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]34 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]35 <a class="magick-nav-item " href="binary-releases.html">Download</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]36 <a class="magick-nav-item " href="command-line-tools.html">Tools</a>
37 <a class="magick-nav-item " href="command-line-options.html">Options</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]38 <a class="magick-nav-item " href="resources.html">Resources</a>
39 <a class="magick-nav-item " href="api.html">Develop</a>
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]40 <a class="magick-nav-item " href="http://nextgen.imagemagick.org/script/search.php">Search</a>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]41 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]42 </nav>
43 </div>
44</div>
45<div class="container">
46<div class="magick-header">
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]47
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]48<p class="text-center"><a href="porting.html#imv7">ImageMagick Version 7</a> • <a href="porting.html#hdri">High Dynamic Range Imaging</a> • <a href="porting.html#channels">Pixel Channels</a> • <a href="porting.html#alpha">Alpha</a> • <a href="porting.html#grayscale">Grayscale</a> • <a href="porting.html#mask">Masks</a> • <a href="porting.html#core">MagickCore API</a> • <a href="porting.html#headers">Header Files</a> • <a href="porting.html#deprecate">Deprecated Features Removed</a> • <a href="porting.html#cli">Command-line Interface</a> • <a href="porting.html#summary">Version 7 Change Summary</a> </p>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]49
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]50<p class="lead magick-description">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>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]51
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]52<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, <var>pixel[i]</var>, or use an accessor method such as GetPixelRed() or SetPixelRed(). There are some modest changes to the MagickCore and MagickWand API's. The Magick++ and PerlMagick API's have not changed and matches that of the ImageMagick version 6.</p>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]53
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]54<p>The shell API (command line) of ImageMagick version 7 is also undergoing
55a major overhaul, with specific emphasis on the ability to read 'options' not
56only from the command line, but also from scripts, and file streams. This
57allows for the use of 'co-processing' programming techniques or performing
58image handling using 'deamon/server backends', and even multi-machine
59distributed processing.</p>
60
61<p>With shell API overhaul other improvements are being made, including:
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]62better reporting of which option failed, the consolidation and deprecation of
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]63options, and more global use of 'image properities' (more commonly known as
64'percent escapes' in option arguments. </p>
65
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]66<p>ImageMagick version 7 is available now as an <a href="http://www.imagemagick.org/download/beta/">Beta</a> release. Look for an official release around 1st Q 2016. 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>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]67
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]68<p>Once ImageMagick version 7 is released, we will continue to support and enhance version 6 for a minimum of 10 years.</p>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]69
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]70<h2 class="magick-header"><a id="hdri"></a>High Dynamic Range Imaging</h2>
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]71<p>ImageMagick version 7 enables <a href="high-dynamic-range.html">high dynamic range imaging</a> (HDRI) by default. HDRI accurately represents the wide range of intensity levels found in real scenes ranging from the brightest direct sunlight to the deepest darkest shadows. In addition, image processing results are more accurate. The disadvantage is it requires more memory and may result in slower processing times. If you see differences in the results of your version 6 command-line with version 7, it is likely due to HDRI. You may need to add <code>-clamp</code> to your command-line to constrain pixels to the 0 .. QuantumRange range, or disable HDRI when you build ImaegMagick version 7. To disable HDRI (recommended for smart phone builds such as iOS), simply add <code>--disable-hdri</code> to the configure script command line when building ImageMagick.</p>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]72
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]73<h2 class="magick-header"><a id="channels"></a>Pixel Channels</h2>
74<p>A pixel is comprised of one or more color values, or <var>channels</var> (e.g. red pixel channel).</p>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]75<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>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]76
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]77<code>
78<textarea class="form-control" rows="15">for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]79{
80 register IndexPacket
81 *indexes;
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]82
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]83 register PixelPacket
84 *q;
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]85
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]86 q=GetCacheViewAuthenticPixels(image_view,0,y,image-&gt;columns,1,exception);
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]87 if (q == (PixelPacket *) NULL)
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]88 {
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]89 status=MagickFalse;
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]90 continue;
91 }
92 indexes=GetCacheViewAuthenticIndexQueue(image_view);
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]93 for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]94 {
95 if ((channel &amp; RedChannel) != 0)
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]96 q-&gt;red=(Quantum) QuantumRange-q-&gt;red;
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]97 if ((channel &amp; GreenChannel) != 0)
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]98 q-&gt;green=(Quantum) QuantumRange-q-&gt;green;
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]99 if ((channel &amp; BlueChannel) != 0)
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]100 q-&gt;blue=(Quantum) QuantumRange-q-&gt;blue;
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]101 if (((channel &amp; IndexChannel) != 0) &amp;&amp;
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]102 (image-&gt;colorspace == CMYKColorspace))
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]103 indexes[x]=(IndexPacket) QuantumRange-indexes[x];
104 q++;
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]105 }
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]106 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
107 status=MagickFalse;
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]108}</textarea>
109</code>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]110
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]111<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>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]112
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]113<code>
114<textarea class="form-control" rows="15">for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]115{
116 register Quantum
117 *q;
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]118
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]119 q=GetCacheViewAuthenticPixels(image_view,0,y,image-&gt;columns,1,exception);
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]120 if (q == (Quantum *) NULL)
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]121 {
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]122 status=MagickFalse;
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]123 continue;
124 }
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]125 for (x=0; x &lt; (ssize_t) image-&gt;columns; x++)
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]126 {
127 if ((GetPixelRedTraits(image) &amp; UpdatePixelTrait) != 0)
128 SetPixelRed(image,QuantumRange-GetPixelRed(image,q),q);
129 if ((GetPixelGreenTraits(image) &amp; UpdatePixelTrait) != 0)
130 SetPixelGreen(image,QuantumRange-GetPixelGreen(image,q),q);
131 if ((GetPixelBlueTraits(image) &amp; UpdatePixelTrait) != 0)
132 SetPixelBlue(image,QuantumRange-GetPixelBlue(image,q),q);
133 if ((GetPixelBlackTraits(image) &amp; UpdatePixelTrait) != 0)
134 SetPixelBlack(image,QuantumRange-GetPixelBlack(image,q),q);
135 if ((GetPixelAlphaTraits(image) &amp; UpdatePixelTrait) != 0)
136 SetPixelAlpha(image,QuantumRange-GetPixelAlpha(image,q),q);
137 q+=GetPixelChannels(image);
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]138 }
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]139 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
140 status=MagickFalse;
141}
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]142</textarea>
143</code>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]144
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]145<p>Let's do that again but take full advantage of the new variable pixel channel support:</p>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]146
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]147<code>
148<textarea class="form-control" rows="15">for (y=0; y &lt; (ssize_t) image-&gt;rows; y++)
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]149{
150 register Quantum
151 *q;
152
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]153 q=GetCacheViewAuthenticPixels(image_view,0,y,image-&gt;columns,1,exception);
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]154 if (q == (Quantum *) NULL)
155 {
156 status=MagickFalse;
157 continue;
158 }
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]159 for (x = 0; x &lt; (ssize_t) image-&gt;columns; x++)
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]160 {
161 register ssize_t
162 i;
163
164 if (GetPixelReadMask(image,q) == 0)
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]165 {
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]166 q+=GetPixelChannels(image);
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]167 continue;
168 }
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]169 for (i=0; i &lt; (ssize_t) GetPixelChannels(image); i++)
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]170 {
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]171 PixelChannel channel=GetPixelChannelChannel(image,i);
172 PixelTrait traits=GetPixelChannelTraits(image,channel);
173 if ((traits &amp; UpdatePixelTrait) == 0)
174 continue;
175 q[i]=QuantumRange-q[i];
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]176 }
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]177 q+=GetPixelChannels(image);
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]178 }
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]179 if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
180 status=MagickFalse;
181}
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]182</textarea>
183</code>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]184
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]185<p>Note, how we use GetPixelChannels() to advance to the next set of pixel channels.</p>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]186
cristy7865f2d2015-03-08 13:15:40 +0000[diff] [blame]187<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 first class pixel channel and accessed as a member of the pixel array (e.g. <code>pixel[4]</code>) or with the convenience pixel accessor methods GetPixelIndex(), SetPixelIndex(), GetPixelBlack(), and SetPixelBlack().</p>
cristy29c5c992011-06-25 13:58:49 +0000[diff] [blame]188
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]189<p>As a consequence of using an array structure for variable pixel channels, auto-vectorization compilers have additional opportunities to speed up pixel loops.</p>
190
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]191<h4>Pixel Accessors</h4>
cristy7865f2d2015-03-08 13:15:40 +0000[diff] [blame]192<p>You can access pixel channel as array elements (e.g. <code>pixel[1]</code>) or use convenience accessors to get or set pixel channels:</p>
cristy87a7f072011-07-01 00:08:52 +0000[diff] [blame]193
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]194<pre>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]195GetPixela() SetPixela()
196GetPixelAlpha() SetPixelAlpha()
197GetPixelb() SetPixelb()
198GetPixelBlack() SetPixelBlack()
199GetPixelBlue() SetPixelBlue()
200GetPixelCb() SetPixelCb()
201GetPixelCr() SetPixelCr()
202GetPixelCyan() SetPixelCyan()
203GetPixelGray() SetPixelGray()
204GetPixelGreen() SetPixelGreen()
205GetPixelIndex() SetPixelIndex()
206GetPixelL() SetPixelL()
207GetPixelMagenta() SetPixelMagenta()
208GetPixelReadMask() SetPixelReadMask()
209GetPixelWriteMask() SetPixelWriteMask()
210GetPixelMetacontentExtent() SetPixelMetacontentExtent()
211GetPixelOpacity() SetPixelOpacity()
212GetPixelRed() SetPixelRed()
213GetPixelYellow() SetPixelYellow()
214GetPixelY() SetPixelY()
cristy87a7f072011-07-01 00:08:52 +0000[diff] [blame]215</pre>
216
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]217<p>You can find these accessors defined in the header file, <code>MagickCore/pixel-accessor.h</code></p>
cristy87a7f072011-07-01 00:08:52 +0000[diff] [blame]218
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]219<h4>Pixel Traits</h4>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]220<p>Each pixel channel includes one or more of these traits:</p>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]221<dl class="dl-horizontal">
cristya4dfb122011-07-07 19:01:57 +0000[diff] [blame]222<dt>Undefined</dt>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]223<dd>no traits associated with this pixel channel</dd>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]224<dt>Copy</dt>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]225<dd>do not update this pixel channel, just copy it</dd>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]226<dt>Update</dt>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]227<dd>update this pixel channel</dd>
cristya4dfb122011-07-07 19:01:57 +0000[diff] [blame]228<dt>Blend</dt>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]229<dd>blend this pixel channel with the alpha mask if it's enabled</dd>
cristya4dfb122011-07-07 19:01:57 +0000[diff] [blame]230</dl>
231<p>We provide these methods to set and get pixel traits:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]232<pre>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]233GetPixelAlphaTraits() SetPixelAlphaTraits()
234GetPixelBlackTraits() SetPixelBlackTraits()
235GetPixelBlueTraits() SetPixelBlueTraits()
236GetPixelCbTraits() SetPixelCbTraits()
237GetPixelChannelTraits() SetPixelChannelTraits()
238GetPixelCrTraits() SetPixelCrTraits()
239GetPixelGrayTraits() SetPixelGrayTraits()
240GetPixelGreenTraits() SetPixelGreenTraits()
241GetPixelIndexTraits() SetPixelIndexTraits()
242GetPixelMagentaTraits() SetPixelMagentaTraits()
243GetPixelRedTraits() SetPixelRedTraits()
244GetPixelYellowTraits() SetPixelYellowTraits()
245GetPixelYTraits() SetPixelYTraits()
cristya4dfb122011-07-07 19:01:57 +0000[diff] [blame]246</pre>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]247<p>For convenience you can set the active trait for a set of pixel channels with a channel mask and this method:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]248<pre>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]249SetImageChannelMask()
cristya4dfb122011-07-07 19:01:57 +0000[diff] [blame]250</pre>
251
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]252<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 or whether to blend with the alpha mask. For example, instead of</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]253<pre>
254NegateImageChannel(image,channel);
cristya4dfb122011-07-07 19:01:57 +0000[diff] [blame]255</pre>
256<p>we use:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]257<pre>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]258channel_mask=SetImageChannelMask(image,channel);
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]259NegateImage(image,exception);
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]260(void) SetImageChannelMask(image,channel_mask);
cristya4dfb122011-07-07 19:01:57 +0000[diff] [blame]261</pre>
262
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]263<h4>Pixel User Channels</h4>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]264<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>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]265<h4>Pixel Metacontent</h4>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]266<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 (internally the data is just copied, it is not modified) and is accessed with these MagickCore API methods:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]267<pre>
268SetImageMetacontentExtent()
269GetImageMetacontentExtent()
270GetVirtualMetacontent()
271GetAuthenticMetacontent()
272GetCacheViewAuthenticMetacontent()
273GetCacheViewVirtualMetacontent()
cristy87a7f072011-07-01 00:08:52 +0000[diff] [blame]274</pre>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]275
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]276<h2 class="magick-header"><a id="alpha"></a>Alpha</h2>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]277<p>We support alpha now, previously opacity. With alpha, a value of <kbd>0</kbd> 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 <code>QuantumRange</code> 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. Another consequence is the alpha part of a sRGB value in hexadecimal notation is now reversed (e.g. #0000 is fully transparent).</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]278<h2 class="magick-header"><a id="colorspace"></a>Colorspace</h2>
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]279<p>The <code>Rec601Luma</code> and <code>Rec709Luma</code> colorspaces are no longer supported. Instead, specify the <code>gray</code> colorspace and choose from these intensity options:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]280<pre>
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]281Rec601Luma
282Rec601Luminance
283Rec709Luma
284Rec709Luminance
285</pre>
286<p>For example,</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]287<pre>
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]288convert myImage.png -intensity Rec709Luminance -colorspace gray myImage.jpg
289</pre>
290
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]291<h2 class="magick-header"><a id="grayscale"></a>Grayscale</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]292<p>Previously, grayscale images were Rec601Luminance and consumed 4 channels: red, green, blue, and alpha. With version 7, grayscale consumes only 1 channel requiring far less resources as a result.</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]293
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]294<h2 class="magick-header"><a id="mask"></a>Masks</h2>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]295<p>Version 7 supports masks for most image operators. As an example, here are two methods to compute the statistics of any pixel selected by the image mask:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]296<pre>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]297identify -verbose -clip statue.tif
298identify -verbose -read-mask mask.png statue.tif
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]299</pre>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]300
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]301<h2 class="magick-header"><a id="core"></a>MagickCore API</h2>
302<p>Here are a list of changes to the MagickCore API:</p>
303<ul>
304<li>Almost all image processing algorithms are now channel aware.</li>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]305<li>The MagickCore API adds an <code>ExceptionInfo</code> argument to those methods that lacked it in version 6, e.g. <code>NegateImage(image,MagickTrue,exception</code>);</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]306<li>All method channel analogs have been removed (e.g. BlurImageChannel()), they are no longer necessary, use pixel traits instead.</li>
307<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>
308<li>The InterpolatePixelMethod enum is now PixelInterpolateMethod.</li>
309<li>The IntegerPixel storage type is removed (use LongPixel instead) and LongLongPixel is added</li>
310<li>Image signatures have changed to account for variable pixel channels.</li>
311<li>All color packet structures, PixelPacket, LongPacket, and DoublePacket, are consolidated to a single color structure, PixelInfo.</li>
312<li>The ChannelMoments structure member <code>I</code> is now <code>invariant</code>. <code>I</code> conflicts with the <code>complex.h</code> header.</li>
313<li>We added a length parameter to FormatMagickSize() to permit variable length buffers.</li>
314</ul>
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]315<h2 class="magick-header"><a id="core"></a>MagickWand API</h2>
316<p>Here are a list of changes to the MagickWand API:</p>
317<ul>
318<li>The DrawMatte() method is now called DrawAlpha().</li>
319<li>The MagickSetImageBias() and MagickSetImageClipMask() methods are no longer supported.</li>
320</ul>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]321<h2 class="magick-header"><a id="headers"></a>Header Files</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]322<p>Prior versions of ImageMagick (4-6) reference the ImageMagick header files as <code>magick/</code> and <code>wand/</code>. ImageMagick 7 instead uses <code>MagickCore/</code> and <code>MagickWand/</code> respectively. For example,</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]323<pre><code>#include &lt;MagickCore/MagickCore.h&gt;
324#include &lt;MagickWand/MagickWand.h&gt;</code></pre>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]325
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]326<h2 class="magick-header"><a id="deprecate"></a>Deprecated Features Removed</h2>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]327<p>All deprecated features from ImageMagick version 6 are removed in version 7. These include the <code>Magick-config</code> and <code>Wand-config</code> configuration utilities. Instead use:</p>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]328
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]329<pre>MagickCore-config
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]330MagickWand-config
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]331</pre>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]332<p>The FilterImage() method has been removed. Use ConvolveImage() instead.</p>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]333
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]334<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>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]335
336
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]337<h2 class="magick-header"><a id="cli"></a>Shell API or Command-line Interface</h2>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]338
339<p>As mentioned the primary focus of the changes to the Shell API or Command
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]340Line Interface is the abstraction so that not only can <var>options</var> be read
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]341from command line arguments, but also from a file (script) or from a file
342stream (interactive commands, or co-processing). </p>
343
344<p>To do this the CLI parser needed to be re-written, so as to always perform
345all options, in a strict, do-it-as-you-see it order. Previously in IMv6
346options were performed in groups (known as 'FireOptions), this awkwardness is
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]347now gone. However the strict order means that you can no longer give operations
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]348before providing an image for the operations to work on. To do so will now
349produce an error. </p>
350
351<p>Error reporting is now reporting exactly which option (by argument count on
352command line, or line,column in scripts) caused the 'exception'. This is not
353complete as yet but getting better. Also not complete is 'regard-warnings'
354handling or its replacement, which will allow you to ignore reported errors
355and continue processing (as appropriate due to error) in co-processes or
356interactive usage. </p>
357
358<p>The parenthesis options used to 'push' the current image list, and image
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]359settings (EG: '<code>(</code>' and '<code>)</code>' ) on to a stack now has
cristy91469932014-07-25 11:00:25 +0000[diff] [blame]360a completely separate image settings stack. That is parenthesis 'push/pull'
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]361image lists, and curly braces (EG: '<code>{</code>' and '<code>}</code>' ) will
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]362'push/pull' image settings. </p>
363
364<p>Of course due to the previously reported changes to the underlying channel
365handling will result be many side effects to almost all options. Here are some
366specific </p>
367
368<p>Most algorithms update the red, green, blue, black (for CMYK), and alpha
369channels. Most operators will blend alpha the other color channels, but other
370operators (and situations) may require this blending to be disabled, and is
371currently done by removing alpha from teh active channels via
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]372<code>-channel</code> option. (e.g. <code>convert castle.gif -channel RGB
373-negate castle.png</code>). </p>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]374
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]375<p>Reading gray-scale images generate an image with only one channel. If
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]376that image is to then accept color the <code>-colorspace</code> setting needs to
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]377be applied to expand the one channel into separate RGB (or other) channels.
378</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]379<p>Previously, command-line arguments were limited to 4096 characters, with ImageMagick version 7 the limit has increased to 131072 characters.</p>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]380
381<h3>Command Changes</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]382<p>Here are a list of changes to the ImageMagick commands:</p>
383<dl class="dl-horizontal">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]384<dt>magick</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]385<dd>The "<code>magick</code>" command is the new primary command of the Shell
386 API, replacing the old "<code>convert</code>" command. This allows you to
387 create a 'magick script' of the form "<code>#!/path/to/command/magick
388 -script</code>", or pipe options into a command "<code>magick -script
389 -</code>, as abackground process. </dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]390
391<dt>magick-script</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]392<dd>This the same as "<code>magick</code>", (only command name is different)
393 but which has an implict "<code>-script</code>" option. This allows you to
394 use it in an "<code>env</code>" style script form. That is a magick script
395 starts with the 'she-bang' line of "<code>#!/usr/bin/env
396 magick-script</code>" allowing the script interpreter to be found anywhere
397 on the users command "<code>PATH</code>". This is required to get around
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]398 a "one argument she-bang bug" that is common on most UNIX systems
399 (including Linux, but not MacOSX).</dd>
400
401</dl>
402
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]403<h3>Behavioral Changes</h3>
404<p>Image settings are applied to each image on the command line. To associate a setting with a particular image, use parenthesis to remove ambiguity. In this example we assign a unique page offset to each image:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]405<pre>
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]406convert \( -page +10+20 first.png \) \( -page +100+200 second.png \) ...
407</pre>
408
409<p>By default, image operations such as convolution blends alpha with each channel. To convolve each channel independently, deactivate the alpha channel as follows:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]410<pre>
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]411convert ... -alpha discrete -blur 0x1 ...
412</pre>
413<p>To just copy the alpha values, use <code>-alpha off</code>.</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]414<p>Some options have changed in ImageMagick version 7. These include:</p>
415<dl>
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]416<dt>+combine</dt>
417<dd>This option now requires an argument, the image colorspace (e.g. +combine sRGB).</dd>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]418</dl>
419
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]420<h3>New Options</h3>
421<p>ImageMagick version 7 supports these new options, though most are limited
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]422to the "<code>magick</code>" command, or to use in "<code>magick</code>"
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]423scripts.</p>
424
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]425<dl class="dl-horizontal">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]426<dt>{ ... }</dt>
427<dd>Save (and restore) the current image settings (internally known as the
428 "image_info" structure). This is automatically done with parenthesis (EG:
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]429 '<code>(</code>' and '<code>)</code>') is "<code>-regard-parenthesis</code>" has
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]430 been set, just as in IMv6. Caution is advised to prevent un-balanced
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]431 braces errors.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]432
433<dt>--</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]434<dd>End of options, to be used in IMv7 "<code>mogrify</code>" command to
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]435 explicitly separate the operations to be applied and the images that
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]436 are to be processed 'in-place'. (not yet implemented). However if
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]437 not provided, "<code>-read</code>" can still be used to differentiate
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]438 secondary image reads (for use in things like alpha composition) from
439 the 'in-place' image being processed. </dd>
440
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]441<dd>In other commands (such as "magick") it is equivalent to a explicit
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]442 "<code>-read</code>" (see below) of the next option as a image (as it was in
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]443 IMv6). </dd>
444
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]445<dt>-alpha discrete</dt>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]446<dd>treat the alpha channel independently (do not blend).</dd>
447
448<dt>-channel-fx <var>expression</var> </dt>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]449<dd>
450<p>exchange, extract, or copy one or more image channels.</p>
451
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]452<p>The expression consists of one or more channels, either mnemonic or numeric (e.g. red or 0, green or 1, etc.), separated by certain operation symbols as follows:</p>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]453
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]454<pre>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]455&lt;=&gt; exchange two channels (e.g. red&lt;=&gt;blue)
456=&gt; copy one channel to another channel (e.g. red=&gt;green)
457= assign a constant value to a channel (e.g. red=50%)
458, write new image with channels in the specified order (e.g. red, green)
459; add a new output image for the next set of channel operations (e.g. red; green; blue)
460| move to the next input image for the source of channel data (e.g. | gray=&gt;alpha)
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]461</pre>
462
463<p>For example, to create 3 grayscale images from the red, green, and blue channels of an image, use:</p>
464
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]465<pre>
466-channel-fx "red; green; blue"
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]467</pre>
468
469<p>A channel without an operation symbol implies separate (i.e, semicolon).</p>
470
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]471<p>Here we take an sRGB image and a grayscale image and inject the grayscale image into the alpha channel:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]472<pre>
473convert wizard.png mask.pgm -channel-fx '| gray=&gt;alpha' wizard-alpha.png
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]474</pre>
475<p>Use a similar command to define a read mask:</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]476<pre>
477convert wizard.png mask.pgm -channel-fx '| gray=&gt;read-mask' wizard-mask.png
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]478</pre>
479
480<p>Add <code>-debug pixel</code> prior to the <code>-channel-fx</code> option to track the channel morphology.</p>
481
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]482</dd>
483
484<dt>-exit</dt>
485<dd>Stop processing at this point. No further options will be processed after
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]486 this option. Can be used in a script to force the "<code>magick</code>"
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]487 command to exit, without actually closing the pipeline that it is
488 processing options from. </dd>
489
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]490<dd>May also be used as a 'final' option on the "<code>magick</code>" command
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]491 line, instead of a implicit output image, to completely prevent any image
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]492 write. ASIDE: even the "<code>NULL:</code>" coder requires at least one
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]493 image, for it to 'not write'! This option does not require any images at
494 all. </dd>
495
496<dt>-read {image}</dt>
497<dd>Explicit read of an image, rather than an implicit read. This allows you
498 to read from filenames that start with an 'option' character, and which
499 otherwise could be mistaken as an option (unknown or otherwise). This will
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]500 eventually be used in "<code>mogrify</code>" to allow the reading of
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]501 secondary images, and allow the use of image list operations within that
502 command. </dd>
503
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]504<dt>-read-mask</dt>
505<dd>prevent updates to image pixels specified by the mask</dd>
506
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]507<dt>-region</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]508<dd>not yet implemented in "<code>magick</code>". (very soon)</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]509
510<dt>-script {file}</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]511<dd>In "<code>magick</code>", stop the processing of command line arguments as
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]512 image operations, and read all further options from the given file or
513 pipeline.</dd>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]514<dt>-write-mask</dt>
515<dd>prevent pixels from being written.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]516
517</dl>
518
519<h3>Changed Options</h3>
520<p>These options are known to have changed, in some way.</p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]521<dl class="dl-horizontal">
522<dt>-bias</dt>
523<dd>The option is no longer recognized. Use <code>-define convolve:bias=<var>value</var></code> instead.</dd>
524<dt>-draw</dt>
525<dd>The <code>matte</code> primitive is now <code>alpha</code> (e.g. <code>-draw 'alpha 0,0 floodfill'</code>).</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]526<dt>-negate</dt>
527<dd>currently negates all channels, including alpha if present. As such you
528 may need to use the -channel option to prevent alpha negation. </dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]529</dl>
530
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]531<h3>Deprecated warning given, but will work (for now)</h3>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]532<dl class="dl-horizontal">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]533<dt>-affine</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]534<dd>Replaced by <code>-draw "affine ..."</code>. (see transform)</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]535<dt>-average</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]536<dd>Replaced by <code>-evaluate-sequence Mean</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]537<dt>-box</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]538<dd>Replaced by <code>-undercolor</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]539<dt>-deconstruct</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]540<dd>Replaced by <code>-layers CompareAny</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]541<dt>-gaussian</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]542<dd>Replaced by <code>-gaussian-blur</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]543<dt>-/+map</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]544<dd>Replaced by <code>-/+remap</code>.</dd>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]545<dt>-/+mask</dt>
546<dd>Replaced by <code>-/+read-mask</code>, <code>-/+write-mask</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]547<dt>-/+matte</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]548<dd>Replaced by <code>-alpha Set/Off</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]549<dt>-transform</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]550<dd>Replaced by <code>-distort Affine "..."</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]551</dl>
552
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]553<h3>Deprecated warning given, and ignored (for now)</h3>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]554<p>Almost 'plus' (+) option that did not do anything has been marked as
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]555deprecated, and does nothing. It does not even have associated code. For
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]556example "+annotate", "+resize", "+clut", and "+draw" .</p>
557
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]558<dl class="dl-horizontal">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]559<dt>-affinity</dt>
cristy37b3d442015-02-28 14:00:30 +0000[diff] [blame]560<dd>Replaced by <code>-remap</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]561<dt>-maximum</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]562<dd>Replaced by <code>-evaluate-sequence Max</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]563<dt>-median</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]564<dd>Replaced by <code>-evaluate-sequence Median</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]565<dt>-minimum</dt>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]566<dd>Replaced by <code>-evaluate-sequence Min</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]567<dt>-recolor</dt>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]568<dd>Replaced by <code>-color-matrix</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]569</dl>
570
571<h3>Removed / Replaced Options ("no such option" error and abort)</h3>
572
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]573<dl class="dl-horizontal">
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]574<dt>-origin</dt>
575<dd>old option, unknown meaning.</dd>
576<dt>-pen</dt>
cristy149d58c2013-08-07 19:44:54 +0000[diff] [blame]577<dd>Replaced by <code>-fill</code>.</dd>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]578<dt>-passphrase</dt>
579<dd>old option, unknown meaning</dd>
580</dl>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]581<h2 class="magick-header"><a id="summary"></a>Version 7 Change Summary</h2>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame]582<p>Changes from ImageMagick version 6 to version 7 are summarized here:</p>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]583<h4>High Dynamic Range Imaging</h4>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]584<ul>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]585<li>ImageMagick version 7 enables HDRI by default. Expect more accurate image processing results with higher memory requirement and possible slower processing times.</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]586</ul>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]587<h4>Pixels</h4>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]588<ul>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]589<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>
590<li>Use convenience macros to access pixel channels (e.g. GetPixelRed(), SetPixelRed()).</li>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]591<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>
592<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>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]593<li>Use GetPixelChannels() to advance to the next set of pixel channels.</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]594<li>Use the <var>metacontent</var> channel to associate metacontent with each pixel.</li>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]595<li>All color packet structures, PixelPacket, LongPacket, and DoublePacket, are consolidated to a single color structure, PixelInfo.</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]596</ul>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]597<h4>Alpha</h4>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]598<ul>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]599<li>We support alpha rather than opacity (0 transparent; QuantumRange opaque).</li>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]600<li>Use GetPixelAlpha() or SetPixelAlpha() to get or set the alpha pixel channel value.</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]601</ul>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]602<h4>Grayscale</h4>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]603<ul>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]604<li>Grayscale images consume one pixel channel in ImageMagick version 7. To process RGB, set the colorspace to RGB (e.g. -colorspace sRGB).</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]605</ul>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]606<h4>Masks</h4>
607<ul>
608<li>ImageMagick version 6 only supports read mask in limited circumstances. Version 7 supports both a read and write mask. The read mask is honored by most image-processing algorithms.</li>
609</ul>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]610<h4>MagickCore API</h4>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]611<ul>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]612<li>Almost all image processing algorithms are now channel aware.</li>
cristy6e51a242015-06-07 14:41:36 +0000[diff] [blame]613<li>MagickCore, version 7, adds an ExceptionInfo argument to those methods that lacked it in version 6, e.g. <code>NegateImage(image,MagickTrue,exception);</code></li>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]614<li>All method channel analogs have been removed (e.g. BlurImageChannel()), they are no longer necessary, use pixel traits instead.</li>
cristyeed6cb62012-01-28 19:38:34 +0000[diff] [blame]615<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>
616<li>The InterpolatePixelMethod enum is now PixelInterpolateMethod.</li>
617<li>To account for variable pixel channels, images may now return a different signature.</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]618</ul>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame]619<h4>Deprecated Methods</h4>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]620<ul>
cristy2dcd6822011-06-13 16:21:20 +0000[diff] [blame]621<li>All ImageMagick version 6 MagickCore and MagickWand deprecated methods are removed and no longer available in ImageMagick version 7.</li>
cristya4dfb122011-07-07 19:01:57 +0000[diff] [blame]622<li>All MagickCore channel method analogs are removed (e.g. NegateImageChannels()). For version 7, use pixel traits instead.</li>
cristy1efc1ab2011-08-01 14:47:02 +0000[diff] [blame]623<li>The FilterImage() method has been removed. Use ConvolveImage() instead.</li>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]624</ul>
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]625</div>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]626 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]627 <p><a href="support.html">Donate</a> •
628 <a href="sitemap.html">Sitemap</a> •
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]629 <a href="links.html">Related</a> •
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]630 <a href="architecture.html">Architecture</a>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]631</p>
632 <p><a href="porting.html#">Back to top</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]633 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]634 <a href="http://nextgen.imagemagick.org/script/contact.php">Contact Us</a></p>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]635 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]636 </footer>
637</div><!-- /.container -->
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]638
cristyd2432012015-05-04 23:15:15 +0000[diff] [blame]639 <script src="https://localhost/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]640 <script src="http://nextgen.imagemagick.org/js/magick.html"></script>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]641</div>
cristyad41c0c2012-10-31 00:49:28 +0000[diff] [blame]642</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]643</html>