]> granicus.if.org Git - imagemagick/blob - www/magick-core.html
(no commit message)
[imagemagick] / www / magick-core.html
1 \r
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
3   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
4 <html version="-//W3C//DTD XHTML 1.1//EN"\r
5       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
6       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
7       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
8                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
9 <head>\r
10   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
11   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
12   <title>ImageMagick: MagickCore, Low-level C API for ImageMagick</title>
13   <meta http-equiv="Content-Language" content="en-US"/>
14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16   <meta name="Application-name" content="ImageMagick"/>
17   <meta name="Description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images."/>
18   <meta name="Application-url" content="http://www.imagemagick.org"/>
19   <meta name="Generator" content="PHP"/>
20   <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"/>
21   <meta name="Rating" content="GENERAL"/>
22   <meta name="Robots" content="INDEX, FOLLOW"/>
23   <meta name="Generator" content="ImageMagick Studio LLC"/>
24   <meta name="Author" content="ImageMagick Studio LLC"/>
25   <meta name="Revisit-after" content="2 DAYS"/>
26   <meta name="Resource-type" content="document"/>
27   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
28   <meta name="Distribution" content="Global"/>
29   <link rel="icon" href="../images/wand.png"/>
30   <link rel="shortcut icon" href="../images/wand.ico"  type="images/x-icon"/>
31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
32   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
33   <style type="text/css" media="all">\r
34     @import url("../www/magick.css");\r
35   </style>\r
36   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
37   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
38   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
39   <script type="text/javascript">\r
40     $(document).ready(function() {\r
41       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
42         'transitionIn'  : 'elastic',\r
43         'transitionOut' : 'elastic',\r
44         'overlayShow'   : false,\r
45         'opacity'       : true\r
46       });\r
47     });\r
48   </script>\r
49 </head>\r
50 \r
51 <body id="www-imagemagick-org">\r
52 <div class="titlebar">\r
53 <a href="../index.html">\r
54   <img src="../images/script.png" alt="[ImageMagick]"\r
55   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
56 <a href="http://www.networkredux.com">\r
57   <img src="../images/networkredux.png" alt="[sponsor]"\r
58   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
59 <a href="http://www.imagemagick.org/discourse-server/">\r
60   <img src="../images/logo.jpg"\r
61   alt="ImageMagick Logo"\r
62   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
63 <a href="../index.html">\r
64   <img src="../images/sprite.jpg"\r
65   alt="ImageMagick Sprite"\r
66   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
67 </div>\r
68 \r
69 <div class="westbar">\r
70 \r
71 <div class="menu">
72   <a title="About ImageMagick" href="../index.html">About ImageMagick</a>
73 </div>
74 <div class="sep"></div>\r
75 <div class="menu">
76   <a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
77 </div>
78 <div class="sub">
79     <a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
80 </div>
81 <div class="sub">
82     <a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
83 </div>
84 <div class="sub">
85     <a title="Binary Release: iPhone" href="../www/binary-releases.html#iPhone">iPhone</a>
86 </div>
87 <div class="sub">
88     <a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
89 </div>
90 <div class="sep"></div>\r
91 <div class="menu">
92   <a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
93 </div>
94 <div class="sub">
95     <a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
96 </div>
97 <div class="sub">
98     <a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
99 </div>
100 <div class="sub">
101     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
102 </div>
103 <div class="menu">
104   <a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
105 </div>
106 <div class="sub">
107     <a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
108 </div>
109 <div class="sub">
110     <a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
111 </div>
112 <div class="sub">
113     <a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
114 </div>
115 <div class="sub">
116     <a title="Program Interface: Magick++" href="../www/magick++.html">Magick++</a>
117 </div>
118 <div class="sep"></div>\r
119 <div  class="menu">
120    <a title="Install from Source" href="../www/install-source.html">Install from Source</a>
121 </div>
122 <div class="sub">
123     <a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
124 </div>
125 <div class="sub">
126     <a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
127  </div>
128 <div class="menu">
129   <a title="Resources" href="../www/resources.html">Resources</a>
130 </div>
131 <div class="menu">
132   <a title="Architecture" href="../www/architecture.html">Architecture</a>
133 </div>
134 <div class="menu">
135   <a title="Download" href="../www/download.html">Download</a>
136 </div>
137 <div class="sep"></div>\r
138 <div class="menu">
139   <a title="Search" href="../www/search.html">Search</a>
140 </div>
141 <div class="sep"></div>\r
142 <div class="menu">
143   <a title="Site Map" href="../www/sitemap.html">Site Map</a>
144 </div>
145 <div  class="sub">
146   <a title="Site Map: Links" href="../www/links.html">Links</a>
147 </div>
148 <div class="sep"></div>\r
149 <div  class="menu">
150   <a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
151
152 <div class="sponsbox">
153 <div  class="sponsor">
154   <a title="Sponsor: Website Hosting" href="http://hostreviewgeeks.com">Website Hosting</a><!-- 201106010090 alexanian media -->
155 </div>
156 <div  class="sponsor">
157   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
158 </div>
159 <div  class="sponsor">
160   <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
161 </div>
162 <div  class="sponsor">
163   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
164 </div>
165 <div  class="sponsor">
166   <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
167 </div>
168 <div  class="sponsor">
169   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
170 </div>
171 <div class="sponsor">
172   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
173 </div>
174 <div  class="sponsor">
175   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
176 </div>
177 <div  class="sponsor">
178    <a title="Sponsor: Fototapete" href=" http://www.allesdruck.de/Fototapete-Tapetendruck,category,8830.html">Fototapete</a><!-- 20110701000080 a-o.de -->
179 </div>
180 </div>
181 </div>
182 </div>\r
183 \r
184 <div class="eastbar">\r
185   <script type="text/javascript">\r
186   <!--\r
187     google_ad_client = "pub-3129977114552745";\r
188     google_ad_slot = "0574824969";\r
189     google_ad_width = 160;\r
190     google_ad_height = 600;\r
191   //-->\r
192   </script>\r
193   <script type="text/javascript"\r
194     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
195   </script>\r
196 </div>\r
197 \r
198 <div class="main">\r
199 \r
200 <h1>MagickCore C API</h1>
201
202 <div class="doc-section">
203
204 <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>
205
206 <ul>
207   <li><a href="../www/api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
208   <li><a href="../www/api/constitute.html">Constitute an Image</a></li>
209   <li><a href="../www/api/composite.html">Composite an Image</a></li>
210   <li><a href="../www/api/image.html">Image Methods</a></li>
211   <li><a href="../www/api/color.html">Count the Colors in an Image</a></li>
212   <li><a href="../www/api/colormap.html">Colormap Methods</a></li>
213   <li><a href="../www/api/distort.html">Image Distortions</a></li>
214   <li><a href="../www/api/layer.html">Dealing with Image Layers</a></li>
215   <li><a href="../www/api/profile.html">Dealing with Image Profiles</a></li>
216   <li><a href="../www/api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
217   <li><a href="../www/api/histogram.html">Image Histograms</a></li>
218   <li><a href="../www/api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
219   <li><a href="../www/api/resize.html">Resize an Image</a></li>
220   <li><a href="../www/api/transform.html">Transform an Image</a></li>
221   <li><a href="../www/api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
222   <li><a href="../www/api/enhance.html">Enhance an Image</a></li>
223   <li><a href="../www/api/effect.html">Add an Effect</a></li>
224   <li><a href="../www/api/morphology.html">Morphological Erosions, Dilations, Openings, and Closings</a></li>
225   <li><a href="../www/api/fx.html">Add a Special Effect</a></li>
226   <li><a href="../www/api/decorate.html">Decorate an Image</a></li>
227   <li><a href="../www/api/attribute.html">Get/Set an Image Attribute</a></li>
228   <li><a href="../www/api/property.html">Get/Set Image Properties</a></li>
229   <li><a href="../www/api/statistic.html">Get Image Statistics</a></li>
230   <li><a href="../www/api/feature.html">Get Image Features</a></li>
231   <li><a href="../www/api/annotate.html">Annotate an Image</a></li>
232   <li><a href="../www/api/paint.html">Paint on an Image</a></li>
233   <li><a href="../www/api/draw.html">Draw on an Image</a></li>
234   <li><a href="../www/api/montage.html">Create an Image Thumbnail</a></li>
235   <li><a href="../www/api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
236   <li><a href="../www/api/compare.html">Compare an Image to a Reconstructed Image</a></li>
237   <li><a href="../www/api/display.html">Interactively Display and Edit an Image</a></li>
238   <li><a href="../www/api/animate.html">Interactively Animate an Image Sequence</a></li>
239   <li><a href="../www/api/cipher.html">Convert to and from Cipher Pixels</a></li>
240   <li><a href="../www/api/list.html">Working with Image Lists</a></li>
241   <li><a href="../www/api/image-view.html">Image View Methods</a></li>
242   <li><a href="../www/api/cache.html">Get or Set Image Pixels</a></li>
243   <li><a href="../www/api/cache-view.html">Working with Cache Views</a></li>
244   <li><a href="../www/api/stream.html">The Pixel FIFO</a></li>
245   <li><a href="../www/api/blob.html">Read or Write Binary Large OBjects</a></li>
246   <li><a href="../www/api/module.html">Loadable Modules</a></li>
247   <li><a href="../www/api/signature.html">Compute a Message Digest for an Image</a></li>
248   <li><a href="../www/api/registry.html">The Image Registry</a></li>
249   <li><a href="../www/api/exception.html">Dealing with Exceptions</a></li>
250   <li><a href="../www/api/memory.html">Memory Allocation</a></li>
251   <li><a href="../www/api/resource.html">Monitor or Limit Resource Consumption</a></li>
252   <li><a href="../www/api/monitor.html">Monitor the Progress of an Image Operation</a></li>
253   <li><a href="../www/api/version.html">Get the Version and Copyrights</a></li>
254   <li><a href="../www/api/deprecate.html">Deprecated Methods</a></li>
255   <li><a href="../www/exception.html">Error and Warning Codes</a></li>
256 </ul>
257
258 <p>After you write your MagickCore program, compile it like this:</p>
259
260 <p class='crt'><span class="crtprompt"> $magick&gt; </span><span class='crtin'>cc `MagickCore-config --cflags --cppflags` -O2 core.c  \ <br/> `MagickCore-config --ldflags --libs`</span></p>
261 <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>
262
263 <div class="viewport">
264 <pre class="code">
265   #include &lt;stdio.h>
266   #include &lt;stdlib.h>
267   #include &lt;string.h>
268   #include &lt;time.h>
269   #include &lt;magick/MagickCore.h>
270
271   int main(int argc,char **argv)
272   {
273     ExceptionInfo
274       *exception;
275
276     Image
277       *image,
278       *images,
279       *resize_image,
280       *thumbnails;
281
282     ImageInfo
283       *image_info;
284
285     if (argc != 3)
286       {
287         (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
288         exit(0);
289       }
290     /*
291       Initialize the image info structure and read an image.
292     */
293     MagickCoreGenesis(*argv,MagickTrue);
294     exception=AcquireExceptionInfo();
295     image_info=CloneImageInfo((ImageInfo *) NULL);
296     (void) strcpy(image_info-&gt;filename,argv[1]);
297     images=ReadImage(image_info,exception);
298     if (exception-&gt;severity != UndefinedException)
299       CatchException(exception);
300     if (images == (Image *) NULL)
301       exit(1);
302     /*
303       Convert the image to a thumbnail.
304     */
305     thumbnails=NewImageList();
306     while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
307     {
308       resize_image=ResizeImage(image,106,80,LanczosFilter,1.0,exception);
309       if (resize_image == (Image *) NULL)
310         MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
311       (void) AppendImageToList(&amp;thumbnails,resize_image);
312       DestroyImage(image);
313     }
314     /*
315       Write the image thumbnail.
316     */
317     (void) strcpy(thumbnails-&gt;filename,argv[2]);
318     WriteImage(image_info,thumbnails);
319     /*
320       Destroy the image thumbnail and exit.
321     */
322     thumbnails=DestroyImageList(thumbnails);
323     image_info=DestroyImageInfo(image_info);
324     exception=DestroyExceptionInfo(exception);
325     MagickCoreTerminus();
326     return(0);
327   }
328 </pre>
329 </div>
330 <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="../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>
331
332 <div class="viewport">
333 <pre class="code">
334 #include &lt;stdio.h>
335 #include &lt;stdlib.h>
336 #include &lt;math.h>
337 #include &lt;magick/MagickCore.h>
338
339 static MagickBooleanType SigmoidalContrast(ImageView *contrast_view,
340   const ssize_t y,const int id,void *context)
341 {
342 #define QuantumScale  ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
343 #define SigmoidalContrast(x) \
344   (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
345
346   RectangleInfo
347     extent;
348
349   register IndexPacket
350     *indexes;
351
352   register PixelPacket
353     *pixels;
354
355   register ssize_t
356     x;
357
358   extent=GetImageViewExtent(contrast_view);
359   pixels=GetImageViewAuthenticPixels(contrast_view);
360   for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
361   {
362     pixels[x].red=RoundToQuantum(SigmoidalContrast(pixels[x].red));
363     pixels[x].green=RoundToQuantum(SigmoidalContrast(pixels[x].green));
364     pixels[x].blue=RoundToQuantum(SigmoidalContrast(pixels[x].blue));
365     pixels[x].opacity=RoundToQuantum(SigmoidalContrast(pixels[x].opacity));
366   }
367   indexes=GetImageViewAuthenticIndexes(contrast_view);
368   if (indexes != (IndexPacket *) NULL)
369     for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
370       indexes[x]=(IndexPacket) RoundToQuantum(SigmoidalContrast(indexes[x]));
371   return(MagickTrue);
372 }
373
374 int main(int argc,char **argv)
375 {
376 #define ThrowImageException(image) \
377 { \
378  \
379   CatchException(exception); \
380   if (contrast_image != (Image *) NULL) \
381     contrast_image=DestroyImage(contrast_image); \
382   exit(-1); \
383 }
384 #define ThrowViewException(view) \
385 { \
386   char \
387     *description; \
388  \
389   ExceptionType \
390     severity; \
391  \
392   description=GetImageViewException(view,&amp;severity); \
393   (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
394   description=DestroyString(description); \
395   exit(-1); \
396 }
397
398   ExceptionInfo
399     *exception;
400
401   Image
402     *contrast_image;
403
404   ImageInfo
405     *image_info;
406
407   ImageView
408     *contrast_view;
409
410   MagickBooleanType
411     status;
412
413   if (argc != 3)
414     {
415       (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
416       exit(0);
417     }
418   /*
419     Read an image.
420   */
421   MagickCoreGenesis(*argv,MagickTrue);
422   image_info=AcquireImageInfo();
423   (void) CopyMagickString(image_info->filename,argv[1],MaxTextExtent);
424   exception=AcquireExceptionInfo();
425   contrast_image=ReadImage(image_info,exception);
426   if (contrast_image == (Image *) NULL)
427     ThrowImageException(contrast_image);
428   /*
429     Sigmoidal non-linearity contrast control.
430   */
431   contrast_view=NewImageView(contrast_image);
432   if (contrast_view == (ImageView *) NULL)
433     ThrowImageException(contrast_image);
434   status=UpdateImageViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
435   if (status == MagickFalse)
436     ThrowImageException(contrast_image);
437   contrast_view=DestroyImageView(contrast_view);
438   /*
439     Write the image then destroy it.
440   */
441   status=WriteImages(image_info,contrast_image,argv[2],exception);
442   if (status == MagickFalse)
443     ThrowImageException(contrast_image);
444   contrast_image=DestroyImage(contrast_image);
445   exception=DestroyExceptionInfo(exception);
446   image_info=DestroyImageInfo(image_info);
447   MagickCoreTerminus();
448   return(0);
449 }
450 </pre>
451 </div>
452 </div>
453 \r
454 </div>\r
455 \r
456 <div id="linkbar">\r
457     <span id="linkbar-west">&nbsp;</span>\r
458     <span id="linkbar-center">\r
459       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
460       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
461     </span>\r
462     <span id="linkbar-east">&nbsp;</span>\r
463   </div>\r
464   <div class="footer">\r
465     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
466     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
467   </div>\r
468   <div style="clear: both; margin: 0; width: 100%; "></div>\r
469   <script type="text/javascript">\r
470     var _gaq = _gaq || [];\r
471     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
472     _gaq.push(['_trackPageview']);\r
473 \r
474     (function() {\r
475       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
476       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
477       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
478     })();\r
479   </script>\r
480 </body>\r
481 </html>\r