granicus.if.org Git - imagemagick/blob - www/magick-core.html

   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, initial-scale=1, shrink-to-fit=no"  />
  10   <title>MagickCore, Low-level C API @ ImageMagick</title>
  11   <meta name="application-name" content="ImageMagick" />
  12   <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." />
  13   <meta name="application-url" content="https://www.imagemagick.org" />
  14   <meta name="generator" content="PHP" />
  15   <meta name="keywords" content="magickcore, low-level, c, api, 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-2017 ImageMagick Studio LLC" />
  23   <meta name="distribution" content="Global" />
  24   <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
  25   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
  26   <link href="https://www.imagemagick.org/script/magick-core.html" rel="canonical" />
  27   <link href="../images/wand.png" rel="icon" />
  28   <link href="../images/wand.ico" rel="shortcut icon" />
  29   <link href="css/magick.css" rel="stylesheet" />
  30 </head>
  31 <body>
  32 <div class="magick-masthead">
  33   <div class="container">
  34     <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
  35          style="display:block"
  36          data-ad-client="ca-pub-3129977114552745"
  37          data-ad-slot="6345125851"
  38          data-ad-format="auto"></ins>
  39     <script>
  40       (adsbygoogle = window.adsbygoogle || []).push({});
  41     </script>
  42     <nav class="nav magick-nav">
  43       <a class="nav-link " href="../index.html">Home</a>
  44       <a class="nav-link " href="download.html">Download</a>
  45       <a class="nav-link " href="command-line-tools.html">Tools</a>
  46       <a class="nav-link " href="command-line-processing.html">Command-line</a>
  47       <a class="nav-link " href="resources.html">Resources</a>
  48       <a class="nav-link " href="develop.html">Develop</a>
  49       <a class="nav-link " href="https://www.imagemagick.org/script/search.php">Search</a>
  50       <a class="nav-link float-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
  51     </nav>
  52   </div>
  53 </div>
  54 <div class="container">
  55 <div class="magick-header">
  56
  57 <p  class="lead magick-description">The <a href="http://www.imagemagick.org/api/MagickCore/index.html">MagickCore API</a> is a low-level interface between the C programming language and the ImageMagick image processing libraries and is recommended for wizard-level programmers only.  Unlike the <a href="magick-wand.html">MagickWand</a> C API which uses only a few opaque types and accessors, with MagickCore you almost exlusively access the structure members directly.  A description of the MagickCore public methods are found here:</p>
  58
  59 <ul>
  60   <li><a href="http://www.imagemagick.org/api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
  61   <li><a href="http://www.imagemagick.org/api/constitute.html">Constitute an Image</a></li>
  62   <li><a href="api/composite.html">Composite an Image</a></li>
  63   <li><a href="http://www.imagemagick.org/api/image.html">Image Methods</a></li>
  64   <li><a href="http://www.imagemagick.org/api/channel.html">Image Channel Methods</a></li>
  65   <li><a href="http://www.imagemagick.org/api/color.html">Count the Colors in an Image</a></li>
  66   <li><a href="http://www.imagemagick.org/api/colormap.html">Colormap Methods</a></li>
  67   <li><a href="http://www.imagemagick.org/api/colorspace.html">Colorspace Methods</a></li>
  68   <li><a href="http://www.imagemagick.org/api/distort.html">Image Distortions</a></li>
  69   <li><a href="http://www.imagemagick.org/api/layer.html">Dealing with Image Layers</a></li>
  70   <li><a href="api/profile.html">Dealing with Image Profiles</a></li>
  71   <li><a href="http://www.imagemagick.org/api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
  72   <li><a href="http://www.imagemagick.org/api/histogram.html">Image Histograms</a></li>
  73   <li><a href="http://www.imagemagick.org/api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
  74   <li><a href="http://www.imagemagick.org/api/resize.html">Resize an Image</a></li>
  75   <li><a href="http://www.imagemagick.org/api/transform.html">Transform an Image</a></li>
  76   <li><a href="http://www.imagemagick.org/api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
  77   <li><a href="http://www.imagemagick.org/api/enhance.html">Enhance an Image</a></li>
  78   <li><a href="http://www.imagemagick.org/api/effect.html">Add an Effect</a></li>
  79   <li><a href="http://www.imagemagick.org/api/morphology.html">Morphological Erosions, Dilations, Openings, and Closings</a></li>
  80   <li><a href="http://www.imagemagick.org/api/fx.html">Add a Special Effect</a></li>
  81   <li><a href="http://www.imagemagick.org/api/decorate.html">Decorate an Image</a></li>
  82   <li><a href="http://www.imagemagick.org/api/attribute.html">Get/Set an Image Attribute</a></li>
  83   <li><a href="api/property.html">Get/Set Image Properties</a></li>
  84   <li><a href="http://www.imagemagick.org/api/statistic.html">Get Image Statistics</a></li>
  85   <li><a href="http://www.imagemagick.org/api/feature.html">Get Image Features</a></li>
  86   <li><a href="http://www.imagemagick.org/api/annotate.html">Annotate an Image</a></li>
  87   <li><a href="http://www.imagemagick.org/api/paint.html">Paint on an Image</a></li>
  88   <li><a href="http://www.imagemagick.org/api/draw.html">Draw on an Image</a></li>
  89   <li><a href="http://www.imagemagick.org/api/montage.html">Create an Image Thumbnail</a></li>
  90   <li><a href="http://www.imagemagick.org/api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
  91   <li><a href="http://www.imagemagick.org/api/compare.html">Compare an Image to a Reconstructed Image</a></li>
  92   <li><a href="http://www.imagemagick.org/api/display.html">Interactively Display and Edit an Image</a></li>
  93   <li><a href="http://www.imagemagick.org/api/animate.html">Interactively Animate an Image Sequence</a></li>
  94   <li><a href="http://www.imagemagick.org/api/cipher.html">Convert to and from Cipher Pixels</a></li>
  95   <li><a href="http://www.imagemagick.org/api/list.html">Working with Image Lists</a></li>
  96   <li><a href="api/image-view.html">Image View Methods</a></li>
  97   <li><a href="api/cache.html">Get or Set Image Pixels</a></li>
  98   <li><a href="api/cache-view.html">Working with Cache Views</a></li>
  99   <li><a href="api/stream.html">The Pixel FIFO</a></li>
 100   <li><a href="http://www.imagemagick.org/api/blob.html">Read or Write Binary Large OBjects</a></li>
 101   <li><a href="api/module.html">Loadable Modules</a></li>
 102   <li><a href="http://www.imagemagick.org/api/signature.html">Compute a Message Digest for an Image</a></li>
 103   <li><a href="http://www.imagemagick.org/api/registry.html">The Image Registry</a></li>
 104   <li><a href="http://www.imagemagick.org/api/exception.html">Dealing with Exceptions</a></li>
 105   <li><a href="http://www.imagemagick.org/api/memory.html">Memory Allocation</a></li>
 106   <li><a href="api/resource.html">Monitor or Limit Resource Consumption</a></li>
 107   <li><a href="http://www.imagemagick.org/api/monitor.html">Monitor the Progress of an Image Operation</a></li>
 108   <li><a href="http://www.imagemagick.org/api/version.html">Get the Version and Copyrights</a></li>
 109   <li><a href="http://www.imagemagick.org/api/mime.html">Mime Methods</a></li>
 110   <li><a href="http://www.imagemagick.org/api/deprecate.html">Deprecated Methods</a></li>
 111   <li><a href="exception.html">Error and Warning Codes</a></li>
 112 </ul>
 113
 114 <p>After you write your MagickCore program, compile it like this:</p>
 115
 116 <pre><code>
 117 cc -o core core.c `pkg-config --cflags --libs MagickWand`
 118 </code></pre>
 119
 120 <p>Set the <code>PKG_CONFIG_PATH</code> environment variable if ImageMagick is not in your default system path:</p>
 121
 122 <pre><code>
 123 export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
 124 </code></pre>
 125
 126 <p>Here is a example program that utilizes the MagickCore API to get you started, <a href="http://www.imagemagick.org/source/core.c">core.c</a>. It reads a GIF image, creates a thumbnail, and writes it to disk in the PNG image format.</p>
 127
 128 <pre class="pre-scrollable"><code>#include &lt;stdio.h>
 129 #include &lt;stdlib.h>
 130 #include &lt;string.h>
 131 #include &lt;time.h>
 132 #include &lt;MagickCore/MagickCore.h>
 133
 134 int main(int argc,char **argv)
 135 {
 136   ExceptionInfo
 137     *exception;
 138
 139   Image
 140     *image,
 141     *images,
 142     *resize_image,
 143     *thumbnails;
 144
 145   ImageInfo
 146     *image_info;
 147
 148   if (argc != 3)
 149     {
 150       (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
 151       exit(0);
 152     }
 153   /*
 154     Initialize the image info structure and read an image.
 155   */
 156   MagickCoreGenesis(*argv,MagickTrue);
 157   exception=AcquireExceptionInfo();
 158   image_info=CloneImageInfo((ImageInfo *) NULL);
 159   (void) strcpy(image_info-&gt;filename,argv[1]);
 160   images=ReadImage(image_info,exception);
 161   if (exception-&gt;severity != UndefinedException)
 162     CatchException(exception);
 163   if (images == (Image *) NULL)
 164     exit(1);
 165   /*
 166     Convert the image to a thumbnail.
 167   */
 168   thumbnails=NewImageList();
 169   while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
 170   {
 171     resize_image=ResizeImage(image,106,80,LanczosFilter,exception);
 172     if (resize_image == (Image *) NULL)
 173       MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
 174     (void) AppendImageToList(&amp;thumbnails,resize_image);
 175     DestroyImage(image);
 176   }
 177   /*
 178     Write the image thumbnail.
 179   */
 180   (void) strcpy(thumbnails-&gt;filename,argv[2]);
 181   WriteImage(image_info,thumbnails,exception);
 182   /*
 183     Destroy the image thumbnail and exit.
 184   */
 185   thumbnails=DestroyImageList(thumbnails);
 186   image_info=DestroyImageInfo(image_info);
 187   exception=DestroyExceptionInfo(exception);
 188   MagickCoreTerminus();
 189   return(0);
 190 }</code></pre>
 191 <p><a id="image-view"></a>Now lets perform the same contrast enhancement while taking advantage of our dual or quad-core processing system by running the algorithm in parallel utilizing wand views.  The <a href="http://www.imagemagick.org/source/core/sigmoidal-contrast.c">sigmoidal-contrast.c</a> module reads an image, applies sigmoidal non-linearity contrast control, and writes the result to disk just like the previous contrast enhancement program, but now it does its work in parallel (assumes ImageMagick is built with OpenMP support).</p>
 192
 193 <pre class="pre-scrollable"><code>#include &lt;stdio.h>
 194 #include &lt;stdlib.h>
 195 #include &lt;math.h>
 196 #include &lt;MagickCore/MagickCore.h>
 197
 198 static MagickBooleanType SigmoidalContrast(ImageView *contrast_view,
 199   const ssize_t y,const int id,void *context)
 200 {
 201 #define QuantumScale  ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
 202 #define SigmoidalContrast(x) \
 203   (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
 204
 205   RectangleInfo
 206     extent;
 207
 208   register IndexPacket
 209     *indexes;
 210
 211   register PixelPacket
 212     *pixels;
 213
 214   register ssize_t
 215     x;
 216
 217   extent=GetImageViewExtent(contrast_view);
 218   pixels=GetImageViewAuthenticPixels(contrast_view);
 219   for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
 220   {
 221     SetPixelRed(pixels,RoundToQuantum(SigmoidalContrast(GetPixelRed(pixels)));
 222     SetPixelGreen(pixels,RoundToQuantum(SigmoidalContrast(GetPixelGreen(pixels)));
 223     SetPixelBlue(pixels,RoundToQuantum(SigmoidalContrast(GetPixelBlue(pixels)));
 224     SetPixelOpacity(pixels,RoundToQuantum(SigmoidalContrast(GetPixelOpacity(pixels)));
 225     pixels++;
 226   }
 227   indexes=GetImageViewAuthenticIndexes(contrast_view);
 228   if (indexes != (IndexPacket *) NULL)
 229     for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
 230       SetPixelIndex(indexes+x,RoundToQuantum(SigmoidalContrast(GetPixelIndex(indexes+x))));
 231   return(MagickTrue);
 232 }
 233
 234 int main(int argc,char **argv)
 235 {
 236 #define ThrowImageException(image) \
 237 { \
 238  \
 239   CatchException(exception); \
 240   if (contrast_image != (Image *) NULL) \
 241     contrast_image=DestroyImage(contrast_image); \
 242   exit(-1); \
 243 }
 244 #define ThrowViewException(view) \
 245 { \
 246   char \
 247     *description; \
 248  \
 249   ExceptionType \
 250     severity; \
 251  \
 252   description=GetImageViewException(view,&amp;severity); \
 253   (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
 254   description=DestroyString(description); \
 255   exit(-1); \
 256 }
 257
 258   ExceptionInfo
 259     *exception;
 260
 261   Image
 262     *contrast_image;
 263
 264   ImageInfo
 265     *image_info;
 266
 267   ImageView
 268     *contrast_view;
 269
 270   MagickBooleanType
 271     status;
 272
 273   if (argc != 3)
 274     {
 275       (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
 276       exit(0);
 277     }
 278   /*
 279     Read an image.
 280   */
 281   MagickCoreGenesis(*argv,MagickTrue);
 282   image_info=AcquireImageInfo();
 283   (void) CopyMagickString(image_info->filename,argv[1],MaxTextExtent);
 284   exception=AcquireExceptionInfo();
 285   contrast_image=ReadImage(image_info,exception);
 286   if (contrast_image == (Image *) NULL)
 287     ThrowImageException(contrast_image);
 288   /*
 289     Sigmoidal non-linearity contrast control.
 290   */
 291   contrast_view=NewImageView(contrast_image);
 292   if (contrast_view == (ImageView *) NULL)
 293     ThrowImageException(contrast_image);
 294   status=UpdateImageViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
 295   if (status == MagickFalse)
 296     ThrowImageException(contrast_image);
 297   contrast_view=DestroyImageView(contrast_view);
 298   /*
 299     Write the image then destroy it.
 300   */
 301   status=WriteImages(image_info,contrast_image,argv[2],exception);
 302   if (status == MagickFalse)
 303     ThrowImageException(contrast_image);
 304   contrast_image=DestroyImage(contrast_image);
 305   exception=DestroyExceptionInfo(exception);
 306   image_info=DestroyImageInfo(image_info);
 307   MagickCoreTerminus();
 308   return(0);
 309 }</code></pre>
 310 </div>
 311   <footer class="magick-footer">
 312     <p><a href="support.html">Donate</a> •
 313      <a href="sitemap.html">Sitemap</a> •
 314     <a href="links.html">Related</a> •
 315     <a href="security-policy.html">Security</a> •
 316     <a href="architecture.html">Architecture</a>
 317 </p>
 318     <p><a href="magick-core.html#">Back to top</a> •
 319     <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
 320     <a href="https://www.imagemagick.org/script/contact.php">Contact Us</a></p>
 321         <p><small>© 1999-2017 ImageMagick Studio LLC</small></p>
 322   </footer>
 323 </div><!-- /.container -->
 324
 325   <script src="https://localhost/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
 326   <script src="../js/magick.html"></script>
 327 </body>
 328 </html>
 329 <!-- Magick Cache 22nd August 2017 09:54 -->