| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418 |
- <!doctype html>
- <html lang="en">
- <head>
- <meta charset="utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1" />
- <title>ImageMagick – MagickWand, C API</title>
- <meta name="application-name" content="ImageMagick" />
- <meta name="description" content="" />
- <meta name="application-url" content="https://imagemagick.org" />
- <meta name="generator" content="PHP" />
- <meta name="keywords" content="magickwc, api, image processing software" />
- <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 ImageMagick Studio LLC" />
- <meta name="distribution" content="Global" />
- <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
- <meta property='og:url' content='../' />
- <meta property='og:title' content='ImageMagick' />
- <meta property='og:image' content='../images/logo.png' />
- <meta property='og:type' content='website' />
- <meta property='og:site_name' content='ImageMagick' />
- <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" />
- <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
- <link href="magick-wand.html" rel="canonical" />
- <link href="../images/wand.png" rel="icon" />
- <link href="../images/wand.ico" rel="shortcut icon" />
- <link href="assets/magick.css" rel="stylesheet" />
- </head>
- <body>
- <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
- <div class="container-fluid">
- <a class="navbar-brand" href="../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a>
- <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
- <span class="navbar-toggler-icon"></span>
- </button>
- <div class="collapse navbar-collapse" id="magick-navbars">
- <ul class="navbar-nav me-auto mb-2 mb-md-0">
- <li class="nav-item">
- <a class="nav-link " href="../www/download.html">Download</a>
- </li>
- <li class="nav-item">
- <a class="nav-link " href="../www/command-line-tools.html">Tools</a>
- </li>
- <li class="nav-item">
- <a class="nav-link " href="../www/command-line-processing.html">CLI</a>
- </li>
- <li class="nav-item">
- <a class="nav-link " href="../www/develop.html">Develop</a>
- </li>
- <li class="nav-item">
- <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
- </li>
- <li class="nav-item">
- <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
- </li>
- </ul>
- <form class="d-flex form-inline" action="search.html">
- <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
- <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
- </form>
- </div>
- </div>
- </nav>
- <div class="container">
- <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>
- <ins class="adsbygoogle"
- style="display:block"
- data-ad-client="ca-pub-3129977114552745"
- data-ad-slot="6345125851"
- data-full-width-responsive="true"
- data-ad-format="horizontal"></ins>
- <script>
- (adsbygoogle = window.adsbygoogle || []).push({});
- </script>
- </div>
- <main class="container">
- <div class="magick-template">
- <div class="magick-header">
- <h1 class="text-center">MagickWand Image API for C</h1>
- <p class="lead magick-description">The <a href="api/MagickWand/index.html">MagickWand API</a> is the recommended interface between the C programming language and the ImageMagick image processing libraries. Unlike the <a href="api/MagickCore/index.html">MagickCore</a> C API, MagickWand uses only a few opaque types. Accessors are available to set or get important wand properties. A description of the MagickWand public methods are found here:</p>
- <ul>
- <li><a href="api/magick-wand.html">Magick Wand Methods</a></li>
- <li><a href="api/magick-property.html">Set or Get Magick Wand Properties</a></li>
- <li><a href="api/magick-image.html">Magick Wand Image Methods</a></li>
- <li><a href="api/pixel-iterator.html">Pixel Iterator Methods</a></li>
- <li><a href="api/pixel-wand.html">Pixel Wand Methods</a></li>
- <li><a href="api/drawing-wand.html">Image Vector Drawing</a></li>
- <li><a href="api/mogrify.html">Command-line Interface</a></li>
- <li><a href="api/wand-view.html">Wand View Methods</a></li>
- <li><a href="api/magick-deprecate.html">Deprecated Methods</a></li>
- <li><a href="exception.html">Error and Warning Codes</a></li>
- </ul>
- <p>After you write your MagickWand program, compile it like this:</p>
- <pre class="bg-light text-dark mx-4"><samp>cc -o wand wand.c `pkg-config --cflags --libs MagickWand`</samp></pre>
- <p>Set the <samp>PKG_CONFIG_PATH</samp> environment variable if ImageMagick is not in your default system path:</p>
- <pre class="bg-light text-dark mx-4"><samp>export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig</samp></pre>
- <p>Here is a example program that utilizes the MagickWand API to get you started, <a href="https://imagemagick.org/source/wand.c">wand.c</a>. It reads an image, creates a thumbnail, and writes the result to disk.</p>
- <pre class="pre-scrollable bg-light text-dark mx-4"><samp>#include <stdio.h>
- #include <stdlib.h>
- #include <MagickWand/MagickWand.h>
- int main(int argc,char **argv)
- {
- #define ThrowWandException(wand) \
- { \
- char \
- *description; \
- \
- ExceptionType \
- severity; \
- \
- description=MagickGetException(wand,&severity); \
- (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
- description=(char *) MagickRelinquishMemory(description); \
- exit(-1); \
- }
- MagickBooleanType
- status;
- MagickWand
- *magick_wand;
- if (argc != 3)
- {
- (void) fprintf(stdout,"Usage: %s image thumbnail\n",argv[0]);
- exit(0);
- }
- /*
- Read an image.
- */
- MagickWandGenesis();
- magick_wand=NewMagickWand();
- status=MagickReadImage(magick_wand,argv[1]);
- if (status == MagickFalse)
- ThrowWandException(magick_wand);
- /*
- Turn the images into a thumbnail sequence.
- */
- MagickResetIterator(magick_wand);
- while (MagickNextImage(magick_wand) != MagickFalse)
- MagickResizeImage(magick_wand,106,80,LanczosFilter,1.0);
- /*
- Write the image then destroy it.
- */
- status=MagickWriteImages(magick_wand,argv[2],MagickTrue);
- if (status == MagickFalse)
- ThrowWandException(magick_wand);
- magick_wand=DestroyMagickWand(magick_wand);
- MagickWandTerminus();
- return(0);
- }
- </samp></pre>
- <p>Here is another program that shows one way to get and set image pixels with the MagickWand API, <a href="https://imagemagick.org/source/contrast.c">contrast.c</a>. It reads an image, applies sigmoidal non-linearity contrast control, and writes the result to disk.</p>
- <pre class="pre-scrollable bg-light text-dark mx-4"><samp>#include <stdio.h>
- #include <stdlib.h>
- #include <math.h>
- #include <MagickWand/MagickWand.h>
- int main(int argc,char **argv)
- {
- #define SigmoidalContrast(x) \
- (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
- #define ThrowWandException(wand) \
- { \
- char \
- *description; \
- \
- ExceptionType \
- severity; \
- \
- description=MagickGetException(wand,&severity); \
- (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
- description=(char *) MagickRelinquishMemory(description); \
- exit(-1); \
- }
- long
- y;
- MagickBooleanType
- status;
- MagickWand
- *contrast_wand,
- *image_wand;
- PixelInfo
- pixel;
- PixelIterator
- *contrast_iterator,
- *iterator;
- PixelWand
- **contrast_pixels,
- **pixels;
- register long
- x;
- unsigned long
- width;
- if (argc != 3)
- {
- (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
- exit(0);
- }
- /*
- Read an image.
- */
- MagickWandGenesis();
- image_wand=NewMagickWand();
- status=MagickReadImage(image_wand,argv[1]);
- if (status == MagickFalse)
- ThrowWandException(image_wand);
- contrast_wand=CloneMagickWand(image_wand);
- /*
- Sigmoidal non-linearity contrast control.
- */
- iterator=NewPixelIterator(image_wand);
- contrast_iterator=NewPixelIterator(contrast_wand);
- if ((iterator == (PixelIterator *) NULL) ||
- (contrast_iterator == (PixelIterator *) NULL))
- ThrowWandException(image_wand);
- for (y=0; y < (long) MagickGetImageHeight(image_wand); y++)
- {
- pixels=PixelGetNextIteratorRow(iterator,&width);
- contrast_pixels=PixelGetNextIteratorRow(contrast_iterator,&width);
- if ((pixels == (PixelWand **) NULL) ||
- (contrast_pixels == (PixelWand **) NULL))
- break;
- for (x=0; x < (long) width; x++)
- {
- PixelGetMagickColor(pixels[x],&pixel);
- pixel.red=SigmoidalContrast(pixel.red);
- pixel.green=SigmoidalContrast(pixel.green);
- pixel.blue=SigmoidalContrast(pixel.blue);
- pixel.index=SigmoidalContrast(pixel.index);
- PixelSetPixelColor(contrast_pixels[x],&pixel);
- }
- (void) PixelSyncIterator(contrast_iterator);
- }
- if (y < (long) MagickGetImageHeight(image_wand))
- ThrowWandException(image_wand);
- contrast_iterator=DestroyPixelIterator(contrast_iterator);
- iterator=DestroyPixelIterator(iterator);
- image_wand=DestroyMagickWand(image_wand);
- /*
- Write the image then destroy it.
- */
- status=MagickWriteImages(contrast_wand,argv[2],MagickTrue);
- if (status == MagickFalse)
- ThrowWandException(image_wand);
- contrast_wand=DestroyMagickWand(contrast_wand);
- MagickWandTerminus();
- return(0);
- }
- </samp></pre>
- <p><a class="anchor" id="wand-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="https://imagemagick.org/source/wand/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>
- <pre class="pre-scrollable bg-light text-dark mx-4"><samp>#include <stdio.h>
- #include <stdio.h>
- #include <stdlib.h>
- #include <math.h>
- #include <MagickWand/MagickWand.h>
- static MagickBooleanType SigmoidalContrast(WandView *contrast_view,
- const ssize_t y,const int thread_id,void *context)
- {
- #define SigmoidalContrast(x) \
- (QuantumRange*(1.0/(1+exp(10.0*(0.5-QuantumScale*x)))-0.0066928509)*1.0092503)
- PixelInfo
- pixel;
- PixelWand
- **pixels;
- RectangleInfo
- extent;
- register ssize_t
- x;
- extent=GetWandViewExtent(contrast_view);
- pixels=GetWandViewPixels(contrast_view);
- for (x=0; x < (ssize_t) extent.width; x++)
- {
- PixelGetMagickColor(pixels[x],&pixel);
- pixel.red=SigmoidalContrast(pixel.red);
- pixel.green=SigmoidalContrast(pixel.green);
- pixel.blue=SigmoidalContrast(pixel.blue);
- pixel.index=SigmoidalContrast(pixel.index);
- PixelSetPixelColor(pixels[x],&pixel);
- }
- return(MagickTrue);
- }
- int main(int argc,char **argv)
- {
- #define ThrowWandException(wand) \
- { \
- char \
- *description; \
- \
- ExceptionType \
- severity; \
- \
- description=MagickGetException(wand,&severity); \
- (void) fprintf(stderr,"%s %s %lu %s\n",GetMagickModule(),description); \
- description=(char *) MagickRelinquishMemory(description); \
- exit(-1); \
- }
- MagickBooleanType
- status;
- MagickWand
- *contrast_wand;
- PixelInfo
- pixel;
- WandView
- *contrast_view;
- if (argc != 3)
- {
- (void) fprintf(stdout,"Usage: %s image sigmoidal-image\n",argv[0]);
- exit(0);
- }
- /*
- Read an image.
- */
- MagickWandGenesis();
- contrast_wand=NewMagickWand();
- status=MagickReadImage(contrast_wand,argv[1]);
- if (status == MagickFalse)
- ThrowWandException(contrast_wand);
- /*
- Sigmoidal non-linearity contrast control.
- */
- contrast_view=NewWandView(contrast_wand);
- if (contrast_view == (WandView *) NULL)
- ThrowWandException(contrast_wand);
- status=UpdateWandViewIterator(contrast_view,SigmoidalContrast,(void *) NULL);
- if (status == MagickFalse)
- ThrowWandException(contrast_wand);
- contrast_view=DestroyWandView(contrast_view);
- /*
- Write the image then destroy it.
- */
- status=MagickWriteImages(contrast_wand,argv[2],MagickTrue);
- if (status == MagickFalse)
- ThrowWandException(contrast_wand);
- contrast_wand=DestroyMagickWand(contrast_wand);
- MagickWandTerminus();
- return(0);
- }
- </samp></pre>
- <p><samp>MagickWandTerminus()</samp> is a function in the ImageMagick library that is used to clean up and release resources when shutting down an application that uses ImageMagick. This function should be called in the primary thread of the application's process during the shutdown process. It's crucial that this function is invoked only after any threads that are using ImageMagick functions have terminated.</p>
- <p>ImageMagick might internally use threads via OpenMP (a method for parallel programming). As a result, it's important to ensure that any function calls into ImageMagick have completed before calling <samp>MagickWandTerminus()</samp>. This prevents issues with OpenMP worker threads accessing resources that are destroyed by this termination function.</p>
- <p>If OpenMP is being used (starting from version 5.0), the OpenMP implementation itself handles starting and stopping worker threads and allocating and freeing resources using its own methods. This means that after calling <samp>MagickWandTerminus()</samp>, some OpenMP resources and worker threads might still remain allocated. To address this, the function <samp>omp_pause_resource_all(omp_pause_hard)</samp> can be invoked. This function, introduced in OpenMP version 5.0, ensures that any resources allocated by OpenMP (such as threads and thread-specific memory) are freed. It's recommended to call this function after <samp>MagickWandTerminus()</samp> has completed its execution.</p>
- <p><a href="../MagickWand/index.html">MagickWand Examples in C</a> illustrates how to use the ImageMagick MagickWand API. Each example is presented as a C function, complete with headers, so that it can be copied to a file and then included in your own C project.</p>
- </div>
- </div>
- </main><!-- /.container -->
- <footer class="magick-footer">
- <div class="container-fluid">
- <a href="../www/security-policy.html">Security</a> •
- <a href="../www/news.html">News</a>
-
- <a href="magick-wand.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico"/></a>
-
- <a href="../www/links.html">Related</a> •
- <a href="../www/sitemap.html">Sitemap</a>
- <br/>
- <a href="../www/support.html">Sponsor</a> •
- <a href="../www/cite.html">Cite</a> •
- <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> •
- <a href="../www/https://imagemagick.org/script/contact.php">Contact Us</a>
- <br/>
- <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
- <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
- <br/>
- <small>Copyright © 1999 ImageMagick Studio LLC</small>
- </div>
- </footer>
- <!-- Javascript assets -->
- <script src="assets/magick.js" ></script>
- </body>
- </html>
|