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">\r
   5 <head>\r
   6   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\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="screen,projection"><!--\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 href="../index.html">About ImageMagick</a>
  50 </div>
  51 <div class="sep"></div>\r
  52 <div class="menu">
  53   <a href="../www/command-line-tools.html">Command-line Tools</a>
  54 </div>
  55 <div class="sub">
  56     <a href="../www/command-line-processing.html">Processing</a>
  57 </div>
  58 <div class="sub">
  59     <a href="../www/command-line-options.html">Options</a>
  60 </div>
  61 <div class="sub">
  62     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  63 </div>
  64 <div class="menu">
  65   <a href="../www/api.html">Program Interfaces</a>
  66 </div>
  67 <div class="sub">
  68     <a href="../www/magick-wand.html">MagickWand</a>
  69 </div>
  70 <div class="sub">
  71     <a href="../www/magick-core.html">MagickCore</a>
  72 </div>
  73 <div class="sub">
  74     <a href="../www/perl-magick.html">PerlMagick</a>
  75 </div>
  76 <div class="sub">
  77     <a href="../Magick++/">Magick++</a>
  78 </div>
  79 <div class="menu">
  80   <a href="../www/architecture.html">Architecture</a>
  81 </div>
  82 <div class="sep"></div>\r
  83 <div  class="menu">
  84    <a href="../www/install-source.html">Install from Source</a>
  85 </div>
  86 <div class="sub">
  87     <a href="../www/install-source.html#unix">Unix</a>
  88 </div>
  89 <div class="sub">
  90     <a href="../www/install-source.html#windows">Windows</a>
  91  </div>
  92 <div class="menu">
  93   <a href="../www/binary-releases.html">Binary Releases</a>
  94 </div>
  95 <div class="sub">
  96     <a href="../www/binary-releases.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a href="../www/binary-releases.html#macosx">Mac OS X</a>
 100 </div>
 101 <div class="sub">
 102     <a href="../www/binary-releases.html#windows">Windows</a>
 103 </div>
 104 <div class="menu">
 105   <a href="../www/resources.html">Resources</a>
 106 </div>
 107 <div class="sep"></div>\r
 108 <div class="menu">
 109   <a href="../www/download.html">Download</a>
 110 </div>
 111 <div class="sep"></div>\r
 112 <div class="menu">
 113   <a href="http://www.imagemagick.org/script/search.php">Search</a>
 114 </div>
 115 <div class="sep"></div>\r
 116 <div class="menu">
 117   <a href="../www/sitemap.html">Site Map</a>
 118 </div>
 119 <div  class="sub">
 120     <a href="../www/links.html">Links</a>
 121 </div>
 122 <div class="sep"></div>\r
 123 <div  class="menu">
 124   <a href="../www/sponsors.html">Sponsors:</a>
 125
 126 <div class="sponsbox">
 127 <div  class="sponsor">
 128    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 129 </div>
 130 <div  class="sponsor">
 131   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 132 </div>
 133 <div  class="sponsor">
 134   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 135 </div>
 136 <div  class="sponsor">
 137   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 138 </div>
 139 <div  class="sponsor">
 140   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 141 </div>
 142 <div  class="sponsor">
 143   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 144 </div>
 145 <div  class="sponsor">
 146    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 147 </div>
 148 <div  class="sponsor">
 149    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 150 </div>
 151 </div>
 152 </div>
 153 \r
 154 \r
 155 </div>\r
 156 \r
 157 <div class="main">\r
 158 \r
 159 <p class="navigation-index"></p>
 160
 161 <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>
 162
 163 <ul>
 164   <li><a href="../www/api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
 165   <li><a href="../www/api/constitute.html">Constitute an Image</a></li>
 166   <li><a href="../www/api/composite.html">Composite an Image</a></li>
 167   <li><a href="../www/api/image.html">Image Methods</a></li>
 168   <li><a href="../www/api/color.html">Count the Colors in an Image</a></li>
 169   <li><a href="../www/api/colormap.html">Colormap Methods</a></li>
 170   <li><a href="../www/api/distort.html">Image Distortions</a></li>
 171   <li><a href="../www/api/layer.html">Dealing with Image Layers</a></li>
 172   <li><a href="../www/api/profile.html">Dealing with Image Profiles</a></li>
 173   <li><a href="../www/api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
 174   <li><a href="../www/api/histogram.html">Image Histograms</a></li>
 175   <li><a href="../www/api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
 176   <li><a href="../www/api/resize.html">Resize an Image</a></li>
 177   <li><a href="../www/api/transform.html">Transform an Image</a></li>
 178   <li><a href="../www/api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
 179   <li><a href="../www/api/enhance.html">Enhance an Image</a></li>
 180   <li><a href="../www/api/effect.html">Add an Effect</a></li>
 181   <li><a href="../www/api/morphology.html">Morphological Erosions, Dilations, Openings, and Closings</a></li>
 182   <li><a href="../www/api/fx.html">Add a Special Effect</a></li>
 183   <li><a href="../www/api/decorate.html">Decorate an Image</a></li>
 184   <li><a href="../www/api/attribute.html">Get/Set an Image Attribute</a></li>
 185   <li><a href="../www/api/property.html">Get/Set Image Properties</a></li>
 186   <li><a href="../www/api/statistic.html">Get Image Statistics</a></li>
 187   <li><a href="../www/api/feature.html">Get Image Features</a></li>
 188   <li><a href="../www/api/annotate.html">Annotate an Image</a></li>
 189   <li><a href="../www/api/paint.html">Paint on an Image</a></li>
 190   <li><a href="../www/api/draw.html">Draw on an Image</a></li>
 191   <li><a href="../www/api/montage.html">Create an Image Thumbnail</a></li>
 192   <li><a href="../www/api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
 193   <li><a href="../www/api/compare.html">Compare an Image to a Reconstructed Image</a></li>
 194   <li><a href="../www/api/display.html">Interactively Display and Edit an Image</a></li>
 195   <li><a href="../www/api/animate.html">Interactively Animate an Image Sequence</a></li>
 196   <li><a href="../www/api/cipher.html">Convert to and from Cipher Pixels</a></li>
 197   <li><a href="../www/api/list.html">Working with Image Lists</a></li>
 198   <li><a href="../www/api/cache.html">Get or Set Image Pixels</a></li>
 199   <li><a href="../www/api/cache-view.html">Working with Cache Views</a></li>
 200   <li><a href="../www/api/stream.html">The Pixel FIFO</a></li>
 201   <li><a href="../www/api/blob.html">Read or Write Binary Large OBjects</a></li>
 202   <li><a href="../www/api/module.html">Loadable Modules</a></li>
 203   <li><a href="../www/api/signature.html">Compute a Message Digest for an Image</a></li>
 204   <li><a href="../www/api/registry.html">The Image Registry</a></li>
 205   <li><a href="../www/api/exception.html">Dealing with Exceptions</a></li>
 206   <li><a href="../www/api/memory.html">Memory Allocation</a></li>
 207   <li><a href="../www/api/resource.html">Monitor or Limit Resource Consumption</a></li>
 208   <li><a href="../www/api/monitor.html">Monitor the Progress of an Image Operation</a></li>
 209   <li><a href="../www/api/version.html">Get the Version and Copyrights</a></li>
 210   <li><a href="../www/api/deprecate.html">Deprecated Methods</a></li>
 211   <li><a href="../www/exception.html">Error and Warning Codes</a></li>
 212 </ul>
 213
 214 <p>After you write your MagickCore program, compile it like this:</p>
 215
 216 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>cc `MagickCore-config --cflags --cppflags` core.c `MagickCore-config --ldflags --libs`</span></p>
 217 <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>
 218
 219 <div class="viewport">
 220 <pre class="code">
 221   #include &lt;stdio.h>
 222   #include &lt;stdlib.h>
 223   #include &lt;string.h>
 224   #include &lt;time.h>
 225   #include &lt;magick/MagickCore.h>
 226
 227   int main(int argc,char **argv)
 228   {
 229     ExceptionInfo
 230       *exception;
 231
 232     Image
 233       *image,
 234       *images,
 235       *resize_image,
 236       *thumbnails;
 237
 238     ImageInfo
 239       *image_info;
 240
 241     if (argc != 3)
 242       {
 243         (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
 244         exit(0);
 245       }
 246     /*
 247       Initialize the image info structure and read an image.
 248     */
 249     MagickCoreGenesis(*argv,MagickTrue);
 250     exception=AcquireExceptionInfo();
 251     image_info=CloneImageInfo((ImageInfo *) NULL);
 252     (void) strcpy(image_info-&gt;filename,argv[1]);
 253     images=ReadImage(image_info,exception);
 254     if (exception-&gt;severity != UndefinedException)
 255       CatchException(exception);
 256     if (images == (Image *) NULL)
 257       exit(1);
 258     /*
 259       Convert the image to a thumbnail.
 260     */
 261     thumbnails=NewImageList();
 262     while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
 263     {
 264       resize_image=ResizeImage(image,106,80,LanczosFilter,1.0,exception);
 265       if (resize_image == (Image *) NULL)
 266         MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
 267       (void) AppendImageToList(&amp;thumbnails,resize_image);
 268       DestroyImage(image);
 269     }
 270     /*
 271       Write the image thumbnail.
 272     */
 273     (void) strcpy(thumbnails-&gt;filename,argv[2]);
 274     WriteImage(image_info,thumbnails);
 275     /*
 276       Destroy the image thumbnail and exit.
 277     */
 278     thumbnails=DestroyImageList(thumbnails);
 279     image_info=DestroyImageInfo(image_info);
 280     exception=DestroyExceptionInfo(exception);
 281     MagickCoreTerminus();
 282     return(0);
 283   }
 284 </pre>
 285 </div>
 286 \r
 287 </div>\r
 288 \r
 289 <div id="linkbar">\r
 290  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 291     <span id="linkbar-center">\r
 292       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 293     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 294     </span>\r
 295     <span id="linkbar-east">&nbsp;</span>\r
 296   </div>\r
 297   <div class="footer">\r
 298     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 299     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 300   </div>\r
 301   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 302 </body>\r
 303 </html>\r