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

   1 \r
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
   5 <head>\r
   6   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
   7   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   8   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   9   <style type="text/css" media="all">\r
  10     @import url("../www/magick.css");\r
  11   </style>\r
  12   <link rel="shortcut icon" href="../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  13   <title>ImageMagick: MagickCore, Low-level C API for ImageMagick</title>
  14   <meta http-equiv="Content-Language" content="en-US"/>
  15   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  16   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  17   <meta name="Generator" content="PHP"/>
  18   <meta name="Keywords" content="magickcore, low-level, c, api, for, imagemagick, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  19   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  20   <meta name="Rating" content="GENERAL"/>
  21   <meta name="Robots" content="INDEX, FOLLOW"/>
  22   <meta name="Generator" content="ImageMagick Studio LLC"/>
  23   <meta name="Author" content="ImageMagick Studio LLC"/>
  24   <meta name="Revisit-after" content="2 DAYS"/>
  25   <meta name="Resource-type" content="document"/>
  26   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  27   <meta name="Distribution" content="Global"/>
  28 </head>\r
  29 \r
  30 <body id="www-imagemagick-org">\r
  31 <div class="titlebar">\r
  32 <a href="../index.html">\r
  33   <img src="../images/script.png" alt="[ImageMagick]"\r
  34   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  35 <a href="http://www.networkredux.com">\r
  36   <img src="../images/networkredux.png" alt="[sponsor]"\r
  37   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  38 <a href="http://www.imagemagick.org/discourse-server/">\r
  39   <img src="../images/logo.jpg" alt=""\r
  40   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  41 <a href="../index.html">\r
  42   <img src="../images/sprite.jpg" alt=""\r
  43   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  44 </div>\r
  45 \r
  46 <div class="eastbar">\r
  47 \r
  48 <div class="menu">
  49   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
  50 </div>
  51 <div class="sep"></div>\r
  52 <div class="menu">
  53   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
  54 </div>
  55 <div class="sub">
  56     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
  57 </div>
  58 <div class="sub">
  59     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
  60 </div>
  61 <div class="sub">
  62     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
  63 </div>
  64 <div class="sep"></div>\r
  65 <div class="menu">
  66   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
  67 </div>
  68 <div class="sub">
  69     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
  70 </div>
  71 <div class="sub">
  72     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
  73 </div>
  74 <div class="sub">
  75     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  76 </div>
  77 <div class="menu">
  78   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
  79 </div>
  80 <div class="sub">
  81     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
  82 </div>
  83 <div class="sub">
  84     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
  85 </div>
  86 <div class="sub">
  87     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
  88 </div>
  89 <div class="sub">
  90     <a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
  91 </div>
  92 <div class="sep"></div>\r
  93 <div  class="menu">
  94    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
  95 </div>
  96 <div class="sub">
  97     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
  98 </div>
  99 <div class="sub">
 100     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
 101  </div>
 102 <div class="menu">
 103   <a title="Resources" href="../www/resources.html">Resources</a>
 104 </div>
 105 <div class="menu">
 106   <a title="Architecture" href="../www/architecture.html">Architecture</a>
 107 </div>
 108 <div class="menu">
 109   <a title="Download" href="../www/download.html">Download</a>
 110 </div>
 111 <div class="sep"></div>\r
 112 <div class="menu">
 113   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 114 </div>
 115 <div class="sep"></div>\r
 116 <div class="menu">
 117   <a title="Site Map"href="../www/sitemap.html">Site Map</a>
 118 </div>
 119 <div  class="sub">
 120     <a title="Site Map: Links"href="../www/links.html">Links</a>
 121 </div>
 122 <div class="sep"></div>\r
 123 <div  class="menu">
 124   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
 125
 126 <div class="sponsbox">
 127 <div  class="sponsor">
 128   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 129 </div>
 130 <div  class="sponsor">
 131   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 132 </div>
 133 <div  class="sponsor">
 134   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 135 </div>
 136 <div  class="sponsor">
 137   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 138 </div>
 139 <div  class="sponsor">
 140   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 141 </div>
 142 <div  class="sponsor">
 143    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 144 </div>
 145 <div  class="sponsor">
 146    <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/" title="Online-Magazin">Online-Magazin</a><!-- 20101101000200 -->
 147 </div>
 148 </div>
 149 </div>
 150 \r
 151 \r
 152 </div>\r
 153 \r
 154 <div class="main">\r
 155 \r
 156 <p class="navigation-index"></p>
 157
 158 <p>The <a href="../www/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="../www/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>
 159
 160 <ul>
 161   <li><a href="../www/api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
 162   <li><a href="../www/api/constitute.html">Constitute an Image</a></li>
 163   <li><a href="../www/api/composite.html">Composite an Image</a></li>
 164   <li><a href="../www/api/image.html">Image Methods</a></li>
 165   <li><a href="../www/api/color.html">Count the Colors in an Image</a></li>
 166   <li><a href="../www/api/colormap.html">Colormap Methods</a></li>
 167   <li><a href="../www/api/distort.html">Image Distortions</a></li>
 168   <li><a href="../www/api/layer.html">Dealing with Image Layers</a></li>
 169   <li><a href="../www/api/profile.html">Dealing with Image Profiles</a></li>
 170   <li><a href="../www/api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
 171   <li><a href="../www/api/histogram.html">Image Histograms</a></li>
 172   <li><a href="../www/api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
 173   <li><a href="../www/api/resize.html">Resize an Image</a></li>
 174   <li><a href="../www/api/transform.html">Transform an Image</a></li>
 175   <li><a href="../www/api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
 176   <li><a href="../www/api/enhance.html">Enhance an Image</a></li>
 177   <li><a href="../www/api/effect.html">Add an Effect</a></li>
 178   <li><a href="../www/api/morphology.html">Morphological Erosions, Dilations, Openings, and Closings</a></li>
 179   <li><a href="../www/api/fx.html">Add a Special Effect</a></li>
 180   <li><a href="../www/api/decorate.html">Decorate an Image</a></li>
 181   <li><a href="../www/api/attribute.html">Get/Set an Image Attribute</a></li>
 182   <li><a href="../www/api/property.html">Get/Set Image Properties</a></li>
 183   <li><a href="../www/api/statistic.html">Get Image Statistics</a></li>
 184   <li><a href="../www/api/feature.html">Get Image Features</a></li>
 185   <li><a href="../www/api/annotate.html">Annotate an Image</a></li>
 186   <li><a href="../www/api/paint.html">Paint on an Image</a></li>
 187   <li><a href="../www/api/draw.html">Draw on an Image</a></li>
 188   <li><a href="../www/api/montage.html">Create an Image Thumbnail</a></li>
 189   <li><a href="../www/api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
 190   <li><a href="../www/api/compare.html">Compare an Image to a Reconstructed Image</a></li>
 191   <li><a href="../www/api/display.html">Interactively Display and Edit an Image</a></li>
 192   <li><a href="../www/api/animate.html">Interactively Animate an Image Sequence</a></li>
 193   <li><a href="../www/api/cipher.html">Convert to and from Cipher Pixels</a></li>
 194   <li><a href="../www/api/list.html">Working with Image Lists</a></li>
 195   <li><a href="../www/api/image-view.html">Image View Methods</a></li>
 196   <li><a href="../www/api/cache.html">Get or Set Image Pixels</a></li>
 197   <li><a href="../www/api/cache-view.html">Working with Cache Views</a></li>
 198   <li><a href="../www/api/stream.html">The Pixel FIFO</a></li>
 199   <li><a href="../www/api/blob.html">Read or Write Binary Large OBjects</a></li>
 200   <li><a href="../www/api/module.html">Loadable Modules</a></li>
 201   <li><a href="../www/api/signature.html">Compute a Message Digest for an Image</a></li>
 202   <li><a href="../www/api/registry.html">The Image Registry</a></li>
 203   <li><a href="../www/api/exception.html">Dealing with Exceptions</a></li>
 204   <li><a href="../www/api/memory.html">Memory Allocation</a></li>
 205   <li><a href="../www/api/resource.html">Monitor or Limit Resource Consumption</a></li>
 206   <li><a href="../www/api/monitor.html">Monitor the Progress of an Image Operation</a></li>
 207   <li><a href="../www/api/version.html">Get the Version and Copyrights</a></li>
 208   <li><a href="../www/api/deprecate.html">Deprecated Methods</a></li>
 209   <li><a href="../www/exception.html">Error and Warning Codes</a></li>
 210 </ul>
 211
 212 <p>After you write your MagickCore program, compile it like this:</p>
 213
 214 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>cc `MagickCore-config --cflags --cppflags` core.c  \ <br/> `MagickCore-config --ldflags --libs`</span></p>
 215 <p>Here is a example program that utilizes the MagickCore API to get you started, <a href="../www/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>
 216
 217 <div class="viewport">
 218 <pre class="code">
 219   #include &lt;stdio.h>
 220   #include &lt;stdlib.h>
 221   #include &lt;string.h>
 222   #include &lt;time.h>
 223   #include &lt;magick/MagickCore.h>
 224
 225   int main(int argc,char **argv)
 226   {
 227     ExceptionInfo
 228       *exception;
 229
 230     Image
 231       *image,
 232       *images,
 233       *resize_image,
 234       *thumbnails;
 235
 236     ImageInfo
 237       *image_info;
 238
 239     if (argc != 3)
 240       {
 241         (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
 242         exit(0);
 243       }
 244     /*
 245       Initialize the image info structure and read an image.
 246     */
 247     MagickCoreGenesis(*argv,MagickTrue);
 248     exception=AcquireExceptionInfo();
 249     image_info=CloneImageInfo((ImageInfo *) NULL);
 250     (void) strcpy(image_info-&gt;filename,argv[1]);
 251     images=ReadImage(image_info,exception);
 252     if (exception-&gt;severity != UndefinedException)
 253       CatchException(exception);
 254     if (images == (Image *) NULL)
 255       exit(1);
 256     /*
 257       Convert the image to a thumbnail.
 258     */
 259     thumbnails=NewImageList();
 260     while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
 261     {
 262       resize_image=ResizeImage(image,106,80,LanczosFilter,1.0,exception);
 263       if (resize_image == (Image *) NULL)
 264         MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
 265       (void) AppendImageToList(&amp;thumbnails,resize_image);
 266       DestroyImage(image);
 267     }
 268     /*
 269       Write the image thumbnail.
 270     */
 271     (void) strcpy(thumbnails-&gt;filename,argv[2]);
 272     WriteImage(image_info,thumbnails);
 273     /*
 274       Destroy the image thumbnail and exit.
 275     */
 276     thumbnails=DestroyImageList(thumbnails);
 277     image_info=DestroyImageInfo(image_info);
 278     exception=DestroyExceptionInfo(exception);
 279     MagickCoreTerminus();
 280     return(0);
 281   }
 282 </pre>
 283 </div>
 284 <p>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="../www/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>
 285
 286 <div class="viewport">
 287 <pre class="code">
 288 #include &lt;stdio.h>
 289 #include &lt;stdlib.h>
 290 #include &lt;math.h>
 291 #include &lt;magick/MagickCore.h>
 292
 293 static MagickBooleanType SigmoidalContrast(ImageView *contrast_view,
 294   const ssize_t y,const int id,void *context)
 295 {
 296 #define QuantumScale  ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
 297 #define SigmoidalContrast(x) \
 298   (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
 299
 300   RectangleInfo
 301     extent;
 302
 303   register IndexPacket
 304     *indexes;
 305
 306   register PixelPacket
 307     *pixels;
 308
 309   register ssize_t
 310     x;
 311
 312   extent=GetImageViewExtent(contrast_view);
 313   pixels=GetImageViewAuthenticPixels(contrast_view);
 314   for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
 315   {
 316     pixels[x].red=RoundToQuantum(SigmoidalContrast(pixels[x].red));
 317     pixels[x].green=RoundToQuantum(SigmoidalContrast(pixels[x].green));
 318     pixels[x].blue=RoundToQuantum(SigmoidalContrast(pixels[x].blue));
 319     pixels[x].opacity=RoundToQuantum(SigmoidalContrast(pixels[x].opacity));
 320   }
 321   indexes=GetImageViewAuthenticIndexes(contrast_view);
 322   if (indexes != (IndexPacket *) NULL)
 323     for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
 324       indexes[x]=(IndexPacket) RoundToQuantum(SigmoidalContrast(indexes[x]));
 325   return(MagickTrue);
 326 }
 327
 328 int main(int argc,char **argv)
 329 {
 330 #define ThrowImageException(image) \
 331 { \
 332  \
 333   CatchException(exception); \
 334   if (contrast_image != (Image *) NULL) \
 335     contrast_image=DestroyImage(contrast_image); \
 336   exit(-1); \
 337 }
 338 #define ThrowViewException(view) \
 339 { \
 340   char \
 341     *description; \
 342  \
 343   ExceptionType \
 344     severity; \
 345  \
 346   description=GetImageViewException(view,&severity); \
 347   (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
 348   description=DestroyString(description); \
 349   exit(-1); \
 350 }
 351
 352   ExceptionInfo
 353     *exception;
 354
 355   Image
 356     *contrast_image;
 357
 358   ImageInfo
 359     *image_info;
 360
 361   ImageView
 362     *contrast_view;
 363
 364   MagickBooleanType
 365     status;
 366
 367   if (argc != 3)
 368     {
 369       (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
 370       exit(0);
 371     }
 372   /*
 373     Read an image.
 374   */
 375   MagickCoreGenesis(*argv,MagickTrue);
 376   image_info=AcquireImageInfo();
 377   (void) CopyMagickString(image_info->filename,argv[1],MaxTextExtent);
 378   exception=AcquireExceptionInfo();
 379   contrast_image=ReadImage(image_info,exception);
 380   if (contrast_image == (Image *) NULL)
 381     ThrowImageException(contrast_image);
 382   /*
 383     Sigmoidal non-linearity contrast control.
 384   */
 385   contrast_view=NewImageView(contrast_image);
 386   if (contrast_view == (ImageView *) NULL)
 387     ThrowImageException(contrast_image);
 388   status=UpdateImageViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
 389   if (status == MagickFalse)
 390     ThrowImageException(contrast_image);
 391   contrast_view=DestroyImageView(contrast_view);
 392   /*
 393     Write the image then destroy it.
 394   */
 395   status=WriteImages(image_info,contrast_image,argv[2],exception);
 396   if (status == MagickFalse)
 397     ThrowImageException(contrast_image);
 398   contrast_image=DestroyImage(contrast_image);
 399   exception=DestroyExceptionInfo(exception);
 400   image_info=DestroyImageInfo(image_info);
 401   MagickCoreTerminus();
 402   return(0);
 403 }
 404 </pre>
 405 </div>
 406 \r
 407 </div>\r
 408 \r
 409 <div id="linkbar">\r
 410  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 411     <span id="linkbar-center">\r
 412       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 413     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 414     </span>\r
 415     <span id="linkbar-east">&nbsp;</span>\r
 416   </div>\r
 417   <div class="footer">\r
 418     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 419     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 420   </div>\r
 421   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 422 </body>\r
 423 </html>\r