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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en" xsi:schemaLocation="http://www.w3.org/1999/xhtml                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   3 <head>
   4   <meta http-equiv="content-type" content="text/html; charset=UTF-8"></meta>
   5   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta>
   6   <title>ImageMagick: MagickCore, Low-level C API for ImageMagick</title>
   7   <meta http-equiv="content-language" content="en-US"></meta>
   8   <meta http-equiv="content-type" content="text/html; charset=utf-8"></meta>
   9   <meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta>
  10   <meta name="application-name" content="ImageMagick"></meta>
  11   <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition, resize, rotate, shear, distort or transform images automagically."></meta>
  12   <meta name="application-url" content="http://www.imagemagick.org"></meta>
  13   <meta name="generator" content="PHP"></meta>
  14   <meta name="keywords" content="magickcore, low-level, c, api, for, imagemagick, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"></meta>
  15   <meta name="rating" content="GENERAL"></meta>
  16   <meta name="robots" content="INDEX, FOLLOW"></meta>
  17   <meta name="generator" content="ImageMagick Studio LLC"></meta>
  18   <meta name="author" content="ImageMagick Studio LLC"></meta>
  19   <meta name="revisit-after" content="2 DAYS"></meta>
  20   <meta name="resource-type" content="document"></meta>
  21   <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta>
  22   <meta name="distribution" content="Global"></meta>
  23   <link rel="icon" href="../images/wand.png"></link>
  24   <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon"></link>
  25   <link rel="canonical" href="../index.html"></link>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link>
  27
  28   <!-- Add jQuery library -->
  29   <script type="text/javascript" src="http://localhost/ajax/libs/jquery/1.7/jquery.min.js"></script>
  30
  31   <!-- Add mousewheel plugin (this is optional) -->
  32   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
  33
  34   <!-- Add fancyBox -->
  35   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link>
  36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
  37
  38   <!-- Optionally add helpers - button, thumbnail and/or media -->
  39   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen"></link>
  40   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
  42
  43   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen"></link>
  44   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
  45
  46   <script type="text/javascript">
  47         $(document).ready(function() {
  48                 $(".fancybox").fancybox();
  49         });
  50   </script>
  51
  52   <!-- ImageMagick style -->
  53   <style type="text/css" media="all">
  54     @import url("../www/magick.css");
  55   </style>
  56 </head>
  57
  58 <body id="www-imagemagick-org">
  59
  60
  61
  62 <div class="titlebar">
  63 <div style="margin: 17px auto; float: left;">
  64   <script type="text/javascript">
  65   <!--
  66     google_ad_client = "pub-3129977114552745";
  67     google_ad_slot = "5439289906";
  68     google_ad_width = 728;
  69     google_ad_height = 90;
  70   //-->
  71   </script>
  72
  73 </div>
  74 <a href="../discourse-server">
  75   <img src="../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a>
  76 <a href="../index.html">
  77   <img src="../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a>
  78 </div>
  79
  80 <div class="westbar">
  81
  82 <div class="menu">
  83   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  84 </div>
  85 <div class="menu">
  86   <a title="Binary Releases" href="binary-releases.html">Binary Releases</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Binary Release: Unix" href="binary-releases.html#unix">Unix</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Binary Release: MacOS X" href="binary-releases.html#macosx">Mac OS X</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: iOS" href="binary-releases.html#iOS">iOS</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: Windows" href="binary-releases.html#windows">Windows</a>
  99 </div>
 100 <div class="sep"></div>
 101 <div class="menu">
 102   <a title="Command-line Tools" href="command-line-tools.html">Command-line Tools</a>
 103 </div>
 104 <div class="sub">
 105     <a title="Command-line Tools: Processing" href="command-line-processing.html">Processing</a>
 106 </div>
 107 <div class="sub">
 108     <a title="Command-line Tools: Options" href="command-line-options.html">Options</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 112 </div>
 113 <div class="menu">
 114   <a title="Program Interfaces" href="api.html">Program Interfaces</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Program Interface: MagickWand" href="magick-wand.html">MagickWand</a>
 118 </div>
 119 <div class="sub">
 120     <a title="Program Interface: MagickCore" href="magick-core.html">MagickCore</a>
 121 </div>
 122 <div class="sub">
 123     <a title="Program Interface: PerlMagick" href="perl-magick.html">PerlMagick</a>
 124 </div>
 125 <div class="sub">
 126     <a title="Program Interface: Magick++" href="magick++.html">Magick++</a>
 127 </div>
 128 <div class="sep"></div>
 129 <div class="menu">
 130    <a title="Install from Source" href="install-source.html">Install from Source</a>
 131 </div>
 132 <div class="sub">
 133     <a title="Install from Source: Unix" href="install-source.html#unix">Unix</a>
 134 </div>
 135 <div class="sub">
 136     <a title="Install from Source: Windows" href="install-source.html#windows">Windows</a>
 137  </div>
 138 <div class="menu">
 139   <a title="Resources" href="resources.html">Resources</a>
 140 </div>
 141 <div class="menu">
 142   <a title="Architecture" href="architecture.html">Architecture</a>
 143 </div>
 144 <div class="menu">
 145   <a title="Download" href="download.html">Download</a>
 146 </div>
 147 <div class="sep"></div>
 148 <div class="menu">
 149   <a title="Search" href="search.html">Search</a>
 150 </div>
 151 <div class="sep"></div>
 152 <div class="menu">
 153   <a title="Site Map" href="sitemap.html">Site Map</a>
 154 </div>
 155 <div class="sub">
 156   <a title="Site Map: Links" href="links.html">Links</a>
 157 </div>
 158 <div class="sep"></div>
 159 <div class="menu">
 160   <a title="Support ImageMagick Development" href="support.html">Support ImageMagick Development</a>
 161 </div>
 162 </div>
 163
 164 <div class="eastbar">
 165
 166   <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../index.html"></a></div>
 167   <noscript>
 168     <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
 169     <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0"></img></a>
 170   </noscript>
 171
 172
 173 </div>
 174
 175 <div class="main">
 176
 177 <h1>MagickCore C API</h1>
 178
 179 <div class="doc-section">
 180
 181 <p>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>
 182
 183 <ul>
 184   <li><a href="../api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
 185   <li><a href="../api/constitute.html">Constitute an Image</a></li>
 186   <li><a href="../api/composite.html">Composite an Image</a></li>
 187   <li><a href="../api/image.html">Image Methods</a></li>
 188   <li><a href="../api/channel.html">Image Channel Methods</a></li>
 189   <li><a href="../api/color.html">Count the Colors in an Image</a></li>
 190   <li><a href="../api/colormap.html">Colormap Methods</a></li>
 191   <li><a href="../api/colorspace.html">Colorspace Methods</a></li>
 192   <li><a href="../api/distort.html">Image Distortions</a></li>
 193   <li><a href="../api/layer.html">Dealing with Image Layers</a></li>
 194   <li><a href="../api/profile.html">Dealing with Image Profiles</a></li>
 195   <li><a href="../api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
 196   <li><a href="../api/histogram.html">Image Histograms</a></li>
 197   <li><a href="../api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
 198   <li><a href="../api/resize.html">Resize an Image</a></li>
 199   <li><a href="../api/transform.html">Transform an Image</a></li>
 200   <li><a href="../api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
 201   <li><a href="../api/enhance.html">Enhance an Image</a></li>
 202   <li><a href="../api/effect.html">Add an Effect</a></li>
 203   <li><a href="../api/morphology.html">Morphological Erosions, Dilations, Openings, and Closings</a></li>
 204   <li><a href="../api/fx.html">Add a Special Effect</a></li>
 205   <li><a href="../api/decorate.html">Decorate an Image</a></li>
 206   <li><a href="../api/attribute.html">Get/Set an Image Attribute</a></li>
 207   <li><a href="../api/property.html">Get/Set Image Properties</a></li>
 208   <li><a href="../api/statistic.html">Get Image Statistics</a></li>
 209   <li><a href="../api/feature.html">Get Image Features</a></li>
 210   <li><a href="../api/annotate.html">Annotate an Image</a></li>
 211   <li><a href="../api/paint.html">Paint on an Image</a></li>
 212   <li><a href="../api/draw.html">Draw on an Image</a></li>
 213   <li><a href="../api/montage.html">Create an Image Thumbnail</a></li>
 214   <li><a href="../api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
 215   <li><a href="../api/compare.html">Compare an Image to a Reconstructed Image</a></li>
 216   <li><a href="../api/display.html">Interactively Display and Edit an Image</a></li>
 217   <li><a href="../api/animate.html">Interactively Animate an Image Sequence</a></li>
 218   <li><a href="../api/cipher.html">Convert to and from Cipher Pixels</a></li>
 219   <li><a href="../api/list.html">Working with Image Lists</a></li>
 220   <li><a href="../api/image-view.html">Image View Methods</a></li>
 221   <li><a href="../api/cache.html">Get or Set Image Pixels</a></li>
 222   <li><a href="../api/cache-view.html">Working with Cache Views</a></li>
 223   <li><a href="../api/stream.html">The Pixel FIFO</a></li>
 224   <li><a href="../api/blob.html">Read or Write Binary Large OBjects</a></li>
 225   <li><a href="../api/module.html">Loadable Modules</a></li>
 226   <li><a href="../api/signature.html">Compute a Message Digest for an Image</a></li>
 227   <li><a href="../api/registry.html">The Image Registry</a></li>
 228   <li><a href="../api/exception.html">Dealing with Exceptions</a></li>
 229   <li><a href="../api/memory.html">Memory Allocation</a></li>
 230   <li><a href="../api/resource.html">Monitor or Limit Resource Consumption</a></li>
 231   <li><a href="../api/monitor.html">Monitor the Progress of an Image Operation</a></li>
 232   <li><a href="../api/version.html">Get the Version and Copyrights</a></li>
 233   <li><a href="../api/deprecate.html">Deprecated Methods</a></li>
 234   <li><a href="exception.html">Error and Warning Codes</a></li>
 235 </ul>
 236
 237 <p>After you write your MagickCore program, compile it like this:</p>
 238
 239 <p class="crt"><span class="crtprompt"> $ </span><span class="crtin">cc -o core `pkg-config --cflags --libs MagickCore` core.c</span></p>
 240 <p>Set the <code>PKG_CONFIG_PATH</code> environment variable if ImageMagick is not in your default system path:</p>
 241 <p class="crt"><span class="crtprompt"> $ </span><span class="crtin">export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig</span></p>
 242 <p>Here is a example program that utilizes the MagickCore API to get you started, <a href="../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>
 243
 244 <div class="viewport">
 245   #include &lt;stdio.h&gt;
 246   #include &lt;stdlib.h&gt;
 247   #include &lt;string.h&gt;
 248   #include &lt;time.h&gt;
 249   #include &lt;magick/MagickCore.h&gt;
 250
 251   int main(int argc,char **argv)
 252   {
 253     ExceptionInfo
 254       *exception;
 255
 256     Image
 257       *image,
 258       *images,
 259       *resize_image,
 260       *thumbnails;
 261
 262     ImageInfo
 263       *image_info;
 264
 265     if (argc != 3)
 266       {
 267         (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
 268         exit(0);
 269       }
 270     /*
 271       Initialize the image info structure and read an image.
 272     */
 273     MagickCoreGenesis(*argv,MagickTrue);
 274     exception=AcquireExceptionInfo();
 275     image_info=CloneImageInfo((ImageInfo *) NULL);
 276     (void) strcpy(image_info-&gt;filename,argv[1]);
 277     images=ReadImage(image_info,exception);
 278     if (exception-&gt;severity != UndefinedException)
 279       CatchException(exception);
 280     if (images == (Image *) NULL)
 281       exit(1);
 282     /*
 283       Convert the image to a thumbnail.
 284     */
 285     thumbnails=NewImageList();
 286     while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
 287     {
 288       resize_image=ResizeImage(image,106,80,LanczosFilter,1.0,exception);
 289       if (resize_image == (Image *) NULL)
 290         MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
 291       (void) AppendImageToList(&amp;thumbnails,resize_image);
 292       DestroyImage(image);
 293     }
 294     /*
 295       Write the image thumbnail.
 296     */
 297     (void) strcpy(thumbnails-&gt;filename,argv[2]);
 298     WriteImage(image_info,thumbnails);
 299     /*
 300       Destroy the image thumbnail and exit.
 301     */
 302     thumbnails=DestroyImageList(thumbnails);
 303     image_info=DestroyImageInfo(image_info);
 304     exception=DestroyExceptionInfo(exception);
 305     MagickCoreTerminus();
 306     return(0);
 307   }
 308 </div>
 309 <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="../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>
 310
 311 <div class="viewport">
 312 #include &lt;stdio.h&gt;
 313 #include &lt;stdlib.h&gt;
 314 #include &lt;math.h&gt;
 315 #include &lt;magick/MagickCore.h&gt;
 316
 317 static MagickBooleanType SigmoidalContrast(ImageView *contrast_view,
 318   const ssize_t y,const int id,void *context)
 319 {
 320 #define QuantumScale  ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
 321 #define SigmoidalContrast(x) \
 322   (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
 323
 324   RectangleInfo
 325     extent;
 326
 327   register IndexPacket
 328     *indexes;
 329
 330   register PixelPacket
 331     *pixels;
 332
 333   register ssize_t
 334     x;
 335
 336   extent=GetImageViewExtent(contrast_view);
 337   pixels=GetImageViewAuthenticPixels(contrast_view);
 338   for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
 339   {
 340     SetPixelRed(pixels,RoundToQuantum(SigmoidalContrast(GetPixelRed(pixels)));
 341     SetPixelGreen(pixels,RoundToQuantum(SigmoidalContrast(GetPixelGreen(pixels)));
 342     SetPixelBlue(pixels,RoundToQuantum(SigmoidalContrast(GetPixelBlue(pixels)));
 343     SetPixelOpacity(pixels,RoundToQuantum(SigmoidalContrast(GetPixelOpacity(pixels)));
 344     pixels++;
 345   }
 346   indexes=GetImageViewAuthenticIndexes(contrast_view);
 347   if (indexes != (IndexPacket *) NULL)
 348     for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
 349       SetPixelIndex(indexes+x,RoundToQuantum(SigmoidalContrast(GetPixelIndex(indexes+x))));
 350   return(MagickTrue);
 351 }
 352
 353 int main(int argc,char **argv)
 354 {
 355 #define ThrowImageException(image) \
 356 { \
 357  \
 358   CatchException(exception); \
 359   if (contrast_image != (Image *) NULL) \
 360     contrast_image=DestroyImage(contrast_image); \
 361   exit(-1); \
 362 }
 363 #define ThrowViewException(view) \
 364 { \
 365   char \
 366     *description; \
 367  \
 368   ExceptionType \
 369     severity; \
 370  \
 371   description=GetImageViewException(view,&amp;severity); \
 372   (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
 373   description=DestroyString(description); \
 374   exit(-1); \
 375 }
 376
 377   ExceptionInfo
 378     *exception;
 379
 380   Image
 381     *contrast_image;
 382
 383   ImageInfo
 384     *image_info;
 385
 386   ImageView
 387     *contrast_view;
 388
 389   MagickBooleanType
 390     status;
 391
 392   if (argc != 3)
 393     {
 394       (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
 395       exit(0);
 396     }
 397   /*
 398     Read an image.
 399   */
 400   MagickCoreGenesis(*argv,MagickTrue);
 401   image_info=AcquireImageInfo();
 402   (void) CopyMagickString(image_info-&gt;filename,argv[1],MaxTextExtent);
 403   exception=AcquireExceptionInfo();
 404   contrast_image=ReadImage(image_info,exception);
 405   if (contrast_image == (Image *) NULL)
 406     ThrowImageException(contrast_image);
 407   /*
 408     Sigmoidal non-linearity contrast control.
 409   */
 410   contrast_view=NewImageView(contrast_image);
 411   if (contrast_view == (ImageView *) NULL)
 412     ThrowImageException(contrast_image);
 413   status=UpdateImageViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
 414   if (status == MagickFalse)
 415     ThrowImageException(contrast_image);
 416   contrast_view=DestroyImageView(contrast_view);
 417   /*
 418     Write the image then destroy it.
 419   */
 420   status=WriteImages(image_info,contrast_image,argv[2],exception);
 421   if (status == MagickFalse)
 422     ThrowImageException(contrast_image);
 423   contrast_image=DestroyImage(contrast_image);
 424   exception=DestroyExceptionInfo(exception);
 425   image_info=DestroyImageInfo(image_info);
 426   MagickCoreTerminus();
 427   return(0);
 428 }
 429 </div>
 430 </div>
 431
 432 </div>
 433
 434 <div id="linkbar">
 435     <span id="linkbar-west"> </span>
 436
 437     <span id="linkbar-center">
 438       <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
 439       <a href="../discourse-server">Discourse Server</a> •
 440       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
 441       <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
 442     </span>
 443     <span id="linkbar-east"> </span>
 444 </div>
 445 <div class="footer">
 446   <span id="footer-west">©  1999-2013 ImageMagick Studio LLC</span>
 447   <span id="footer-east"> <a href="contact.html">Contact the Wizards</a></span>
 448 </div>
 449 <div style="clear: both; margin: 0; width: 100%; "></div>
 450 </body>
 451 </html>