Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 9372a158e662d81ce4df26249238df39d66102ff / . / www / magick-core.html
blob: 53a2cec5c003450d728ce912cbbab5a981b0810b [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../www/magick.css");
10 --></style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
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="Generator" content="PHP"/>
17 <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"/>
18 <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."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../index.html">
32 <img src="../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../index.html">
41 <img src="../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
48 <a href="../index.html">About ImageMagick</a>
49</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
52 <a href="../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../www/architecture.html">Architecture</a>
80</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
83 <a href="../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../www/resources.html">Resources</a>
105</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
108 <a href="../www/download.html">Download</a>
109</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
112 <a href="http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
116 <a href="../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../www/links.html">Links</a>
120</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
123 <a href="../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]127 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]130 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]133 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
134</div>
135<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]136 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
138<div class="sponsor">
139 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
140</div>
141<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
145</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]146
147
148</div>
149
150<div class="main">
151
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152<p class="navigation-index"></p>
153
154<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>
155
156<ul>
157 <li><a href="../www/api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
158 <li><a href="../www/api/constitute.html">Constitute an Image</a></li>
159 <li><a href="../www/api/composite.html">Composite an Image</a></li>
160 <li><a href="../www/api/image.html">Image Methods</a></li>
161 <li><a href="../www/api/color.html">Count the Colors in an Image</a></li>
cristy43d0f4d2009-09-17 19:35:37 +0000[diff] [blame]162 <li><a href="../www/api/colormap.html">Colormap Methods</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]163 <li><a href="../www/api/distort.html">Image Distortions</a></li>
164 <li><a href="../www/api/layer.html">Dealing with Image Layers</a></li>
165 <li><a href="../www/api/profile.html">Dealing with Image Profiles</a></li>
166 <li><a href="../www/api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
167 <li><a href="../www/api/histogram.html">Image Histograms</a></li>
168 <li><a href="../www/api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
169 <li><a href="../www/api/resize.html">Resize an Image</a></li>
170 <li><a href="../www/api/transform.html">Transform an Image</a></li>
171 <li><a href="../www/api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
172 <li><a href="../www/api/enhance.html">Enhance an Image</a></li>
173 <li><a href="../www/api/effect.html">Add an Effect</a></li>
174 <li><a href="../www/api/fx.html">Add a Special Effect</a></li>
175 <li><a href="../www/api/decorate.html">Decorate an Image</a></li>
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]176 <li><a href="../www/api/attribute.html">Get/Set an Image Attribute</a></li>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]177 <li><a href="../www/api/property.html">Get/Set Image Properties</a></li>
178 <li><a href="../www/api/annotate.html">Annotate an Image</a></li>
179 <li><a href="../www/api/paint.html">Paint on an Image</a></li>
180 <li><a href="../www/api/draw.html">Draw on an Image</a></li>
181 <li><a href="../www/api/montage.html">Create an Image Thumbnail</a></li>
182 <li><a href="../www/api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
183 <li><a href="../www/api/compare.html">Compare an Image to a Reconstructed Image</a></li>
184 <li><a href="../www/api/display.html">Interactively Display and Edit an Image</a></li>
185 <li><a href="../www/api/animate.html">Interactively Animate an Image Sequence</a></li>
186 <li><a href="../www/api/cipher.html">Convert to and from Cipher Pixels</a></li>
187 <li><a href="../www/api/list.html">Working with Image Lists</a></li>
188 <li><a href="../www/api/cache.html">Get or Set Image Pixels</a></li>
189 <li><a href="../www/api/cache-view.html">Working with Cache Views</a></li>
190 <li><a href="../www/api/stream.html">The Pixel FIFO</a></li>
191 <li><a href="../www/api/blob.html">Read or Write Binary Large OBjects</a></li>
192 <li><a href="../www/api/module.html">Loadable Modules</a></li>
193 <li><a href="../www/api/signature.html">Compute a Message Digest for an Image</a></li>
194 <li><a href="../www/api/registry.html">The Image Registry</a></li>
195 <li><a href="../www/api/exception.html">Dealing with Exceptions</a></li>
196 <li><a href="../www/api/memory.html">Memory Allocation</a></li>
197 <li><a href="../www/api/resource.html">Monitor or Limit Resource Consumption</a></li>
198 <li><a href="../www/api/monitor.html">Monitor the Progress of an Image Operation</a></li>
199 <li><a href="../www/api/version.html">Get the Version and Copyrights</a></li>
200 <li><a href="../www/api/deprecate.html">Deprecated Methods</a></li>
201 <li><a href="../www/exception.html">Error and Warning Codes</a></li>
202</ul>
203
204<p>After you write your MagickCore program, compile it like this:</p>
205
206<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>
207<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>
208
209<div class="viewport">
210<pre class="code">
211 #include &lt;stdio.h>
212 #include &lt;stdlib.h>
213 #include &lt;string.h>
214 #include &lt;time.h>
215 #include &lt;magick/MagickCore.h>
216
217 int main(int argc,char **argv)
218 {
219 ExceptionInfo
220 *exception;
221
222 Image
223 *image,
224 *images,
225 *resize_image,
226 *thumbnails;
227
228 ImageInfo
229 *image_info;
230
231 if (argc != 3)
232 {
233 (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
234 exit(0);
235 }
236 /*
237 Initialize the image info structure and read an image.
238 */
239 MagickCoreGenesis(*argv,MagickTrue);
240 exception=AcquireExceptionInfo();
241 image_info=CloneImageInfo((ImageInfo *) NULL);
242 (void) strcpy(image_info-&gt;filename,argv[1]);
243 images=ReadImage(image_info,exception);
244 if (exception-&gt;severity != UndefinedException)
245 CatchException(exception);
246 if (images == (Image *) NULL)
247 exit(1);
248 /*
249 Convert the image to a thumbnail.
250 */
251 thumbnails=NewImageList();
252 while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
253 {
254 resize_image=ResizeImage(image,106,80,LanczosFilter,1.0,exception);
255 if (resize_image == (Image *) NULL)
256 MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
257 (void) AppendImageToList(&amp;thumbnails,resize_image);
258 DestroyImage(image);
259 }
260 /*
261 Write the image thumbnail.
262 */
263 (void) strcpy(thumbnails-&gt;filename,argv[2]);
264 WriteImage(image_info,thumbnails);
265 /*
266 Destroy the image thumbnail and exit.
267 */
268 thumbnails=DestroyImageList(thumbnails);
269 image_info=DestroyImageInfo(image_info);
270 exception=DestroyExceptionInfo(exception);
271 MagickCoreTerminus();
272 return(0);
273 }
274</pre>
275</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]276
277</div>
278
279<div id="linkbar">
280 <!-- <span id="linkbar-west">&nbsp;</span> -->
281 <span id="linkbar-center">
282 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
283 <a href="../www/mailing-list.html">Mailing Lists</a> &bull;
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame]284 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]285 </span>
286 <span id="linkbar-east">&nbsp;</span>
287 </div>
288 <div class="footer">
289 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
290 <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
291 </div>
292 <div style="clear: both; margin: 0; width: 100%; "></div>
293</body>
294</html>