2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % DDDD EEEEE PPPP RRRR EEEEE CCCC AAA TTTTT EEEEE %
7 % D D E P P R R E C A A T E %
8 % D D EEE PPPPP RRRR EEE C AAAAA T EEE %
9 % D D E P R R E C A A T E %
10 % DDDD EEEEE P R R EEEEE CCCC A A T EEEEE %
13 % MagickCore Deprecated Methods %
20 % Copyright 1999-2011 ImageMagick Studio LLC, a non-profit organization %
21 % dedicated to making software imaging solutions freely available. %
23 % You may not use this file except in compliance with the License. You may %
24 % obtain a copy of the License at %
26 % http://www.imagemagick.org/script/license.php %
28 % Unless required by applicable law or agreed to in writing, software %
29 % distributed under the License is distributed on an "AS IS" BASIS, %
30 % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
31 % See the License for the specific language governing permissions and %
32 % limitations under the License. %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
43 #include "magick/studio.h"
44 #include "magick/property.h"
45 #include "magick/blob.h"
46 #include "magick/blob-private.h"
47 #include "magick/cache.h"
48 #include "magick/cache-view.h"
49 #include "magick/client.h"
50 #include "magick/color.h"
51 #include "magick/color-private.h"
52 #include "magick/colormap.h"
53 #include "magick/colormap-private.h"
54 #include "magick/colorspace.h"
55 #include "magick/composite.h"
56 #include "magick/composite-private.h"
57 #include "magick/constitute.h"
58 #include "magick/deprecate.h"
59 #include "magick/draw.h"
60 #include "magick/draw-private.h"
61 #include "magick/effect.h"
62 #include "magick/enhance.h"
63 #include "magick/exception.h"
64 #include "magick/exception-private.h"
65 #include "magick/fx.h"
66 #include "magick/geometry.h"
67 #include "magick/identify.h"
68 #include "magick/image.h"
69 #include "magick/image-private.h"
70 #include "magick/list.h"
71 #include "magick/log.h"
72 #include "magick/memory_.h"
73 #include "magick/magick.h"
74 #include "magick/monitor.h"
75 #include "magick/monitor-private.h"
76 #include "magick/morphology.h"
77 #include "magick/paint.h"
78 #include "magick/pixel.h"
79 #include "magick/pixel-private.h"
80 #include "magick/quantize.h"
81 #include "magick/random_.h"
82 #include "magick/resource_.h"
83 #include "magick/semaphore.h"
84 #include "magick/segment.h"
85 #include "magick/splay-tree.h"
86 #include "magick/statistic.h"
87 #include "magick/string_.h"
88 #include "magick/threshold.h"
89 #include "magick/transform.h"
90 #include "magick/utility.h"
92 #if !defined(MAGICKCORE_EXCLUDE_DEPRECATED)
97 monitor_handler = (MonitorHandler) NULL;
100 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
104 % A c q u i r e C a c h e V i e w I n d e x e s %
108 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
110 % AcquireCacheViewIndexes() returns the indexes associated with the specified
113 % Deprecated, replace with:
115 % GetCacheViewVirtualIndexQueue(cache_view);
117 % The format of the AcquireCacheViewIndexes method is:
119 % const IndexPacket *AcquireCacheViewIndexes(const CacheView *cache_view)
121 % A description of each parameter follows:
123 % o cache_view: the cache view.
126 MagickExport const IndexPacket *AcquireCacheViewIndexes(
127 const CacheView *cache_view)
129 return(GetCacheViewVirtualIndexQueue(cache_view));
133 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
137 % A c q u i r e C a c h e V i e w P i x e l s %
141 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
143 % AcquireCacheViewPixels() gets pixels from the in-memory or disk pixel cache
144 % as defined by the geometry parameters. A pointer to the pixels is returned
145 % if the pixels are transferred, otherwise a NULL is returned.
147 % Deprecated, replace with:
149 % GetCacheViewVirtualPixels(cache_view,x,y,columns,rows,exception);
151 % The format of the AcquireCacheViewPixels method is:
153 % const PixelPacket *AcquireCacheViewPixels(const CacheView *cache_view,
154 % const ssize_t x,const ssize_t y,const size_t columns,
155 % const size_t rows,ExceptionInfo *exception)
157 % A description of each parameter follows:
159 % o cache_view: the cache view.
161 % o x,y,columns,rows: These values define the perimeter of a region of
164 % o exception: return any errors or warnings in this structure.
167 MagickExport const PixelPacket *AcquireCacheViewPixels(
168 const CacheView *cache_view,const ssize_t x,const ssize_t y,
169 const size_t columns,const size_t rows,ExceptionInfo *exception)
171 return(GetCacheViewVirtualPixels(cache_view,x,y,columns,rows,exception));
175 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
179 % A c q u i r e I m a g e P i x e l s %
182 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
184 % AcquireImagePixels() returns an immutable pixel region. If the
185 % region is successfully accessed, a pointer to it is returned, otherwise
186 % NULL is returned. The returned pointer may point to a temporary working
187 % copy of the pixels or it may point to the original pixels in memory.
188 % Performance is maximized if the selected region is part of one row, or one
189 % or more full rows, since there is opportunity to access the pixels in-place
190 % (without a copy) if the image is in RAM, or in a memory-mapped file. The
191 % returned pointer should *never* be deallocated by the user.
193 % Pixels accessed via the returned pointer represent a simple array of type
194 % PixelPacket. If the image type is CMYK or the storage class is PseudoClass,
195 % call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to access
196 % the black color component or to obtain the colormap indexes (of type
197 % IndexPacket) corresponding to the region.
199 % If you plan to modify the pixels, use GetAuthenticPixels() instead.
201 % Note, the AcquireImagePixels() and GetAuthenticPixels() methods are not
202 % thread-safe. In a threaded environment, use GetCacheViewVirtualPixels() or
203 % GetCacheViewAuthenticPixels() instead.
205 % Deprecated, replace with:
207 % GetVirtualPixels(image,x,y,columns,rows,exception);
209 % The format of the AcquireImagePixels() method is:
211 % const PixelPacket *AcquireImagePixels(const Image *image,const ssize_t x,
212 % const ssize_t y,const size_t columns,const size_t rows,
213 % ExceptionInfo *exception)
215 % A description of each parameter follows:
217 % o image: the image.
219 % o x,y,columns,rows: These values define the perimeter of a region of
222 % o exception: return any errors or warnings in this structure.
225 MagickExport const PixelPacket *AcquireImagePixels(const Image *image,
226 const ssize_t x,const ssize_t y,const size_t columns,
227 const size_t rows,ExceptionInfo *exception)
229 return(GetVirtualPixels(image,x,y,columns,rows,exception));
233 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
237 % A c q u i r e I n d e x e s %
241 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
243 % AcquireIndexes() returns the black channel or the colormap indexes
244 % associated with the last call to QueueAuthenticPixels() or
245 % GetVirtualPixels(). NULL is returned if the black channel or colormap
246 % indexes are not available.
248 % Deprecated, replace with:
250 % GetVirtualIndexQueue(image);
252 % The format of the AcquireIndexes() method is:
254 % const IndexPacket *AcquireIndexes(const Image *image)
256 % A description of each parameter follows:
258 % o indexes: AcquireIndexes() returns the indexes associated with the last
259 % call to QueueAuthenticPixels() or GetVirtualPixels().
261 % o image: the image.
264 MagickExport const IndexPacket *AcquireIndexes(const Image *image)
266 return(GetVirtualIndexQueue(image));
270 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
274 % A c q u i r e M e m o r y %
278 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
280 % AcquireMemory() returns a pointer to a block of memory at least size bytes
281 % suitably aligned for any use.
283 % The format of the AcquireMemory method is:
285 % void *AcquireMemory(const size_t size)
287 % A description of each parameter follows:
289 % o size: the size of the memory in bytes to allocate.
292 MagickExport void *AcquireMemory(const size_t size)
298 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
299 allocation=malloc(size);
304 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
308 % A c q u i r e O n e C a c h e V i e w P i x e l %
312 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
314 % AcquireOneCacheViewPixel() returns a single pixel at the specified (x,y)
315 % location. The image background color is returned if an error occurs. If
316 % you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.
318 % Deprecated, replace with:
320 % GetOneCacheViewVirtualPixel(cache_view,x,y,pixel,exception);
322 % The format of the AcquireOneCacheViewPixel method is:
324 % MagickBooleanType AcquireOneCacheViewPixel(const CacheView *cache_view,
325 % const ssize_t x,const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
327 % A description of each parameter follows:
329 % o cache_view: the cache view.
331 % o x,y: These values define the offset of the pixel.
333 % o pixel: return a pixel at the specified (x,y) location.
335 % o exception: return any errors or warnings in this structure.
338 MagickExport MagickBooleanType AcquireOneCacheViewPixel(
339 const CacheView *cache_view,const ssize_t x,const ssize_t y,PixelPacket *pixel,
340 ExceptionInfo *exception)
342 return(GetOneCacheViewVirtualPixel(cache_view,x,y,pixel,exception));
346 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
350 % A c q u i r e O n e C a c h e V i e w V i r t u a l P i x e l %
354 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
356 % AcquireOneCacheViewVirtualPixel() returns a single pixel at the specified
357 % (x,y) location. The image background color is returned if an error occurs.
358 % If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.
360 % Deprecated, replace with:
362 % GetOneCacheViewVirtualMethodPixel(cache_view,virtual_pixel_method,
363 % x,y,pixel,exception);
365 % The format of the AcquireOneCacheViewPixel method is:
367 % MagickBooleanType AcquireOneCacheViewVirtualPixel(
368 % const CacheView *cache_view,
369 % const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
370 % const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
372 % A description of each parameter follows:
374 % o cache_view: the cache view.
376 % o virtual_pixel_method: the virtual pixel method.
378 % o x,y: These values define the offset of the pixel.
380 % o pixel: return a pixel at the specified (x,y) location.
382 % o exception: return any errors or warnings in this structure.
385 MagickExport MagickBooleanType AcquireOneCacheViewVirtualPixel(
386 const CacheView *cache_view,const VirtualPixelMethod virtual_pixel_method,
387 const ssize_t x,const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
392 status=GetOneCacheViewVirtualMethodPixel(cache_view,virtual_pixel_method,
393 x,y,pixel,exception);
398 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
402 % A c q u i r e O n e M a g i c k P i x e l %
406 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
408 % AcquireOneMagickPixel() returns a single pixel at the specified (x,y)
409 % location. The image background color is returned if an error occurs. If
410 % you plan to modify the pixel, use GetOnePixel() instead.
412 % Deprecated, replace with:
414 % MagickPixelPacket pixel;
415 % GetOneVirtualMagickPixel(image,x,y,&pixel,exception);
417 % The format of the AcquireOneMagickPixel() method is:
419 % MagickPixelPacket AcquireOneMagickPixel(const Image image,const ssize_t x,
420 % const ssize_t y,ExceptionInfo exception)
422 % A description of each parameter follows:
424 % o image: the image.
426 % o x,y: These values define the location of the pixel to return.
428 % o exception: return any errors or warnings in this structure.
431 MagickExport MagickPixelPacket AcquireOneMagickPixel(const Image *image,
432 const ssize_t x,const ssize_t y,ExceptionInfo *exception)
437 (void) GetOneVirtualMagickPixel(image,x,y,&pixel,exception);
442 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
446 % A c q u i r e O n e P i x e l %
450 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
452 % AcquireOnePixel() returns a single pixel at the specified (x,y) location.
453 % The image background color is returned if an error occurs. If you plan to
454 % modify the pixel, use GetOnePixel() instead.
456 % Deprecated, replace with:
459 % GetOneVirtualPixel(image,x,y,&pixel,exception);
461 % The format of the AcquireOnePixel() method is:
463 % PixelPacket AcquireOnePixel(const Image image,const ssize_t x,
464 % const ssize_t y,ExceptionInfo exception)
466 % A description of each parameter follows:
468 % o image: the image.
470 % o x,y: These values define the location of the pixel to return.
472 % o exception: return any errors or warnings in this structure.
475 MagickExport PixelPacket AcquireOnePixel(const Image *image,const ssize_t x,
476 const ssize_t y,ExceptionInfo *exception)
481 (void) GetOneVirtualPixel(image,x,y,&pixel,exception);
486 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
490 % A c q u i r e O n e V i r t u a l P i x e l %
494 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
496 % AcquireOneVirtualPixel() returns a single pixel at the specified (x,y)
497 % location as defined by specified pixel method. The image background color
498 % is returned if an error occurs. If you plan to modify the pixel, use
499 % GetOnePixel() instead.
501 % Deprecated, replace with:
504 % GetOneVirtualMethodPixel(image,virtual_pixel_method,x,y,&pixel,exception);
506 % The format of the AcquireOneVirtualPixel() method is:
508 % PixelPacket AcquireOneVirtualPixel(const Image image,
509 % const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
510 % const ssize_t y,ExceptionInfo exception)
512 % A description of each parameter follows:
514 % o virtual_pixel_method: the virtual pixel method.
516 % o image: the image.
518 % o x,y: These values define the location of the pixel to return.
520 % o exception: return any errors or warnings in this structure.
523 MagickExport PixelPacket AcquireOneVirtualPixel(const Image *image,
524 const VirtualPixelMethod virtual_pixel_method,const ssize_t x,const ssize_t y,
525 ExceptionInfo *exception)
530 (void) GetOneVirtualMethodPixel(image,virtual_pixel_method,x,y,&pixel,
536 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
540 % A c q u i r e P i x e l s %
544 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
546 % AcquirePixels() returns the pixels associated with the last call to
547 % QueueAuthenticPixels() or GetVirtualPixels().
549 % Deprecated, replace with:
551 % GetVirtualPixelQueue(image);
553 % The format of the AcquirePixels() method is:
555 % const PixelPacket *AcquirePixels(const Image image)
557 % A description of each parameter follows:
559 % o image: the image.
562 MagickExport const PixelPacket *AcquirePixels(const Image *image)
564 return(GetVirtualPixelQueue(image));
568 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
572 % A f f i n i t y I m a g e %
576 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
578 % AffinityImage() replaces the colors of an image with the closest color from
581 % Deprecated, replace with:
583 % RemapImage(quantize_info,image,affinity_image);
585 % The format of the AffinityImage method is:
587 % MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
588 % Image *image,const Image *affinity_image)
590 % A description of each parameter follows:
592 % o quantize_info: Specifies a pointer to an QuantizeInfo structure.
594 % o image: the image.
596 % o affinity_image: the reference image.
599 MagickExport MagickBooleanType AffinityImage(const QuantizeInfo *quantize_info,
600 Image *image,const Image *affinity_image)
602 return(RemapImage(quantize_info,image,affinity_image));
606 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
610 % A f f i n i t y I m a g e s %
614 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
616 % AffinityImages() replaces the colors of a sequence of images with the
617 % closest color from a reference image.
619 % Deprecated, replace with:
621 % RemapImages(quantize_info,images,affinity_image);
623 % The format of the AffinityImage method is:
625 % MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
626 % Image *images,Image *affinity_image)
628 % A description of each parameter follows:
630 % o quantize_info: Specifies a pointer to an QuantizeInfo structure.
632 % o images: the image sequence.
634 % o affinity_image: the reference image.
637 MagickExport MagickBooleanType AffinityImages(const QuantizeInfo *quantize_info,
638 Image *images,const Image *affinity_image)
640 return(RemapImages(quantize_info,images,affinity_image));
644 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
648 % A l l o c a t e I m a g e %
652 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
654 % AllocateImage() returns a pointer to an image structure initialized to
657 % Deprecated, replace with:
659 % AcquireImage(image_info);
661 % The format of the AllocateImage method is:
663 % Image *AllocateImage(const ImageInfo *image_info)
665 % A description of each parameter follows:
667 % o image_info: Many of the image default values are set from this
668 % structure. For example, filename, compression, depth, background color,
672 MagickExport Image *AllocateImage(const ImageInfo *image_info)
674 return(AcquireImage(image_info));
678 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
682 % A l l o c a t e I m a g e C o l o r m a p %
686 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
688 % AllocateImageColormap() allocates an image colormap and initializes
689 % it to a linear gray colorspace. If the image already has a colormap,
690 % it is replaced. AllocateImageColormap() returns MagickTrue if successful,
691 % otherwise MagickFalse if there is not enough memory.
693 % Deprecated, replace with:
695 % AcquireImageColormap(image,colors);
697 % The format of the AllocateImageColormap method is:
699 % MagickBooleanType AllocateImageColormap(Image *image,
700 % const size_t colors)
702 % A description of each parameter follows:
704 % o image: the image.
706 % o colors: the number of colors in the image colormap.
709 MagickExport MagickBooleanType AllocateImageColormap(Image *image,
712 return(AcquireImageColormap(image,colors));
716 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
720 % A l l o c a t e N e x t I m a g e %
724 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
726 % AllocateNextImage() initializes the next image in a sequence to
727 % default values. The next member of image points to the newly allocated
728 % image. If there is a memory shortage, next is assigned NULL.
730 % Deprecated, replace with:
732 % AcquireNextImage(image_info,image);
734 % The format of the AllocateNextImage method is:
736 % void AllocateNextImage(const ImageInfo *image_info,Image *image)
738 % A description of each parameter follows:
740 % o image_info: Many of the image default values are set from this
741 % structure. For example, filename, compression, depth, background color,
744 % o image: the image.
747 MagickExport void AllocateNextImage(const ImageInfo *image_info,Image *image)
749 AcquireNextImage(image_info,image);
753 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
757 % A l l o c a t e S t r i n g %
761 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
763 % AllocateString() allocates memory for a string and copies the source string
764 % to that memory location (and returns it).
766 % The format of the AllocateString method is:
768 % char *AllocateString(const char *source)
770 % A description of each parameter follows:
772 % o source: A character string.
775 MagickExport char *AllocateString(const char *source)
783 assert(source != (const char *) NULL);
784 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
785 length=strlen(source)+MaxTextExtent+1;
786 destination=(char *) AcquireQuantumMemory(length,sizeof(*destination));
787 if (destination == (char *) NULL)
788 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
790 if (source != (char *) NULL)
791 (void) CopyMagickString(destination,source,length);
796 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
800 % A v e r a g e I m a g e s %
804 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
806 % AverageImages() takes a set of images and averages them together. Each
807 % image in the set must have the same width and height. AverageImages()
808 % returns a single image with each corresponding pixel component of each
809 % image averaged. On failure, a NULL image is returned and exception
810 % describes the reason for the failure.
812 % Deprecated, replace with:
814 % EvaluateImages(images,MeanEvaluateOperator,exception);
816 % The format of the AverageImages method is:
818 % Image *AverageImages(Image *images,ExceptionInfo *exception)
820 % A description of each parameter follows:
822 % o image: the image sequence.
824 % o exception: return any errors or warnings in this structure.
827 MagickExport Image *AverageImages(const Image *images,ExceptionInfo *exception)
829 return(EvaluateImages(images,MeanEvaluateOperator,exception));
833 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
837 % C h a n n e l I m a g e %
841 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
843 % Extract a channel from the image. A channel is a particular color component
844 % of each pixel in the image.
846 % Deprecated, replace with:
848 % SeparateImageChannel(image,channel);
850 % The format of the ChannelImage method is:
852 % unsigned int ChannelImage(Image *image,const ChannelType channel)
854 % A description of each parameter follows:
856 % o image: the image.
858 % o channel: Identify which channel to extract: RedChannel, GreenChannel,
859 % BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel,
863 MagickExport unsigned int ChannelImage(Image *image,const ChannelType channel)
865 return(SeparateImageChannel(image,channel));
869 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
873 % C h a n n e l T h r e s h o l d I m a g e %
877 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
879 % ChannelThresholdImage() changes the value of individual pixels based on
880 % the intensity of each pixel channel. The result is a high-contrast image.
882 % The format of the ChannelThresholdImage method is:
884 % unsigned int ChannelThresholdImage(Image *image,const char *level)
886 % A description of each parameter follows:
888 % o image: the image.
890 % o level: define the threshold values.
893 MagickExport unsigned int ChannelThresholdImage(Image *image,const char *level)
905 assert(image != (Image *) NULL);
906 assert(image->signature == MagickSignature);
907 if (image->debug != MagickFalse)
908 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
909 if (image->debug != MagickFalse)
910 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
911 if (level == (char *) NULL)
913 flags=ParseGeometry(level,&geometry_info);
914 threshold.red=geometry_info.rho;
915 threshold.green=geometry_info.sigma;
916 if ((flags & SigmaValue) == 0)
917 threshold.green=threshold.red;
918 threshold.blue=geometry_info.xi;
919 if ((flags & XiValue) == 0)
920 threshold.blue=threshold.red;
921 status=BilevelImageChannel(image,RedChannel,threshold.red);
922 status|=BilevelImageChannel(image,GreenChannel,threshold.green);
923 status|=BilevelImageChannel(image,BlueChannel,threshold.blue);
928 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
932 % C l i p I m a g e P a t h %
936 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
938 % ClipPathImage() sets the image clip mask based any clipping path information
941 % Deprecated, replace with:
943 % ClipImagePath(image,pathname,inside);
945 % The format of the ClipImage method is:
947 % MagickBooleanType ClipPathImage(Image *image,const char *pathname,
948 % const MagickBooleanType inside)
950 % A description of each parameter follows:
952 % o image: the image.
954 % o pathname: name of clipping path resource. If name is preceded by #, use
955 % clipping path numbered by name.
957 % o inside: if non-zero, later operations take effect inside clipping path.
958 % Otherwise later operations take effect outside clipping path.
961 MagickExport MagickBooleanType ClipPathImage(Image *image,const char *pathname,
962 const MagickBooleanType inside)
964 return(ClipImagePath(image,pathname,inside));
968 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
972 % C l o n e I m a g e A t t r i b u t e s %
976 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
978 % CloneImageAttributes() clones one or more image attributes.
980 % Deprecated, replace with:
982 % CloneImageProperties(image,clone_image);
984 % The format of the CloneImageAttributes method is:
986 % MagickBooleanType CloneImageAttributes(Image *image,
987 % const Image *clone_image)
989 % A description of each parameter follows:
991 % o image: the image.
993 % o clone_image: the clone image.
996 MagickExport MagickBooleanType CloneImageAttributes(Image *image,
997 const Image *clone_image)
999 return(CloneImageProperties(image,clone_image));
1003 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1007 % C l o n e M e m o r y %
1011 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1013 % CloneMemory() copies size bytes from memory area source to the destination.
1014 % Copying between objects that overlap will take place correctly. It returns
1017 % The format of the CloneMemory method is:
1019 % void *CloneMemory(void *destination,const void *source,
1020 % const size_t size)
1022 % A description of each parameter follows:
1024 % o destination: the destination.
1026 % o source: the source.
1028 % o size: the size of the memory in bytes to allocate.
1031 MagickExport void *CloneMemory(void *destination,const void *source,
1034 register const unsigned char
1037 register unsigned char
1043 assert(destination != (void *) NULL);
1044 assert(source != (const void *) NULL);
1045 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
1046 p=(const unsigned char *) source;
1047 q=(unsigned char *) destination;
1048 if ((p <= q) || ((p+size) >= q))
1049 return(CopyMagickMemory(destination,source,size));
1051 Overlap, copy backwards.
1055 for (i=(ssize_t) (size-1); i >= 0; i--)
1057 return(destination);
1061 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1065 % C l o s e C a c h e V i e w %
1069 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1071 % CloseCacheView() closes the specified view returned by a previous call to
1074 % Deprecated, replace with:
1076 % DestroyCacheView(view_info);
1078 % The format of the CloseCacheView method is:
1080 % CacheView *CloseCacheView(CacheView *view_info)
1082 % A description of each parameter follows:
1084 % o view_info: the address of a structure of type CacheView.
1087 MagickExport CacheView *CloseCacheView(CacheView *view_info)
1089 return(DestroyCacheView(view_info));
1093 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1097 % C o l o r F l o o d f i l l I m a g e %
1101 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1103 % ColorFloodfill() changes the color value of any pixel that matches
1104 % target and is an immediate neighbor. If the method FillToBorderMethod is
1105 % specified, the color value is changed for any neighbor pixel that does not
1106 % match the bordercolor member of image.
1108 % By default target must match a particular pixel color exactly.
1109 % However, in many cases two colors may differ by a small amount. The
1110 % fuzz member of image defines how much tolerance is acceptable to
1111 % consider two colors as the same. For example, set fuzz to 10 and the
1112 % color red at intensities of 100 and 102 respectively are now
1113 % interpreted as the same color for the purposes of the floodfill.
1115 % The format of the ColorFloodfillImage method is:
1117 % MagickBooleanType ColorFloodfillImage(Image *image,
1118 % const DrawInfo *draw_info,const PixelPacket target,
1119 % const ssize_t x_offset,const ssize_t y_offset,const PaintMethod method)
1121 % A description of each parameter follows:
1123 % o image: the image.
1125 % o draw_info: the draw info.
1127 % o target: the RGB value of the target color.
1129 % o x,y: the starting location of the operation.
1131 % o method: Choose either FloodfillMethod or FillToBorderMethod.
1135 #define MaxStacksize (1UL << 15)
1136 #define PushSegmentStack(up,left,right,delta) \
1138 if (s >= (segment_stack+MaxStacksize)) \
1139 ThrowBinaryException(DrawError,"SegmentStackOverflow",image->filename) \
1142 if ((((up)+(delta)) >= 0) && (((up)+(delta)) < (ssize_t) image->rows)) \
1144 s->x1=(double) (left); \
1145 s->y1=(double) (up); \
1146 s->x2=(double) (right); \
1147 s->y2=(double) (delta); \
1153 MagickExport MagickBooleanType ColorFloodfillImage(Image *image,
1154 const DrawInfo *draw_info,const PixelPacket target,const ssize_t x_offset,
1155 const ssize_t y_offset,const PaintMethod method)
1166 register SegmentInfo
1181 Check boundary conditions.
1183 assert(image != (Image *) NULL);
1184 assert(image->signature == MagickSignature);
1185 if (image->debug != MagickFalse)
1186 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
1187 assert(draw_info != (DrawInfo *) NULL);
1188 assert(draw_info->signature == MagickSignature);
1189 if ((x_offset < 0) || (x_offset >= (ssize_t) image->columns))
1190 return(MagickFalse);
1191 if ((y_offset < 0) || (y_offset >= (ssize_t) image->rows))
1192 return(MagickFalse);
1193 if (SetImageStorageClass(image,DirectClass) == MagickFalse)
1194 return(MagickFalse);
1195 if (image->matte == MagickFalse)
1196 (void) SetImageAlphaChannel(image,OpaqueAlphaChannel);
1197 floodplane_image=CloneImage(image,image->columns,image->rows,MagickTrue,
1199 if (floodplane_image == (Image *) NULL)
1200 return(MagickFalse);
1201 (void) SetImageAlphaChannel(floodplane_image,OpaqueAlphaChannel);
1203 Set floodfill color.
1205 segment_stack=(SegmentInfo *) AcquireQuantumMemory(MaxStacksize,
1206 sizeof(*segment_stack));
1207 if (segment_stack == (SegmentInfo *) NULL)
1209 floodplane_image=DestroyImage(floodplane_image);
1210 ThrowBinaryException(ResourceLimitError,"MemoryAllocationFailed",
1214 Push initial segment on stack.
1220 PushSegmentStack(y,x,x,1);
1221 PushSegmentStack(y+1,x,x,-1);
1222 while (s > segment_stack)
1224 register const PixelPacket
1230 register PixelPacket
1234 Pop segment off stack.
1239 offset=(ssize_t) s->y2;
1240 y=(ssize_t) s->y1+offset;
1242 Recolor neighboring pixels.
1244 p=GetVirtualPixels(image,0,y,(size_t) (x1+1),1,&image->exception);
1245 q=GetAuthenticPixels(floodplane_image,0,y,(size_t) (x1+1),1,
1247 if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL))
1251 for (x=x1; x >= 0; x--)
1253 if (q->opacity == (Quantum) TransparentOpacity)
1255 if (method == FloodfillMethod)
1257 if (IsColorSimilar(image,p,&target) == MagickFalse)
1261 if (IsColorSimilar(image,p,&target) != MagickFalse)
1263 q->opacity=(Quantum) TransparentOpacity;
1267 if (SyncAuthenticPixels(floodplane_image,&image->exception) == MagickFalse)
1269 skip=x >= x1 ? MagickTrue : MagickFalse;
1270 if (skip == MagickFalse)
1274 PushSegmentStack(y,start,x1-1,-offset);
1279 if (skip == MagickFalse)
1281 if (x < (ssize_t) image->columns)
1283 p=GetVirtualPixels(image,x,y,image->columns-x,1,
1285 q=GetAuthenticPixels(floodplane_image,x,y,image->columns-x,1,
1287 if ((p == (const PixelPacket *) NULL) ||
1288 (q == (PixelPacket *) NULL))
1290 for ( ; x < (ssize_t) image->columns; x++)
1292 if (q->opacity == (Quantum) TransparentOpacity)
1294 if (method == FloodfillMethod)
1296 if (IsColorSimilar(image,p,&target) == MagickFalse)
1300 if (IsColorSimilar(image,p,&target) != MagickFalse)
1302 q->opacity=(Quantum) TransparentOpacity;
1306 if (SyncAuthenticPixels(floodplane_image,&image->exception) == MagickFalse)
1309 PushSegmentStack(y,start,x-1,offset);
1311 PushSegmentStack(y,x2+1,x-1,-offset);
1317 p=GetVirtualPixels(image,x,y,(size_t) (x2-x+1),1,
1319 q=GetAuthenticPixels(floodplane_image,x,y,(size_t) (x2-x+1),1,
1321 if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL))
1323 for ( ; x <= x2; x++)
1325 if (q->opacity == (Quantum) TransparentOpacity)
1327 if (method == FloodfillMethod)
1329 if (IsColorSimilar(image,p,&target) != MagickFalse)
1333 if (IsColorSimilar(image,p,&target) == MagickFalse)
1342 for (y=0; y < (ssize_t) image->rows; y++)
1344 register const PixelPacket
1350 register PixelPacket
1354 Tile fill color onto floodplane.
1356 p=GetVirtualPixels(floodplane_image,0,y,image->columns,1,
1358 q=GetAuthenticPixels(image,0,y,image->columns,1,&image->exception);
1359 if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL))
1361 for (x=0; x < (ssize_t) image->columns; x++)
1363 if (GetOpacityPixelComponent(p) != OpaqueOpacity)
1365 (void) GetFillColor(draw_info,x,y,&fill_color);
1366 MagickCompositeOver(&fill_color,(MagickRealType) fill_color.opacity,q,
1367 (MagickRealType) q->opacity,q);
1372 if (SyncAuthenticPixels(image,&image->exception) == MagickFalse)
1375 segment_stack=(SegmentInfo *) RelinquishMagickMemory(segment_stack);
1376 floodplane_image=DestroyImage(floodplane_image);
1377 return(y == (ssize_t) image->rows ? MagickTrue : MagickFalse);
1381 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1385 % D e l e t e I m a g e A t t r i b u t e %
1389 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1391 % DeleteImageAttribute() deletes an attribute from the image.
1393 % Deprecated, replace with:
1395 % DeleteImageProperty(image,key);
1397 % The format of the DeleteImageAttribute method is:
1399 % MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
1401 % A description of each parameter follows:
1403 % o image: the image info.
1405 % o key: the image key.
1408 MagickExport MagickBooleanType DeleteImageAttribute(Image *image,
1411 return(DeleteImageProperty(image,key));
1415 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1419 % D e l e t e I m a g e L i s t %
1423 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1425 % DeleteImageList() deletes an image at the specified position in the list.
1427 % The format of the DeleteImageList method is:
1429 % unsigned int DeleteImageList(Image *images,const ssize_t offset)
1431 % A description of each parameter follows:
1433 % o images: the image list.
1435 % o offset: the position within the list.
1438 MagickExport unsigned int DeleteImageList(Image *images,const ssize_t offset)
1443 if (images->debug != MagickFalse)
1444 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
1445 while (GetPreviousImageInList(images) != (Image *) NULL)
1446 images=GetPreviousImageInList(images);
1447 for (i=0; i < offset; i++)
1449 if (GetNextImageInList(images) == (Image *) NULL)
1450 return(MagickFalse);
1451 images=GetNextImageInList(images);
1453 DeleteImageFromList(&images);
1458 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1462 % D e l e t e M a g i c k R e g i s t r y %
1466 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1468 % DeleteMagickRegistry() deletes an entry in the registry as defined by the id.
1469 % It returns MagickTrue if the entry is deleted otherwise MagickFalse if no
1470 % entry is found in the registry that matches the id.
1472 % Deprecated, replace with:
1474 % char key[MaxTextExtent];
1475 % FormatMagickString(key,MaxTextExtent,"%ld\n",id);
1476 % DeleteImageRegistry(key);
1478 % The format of the DeleteMagickRegistry method is:
1480 % MagickBooleanType DeleteMagickRegistry(const ssize_t id)
1482 % A description of each parameter follows:
1484 % o id: the registry id.
1487 MagickExport MagickBooleanType DeleteMagickRegistry(const ssize_t id)
1492 (void) FormatMagickString(key,MaxTextExtent,"%.20g\n",(double) id);
1493 return(DeleteImageRegistry(key));
1497 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1501 + D e s t r o y C o n s t i t u t e %
1505 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1507 % DestroyConstitute() destroys the constitute component.
1509 % The format of the DestroyConstitute method is:
1511 % DestroyConstitute(void)
1514 MagickExport void DestroyConstitute(void)
1516 ConstituteComponentTerminus();
1520 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1524 + D e s t r o y M a g i c k R e g i s t r y %
1528 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1530 % DestroyMagickRegistry() deallocates memory associated the magick registry.
1532 % Deprecated, replace with:
1534 % RegistryComponentTerminus();
1536 % The format of the DestroyMagickRegistry method is:
1538 % void DestroyMagickRegistry(void)
1541 MagickExport void DestroyMagickRegistry(void)
1543 RegistryComponentTerminus();
1547 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1551 % D e s c r i b e I m a g e %
1555 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1557 % DescribeImage() describes an image by printing its attributes to the file.
1558 % Attributes include the image width, height, size, and others.
1560 % Deprecated, replace with:
1562 % IdentifyImage(image,file,verbose);
1564 % The format of the DescribeImage method is:
1566 % MagickBooleanType DescribeImage(Image *image,FILE *file,
1567 % const MagickBooleanType verbose)
1569 % A description of each parameter follows:
1571 % o image: the image.
1573 % o file: the file, typically stdout.
1575 % o verbose: A value other than zero prints more detailed information
1579 MagickExport MagickBooleanType DescribeImage(Image *image,FILE *file,
1580 const MagickBooleanType verbose)
1582 return(IdentifyImage(image,file,verbose));
1586 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1590 % D e s t r o y I m a g e A t t r i b u t e s %
1594 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1596 % DestroyImageAttributes() deallocates memory associated with the image
1599 % The format of the DestroyImageAttributes method is:
1601 % DestroyImageAttributes(Image *image)
1603 % A description of each parameter follows:
1605 % o image: the image.
1608 MagickExport void DestroyImageAttributes(Image *image)
1610 assert(image != (Image *) NULL);
1611 assert(image->signature == MagickSignature);
1612 if (image->debug != MagickFalse)
1613 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
1614 if (image->attributes != (void *) NULL)
1615 image->attributes=(void *) DestroySplayTree((SplayTreeInfo *)
1620 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1624 % D e s t r o y I m a g e s %
1628 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1630 % DestroyImages() destroys an image list.
1632 % Deprecated, replace with:
1634 % DestroyImageList(image);
1636 % The format of the DestroyImages method is:
1638 % void DestroyImages(Image *image)
1640 % A description of each parameter follows:
1642 % o image: the image sequence.
1645 MagickExport void DestroyImages(Image *image)
1647 if (image == (Image *) NULL)
1649 if (image->debug != MagickFalse)
1650 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.4.3");
1651 image=DestroyImageList(image);
1655 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1659 % D e s t r o y M a g i c k %
1663 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1665 % DestroyMagick() destroys the ImageMagick environment.
1667 % Deprecated, replace with:
1669 % MagickCoreTerminus();
1671 % The format of the DestroyMagick function is:
1673 % DestroyMagick(void)
1676 MagickExport void DestroyMagick(void)
1678 MagickCoreTerminus();
1682 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1686 % D i s p a t c h I m a g e %
1690 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1692 % DispatchImage() extracts pixel data from an image and returns it to you.
1693 % The method returns MagickFalse on success otherwise MagickTrue if an error is
1694 % encountered. The data is returned as char, short int, int, ssize_t, float,
1695 % or double in the order specified by map.
1697 % Suppose you want to extract the first scanline of a 640x480 image as
1698 % character data in red-green-blue order:
1700 % DispatchImage(image,0,0,640,1,"RGB",CharPixel,pixels,exception);
1702 % Deprecated, replace with:
1704 % ExportImagePixels(image,x_offset,y_offset,columns,rows,map,type,pixels,
1707 % The format of the DispatchImage method is:
1709 % unsigned int DispatchImage(const Image *image,const ssize_t x_offset,
1710 % const ssize_t y_offset,const size_t columns,
1711 % const size_t rows,const char *map,const StorageType type,
1712 % void *pixels,ExceptionInfo *exception)
1714 % A description of each parameter follows:
1716 % o image: the image.
1718 % o x_offset, y_offset, columns, rows: These values define the perimeter
1719 % of a region of pixels you want to extract.
1721 % o map: This string reflects the expected ordering of the pixel array.
1722 % It can be any combination or order of R = red, G = green, B = blue,
1723 % A = alpha, C = cyan, Y = yellow, M = magenta, K = black, or
1724 % I = intensity (for grayscale).
1726 % o type: Define the data type of the pixels. Float and double types are
1727 % normalized to [0..1] otherwise [0..QuantumRange]. Choose from these
1728 % types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or
1731 % o pixels: This array of values contain the pixel components as defined by
1732 % map and type. You must preallocate this array where the expected
1733 % length varies depending on the values of width, height, map, and type.
1735 % o exception: return any errors or warnings in this structure.
1738 MagickExport unsigned int DispatchImage(const Image *image,const ssize_t x_offset,
1739 const ssize_t y_offset,const size_t columns,const size_t rows,
1740 const char *map,const StorageType type,void *pixels,ExceptionInfo *exception)
1745 if (image->debug != MagickFalse)
1746 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.6");
1747 status=ExportImagePixels(image,x_offset,y_offset,columns,rows,map,type,pixels,
1753 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1757 % E x t r a c t S u b i m a g e F r o m I m a g e %
1761 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1763 % ExtractSubimageFromImageImage() extracts a region of the image that most
1764 % closely resembles the reference.
1766 % The format of the ExtractSubimageFromImageImage method is:
1768 % Image *ExtractSubimageFromImage(const Image *image,
1769 % const Image *reference,ExceptionInfo *exception)
1771 % A description of each parameter follows:
1773 % o image: the image.
1775 % o reference: find an area of the image that closely resembles this image.
1777 % o exception: return any errors or warnings in this structure.
1781 static double GetSimilarityMetric(const Image *image,const Image *reference,
1782 const ssize_t x_offset,const ssize_t y_offset,
1783 const double similarity_threshold,ExceptionInfo *exception)
1791 normalized_similarity,
1798 Compute the similarity in pixels between two images.
1800 normalized_similarity=1.0;
1803 if ((image->matte != MagickFalse) && (reference->matte != MagickFalse))
1805 if ((image->colorspace == CMYKColorspace) &&
1806 (reference->colorspace == CMYKColorspace))
1808 image_view=AcquireCacheView(image);
1809 reference_view=AcquireCacheView(reference);
1810 for (y=0; y < (ssize_t) reference->rows; y++)
1812 register const IndexPacket
1816 register const PixelPacket
1823 p=GetCacheViewVirtualPixels(image_view,x_offset,y_offset+y,
1824 reference->columns,1,exception);
1825 q=GetCacheViewVirtualPixels(reference_view,0,y,reference->columns,1,
1827 if ((p == (const PixelPacket *) NULL) || (q == (const PixelPacket *) NULL))
1829 indexes=GetCacheViewVirtualIndexQueue(image_view);
1830 reference_indexes=GetCacheViewVirtualIndexQueue(reference_view);
1831 for (x=0; x < (ssize_t) reference->columns; x++)
1836 pixel=QuantumScale*(GetRedPixelComponent(p)-(double)
1837 GetRedPixelComponent(q));
1838 similarity+=pixel*pixel;
1839 pixel=QuantumScale*(GetGreenPixelComponent(p)-(double)
1840 GetGreenPixelComponent(q));
1841 similarity+=pixel*pixel;
1842 pixel=QuantumScale*(GetBluePixelComponent(p)-(double)
1843 GetBluePixelComponent(q));
1844 similarity+=pixel*pixel;
1845 if ((image->matte != MagickFalse) && (reference->matte != MagickFalse))
1847 pixel=QuantumScale*(GetOpacityPixelComponent(p)-(double)
1848 GetOpacityPixelComponent(q));
1849 similarity+=pixel*pixel;
1851 if ((image->colorspace == CMYKColorspace) &&
1852 (reference->colorspace == CMYKColorspace))
1854 pixel=QuantumScale*(indexes[x]-(double) reference_indexes[x]);
1855 similarity+=pixel*pixel;
1860 normalized_similarity=sqrt(similarity)/reference->columns/reference->rows/
1862 if (normalized_similarity > similarity_threshold)
1865 reference_view=DestroyCacheView(reference_view);
1866 image_view=DestroyCacheView(image_view);
1867 return(normalized_similarity);
1870 MagickExport Image *ExtractSubimageFromImage(Image *image,
1871 const Image *reference,ExceptionInfo *exception)
1874 similarity_threshold;
1883 Extract reference from image.
1885 if ((reference->columns > image->columns) || (reference->rows > image->rows))
1886 return((Image *) NULL);
1887 similarity_threshold=(double) image->columns*image->rows;
1888 SetGeometry(reference,&offset);
1889 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1890 #pragma omp parallel for schedule(dynamic,4)
1892 for (y=0; y < (ssize_t) (image->rows-reference->rows); y++)
1900 for (x=0; x < (ssize_t) (image->columns-reference->columns); x++)
1902 similarity=GetSimilarityMetric(image,reference,x,y,similarity_threshold,
1904 #if defined(MAGICKCORE_OPENMP_SUPPORT)
1905 #pragma omp critical (MagickCore_ExtractSubimageFromImage)
1907 if (similarity < similarity_threshold)
1909 similarity_threshold=similarity;
1915 if (similarity_threshold > (QuantumScale*reference->fuzz/100.0))
1916 return((Image *) NULL);
1917 return(CropImage(image,&offset,exception));
1921 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1925 % F l a t t e n I m a g e %
1929 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1931 % FlattenImages() Obsolete Function: Use MergeImageLayers() instead.
1933 % Deprecated, replace with:
1935 % MergeImageLayers(image,FlattenLayer,exception);
1937 % The format of the FlattenImage method is:
1939 % Image *FlattenImage(Image *image,ExceptionInfo *exception)
1941 % A description of each parameter follows:
1943 % o image: the image sequence.
1945 % o exception: return any errors or warnings in this structure.
1948 MagickExport Image *FlattenImages(Image *image,ExceptionInfo *exception)
1950 return(MergeImageLayers(image,FlattenLayer,exception));
1954 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1958 % F o r m a t I m a g e A t t r i b u t e %
1962 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1964 % FormatImageAttribute() permits formatted key/value pairs to be saved as an
1967 % The format of the FormatImageAttribute method is:
1969 % MagickBooleanType FormatImageAttribute(Image *image,const char *key,
1970 % const char *format,...)
1972 % A description of each parameter follows.
1974 % o image: The image.
1976 % o key: The attribute key.
1978 % o format: A string describing the format to use to write the remaining
1983 MagickExport MagickBooleanType FormatImageAttributeList(Image *image,
1984 const char *key,const char *format,va_list operands)
1987 value[MaxTextExtent];
1992 #if defined(MAGICKCORE_HAVE_VSNPRINTF)
1993 n=vsnprintf(value,MaxTextExtent,format,operands);
1995 n=vsprintf(value,format,operands);
1998 value[MaxTextExtent-1]='\0';
1999 return(SetImageProperty(image,key,value));
2002 MagickExport MagickBooleanType FormatImageAttribute(Image *image,
2003 const char *key,const char *format,...)
2011 va_start(operands,format);
2012 status=FormatImagePropertyList(image,key,format,operands);
2018 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2022 % F o r m a t S t r i n g %
2026 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2028 % FormatString() prints formatted output of a variable argument list.
2030 % The format of the FormatString method is:
2032 % void FormatString(char *string,const char *format,...)
2034 % A description of each parameter follows.
2036 % o string: Method FormatString returns the formatted string in this
2039 % o format: A string describing the format to use to write the remaining
2044 MagickExport void FormatStringList(char *string,const char *format,
2050 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
2051 #if defined(MAGICKCORE_HAVE_VSNPRINTF)
2052 n=vsnprintf(string,MaxTextExtent,format,operands);
2054 n=vsprintf(string,format,operands);
2057 string[MaxTextExtent-1]='\0';
2060 MagickExport void FormatString(char *string,const char *format,...)
2065 va_start(operands,format);
2066 (void) FormatMagickStringList(string,MaxTextExtent,format,operands);
2072 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2076 + F u z z y C o l o r M a t c h %
2080 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2082 % FuzzyColorMatch() returns true if two pixels are identical in color.
2084 % The format of the ColorMatch method is:
2086 % void FuzzyColorMatch(const PixelPacket *p,const PixelPacket *q,
2087 % const double fuzz)
2089 % A description of each parameter follows:
2095 % o distance: Define how much tolerance is acceptable to consider
2096 % two colors as the same.
2099 MagickExport unsigned int FuzzyColorMatch(const PixelPacket *p,
2100 const PixelPacket *q,const double fuzz)
2105 register MagickRealType
2108 if ((fuzz == 0.0) && (GetRedPixelComponent(p) == GetRedPixelComponent(q)) &&
2109 (GetGreenPixelComponent(p) == GetGreenPixelComponent(q)) &&
2110 (GetBluePixelComponent(p) == GetBluePixelComponent(q)))
2112 pixel.red=GetRedPixelComponent(p)-(MagickRealType) GetRedPixelComponent(q);
2113 distance=pixel.red*pixel.red;
2114 if (distance > (fuzz*fuzz))
2115 return(MagickFalse);
2116 pixel.green=GetGreenPixelComponent(p)-(MagickRealType)
2117 GetGreenPixelComponent(q);
2118 distance+=pixel.green*pixel.green;
2119 if (distance > (fuzz*fuzz))
2120 return(MagickFalse);
2121 pixel.blue=GetBluePixelComponent(p)-(MagickRealType) GetBluePixelComponent(q);
2122 distance+=pixel.blue*pixel.blue;
2123 if (distance > (fuzz*fuzz))
2124 return(MagickFalse);
2129 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2133 + F u z z y C o l o r C o m p a r e %
2137 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2139 % FuzzyColorCompare() returns MagickTrue if the distance between two colors is
2140 % less than the specified distance in a linear three dimensional color space.
2141 % This method is used by ColorFloodFill() and other algorithms which
2142 % compare two colors.
2144 % The format of the FuzzyColorCompare method is:
2146 % void FuzzyColorCompare(const Image *image,const PixelPacket *p,
2147 % const PixelPacket *q)
2149 % A description of each parameter follows:
2151 % o image: the image.
2158 MagickExport MagickBooleanType FuzzyColorCompare(const Image *image,
2159 const PixelPacket *p,const PixelPacket *q)
2161 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.2.5");
2162 return(IsColorSimilar(image,p,q));
2166 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2170 + F u z z y O p a c i t y C o m p a r e %
2174 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2176 % FuzzyOpacityCompare() returns true if the distance between two opacity
2177 % values is less than the specified distance in a linear color space. This
2178 % method is used by MatteFloodFill() and other algorithms which compare
2179 % two opacity values.
2181 % Deprecated, replace with:
2183 % IsOpacitySimilar(image,p,q);
2185 % The format of the FuzzyOpacityCompare method is:
2187 % void FuzzyOpacityCompare(const Image *image,const PixelPacket *p,
2188 % const PixelPacket *q)
2190 % A description of each parameter follows:
2192 % o image: the image.
2199 MagickExport MagickBooleanType FuzzyOpacityCompare(const Image *image,
2200 const PixelPacket *p,const PixelPacket *q)
2202 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.2.5");
2203 return(IsOpacitySimilar(image,p,q));
2207 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2211 % G e t C o n f i g u r e B l o b %
2215 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2217 % GetConfigureBlob() returns the specified configure file as a blob.
2219 % The format of the GetConfigureBlob method is:
2221 % void *GetConfigureBlob(const char *filename,ExceptionInfo *exception)
2223 % A description of each parameter follows:
2225 % o filename: the configure file name.
2227 % o path: return the full path information of the configure file.
2229 % o length: This pointer to a size_t integer sets the initial length of the
2230 % blob. On return, it reflects the actual length of the blob.
2232 % o exception: return any errors or warnings in this structure.
2235 MagickExport void *GetConfigureBlob(const char *filename,char *path,
2236 size_t *length,ExceptionInfo *exception)
2241 assert(filename != (const char *) NULL);
2242 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",filename);
2243 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
2244 assert(path != (char *) NULL);
2245 assert(length != (size_t *) NULL);
2246 assert(exception != (ExceptionInfo *) NULL);
2248 (void) CopyMagickString(path,filename,MaxTextExtent);
2249 #if defined(MAGICKCORE_INSTALLED_SUPPORT)
2250 #if defined(MAGICKCORE_LIBRARY_PATH)
2251 if (blob == (void *) NULL)
2254 Search hard coded paths.
2256 (void) FormatMagickString(path,MaxTextExtent,"%s%s",
2257 MAGICKCORE_LIBRARY_PATH,filename);
2258 if (IsPathAccessible(path) != MagickFalse)
2259 blob=FileToBlob(path,~0,length,exception);
2262 #if defined(MAGICKCORE_WINDOWS_SUPPORT) && !(defined(MAGICKCORE_CONFIGURE_PATH) || defined(MAGICKCORE_SHARE_PATH))
2263 if (blob == (void *) NULL)
2269 Locate file via registry key.
2271 key_value=NTRegistryKeyLookup("ConfigurePath");
2272 if (key_value != (char *) NULL)
2274 (void) FormatMagickString(path,MaxTextExtent,"%s%s%s",key_value,
2275 DirectorySeparator,filename);
2276 if (IsPathAccessible(path) != MagickFalse)
2277 blob=FileToBlob(path,~0,length,exception);
2282 if (blob == (void *) NULL)
2287 home=GetEnvironmentValue("MAGICK_HOME");
2288 if (home != (char *) NULL)
2293 #if !defined(MAGICKCORE_POSIX_SUPPORT)
2294 (void) FormatMagickString(path,MaxTextExtent,"%s%s%s",home,
2295 DirectorySeparator,filename);
2297 (void) FormatMagickString(path,MaxTextExtent,"%s/lib/%s/%s",home,
2298 MAGICKCORE_LIBRARY_RELATIVE_PATH,filename);
2300 if (IsPathAccessible(path) != MagickFalse)
2301 blob=FileToBlob(path,~0,length,exception);
2302 home=DestroyString(home);
2304 home=GetEnvironmentValue("HOME");
2305 if (home == (char *) NULL)
2306 home=GetEnvironmentValue("USERPROFILE");
2307 if (home != (char *) NULL)
2310 Search $HOME/.magick.
2312 (void) FormatMagickString(path,MaxTextExtent,"%s%s.magick%s%s",home,
2313 DirectorySeparator,DirectorySeparator,filename);
2314 if ((IsPathAccessible(path) != MagickFalse) && (blob == (void *) NULL))
2315 blob=FileToBlob(path,~0,length,exception);
2316 home=DestroyString(home);
2319 if ((blob == (void *) NULL) && (*GetClientPath() != '\0'))
2321 #if !defined(MAGICKCORE_POSIX_SUPPORT)
2322 (void) FormatMagickString(path,MaxTextExtent,"%s%s%s",GetClientPath(),
2323 DirectorySeparator,filename);
2326 prefix[MaxTextExtent];
2329 Search based on executable directory if directory is known.
2331 (void) CopyMagickString(prefix,GetClientPath(),
2333 ChopPathComponents(prefix,1);
2334 (void) FormatMagickString(path,MaxTextExtent,"%s/lib/%s/%s",prefix,
2335 MAGICKCORE_LIBRARY_RELATIVE_PATH,filename);
2337 if (IsPathAccessible(path) != MagickFalse)
2338 blob=FileToBlob(path,~0,length,exception);
2341 Search current directory.
2343 if ((blob == (void *) NULL) && (IsPathAccessible(path) != MagickFalse))
2344 blob=FileToBlob(path,~0,length,exception);
2345 #if defined(MAGICKCORE_WINDOWS_SUPPORT)
2347 Search Windows registry.
2349 if (blob == (void *) NULL)
2350 blob=NTResourceToBlob(filename);
2353 if (blob == (void *) NULL)
2354 (void) ThrowMagickException(exception,GetMagickModule(),ConfigureWarning,
2355 "UnableToOpenConfigureFile","`%s'",path);
2360 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2364 % G e t C a c h e V i e w %
2368 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2370 % GetCacheView() gets pixels from the in-memory or disk pixel cache as
2371 % defined by the geometry parameters. A pointer to the pixels is returned if
2372 % the pixels are transferred, otherwise a NULL is returned.
2374 % Deprecated, replace with:
2376 % GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2377 % GetCacheViewException(cache_view));
2379 % The format of the GetCacheView method is:
2381 % PixelPacket *GetCacheView(CacheView *cache_view,const ssize_t x,
2382 % const ssize_t y,const size_t columns,const size_t rows)
2384 % A description of each parameter follows:
2386 % o cache_view: the address of a structure of type CacheView.
2388 % o x,y,columns,rows: These values define the perimeter of a region of
2392 MagickExport PixelPacket *GetCacheView(CacheView *cache_view,const ssize_t x,
2393 const ssize_t y,const size_t columns,const size_t rows)
2398 pixels=GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2399 GetCacheViewException(cache_view));
2404 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2408 % G e t C a c h e V i e w I n d e x e s %
2412 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2414 % GetCacheViewIndexes() returns the indexes associated with the specified
2417 % Deprecated, replace with:
2419 % GetCacheViewAuthenticIndexQueue(cache_view);
2421 % The format of the GetCacheViewIndexes method is:
2423 % IndexPacket *GetCacheViewIndexes(CacheView *cache_view)
2425 % A description of each parameter follows:
2427 % o cache_view: the cache view.
2430 MagickExport IndexPacket *GetCacheViewIndexes(CacheView *cache_view)
2432 return(GetCacheViewAuthenticIndexQueue(cache_view));
2436 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2440 % G e t C a c h e V i e w P i x e l s %
2444 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2446 % GetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as
2447 % defined by the geometry parameters. A pointer to the pixels is returned if
2448 % the pixels are transferred, otherwise a NULL is returned.
2450 % Deprecated, replace with:
2452 % GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2453 % GetCacheViewException(cache_view));
2455 % The format of the GetCacheViewPixels method is:
2457 % PixelPacket *GetCacheViewPixels(CacheView *cache_view,const ssize_t x,
2458 % const ssize_t y,const size_t columns,const size_t rows)
2460 % A description of each parameter follows:
2462 % o cache_view: the cache view.
2464 % o x,y,columns,rows: These values define the perimeter of a region of
2468 MagickExport PixelPacket *GetCacheViewPixels(CacheView *cache_view,const ssize_t x,
2469 const ssize_t y,const size_t columns,const size_t rows)
2474 pixels=GetCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
2475 GetCacheViewException(cache_view));
2480 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2484 % G e t I m a g e A t t r i b u t e %
2488 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2490 % GetImageAttribute() searches the list of image attributes and returns
2491 % a pointer to the attribute if it exists otherwise NULL.
2493 % The format of the GetImageAttribute method is:
2495 % const ImageAttribute *GetImageAttribute(const Image *image,
2498 % A description of each parameter follows:
2500 % o image: the image.
2502 % o key: These character strings are the name of an image attribute to
2507 static void *DestroyAttribute(void *attribute)
2509 register ImageAttribute
2512 p=(ImageAttribute *) attribute;
2513 if (p->value != (char *) NULL)
2514 p->value=DestroyString(p->value);
2515 return(RelinquishMagickMemory(p));
2518 MagickExport const ImageAttribute *GetImageAttribute(const Image *image,
2527 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.3.1");
2528 value=GetImageProperty(image,key);
2529 if (value == (const char *) NULL)
2530 return((const ImageAttribute *) NULL);
2531 if (image->attributes == (void *) NULL)
2532 ((Image *) image)->attributes=NewSplayTree(CompareSplayTreeString,
2533 RelinquishMagickMemory,DestroyAttribute);
2536 const ImageAttribute
2539 attribute=(const ImageAttribute *) GetValueFromSplayTree((SplayTreeInfo *)
2540 image->attributes,key);
2541 if (attribute != (const ImageAttribute *) NULL)
2544 attribute=(ImageAttribute *) AcquireMagickMemory(sizeof(*attribute));
2545 if (attribute == (ImageAttribute *) NULL)
2546 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
2547 (void) ResetMagickMemory(attribute,0,sizeof(*attribute));
2548 attribute->key=ConstantString(key);
2549 attribute->value=ConstantString(value);
2550 (void) AddValueToSplayTree((SplayTreeInfo *) ((Image *) image)->attributes,
2551 attribute->key,attribute);
2552 return((const ImageAttribute *) attribute);
2556 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2560 % G e t I m a g e C l i p p i n g P a t h A t t r i b u t e %
2564 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2566 % GetImageClippingPathAttribute() searches the list of image attributes and
2567 % returns a pointer to a clipping path if it exists otherwise NULL.
2569 % Deprecated, replace with:
2571 % GetImageAttribute(image,"8BIM:1999,2998");
2573 % The format of the GetImageClippingPathAttribute method is:
2575 % const ImageAttribute *GetImageClippingPathAttribute(Image *image)
2577 % A description of each parameter follows:
2579 % o attribute: Method GetImageClippingPathAttribute returns the clipping
2580 % path if it exists otherwise NULL.
2582 % o image: the image.
2585 MagickExport const ImageAttribute *GetImageClippingPathAttribute(Image *image)
2587 return(GetImageAttribute(image,"8BIM:1999,2998"));
2591 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2595 % G e t I m a g e F r o m M a g i c k R e g i s t r y %
2599 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2601 % GetImageFromMagickRegistry() gets an image from the registry as defined by
2602 % its name. If the image is not found, a NULL image is returned.
2604 % Deprecated, replace with:
2606 % GetImageRegistry(ImageRegistryType,name,exception);
2608 % The format of the GetImageFromMagickRegistry method is:
2610 % Image *GetImageFromMagickRegistry(const char *name,ssize_t *id,
2611 % ExceptionInfo *exception)
2613 % A description of each parameter follows:
2615 % o name: the name of the image to retrieve from the registry.
2617 % o id: the registry id.
2619 % o exception: return any errors or warnings in this structure.
2622 MagickExport Image *GetImageFromMagickRegistry(const char *name,ssize_t *id,
2623 ExceptionInfo *exception)
2626 return((Image *) GetImageRegistry(ImageRegistryType,name,exception));
2630 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2634 % G e t M a g i c k R e g i s t r y %
2638 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2640 % GetMagickRegistry() gets a blob from the registry as defined by the id. If
2641 % the blob that matches the id is not found, NULL is returned.
2643 % The format of the GetMagickRegistry method is:
2645 % const void *GetMagickRegistry(const ssize_t id,RegistryType *type,
2646 % size_t *length,ExceptionInfo *exception)
2648 % A description of each parameter follows:
2650 % o id: the registry id.
2652 % o type: the registry type.
2654 % o length: the blob length in number of bytes.
2656 % o exception: return any errors or warnings in this structure.
2659 MagickExport void *GetMagickRegistry(const ssize_t id,RegistryType *type,
2660 size_t *length,ExceptionInfo *exception)
2668 *type=UndefinedRegistryType;
2670 (void) FormatMagickString(key,MaxTextExtent,"%.20g\n",(double) id);
2671 blob=(void *) GetImageRegistry(ImageRegistryType,key,exception);
2672 if (blob != (void *) NULL)
2674 blob=(void *) GetImageRegistry(ImageInfoRegistryType,key,exception);
2675 if (blob != (void *) NULL)
2677 return((void *) GetImageRegistry(UndefinedRegistryType,key,exception));
2681 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2685 % G e t I m a g e G e o m e t r y %
2689 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2691 % GetImageGeometry() returns a region as defined by the geometry string with
2692 % respect to the image and its gravity.
2694 % Deprecated, replace with:
2696 % if (size_to_fit != MagickFalse)
2697 % ParseRegionGeometry(image,geometry,region_info,&image->exception); else
2698 % ParsePageGeometry(image,geometry,region_info,&image->exception);
2700 % The format of the GetImageGeometry method is:
2702 % int GetImageGeometry(Image *image,const char *geometry,
2703 % const unsigned int size_to_fit,RectangeInfo *region_info)
2705 % A description of each parameter follows:
2707 % o flags: Method GetImageGeometry returns a bitmask that indicates
2708 % which of the four values were located in the geometry string.
2710 % o geometry: The geometry (e.g. 100x100+10+10).
2712 % o size_to_fit: A value other than 0 means to scale the region so it
2713 % fits within the specified width and height.
2715 % o region_info: the region as defined by the geometry string with
2716 % respect to the image and its gravity.
2719 MagickExport int GetImageGeometry(Image *image,const char *geometry,
2720 const unsigned int size_to_fit,RectangleInfo *region_info)
2722 if (image->debug != MagickFalse)
2723 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.4");
2724 if (size_to_fit != MagickFalse)
2725 return((int) ParseRegionGeometry(image,geometry,region_info,&image->exception));
2726 return((int) ParsePageGeometry(image,geometry,region_info,&image->exception));
2730 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2734 % G e t I m a g e L i s t %
2738 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2740 % GetImageList() returns an image at the specified position in the list.
2742 % Deprecated, replace with:
2744 % CloneImage(GetImageFromList(images,(ssize_t) offset),0,0,MagickTrue,
2747 % The format of the GetImageList method is:
2749 % Image *GetImageList(const Image *images,const ssize_t offset,
2750 % ExceptionInfo *exception)
2752 % A description of each parameter follows:
2754 % o images: the image list.
2756 % o offset: the position within the list.
2758 % o exception: return any errors or warnings in this structure.
2761 MagickExport Image *GetImageList(const Image *images,const ssize_t offset,
2762 ExceptionInfo *exception)
2767 if (images->debug != MagickFalse)
2768 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
2769 image=CloneImage(GetImageFromList(images,(ssize_t) offset),0,0,MagickTrue,
2775 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2779 % G e t I m a g e L i s t I n d e x %
2783 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2785 % GetImageListIndex() returns the position in the list of the specified
2788 % Deprecated, replace with:
2790 % GetImageIndexInList(images);
2792 % The format of the GetImageListIndex method is:
2794 % ssize_t GetImageListIndex(const Image *images)
2796 % A description of each parameter follows:
2798 % o images: the image list.
2801 MagickExport ssize_t GetImageListIndex(const Image *images)
2803 if (images->debug != MagickFalse)
2804 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
2805 return(GetImageIndexInList(images));
2809 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2813 % G e t I m a g e L i s t S i z e %
2817 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2819 % GetImageListSize() returns the number of images in the list.
2821 % Deprecated, replace with:
2823 % GetImageListLength(images);
2825 % The format of the GetImageListSize method is:
2827 % size_t GetImageListSize(const Image *images)
2829 % A description of each parameter follows:
2831 % o images: the image list.
2834 MagickExport size_t GetImageListSize(const Image *images)
2836 if (images->debug != MagickFalse)
2837 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
2838 return(GetImageListLength(images));
2842 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2846 % G e t I m a g e P i x e l s %
2850 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2852 % GetImagePixels() obtains a pixel region for read/write access. If the
2853 % region is successfully accessed, a pointer to a PixelPacket array
2854 % representing the region is returned, otherwise NULL is returned.
2856 % The returned pointer may point to a temporary working copy of the pixels
2857 % or it may point to the original pixels in memory. Performance is maximized
2858 % if the selected region is part of one row, or one or more full rows, since
2859 % then there is opportunity to access the pixels in-place (without a copy)
2860 % if the image is in RAM, or in a memory-mapped file. The returned pointer
2861 % should *never* be deallocated by the user.
2863 % Pixels accessed via the returned pointer represent a simple array of type
2864 % PixelPacket. If the image type is CMYK or if the storage class is
2865 % PseduoClass, call GetAuthenticIndexQueue() after invoking GetImagePixels()
2866 % to obtain the black color component or colormap indexes (of type IndexPacket)
2867 % corresponding to the region. Once the PixelPacket (and/or IndexPacket)
2868 % array has been updated, the changes must be saved back to the underlying
2869 % image using SyncAuthenticPixels() or they may be lost.
2871 % Deprecated, replace with:
2873 % GetAuthenticPixels(image,x,y,columns,rows,&image->exception);
2875 % The format of the GetImagePixels() method is:
2877 % PixelPacket *GetImagePixels(Image *image,const ssize_t x,const ssize_t y,
2878 % const size_t columns,const size_t rows)
2880 % A description of each parameter follows:
2882 % o image: the image.
2884 % o x,y,columns,rows: These values define the perimeter of a region of
2888 MagickExport PixelPacket *GetImagePixels(Image *image,const ssize_t x,const ssize_t y,
2889 const size_t columns,const size_t rows)
2891 return(GetAuthenticPixels(image,x,y,columns,rows,&image->exception));
2895 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2899 % G e t I n d e x e s %
2903 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2905 % GetIndexes() returns the black channel or the colormap indexes associated
2906 % with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is
2907 % returned if the black channel or colormap indexes are not available.
2909 % Deprecated, replace with:
2911 % GetAuthenticIndexQueue(image);
2913 % The format of the GetIndexes() method is:
2915 % IndexPacket *GetIndexes(const Image *image)
2917 % A description of each parameter follows:
2919 % o indexes: GetIndexes() returns the indexes associated with the last
2920 % call to QueueAuthenticPixels() or GetAuthenticPixels().
2922 % o image: the image.
2925 MagickExport IndexPacket *GetIndexes(const Image *image)
2927 return(GetAuthenticIndexQueue(image));
2931 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2935 + G e t M a g i c k G e o m e t r y %
2939 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2941 % GetMagickGeometry() is similar to GetGeometry() except the returned
2942 % geometry is modified as determined by the meta characters: %, !, <, >,
2945 % Deprecated, replace with:
2947 % ParseMetaGeometry(geometry,x,y,width,height);
2949 % The format of the GetMagickGeometry method is:
2951 % unsigned int GetMagickGeometry(const char *geometry,ssize_t *x,ssize_t *y,
2952 % size_t *width,size_t *height)
2954 % A description of each parameter follows:
2956 % o geometry: Specifies a character string representing the geometry
2959 % o x,y: A pointer to an integer. The x and y offset as determined by
2960 % the geometry specification is returned here.
2962 % o width,height: A pointer to an unsigned integer. The width and height
2963 % as determined by the geometry specification is returned here.
2966 MagickExport unsigned int GetMagickGeometry(const char *geometry,ssize_t *x,
2967 ssize_t *y,size_t *width,size_t *height)
2969 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.3");
2970 return(ParseMetaGeometry(geometry,x,y,width,height));
2974 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2978 % G e t N e x t I m a g e %
2982 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2984 % GetNextImage() returns the next image in a list.
2986 % Deprecated, replace with:
2988 % GetNextImageInList(images);
2990 % The format of the GetNextImage method is:
2992 % Image *GetNextImage(const Image *images)
2994 % A description of each parameter follows:
2996 % o images: the image list.
2999 MagickExport Image *GetNextImage(const Image *images)
3001 if (images->debug != MagickFalse)
3002 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
3003 return(GetNextImageInList(images));
3007 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3011 % G e t N e x t I m a g e A t t r i b u t e %
3015 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3017 % GetNextImageAttribute() gets the next image attribute.
3019 % Deprecated, replace with:
3021 % const char *property;
3022 % property=GetNextImageProperty(image);
3023 % if (property != (const char *) NULL)
3024 % GetImageAttribute(image,property);
3026 % The format of the GetNextImageAttribute method is:
3028 % const ImageAttribute *GetNextImageAttribute(const Image *image)
3030 % A description of each parameter follows:
3032 % o image: the image.
3035 MagickExport const ImageAttribute *GetNextImageAttribute(const Image *image)
3040 property=GetNextImageProperty(image);
3041 if (property == (const char *) NULL)
3042 return((const ImageAttribute *) NULL);
3043 return(GetImageAttribute(image,property));
3047 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3051 % G e t N u m b e r S c e n e s %
3055 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3057 % GetNumberScenes() returns the number of images in the list.
3059 % Deprecated, replace with:
3061 % GetImageListLength(image);
3063 % The format of the GetNumberScenes method is:
3065 % unsigned int GetNumberScenes(const Image *images)
3067 % A description of each parameter follows:
3069 % o images: the image list.
3072 MagickExport unsigned int GetNumberScenes(const Image *image)
3074 if (image->debug != MagickFalse)
3075 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
3076 return((unsigned int) GetImageListLength(image));
3080 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3084 % G e t O n e P i x e l %
3088 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3090 % GetOnePixel() returns a single pixel at the specified (x,y) location.
3091 % The image background color is returned if an error occurs.
3093 % Deprecated, replace with:
3095 % GetOneAuthenticPixel(image,x,y,&pixel,&image->exception);
3097 % The format of the GetOnePixel() method is:
3099 % PixelPacket GetOnePixel(const Image image,const ssize_t x,const ssize_t y)
3101 % A description of each parameter follows:
3103 % o image: the image.
3105 % o x,y: These values define the location of the pixel to return.
3108 MagickExport PixelPacket GetOnePixel(Image *image,const ssize_t x,const ssize_t y)
3113 (void) GetOneAuthenticPixel(image,x,y,&pixel,&image->exception);
3118 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3122 % G e t P i x e l s %
3126 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3128 % GetPixels() returns the pixels associated with the last call to
3129 % QueueAuthenticPixels() or GetAuthenticPixels().
3131 % Deprecated, replace with:
3133 % GetAuthenticPixelQueue(image);
3135 % The format of the GetPixels() method is:
3137 % PixelPacket *GetPixels(const Image image)
3139 % A description of each parameter follows:
3141 % o pixels: GetPixels() returns the pixels associated with the last call
3142 % to QueueAuthenticPixels() or GetAuthenticPixels().
3144 % o image: the image.
3147 MagickExport PixelPacket *GetPixels(const Image *image)
3149 return(GetAuthenticPixelQueue(image));
3153 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3157 % G e t P r e v i o u s I m a g e %
3161 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3163 % GetPreviousImage() returns the previous image in a list.
3165 % Deprecated, replace with:
3167 % GetPreviousImageInList(images));
3169 % The format of the GetPreviousImage method is:
3171 % Image *GetPreviousImage(const Image *images)
3173 % A description of each parameter follows:
3175 % o images: the image list.
3178 MagickExport Image *GetPreviousImage(const Image *images)
3180 if (images->debug != MagickFalse)
3181 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
3182 return(GetPreviousImageInList(images));
3186 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3190 % H S L T r a n s f o r m %
3194 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3196 % HSLTransform() converts a (hue, saturation, lightness) to a (red, green,
3199 % The format of the HSLTransformImage method is:
3201 % void HSLTransform(const double hue,const double saturation,
3202 % const double lightness,Quantum *red,Quantum *green,Quantum *blue)
3204 % A description of each parameter follows:
3206 % o hue, saturation, lightness: A double value representing a
3207 % component of the HSL color space.
3209 % o red, green, blue: A pointer to a pixel component of type Quantum.
3213 static inline MagickRealType HueToRGB(MagickRealType m1,MagickRealType m2,
3220 if ((6.0*hue) < 1.0)
3221 return(m1+6.0*(m2-m1)*hue);
3222 if ((2.0*hue) < 1.0)
3224 if ((3.0*hue) < 2.0)
3225 return(m1+6.0*(m2-m1)*(2.0/3.0-hue));
3229 MagickExport void HSLTransform(const double hue,const double saturation,
3230 const double lightness,Quantum *red,Quantum *green,Quantum *blue)
3240 Convert HSL to RGB colorspace.
3242 assert(red != (Quantum *) NULL);
3243 assert(green != (Quantum *) NULL);
3244 assert(blue != (Quantum *) NULL);
3245 if (lightness <= 0.5)
3246 m2=lightness*(saturation+1.0);
3248 m2=lightness+saturation-lightness*saturation;
3249 m1=2.0*lightness-m2;
3250 r=HueToRGB(m1,m2,hue+1.0/3.0);
3251 g=HueToRGB(m1,m2,hue);
3252 b=HueToRGB(m1,m2,hue-1.0/3.0);
3253 *red=ClampToQuantum((MagickRealType) QuantumRange*r);
3254 *green=ClampToQuantum((MagickRealType) QuantumRange*g);
3255 *blue=ClampToQuantum((MagickRealType) QuantumRange*b);
3259 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3263 % I d e n t i t y A f f i n e %
3267 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3269 % IdentityAffine() initializes the affine transform to the identity matrix.
3271 % The format of the IdentityAffine method is:
3273 % IdentityAffine(AffineMatrix *affine)
3275 % A description of each parameter follows:
3277 % o affine: A pointer the affine transform of type AffineMatrix.
3280 MagickExport void IdentityAffine(AffineMatrix *affine)
3282 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
3283 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
3284 assert(affine != (AffineMatrix *) NULL);
3285 (void) ResetMagickMemory(affine,0,sizeof(AffineMatrix));
3291 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3295 % I n i t i a l i z e M a g i c k %
3299 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3301 % InitializeMagick() initializes the ImageMagick environment.
3303 % Deprecated, replace with:
3305 % MagickCoreGenesis(path,MagickFalse);
3307 % The format of the InitializeMagick function is:
3309 % InitializeMagick(const char *path)
3311 % A description of each parameter follows:
3313 % o path: the execution path of the current ImageMagick client.
3316 MagickExport void InitializeMagick(const char *path)
3318 MagickCoreGenesis(path,MagickFalse);
3322 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3326 % I n t e r p o l a t e P i x e l C o l o r %
3330 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3332 % InterpolatePixelColor() applies bi-linear or tri-linear interpolation
3333 % between a pixel and it's neighbors.
3335 % The format of the InterpolatePixelColor method is:
3337 % MagickPixelPacket InterpolatePixelColor(const Image *image,
3338 % CacheView *view_info,InterpolatePixelMethod method,const double x,
3339 % const double y,ExceptionInfo *exception)
3341 % A description of each parameter follows:
3343 % o image: the image.
3345 % o image_view: the image cache view.
3347 % o type: the type of pixel color interpolation.
3349 % o x,y: A double representing the current (x,y) position of the pixel.
3351 % o exception: return any errors or warnings in this structure.
3355 static inline double MagickMax(const double x,const double y)
3362 static void BicubicInterpolate(const MagickPixelPacket *pixels,const double dx,
3363 MagickPixelPacket *pixel)
3373 p=(pixels[3].red-pixels[2].red)-(pixels[0].red-pixels[1].red);
3374 q=(pixels[0].red-pixels[1].red)-p;
3375 r=pixels[2].red-pixels[0].red;
3377 pixel->red=(dx*dx2*p)+(dx2*q)+(dx*r)+s;
3378 p=(pixels[3].green-pixels[2].green)-(pixels[0].green-pixels[1].green);
3379 q=(pixels[0].green-pixels[1].green)-p;
3380 r=pixels[2].green-pixels[0].green;
3382 pixel->green=(dx*dx2*p)+(dx2*q)+(dx*r)+s;
3383 p=(pixels[3].blue-pixels[2].blue)-(pixels[0].blue-pixels[1].blue);
3384 q=(pixels[0].blue-pixels[1].blue)-p;
3385 r=pixels[2].blue-pixels[0].blue;
3387 pixel->blue=(dx*dx2*p)+(dx2*q)+(dx*r)+s;
3388 p=(pixels[3].opacity-pixels[2].opacity)-(pixels[0].opacity-pixels[1].opacity);
3389 q=(pixels[0].opacity-pixels[1].opacity)-p;
3390 r=pixels[2].opacity-pixels[0].opacity;
3391 s=pixels[1].opacity;
3392 pixel->opacity=(dx*dx2*p)+(dx2*q)+(dx*r)+s;
3393 if (pixel->colorspace == CMYKColorspace)
3395 p=(pixels[3].index-pixels[2].index)-(pixels[0].index-pixels[1].index);
3396 q=(pixels[0].index-pixels[1].index)-p;
3397 r=pixels[2].index-pixels[0].index;
3399 pixel->index=(dx*dx2*p)+(dx2*q)+(dx*r)+s;
3403 static inline MagickRealType CubicWeightingFunction(const MagickRealType x)
3409 alpha=MagickMax(x+2.0,0.0);
3410 gamma=1.0*alpha*alpha*alpha;
3411 alpha=MagickMax(x+1.0,0.0);
3412 gamma-=4.0*alpha*alpha*alpha;
3413 alpha=MagickMax(x+0.0,0.0);
3414 gamma+=6.0*alpha*alpha*alpha;
3415 alpha=MagickMax(x-1.0,0.0);
3416 gamma-=4.0*alpha*alpha*alpha;
3420 static inline double MeshInterpolate(const PointInfo *delta,const double p,
3421 const double x,const double y)
3423 return(delta->x*x+delta->y*y+(1.0-delta->x-delta->y)*p);
3426 static inline ssize_t NearestNeighbor(MagickRealType x)
3429 return((ssize_t) (x+0.5));
3430 return((ssize_t) (x-0.5));
3433 MagickExport MagickPixelPacket InterpolatePixelColor(const Image *image,
3434 CacheView *image_view,const InterpolatePixelMethod method,const double x,
3435 const double y,ExceptionInfo *exception)
3440 register const IndexPacket
3443 register const PixelPacket
3449 assert(image != (Image *) NULL);
3450 assert(image->signature == MagickSignature);
3451 assert(image_view != (CacheView *) NULL);
3452 GetMagickPixelPacket(image,&pixel);
3455 case AverageInterpolatePixel:
3464 p=GetCacheViewVirtualPixels(image_view,(ssize_t) floor(x)-1,(ssize_t)
3465 floor(y)-1,4,4,exception);
3466 if (p == (const PixelPacket *) NULL)
3468 indexes=GetCacheViewVirtualIndexQueue(image_view);
3469 for (i=0; i < 16L; i++)
3471 GetMagickPixelPacket(image,pixels+i);
3472 SetMagickPixelPacket(image,p,indexes+i,pixels+i);
3474 if (image->matte != MagickFalse)
3476 alpha[i]=QuantumScale*((MagickRealType) GetAlphaPixelComponent(p));
3477 pixels[i].red*=alpha[i];
3478 pixels[i].green*=alpha[i];
3479 pixels[i].blue*=alpha[i];
3480 if (image->colorspace == CMYKColorspace)
3481 pixels[i].index*=alpha[i];
3484 gamma=1.0/(fabs((double) gamma) <= MagickEpsilon ? 1.0 : gamma);
3485 pixel.red+=gamma*0.0625*pixels[i].red;
3486 pixel.green+=gamma*0.0625*pixels[i].green;
3487 pixel.blue+=gamma*0.0625*pixels[i].blue;
3488 pixel.opacity+=0.0625*pixels[i].opacity;
3489 if (image->colorspace == CMYKColorspace)
3490 pixel.index+=gamma*0.0625*pixels[i].index;
3495 case BicubicInterpolatePixel:
3507 p=GetCacheViewVirtualPixels(image_view,(ssize_t) floor(x)-1,(ssize_t)
3508 floor(y)-1,4,4,exception);
3509 if (p == (const PixelPacket *) NULL)
3511 indexes=GetCacheViewVirtualIndexQueue(image_view);
3512 for (i=0; i < 16L; i++)
3514 GetMagickPixelPacket(image,pixels+i);
3515 SetMagickPixelPacket(image,p,indexes+i,pixels+i);
3517 if (image->matte != MagickFalse)
3519 alpha[i]=QuantumScale*((MagickRealType) GetAlphaPixelComponent(p));
3520 pixels[i].red*=alpha[i];
3521 pixels[i].green*=alpha[i];
3522 pixels[i].blue*=alpha[i];
3523 if (image->colorspace == CMYKColorspace)
3524 pixels[i].index*=alpha[i];
3529 for (i=0; i < 4L; i++)
3530 BicubicInterpolate(pixels+4*i,delta.x,u+i);
3532 BicubicInterpolate(u,delta.y,&pixel);
3535 case BilinearInterpolatePixel:
3548 p=GetCacheViewVirtualPixels(image_view,(ssize_t) floor(x),(ssize_t)
3549 floor(y),2,2,exception);
3550 if (p == (const PixelPacket *) NULL)
3552 indexes=GetCacheViewVirtualIndexQueue(image_view);
3553 for (i=0; i < 4L; i++)
3555 GetMagickPixelPacket(image,pixels+i);
3556 SetMagickPixelPacket(image,p,indexes+i,pixels+i);
3558 if (image->matte != MagickFalse)
3560 alpha[i]=QuantumScale*((MagickRealType) GetAlphaPixelComponent(p));
3561 pixels[i].red*=alpha[i];
3562 pixels[i].green*=alpha[i];
3563 pixels[i].blue*=alpha[i];
3564 if (image->colorspace == CMYKColorspace)
3565 pixels[i].index*=alpha[i];
3571 gamma=(((1.0-delta.y)*((1.0-delta.x)*alpha[0]+delta.x*alpha[1])+delta.y*
3572 ((1.0-delta.x)*alpha[2]+delta.x*alpha[3])));
3573 gamma=1.0/(fabs((double) gamma) <= MagickEpsilon ? 1.0 : gamma);
3574 pixel.red=gamma*((1.0-delta.y)*((1.0-delta.x)*pixels[0].red+delta.x*
3575 pixels[1].red)+delta.y*((1.0-delta.x)*pixels[2].red+delta.x*
3577 pixel.green=gamma*((1.0-delta.y)*((1.0-delta.x)*pixels[0].green+delta.x*
3578 pixels[1].green)+delta.y*((1.0-delta.x)*pixels[2].green+
3579 delta.x*pixels[3].green));
3580 pixel.blue=gamma*((1.0-delta.y)*((1.0-delta.x)*pixels[0].blue+delta.x*
3581 pixels[1].blue)+delta.y*((1.0-delta.x)*pixels[2].blue+delta.x*
3583 pixel.opacity=((1.0-delta.y)*((1.0-delta.x)*pixels[0].opacity+delta.x*
3584 pixels[1].opacity)+delta.y*((1.0-delta.x)*pixels[2].opacity+delta.x*
3585 pixels[3].opacity));
3586 if (image->colorspace == CMYKColorspace)
3587 pixel.index=gamma*((1.0-delta.y)*((1.0-delta.x)*pixels[0].index+delta.x*
3588 pixels[1].index)+delta.y*((1.0-delta.x)*pixels[2].index+delta.x*
3592 case FilterInterpolatePixel:
3606 geometry.x=(ssize_t) floor(x)-1L;
3607 geometry.y=(ssize_t) floor(y)-1L;
3608 excerpt_image=ExcerptImage(image,&geometry,exception);
3609 if (excerpt_image == (Image *) NULL)
3611 filter_image=ResizeImage(excerpt_image,1,1,image->filter,image->blur,
3613 excerpt_image=DestroyImage(excerpt_image);
3614 if (filter_image == (Image *) NULL)
3616 p=GetVirtualPixels(filter_image,0,0,1,1,exception);
3617 if (p == (const PixelPacket *) NULL)
3619 filter_image=DestroyImage(filter_image);
3622 indexes=GetVirtualIndexQueue(filter_image);
3623 GetMagickPixelPacket(image,pixels);
3624 SetMagickPixelPacket(image,p,indexes,&pixel);
3625 filter_image=DestroyImage(filter_image);
3628 case IntegerInterpolatePixel:
3633 p=GetCacheViewVirtualPixels(image_view,(ssize_t) floor(x),(ssize_t)
3634 floor(y),1,1,exception);
3635 if (p == (const PixelPacket *) NULL)
3637 indexes=GetCacheViewVirtualIndexQueue(image_view);
3638 GetMagickPixelPacket(image,pixels);
3639 SetMagickPixelPacket(image,p,indexes,&pixel);
3642 case MeshInterpolatePixel:
3655 p=GetCacheViewVirtualPixels(image_view,(ssize_t) floor(x),(ssize_t)
3656 floor(y),2,2,exception);
3657 if (p == (const PixelPacket *) NULL)
3659 indexes=GetCacheViewVirtualIndexQueue(image_view);
3660 for (i=0; i < 4L; i++)
3662 GetMagickPixelPacket(image,pixels+i);
3663 SetMagickPixelPacket(image,p,indexes+i,pixels+i);
3665 if (image->matte != MagickFalse)
3667 alpha[i]=QuantumScale*((MagickRealType) GetAlphaPixelComponent(p));
3668 pixels[i].red*=alpha[i];
3669 pixels[i].green*=alpha[i];
3670 pixels[i].blue*=alpha[i];
3671 if (image->colorspace == CMYKColorspace)
3672 pixels[i].index*=alpha[i];
3678 luminance.x=MagickPixelLuminance(pixels+0)-MagickPixelLuminance(pixels+3);
3679 luminance.y=MagickPixelLuminance(pixels+1)-MagickPixelLuminance(pixels+2);
3680 if (fabs(luminance.x) < fabs(luminance.y))
3685 if (delta.x <= delta.y)
3688 Bottom-left triangle (pixel:2, diagonal: 0-3).
3690 delta.y=1.0-delta.y;
3691 gamma=MeshInterpolate(&delta,alpha[2],alpha[3],alpha[0]);
3692 gamma=1.0/(fabs((double) gamma) <= MagickEpsilon ? 1.0 : gamma);
3693 pixel.red=gamma*MeshInterpolate(&delta,pixels[2].red,
3694 pixels[3].red,pixels[0].red);
3695 pixel.green=gamma*MeshInterpolate(&delta,pixels[2].green,
3696 pixels[3].green,pixels[0].green);
3697 pixel.blue=gamma*MeshInterpolate(&delta,pixels[2].blue,
3698 pixels[3].blue,pixels[0].blue);
3699 pixel.opacity=gamma*MeshInterpolate(&delta,pixels[2].opacity,
3700 pixels[3].opacity,pixels[0].opacity);
3701 if (image->colorspace == CMYKColorspace)
3702 pixel.index=gamma*MeshInterpolate(&delta,pixels[2].index,
3703 pixels[3].index,pixels[0].index);
3708 Top-right triangle (pixel:1, diagonal: 0-3).
3710 delta.x=1.0-delta.x;
3711 gamma=MeshInterpolate(&delta,alpha[1],alpha[0],alpha[3]);
3712 gamma=1.0/(fabs((double) gamma) <= MagickEpsilon ? 1.0 : gamma);
3713 pixel.red=gamma*MeshInterpolate(&delta,pixels[1].red,
3714 pixels[0].red,pixels[3].red);
3715 pixel.green=gamma*MeshInterpolate(&delta,pixels[1].green,
3716 pixels[0].green,pixels[3].green);
3717 pixel.blue=gamma*MeshInterpolate(&delta,pixels[1].blue,
3718 pixels[0].blue,pixels[3].blue);
3719 pixel.opacity=gamma*MeshInterpolate(&delta,pixels[1].opacity,
3720 pixels[0].opacity,pixels[3].opacity);
3721 if (image->colorspace == CMYKColorspace)
3722 pixel.index=gamma*MeshInterpolate(&delta,pixels[1].index,
3723 pixels[0].index,pixels[3].index);
3731 if (delta.x <= (1.0-delta.y))
3734 Top-left triangle (pixel 0, diagonal: 1-2).
3736 gamma=MeshInterpolate(&delta,alpha[0],alpha[1],alpha[2]);
3737 gamma=1.0/(fabs((double) gamma) <= MagickEpsilon ? 1.0 : gamma);
3738 pixel.red=gamma*MeshInterpolate(&delta,pixels[0].red,
3739 pixels[1].red,pixels[2].red);
3740 pixel.green=gamma*MeshInterpolate(&delta,pixels[0].green,
3741 pixels[1].green,pixels[2].green);
3742 pixel.blue=gamma*MeshInterpolate(&delta,pixels[0].blue,
3743 pixels[1].blue,pixels[2].blue);
3744 pixel.opacity=gamma*MeshInterpolate(&delta,pixels[0].opacity,
3745 pixels[1].opacity,pixels[2].opacity);
3746 if (image->colorspace == CMYKColorspace)
3747 pixel.index=gamma*MeshInterpolate(&delta,pixels[0].index,
3748 pixels[1].index,pixels[2].index);
3753 Bottom-right triangle (pixel: 3, diagonal: 1-2).
3755 delta.x=1.0-delta.x;
3756 delta.y=1.0-delta.y;
3757 gamma=MeshInterpolate(&delta,alpha[3],alpha[2],alpha[1]);
3758 gamma=1.0/(fabs((double) gamma) <= MagickEpsilon ? 1.0 : gamma);
3759 pixel.red=gamma*MeshInterpolate(&delta,pixels[3].red,
3760 pixels[2].red,pixels[1].red);
3761 pixel.green=gamma*MeshInterpolate(&delta,pixels[3].green,
3762 pixels[2].green,pixels[1].green);
3763 pixel.blue=gamma*MeshInterpolate(&delta,pixels[3].blue,
3764 pixels[2].blue,pixels[1].blue);
3765 pixel.opacity=gamma*MeshInterpolate(&delta,pixels[3].opacity,
3766 pixels[2].opacity,pixels[1].opacity);
3767 if (image->colorspace == CMYKColorspace)
3768 pixel.index=gamma*MeshInterpolate(&delta,pixels[3].index,
3769 pixels[2].index,pixels[1].index);
3774 case NearestNeighborInterpolatePixel:
3779 p=GetCacheViewVirtualPixels(image_view,NearestNeighbor(x),
3780 NearestNeighbor(y),1,1,exception);
3781 if (p == (const PixelPacket *) NULL)
3783 indexes=GetCacheViewVirtualIndexQueue(image_view);
3784 GetMagickPixelPacket(image,pixels);
3785 SetMagickPixelPacket(image,p,indexes,&pixel);
3788 case SplineInterpolatePixel:
3806 p=GetCacheViewVirtualPixels(image_view,(ssize_t) floor(x)-1,(ssize_t)
3807 floor(y)-1,4,4,exception);
3808 if (p == (const PixelPacket *) NULL)
3810 indexes=GetCacheViewVirtualIndexQueue(image_view);
3814 for (i=(-1); i < 3L; i++)
3816 dy=CubicWeightingFunction((MagickRealType) i-delta.y);
3817 for (j=(-1); j < 3L; j++)
3819 GetMagickPixelPacket(image,pixels+n);
3820 SetMagickPixelPacket(image,p,indexes+n,pixels+n);
3822 if (image->matte != MagickFalse)
3824 alpha[n]=QuantumScale*((MagickRealType)
3825 GetAlphaPixelComponent(p));
3826 pixels[n].red*=alpha[n];
3827 pixels[n].green*=alpha[n];
3828 pixels[n].blue*=alpha[n];
3829 if (image->colorspace == CMYKColorspace)
3830 pixels[n].index*=alpha[n];
3832 dx=CubicWeightingFunction(delta.x-(MagickRealType) j);
3834 gamma=1.0/(fabs((double) gamma) <= MagickEpsilon ? 1.0 : gamma);
3835 pixel.red+=gamma*dx*dy*pixels[n].red;
3836 pixel.green+=gamma*dx*dy*pixels[n].green;
3837 pixel.blue+=gamma*dx*dy*pixels[n].blue;
3838 if (image->matte != MagickFalse)
3839 pixel.opacity+=dx*dy*pixels[n].opacity;
3840 if (image->colorspace == CMYKColorspace)
3841 pixel.index+=gamma*dx*dy*pixels[n].index;
3853 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3857 % I n t e r p r e t I m a g e A t t r i b u t e s %
3861 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3863 % InterpretImageAttributes() replaces any embedded formatting characters with
3864 % the appropriate image attribute and returns the translated text.
3866 % Deprecated, replace with:
3868 % InterpretImageProperties(image_info,image,embed_text);
3870 % The format of the InterpretImageAttributes method is:
3872 % char *InterpretImageAttributes(const ImageInfo *image_info,Image *image,
3873 % const char *embed_text)
3875 % A description of each parameter follows:
3877 % o image_info: the image info.
3879 % o image: the image.
3881 % o embed_text: the address of a character string containing the embedded
3882 % formatting characters.
3885 MagickExport char *InterpretImageAttributes(const ImageInfo *image_info,
3886 Image *image,const char *embed_text)
3888 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.3.1");
3889 return(InterpretImageProperties(image_info,image,embed_text));
3893 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3897 + I s S u b i m a g e %
3901 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3903 % IsSubimage() returns MagickTrue if the geometry is a valid subimage
3904 % specification (e.g. [1], [1-9], [1,7,4]).
3906 % The format of the IsSubimage method is:
3908 % unsigned int IsSubimage(const char *geometry,const unsigned int pedantic)
3910 % A description of each parameter follows:
3912 % o geometry: This string is the geometry specification.
3914 % o pedantic: A value other than 0 invokes a more restrictive set of
3915 % conditions for a valid specification (e.g. [1], [1-4], [4-1]).
3918 MagickExport unsigned int IsSubimage(const char *geometry,
3919 const unsigned int pedantic)
3921 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
3922 if (geometry == (const char *) NULL)
3923 return(MagickFalse);
3924 if ((strchr(geometry,'x') != (char *) NULL) ||
3925 (strchr(geometry,'X') != (char *) NULL))
3926 return(MagickFalse);
3927 if ((pedantic != MagickFalse) && (strchr(geometry,',') != (char *) NULL))
3928 return(MagickFalse);
3933 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3937 % L e v e l I m a g e C o l o r s %
3941 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3943 % LevelImageColor() will map the given color to "black" and "white"
3944 % values, limearly spreading out the colors, and level values on a channel by
3945 % channel bases, as per LevelImage(). The given colors allows you to specify
3946 % different level ranges for each of the color channels separately.
3948 % If the boolean 'invert' is set true the image values will modifyed in the
3949 % reverse direction. That is any existing "black" and "white" colors in the
3950 % image will become the color values given, with all other values compressed
3951 % appropriatally. This effectivally maps a greyscale gradient into the given
3954 % Deprecated, replace with:
3956 % LevelColorsImageChannel(image,channel,black_color,white_color,invert);
3958 % The format of the LevelImageColors method is:
3960 % MagickBooleanType LevelImageColors(Image *image,const ChannelType channel,
3961 % const MagickPixelPacket *black_color,const MagickPixelPacket *white_color,
3962 % const MagickBooleanType invert)
3964 % A description of each parameter follows:
3966 % o image: the image.
3968 % o channel: the channel.
3970 % o black_color: The color to map black to/from
3972 % o white_point: The color to map white to/from
3974 % o invert: if true map the colors (levelize), rather than from (level)
3977 MagickBooleanType LevelImageColors(Image *image,const ChannelType channel,
3978 const MagickPixelPacket *black_color,const MagickPixelPacket *white_color,
3979 const MagickBooleanType invert)
3981 return(LevelColorsImageChannel(image,channel,black_color,white_color,invert));
3985 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3989 % L i b e r a t e M e m o r y %
3993 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3995 % LiberateMemory() frees memory that has already been allocated, and NULL's
3996 % the pointer to it.
3998 % The format of the LiberateMemory method is:
4000 % void LiberateMemory(void **memory)
4002 % A description of each parameter follows:
4004 % o memory: A pointer to a block of memory to free for reuse.
4007 MagickExport void LiberateMemory(void **memory)
4009 assert(memory != (void **) NULL);
4010 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
4011 if (*memory == (void *) NULL)
4014 *memory=(void *) NULL;
4018 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4022 % L i b e r a t e S e m a p h o r e I n f o %
4026 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4028 % LiberateSemaphoreInfo() relinquishes a semaphore.
4030 % Deprecated, replace with:
4032 % UnlockSemaphoreInfo(*semaphore_info);
4034 % The format of the LiberateSemaphoreInfo method is:
4036 % LiberateSemaphoreInfo(void **semaphore_info)
4038 % A description of each parameter follows:
4040 % o semaphore_info: Specifies a pointer to an SemaphoreInfo structure.
4043 MagickExport void LiberateSemaphoreInfo(SemaphoreInfo **semaphore_info)
4045 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
4046 UnlockSemaphoreInfo(*semaphore_info);
4050 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4054 % M a g i c k I n c a r n a t e %
4058 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4060 % MagickIncarnate() initializes the ImageMagick environment.
4062 % Deprecated, replace with:
4064 % MagickCoreGenesis(path,MagickFalse);
4066 % The format of the MagickIncarnate function is:
4068 % MagickIncarnate(const char *path)
4070 % A description of each parameter follows:
4072 % o path: the execution path of the current ImageMagick client.
4076 MagickExport void MagickIncarnate(const char *path)
4078 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.1");
4079 MagickCoreGenesis(path,MagickFalse);
4083 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4087 % M a g i c k M o n i t o r %
4091 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4093 % MagickMonitor() calls the monitor handler method with a text string that
4094 % describes the task and a measure of completion. The method returns
4095 % MagickTrue on success otherwise MagickFalse if an error is encountered, e.g.
4096 % if there was a user interrupt.
4098 % The format of the MagickMonitor method is:
4100 % MagickBooleanType MagickMonitor(const char *text,
4101 % const MagickOffsetType offset,const MagickSizeType span,
4102 % void *client_data)
4104 % A description of each parameter follows:
4106 % o offset: the position relative to the span parameter which represents
4107 % how much progress has been made toward completing a task.
4109 % o span: the span relative to completing a task.
4111 % o client_data: the client data.
4114 MagickExport MagickBooleanType MagickMonitor(const char *text,
4115 const MagickOffsetType offset,const MagickSizeType span,
4116 void *magick_unused(client_data))
4124 assert(text != (const char *) NULL);
4125 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",text);
4126 ProcessPendingEvents(text);
4128 exception=AcquireExceptionInfo();
4129 if (monitor_handler != (MonitorHandler) NULL)
4130 status=(*monitor_handler)(text,offset,span,exception);
4131 exception=DestroyExceptionInfo(exception);
4136 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4144 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4146 % MapImage() replaces the colors of an image with the closest color from a
4149 % Deprecated, replace with:
4151 % QuantizeInfo quantize_info;
4152 % GetQuantizeInfo(&quantize_info);
4153 % quantize_info.dither=dither;
4154 % RemapImage(&quantize_info,image,map_image);
4156 % The format of the MapImage method is:
4158 % MagickBooleanType MapImage(Image *image,const Image *map_image,
4159 % const MagickBooleanType dither)
4161 % A description of each parameter follows:
4163 % o image: Specifies a pointer to an Image structure.
4165 % o map_image: the image. Reduce image to a set of colors represented by
4168 % o dither: Set this integer value to something other than zero to
4169 % dither the mapped image.
4172 MagickExport MagickBooleanType MapImage(Image *image,const Image *map_image,
4173 const MagickBooleanType dither)
4179 Initialize color cube.
4181 assert(image != (Image *) NULL);
4182 assert(image->signature == MagickSignature);
4183 if (image->debug != MagickFalse)
4184 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
4185 assert(map_image != (Image *) NULL);
4186 assert(map_image->signature == MagickSignature);
4187 GetQuantizeInfo(&quantize_info);
4188 quantize_info.dither=dither;
4189 return(RemapImage(&quantize_info,image,map_image));
4193 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4197 % M a p I m a g e s %
4201 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4203 % MapImages() replaces the colors of a sequence of images with the closest
4204 % color from a reference image.
4206 % Deprecated, replace with:
4208 % QuantizeInfo quantize_info;
4209 % GetQuantizeInfo(&quantize_info);
4210 % quantize_info.dither=dither;
4211 % RemapImages(&quantize_info,images,map_image);
4213 % The format of the MapImage method is:
4215 % MagickBooleanType MapImages(Image *images,Image *map_image,
4216 % const MagickBooleanType dither)
4218 % A description of each parameter follows:
4220 % o image: Specifies a pointer to a set of Image structures.
4222 % o map_image: the image. Reduce image to a set of colors represented by
4225 % o dither: Set this integer value to something other than zero to
4226 % dither the quantized image.
4229 MagickExport MagickBooleanType MapImages(Image *images,const Image *map_image,
4230 const MagickBooleanType dither)
4235 assert(images != (Image *) NULL);
4236 assert(images->signature == MagickSignature);
4237 if (images->debug != MagickFalse)
4238 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
4239 GetQuantizeInfo(&quantize_info);
4240 quantize_info.dither=dither;
4241 return(RemapImages(&quantize_info,images,map_image));
4245 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4249 % M a t t e F l o o d f i l l I m a g e %
4253 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4255 % MatteFloodfill() changes the transparency value of any pixel that matches
4256 % target and is an immediate neighbor. If the method FillToBorderMethod
4257 % is specified, the transparency value is changed for any neighbor pixel
4258 % that does not match the bordercolor member of image.
4260 % By default target must match a particular pixel transparency exactly.
4261 % However, in many cases two transparency values may differ by a
4262 % small amount. The fuzz member of image defines how much tolerance is
4263 % acceptable to consider two transparency values as the same. For example,
4264 % set fuzz to 10 and the opacity values of 100 and 102 respectively are
4265 % now interpreted as the same value for the purposes of the floodfill.
4267 % The format of the MatteFloodfillImage method is:
4269 % MagickBooleanType MatteFloodfillImage(Image *image,
4270 % const PixelPacket target,const Quantum opacity,const ssize_t x_offset,
4271 % const ssize_t y_offset,const PaintMethod method)
4273 % A description of each parameter follows:
4275 % o image: the image.
4277 % o target: the RGB value of the target color.
4279 % o opacity: the level of transparency: 0 is fully opaque and QuantumRange is
4280 % fully transparent.
4282 % o x,y: the starting location of the operation.
4284 % o method: Choose either FloodfillMethod or FillToBorderMethod.
4287 MagickExport MagickBooleanType MatteFloodfillImage(Image *image,
4288 const PixelPacket target,const Quantum opacity,const ssize_t x_offset,
4289 const ssize_t y_offset,const PaintMethod method)
4297 register SegmentInfo
4312 Check boundary conditions.
4314 assert(image != (Image *) NULL);
4315 assert(image->signature == MagickSignature);
4316 if (image->debug != MagickFalse)
4317 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
4318 if ((x_offset < 0) || (x_offset >= (ssize_t) image->columns))
4319 return(MagickFalse);
4320 if ((y_offset < 0) || (y_offset >= (ssize_t) image->rows))
4321 return(MagickFalse);
4322 if (SetImageStorageClass(image,DirectClass) == MagickFalse)
4323 return(MagickFalse);
4324 if (image->matte == MagickFalse)
4325 (void) SetImageAlphaChannel(image,OpaqueAlphaChannel);
4326 floodplane_image=CloneImage(image,image->columns,image->rows,MagickTrue,
4328 if (floodplane_image == (Image *) NULL)
4329 return(MagickFalse);
4330 (void) SetImageAlphaChannel(floodplane_image,OpaqueAlphaChannel);
4332 Set floodfill color.
4334 segment_stack=(SegmentInfo *) AcquireQuantumMemory(MaxStacksize,
4335 sizeof(*segment_stack));
4336 if (segment_stack == (SegmentInfo *) NULL)
4338 floodplane_image=DestroyImage(floodplane_image);
4339 ThrowBinaryException(ResourceLimitError,"MemoryAllocationFailed",
4343 Push initial segment on stack.
4349 PushSegmentStack(y,x,x,1);
4350 PushSegmentStack(y+1,x,x,-1);
4351 while (s > segment_stack)
4353 register const PixelPacket
4359 register PixelPacket
4363 Pop segment off stack.
4368 offset=(ssize_t) s->y2;
4369 y=(ssize_t) s->y1+offset;
4371 Recolor neighboring pixels.
4373 p=GetVirtualPixels(image,0,y,(size_t) (x1+1),1,&image->exception);
4374 q=GetAuthenticPixels(floodplane_image,0,y,(size_t) (x1+1),1,
4376 if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL))
4380 for (x=x1; x >= 0; x--)
4382 if (q->opacity == (Quantum) TransparentOpacity)
4384 if (method == FloodfillMethod)
4386 if (IsColorSimilar(image,p,&target) == MagickFalse)
4390 if (IsColorSimilar(image,p,&target) != MagickFalse)
4392 q->opacity=(Quantum) TransparentOpacity;
4396 if (SyncAuthenticPixels(floodplane_image,&image->exception) == MagickFalse)
4398 skip=x >= x1 ? MagickTrue : MagickFalse;
4399 if (skip == MagickFalse)
4403 PushSegmentStack(y,start,x1-1,-offset);
4408 if (skip == MagickFalse)
4410 if (x < (ssize_t) image->columns)
4412 p=GetVirtualPixels(image,x,y,image->columns-x,1,
4414 q=GetAuthenticPixels(floodplane_image,x,y,image->columns-x,1,
4416 if ((p == (const PixelPacket *) NULL) ||
4417 (q == (PixelPacket *) NULL))
4419 for ( ; x < (ssize_t) image->columns; x++)
4421 if (q->opacity == (Quantum) TransparentOpacity)
4423 if (method == FloodfillMethod)
4425 if (IsColorSimilar(image,p,&target) == MagickFalse)
4429 if (IsColorSimilar(image,p,&target) != MagickFalse)
4431 q->opacity=(Quantum) TransparentOpacity;
4435 if (SyncAuthenticPixels(floodplane_image,&image->exception) == MagickFalse)
4438 PushSegmentStack(y,start,x-1,offset);
4440 PushSegmentStack(y,x2+1,x-1,-offset);
4446 p=GetVirtualPixels(image,x,y,(size_t) (x2-x+1),1,
4448 q=GetAuthenticPixels(floodplane_image,x,y,(size_t) (x2-x+1),1,
4450 if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL))
4452 for ( ; x <= x2; x++)
4454 if (q->opacity == (Quantum) TransparentOpacity)
4456 if (method == FloodfillMethod)
4458 if (IsColorSimilar(image,p,&target) != MagickFalse)
4462 if (IsColorSimilar(image,p,&target) == MagickFalse)
4471 for (y=0; y < (ssize_t) image->rows; y++)
4473 register const PixelPacket
4479 register PixelPacket
4483 Tile fill color onto floodplane.
4485 p=GetVirtualPixels(floodplane_image,0,y,image->columns,1,
4487 q=GetAuthenticPixels(image,0,y,image->columns,1,&image->exception);
4488 if ((p == (const PixelPacket *) NULL) || (q == (PixelPacket *) NULL))
4490 for (x=0; x < (ssize_t) image->columns; x++)
4492 if (GetOpacityPixelComponent(p) != OpaqueOpacity)
4497 if (SyncAuthenticPixels(image,&image->exception) == MagickFalse)
4500 segment_stack=(SegmentInfo *) RelinquishMagickMemory(segment_stack);
4501 floodplane_image=DestroyImage(floodplane_image);
4502 return(y == (ssize_t) image->rows ? MagickTrue : MagickFalse);
4506 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4510 % M a x i m u m I m a g e s %
4514 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4516 % MaximumImages() returns the maximum intensity of an image sequence.
4518 % Deprecated, replace with:
4520 % EvaluateImages(images,MinEvaluateOperator,exception);
4522 % The format of the MaxImages method is:
4524 % Image *MaximumImages(Image *images,ExceptionInfo *exception)
4526 % A description of each parameter follows:
4528 % o images: the image sequence.
4530 % o exception: return any errors or warnings in this structure.
4533 MagickExport Image *MaximumImages(const Image *images,ExceptionInfo *exception)
4535 return(EvaluateImages(images,MinEvaluateOperator,exception));
4539 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4543 % M i n i m u m I m a g e s %
4547 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4549 % MinimumImages() returns the minimum intensity of an image sequence.
4551 % Deprecated, replace with:
4553 % EvaluateImages(images,MinEvaluateOperator,exception);
4555 % The format of the MinimumImages method is:
4557 % Image *MinimumImages(Image *images,ExceptionInfo *exception)
4559 % A description of each parameter follows:
4561 % o images: the image sequence.
4563 % o exception: return any errors or warnings in this structure.
4566 MagickExport Image *MinimumImages(const Image *images,ExceptionInfo *exception)
4568 return(EvaluateImages(images,MinEvaluateOperator,exception));
4572 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4576 % M e d i a n F i l t e r I m a g e %
4580 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4582 % MedianFilterImage() applies a digital filter that improves the quality
4583 % of a noisy image. Each pixel is replaced by the median in a set of
4584 % neighboring pixels as defined by radius.
4586 % The algorithm was contributed by Mike Edmonds and implements an insertion
4587 % sort for selecting median color-channel values. For more on this algorithm
4588 % see "Skip Lists: A probabilistic Alternative to Balanced Trees" by William
4589 % Pugh in the June 1990 of Communications of the ACM.
4591 % The format of the MedianFilterImage method is:
4593 % Image *MedianFilterImage(const Image *image,const double radius,
4594 % ExceptionInfo *exception)
4596 % A description of each parameter follows:
4598 % o image: the image.
4600 % o radius: the radius of the pixel neighborhood.
4602 % o exception: return any errors or warnings in this structure.
4605 MagickExport Image *MedianFilterImage(const Image *image,const double radius,
4606 ExceptionInfo *exception)
4611 median_image=StatisticImage(image,MedianStatistic,(size_t) radius,(size_t)
4613 return(median_image);
4617 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4621 % M o d e I m a g e %
4625 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4627 % ModeImage() makes each pixel the 'predominate color' of the neighborhood
4628 % of the specified radius.
4630 % The format of the ModeImage method is:
4632 % Image *ModeImage(const Image *image,const double radius,
4633 % ExceptionInfo *exception)
4635 % A description of each parameter follows:
4637 % o image: the image.
4639 % o radius: the radius of the pixel neighborhood.
4641 % o exception: return any errors or warnings in this structure.
4644 MagickExport Image *ModeImage(const Image *image,const double radius,
4645 ExceptionInfo *exception)
4650 mode_image=StatisticImage(image,ModeStatistic,(size_t) radius,(size_t) radius,
4656 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4660 % M o s a i c I m a g e s %
4664 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4666 % MosaicImages() Obsolete Function: Use MergeImageLayers() instead.
4668 % Deprecated, replace with:
4670 % MergeImageLayers(image,MosaicLayer,exception);
4672 % The format of the MosaicImage method is:
4674 % Image *MosaicImages(const Image *image,ExceptionInfo *exception)
4676 % A description of each parameter follows:
4678 % o image: the image list to be composited together
4680 % o exception: return any errors or warnings in this structure.
4683 MagickExport Image *MosaicImages(Image *image,ExceptionInfo *exception)
4685 return(MergeImageLayers(image,MosaicLayer,exception));
4689 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4693 % O p a q u e I m a g e %
4697 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4699 % OpaqueImage() changes any pixel that matches color with the color
4702 % By default color must match a particular pixel color exactly. However,
4703 % in many cases two colors may differ by a small amount. Fuzz defines
4704 % how much tolerance is acceptable to consider two colors as the same.
4705 % For example, set fuzz to 10 and the color red at intensities of 100 and
4706 % 102 respectively are now interpreted as the same color.
4708 % The format of the OpaqueImage method is:
4710 % MagickBooleanType OpaqueImage(Image *image,
4711 % const PixelPacket *target,const PixelPacket fill)
4713 % A description of each parameter follows:
4715 % o image: the image.
4717 % o target: the RGB value of the target color.
4719 % o fill: the replacement color.
4722 MagickExport MagickBooleanType OpaqueImage(Image *image,
4723 const PixelPacket target,const PixelPacket fill)
4725 #define OpaqueImageTag "Opaque/Image"
4737 Make image color opaque.
4739 assert(image != (Image *) NULL);
4740 assert(image->signature == MagickSignature);
4741 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.1.0");
4742 if (image->debug != MagickFalse)
4743 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
4744 switch (image->storage_class)
4750 Make DirectClass image opaque.
4752 for (y=0; y < (ssize_t) image->rows; y++)
4757 register PixelPacket
4760 q=GetAuthenticPixels(image,0,y,image->columns,1,&image->exception);
4761 if (q == (PixelPacket *) NULL)
4763 for (x=0; x < (ssize_t) image->columns; x++)
4765 if (IsColorSimilar(image,q,&target) != MagickFalse)
4769 if (SyncAuthenticPixels(image,&image->exception) == MagickFalse)
4771 proceed=SetImageProgress(image,OpaqueImageTag,(MagickOffsetType) y,
4773 if (proceed == MagickFalse)
4781 Make PseudoClass image opaque.
4783 for (i=0; i < (ssize_t) image->colors; i++)
4785 if (IsColorSimilar(image,&image->colormap[i],&target) != MagickFalse)
4786 image->colormap[i]=fill;
4788 if (fill.opacity != OpaqueOpacity)
4790 for (y=0; y < (ssize_t) image->rows; y++)
4795 register PixelPacket
4798 q=GetAuthenticPixels(image,0,y,image->columns,1,&image->exception);
4799 if (q == (PixelPacket *) NULL)
4801 for (x=0; x < (ssize_t) image->columns; x++)
4803 if (IsColorSimilar(image,q,&target) != MagickFalse)
4804 q->opacity=fill.opacity;
4807 if (SyncAuthenticPixels(image,&image->exception) == MagickFalse)
4811 (void) SyncImage(image);
4815 if (fill.opacity != OpaqueOpacity)
4816 image->matte=MagickTrue;
4821 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4825 % O p e n C a c h e V i e w %
4829 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4831 % OpenCacheView() opens a view into the pixel cache, using the
4832 % VirtualPixelMethod that is defined within the given image itself.
4834 % Deprecated, replace with:
4836 % AcquireCacheView(image);
4838 % The format of the OpenCacheView method is:
4840 % CacheView *OpenCacheView(const Image *image)
4842 % A description of each parameter follows:
4844 % o image: the image.
4847 MagickExport CacheView *OpenCacheView(const Image *image)
4849 return(AcquireCacheView(image));
4853 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4857 % P a i n t F l o o d f i l l I m a g e %
4861 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4863 % PaintFloodfill() changes the color value of any pixel that matches
4864 % target and is an immediate neighbor. If the method FillToBorderMethod is
4865 % specified, the color value is changed for any neighbor pixel that does not
4866 % match the bordercolor member of image.
4868 % By default target must match a particular pixel color exactly.
4869 % However, in many cases two colors may differ by a small amount. The
4870 % fuzz member of image defines how much tolerance is acceptable to
4871 % consider two colors as the same. For example, set fuzz to 10 and the
4872 % color red at intensities of 100 and 102 respectively are now
4873 % interpreted as the same color for the purposes of the floodfill.
4875 % Deprecated, replace with:
4877 % FloodfillPaintImage(image,channel,draw_info,target,x,y,
4878 % method == FloodfillMethod ? MagickFalse : MagickTrue);
4880 % The format of the PaintFloodfillImage method is:
4882 % MagickBooleanType PaintFloodfillImage(Image *image,
4883 % const ChannelType channel,const MagickPixelPacket target,const ssize_t x,
4884 % const ssize_t y,const DrawInfo *draw_info,const PaintMethod method)
4886 % A description of each parameter follows:
4888 % o image: the image.
4890 % o channel: the channel(s).
4892 % o target: the RGB value of the target color.
4894 % o x,y: the starting location of the operation.
4896 % o draw_info: the draw info.
4898 % o method: Choose either FloodfillMethod or FillToBorderMethod.
4901 MagickExport MagickBooleanType PaintFloodfillImage(Image *image,
4902 const ChannelType channel,const MagickPixelPacket *target,const ssize_t x,
4903 const ssize_t y,const DrawInfo *draw_info,const PaintMethod method)
4908 status=FloodfillPaintImage(image,channel,draw_info,target,x,y,
4909 method == FloodfillMethod ? MagickFalse : MagickTrue);
4914 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4917 % P a i n t O p a q u e I m a g e %
4920 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4922 % PaintOpaqueImage() changes any pixel that matches color with the color
4925 % By default color must match a particular pixel color exactly. However,
4926 % in many cases two colors may differ by a small amount. Fuzz defines
4927 % how much tolerance is acceptable to consider two colors as the same.
4928 % For example, set fuzz to 10 and the color red at intensities of 100 and
4929 % 102 respectively are now interpreted as the same color.
4931 % Deprecated, replace with:
4933 % OpaquePaintImageChannel(image,DefaultChannels,target,fill,MagickFalse);
4934 % OpaquePaintImageChannel(image,channel,target,fill,MagickFalse);
4936 % The format of the PaintOpaqueImage method is:
4938 % MagickBooleanType PaintOpaqueImage(Image *image,
4939 % const PixelPacket *target,const PixelPacket *fill)
4940 % MagickBooleanType PaintOpaqueImageChannel(Image *image,
4941 % const ChannelType channel,const PixelPacket *target,
4942 % const PixelPacket *fill)
4944 % A description of each parameter follows:
4946 % o image: the image.
4948 % o channel: the channel(s).
4950 % o target: the RGB value of the target color.
4952 % o fill: the replacement color.
4956 MagickExport MagickBooleanType PaintOpaqueImage(Image *image,
4957 const MagickPixelPacket *target,const MagickPixelPacket *fill)
4962 status=OpaquePaintImageChannel(image,DefaultChannels,target,fill,MagickFalse);
4966 MagickExport MagickBooleanType PaintOpaqueImageChannel(Image *image,
4967 const ChannelType channel,const MagickPixelPacket *target,
4968 const MagickPixelPacket *fill)
4970 return(OpaquePaintImageChannel(image,channel,target,fill,MagickFalse));
4974 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4978 % P a i n t T r a n s p a r e n t I m a g e %
4982 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4984 % PaintTransparentImage() changes the opacity value associated with any pixel
4985 % that matches color to the value defined by opacity.
4987 % By default color must match a particular pixel color exactly. However,
4988 % in many cases two colors may differ by a small amount. Fuzz defines
4989 % how much tolerance is acceptable to consider two colors as the same.
4990 % For example, set fuzz to 10 and the color red at intensities of 100 and
4991 % 102 respectively are now interpreted as the same color.
4993 % Deprecated, replace with:
4995 % TransparentPaintImage(image,target,opacity,MagickFalse);
4997 % The format of the PaintTransparentImage method is:
4999 % MagickBooleanType PaintTransparentImage(Image *image,
5000 % const MagickPixelPacket *target,const Quantum opacity)
5002 % A description of each parameter follows:
5004 % o image: the image.
5006 % o target: the RGB value of the target color.
5008 % o opacity: the replacement opacity value.
5011 MagickExport MagickBooleanType PaintTransparentImage(Image *image,
5012 const MagickPixelPacket *target,const Quantum opacity)
5014 return(TransparentPaintImage(image,target,opacity,MagickFalse));
5018 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5022 + P a r s e I m a g e G e o m e t r y %
5026 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5028 % ParseImageGeometry() is similar to GetGeometry() except the returned
5029 % geometry is modified as determined by the meta characters: %, !, <,
5032 % Deprecated, replace with:
5034 % ParseMetaGeometry(geometry,x,y,width,height);
5036 % The format of the ParseImageGeometry method is:
5038 % int ParseImageGeometry(char *geometry,ssize_t *x,ssize_t *y,
5039 % size_t *width,size_t *height)
5041 % A description of each parameter follows:
5043 % o flags: Method ParseImageGeometry returns a bitmask that indicates
5044 % which of the four values were located in the geometry string.
5046 % o image_geometry: Specifies a character string representing the geometry
5049 % o x,y: A pointer to an integer. The x and y offset as determined by
5050 % the geometry specification is returned here.
5052 % o width,height: A pointer to an unsigned integer. The width and height
5053 % as determined by the geometry specification is returned here.
5056 MagickExport int ParseImageGeometry(const char *geometry,ssize_t *x,ssize_t *y,
5057 size_t *width,size_t *height)
5059 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.1");
5060 return((int) ParseMetaGeometry(geometry,x,y,width,height));
5064 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5068 % P a r s e S i z e G e o m e t r y %
5072 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5074 % ParseSizeGeometry() returns a region as defined by the geometry string with
5075 % respect to the image dimensions and aspect ratio.
5077 % Deprecated, replace with:
5079 % ParseMetaGeometry(geometry,®ion_info->x,®ion_info->y,
5080 % ®ion_info->width,®ion_info->height);
5082 % The format of the ParseSizeGeometry method is:
5084 % MagickStatusType ParseSizeGeometry(const Image *image,
5085 % const char *geometry,RectangeInfo *region_info)
5087 % A description of each parameter follows:
5089 % o geometry: The geometry (e.g. 100x100+10+10).
5091 % o region_info: the region as defined by the geometry string.
5094 MagickExport MagickStatusType ParseSizeGeometry(const Image *image,
5095 const char *geometry,RectangleInfo *region_info)
5100 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.4.7");
5101 SetGeometry(image,region_info);
5102 flags=ParseMetaGeometry(geometry,®ion_info->x,®ion_info->y,
5103 ®ion_info->width,®ion_info->height);
5108 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5112 % P o p I m a g e L i s t %
5116 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5118 % PopImageList() removes the last image in the list.
5120 % Deprecated, replace with:
5122 % RemoveLastImageFromList(images);
5124 % The format of the PopImageList method is:
5126 % Image *PopImageList(Image **images)
5128 % A description of each parameter follows:
5130 % o images: the image list.
5133 MagickExport Image *PopImageList(Image **images)
5135 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
5136 return(RemoveLastImageFromList(images));
5140 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5144 % P o p I m a g e P i x e l s %
5148 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5150 % PopImagePixels() transfers one or more pixel components from the image pixel
5151 % cache to a user supplied buffer. The pixels are returned in network byte
5152 % order. MagickTrue is returned if the pixels are successfully transferred,
5153 % otherwise MagickFalse.
5155 % The format of the PopImagePixels method is:
5157 % size_t PopImagePixels(Image *,const QuantumType quantum,
5158 % unsigned char *destination)
5160 % A description of each parameter follows:
5162 % o image: the image.
5164 % o quantum: Declare which pixel components to transfer (RGB, RGBA, etc).
5166 % o destination: The components are transferred to this buffer.
5169 MagickExport size_t PopImagePixels(Image *image,const QuantumType quantum,
5170 unsigned char *destination)
5178 quantum_info=AcquireQuantumInfo((const ImageInfo *) NULL,image);
5179 if (quantum_info == (QuantumInfo *) NULL)
5181 length=ExportQuantumPixels(image,(const CacheView *) NULL,quantum_info,
5182 quantum,destination,&image->exception);
5183 quantum_info=DestroyQuantumInfo(quantum_info);
5188 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5192 % P o s t s c r i p t G e o m e t r y %
5196 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5198 % PostscriptGeometry() replaces any page mneumonic with the equivalent size in
5201 % Deprecated, replace with:
5203 % GetPageGeometry(page);
5205 % The format of the PostscriptGeometry method is:
5207 % char *PostscriptGeometry(const char *page)
5209 % A description of each parameter follows.
5211 % o page: Specifies a pointer to an array of characters.
5212 % The string is either a Postscript page name (e.g. A4) or a postscript
5213 % page geometry (e.g. 612x792+36+36).
5216 MagickExport char *PostscriptGeometry(const char *page)
5218 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.1");
5219 return(GetPageGeometry(page));
5223 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5227 % P u s h I m a g e L i s t %
5231 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5233 % PushImageList() adds an image to the end of the list.
5235 % Deprecated, replace with:
5237 % AppendImageToList(images,CloneImageList(image,exception));
5239 % The format of the PushImageList method is:
5241 % unsigned int PushImageList(Image *images,const Image *image,
5242 % ExceptionInfo *exception)
5244 % A description of each parameter follows:
5246 % o images: the image list.
5248 % o image: the image.
5250 % o exception: return any errors or warnings in this structure.
5253 MagickExport unsigned int PushImageList(Image **images,const Image *image,
5254 ExceptionInfo *exception)
5256 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
5257 AppendImageToList(images,CloneImageList(image,exception));
5262 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5266 % P u s h I m a g e P i x e l s %
5270 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5272 % PushImagePixels() transfers one or more pixel components from a user
5273 % supplied buffer into the image pixel cache of an image. The pixels are
5274 % expected in network byte order. It returns MagickTrue if the pixels are
5275 % successfully transferred, otherwise MagickFalse.
5277 % The format of the PushImagePixels method is:
5279 % size_t PushImagePixels(Image *image,const QuantumType quantum,
5280 % const unsigned char *source)
5282 % A description of each parameter follows:
5284 % o image: the image.
5286 % o quantum: Declare which pixel components to transfer (red, green, blue,
5287 % opacity, RGB, or RGBA).
5289 % o source: The pixel components are transferred from this buffer.
5292 MagickExport size_t PushImagePixels(Image *image,const QuantumType quantum,
5293 const unsigned char *source)
5301 quantum_info=AcquireQuantumInfo((const ImageInfo *) NULL,image);
5302 if (quantum_info == (QuantumInfo *) NULL)
5304 length=ImportQuantumPixels(image,(CacheView *) NULL,quantum_info,quantum,
5305 source,&image->exception);
5306 quantum_info=DestroyQuantumInfo(quantum_info);
5311 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5315 % Q u a n t i z a t i o n E r r o r %
5319 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5321 % QuantizationError() measures the difference between the original and
5322 % quantized images. This difference is the total quantization error. The
5323 % error is computed by summing over all pixels in an image the distance
5324 % squared in RGB space between each reference pixel value and its quantized
5325 % value. These values are computed:
5327 % o mean_error_per_pixel: This value is the mean error for any single
5328 % pixel in the image.
5330 % o normalized_mean_square_error: This value is the normalized mean
5331 % quantization error for any single pixel in the image. This distance
5332 % measure is normalized to a range between 0 and 1. It is independent
5333 % of the range of red, green, and blue values in the image.
5335 % o normalized_maximum_square_error: Thsi value is the normalized
5336 % maximum quantization error for any single pixel in the image. This
5337 % distance measure is normalized to a range between 0 and 1. It is
5338 % independent of the range of red, green, and blue values in your image.
5340 % Deprecated, replace with:
5342 % GetImageQuantizeError(image);
5344 % The format of the QuantizationError method is:
5346 % unsigned int QuantizationError(Image *image)
5348 % A description of each parameter follows.
5350 % o image: Specifies a pointer to an Image structure; returned from
5354 MagickExport unsigned int QuantizationError(Image *image)
5356 if (image->debug != MagickFalse)
5357 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.3");
5358 return(GetImageQuantizeError(image));
5362 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5365 % R a n d o m C h a n n e l T h r e s h o l d I m a g e %
5369 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5371 % RandomChannelThresholdImage() changes the value of individual pixels based
5372 % on the intensity of each pixel compared to a random threshold. The result
5373 % is a low-contrast, two color image.
5375 % The format of the RandomChannelThresholdImage method is:
5377 % unsigned int RandomChannelThresholdImage(Image *image,
5378 % const char *channel, const char *thresholds,
5379 % ExceptionInfo *exception)
5381 % A description of each parameter follows:
5383 % o image: the image.
5385 % o channel: the channel or channels to be thresholded.
5387 % o thresholds: a geometry string containing LOWxHIGH thresholds.
5388 % If the string contains 2x2, 3x3, or 4x4, then an ordered
5389 % dither of order 2, 3, or 4 will be performed instead.
5391 % o exception: return any errors or warnings in this structure.
5394 MagickExport unsigned int RandomChannelThresholdImage(Image *image,const char
5395 *channel,const char *thresholds,ExceptionInfo *exception)
5397 #define RandomChannelThresholdImageText " RandomChannelThreshold image... "
5410 static MagickRealType
5411 o2[4]={0.2f, 0.6f, 0.8f, 0.4f},
5412 o3[9]={0.1f, 0.6f, 0.3f, 0.7f, 0.5f, 0.8f, 0.4f, 0.9f, 0.2f},
5413 o4[16]={0.1f, 0.7f, 1.1f, 0.3f, 1.0f, 0.5f, 1.5f, 0.8f, 1.4f, 1.6f, 0.6f,
5414 1.2f, 0.4f, 0.9f, 1.3f, 0.2f},
5423 assert(image != (Image *) NULL);
5424 assert(image->signature == MagickSignature);
5425 if (image->debug != MagickFalse)
5426 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
5427 assert(exception != (ExceptionInfo *) NULL);
5428 assert(exception->signature == MagickSignature);
5429 if (image->debug != MagickFalse)
5430 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
5431 if (thresholds == (const char *) NULL)
5433 if (LocaleCompare(thresholds,"2x2") == 0)
5436 if (LocaleCompare(thresholds,"3x3") == 0)
5439 if (LocaleCompare(thresholds,"4x4") == 0)
5446 count=(ssize_t) sscanf(thresholds,"%lf[/x%%]%lf",&lower_threshold,
5448 if (strchr(thresholds,'%') != (char *) NULL)
5450 upper_threshold*=(.01*QuantumRange);
5451 lower_threshold*=(.01*QuantumRange);
5454 upper_threshold=(MagickRealType) QuantumRange-lower_threshold;
5456 if (image->debug != MagickFalse)
5457 (void) LogMagickEvent(TransformEvent,GetMagickModule(),
5458 " RandomChannelThresholdImage: channel type=%s",channel);
5459 if (image->debug != MagickFalse)
5460 (void) LogMagickEvent(TransformEvent,GetMagickModule(),
5461 " Thresholds: %s (%fx%f)",thresholds,lower_threshold,upper_threshold);
5462 if (LocaleCompare(channel,"all") == 0 ||
5463 LocaleCompare(channel,"intensity") == 0)
5464 if (AcquireImageColormap(image,2) == MagickFalse)
5465 ThrowBinaryException(ResourceLimitError,"MemoryAllocationFailed",
5467 random_info=AcquireRandomInfo();
5468 for (y=0; y < (ssize_t) image->rows; y++)
5473 register IndexPacket
5477 register PixelPacket
5480 q=GetAuthenticPixels(image,0,y,image->columns,1,exception);
5481 if (q == (PixelPacket *) NULL)
5483 if (LocaleCompare(channel,"all") == 0 ||
5484 LocaleCompare(channel,"intensity") == 0)
5486 indexes=GetAuthenticIndexQueue(image);
5487 for (x=0; x < (ssize_t) image->columns; x++)
5492 intensity=(MagickRealType) PixelIntensityToQuantum(q);
5495 if (intensity < lower_threshold)
5496 threshold=lower_threshold;
5497 else if (intensity > upper_threshold)
5498 threshold=upper_threshold;
5500 threshold=(MagickRealType) (QuantumRange*
5501 GetPseudoRandomValue(random_info));
5503 else if (order == 2)
5504 threshold=(MagickRealType) QuantumRange*o2[(x%2)+2*(y%2)];
5505 else if (order == 3)
5506 threshold=(MagickRealType) QuantumRange*o3[(x%3)+3*(y%3)];
5507 else if (order == 4)
5508 threshold=(MagickRealType) QuantumRange*o4[(x%4)+4*(y%4)];
5509 index=(IndexPacket) (intensity <= threshold ? 0 : 1);
5510 SetIndexPixelComponent(indexes+x,index);
5511 SetRedPixelComponent(q,image->colormap[(ssize_t) index].red);
5512 SetGreenPixelComponent(q,image->colormap[(ssize_t) index].green);
5513 SetBluePixelComponent(q,image->colormap[(ssize_t) index].blue);
5517 if (LocaleCompare(channel,"opacity") == 0 ||
5518 LocaleCompare(channel,"all") == 0 ||
5519 LocaleCompare(channel,"matte") == 0)
5521 if (image->matte != MagickFalse)
5522 for (x=0; x < (ssize_t) image->columns; x++)
5526 if ((MagickRealType) q->opacity < lower_threshold)
5527 threshold=lower_threshold;
5528 else if ((MagickRealType) q->opacity > upper_threshold)
5529 threshold=upper_threshold;
5531 threshold=(MagickRealType) (QuantumRange*
5532 GetPseudoRandomValue(random_info));
5534 else if (order == 2)
5535 threshold=(MagickRealType) QuantumRange*o2[(x%2)+2*(y%2)];
5536 else if (order == 3)
5537 threshold=(MagickRealType) QuantumRange*o3[(x%3)+3*(y%3)];
5538 else if (order == 4)
5539 threshold=(MagickRealType) QuantumRange*o4[(x%4)+4*(y%4)]/1.7;
5540 SetOpacityPixelComponent(q,(MagickRealType) q->opacity <=
5541 threshold ? 0 : QuantumRange);
5547 /* To Do: red, green, blue, cyan, magenta, yellow, black */
5548 if (LocaleCompare(channel,"intensity") != 0)
5549 ThrowBinaryException(OptionError,"UnrecognizedChannelType",
5552 if (SyncAuthenticPixels(image,exception) == MagickFalse)
5555 random_info=DestroyRandomInfo(random_info);
5560 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5564 % R e a c q u i r e M e m o r y %
5568 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5570 % ReacquireMemory() changes the size of the memory and returns a pointer to
5571 % the (possibly moved) block. The contents will be unchanged up to the
5572 % lesser of the new and old sizes.
5574 % The format of the ReacquireMemory method is:
5576 % void ReacquireMemory(void **memory,const size_t size)
5578 % A description of each parameter follows:
5580 % o memory: A pointer to a memory allocation. On return the pointer
5581 % may change but the contents of the original allocation will not.
5583 % o size: the new size of the allocated memory.
5586 MagickExport void ReacquireMemory(void **memory,const size_t size)
5591 assert(memory != (void **) NULL);
5592 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
5593 if (*memory == (void *) NULL)
5595 *memory=AcquireMagickMemory(size);
5598 allocation=realloc(*memory,size);
5599 if (allocation == (void *) NULL)
5600 *memory=RelinquishMagickMemory(*memory);
5605 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5609 % R e c o l o r I m a g e %
5613 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5615 % RecolorImage() apply color transformation to an image. The method permits
5616 % saturation changes, hue rotation, luminance to alpha, and various other
5617 % effects. Although variable-sized transformation matrices can be used,
5618 % typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA
5619 % (or RGBA with offsets). The matrix is similar to those used by Adobe Flash
5620 % except offsets are in column 6 rather than 5 (in support of CMYKA images)
5621 % and offsets are normalized (divide Flash offset by 255).
5623 % The format of the RecolorImage method is:
5625 % Image *RecolorImage(const Image *image,const size_t order,
5626 % const double *color_matrix,ExceptionInfo *exception)
5628 % A description of each parameter follows:
5630 % o image: the image.
5632 % o order: the number of columns and rows in the recolor matrix.
5634 % o color_matrix: An array of double representing the recolor matrix.
5636 % o exception: return any errors or warnings in this structure.
5639 MagickExport Image *RecolorImage(const Image *image,const size_t order,
5640 const double *color_matrix,ExceptionInfo *exception)
5648 kernel_info=AcquireKernelInfo("1");
5649 if (kernel_info == (KernelInfo *) NULL)
5650 return((Image *) NULL);
5651 kernel_info->width=order;
5652 kernel_info->height=order;
5653 kernel_info->values=(double *) color_matrix;
5654 recolor_image=ColorMatrixImage(image,kernel_info,exception);
5655 kernel_info->values=(double *) NULL;
5656 kernel_info=DestroyKernelInfo(kernel_info);
5657 return(recolor_image);
5661 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5665 % R e d u c e N o i s e I m a g e %
5669 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5671 % ReduceNoiseImage() smooths the contours of an image while still preserving
5672 % edge information. The algorithm works by replacing each pixel with its
5673 % neighbor closest in value. A neighbor is defined by radius. Use a radius
5674 % of 0 and ReduceNoise() selects a suitable radius for you.
5676 % The format of the ReduceNoiseImage method is:
5678 % Image *ReduceNoiseImage(const Image *image,const double radius,
5679 % ExceptionInfo *exception)
5681 % A description of each parameter follows:
5683 % o image: the image.
5685 % o radius: the radius of the pixel neighborhood.
5687 % o exception: return any errors or warnings in this structure.
5690 MagickExport Image *ReduceNoiseImage(const Image *image,const double radius,
5691 ExceptionInfo *exception)
5696 reduce_image=StatisticImage(image,NonpeakStatistic,(size_t) radius,(size_t)
5698 return(reduce_image);
5702 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5706 % R e s e t I m a g e A t t r i b u t e I t e r a t o r %
5710 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5712 % ResetImageAttributeIterator() resets the image attributes iterator. Use it
5713 % in conjunction with GetNextImageAttribute() to iterate over all the values
5714 % associated with an image.
5716 % Deprecated, replace with:
5718 % ResetImagePropertyIterator(image);
5720 % The format of the ResetImageAttributeIterator method is:
5722 % ResetImageAttributeIterator(const ImageInfo *image)
5724 % A description of each parameter follows:
5726 % o image: the image.
5729 MagickExport void ResetImageAttributeIterator(const Image *image)
5731 ResetImagePropertyIterator(image);
5735 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5739 % S e t C a c h e V i e w P i x e l s %
5743 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5745 % SetCacheViewPixels() gets pixels from the in-memory or disk pixel cache as
5746 % defined by the geometry parameters. A pointer to the pixels is returned
5747 % if the pixels are transferred, otherwise a NULL is returned.
5749 % Deprecated, replace with:
5751 % QueueCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
5752 % GetCacheViewException(cache_view));
5754 % The format of the SetCacheViewPixels method is:
5756 % PixelPacket *SetCacheViewPixels(CacheView *cache_view,const ssize_t x,
5757 % const ssize_t y,const size_t columns,const size_t rows)
5759 % A description of each parameter follows:
5761 % o cache_view: the cache view.
5763 % o x,y,columns,rows: These values define the perimeter of a region of
5767 MagickExport PixelPacket *SetCacheViewPixels(CacheView *cache_view,const ssize_t x,
5768 const ssize_t y,const size_t columns,const size_t rows)
5773 pixels=QueueCacheViewAuthenticPixels(cache_view,x,y,columns,rows,
5774 GetCacheViewException(cache_view));
5779 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5783 + S e t C a c h e T h e s h o l d %
5787 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5789 % SetCacheThreshold() sets the amount of free memory allocated for the pixel
5790 % cache. Once this threshold is exceeded, all subsequent pixels cache
5791 % operations are to/from disk.
5793 % The format of the SetCacheThreshold() method is:
5795 % void SetCacheThreshold(const size_t threshold)
5797 % A description of each parameter follows:
5799 % o threshold: the number of megabytes of memory available to the pixel
5803 MagickExport void SetCacheThreshold(const size_t size)
5805 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.1");
5806 (void) SetMagickResourceLimit(MemoryResource,size*1024*1024);
5807 (void) SetMagickResourceLimit(MapResource,2*size*1024*1024);
5811 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5815 % S e t E x c e p t i o n I n f o %
5819 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5821 % SetExceptionInfo() sets the exception severity.
5823 % The format of the SetExceptionInfo method is:
5825 % MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
5826 % ExceptionType severity)
5828 % A description of each parameter follows:
5830 % o exception: the exception info.
5832 % o severity: the exception severity.
5835 MagickExport MagickBooleanType SetExceptionInfo(ExceptionInfo *exception,
5836 ExceptionType severity)
5838 assert(exception != (ExceptionInfo *) NULL);
5839 ClearMagickException(exception);
5840 exception->severity=severity;
5845 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5853 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5855 % SetImage() sets the red, green, and blue components of each pixel to
5856 % the image background color and the opacity component to the specified
5857 % level of transparency. The background color is defined by the
5858 % background_color member of the image.
5860 % The format of the SetImage method is:
5862 % void SetImage(Image *image,const Quantum opacity)
5864 % A description of each parameter follows:
5866 % o image: the image.
5868 % o opacity: Set each pixel to this level of transparency.
5871 MagickExport void SetImage(Image *image,const Quantum opacity)
5879 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.2.0");
5880 assert(image != (Image *) NULL);
5881 if (image->debug != MagickFalse)
5882 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
5883 assert(image->signature == MagickSignature);
5884 background_color=image->background_color;
5885 if (opacity != OpaqueOpacity)
5886 background_color.opacity=opacity;
5887 if (background_color.opacity != OpaqueOpacity)
5889 (void) SetImageStorageClass(image,DirectClass);
5890 image->matte=MagickTrue;
5892 if ((image->storage_class == PseudoClass) ||
5893 (image->colorspace == CMYKColorspace))
5896 Set colormapped or CMYK image.
5898 for (y=0; y < (ssize_t) image->rows; y++)
5900 register IndexPacket
5906 register PixelPacket
5909 q=QueueAuthenticPixels(image,0,y,image->columns,1,&image->exception);
5910 if (q == (PixelPacket *) NULL)
5912 for (x=0; x < (ssize_t) image->columns; x++)
5913 *q++=background_color;
5914 indexes=GetAuthenticIndexQueue(image);
5915 for (x=0; x < (ssize_t) image->columns; x++)
5916 indexes[x]=(IndexPacket) 0;
5917 if (SyncAuthenticPixels(image,&image->exception) == MagickFalse)
5923 Set DirectClass image.
5925 for (y=0; y < (ssize_t) image->rows; y++)
5930 register PixelPacket
5933 q=QueueAuthenticPixels(image,0,y,image->columns,1,&image->exception);
5934 if (q == (PixelPacket *) NULL)
5936 for (x=0; x < (ssize_t) image->columns; x++)
5937 *q++=background_color;
5938 if (SyncAuthenticPixels(image,&image->exception) == MagickFalse)
5944 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5948 % S e t I m a g e A t t r i b u t e %
5952 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5954 % SetImageAttribute() searches the list of image attributes and replaces the
5955 % attribute value. If it is not found in the list, the attribute name
5956 % and value is added to the list.
5958 % Deprecated, replace with:
5960 % SetImageProperty(image,key,value);
5962 % The format of the SetImageAttribute method is:
5964 % MagickBooleanType SetImageAttribute(Image *image,const char *key,
5965 % const char *value)
5967 % A description of each parameter follows:
5969 % o image: the image.
5973 % o value: the value.
5976 MagickExport MagickBooleanType SetImageAttribute(Image *image,const char *key,
5979 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.3.1");
5980 return(SetImageProperty(image,key,value));
5984 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5988 % S e t I m a g e L i s t %
5992 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5994 % SetImageList() inserts an image into the list at the specified position.
5996 % The format of the SetImageList method is:
5998 % unsigned int SetImageList(Image *images,const Image *image,
5999 % const ssize_t offset,ExceptionInfo *exception)
6001 % A description of each parameter follows:
6003 % o images: the image list.
6005 % o image: the image.
6007 % o offset: the position within the list.
6009 % o exception: return any errors or warnings in this structure.
6012 MagickExport unsigned int SetImageList(Image **images,const Image *image,
6013 const ssize_t offset,ExceptionInfo *exception)
6021 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
6022 clone=CloneImageList(image,exception);
6023 while (GetPreviousImageInList(*images) != (Image *) NULL)
6024 (*images)=GetPreviousImageInList(*images);
6025 for (i=0; i < offset; i++)
6027 if (GetNextImageInList(*images) == (Image *) NULL)
6028 return(MagickFalse);
6029 (*images)=GetNextImageInList(*images);
6031 InsertImageInList(images,clone);
6036 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6040 % S e t I m a g e P i x e l s %
6044 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6046 % SetImagePixels() queues a mutable pixel region.
6047 % If the region is successfully intialized a pointer to a PixelPacket
6048 % array representing the region is returned, otherwise NULL is returned.
6049 % The returned pointer may point to a temporary working buffer for the
6050 % pixels or it may point to the final location of the pixels in memory.
6052 % Write-only access means that any existing pixel values corresponding to
6053 % the region are ignored. This useful while the initial image is being
6054 % created from scratch, or if the existing pixel values are to be
6055 % completely replaced without need to refer to their pre-existing values.
6056 % The application is free to read and write the pixel buffer returned by
6057 % SetImagePixels() any way it pleases. SetImagePixels() does not initialize
6058 % the pixel array values. Initializing pixel array values is the
6059 % application's responsibility.
6061 % Performance is maximized if the selected region is part of one row, or
6062 % one or more full rows, since then there is opportunity to access the
6063 % pixels in-place (without a copy) if the image is in RAM, or in a
6064 % memory-mapped file. The returned pointer should *never* be deallocated
6067 % Pixels accessed via the returned pointer represent a simple array of type
6068 % PixelPacket. If the image type is CMYK or the storage class is PseudoClass,
6069 % call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain
6070 % the black color component or the colormap indexes (of type IndexPacket)
6071 % corresponding to the region. Once the PixelPacket (and/or IndexPacket)
6072 % array has been updated, the changes must be saved back to the underlying
6073 % image using SyncAuthenticPixels() or they may be lost.
6075 % Deprecated, replace with:
6077 % QueueAuthenticPixels(image,x,y,columns,rows,&image->exception);
6079 % The format of the SetImagePixels() method is:
6081 % PixelPacket *SetImagePixels(Image *image,const ssize_t x,const ssize_t y,
6082 % const size_t columns,const size_t rows)
6084 % A description of each parameter follows:
6086 % o pixels: SetImagePixels returns a pointer to the pixels if they are
6087 % transferred, otherwise a NULL is returned.
6089 % o image: the image.
6091 % o x,y,columns,rows: These values define the perimeter of a region of
6095 MagickExport PixelPacket *SetImagePixels(Image *image,const ssize_t x,const ssize_t y,
6096 const size_t columns,const size_t rows)
6098 return(QueueAuthenticPixels(image,x,y,columns,rows,&image->exception));
6102 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6106 % S e t M a g i c k R e g i s t r y %
6110 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6112 % SetMagickRegistry() sets a blob into the registry and returns a unique ID.
6113 % If an error occurs, -1 is returned.
6115 % The format of the SetMagickRegistry method is:
6117 % ssize_t SetMagickRegistry(const RegistryType type,const void *blob,
6118 % const size_t length,ExceptionInfo *exception)
6120 % A description of each parameter follows:
6122 % o type: the registry type.
6124 % o blob: the address of a Binary Large OBject.
6126 % o length: For a registry type of ImageRegistryType use sizeof(Image)
6127 % otherise the blob length in number of bytes.
6129 % o exception: return any errors or warnings in this structure.
6132 MagickExport ssize_t SetMagickRegistry(const RegistryType type,const void *blob,
6133 const size_t magick_unused(length),ExceptionInfo *exception)
6144 (void) FormatMagickString(key,MaxTextExtent,"%.20g\n",(double) id);
6145 status=SetImageRegistry(type,key,blob,exception);
6146 if (status == MagickFalse)
6152 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6156 % S e t M o n i t o r H a n d l e r %
6160 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6162 % SetMonitorHandler() sets the monitor handler to the specified method
6163 % and returns the previous monitor handler.
6165 % The format of the SetMonitorHandler method is:
6167 % MonitorHandler SetMonitorHandler(MonitorHandler handler)
6169 % A description of each parameter follows:
6171 % o handler: Specifies a pointer to a method to handle monitors.
6175 MagickExport MonitorHandler GetMonitorHandler(void)
6177 return(monitor_handler);
6180 MagickExport MonitorHandler SetMonitorHandler(MonitorHandler handler)
6185 previous_handler=monitor_handler;
6186 monitor_handler=handler;
6187 return(previous_handler);
6191 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6195 % S h i f t I m a g e L i s t %
6199 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6201 % ShiftImageList() removes an image from the beginning of the list.
6203 % Deprecated, replace with:
6205 % RemoveFirstImageFromList(images);
6207 % The format of the ShiftImageList method is:
6209 % Image *ShiftImageList(Image **images)
6211 % A description of each parameter follows:
6213 % o images: the image list.
6216 MagickExport Image *ShiftImageList(Image **images)
6218 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
6219 return(RemoveFirstImageFromList(images));
6223 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6231 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6233 % SizeBlob() returns the current length of the image file or blob.
6235 % Deprecated, replace with:
6237 % GetBlobSize(image);
6239 % The format of the SizeBlob method is:
6241 % off_t SizeBlob(Image *image)
6243 % A description of each parameter follows:
6245 % o size: Method SizeBlob returns the current length of the image file
6248 % o image: the image.
6251 MagickExport MagickOffsetType SizeBlob(Image *image)
6253 if (image->debug != MagickFalse)
6254 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.4.3");
6255 return((MagickOffsetType) GetBlobSize(image));
6259 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6263 % S p l i c e I m a g e L i s t %
6267 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6269 % SpliceImageList() removes the images designated by offset and length from
6270 % the list and replaces them with the specified list.
6272 % The format of the SpliceImageList method is:
6274 % Image *SpliceImageList(Image *images,const ssize_t offset,
6275 % const size_t length,const Image *splices,
6276 % ExceptionInfo *exception)
6278 % A description of each parameter follows:
6280 % o images: the image list.
6282 % o offset: the position within the list.
6284 % o length: the length of the image list to remove.
6286 % o splice: Replace the removed image list with this list.
6288 % o exception: return any errors or warnings in this structure.
6291 MagickExport Image *SpliceImageList(Image *images,const ssize_t offset,
6292 const size_t length,const Image *splices,ExceptionInfo *exception)
6300 if (images->debug != MagickFalse)
6301 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
6302 clone=CloneImageList(splices,exception);
6303 while (GetPreviousImageInList(images) != (Image *) NULL)
6304 images=GetPreviousImageInList(images);
6305 for (i=0; i < offset; i++)
6307 if (GetNextImageInList(images) == (Image *) NULL)
6308 return((Image *) NULL);
6309 images=GetNextImageInList(images);
6311 (void) SpliceImageIntoList(&images,length,clone);
6316 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6324 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6326 % Strip() strips any whitespace or quotes from the beginning and end of a
6327 % string of characters.
6329 % The format of the Strip method is:
6331 % void Strip(char *message)
6333 % A description of each parameter follows:
6335 % o message: Specifies an array of characters.
6338 MagickExport void Strip(char *message)
6344 assert(message != (char *) NULL);
6345 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
6346 if (*message == '\0')
6348 if (strlen(message) == 1)
6351 while (isspace((int) ((unsigned char) *p)) != 0)
6353 if ((*p == '\'') || (*p == '"'))
6355 q=message+strlen(message)-1;
6356 while ((isspace((int) ((unsigned char) *q)) != 0) && (q > p))
6359 if ((*q == '\'') || (*q == '"'))
6361 (void) CopyMagickMemory(message,p,(size_t) (q-p+1));
6362 message[q-p+1]='\0';
6366 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6370 % S y n c C a c h e V i e w %
6374 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6376 % SyncCacheView() saves the cache view pixels to the in-memory or disk
6377 % cache. It returns MagickTrue if the pixel region is synced, otherwise
6380 % Deprecated, replace with:
6382 % SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
6384 % The format of the SyncCacheView method is:
6386 % MagickBooleanType SyncCacheView(CacheView *cache_view)
6388 % A description of each parameter follows:
6390 % o cache_view: the cache view.
6393 MagickExport MagickBooleanType SyncCacheView(CacheView *cache_view)
6398 status=SyncCacheViewAuthenticPixels(cache_view,
6399 GetCacheViewException(cache_view));
6404 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6408 % S y n c C a c h e V i e w P i x e l s %
6412 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6414 % SyncCacheViewPixels() saves the cache view pixels to the in-memory
6415 % or disk cache. It returns MagickTrue if the pixel region is flushed,
6416 % otherwise MagickFalse.
6418 % Deprecated, replace with:
6420 % SyncCacheViewAuthenticPixels(cache_view,GetCacheViewException(cache_view));
6422 % The format of the SyncCacheViewPixels method is:
6424 % MagickBooleanType SyncCacheViewPixels(CacheView *cache_view)
6426 % A description of each parameter follows:
6428 % o cache_view: the cache view.
6430 % o exception: return any errors or warnings in this structure.
6433 MagickExport MagickBooleanType SyncCacheViewPixels(CacheView *cache_view)
6438 status=SyncCacheViewAuthenticPixels(cache_view,
6439 GetCacheViewException(cache_view));
6444 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6448 % S y n c I m a g e P i x e l s %
6452 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6454 % SyncImagePixels() saves the image pixels to the in-memory or disk cache.
6455 % The method returns MagickTrue if the pixel region is synced, otherwise
6458 % Deprecated, replace with:
6460 % SyncAuthenticPixels(image,&image->exception);
6462 % The format of the SyncImagePixels() method is:
6464 % MagickBooleanType SyncImagePixels(Image *image)
6466 % A description of each parameter follows:
6468 % o image: the image.
6471 MagickExport MagickBooleanType SyncImagePixels(Image *image)
6473 return(SyncAuthenticPixels(image,&image->exception));
6477 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6481 % T e m p o r a r y F i l e n a m e %
6485 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6487 % TemporaryFilename() replaces the contents of path by a unique path name.
6489 % The format of the TemporaryFilename method is:
6491 % void TemporaryFilename(char *path)
6493 % A description of each parameter follows.
6495 % o path: Specifies a pointer to an array of characters. The unique path
6496 % name is returned in this array.
6499 MagickExport void TemporaryFilename(char *path)
6501 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.6");
6502 (void) AcquireUniqueFilename(path);
6503 (void) RelinquishUniqueFileResource(path);
6507 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6511 % T h r e s h o l d I m a g e %
6515 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6517 % ThresholdImage() changes the value of individual pixels based on
6518 % the intensity of each pixel compared to threshold. The result is a
6519 % high-contrast, two color image.
6521 % The format of the ThresholdImage method is:
6523 % unsigned int ThresholdImage(Image *image,const double threshold)
6525 % A description of each parameter follows:
6527 % o image: the image.
6529 % o threshold: Define the threshold value
6532 MagickExport unsigned int ThresholdImage(Image *image,const double threshold)
6534 #define ThresholdImageTag "Threshold/Image"
6545 assert(image != (Image *) NULL);
6546 assert(image->signature == MagickSignature);
6547 if (image->debug != MagickFalse)
6548 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
6549 if (image->debug != MagickFalse)
6550 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.7");
6551 if (!AcquireImageColormap(image,2))
6552 ThrowBinaryException(ResourceLimitError,"MemoryAllocationFailed",
6553 "UnableToThresholdImage");
6554 for (y=0; y < (ssize_t) image->rows; y++)
6556 register IndexPacket
6562 register PixelPacket
6565 q=GetAuthenticPixels(image,0,y,image->columns,1,&image->exception);
6566 if (q == (PixelPacket *) NULL)
6568 indexes=GetAuthenticIndexQueue(image);
6569 for (x=0; x < (ssize_t) image->columns; x++)
6571 index=(IndexPacket) ((MagickRealType) PixelIntensityToQuantum(q) <=
6573 SetIndexPixelComponent(indexes+x,index);
6574 SetRedPixelComponent(q,image->colormap[(ssize_t) index].red);
6575 SetGreenPixelComponent(q,image->colormap[(ssize_t) index].green);
6576 SetBluePixelComponent(q,image->colormap[(ssize_t) index].blue);
6579 if (!SyncAuthenticPixels(image,&image->exception))
6586 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6590 % T h r e s h o l d I m a g e C h a n n e l %
6594 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6596 % ThresholdImageChannel() changes the value of individual pixels based on
6597 % the intensity of each pixel channel. The result is a high-contrast image.
6599 % The format of the ThresholdImageChannel method is:
6601 % unsigned int ThresholdImageChannel(Image *image,const char *threshold)
6603 % A description of each parameter follows:
6605 % o image: the image.
6607 % o threshold: define the threshold values.
6610 MagickExport unsigned int ThresholdImageChannel(Image *image,
6611 const char *threshold)
6613 #define ThresholdImageTag "Threshold/Image"
6633 assert(image != (Image *) NULL);
6634 assert(image->signature == MagickSignature);
6635 if (image->debug != MagickFalse)
6636 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
6637 if (threshold == (const char *) NULL)
6639 if (SetImageStorageClass(image,DirectClass) == MagickFalse)
6640 return(MagickFalse);
6641 flags=ParseGeometry(threshold,&geometry_info);
6642 pixel.red=geometry_info.rho;
6643 if (flags & SigmaValue)
6644 pixel.green=geometry_info.sigma;
6646 pixel.green=pixel.red;
6647 if (flags & XiValue)
6648 pixel.blue=geometry_info.xi;
6650 pixel.blue=pixel.red;
6651 if (flags & PsiValue)
6652 pixel.opacity=geometry_info.psi;
6654 pixel.opacity=(MagickRealType) OpaqueOpacity;
6655 if (flags & PercentValue)
6657 pixel.red*=QuantumRange/100.0f;
6658 pixel.green*=QuantumRange/100.0f;
6659 pixel.blue*=QuantumRange/100.0f;
6660 pixel.opacity*=QuantumRange/100.0f;
6662 if (!(flags & SigmaValue))
6664 if (!AcquireImageColormap(image,2))
6665 ThrowBinaryException(ResourceLimitError,"MemoryAllocationFailed",
6666 "UnableToThresholdImage");
6668 (void) GetImageDynamicThreshold(image,2.0,2.0,&pixel,&image->exception);
6670 for (y=0; y < (ssize_t) image->rows; y++)
6672 register IndexPacket
6678 register PixelPacket
6681 q=GetAuthenticPixels(image,0,y,image->columns,1,&image->exception);
6682 if (q == (PixelPacket *) NULL)
6684 indexes=GetAuthenticIndexQueue(image);
6685 if (IsMagickGray(&pixel) != MagickFalse)
6686 for (x=0; x < (ssize_t) image->columns; x++)
6688 index=(IndexPacket) ((MagickRealType)
6689 PixelIntensityToQuantum(q) <= pixel.red ? 0 : 1);
6690 SetIndexPixelComponent(indexes+x,index);
6691 SetRedPixelComponent(q,image->colormap[(ssize_t) index].red);
6692 SetGreenPixelComponent(q,image->colormap[(ssize_t) index].green);
6693 SetBluePixelComponent(q,image->colormap[(ssize_t) index].blue);
6697 for (x=0; x < (ssize_t) image->columns; x++)
6699 SetRedPixelComponent(q,q->red <= pixel.red ? 0 : QuantumRange);
6700 SetGreenPixelComponent(q,q->green <= pixel.green ? 0 : QuantumRange);
6701 SetBluePixelComponent(q,q->blue <= pixel.blue ? 0 : QuantumRange);
6702 SetOpacityPixelComponent(q,q->opacity <= pixel.opacity ? 0 :
6706 if (!SyncAuthenticPixels(image,&image->exception))
6713 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6717 + T r a n s f o r m C o l o r s p a c e %
6721 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6723 % TransformColorspace() converts the image to a specified colorspace.
6724 % If the image is already in the requested colorspace, no work is performed.
6725 % Note that the current colorspace is stored in the image colorspace member.
6726 % The transformation matrices are not necessarily the standard ones: the
6727 % weights are rescaled to normalize the range of the transformed values to
6728 % be [0..QuantumRange].
6730 % Deprecated, replace with:
6732 % TransformImageColorspace(image,colorspace);
6734 % The format of the TransformColorspace method is:
6736 % unsigned int (void) TransformColorspace(Image *image,
6737 % const ColorspaceType colorspace)
6739 % A description of each parameter follows:
6741 % o image: the image to transform
6743 % o colorspace: the desired colorspace.
6746 MagickExport unsigned int TransformColorspace(Image *image,
6747 const ColorspaceType colorspace)
6749 assert(image != (Image *) NULL);
6750 assert(image->signature == MagickSignature);
6751 if (image->debug != MagickFalse)
6752 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.6");
6753 return(TransformImageColorspace(image,colorspace));
6757 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6761 % T r a n s f o r m H S L %
6765 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6767 % TransformHSL() converts a (red, green, blue) to a (hue, saturation,
6768 % lightness) triple.
6770 % The format of the TransformHSL method is:
6772 % void TransformHSL(const Quantum red,const Quantum green,
6773 % const Quantum blue,double *hue,double *saturation,double *lightness)
6775 % A description of each parameter follows:
6777 % o red, green, blue: A Quantum value representing the red, green, and
6778 % blue component of a pixel..
6780 % o hue, saturation, lightness: A pointer to a double value representing a
6781 % component of the HSL color space.
6785 static inline double MagickMin(const double x,const double y)
6792 MagickExport void TransformHSL(const Quantum red,const Quantum green,
6793 const Quantum blue,double *hue,double *saturation,double *lightness)
6804 Convert RGB to HSL colorspace.
6806 assert(hue != (double *) NULL);
6807 assert(saturation != (double *) NULL);
6808 assert(lightness != (double *) NULL);
6810 g=QuantumScale*green;
6811 b=QuantumScale*blue;
6812 max=MagickMax(r,MagickMax(g,b));
6813 min=MagickMin(r,MagickMin(g,b));
6816 *lightness=(double) ((min+max)/2.0);
6820 *saturation=(double) (delta/((*lightness < 0.5) ? (min+max) :
6823 *hue=(double) (g == min ? 5.0+(max-b)/delta : 1.0-(max-g)/delta);
6826 *hue=(double) (b == min ? 1.0+(max-r)/delta : 3.0-(max-b)/delta);
6828 *hue=(double) (r == min ? 3.0+(max-g)/delta : 5.0-(max-r)/delta);
6833 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6837 % T r a n s l a t e T e x t %
6841 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6843 % TranslateText() replaces any embedded formatting characters with the
6844 % appropriate image attribute and returns the translated text.
6846 % Deprecated, replace with:
6848 % InterpretImageProperties(image_info,image,embed_text);
6850 % The format of the TranslateText method is:
6852 % char *TranslateText(const ImageInfo *image_info,Image *image,
6853 % const char *embed_text)
6855 % A description of each parameter follows:
6857 % o image_info: the image info.
6859 % o image: the image.
6861 % o embed_text: the address of a character string containing the embedded
6862 % formatting characters.
6865 MagickExport char *TranslateText(const ImageInfo *image_info,Image *image,
6866 const char *embed_text)
6868 assert(image != (Image *) NULL);
6869 assert(image->signature == MagickSignature);
6870 if (image->debug != MagickFalse)
6871 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.2.6");
6872 return(InterpretImageProperties(image_info,image,embed_text));
6876 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6880 % T r a n s p a r e n t I m a g e %
6884 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6886 % TransparentImage() changes the opacity value associated with any pixel
6887 % that matches color to the value defined by opacity.
6889 % By default color must match a particular pixel color exactly. However,
6890 % in many cases two colors may differ by a small amount. Fuzz defines
6891 % how much tolerance is acceptable to consider two colors as the same.
6892 % For example, set fuzz to 10 and the color red at intensities of 100 and
6893 % 102 respectively are now interpreted as the same color.
6895 % The format of the TransparentImage method is:
6897 % MagickBooleanType TransparentImage(Image *image,
6898 % const PixelPacket target,const Quantum opacity)
6900 % A description of each parameter follows:
6902 % o image: the image.
6904 % o target: the RGB value of the target color.
6906 % o opacity: the replacement opacity value.
6909 MagickExport MagickBooleanType TransparentImage(Image *image,
6910 const PixelPacket target,const Quantum opacity)
6912 #define TransparentImageTag "Transparent/Image"
6921 Make image color transparent.
6923 assert(image != (Image *) NULL);
6924 assert(image->signature == MagickSignature);
6925 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v6.1.0");
6926 if (image->debug != MagickFalse)
6927 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
6928 if (image->matte == MagickFalse)
6929 (void) SetImageAlphaChannel(image,OpaqueAlphaChannel);
6930 for (y=0; y < (ssize_t) image->rows; y++)
6935 register PixelPacket
6938 q=GetAuthenticPixels(image,0,y,image->columns,1,&image->exception);
6939 if (q == (PixelPacket *) NULL)
6941 for (x=0; x < (ssize_t) image->columns; x++)
6943 if (IsColorSimilar(image,q,&target) != MagickFalse)
6947 if (SyncAuthenticPixels(image,&image->exception) == MagickFalse)
6949 proceed=SetImageProgress(image,TransparentImageTag,(MagickOffsetType) y,
6951 if (proceed == MagickFalse)
6958 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6962 % U n s h i f t I m a g e L i s t %
6966 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6968 % UnshiftImageList() adds the image to the beginning of the list.
6970 % Deprecated, replace with:
6972 % PrependImageToList(images,CloneImageList(image,exception));
6974 % The format of the UnshiftImageList method is:
6976 % unsigned int UnshiftImageList(Image *images,const Image *image,
6977 % ExceptionInfo *exception)
6979 % A description of each parameter follows:
6981 % o images: the image list.
6983 % o image: the image.
6985 % o exception: return any errors or warnings in this structure.
6988 MagickExport unsigned int UnshiftImageList(Image **images,const Image *image,
6989 ExceptionInfo *exception)
6991 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.5.2");
6992 PrependImageToList(images,CloneImageList(image,exception));
6997 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7001 + V a l i d a t e C o l o r m a p I n d e x %
7005 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7007 % ValidateColormapIndex() validates the colormap index. If the index does
7008 % not range from 0 to the number of colors in the colormap an exception
7009 % issued and 0 is returned.
7011 % Deprecated, replace with:
7013 % ConstrainColormapIndex(image,index);
7015 % The format of the ValidateColormapIndex method is:
7017 % IndexPacket ValidateColormapIndex(Image *image,const unsigned int index)
7019 % A description of each parameter follows:
7021 % o index: Method ValidateColormapIndex returns colormap index if it is
7022 % valid other an exception issued and 0 is returned.
7024 % o image: the image.
7026 % o index: This integer is the colormap index.
7029 MagickExport IndexPacket ValidateColormapIndex(Image *image,
7032 if (image->debug != MagickFalse)
7033 (void) LogMagickEvent(DeprecateEvent,GetMagickModule(),"last use: v5.4.4");
7034 return(ConstrainColormapIndex(image,index));
7038 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7042 % Z o o m I m a g e %
7046 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
7048 % ZoomImage() creates a new image that is a scaled size of an existing one.
7049 % It allocates the memory necessary for the new Image structure and returns a
7050 % pointer to the new image. The Point filter gives fast pixel replication,
7051 % Triangle is equivalent to bi-linear interpolation, and Mitchel giver slower,
7052 % very high-quality results. See Graphic Gems III for details on this
7055 % The filter member of the Image structure specifies which image filter to
7056 % use. Blur specifies the blur factor where > 1 is blurry, < 1 is sharp.
7058 % The format of the ZoomImage method is:
7060 % Image *ZoomImage(const Image *image,const size_t columns,
7061 % const size_t rows,ExceptionInfo *exception)
7063 % A description of each parameter follows:
7065 % o image: the image.
7067 % o columns: An integer that specifies the number of columns in the zoom
7070 % o rows: An integer that specifies the number of rows in the scaled
7073 % o exception: return any errors or warnings in this structure.
7076 MagickExport Image *ZoomImage(const Image *image,const size_t columns,
7077 const size_t rows,ExceptionInfo *exception)
7082 assert(image != (const Image *) NULL);
7083 assert(image->signature == MagickSignature);
7084 if (image->debug != MagickFalse)
7085 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
7086 assert(exception != (ExceptionInfo *) NULL);
7087 assert(exception->signature == MagickSignature);
7088 zoom_image=ResizeImage(image,columns,rows,image->filter,image->blur,