granicus.if.org Git - imagemagick/blob - www/api/profile.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   7   <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Image Profiles</title/>
   8   <meta http-equiv="Content-Language" content="en-US"/>
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <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."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  14   <meta name="Generator" content="PHP"/>
  15   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, dealing, with, image, profiles, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  16   <meta name="Rating" content="GENERAL"/>
  17   <meta name="Robots" content="INDEX, FOLLOW"/>
  18   <meta name="Generator" content="ImageMagick Studio LLC"/>
  19   <meta name="Author" content="ImageMagick Studio LLC"/>
  20   <meta name="Revisit-after" content="2 DAYS"/>
  21   <meta name="Resource-type" content="document"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
  25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../../index.html">\r
  35   <img src="../../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../../index.html">\r
  44   <img src="../../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  62 </div>
  63 <div class="sub">
  64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 146 </div>
 147 </div>
 148 </div>
 149 </div>\r
 150 \r
 151 <div class="eastbar">\r
 152   <script type="text/javascript">\r
 153   <!--\r
 154     google_ad_client = "pub-3129977114552745";\r
 155     google_ad_slot = "0574824969";\r
 156     google_ad_width = 160;\r
 157     google_ad_height = 600;\r
 158   //-->\r
 159   </script>\r
 160   <script type="text/javascript"\r
 161     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 162   </script>\r
 163 </div>\r
 164 \r
 165 <div class="main">\r
 166 \r
 167 <p class="navigation-index">[<a href="#CloneImageProfiles">CloneImageProfiles</a> &bull; <a href="#DeleteImageProfile">DeleteImageProfile</a> &bull; <a href="#DestroyImageProfiles">DestroyImageProfiles</a> &bull; <a href="#GetImageProfile">GetImageProfile</a> &bull; <a href="#GetNextImageProfile">GetNextImageProfile</a> &bull; <a href="#ProfileImage">ProfileImage</a> &bull; <a href="#RemoveImageProfile">RemoveImageProfile</a> &bull; <a href="#ResetImageProfileIterator">ResetImageProfileIterator</a> &bull; <a href="#SetImageProfile">SetImageProfile</a> &bull; <a href="#SyncImageProfiles">SyncImageProfiles</a>]</p>
 168
 169 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 170 _8c.html" target="source" name="CloneImageProfiles">CloneImageProfiles</a></h2>
 171 <div class="doc-section">
 172
 173 <p>CloneImageProfiles() clones one or more image profiles.</p></ol>
 174
 175 <p>The format of the CloneImageProfiles method is:</p>
 176
 177 <pre class="code">
 178   MagickBooleanType CloneImageProfiles(Image *image,
 179     const Image *clone_image)
 180 </pre>
 181
 182 <p>A description of each parameter follows:</p></ol>
 183
 184 <h5>image</h5>
 185 <ol><p>the image.</p></ol>
 186
 187 <h5>clone_image</h5>
 188 <ol><p>the clone image.</p></ol>
 189
 190  </div>
 191 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 192 _8c.html" target="source" name="DeleteImageProfile">DeleteImageProfile</a></h2>
 193 <div class="doc-section">
 194
 195 <p>DeleteImageProfile() deletes a profile from the image by its name.</p></ol>
 196
 197 <p>The format of the DeleteImageProfile method is:</p>
 198
 199 <pre class="code">
 200   MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
 201 </pre>
 202
 203 <p>A description of each parameter follows:</p></ol>
 204
 205 <h5>image</h5>
 206 <ol><p>the image.</p></ol>
 207
 208 <h5>name</h5>
 209 <ol><p>the profile name.</p></ol>
 210
 211  </div>
 212 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 213 _8c.html" target="source" name="DestroyImageProfiles">DestroyImageProfiles</a></h2>
 214 <div class="doc-section">
 215
 216 <p>DestroyImageProfiles() releases memory associated with an image profile map.</p></ol>
 217
 218 <p>The format of the DestroyProfiles method is:</p>
 219
 220 <pre class="code">
 221   void DestroyImageProfiles(Image *image)
 222 </pre>
 223
 224 <p>A description of each parameter follows:</p></ol>
 225
 226 <h5>image</h5>
 227 <ol><p>the image.</p></ol>
 228
 229  </div>
 230 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 231 _8c.html" target="source" name="GetImageProfile">GetImageProfile</a></h2>
 232 <div class="doc-section">
 233
 234 <p>GetImageProfile() gets a profile associated with an image by name.</p></ol>
 235
 236 <p>The format of the GetImageProfile method is:</p>
 237
 238 <pre class="code">
 239   const StringInfo *GetImageProfile(const Image *image,const char *name)
 240 </pre>
 241
 242 <p>A description of each parameter follows:</p></ol>
 243
 244 <h5>image</h5>
 245 <ol><p>the image.</p></ol>
 246
 247 <h5>name</h5>
 248 <ol><p>the profile name.</p></ol>
 249
 250  </div>
 251 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 252 _8c.html" target="source" name="GetNextImageProfile">GetNextImageProfile</a></h2>
 253 <div class="doc-section">
 254
 255 <p>GetNextImageProfile() gets the next profile name for an image.</p></ol>
 256
 257 <p>The format of the GetNextImageProfile method is:</p>
 258
 259 <pre class="code">
 260   char *GetNextImageProfile(const Image *image)
 261 </pre>
 262
 263 <p>A description of each parameter follows:</p></ol>
 264
 265 <h5>hash_info</h5>
 266 <ol><p>the hash info.</p></ol>
 267
 268  </div>
 269 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 270 _8c.html" target="source" name="ProfileImage">ProfileImage</a></h2>
 271 <div class="doc-section">
 272
 273 <p>ProfileImage() associates, applies, or removes an ICM, IPTC, or generic profile with / to / from an image.  If the profile is NULL, it is removed from the image otherwise added or applied.  Use a name of '*' and a profile of NULL to remove all profiles from the image.</p></ol>
 274
 275 <p>ICC and ICM profiles are handled as follows: If the image does not have an associated color profile, the one you provide is associated with the image and the image pixels are not transformed.  Otherwise, the colorspace transform defined by the existing and new profile are applied to the image pixels and the new profile is associated with the image.</p></ol>
 276
 277 <p>The format of the ProfileImage method is:</p>
 278
 279 <pre class="code">
 280   MagickBooleanType ProfileImage(Image *image,const char *name,
 281     const void *datum,const size_t length,const MagickBooleanType clone)
 282 </pre>
 283
 284 <p>A description of each parameter follows:</p></ol>
 285
 286 <h5>image</h5>
 287 <ol><p>the image.</p></ol>
 288
 289 <h5>name</h5>
 290 <ol><p>Name of profile to add or remove: ICC, IPTC, or generic profile.</p></ol>
 291
 292 <h5>datum</h5>
 293 <ol><p>the profile data.</p></ol>
 294
 295 <h5>length</h5>
 296 <ol><p>the length of the profile.</p></ol>
 297
 298 <h5>clone</h5>
 299 <ol><p>should be MagickFalse.</p></ol>
 300
 301  </div>
 302 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 303 _8c.html" target="source" name="RemoveImageProfile">RemoveImageProfile</a></h2>
 304 <div class="doc-section">
 305
 306 <p>RemoveImageProfile() removes a named profile from the image and returns its value.</p></ol>
 307
 308 <p>The format of the RemoveImageProfile method is:</p>
 309
 310 <pre class="code">
 311   void *RemoveImageProfile(Image *image,const char *name)
 312 </pre>
 313
 314 <p>A description of each parameter follows:</p></ol>
 315
 316 <h5>image</h5>
 317 <ol><p>the image.</p></ol>
 318
 319 <h5>name</h5>
 320 <ol><p>the profile name.</p></ol>
 321
 322  </div>
 323 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 324 _8c.html" target="source" name="ResetImageProfileIterator">ResetImageProfileIterator</a></h2>
 325 <div class="doc-section">
 326
 327 <p>ResetImageProfileIterator() resets the image profile iterator.  Use it in conjunction with GetNextImageProfile() to iterate over all the profiles associated with an image.</p></ol>
 328
 329 <p>The format of the ResetImageProfileIterator method is:</p>
 330
 331 <pre class="code">
 332   ResetImageProfileIterator(Image *image)
 333 </pre>
 334
 335 <p>A description of each parameter follows:</p></ol>
 336
 337 <h5>image</h5>
 338 <ol><p>the image.</p></ol>
 339
 340  </div>
 341 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 342 _8c.html" target="source" name="SetImageProfile">SetImageProfile</a></h2>
 343 <div class="doc-section">
 344
 345 <p>SetImageProfile() adds a named profile to the image.  If a profile with the same name already exists, it is replaced.  This method differs from the ProfileImage() method in that it does not apply CMS color profiles.</p></ol>
 346
 347 <p>The format of the SetImageProfile method is:</p>
 348
 349 <pre class="code">
 350   MagickBooleanType SetImageProfile(Image *image,const char *name,
 351     const StringInfo *profile)
 352 </pre>
 353
 354 <p>A description of each parameter follows:</p></ol>
 355
 356 <h5>image</h5>
 357 <ol><p>the image.</p></ol>
 358
 359 <h5>name</h5>
 360 <ol><p>the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).</p></ol>
 361
 362 <h5>profile</h5>
 363 <ol><p>A StringInfo structure that contains the named profile.</p></ol>
 364
 365  </div>
 366 <h2><a href="http://www.imagemagick.org/api/MagickCore/profile
 367 _8c.html" target="source" name="SyncImageProfiles">SyncImageProfiles</a></h2>
 368 <div class="doc-section">
 369
 370 <p>SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.</p></ol>
 371
 372 <p>The format of the SyncImageProfiles method is:</p>
 373
 374 <pre class="code">
 375   MagickBooleanType SyncImageProfiles(Image *image)
 376 </pre>
 377
 378 <p>A description of each parameter follows:</p></ol>
 379
 380 <h5>image</h5>
 381 <ol><p>the image.</p></ol>
 382
 383  </div>
 384 \r
 385 </div>\r
 386 \r
 387 <div id="linkbar">\r
 388     <span id="linkbar-west">&nbsp;</span>\r
 389     <span id="linkbar-center">\r
 390       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 391       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 392     </span>\r
 393     <span id="linkbar-east">&nbsp;</span>\r
 394   </div>\r
 395   <div class="footer">\r
 396     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 397     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 398   </div>\r
 399   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 400   <script type="text/javascript">\r
 401     var _gaq = _gaq || [];\r
 402     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 403     _gaq.push(['_trackPageview']);\r
 404 \r
 405     (function() {\r
 406       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 407       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 408       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 409     })();\r
 410   </script>\r
 411 </body>\r
 412 </html>\r