2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % CCCC OOO N N SSSSS TTTTT IIIII TTTTT U U TTTTT EEEEE %
7 % C O O NN N SS T I T U U T E %
8 % C O O N N N ESSS T I T U U T EEE %
9 % C O O N NN SS T I T U U T E %
10 % CCCC OOO N N SSSSS T IIIII T UUU T EEEEE %
13 % MagickCore Methods to Consitute an Image %
20 % Copyright 1999-2016 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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "MagickCore/studio.h"
43 #include "MagickCore/attribute.h"
44 #include "MagickCore/blob.h"
45 #include "MagickCore/blob-private.h"
46 #include "MagickCore/exception.h"
47 #include "MagickCore/exception-private.h"
48 #include "MagickCore/cache.h"
49 #include "MagickCore/client.h"
50 #include "MagickCore/colorspace-private.h"
51 #include "MagickCore/constitute.h"
52 #include "MagickCore/constitute-private.h"
53 #include "MagickCore/delegate.h"
54 #include "MagickCore/geometry.h"
55 #include "MagickCore/identify.h"
56 #include "MagickCore/image-private.h"
57 #include "MagickCore/list.h"
58 #include "MagickCore/magick.h"
59 #include "MagickCore/memory_.h"
60 #include "MagickCore/monitor.h"
61 #include "MagickCore/monitor-private.h"
62 #include "MagickCore/option.h"
63 #include "MagickCore/pixel.h"
64 #include "MagickCore/pixel-accessor.h"
65 #include "MagickCore/policy.h"
66 #include "MagickCore/profile.h"
67 #include "MagickCore/profile-private.h"
68 #include "MagickCore/property.h"
69 #include "MagickCore/quantum.h"
70 #include "MagickCore/resize.h"
71 #include "MagickCore/resource_.h"
72 #include "MagickCore/semaphore.h"
73 #include "MagickCore/statistic.h"
74 #include "MagickCore/stream.h"
75 #include "MagickCore/string_.h"
76 #include "MagickCore/string-private.h"
77 #include "MagickCore/timer.h"
78 #include "MagickCore/token.h"
79 #include "MagickCore/transform.h"
80 #include "MagickCore/utility.h"
81 #include "MagickCore/utility-private.h"
84 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
88 % C o n s t i t u t e I m a g e %
92 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
94 % ConstituteImage() returns an image from the pixel data you supply.
95 % The pixel data must be in scanline order top-to-bottom. The data can be
96 % char, short int, int, float, or double. Float and double require the
97 % pixels to be normalized [0..1], otherwise [0..QuantumRange]. For example, to
98 % create a 640x480 image from unsigned red-green-blue character data, use:
100 % image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
102 % The format of the ConstituteImage method is:
104 % Image *ConstituteImage(const size_t columns,const size_t rows,
105 % const char *map,const StorageType storage,const void *pixels,
106 % ExceptionInfo *exception)
108 % A description of each parameter follows:
110 % o columns: width in pixels of the image.
112 % o rows: height in pixels of the image.
114 % o map: This string reflects the expected ordering of the pixel array.
115 % It can be any combination or order of R = red, G = green, B = blue,
116 % A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan,
117 % Y = yellow, M = magenta, K = black, I = intensity (for grayscale),
120 % o storage: Define the data type of the pixels. Float and double types are
121 % expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose
122 % from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel,
123 % LongPixel, QuantumPixel, or ShortPixel.
125 % o pixels: This array of values contain the pixel components as defined by
126 % map and type. You must preallocate this array where the expected
127 % length varies depending on the values of width, height, map, and type.
129 % o exception: return any errors or warnings in this structure.
132 MagickExport Image *ConstituteImage(const size_t columns,const size_t rows,
133 const char *map,const StorageType storage,const void *pixels,
134 ExceptionInfo *exception)
143 Allocate image structure.
145 assert(map != (const char *) NULL);
146 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",map);
147 assert(pixels != (void *) NULL);
148 assert(exception != (ExceptionInfo *) NULL);
149 assert(exception->signature == MagickCoreSignature);
150 image=AcquireImage((ImageInfo *) NULL,exception);
151 if (image == (Image *) NULL)
152 return((Image *) NULL);
153 if ((columns == 0) || (rows == 0))
154 ThrowImageException(OptionError,"NonZeroWidthAndHeightRequired");
155 image->columns=columns;
157 (void) SetImageBackgroundColor(image,exception);
158 status=ImportImagePixels(image,0,0,columns,rows,map,storage,pixels,exception);
159 if (status == MagickFalse)
160 image=DestroyImage(image);
165 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
169 % P i n g I m a g e %
173 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
175 % PingImage() returns all the properties of an image or image sequence
176 % except for the pixels. It is much faster and consumes far less memory
177 % than ReadImage(). On failure, a NULL image is returned and exception
178 % describes the reason for the failure.
180 % The format of the PingImage method is:
182 % Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
184 % A description of each parameter follows:
186 % o image_info: Ping the image defined by the file or filename members of
189 % o exception: return any errors or warnings in this structure.
193 #if defined(__cplusplus) || defined(c_plusplus)
197 static size_t PingStream(const Image *magick_unused(image),
198 const void *magick_unused(pixels),const size_t columns)
200 magick_unreferenced(image);
201 magick_unreferenced(pixels);
205 #if defined(__cplusplus) || defined(c_plusplus)
209 MagickExport Image *PingImage(const ImageInfo *image_info,
210 ExceptionInfo *exception)
218 assert(image_info != (ImageInfo *) NULL);
219 assert(image_info->signature == MagickCoreSignature);
220 if (image_info->debug != MagickFalse)
221 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
222 image_info->filename);
223 assert(exception != (ExceptionInfo *) NULL);
224 ping_info=CloneImageInfo(image_info);
225 ping_info->ping=MagickTrue;
226 image=ReadStream(ping_info,&PingStream,exception);
227 if (image != (Image *) NULL)
229 ResetTimer(&image->timer);
230 if (ping_info->verbose != MagickFalse)
231 (void) IdentifyImage(image,stdout,MagickFalse,exception);
233 ping_info=DestroyImageInfo(ping_info);
238 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
242 % P i n g I m a g e s %
246 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
248 % PingImages() pings one or more images and returns them as an image list.
250 % The format of the PingImage method is:
252 % Image *PingImages(ImageInfo *image_info,const char *filename,
253 % ExceptionInfo *exception)
255 % A description of each parameter follows:
257 % o image_info: the image info.
259 % o filename: the image filename.
261 % o exception: return any errors or warnings in this structure.
264 MagickExport Image *PingImages(ImageInfo *image_info,const char *filename,
265 ExceptionInfo *exception)
268 ping_filename[MagickPathExtent];
278 Ping image list from a file.
280 assert(image_info != (ImageInfo *) NULL);
281 assert(image_info->signature == MagickCoreSignature);
282 if (image_info->debug != MagickFalse)
283 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
284 image_info->filename);
285 assert(exception != (ExceptionInfo *) NULL);
286 (void) SetImageOption(image_info,"filename",filename);
287 (void) CopyMagickString(image_info->filename,filename,MagickPathExtent);
288 (void) InterpretImageFilename(image_info,(Image *) NULL,image_info->filename,
289 (int) image_info->scene,ping_filename,exception);
290 if (LocaleCompare(ping_filename,image_info->filename) != 0)
300 Images of the form image-%d.png[1-5].
302 read_info=CloneImageInfo(image_info);
303 sans=AcquireExceptionInfo();
304 (void) SetImageInfo(read_info,0,sans);
305 sans=DestroyExceptionInfo(sans);
306 if (read_info->number_scenes == 0)
308 read_info=DestroyImageInfo(read_info);
309 return(PingImage(image_info,exception));
311 (void) CopyMagickString(ping_filename,read_info->filename,MagickPathExtent);
312 images=NewImageList();
313 extent=(ssize_t) (read_info->scene+read_info->number_scenes);
314 for (scene=(ssize_t) read_info->scene; scene < (ssize_t) extent; scene++)
316 (void) InterpretImageFilename(image_info,(Image *) NULL,ping_filename,
317 (int) scene,read_info->filename,exception);
318 image=PingImage(read_info,exception);
319 if (image == (Image *) NULL)
321 AppendImageToList(&images,image);
323 read_info=DestroyImageInfo(read_info);
326 return(PingImage(image_info,exception));
330 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
334 % R e a d I m a g e %
338 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
340 % ReadImage() reads an image or image sequence from a file or file handle.
341 % The method returns a NULL if there is a memory shortage or if the image
342 % cannot be read. On failure, a NULL image is returned and exception
343 % describes the reason for the failure.
345 % The format of the ReadImage method is:
347 % Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
349 % A description of each parameter follows:
351 % o image_info: Read the image defined by the file or filename members of
354 % o exception: return any errors or warnings in this structure.
357 MagickExport Image *ReadImage(const ImageInfo *image_info,
358 ExceptionInfo *exception)
361 filename[MagickPathExtent],
362 magick[MagickPathExtent],
363 magick_filename[MagickPathExtent];
397 Determine image type from filename prefix or suffix (e.g. image.jpg).
399 assert(image_info != (ImageInfo *) NULL);
400 assert(image_info->signature == MagickCoreSignature);
401 assert(image_info->filename != (char *) NULL);
402 if (image_info->debug != MagickFalse)
403 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
404 image_info->filename);
405 assert(exception != (ExceptionInfo *) NULL);
406 read_info=CloneImageInfo(image_info);
407 (void) CopyMagickString(magick_filename,read_info->filename,MagickPathExtent);
408 (void) SetImageInfo(read_info,0,exception);
409 (void) CopyMagickString(filename,read_info->filename,MagickPathExtent);
410 (void) CopyMagickString(magick,read_info->magick,MagickPathExtent);
411 domain=CoderPolicyDomain;
412 rights=ReadPolicyRights;
413 if (IsRightsAuthorized(domain,rights,read_info->magick) == MagickFalse)
416 (void) ThrowMagickException(exception,GetMagickModule(),PolicyError,
417 "NotAuthorized","`%s'",read_info->filename);
418 read_info=DestroyImageInfo(read_info);
419 return((Image *) NULL);
422 Call appropriate image reader based on image type.
424 sans_exception=AcquireExceptionInfo();
425 magick_info=GetMagickInfo(read_info->magick,sans_exception);
426 sans_exception=DestroyExceptionInfo(sans_exception);
427 if (magick_info != (const MagickInfo *) NULL)
429 if (GetMagickEndianSupport(magick_info) == MagickFalse)
430 read_info->endian=UndefinedEndian;
432 if ((image_info->endian == UndefinedEndian) &&
433 (GetMagickRawSupport(magick_info) != MagickFalse))
439 read_info->endian=(*(char *) &lsb_first) == 1 ? LSBEndian :
443 if ((magick_info != (const MagickInfo *) NULL) &&
444 (GetMagickSeekableStream(magick_info) != MagickFalse))
449 image=AcquireImage(read_info,exception);
450 (void) CopyMagickString(image->filename,read_info->filename,
452 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
453 if (status == MagickFalse)
455 read_info=DestroyImageInfo(read_info);
456 image=DestroyImage(image);
457 return((Image *) NULL);
459 if (IsBlobSeekable(image) == MagickFalse)
462 Coder requires a seekable stream.
464 *read_info->filename='\0';
465 status=ImageToFile(image,read_info->filename,exception);
466 if (status == MagickFalse)
468 (void) CloseBlob(image);
469 read_info=DestroyImageInfo(read_info);
470 image=DestroyImage(image);
471 return((Image *) NULL);
473 read_info->temporary=MagickTrue;
475 (void) CloseBlob(image);
476 image=DestroyImage(image);
478 image=NewImageList();
479 if ((magick_info == (const MagickInfo *) NULL) ||
480 (GetImageDecoder(magick_info) == (DecodeImageHandler *) NULL))
482 delegate_info=GetDelegateInfo(read_info->magick,(char *) NULL,exception);
483 if (delegate_info == (const DelegateInfo *) NULL)
485 (void) SetImageInfo(read_info,0,exception);
486 (void) CopyMagickString(read_info->filename,filename,
488 magick_info=GetMagickInfo(read_info->magick,exception);
491 if ((magick_info != (const MagickInfo *) NULL) &&
492 (GetImageDecoder(magick_info) != (DecodeImageHandler *) NULL))
494 if (GetMagickDecoderThreadSupport(magick_info) == MagickFalse)
495 LockSemaphoreInfo(magick_info->semaphore);
496 image=GetImageDecoder(magick_info)(read_info,exception);
497 if (GetMagickDecoderThreadSupport(magick_info) == MagickFalse)
498 UnlockSemaphoreInfo(magick_info->semaphore);
502 delegate_info=GetDelegateInfo(read_info->magick,(char *) NULL,exception);
503 if (delegate_info == (const DelegateInfo *) NULL)
505 (void) ThrowMagickException(exception,GetMagickModule(),
506 MissingDelegateError,"NoDecodeDelegateForThisImageFormat","`%s'",
508 if (read_info->temporary != MagickFalse)
509 (void) RelinquishUniqueFileResource(read_info->filename);
510 read_info=DestroyImageInfo(read_info);
511 return((Image *) NULL);
514 Let our decoding delegate process the image.
516 image=AcquireImage(read_info,exception);
517 if (image == (Image *) NULL)
519 read_info=DestroyImageInfo(read_info);
520 return((Image *) NULL);
522 (void) CopyMagickString(image->filename,read_info->filename,
524 *read_info->filename='\0';
525 if (GetDelegateThreadSupport(delegate_info) == MagickFalse)
526 LockSemaphoreInfo(delegate_info->semaphore);
527 (void) InvokeDelegate(read_info,image,read_info->magick,(char *) NULL,
529 if (GetDelegateThreadSupport(delegate_info) == MagickFalse)
530 UnlockSemaphoreInfo(delegate_info->semaphore);
531 image=DestroyImageList(image);
532 read_info->temporary=MagickTrue;
533 (void) SetImageInfo(read_info,0,exception);
534 magick_info=GetMagickInfo(read_info->magick,exception);
535 if ((magick_info == (const MagickInfo *) NULL) ||
536 (GetImageDecoder(magick_info) == (DecodeImageHandler *) NULL))
538 if (IsPathAccessible(read_info->filename) != MagickFalse)
539 (void) ThrowMagickException(exception,GetMagickModule(),
540 MissingDelegateError,"NoDecodeDelegateForThisImageFormat","`%s'",
543 ThrowFileException(exception,FileOpenError,"UnableToOpenFile",
544 read_info->filename);
545 read_info=DestroyImageInfo(read_info);
546 return((Image *) NULL);
548 if (GetMagickDecoderThreadSupport(magick_info) == MagickFalse)
549 LockSemaphoreInfo(magick_info->semaphore);
550 image=(Image *) (GetImageDecoder(magick_info))(read_info,exception);
551 if (GetMagickDecoderThreadSupport(magick_info) == MagickFalse)
552 UnlockSemaphoreInfo(magick_info->semaphore);
554 if (read_info->temporary != MagickFalse)
556 (void) RelinquishUniqueFileResource(read_info->filename);
557 read_info->temporary=MagickFalse;
558 if (image != (Image *) NULL)
559 (void) CopyMagickString(image->filename,filename,MagickPathExtent);
561 if (image == (Image *) NULL)
563 read_info=DestroyImageInfo(read_info);
566 if (exception->severity >= ErrorException)
567 (void) LogMagickEvent(ExceptionEvent,GetMagickModule(),
568 "Coder (%s) generated an image despite an error (%d), "
569 "notify the developers",image->magick,exception->severity);
570 if (IsBlobTemporary(image) != MagickFalse)
571 (void) RelinquishUniqueFileResource(read_info->filename);
572 if ((GetNextImageInList(image) != (Image *) NULL) &&
573 (IsSceneGeometry(read_info->scenes,MagickFalse) != MagickFalse))
578 clones=CloneImages(image,read_info->scenes,exception);
579 if (clones == (Image *) NULL)
580 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
581 "SubimageSpecificationReturnsNoImages","`%s'",read_info->filename);
584 image=DestroyImageList(image);
585 image=GetFirstImageInList(clones);
588 for (next=image; next != (Image *) NULL; next=GetNextImageInList(next))
591 magick_path[MagickPathExtent],
593 timestamp[MagickPathExtent];
601 next->taint=MagickFalse;
602 GetPathComponent(magick_filename,MagickPath,magick_path);
603 if (*magick_path == '\0' && *next->magick == '\0')
604 (void) CopyMagickString(next->magick,magick,MagickPathExtent);
605 (void) CopyMagickString(next->magick_filename,magick_filename,
607 if (IsBlobTemporary(image) != MagickFalse)
608 (void) CopyMagickString(next->filename,filename,MagickPathExtent);
609 if (next->magick_columns == 0)
610 next->magick_columns=next->columns;
611 if (next->magick_rows == 0)
612 next->magick_rows=next->rows;
613 value=GetImageProperty(next,"tiff:Orientation",exception);
614 if (value == (char *) NULL)
615 value=GetImageProperty(next,"exif:Orientation",exception);
616 if (value != (char *) NULL)
618 next->orientation=(OrientationType) StringToLong(value);
619 (void) DeleteImageProperty(next,"tiff:Orientation");
620 (void) DeleteImageProperty(next,"exif:Orientation");
622 value=GetImageProperty(next,"exif:XResolution",exception);
623 if (value != (char *) NULL)
625 geometry_info.rho=next->resolution.x;
626 geometry_info.sigma=1.0;
627 flags=ParseGeometry(value,&geometry_info);
628 if (geometry_info.sigma != 0)
629 next->resolution.x=geometry_info.rho/geometry_info.sigma;
630 (void) DeleteImageProperty(next,"exif:XResolution");
632 value=GetImageProperty(next,"exif:YResolution",exception);
633 if (value != (char *) NULL)
635 geometry_info.rho=next->resolution.y;
636 geometry_info.sigma=1.0;
637 flags=ParseGeometry(value,&geometry_info);
638 if (geometry_info.sigma != 0)
639 next->resolution.y=geometry_info.rho/geometry_info.sigma;
640 (void) DeleteImageProperty(next,"exif:YResolution");
642 value=GetImageProperty(next,"tiff:ResolutionUnit",exception);
643 if (value == (char *) NULL)
644 value=GetImageProperty(next,"exif:ResolutionUnit",exception);
645 if (value != (char *) NULL)
647 next->units=(ResolutionType) (StringToLong(value)-1);
648 (void) DeleteImageProperty(next,"exif:ResolutionUnit");
649 (void) DeleteImageProperty(next,"tiff:ResolutionUnit");
651 if (next->page.width == 0)
652 next->page.width=next->columns;
653 if (next->page.height == 0)
654 next->page.height=next->rows;
655 option=GetImageOption(read_info,"caption");
656 if (option != (const char *) NULL)
658 property=InterpretImageProperties(read_info,next,option,exception);
659 (void) SetImageProperty(next,"caption",property,exception);
660 property=DestroyString(property);
662 option=GetImageOption(read_info,"comment");
663 if (option != (const char *) NULL)
665 property=InterpretImageProperties(read_info,next,option,exception);
666 (void) SetImageProperty(next,"comment",property,exception);
667 property=DestroyString(property);
669 option=GetImageOption(read_info,"label");
670 if (option != (const char *) NULL)
672 property=InterpretImageProperties(read_info,next,option,exception);
673 (void) SetImageProperty(next,"label",property,exception);
674 property=DestroyString(property);
676 if (LocaleCompare(next->magick,"TEXT") == 0)
677 (void) ParseAbsoluteGeometry("0x0+0+0",&next->page);
678 if ((read_info->extract != (char *) NULL) &&
679 (read_info->stream == (StreamHandler) NULL))
684 flags=ParseAbsoluteGeometry(read_info->extract,&geometry);
685 if ((next->columns != geometry.width) ||
686 (next->rows != geometry.height))
688 if (((flags & XValue) != 0) || ((flags & YValue) != 0))
693 crop_image=CropImage(next,&geometry,exception);
694 if (crop_image != (Image *) NULL)
695 ReplaceImageInList(&next,crop_image);
698 if (((flags & WidthValue) != 0) || ((flags & HeightValue) != 0))
703 flags=ParseRegionGeometry(next,read_info->extract,&geometry,
705 size_image=ResizeImage(next,geometry.width,geometry.height,
706 next->filter,exception);
707 if (size_image != (Image *) NULL)
708 ReplaceImageInList(&next,size_image);
712 profile=GetImageProfile(next,"icc");
713 if (profile == (const StringInfo *) NULL)
714 profile=GetImageProfile(next,"icm");
715 profile=GetImageProfile(next,"iptc");
716 if (profile == (const StringInfo *) NULL)
717 profile=GetImageProfile(next,"8bim");
718 (void) FormatMagickTime(GetBlobProperties(next)->st_mtime,MagickPathExtent,
720 (void) SetImageProperty(next,"date:modify",timestamp,exception);
721 (void) FormatMagickTime(GetBlobProperties(next)->st_ctime,MagickPathExtent,
723 (void) SetImageProperty(next,"date:create",timestamp,exception);
724 option=GetImageOption(image_info,"delay");
725 if (option != (const char *) NULL)
727 flags=ParseGeometry(option,&geometry_info);
728 if ((flags & GreaterValue) != 0)
730 if (next->delay > (size_t) floor(geometry_info.rho+0.5))
731 next->delay=(size_t) floor(geometry_info.rho+0.5);
734 if ((flags & LessValue) != 0)
736 if (next->delay < (size_t) floor(geometry_info.rho+0.5))
737 next->ticks_per_second=(ssize_t) floor(geometry_info.sigma+0.5);
740 next->delay=(size_t) floor(geometry_info.rho+0.5);
741 if ((flags & SigmaValue) != 0)
742 next->ticks_per_second=(ssize_t) floor(geometry_info.sigma+0.5);
744 option=GetImageOption(image_info,"dispose");
745 if (option != (const char *) NULL)
746 next->dispose=(DisposeType) ParseCommandOption(MagickDisposeOptions,
748 if (read_info->verbose != MagickFalse)
749 (void) IdentifyImage(next,stderr,MagickFalse,exception);
752 read_info=DestroyImageInfo(read_info);
753 return(GetFirstImageInList(image));
757 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
761 % R e a d I m a g e s %
765 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
767 % ReadImages() reads one or more images and returns them as an image list.
769 % The format of the ReadImage method is:
771 % Image *ReadImages(ImageInfo *image_info,const char *filename,
772 % ExceptionInfo *exception)
774 % A description of each parameter follows:
776 % o image_info: the image info.
778 % o filename: the image filename.
780 % o exception: return any errors or warnings in this structure.
783 MagickExport Image *ReadImages(ImageInfo *image_info,const char *filename,
784 ExceptionInfo *exception)
787 read_filename[MagickPathExtent];
797 Read image list from a file.
799 assert(image_info != (ImageInfo *) NULL);
800 assert(image_info->signature == MagickCoreSignature);
801 if (image_info->debug != MagickFalse)
802 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
803 image_info->filename);
804 assert(exception != (ExceptionInfo *) NULL);
805 read_info=CloneImageInfo(image_info);
806 *read_info->magick='\0';
807 (void) SetImageOption(read_info,"filename",filename);
808 (void) CopyMagickString(read_info->filename,filename,MagickPathExtent);
809 (void) InterpretImageFilename(read_info,(Image *) NULL,filename,
810 (int) read_info->scene,read_filename,exception);
811 if (LocaleCompare(read_filename,read_info->filename) != 0)
821 Images of the form image-%d.png[1-5].
823 sans=AcquireExceptionInfo();
824 (void) SetImageInfo(read_info,0,sans);
825 sans=DestroyExceptionInfo(sans);
826 if (read_info->number_scenes == 0)
828 read_info=DestroyImageInfo(read_info);
829 return(ReadImage(image_info,exception));
831 (void) CopyMagickString(read_filename,read_info->filename,MagickPathExtent);
832 images=NewImageList();
833 extent=(ssize_t) (read_info->scene+read_info->number_scenes);
834 for (scene=(ssize_t) read_info->scene; scene < (ssize_t) extent; scene++)
836 (void) InterpretImageFilename(image_info,(Image *) NULL,read_filename,
837 (int) scene,read_info->filename,exception);
838 image=ReadImage(read_info,exception);
839 if (image == (Image *) NULL)
841 AppendImageToList(&images,image);
843 read_info=DestroyImageInfo(read_info);
846 image=ReadImage(read_info,exception);
847 read_info=DestroyImageInfo(read_info);
852 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
856 + R e a d I n l i n e I m a g e %
860 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
862 % ReadInlineImage() reads a Base64-encoded inline image or image sequence.
863 % The method returns a NULL if there is a memory shortage or if the image
864 % cannot be read. On failure, a NULL image is returned and exception
865 % describes the reason for the failure.
867 % The format of the ReadInlineImage method is:
869 % Image *ReadInlineImage(const ImageInfo *image_info,const char *content,
870 % ExceptionInfo *exception)
872 % A description of each parameter follows:
874 % o image_info: the image info.
876 % o content: the image encoded in Base64.
878 % o exception: return any errors or warnings in this structure.
881 MagickExport Image *ReadInlineImage(const ImageInfo *image_info,
882 const char *content,ExceptionInfo *exception)
900 Skip over header (e.g. data:image/gif;base64,).
902 image=NewImageList();
903 for (p=content; (*p != ',') && (*p != '\0'); p++) ;
905 ThrowReaderException(CorruptImageError,"CorruptImage");
908 blob=Base64Decode(p,&length);
910 ThrowReaderException(CorruptImageError,"CorruptImage");
911 read_info=CloneImageInfo(image_info);
912 (void) SetImageInfoProgressMonitor(read_info,(MagickProgressMonitor) NULL,
914 *read_info->filename='\0';
915 *read_info->magick='\0';
916 image=BlobToImage(read_info,blob,length,exception);
917 blob=(unsigned char *) RelinquishMagickMemory(blob);
918 read_info=DestroyImageInfo(read_info);
923 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
927 % W r i t e I m a g e %
931 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
933 % WriteImage() writes an image or an image sequence to a file or file handle.
934 % If writing to a file is on disk, the name is defined by the filename member
935 % of the image structure. WriteImage() returns MagickFalse is there is a
936 % memory shortage or if the image cannot be written. Check the exception
937 % member of image to determine the cause for any failure.
939 % The format of the WriteImage method is:
941 % MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image,
942 % ExceptionInfo *exception)
944 % A description of each parameter follows:
946 % o image_info: the image info.
948 % o image: the image.
950 % o exception: return any errors or warnings in this structure.
953 MagickExport MagickBooleanType WriteImage(const ImageInfo *image_info,
954 Image *image,ExceptionInfo *exception)
957 filename[MagickPathExtent];
985 Determine image type from filename prefix or suffix (e.g. image.jpg).
987 assert(image_info != (ImageInfo *) NULL);
988 assert(image_info->signature == MagickCoreSignature);
989 if (image->debug != MagickFalse)
990 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
991 image_info->filename);
992 assert(image != (Image *) NULL);
993 assert(image->signature == MagickCoreSignature);
994 assert(exception != (ExceptionInfo *) NULL);
995 sans_exception=AcquireExceptionInfo();
996 write_info=CloneImageInfo(image_info);
997 (void) CopyMagickString(write_info->filename,image->filename,
999 (void) SetImageInfo(write_info,1,sans_exception);
1000 if (*write_info->magick == '\0')
1001 (void) CopyMagickString(write_info->magick,image->magick,MagickPathExtent);
1002 (void) CopyMagickString(filename,image->filename,MagickPathExtent);
1003 (void) CopyMagickString(image->filename,write_info->filename,
1005 domain=CoderPolicyDomain;
1006 rights=WritePolicyRights;
1007 if (IsRightsAuthorized(domain,rights,write_info->magick) == MagickFalse)
1009 sans_exception=DestroyExceptionInfo(sans_exception);
1010 write_info=DestroyImageInfo(write_info);
1012 ThrowBinaryException(PolicyError,"NotAuthorized",filename);
1015 Call appropriate image reader based on image type.
1017 magick_info=GetMagickInfo(write_info->magick,sans_exception);
1018 sans_exception=DestroyExceptionInfo(sans_exception);
1019 if (magick_info != (const MagickInfo *) NULL)
1021 if (GetMagickEndianSupport(magick_info) == MagickFalse)
1022 image->endian=UndefinedEndian;
1024 if ((image_info->endian == UndefinedEndian) &&
1025 (GetMagickRawSupport(magick_info) != MagickFalse))
1031 image->endian=(*(char *) &lsb_first) == 1 ? LSBEndian : MSBEndian;
1034 (void) SyncImageProfiles(image);
1035 DisassociateImageStream(image);
1036 option=GetImageOption(image_info,"delegate:bimodal");
1037 if ((IsStringTrue(option) != MagickFalse) &&
1038 (write_info->page == (char *) NULL) &&
1039 (GetPreviousImageInList(image) == (Image *) NULL) &&
1040 (GetNextImageInList(image) == (Image *) NULL) &&
1041 (IsTaintImage(image) == MagickFalse) )
1043 delegate_info=GetDelegateInfo(image->magick,write_info->magick,exception);
1044 if ((delegate_info != (const DelegateInfo *) NULL) &&
1045 (GetDelegateMode(delegate_info) == 0) &&
1046 (IsPathAccessible(image->magick_filename) != MagickFalse))
1049 Process image with bi-modal delegate.
1051 (void) CopyMagickString(image->filename,image->magick_filename,
1053 status=InvokeDelegate(write_info,image,image->magick,
1054 write_info->magick,exception);
1055 write_info=DestroyImageInfo(write_info);
1056 (void) CopyMagickString(image->filename,filename,MagickPathExtent);
1061 temporary=MagickFalse;
1062 if ((magick_info != (const MagickInfo *) NULL) &&
1063 (GetMagickSeekableStream(magick_info) != MagickFalse))
1066 image_filename[MagickPathExtent];
1068 (void) CopyMagickString(image_filename,image->filename,MagickPathExtent);
1069 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
1070 (void) CopyMagickString(image->filename, image_filename,MagickPathExtent);
1071 if (status != MagickFalse)
1073 if (IsBlobSeekable(image) == MagickFalse)
1076 A seekable stream is required by the encoder.
1078 write_info->adjoin=MagickTrue;
1079 (void) CopyMagickString(write_info->filename,image->filename,
1081 (void) AcquireUniqueFilename(image->filename);
1082 temporary=MagickTrue;
1084 (void) CloseBlob(image);
1087 if ((magick_info != (const MagickInfo *) NULL) &&
1088 (GetImageEncoder(magick_info) != (EncodeImageHandler *) NULL))
1091 Call appropriate image writer based on image type.
1093 if (GetMagickEncoderThreadSupport(magick_info) == MagickFalse)
1094 LockSemaphoreInfo(magick_info->semaphore);
1095 status=GetImageEncoder(magick_info)(write_info,image,exception);
1096 if (GetMagickEncoderThreadSupport(magick_info) == MagickFalse)
1097 UnlockSemaphoreInfo(magick_info->semaphore);
1101 delegate_info=GetDelegateInfo((char *) NULL,write_info->magick,exception);
1102 if (delegate_info != (DelegateInfo *) NULL)
1105 Process the image with delegate.
1107 *write_info->filename='\0';
1108 if (GetDelegateThreadSupport(delegate_info) == MagickFalse)
1109 LockSemaphoreInfo(delegate_info->semaphore);
1110 status=InvokeDelegate(write_info,image,(char *) NULL,
1111 write_info->magick,exception);
1112 if (GetDelegateThreadSupport(delegate_info) == MagickFalse)
1113 UnlockSemaphoreInfo(delegate_info->semaphore);
1114 (void) CopyMagickString(image->filename,filename,MagickPathExtent);
1118 sans_exception=AcquireExceptionInfo();
1119 magick_info=GetMagickInfo(write_info->magick,sans_exception);
1120 sans_exception=DestroyExceptionInfo(sans_exception);
1121 if ((write_info->affirm == MagickFalse) &&
1122 (magick_info == (const MagickInfo *) NULL))
1124 (void) CopyMagickString(write_info->magick,image->magick,
1126 magick_info=GetMagickInfo(write_info->magick,exception);
1128 if ((magick_info == (const MagickInfo *) NULL) ||
1129 (GetImageEncoder(magick_info) == (EncodeImageHandler *) NULL))
1132 extension[MagickPathExtent];
1134 GetPathComponent(image->filename,ExtensionPath,extension);
1135 if (*extension != '\0')
1136 magick_info=GetMagickInfo(extension,exception);
1138 magick_info=GetMagickInfo(image->magick,exception);
1139 (void) CopyMagickString(image->filename,filename,
1142 if ((magick_info == (const MagickInfo *) NULL) ||
1143 (GetImageEncoder(magick_info) == (EncodeImageHandler *) NULL))
1145 magick_info=GetMagickInfo(image->magick,exception);
1146 if ((magick_info == (const MagickInfo *) NULL) ||
1147 (GetImageEncoder(magick_info) == (EncodeImageHandler *) NULL))
1148 (void) ThrowMagickException(exception,GetMagickModule(),
1149 MissingDelegateError,"NoEncodeDelegateForThisImageFormat",
1150 "`%s'",write_info->magick);
1152 (void) ThrowMagickException(exception,GetMagickModule(),
1153 MissingDelegateWarning,"NoEncodeDelegateForThisImageFormat",
1154 "`%s'",write_info->magick);
1156 if ((magick_info != (const MagickInfo *) NULL) &&
1157 (GetImageEncoder(magick_info) != (EncodeImageHandler *) NULL))
1160 Call appropriate image writer based on image type.
1162 if (GetMagickEncoderThreadSupport(magick_info) == MagickFalse)
1163 LockSemaphoreInfo(magick_info->semaphore);
1164 status=GetImageEncoder(magick_info)(write_info,image,exception);
1165 if (GetMagickEncoderThreadSupport(magick_info) == MagickFalse)
1166 UnlockSemaphoreInfo(magick_info->semaphore);
1170 if (temporary != MagickFalse)
1173 Copy temporary image file to permanent.
1175 status=OpenBlob(write_info,image,ReadBinaryBlobMode,exception);
1176 if (status != MagickFalse)
1178 (void) RelinquishUniqueFileResource(write_info->filename);
1179 status=ImageToFile(image,write_info->filename,exception);
1181 (void) CloseBlob(image);
1182 (void) RelinquishUniqueFileResource(image->filename);
1183 (void) CopyMagickString(image->filename,write_info->filename,
1186 if ((LocaleCompare(write_info->magick,"info") != 0) &&
1187 (write_info->verbose != MagickFalse))
1188 (void) IdentifyImage(image,stdout,MagickFalse,exception);
1189 write_info=DestroyImageInfo(write_info);
1194 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1198 % W r i t e I m a g e s %
1202 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1204 % WriteImages() writes an image sequence into one or more files. While
1205 % WriteImage() can write an image sequence, it is limited to writing
1206 % the sequence into a single file using a format which supports multiple
1207 % frames. WriteImages(), however, does not have this limitation, instead it
1208 % generates multiple output files if necessary (or when requested). When
1209 % ImageInfo's adjoin flag is set to MagickFalse, the file name is expected
1210 % to include a printf-style formatting string for the frame number (e.g.
1213 % The format of the WriteImages method is:
1215 % MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
1216 % const char *filename,ExceptionInfo *exception)
1218 % A description of each parameter follows:
1220 % o image_info: the image info.
1222 % o images: the image list.
1224 % o filename: the image filename.
1226 % o exception: return any errors or warnings in this structure.
1229 MagickExport MagickBooleanType WriteImages(const ImageInfo *image_info,
1230 Image *images,const char *filename,ExceptionInfo *exception)
1232 #define WriteImageTag "Write/Image"
1246 MagickProgressMonitor
1258 assert(image_info != (const ImageInfo *) NULL);
1259 assert(image_info->signature == MagickCoreSignature);
1260 assert(images != (Image *) NULL);
1261 assert(images->signature == MagickCoreSignature);
1262 if (images->debug != MagickFalse)
1263 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
1264 assert(exception != (ExceptionInfo *) NULL);
1265 write_info=CloneImageInfo(image_info);
1266 *write_info->magick='\0';
1267 images=GetFirstImageInList(images);
1268 if (filename != (const char *) NULL)
1269 for (p=images; p != (Image *) NULL; p=GetNextImageInList(p))
1270 (void) CopyMagickString(p->filename,filename,MagickPathExtent);
1271 (void) CopyMagickString(write_info->filename,images->filename,
1273 sans_exception=AcquireExceptionInfo();
1274 (void) SetImageInfo(write_info,(unsigned int) GetImageListLength(images),
1276 sans_exception=DestroyExceptionInfo(sans_exception);
1277 if (*write_info->magick == '\0')
1278 (void) CopyMagickString(write_info->magick,images->magick,MagickPathExtent);
1280 for ( ; GetNextImageInList(p) != (Image *) NULL; p=GetNextImageInList(p))
1285 next=GetNextImageInList(p);
1286 if (next == (Image *) NULL)
1288 if (p->scene >= next->scene)
1294 Generate consistent scene numbers.
1296 i=(ssize_t) images->scene;
1297 for (p=images; p != (Image *) NULL; p=GetNextImageInList(p))
1298 p->scene=(size_t) i++;
1306 progress_monitor=(MagickProgressMonitor) NULL;
1308 number_images=GetImageListLength(images);
1309 for (p=images; p != (Image *) NULL; p=GetNextImageInList(p))
1311 if (number_images != 1)
1312 progress_monitor=SetImageProgressMonitor(p,(MagickProgressMonitor) NULL,
1314 status&=WriteImage(write_info,p,exception);
1315 if (number_images != 1)
1316 (void) SetImageProgressMonitor(p,progress_monitor,p->client_data);
1317 if (write_info->adjoin != MagickFalse)
1319 if (number_images != 1)
1321 proceed=SetImageProgress(p,WriteImageTag,progress++,number_images);
1322 if (proceed == MagickFalse)
1326 write_info=DestroyImageInfo(write_info);
1327 return(status != 0 ? MagickTrue : MagickFalse);