• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1
2
3
4
5<!DOCTYPE html>
6<html lang="en">
7<head>
8  <meta charset="utf-8"  />
9  <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,shrink-to-fit=no"  />
10  <title>ImageMagick - Porting to ImageMagick Version 7</title>
11  <meta name="application-name" content="ImageMagick" />
12  <meta name="description" content="Use ImageMagick® to create, edit, compose, and convert bitmap images. Resize an image, crop it, change its shades and colors, add captions, and more." />
13  <meta name="application-url" content="https://imagemagick.org" />
14  <meta name="generator" content="PHP" />
15  <meta name="keywords" content="porting, to, imagemagick, version, 7, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert" />
16  <meta name="rating" content="GENERAL" />
17  <meta name="robots" content="INDEX, FOLLOW" />
18  <meta name="generator" content="ImageMagick Studio LLC" />
19  <meta name="author" content="ImageMagick Studio LLC" />
20  <meta name="revisit-after" content="2 DAYS" />
21  <meta name="resource-type" content="document" />
22  <meta name="copyright" content="Copyright (c) 1999-2020 ImageMagick Studio LLC" />
23  <meta name="distribution" content="Global" />
24  <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
25  <meta property='og:url' content='../' />
26  <meta property='og:title' content='ImageMagick' />
27  <meta property='og:image' content='../images/logo.png' />
28  <meta property='og:type' content='website' />
29  <meta property='og:site_name' content='ImageMagick' />
30  <meta property='og:description' content="Convert, Edit, or Compose Bitmap Images" />
31  <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
32  <link href="../www/porting.html" rel="canonical" />
33  <link href="../images/wand.png" rel="icon" />
34  <link href="../images/wand.ico" rel="shortcut icon" />
35  <link href="assets/magick.css" rel="stylesheet" />
36</head>
37<body>
38  <nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark">
39    <a class="navbar-brand" href="../index.html"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a>
40    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsMagick" aria-controls="navbarsMagick" aria-expanded="false" aria-label="Toggle navigation">
41      <span class="navbar-toggler-icon"></span>
42    </button>
43
44    <div class="navbar-collapse collapse" id="navbarsMagick" style="">
45    <ul class="navbar-nav mr-auto">
46      <li class="nav-item ">
47        <a class="nav-link" href="../index.html">Home <span class="sr-only">(current)</span></a>
48      </li>
49      <li class="nav-item ">
50        <a class="nav-link" href="download.html">Download</a>
51      </li>
52      <li class="nav-item ">
53        <a class="nav-link" href="command-line-tools.html">Tools</a>
54      </li>
55      <li class="nav-item ">
56        <a class="nav-link" href="command-line-processing.html">Command-line</a>
57      </li>
58      <li class="nav-item ">
59        <a class="nav-link" href="resources.html">Resources</a>
60      </li>
61      <li class="nav-item ">
62        <a class="nav-link" href="develop.html">Develop</a>
63      </li>
64      <li class="nav-item">
65        <a class="nav-link" target="_blank" href="https://imagemagick.org/discourse-server/">Community</a>
66      </li>
67    </ul>
68    <form class="form-inline my-2 my-lg-0" action="https://imagemagick.org/script/search.php">
69      <input class="form-control mr-sm-2" type="text" name="q" placeholder="Search" aria-label="Search">
70      <button class="btn btn-outline-success my-2 my-sm-0" type="submit" name="sa">Search</button>
71    </form>
72    </div>
73  </nav>
74  <div class="container">
75   <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
76         style="display:block"
77         data-ad-client="ca-pub-3129977114552745"
78         data-ad-slot="6345125851"
79         data-full-width-responsive="true"
80         data-ad-format="horizontal"></ins>
81    <script>
82      (adsbygoogle = window.adsbygoogle || []).push({});
83    </script>
84
85  </div>
86
87  <main class="container">
88    <div class="magick-template">
89<div class="magick-header">
90
91<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>
92
93<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 improved 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.  In addition, ImageMagick 7 stores pixel channels as floats permitting out of band values (e.g. negative) and reduces rounding error.  There are numerous other design enhancements described within.</p>
94
95<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>
96
97<p>The shell API (command line) of ImageMagick version 7 has undergone
98a major overhaul, with specific emphasis on the ability to read 'options' not
99only from the command line, but also from scripts, and file streams. This
100allows for the use of 'co-processing' programming techniques or performing
101image handling using 'deamon/server backends', and even multi-machine
102distributed processing.</p>
103
104<p>With the shell API overhaul other improvements were made, including:
105better reporting of which option failed, the consolidation and deprecation of
106options, and more global use of 'image properties' (more commonly known as
107'percent escapes' in option arguments. </p>
108
109<p>ImageMagick version 7 is available now as a <a href="../download">production</a> release.</p>
110
111<p>Now that ImageMagick version 7 is released, we continue to support and enhance version 6 for a minimum of 10 years.</p>
112
113<h2><a class="anchor" id="hdri"></a>High Dynamic Range Imaging</h2>
114<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 ImageMagick version 7.  To disable HDRI (recommended for smart phone builds such as iOS or production sites where performance is a premium), simply add <code>--disable-hdri</code> to the configure script command line when building ImageMagick.</p>
115
116<h2><a class="anchor" id="channels"></a>Pixel Channels</h2>
117<p>A pixel is comprised of one or more color values, or <var>channels</var> (e.g. red pixel channel).</p>
118<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>
119
120<pre class="pre-scrollable"><code>for (y=0; y &lt; (ssize_t) image->rows; y++)
121{
122  register IndexPacket
123    *indexes;
124
125  register PixelPacket
126    *q;
127
128  q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
129  if (q == (PixelPacket *) NULL)
130    {
131      status=MagickFalse;
132      continue;
133    }
134  indexes=GetCacheViewAuthenticIndexQueue(image_view);
135  for (x=0; x &lt; (ssize_t) image->columns; x++)
136  {
137    if ((channel &amp; RedChannel) != 0)
138      q->red=(Quantum) QuantumRange-q->red;
139    if ((channel &amp; GreenChannel) != 0)
140      q->green=(Quantum) QuantumRange-q->green;
141    if ((channel &amp; BlueChannel) != 0)
142      q->blue=(Quantum) QuantumRange-q->blue;
143    if (((channel &amp; IndexChannel) != 0) &amp;&amp;
144        (image->colorspace == CMYKColorspace))
145      indexes[x]=(IndexPacket) QuantumRange-indexes[x];
146    q++;
147  }
148  if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
149    status=MagickFalse;
150}</code></pre>
151
152<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>
153
154<pre class="pre-scrollable"><code>for (y=0; y &lt; (ssize_t) image->rows; y++)
155{
156  register Quantum
157    *q;
158
159  q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
160  if (q == (Quantum *) NULL)
161    {
162      status=MagickFalse;
163      continue;
164    }
165  for (x=0; x &lt; (ssize_t) image->columns; x++)
166  {
167    if ((GetPixelRedTraits(image) &amp; UpdatePixelTrait) != 0)
168      SetPixelRed(image,QuantumRange-GetPixelRed(image,q),q);
169    if ((GetPixelGreenTraits(image) &amp; UpdatePixelTrait) != 0)
170      SetPixelGreen(image,QuantumRange-GetPixelGreen(image,q),q);
171    if ((GetPixelBlueTraits(image) &amp; UpdatePixelTrait) != 0)
172      SetPixelBlue(image,QuantumRange-GetPixelBlue(image,q),q);
173    if ((GetPixelBlackTraits(image) &amp; UpdatePixelTrait) != 0)
174      SetPixelBlack(image,QuantumRange-GetPixelBlack(image,q),q);
175    if ((GetPixelAlphaTraits(image) &amp; UpdatePixelTrait) != 0)
176      SetPixelAlpha(image,QuantumRange-GetPixelAlpha(image,q),q);
177    q+=GetPixelChannels(image);
178  }
179  if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
180    status=MagickFalse;
181}</code></pre>
182
183<p>Let's do that again but take full advantage of the new variable pixel channel support:</p>
184
185<pre class="pre-scrollable"><code>for (y=0; y &lt; (ssize_t) image->rows; y++)
186{
187  register Quantum
188    *q;
189
190  q=GetCacheViewAuthenticPixels(image_view,0,y,image->columns,1,exception);
191  if (q == (Quantum *) NULL)
192    {
193      status=MagickFalse;
194      continue;
195    }
196  for (x = 0; x &lt; (ssize_t) image->columns; x++)
197  {
198    register ssize_t
199      i;
200
201    if (GetPixelWriteMask(image,q) &lt;= (QuantumRange/2))
202      {
203        q+=GetPixelChannels(image);
204        continue;
205      }
206    for (i=0; i &lt; (ssize_t) GetPixelChannels(image); i++)
207    {
208      PixelChannel channel = GetPixelChannelChannel(image,i);
209      PixelTrait traits = GetPixelChannelTraits(image,channel);
210      if ((traits &amp; UpdatePixelTrait) == 0)
211        continue;
212      q[i]=QuantumRange-q[i];
213    }
214    q+=GetPixelChannels(image);
215  }
216  if (SyncCacheViewAuthenticPixels(image_view,exception) == MagickFalse)
217    status=MagickFalse;
218}</code></pre>
219
220<p>Note, how we use GetPixelChannels() to advance to the next set of pixel channels.</p>
221
222<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>
223
224<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>
225
226<h5>Pixel Accessors</h5>
227<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>
228
229<pre class="highlight"><code>GetPixela()                  SetPixela()
230GetPixelAlpha()              SetPixelAlpha()
231GetPixelb()                  SetPixelb()
232GetPixelBlack()              SetPixelBlack()
233GetPixelBlue()               SetPixelBlue()
234GetPixelCb()                 SetPixelCb()
235GetPixelCr()                 SetPixelCr()
236GetPixelCyan()               SetPixelCyan()
237GetPixelGray()               SetPixelGray()
238GetPixelGreen()              SetPixelGreen()
239GetPixelIndex()              SetPixelIndex()
240GetPixelL()                  SetPixelL()
241GetPixelMagenta()            SetPixelMagenta()
242GetPixelReadMask()           SetPixelReadMask()
243GetPixelWriteMask()          SetPixelWriteMask()
244GetPixelMetacontentExtent()  SetPixelMetacontentExtent()
245GetPixelOpacity()            SetPixelOpacity()
246GetPixelRed()                SetPixelRed()
247GetPixelYellow()             SetPixelYellow()
248GetPixelY()                  SetPixelY()</code></pre>
249
250<p>You can find these accessors defined in the header file, <code>MagickCore/pixel-accessor.h</code></p>
251
252<h5>Pixel Traits</h5>
253<p>Each pixel channel includes one or more of these traits:</p>
254<dl class="row">
255<dt class="col-md-4">Undefined</dt>
256<dd class="col-md-8">no traits associated with this pixel channel</dd>
257<dt class="col-md-4">Copy</dt>
258<dd class="col-md-8">do not update this pixel channel, just copy it</dd>
259<dt class="col-md-4">Update</dt>
260<dd class="col-md-8">update this pixel channel</dd>
261<dt class="col-md-4">Blend</dt>
262<dd class="col-md-8">blend this pixel channel with the alpha mask if it's enabled</dd>
263</dl>
264<p>We provide these methods to set and get pixel traits:</p>
265<pre class="highlight"><code>GetPixelAlphaTraits()    SetPixelAlphaTraits()
266GetPixelBlackTraits()    SetPixelBlackTraits()
267GetPixelBlueTraits()     SetPixelBlueTraits()
268GetPixelCbTraits()       SetPixelCbTraits()
269GetPixelChannelTraits()  SetPixelChannelTraits()
270GetPixelCrTraits()       SetPixelCrTraits()
271GetPixelGrayTraits()     SetPixelGrayTraits()
272GetPixelGreenTraits()    SetPixelGreenTraits()
273GetPixelIndexTraits()    SetPixelIndexTraits()
274GetPixelMagentaTraits()  SetPixelMagentaTraits()
275GetPixelRedTraits()      SetPixelRedTraits()
276GetPixelYellowTraits()   SetPixelYellowTraits()
277GetPixelYTraits()        SetPixelYTraits()</code></pre>
278<p>For convenience you can set the active trait for a set of pixel channels with a channel mask and this method:</p>
279<pre class="highlight"><code>SetImageChannelMask()
280</code></pre>
281
282<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>
283<pre class="highlight"><code>NegateImageChannel(image,channel);</code></pre>
284<p>we use:</p>
285<pre class="highlight"><code>channel_mask=SetImageChannelMask(image,channel);
286NegateImage(image,exception);
287(void) SetImageChannelMask(image,channel_mask);</code></pre>
288
289<h5>Pixel User Channels</h5>
290<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>
291<h5>Pixel Metacontent</h5>
292<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>
293<pre class="highlight"><code>SetImageMetacontentExtent()
294GetImageMetacontentExtent()
295GetVirtualMetacontent()
296GetAuthenticMetacontent()
297GetCacheViewAuthenticMetacontent()
298GetCacheViewVirtualMetacontent()</code></pre>
299
300<h2><a class="anchor" id="alpha"></a>Alpha</h2>
301<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>
302<h2><a class="anchor" id="colorspace"></a>Colorspace</h2>
303<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>
304<pre class="highlight"><code>Rec601Luma
305Rec601Luminance
306Rec709Luma
307Rec709Luminance</code></pre>
308<p>For example,</p>
309<pre class="highlight"><code>convert myImage.png -intensity Rec709Luminance -colorspace gray myImage.jpg</code></pre>
310
311<h2><a class="anchor" id="grayscale"></a>Grayscale</h2>
312<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>
313
314<h2><a class="anchor" id="mask"></a>Masks</h2>
315<p>Version 7 supports masks for most image operators.  White pixels in a read mask ignores corresponding pixel in an image whereas white pixels in a write mask protects the corresponding pixel in the image.  From the command-line, you can associate a mask with an image with the <code>-read-mask</code> and <code>-write-mask</code> options.  This polarity matches the masks in version 6 of ImageMagick for ease of porting your workflow.  For convenience, we continue to support the <code>-mask</code> option in version 7 to match the behavior of version 6.</p>
316<p>In this example, we compute the distortion of a masked reconstructed image:</p>
317<pre class="highlight"><code>compare -metric rmse -read-mask hat_mask.png hat.png wizard.png difference.png</code></pre>
318<p>Here we protect certain pixels from change:</p>
319<pre class="highlight"><code>convert rose: -write-mask rose_bg_mask.png -modulate 110,100,33.3  +mask rose_blue.png</code></pre>
320
321<p>A mask associated with an image persists until it is modified or removed.  This may produce unexpected results for complex command-lines.  Here we only want to clip when applying the alpha option, not the resize:</p>
322<pre class="highlight">
323convert -density 300 -colorspace srgb image.eps -alpha transparent -clip -alpha opaque +clip -resize 1000x1000 -strip image.png
324</pre>
325
326<h2><a class="anchor" id="core"></a>MagickCore API</h2>
327<p>Here are a list of changes to the MagickCore API:</p>
328<ul>
329<li>Almost all image processing algorithms are now channel aware.</li>
330<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>
331<li>All method channel analogs have been removed (e.g. BlurImageChannel()), they are no longer necessary, use pixel traits instead.</li>
332<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>
333<li>The InterpolatePixelMethod enum is now PixelInterpolateMethod.</li>
334<li>The IntegerPixel storage type is removed (use LongPixel instead) and LongLongPixel is added</li>
335<li>Image signatures have changed to account for variable pixel channels.</li>
336<li>All color packet structures, PixelPacket, LongPacket, and DoublePacket, are consolidated to a single color structure, PixelInfo.</li>
337<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>
338<li>We added a length parameter to FormatMagickSize() to permit variable length buffers.</li>
339</ul>
340<h2><a class="anchor" id="core"></a>MagickWand API</h2>
341<p>Here are a list of changes to the MagickWand API:</p>
342<ul>
343<li>Almost all image processing algorithms are now channel aware.</li>
344<li>The DrawMatte() method is now called DrawAlpha().</li>
345<li>The MagickSetImageBias() and MagickSetImageClipMask() methods are no longer supported.</li>
346</ul>
347<h2><a class="anchor" id="core"></a>Magick++ API</h2>
348<p>Here are a list of changes to the Magick++ API:</p>
349<ul>
350<li>Almost all image processing algorithms are now channel aware.</li>
351<li>Use this construct, for example, to avoid operating on the alpha channel:
352<pre class="highlight"><code>image.negateChannel(Magick::ChannelType(Magick::CompositeChannels ^ Magick::AlphaChannel));
353</code></pre>
354</li>
355</ul>
356<h2><a class="anchor" id="headers"></a>Header Files</h2>
357<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>
358<pre class="highlight"><code><code>#include &lt;MagickCore/MagickCore.h>
359#include &lt;MagickWand/MagickWand.h></code></code></pre>
360
361<h2><a class="anchor" id="deprecate"></a>Deprecated Features Removed</h2>
362<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>
363
364<pre class="highlight"><code>MagickCore-config
365MagickWand-config</code></pre>
366<p>The FilterImage() method has been removed.  Use ConvolveImage() instead.</p>
367
368<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>
369
370<p>The Bessel filter was removed as it is an alias for Jinc.  Use -filter Jinc instead.</p>
371
372
373<h2><a class="anchor" id="cli"></a>Shell API or Command-line Interface</h2>
374
375<p>As mentioned the primary focus of the changes to the Shell API or Command
376Line Interface is the abstraction so that not only can <var>options</var> be
377read from command line arguments, but also from a file (script) or from a file
378stream (interactive commands, or co-processing). </p>
379
380<p>To do this the CLI parser needed to be re-written, so as to always perform
381all options, in a strict, do-it-as-you-see it order. Previously in IMv6
382options were performed in groups (known as 'FireOptions), this awkwardness is
383now gone.  However the strict order means that you can no longer give operations
384before providing an image for the operations to work on.  To do so will now
385produce an error. </p>
386
387<p>Error reporting is now reporting exactly which option (by argument count on
388command line, or line,column in scripts) caused the 'exception'.  This is not
389complete as yet but getting better. Also not complete is 'regard-warnings'
390handling or its replacement, which will allow you to ignore reported errors
391and continue processing (as appropriate due to error) in co-processes or
392interactive usage. </p>
393
394<p>With the IMv7 parser, activated by the `magick` utility, settings are applied to each image in memory in turn (if any). While an option: only need to be applied once globally. Using the other utilities directly, or as an argument to the `magick` CLI (e.g. `magick convert`) utilizes the legacy parser.</p>
395
396<p>The parenthesis options used to 'push' the current image list, and image
397settings (EG: '<code>(</code>' and '<code>)</code>' ) on to a stack now has
398a completely separate image settings stack. That is parenthesis 'push/pull'
399image lists, and curly braces (EG: '<code>{</code>' and '<code>}</code>' ) will
400'push/pull' image settings. </p>
401
402<p>Of course due to the previously reported changes to the underlying channel
403handling will result be many side effects to almost all options. Here are some
404specific </p>
405
406<p>Most algorithms update the red, green, blue, black (for CMYK), and alpha
407channels.  Most operators will blend alpha the other color channels, but other
408operators (and situations) may require this blending to be disabled, and is
409currently done by removing alpha from the active channels via
410<code>-channel</code> option.  (e.g. <code>convert castle.gif -channel RGB
411-negate castle.png</code>). </p>
412
413<p>Reading gray-scale images generate an image with only one channel. If
414that image is to then accept color the <code>-colorspace</code> setting needs to
415be applied to expand the one channel into separate RGB (or other) channels.
416</p>
417<p>Previously, command-line arguments were limited to 4096 characters, with ImageMagick version 7 the limit has increased to 131072 characters.</p>
418
419<h3>Command Changes</h3>
420<p>Here are a list of changes to the ImageMagick commands:</p>
421<dl class="row">
422<dt class="col-md-4">magick</dt>
423<dd class="col-md-8">The "<code>magick</code>" command is the new primary command of the Shell
424    API, replacing the old "<code>convert</code>" command. This allows you to
425    create a 'magick script' of the form  "<code>#!/path/to/command/magick
426    -script</code>", or pipe options into a command "<code>magick -script
427    -</code>, as abackground process. </dd>
428
429<dt class="col-md-4">magick-script</dt>
430<dd class="col-md-8">This the same as "<code>magick</code>", (only command name is different)
431    but which has an implicit "<code>-script</code>" option.  This allows you to
432    use it in an "<code>env</code>" style script form.  That is a magick script
433    starts with the 'she-bang' line of "<code>#!/usr/bin/env
434    magick-script</code>" allowing the script interpreter to be found anywhere
435    on the users command "<code>PATH</code>".  This is required to get around
436    a "one argument she-bang bug" that is common on most UNIX systems
437    (including Linux, but not MacOSX).</dd>
438<dt class="col-md-4">animate, compare, composite, conjure, convert, display, identify, import, mogrify, montage, stream</dt>
439<dd class="col-md-8">To reduce the footprint of the command-line utilities, these utilities are symbolic links to the <code>magick</code> utility.  You can also invoke them from the <code>magick</code> utility, for example, use <code>magick convert logo: logo.png</code> to invoke the <code>convert</code> utility.
440</dd></dl>
441
442<h3>Behavioral Changes</h3>
443<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>
444<pre class="highlight"><code>convert \( -page +10+20 first.png \) \( -page +100+200 second.png \) ...</code></pre>
445
446<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>
447<pre class="highlight"><code>convert ... -alpha discrete -blur 0x1 ...</code></pre>
448<p>To remove the alpha values from your image, use <code>-alpha off</code>. If you want to instead persist the alpha channel but not blend the alpha pixels for certain image processing operations, use <code>-alpha deactivate</code> instead.</p>
449<p>Some options have changed in ImageMagick version 7.  These include:</p>
450<dl>
451<dt class="col-md-4">-channel</dt>
452<dd class="col-md-8">the default is to update the RGBA channels, previously, in IMv6, the default was RGB.  If you get results that differ from IMv6, you may need to specify <code>-channel RGB</code> on your command line (e.g. -channel RGB -negate).</dd>
453<dt class="col-md-4">+combine</dt>
454<dd class="col-md-8">This option now requires an argument, the image colorspace (e.g. +combine sRGB).</dd>
455<dt class="col-md-4">-format</dt>
456<dd class="col-md-8">The %Z image property is no longer supported.</dd>
457<dt class="col-md-4">-gamma</dt>
458<dd class="col-md-8">Multiple gamma arguments (e.g. <code>-gamma 1,2,3</code>) are no longer supported, instead use <code>-channel</code> (e.g. <code>-channel blue -gamma 2)</code>.</dd>
459<dt class="col-md-4">-region</dt>
460<dd class="col-md-8">This option sets a write mask for the region you define.  In IMv6, a separate image was cloned instead, operated on, and the results were composited to the source image.  In addition, the draw transformations are relative to the upper left corner of the image, previously in IMv6 they were relative to the region.</dd>
461</dl>
462
463<p>Use <code>-define morphology:showKernel=1</code> to post the morphology or convolution kernel.  Previously it was <code>-define showKernel=1</code>.</p>
464
465<h3>New Options</h3>
466<p>ImageMagick version 7 supports these new options, though most are limited
467to the "<code>magick</code>" command, or to use in "<code>magick</code>"
468scripts.</p>
469
470<dl class="row">
471<dt class="col-md-4">{ ... }</dt>
472<dd class="col-md-8">Save (and restore) the current image settings (internally known as the
473    "image_info" structure).  This is automatically done with parenthesis (EG:
474    '<code>(</code>' and '<code>)</code>') is "<code>-regard-parenthesis</code>" has
475    been set, just as in IMv6.  Caution is advised to prevent un-balanced
476    braces errors.</dd>
477
478<dt class="col-md-4">--</dt>
479<dd class="col-md-8">End of options, to be used in IMv7 "<code>mogrify</code>" command to
480    explicitly separate the operations to be applied and the images that
481    are to be processed 'in-place'.  (not yet implemented).  However if
482    not provided, "<code>-read</code>" can still be used to differentiate
483    secondary image reads (for use in things like alpha composition) from
484    the 'in-place' image being processed.  In other commands (such as "magick") it is equivalent to a explicit "<code>-read</code>" (see below) of the next option as a image (as it was in IMv6).  </dd>
485
486<dt class="col-md-4">-alpha activate/deactivate</dt>
487<dd class="col-md-8">enables and disables the alpha channel, respectively, with persistence. This is like on/off in Imagemagick 6. In Imagemagick 7, -alpha off will remove the alpha channel permanently such that -alpha on will not re-enable it.</dd>
488
489<dt class="col-md-4">-alpha discrete</dt>
490<dd class="col-md-8">treat the alpha channel independently (do not blend).</dd>
491
492<dt class="col-md-4">-channel-fx <var>expression</var> </dt>
493<dd class="col-md-8">
494<p>exchange, extract, or copy one or more image channels.</p>
495
496<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>
497
498<pre class="highlight"><code>&lt;=&gt;  exchange two channels (e.g. red&lt;=&gt;blue)
499=&gt;   copy one channel to another channel (e.g. red=&gt;green)
500=    assign a constant value to a channel (e.g. red=50%)
501,    write new image with channels in the specified order (e.g. red, green)
502;    add a new output image for the next set of channel operations (e.g. red; green; blue)
503|    move to the next input image for the source of channel data (e.g. | gray=>alpha)</code></pre>
504
505<p>For example, to create 3 grayscale images from the red, green, and blue channels of an image, use:</p>
506
507<pre class="highlight"><code>-channel-fx "red; green; blue"</code></pre>
508
509<p>A channel without an operation symbol implies separate (i.e, semicolon).</p>
510
511<p>Here we take an sRGB image and a grayscale image and inject the grayscale image into the alpha channel:</p>
512<pre class="highlight"><code>convert wizard.png mask.pgm -channel-fx '| gray=>alpha' wizard-alpha.png</code></pre>
513<p>Use a similar command to define a read mask:</p>
514<pre class="highlight"><code>convert wizard.png mask.pgm -channel-fx '| gray=>read-mask' wizard-mask.png</code></pre>
515
516<p>Add <code>-debug pixel</code> prior to the <code>-channel-fx</code> option to track the channel morphology.</p>
517
518</dd>
519
520<dt class="col-md-4">-exit</dt>
521<dd class="col-md-8">Stop processing at this point. No further options will be processed after
522    this option. Can be used in a script to force the "<code>magick</code>"
523    command to exit, without actually closing the pipeline that it is
524    processing options from.  May also be used as a 'final' option on the "<code>magick</code>" command
525    line, instead of a implicit output image, to completely prevent any image
526    write. ASIDE: even the "<code>NULL:</code>" coder requires at least one
527    image, for it to 'not write'! This option does not require any images at
528    all. </dd>
529
530<dt class="col-md-4">-read {image}</dt>
531<dd class="col-md-8">Explicit read of an image, rather than an implicit read.  This allows you
532    to read from filenames that start with an 'option' character, and which
533    otherwise could be mistaken as an option (unknown or otherwise). This will
534    eventually be used in "<code>mogrify</code>" to allow the reading of
535    secondary images, and allow the use of image list operations within that
536    command. </dd>
537
538<dt class="col-md-4">-read-mask</dt>
539<dd class="col-md-8">prevent updates to image pixels specified by the mask</dd>
540
541<dt class="col-md-4">-region</dt>
542<dd class="col-md-8">supported in ImageMagick 7.0.2-6 and above</dd>
543
544<dt class="col-md-4">-script {file}</dt>
545<dd class="col-md-8">In "<code>magick</code>", stop the processing of command line arguments as
546    image operations, and read all further options from the given file or
547    pipeline.</dd>
548<dt class="col-md-4">-write-mask</dt>
549<dd class="col-md-8">prevent pixels from being written.</dd>
550
551</dl>
552
553<h3>Changed Options</h3>
554<p>These options are known to have changed, in some way.</p>
555<dl class="row">
556<dt class="col-md-4">-bias</dt>
557<dd class="col-md-8">The option is no longer recognized.  Use <code>-define convolve:bias=<var>value</var></code> instead.</dd>
558<dt class="col-md-4">-draw</dt>
559<dd class="col-md-8">The <code>matte</code> primitive is now <code>alpha</code> (e.g. <code>-draw 'alpha 0,0 floodfill'</code>).</dd>
560<dt class="col-md-4">-negate</dt>
561<dd class="col-md-8">currently negates all channels, including alpha if present.  As such you may need to use the -channel option to prevent alpha negation (e.g. -channel RGB -negate).  </dd>
562<dt class="col-md-4">-preview</dt>
563<dd class="col-md-8">this option is now an image operator.  The PREVIEW image format has been removed.</dd>
564</dl>
565
566<h3>Deprecated warning given, but will work (for now)</h3>
567<dl class="row">
568<dt class="col-md-4">-affine</dt>
569<dd class="col-md-8">Replaced by <code>-draw "affine ..."</code>. (see transform)</dd>
570<dt class="col-md-4">-average</dt>
571<dd class="col-md-8">Replaced by <code>-evaluate-sequence Mean</code>.</dd>
572<dt class="col-md-4">-box</dt>
573<dd class="col-md-8">Replaced by <code>-undercolor</code>.</dd>
574<dt class="col-md-4">-deconstruct</dt>
575<dd class="col-md-8">Replaced by <code>-layers CompareAny</code>.</dd>
576<dt class="col-md-4">-gaussian</dt>
577<dd class="col-md-8">Replaced by <code>-gaussian-blur</code>.</dd>
578<dt class="col-md-4">-/+map</dt>
579<dd class="col-md-8">Replaced by <code>-/+remap</code>.</dd>
580<dt class="col-md-4">-/+mask</dt>
581<dd class="col-md-8">Replaced by <code>-/+read-mask</code>, <code>-/+write-mask</code>.</dd>
582<dt class="col-md-4">-/+matte</dt>
583<dd class="col-md-8">Replaced by <code>-alpha Set/Off</code>.</dd>
584<dt class="col-md-4">-transform</dt>
585<dd class="col-md-8">Replaced by <code>-distort Affine "..."</code>.</dd>
586</dl>
587
588<h3>Deprecated warning given, and ignored (for now)</h3>
589<p>Almost 'plus' (+) option that did not do anything has been marked as
590deprecated, and does nothing. It does not even have associated code.  For
591example "+annotate", "+resize", "+clut", and "+draw" .</p>
592
593<dl class="row">
594<dt class="col-md-4">-affinity</dt>
595<dd class="col-md-8">Replaced by <code>-remap</code>.</dd>
596<dt class="col-md-4">-maximum</dt>
597<dd class="col-md-8">Replaced by <code>-evaluate-sequence Max</code>.</dd>
598<dt class="col-md-4">-median</dt>
599<dd class="col-md-8">Replaced by <code>-evaluate-sequence Median</code>.</dd>
600<dt class="col-md-4">-minimum</dt>
601<dd class="col-md-8">Replaced by <code>-evaluate-sequence Min</code>.</dd>
602<dt class="col-md-4">-recolor</dt>
603<dd class="col-md-8">Replaced by <code>-color-matrix</code>.</dd>
604</dl>
605
606<h3>Removed / Replaced Options ("no such option" error and abort)</h3>
607
608<dl class="row">
609<dt class="col-md-4">-interpolate filter</dt>
610<dd class="col-md-8">remove slow and useless interpolation method</dd>
611<dt class="col-md-4">-origin</dt>
612<dd class="col-md-8">old option, unknown meaning.</dd>
613<dt class="col-md-4">-pen</dt>
614<dd class="col-md-8">Replaced by <code>-fill</code>.</dd>
615<dt class="col-md-4">-passphrase</dt>
616<dd class="col-md-8">old option, unknown meaning</dd>
617</dl>
618<h2><a class="anchor" id="summary"></a>Version 7 Change Summary</h2>
619<p>Changes from ImageMagick version 6 to version 7 are summarized here:</p>
620<h5>High Dynamic Range Imaging</h5>
621<ul>
622<li>ImageMagick version 7 enables HDRI by default.  Expect more accurate image processing results with higher memory requirements and possible slower processing times.  You can disable this feature for resource constrained system such as a cell phone with a slight loss of accuracy for certain algorithms (e.g. resizing).</li>
623</ul>
624<h5>Pixels</h5>
625<ul>
626<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>
627<li>Use convenience macros to access pixel channels (e.g. GetPixelRed(), SetPixelRed()).</li>
628<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>
629<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>
630<li>Use GetPixelChannels() to advance to the next set of pixel channels.</li>
631<li>Use the <var>metacontent</var> channel  to associate metacontent with each pixel.</li>
632<li>All color packet structures, PixelPacket, LongPacket, and DoublePacket, are consolidated to a single color structure, PixelInfo.</li>
633</ul>
634<h5>Alpha</h5>
635<ul>
636<li>We support alpha rather than opacity (0 transparent; QuantumRange opaque).</li>
637<li>Use GetPixelAlpha() or SetPixelAlpha() to get or set the alpha pixel channel value.</li>
638</ul>
639<h5>Grayscale</h5>
640<ul>
641<li>Grayscale images consume one pixel channel in ImageMagick version 7.  To process RGB, set the colorspace to RGB (e.g. -colorspace sRGB).</li>
642</ul>
643<h5>Masks</h5>
644<ul>
645<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>
646</ul>
647<h5>MagickCore API</h5>
648<ul>
649<li>Almost all image processing algorithms are now channel aware.</li>
650<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>
651<li>All method channel analogs have been removed (e.g. BlurImageChannel()), they are no longer necessary, use pixel traits instead.</li>
652<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>
653<li>The InterpolatePixelMethod enum is now PixelInterpolateMethod.</li>
654<li>To account for variable pixel channels, images may now return a different signature.</li>
655</ul>
656<h5>Deprecated Methods</h5>
657<ul>
658<li>All ImageMagick version 6 MagickCore and MagickWand deprecated methods are removed and no longer available in ImageMagick version 7.</li>
659<li>All MagickCore channel method analogs are removed (e.g. NegateImageChannels()).  For version 7, use pixel traits instead.</li>
660<li>The FilterImage() method has been removed.  Use ConvolveImage() instead.</li>
661</ul>
662</div>
663    </div>
664  </main><!-- /.container -->
665  <footer class="magick-footer">
666    <p><a href="security-policy.html">Security</a> •
667    <a href="architecture.html">Architecture</a>
668
669    <a href="porting.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico"/></a>
670
671    <a href="links.html">Related</a> •
672     <a href="sitemap.html">Sitemap</a>
673    <br/>
674    <a href="support.html">Donate</a> •
675    <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
676    <a href="https://imagemagick.org/script/contact.php">Contact Us</a>
677    <br/>
678    <small>© 1999-2020 ImageMagick Studio LLC</small></p>
679  </footer>
680
681  <!-- Javascript assets -->
682  <script src="assets/magick.js" crossorigin="anonymous"></script>
683  <script>window.jQuery || document.write('<script src="https://localhost/ajax/libs/jquery/3.4.1/jquery.min.js"><\/script>')</script>
684</body>
685</html>
686<!-- Magick Cache 5th January 2020 10:01 -->