blob: 5ed49ba703d6c7d1c5cc39afbbd8b65fd57020f1 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
<style type="text/css" media="all">
@import url("../www/magick.css");
</style>
<link rel="shortcut icon" href="../images/wand.ico" type="images/vnd.microsoft.icon"/>
<title>ImageMagick: MagickCore, Low-level C API for ImageMagick</title>
<meta http-equiv="Content-Language" content="en-US"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
<meta name="Generator" content="PHP"/>
<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"/>
<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."/>
<meta name="Rating" content="GENERAL"/>
<meta name="Robots" content="INDEX, FOLLOW"/>
<meta name="Generator" content="ImageMagick Studio LLC"/>
<meta name="Author" content="ImageMagick Studio LLC"/>
<meta name="Revisit-after" content="2 DAYS"/>
<meta name="Resource-type" content="document"/>
<meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<a href="../index.html">
<img src="../images/script.png" alt="[ImageMagick]"
style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
<a href="http://www.networkredux.com">
<img src="../images/networkredux.png" alt="[sponsor]"
style="margin: 45px auto; border: 0px; float: left;" /></a>
<a href="http://www.imagemagick.org/discourse-server/">
<img src="../images/logo.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
<a href="../index.html">
<img src="../images/sprite.jpg" alt=""
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="eastbar">
<div class="menu">
<a title="About ImageMagick" href="../index.html">About ImageMagick</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Binary Releases" href="../www/binary-releases.html">Binary Releases</a>
</div>
<div class="sub">
<a title="Binary Release: Unix" href="../www/binary-releases.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Binary Release: MacOS X" href="../www/binary-releases.html#macosx">Mac OS X</a>
</div>
<div class="sub">
<a title="Binary Release: Windows" href="../www/binary-releases.html#windows">Windows</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Command-line Tools" href="../www/command-line-tools.html">Command-line Tools</a>
</div>
<div class="sub">
<a title="Command-line Tools: Processing" href="../www/command-line-processing.html">Processing</a>
</div>
<div class="sub">
<a title="Command-line Tools: Options" href="../www/command-line-options.html">Options</a>
</div>
<div class="sub">
<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a title="Program Interfaces" href="../www/api.html">Program Interfaces</a>
</div>
<div class="sub">
<a title="Program Interface: MagickWand" href="../www/magick-wand.html">MagickWand</a>
</div>
<div class="sub">
<a title="Program Interface: MagickCore" href="../www/magick-core.html">MagickCore</a>
</div>
<div class="sub">
<a title="Program Interface: PerlMagick" href="../www/perl-magick.html">PerlMagick</a>
</div>
<div class="sub">
<a title="Program Interface: Magick++" href="../Magick++/">Magick++</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Install from Source" href="../www/install-source.html">Install from Source</a>
</div>
<div class="sub">
<a title="Install from Source: Unix" href="../www/install-source.html#unix">Unix</a>
</div>
<div class="sub">
<a title="Install from Source: Windows" href="../www/install-source.html#windows">Windows</a>
</div>
<div class="menu">
<a title="Resources" href="../www/resources.html">Resources</a>
</div>
<div class="menu">
<a title="Architecture" href="../www/architecture.html">Architecture</a>
</div>
<div class="menu">
<a title="Download" href="../www/download.html">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Site Map"href="../www/sitemap.html">Site Map</a>
</div>
<div class="sub">
<a title="Site Map: Links"href="../www/links.html">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Sponsors" href="../www/sponsors.html">Sponsors:</a>
<div class="sponsbox">
<div class="sponsor">
<a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
</div>
<div class="sponsor">
<a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
</div>
<div class="sponsor">
<a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
</div>
<div class="sponsor">
<a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
</div>
<div class="sponsor">
<a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
</div>
<div class="sponsor">
<a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
</div>
<div class="sponsor">
<a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20111001000240 -->
</div>
</div>
</div>
</div>
<div class="main">
<p class="navigation-index"></p>
<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>
<ul>
<li><a href="../www/api/magick.html">Initialize or Destroy the ImageMagick Environment</a></li>
<li><a href="../www/api/constitute.html">Constitute an Image</a></li>
<li><a href="../www/api/composite.html">Composite an Image</a></li>
<li><a href="../www/api/image.html">Image Methods</a></li>
<li><a href="../www/api/color.html">Count the Colors in an Image</a></li>
<li><a href="../www/api/colormap.html">Colormap Methods</a></li>
<li><a href="../www/api/distort.html">Image Distortions</a></li>
<li><a href="../www/api/layer.html">Dealing with Image Layers</a></li>
<li><a href="../www/api/profile.html">Dealing with Image Profiles</a></li>
<li><a href="../www/api/quantize.html">Reduce the Number of Unique Colors in an Image</a></li>
<li><a href="../www/api/histogram.html">Image Histograms</a></li>
<li><a href="../www/api/segment.html">Segment an Image with Thresholding Fuzzy c-Means</a></li>
<li><a href="../www/api/resize.html">Resize an Image</a></li>
<li><a href="../www/api/transform.html">Transform an Image</a></li>
<li><a href="../www/api/shear.html">Shear or Rotate an Image by an Arbitrary Angle</a></li>
<li><a href="../www/api/enhance.html">Enhance an Image</a></li>
<li><a href="../www/api/effect.html">Add an Effect</a></li>
<li><a href="../www/api/morphology.html">Morphological Erosions, Dilations, Openings, and Closings</a></li>
<li><a href="../www/api/fx.html">Add a Special Effect</a></li>
<li><a href="../www/api/decorate.html">Decorate an Image</a></li>
<li><a href="../www/api/attribute.html">Get/Set an Image Attribute</a></li>
<li><a href="../www/api/property.html">Get/Set Image Properties</a></li>
<li><a href="../www/api/statistic.html">Get Image Statistics</a></li>
<li><a href="../www/api/feature.html">Get Image Features</a></li>
<li><a href="../www/api/annotate.html">Annotate an Image</a></li>
<li><a href="../www/api/paint.html">Paint on an Image</a></li>
<li><a href="../www/api/draw.html">Draw on an Image</a></li>
<li><a href="../www/api/montage.html">Create an Image Thumbnail</a></li>
<li><a href="../www/api/fourier.html">Compute the discrete Fourier transform (DFT)</a></li>
<li><a href="../www/api/compare.html">Compare an Image to a Reconstructed Image</a></li>
<li><a href="../www/api/display.html">Interactively Display and Edit an Image</a></li>
<li><a href="../www/api/animate.html">Interactively Animate an Image Sequence</a></li>
<li><a href="../www/api/cipher.html">Convert to and from Cipher Pixels</a></li>
<li><a href="../www/api/list.html">Working with Image Lists</a></li>
<li><a href="../www/api/image-view.html">Image View Methods</a></li>
<li><a href="../www/api/cache.html">Get or Set Image Pixels</a></li>
<li><a href="../www/api/cache-view.html">Working with Cache Views</a></li>
<li><a href="../www/api/stream.html">The Pixel FIFO</a></li>
<li><a href="../www/api/blob.html">Read or Write Binary Large OBjects</a></li>
<li><a href="../www/api/module.html">Loadable Modules</a></li>
<li><a href="../www/api/signature.html">Compute a Message Digest for an Image</a></li>
<li><a href="../www/api/registry.html">The Image Registry</a></li>
<li><a href="../www/api/exception.html">Dealing with Exceptions</a></li>
<li><a href="../www/api/memory.html">Memory Allocation</a></li>
<li><a href="../www/api/resource.html">Monitor or Limit Resource Consumption</a></li>
<li><a href="../www/api/monitor.html">Monitor the Progress of an Image Operation</a></li>
<li><a href="../www/api/version.html">Get the Version and Copyrights</a></li>
<li><a href="../www/api/deprecate.html">Deprecated Methods</a></li>
<li><a href="../www/exception.html">Error and Warning Codes</a></li>
</ul>
<p>After you write your MagickCore program, compile it like this:</p>
<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>
<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>
<div class="viewport">
<pre class="code">
#include &lt;stdio.h>
#include &lt;stdlib.h>
#include &lt;string.h>
#include &lt;time.h>
#include &lt;magick/MagickCore.h>
int main(int argc,char **argv)
{
ExceptionInfo
*exception;
Image
*image,
*images,
*resize_image,
*thumbnails;
ImageInfo
*image_info;
if (argc != 3)
{
(void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
exit(0);
}
/*
Initialize the image info structure and read an image.
*/
MagickCoreGenesis(*argv,MagickTrue);
exception=AcquireExceptionInfo();
image_info=CloneImageInfo((ImageInfo *) NULL);
(void) strcpy(image_info-&gt;filename,argv[1]);
images=ReadImage(image_info,exception);
if (exception-&gt;severity != UndefinedException)
CatchException(exception);
if (images == (Image *) NULL)
exit(1);
/*
Convert the image to a thumbnail.
*/
thumbnails=NewImageList();
while ((image=RemoveFirstImageFromList(&amp;images)) != (Image *) NULL)
{
resize_image=ResizeImage(image,106,80,LanczosFilter,1.0,exception);
if (resize_image == (Image *) NULL)
MagickError(exception-&gt;severity,exception-&gt;reason,exception-&gt;description);
(void) AppendImageToList(&amp;thumbnails,resize_image);
DestroyImage(image);
}
/*
Write the image thumbnail.
*/
(void) strcpy(thumbnails-&gt;filename,argv[2]);
WriteImage(image_info,thumbnails);
/*
Destroy the image thumbnail and exit.
*/
thumbnails=DestroyImageList(thumbnails);
image_info=DestroyImageInfo(image_info);
exception=DestroyExceptionInfo(exception);
MagickCoreTerminus();
return(0);
}
</pre>
</div>
<p><a name="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>
<div class="viewport">
<pre class="code">
#include &lt;stdio.h>
#include &lt;stdlib.h>
#include &lt;math.h>
#include &lt;magick/MagickCore.h>
static MagickBooleanType SigmoidalContrast(ImageView *contrast_view,
const ssize_t y,const int id,void *context)
{
#define QuantumScale ((MagickRealType) 1.0/(MagickRealType) QuantumRange)
#define SigmoidalContrast(x) \
(QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
RectangleInfo
extent;
register IndexPacket
*indexes;
register PixelPacket
*pixels;
register ssize_t
x;
extent=GetImageViewExtent(contrast_view);
pixels=GetImageViewAuthenticPixels(contrast_view);
for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
{
pixels[x].red=RoundToQuantum(SigmoidalContrast(pixels[x].red));
pixels[x].green=RoundToQuantum(SigmoidalContrast(pixels[x].green));
pixels[x].blue=RoundToQuantum(SigmoidalContrast(pixels[x].blue));
pixels[x].opacity=RoundToQuantum(SigmoidalContrast(pixels[x].opacity));
}
indexes=GetImageViewAuthenticIndexes(contrast_view);
if (indexes != (IndexPacket *) NULL)
for (x=0; x &lt; (ssize_t) (extent.width-extent.x); x++)
indexes[x]=(IndexPacket) RoundToQuantum(SigmoidalContrast(indexes[x]));
return(MagickTrue);
}
int main(int argc,char **argv)
{
#define ThrowImageException(image) \
{ \
\
CatchException(exception); \
if (contrast_image != (Image *) NULL) \
contrast_image=DestroyImage(contrast_image); \
exit(-1); \
}
#define ThrowViewException(view) \
{ \
char \
*description; \
\
ExceptionType \
severity; \
\
description=GetImageViewException(view,&severity); \
(void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
description=DestroyString(description); \
exit(-1); \
}
ExceptionInfo
*exception;
Image
*contrast_image;
ImageInfo
*image_info;
ImageView
*contrast_view;
MagickBooleanType
status;
if (argc != 3)
{
(void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
exit(0);
}
/*
Read an image.
*/
MagickCoreGenesis(*argv,MagickTrue);
image_info=AcquireImageInfo();
(void) CopyMagickString(image_info->filename,argv[1],MaxTextExtent);
exception=AcquireExceptionInfo();
contrast_image=ReadImage(image_info,exception);
if (contrast_image == (Image *) NULL)
ThrowImageException(contrast_image);
/*
Sigmoidal non-linearity contrast control.
*/
contrast_view=NewImageView(contrast_image);
if (contrast_view == (ImageView *) NULL)
ThrowImageException(contrast_image);
status=UpdateImageViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
if (status == MagickFalse)
ThrowImageException(contrast_image);
contrast_view=DestroyImageView(contrast_view);
/*
Write the image then destroy it.
*/
status=WriteImages(image_info,contrast_image,argv[2],exception);
if (status == MagickFalse)
ThrowImageException(contrast_image);
contrast_image=DestroyImage(contrast_image);
exception=DestroyExceptionInfo(exception);
image_info=DestroyImageInfo(image_info);
MagickCoreTerminus();
return(0);
}
</pre>
</div>
</div>
<div id="linkbar">
<!-- <span id="linkbar-west">&nbsp;</span> -->
<span id="linkbar-center">
<a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east">&nbsp;</span>
</div>
<div class="footer">
<span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>