blob: 2490a53df94c5fdda5af963a8f737d3bb4b51807 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
7 <title>ImageMagick: MagickCore, C API for ImageMagick: Convert to and from Cipher Pixels</title/>
cristy3ed852e2009-09-05 21:47:34 +00008 <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"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <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"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, convert, to, from, cipher, pixels, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +000016 <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"/>
cristy16af1cb2009-12-11 21:38:29 +000022 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000024 <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"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000030</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +000048<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000049
cristy3ed852e2009-09-05 21:47:34 +000050<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000051 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000052</div>
cristy3eaa0ef2010-03-06 20:35:26 +000053<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristybb503372010-05-27 20:51:26 +000055 <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>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
cristy3eaa0ef2010-03-06 20:35:26 +000094<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000095<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristybb503372010-05-27 20:51:26 +0000107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000127
128<div class="sponsbox">
129<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000130 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy2c839602010-04-03 02:32:08 +0000143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000149</div>
150<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000151 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyc49f7992009-09-22 22:48:40 +0000152</div>
cristy3ed852e2009-09-05 21:47:34 +0000153</div>
154</div>
cristyce69bb02010-07-27 19:49:46 +0000155</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000156
cristyce69bb02010-07-27 19:49:46 +0000157<div class="eastbar">
158 <script type="text/javascript">
159 <!--
160 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000161 google_ad_slot = "0574824969";
162 google_ad_width = 160;
163 google_ad_height = 600;
164 //-->
165 </script>
166 <script type="text/javascript"
167 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
168 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000169</div>
170
171<div class="main">
172
cristy3ed852e2009-09-05 21:47:34 +0000173<p class="navigation-index">[<a href="#AcquireAESInfo">AcquireAESInfo</a> &bull; <a href="#DestroyAESInfo">DestroyAESInfo</a> &bull; <a href="#EncipherAESBlock">EncipherAESBlock</a> &bull; <a href="#PasskeyDecipherImage">PasskeyDecipherImage</a> &bull; <a href="#PasskeyEncipherImage">PasskeyEncipherImage</a> &bull; <a href="#SetAESKey">SetAESKey</a> &bull; <a href="#PasskeyDecipherImage">PasskeyDecipherImage</a> &bull; <a href="#PasskeyEncipherImage">PasskeyEncipherImage</a>]</p>
174
175<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
176_8c.html" target="source" name="AcquireAESInfo">AcquireAESInfo</a></h2>
177<div class="doc-section">
178
179<p>AcquireAESInfo() allocate the AESInfo structure.</p></ol>
180
181<p>The format of the AcquireAESInfo method is:</p>
182
183<pre class="code">
184 AESInfo *AcquireAESInfo(void)
185</pre>
186
187 </div>
188<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
189_8c.html" target="source" name="DestroyAESInfo">DestroyAESInfo</a></h2>
190<div class="doc-section">
191
192<p>DestroyAESInfo() zeros memory associated with the AESInfo structure.</p></ol>
193
194<p>The format of the DestroyAESInfo method is:</p>
195
196<pre class="code">
197 AESInfo *DestroyAESInfo(AESInfo *aes_info)
198</pre>
199
200<p>A description of each parameter follows:</p></ol>
201
202<h5>aes_info</h5>
203<ol><p>the cipher context.</p></ol>
204
205 </div>
206<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
207_8c.html" target="source" name="EncipherAESBlock">EncipherAESBlock</a></h2>
208<div class="doc-section">
209
210<p>EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.</p></ol>
211
212<p>The format of the EncipherAESBlock method is:</p>
213
214<pre class="code">
215 void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
216 unsigned char *ciphertext)
217</pre>
218
219<p>A description of each parameter follows:</p></ol>
220
221<h5>aes_info</h5>
222<ol><p>the cipher context.</p></ol>
223
224<h5>plaintext</h5>
225<ol><p>the plain text.</p></ol>
226
227<h5>ciphertext</h5>
228<ol><p>the cipher text.</p></ol>
229
230 </div>
231<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
232_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
233<div class="doc-section">
234
235<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
236
237<p>The format of the PasskeyDecipherImage method is:</p>
238
239<pre class="code">
240 MagickBooleanType PasskeyDecipherImage(Image *image,
241 const StringInfo *passkey,ExceptionInfo *exception)
242 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
243 ExceptionInfo *exception)
244</pre>
245
246<p>A description of each parameter follows:</p></ol>
247
248<h5>image</h5>
249<ol><p>the image.</p></ol>
250
251<h5>passphrase</h5>
252<ol><p>decipher cipher pixels with this passphrase.</p></ol>
253
254<h5>passkey</h5>
255<ol><p>decrypt cipher pixels with this passkey.</p></ol>
256
257<h5>exception</h5>
258<ol><p>return any errors or warnings in this structure.</p></ol>
259
260 </div>
261<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
262_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
263<div class="doc-section">
264
265<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
266
267<p>The format of the PasskeyEncipherImage method is:</p>
268
269<pre class="code">
270 MagickBooleanType PasskeyEncipherImage(Image *image,
271 const StringInfo *passkey,ExceptionInfo *exception)
272 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
273 ExceptionInfo *exception)
274</pre>
275
276<p>A description of each parameter follows:</p></ol>
277
278<h5>image</h5>
279<ol><p>the image.</p></ol>
280
281<h5>passphrase</h5>
282<ol><p>encipher pixels with this passphrase.</p></ol>
283
284<h5>passkey</h5>
285<ol><p>decrypt cipher pixels with this passkey.</p></ol>
286
287<h5>exception</h5>
288<ol><p>return any errors or warnings in this structure.</p></ol>
289
290 </div>
291<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
292_8c.html" target="source" name="SetAESKey">SetAESKey</a></h2>
293<div class="doc-section">
294
295<p>SetAESKey() sets the key for the AES cipher. The key length is specified in bits. Valid values are 128, 192, or 256 requiring a key buffer length in bytes of 16, 24, and 32 respectively.</p></ol>
296
297<p>The format of the SetAESKey method is:</p>
298
299<pre class="code">
300 SetAESKey(AESInfo *aes_info,const StringInfo *key)
301</pre>
302
303<p>A description of each parameter follows:</p></ol>
304
305<h5>aes_info</h5>
306<ol><p>the cipher context.</p></ol>
307
308<h5>key</h5>
309<ol><p>the key.</p></ol>
310
311 </div>
312<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
313_8c.html" target="source" name="PasskeyDecipherImage">PasskeyDecipherImage</a></h2>
314<div class="doc-section">
315
316<p>PasskeyDecipherImage() converts cipher pixels to plain pixels.</p></ol>
317
318<p>The format of the PasskeyDecipherImage method is:</p>
319
320<pre class="code">
321 MagickBooleanType PasskeyDecipherImage(Image *image,
322 const StringInfo *passkey,ExceptionInfo *exception)
323 MagickBooleanType DecipherImage(Image *image,const char *passphrase,
324 ExceptionInfo *exception)
325</pre>
326
327<p>A description of each parameter follows:</p></ol>
328
329<h5>image</h5>
330<ol><p>the image.</p></ol>
331
332<h5>passphrase</h5>
333<ol><p>decipher cipher pixels with this passphrase.</p></ol>
334
335<h5>passkey</h5>
336<ol><p>decrypt cipher pixels with this passkey.</p></ol>
337
338<h5>exception</h5>
339<ol><p>return any errors or warnings in this structure.</p></ol>
340
341 </div>
342<h2><a href="http://www.imagemagick.org/api/MagickCore/cipher
343_8c.html" target="source" name="PasskeyEncipherImage">PasskeyEncipherImage</a></h2>
344<div class="doc-section">
345
346<p>PasskeyEncipherImage() converts pixels to cipher-pixels.</p></ol>
347
348<p>The format of the PasskeyEncipherImage method is:</p>
349
350<pre class="code">
351 MagickBooleanType PasskeyEncipherImage(Image *image,
352 const StringInfo *passkey,ExceptionInfo *exception)
353 MagickBooleanType EncipherImage(Image *image,const char *passphrase,
354 ExceptionInfo *exception)
355</pre>
356
357<p>A description of each parameter follows:</p></ol>
358
359<h5>passphrase</h5>
360<ol><p>decipher cipher pixels with this passphrase.</p></ol>
361
362<h5>passkey</h5>
363<ol><p>decrypt cipher pixels with this passkey.</p></ol>
364
365<h5>exception</h5>
366<ol><p>return any errors or warnings in this structure.</p></ol>
367
368 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000369
370</div>
371
372<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000373 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000374 <span id="linkbar-center">
375 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000376 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000377 </span>
378 <span id="linkbar-east">&nbsp;</span>
379 </div>
380 <div class="footer">
381 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
382 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
383 </div>
384 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000385 <script type="text/javascript">
386 var _gaq = _gaq || [];
387 _gaq.push(['_setAccount', 'UA-17690367-1']);
388 _gaq.push(['_trackPageview']);
389
390 (function() {
391 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
392 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
393 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
394 })();
395 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000396</body>
397</html>