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-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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "MagickCore/studio.h"
43 #include "MagickCore/blob.h"
44 #include "MagickCore/blob-private.h"
45 #include "MagickCore/exception.h"
46 #include "MagickCore/exception-private.h"
47 #include "MagickCore/cache.h"
48 #include "MagickCore/client.h"
49 #include "MagickCore/constitute.h"
50 #include "MagickCore/constitute-private.h"
51 #include "MagickCore/delegate.h"
52 #include "MagickCore/geometry.h"
53 #include "MagickCore/identify.h"
54 #include "MagickCore/image-private.h"
55 #include "MagickCore/list.h"
56 #include "MagickCore/magick.h"
57 #include "MagickCore/memory_.h"
58 #include "MagickCore/monitor.h"
59 #include "MagickCore/monitor-private.h"
60 #include "MagickCore/option.h"
61 #include "MagickCore/pixel.h"
62 #include "MagickCore/pixel-accessor.h"
63 #include "MagickCore/policy.h"
64 #include "MagickCore/profile.h"
65 #include "MagickCore/profile-private.h"
66 #include "MagickCore/property.h"
67 #include "MagickCore/quantum.h"
68 #include "MagickCore/resize.h"
69 #include "MagickCore/resource_.h"
70 #include "MagickCore/semaphore.h"
71 #include "MagickCore/statistic.h"
72 #include "MagickCore/stream.h"
73 #include "MagickCore/string_.h"
74 #include "MagickCore/string-private.h"
75 #include "MagickCore/timer.h"
76 #include "MagickCore/transform.h"
77 #include "MagickCore/utility.h"
78 #include "MagickCore/utility-private.h"
81 *constitute_semaphore = (SemaphoreInfo *) NULL;
84 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
88 + C o n s t i t u t e C o m p o n e n t G e n e s i s %
92 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
94 % ConstituteComponentGenesis() instantiates the constitute component.
96 % The format of the ConstituteComponentGenesis method is:
98 % MagickBooleanType ConstituteComponentGenesis(void)
101 MagickPrivate MagickBooleanType ConstituteComponentGenesis(void)
103 AcquireSemaphoreInfo(&constitute_semaphore);
108 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
112 + C o n s t i t u t e C o m p o n e n t T e r m i n u s %
116 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
118 % ConstituteComponentTerminus() destroys the constitute component.
120 % The format of the ConstituteComponentTerminus method is:
122 % ConstituteComponentTerminus(void)
125 MagickPrivate void ConstituteComponentTerminus(void)
127 if (constitute_semaphore == (SemaphoreInfo *) NULL)
128 AcquireSemaphoreInfo(&constitute_semaphore);
129 DestroySemaphoreInfo(&constitute_semaphore);
133 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
137 % C o n s t i t u t e I m a g e %
141 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
143 % ConstituteImage() returns an image from the pixel data you supply.
144 % The pixel data must be in scanline order top-to-bottom. The data can be
145 % char, short int, int, float, or double. Float and double require the
146 % pixels to be normalized [0..1], otherwise [0..QuantumRange]. For example, to
147 % create a 640x480 image from unsigned red-green-blue character data, use:
149 % image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
151 % The format of the ConstituteImage method is:
153 % Image *ConstituteImage(const size_t columns,const size_t rows,
154 % const char *map,const StorageType storage,const void *pixels,
155 % ExceptionInfo *exception)
157 % A description of each parameter follows:
159 % o columns: width in pixels of the image.
161 % o rows: height in pixels of the image.
163 % o map: This string reflects the expected ordering of the pixel array.
164 % It can be any combination or order of R = red, G = green, B = blue,
165 % A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan,
166 % Y = yellow, M = magenta, K = black, I = intensity (for grayscale),
169 % o storage: Define the data type of the pixels. Float and double types are
170 % expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose
171 % from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel,
172 % LongPixel, QuantumPixel, or ShortPixel.
174 % o pixels: This array of values contain the pixel components as defined by
175 % map and type. You must preallocate this array where the expected
176 % length varies depending on the values of width, height, map, and type.
178 % o exception: return any errors or warnings in this structure.
181 MagickExport Image *ConstituteImage(const size_t columns,
182 const size_t rows,const char *map,const StorageType storage,
183 const void *pixels,ExceptionInfo *exception)
192 Allocate image structure.
194 assert(map != (const char *) NULL);
195 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",map);
196 assert(pixels != (void *) NULL);
197 assert(exception != (ExceptionInfo *) NULL);
198 assert(exception->signature == MagickSignature);
199 image=AcquireImage((ImageInfo *) NULL);
200 if (image == (Image *) NULL)
201 return((Image *) NULL);
202 if ((columns == 0) || (rows == 0))
203 ThrowImageException(OptionError,"NonZeroWidthAndHeightRequired");
204 image->columns=columns;
206 (void) SetImageBackgroundColor(image);
207 status=ImportImagePixels(image,0,0,columns,rows,map,storage,pixels,exception);
208 if (status == MagickFalse)
209 image=DestroyImage(image);
214 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
218 % P i n g I m a g e %
222 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
224 % PingImage() returns all the properties of an image or image sequence
225 % except for the pixels. It is much faster and consumes far less memory
226 % than ReadImage(). On failure, a NULL image is returned and exception
227 % describes the reason for the failure.
229 % The format of the PingImage method is:
231 % Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
233 % A description of each parameter follows:
235 % o image_info: Ping the image defined by the file or filename members of
238 % o exception: return any errors or warnings in this structure.
242 #if defined(__cplusplus) || defined(c_plusplus)
246 static size_t PingStream(const Image *magick_unused(image),
247 const void *magick_unused(pixels),const size_t columns)
252 #if defined(__cplusplus) || defined(c_plusplus)
256 MagickExport Image *PingImage(const ImageInfo *image_info,
257 ExceptionInfo *exception)
265 assert(image_info != (ImageInfo *) NULL);
266 assert(image_info->signature == MagickSignature);
267 if (image_info->debug != MagickFalse)
268 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
269 image_info->filename);
270 assert(exception != (ExceptionInfo *) NULL);
271 ping_info=CloneImageInfo(image_info);
272 ping_info->ping=MagickTrue;
273 image=ReadStream(ping_info,&PingStream,exception);
274 if (image != (Image *) NULL)
276 ResetTimer(&image->timer);
277 if (ping_info->verbose != MagickFalse)
278 (void) IdentifyImage(image,stdout,MagickFalse,exception);
280 ping_info=DestroyImageInfo(ping_info);
285 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
289 % P i n g I m a g e s %
293 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
295 % PingImages() pings one or more images and returns them as an image list.
297 % The format of the PingImage method is:
299 % Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
301 % A description of each parameter follows:
303 % o image_info: the image info.
305 % o exception: return any errors or warnings in this structure.
308 MagickExport Image *PingImages(const ImageInfo *image_info,
309 ExceptionInfo *exception)
312 filename[MaxTextExtent];
322 Ping image list from a file.
324 assert(image_info != (ImageInfo *) NULL);
325 assert(image_info->signature == MagickSignature);
326 if (image_info->debug != MagickFalse)
327 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
328 image_info->filename);
329 assert(exception != (ExceptionInfo *) NULL);
330 (void) InterpretImageFilename(image_info,(Image *) NULL,image_info->filename,
331 (int) image_info->scene,filename);
332 if (LocaleCompare(filename,image_info->filename) != 0)
342 Images of the form image-%d.png[1-5].
344 read_info=CloneImageInfo(image_info);
345 sans=AcquireExceptionInfo();
346 (void) SetImageInfo(read_info,0,sans);
347 sans=DestroyExceptionInfo(sans);
348 (void) CopyMagickString(filename,read_info->filename,MaxTextExtent);
349 images=NewImageList();
350 extent=(ssize_t) (read_info->scene+read_info->number_scenes);
351 for (scene=(ssize_t) read_info->scene; scene < (ssize_t) extent; scene++)
353 (void) InterpretImageFilename(image_info,(Image *) NULL,filename,(int)
354 scene,read_info->filename);
355 image=PingImage(read_info,exception);
356 if (image == (Image *) NULL)
358 AppendImageToList(&images,image);
360 read_info=DestroyImageInfo(read_info);
363 return(PingImage(image_info,exception));
367 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
371 % R e a d I m a g e %
375 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
377 % ReadImage() reads an image or image sequence from a file or file handle.
378 % The method returns a NULL if there is a memory shortage or if the image
379 % cannot be read. On failure, a NULL image is returned and exception
380 % describes the reason for the failure.
382 % The format of the ReadImage method is:
384 % Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
386 % A description of each parameter follows:
388 % o image_info: Read the image defined by the file or filename members of
391 % o exception: return any errors or warnings in this structure.
394 MagickExport Image *ReadImage(const ImageInfo *image_info,
395 ExceptionInfo *exception)
398 filename[MaxTextExtent],
399 magick[MaxTextExtent],
400 magick_filename[MaxTextExtent];
435 Determine image type from filename prefix or suffix (e.g. image.jpg).
437 assert(image_info != (ImageInfo *) NULL);
438 assert(image_info->signature == MagickSignature);
439 assert(image_info->filename != (char *) NULL);
440 if (image_info->debug != MagickFalse)
441 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
442 image_info->filename);
443 assert(exception != (ExceptionInfo *) NULL);
444 read_info=CloneImageInfo(image_info);
445 (void) CopyMagickString(magick_filename,read_info->filename,MaxTextExtent);
446 (void) SetImageInfo(read_info,0,exception);
447 (void) CopyMagickString(filename,read_info->filename,MaxTextExtent);
448 (void) CopyMagickString(magick,read_info->magick,MaxTextExtent);
449 domain=CoderPolicyDomain;
450 rights=ReadPolicyRights;
451 if (IsRightsAuthorized(domain,rights,read_info->magick) == MagickFalse)
454 (void) ThrowMagickException(exception,GetMagickModule(),PolicyError,
455 "NotAuthorized","`%s'",read_info->filename);
456 return((Image *) NULL);
459 Call appropriate image reader based on image type.
461 sans_exception=AcquireExceptionInfo();
462 magick_info=GetMagickInfo(read_info->magick,sans_exception);
463 sans_exception=DestroyExceptionInfo(sans_exception);
464 if (magick_info != (const MagickInfo *) NULL)
466 if (GetMagickEndianSupport(magick_info) == MagickFalse)
467 read_info->endian=UndefinedEndian;
469 if ((image_info->endian == UndefinedEndian) &&
470 (GetMagickRawSupport(magick_info) != MagickFalse))
476 read_info->endian=(*(char *) &lsb_first) == 1 ? LSBEndian :
480 if ((magick_info != (const MagickInfo *) NULL) &&
481 (GetMagickSeekableStream(magick_info) != MagickFalse))
486 image=AcquireImage(read_info);
487 (void) CopyMagickString(image->filename,read_info->filename,
489 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
490 if (status == MagickFalse)
492 read_info=DestroyImageInfo(read_info);
493 image=DestroyImage(image);
494 return((Image *) NULL);
496 if (IsBlobSeekable(image) == MagickFalse)
499 Coder requires a seekable stream.
501 *read_info->filename='\0';
502 status=ImageToFile(image,read_info->filename,exception);
503 if (status == MagickFalse)
505 (void) CloseBlob(image);
506 read_info=DestroyImageInfo(read_info);
507 image=DestroyImage(image);
508 return((Image *) NULL);
510 read_info->temporary=MagickTrue;
512 (void) CloseBlob(image);
513 image=DestroyImage(image);
515 image=NewImageList();
516 if (constitute_semaphore == (SemaphoreInfo *) NULL)
517 AcquireSemaphoreInfo(&constitute_semaphore);
518 if ((magick_info != (const MagickInfo *) NULL) &&
519 (GetImageDecoder(magick_info) != (DecodeImageHandler *) NULL))
521 thread_support=GetMagickThreadSupport(magick_info);
522 if ((thread_support & DecoderThreadSupport) == 0)
523 LockSemaphoreInfo(constitute_semaphore);
524 image=GetImageDecoder(magick_info)(read_info,exception);
525 if ((thread_support & DecoderThreadSupport) == 0)
526 UnlockSemaphoreInfo(constitute_semaphore);
530 delegate_info=GetDelegateInfo(read_info->magick,(char *) NULL,exception);
531 if (delegate_info == (const DelegateInfo *) NULL)
533 (void) ThrowMagickException(exception,GetMagickModule(),
534 MissingDelegateError,"NoDecodeDelegateForThisImageFormat","`%s'",
535 read_info->filename);
536 if (read_info->temporary != MagickFalse)
537 (void) RelinquishUniqueFileResource(read_info->filename);
538 read_info=DestroyImageInfo(read_info);
539 return((Image *) NULL);
542 Let our decoding delegate process the image.
544 image=AcquireImage(read_info);
545 if (image == (Image *) NULL)
547 read_info=DestroyImageInfo(read_info);
548 return((Image *) NULL);
550 (void) CopyMagickString(image->filename,read_info->filename,
552 *read_info->filename='\0';
553 if (GetDelegateThreadSupport(delegate_info) == MagickFalse)
554 LockSemaphoreInfo(constitute_semaphore);
555 (void) InvokeDelegate(read_info,image,read_info->magick,(char *) NULL,
557 if (GetDelegateThreadSupport(delegate_info) == MagickFalse)
558 UnlockSemaphoreInfo(constitute_semaphore);
559 image=DestroyImageList(image);
560 read_info->temporary=MagickTrue;
561 (void) SetImageInfo(read_info,0,exception);
562 magick_info=GetMagickInfo(read_info->magick,exception);
563 if ((magick_info == (const MagickInfo *) NULL) ||
564 (GetImageDecoder(magick_info) == (DecodeImageHandler *) NULL))
566 if (IsPathAccessible(read_info->filename) != MagickFalse)
567 (void) ThrowMagickException(exception,GetMagickModule(),
568 MissingDelegateError,"NoDecodeDelegateForThisImageFormat","`%s'",
569 read_info->filename);
571 ThrowFileException(exception,FileOpenError,"UnableToOpenFile",
572 read_info->filename);
573 read_info=DestroyImageInfo(read_info);
574 return((Image *) NULL);
576 thread_support=GetMagickThreadSupport(magick_info);
577 if ((thread_support & DecoderThreadSupport) == 0)
578 LockSemaphoreInfo(constitute_semaphore);
579 image=(Image *) (GetImageDecoder(magick_info))(read_info,exception);
580 if ((thread_support & DecoderThreadSupport) == 0)
581 UnlockSemaphoreInfo(constitute_semaphore);
583 if (read_info->temporary != MagickFalse)
585 (void) RelinquishUniqueFileResource(read_info->filename);
586 read_info->temporary=MagickFalse;
587 if (image != (Image *) NULL)
588 (void) CopyMagickString(image->filename,filename,MaxTextExtent);
590 if (image == (Image *) NULL)
592 read_info=DestroyImageInfo(read_info);
595 if (exception->severity >= ErrorException)
596 (void) LogMagickEvent(ExceptionEvent,GetMagickModule(),
597 "Coder (%s) generated an image despite an error (%d), "
598 "notify the developers",image->magick,exception->severity);
599 if (IsBlobTemporary(image) != MagickFalse)
600 (void) RelinquishUniqueFileResource(read_info->filename);
601 if ((GetNextImageInList(image) != (Image *) NULL) &&
602 (IsSceneGeometry(read_info->scenes,MagickFalse) != MagickFalse))
607 clones=CloneImages(image,read_info->scenes,exception);
608 if (clones == (Image *) NULL)
609 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
610 "SubimageSpecificationReturnsNoImages","`%s'",read_info->filename);
613 image=DestroyImageList(image);
614 image=GetFirstImageInList(clones);
617 if (GetBlobError(image) != MagickFalse)
619 ThrowFileException(exception,FileOpenError,
620 "AnErrorHasOccurredReadingFromFile",read_info->filename);
621 image=DestroyImageList(image);
622 read_info=DestroyImageInfo(read_info);
623 return((Image *) NULL);
625 for (next=image; next != (Image *) NULL; next=GetNextImageInList(next))
628 magick_path[MaxTextExtent],
630 timestamp[MaxTextExtent];
638 next->taint=MagickFalse;
639 GetPathComponent(magick_filename,MagickPath,magick_path);
640 if (*magick_path == '\0')
641 (void) CopyMagickString(next->magick,magick,MaxTextExtent);
642 (void) CopyMagickString(next->magick_filename,magick_filename,
644 if (IsBlobTemporary(image) != MagickFalse)
645 (void) CopyMagickString(next->filename,filename,MaxTextExtent);
646 if (next->magick_columns == 0)
647 next->magick_columns=next->columns;
648 if (next->magick_rows == 0)
649 next->magick_rows=next->rows;
650 value=GetImageProperty(next,"tiff:Orientation");
651 if (value == (char *) NULL)
652 value=GetImageProperty(next,"exif:Orientation");
653 if (value != (char *) NULL)
655 next->orientation=(OrientationType) StringToLong(value);
656 (void) DeleteImageProperty(next,"tiff:Orientation");
657 (void) DeleteImageProperty(next,"exif:Orientation");
659 value=GetImageProperty(next,"exif:XResolution");
660 if (value != (char *) NULL)
662 geometry_info.rho=next->x_resolution;
663 geometry_info.sigma=1.0;
664 flags=ParseGeometry(value,&geometry_info);
665 if (geometry_info.sigma != 0)
666 next->x_resolution=geometry_info.rho/geometry_info.sigma;
667 (void) DeleteImageProperty(next,"exif:XResolution");
669 value=GetImageProperty(next,"exif:YResolution");
670 if (value != (char *) NULL)
672 geometry_info.rho=next->y_resolution;
673 geometry_info.sigma=1.0;
674 flags=ParseGeometry(value,&geometry_info);
675 if (geometry_info.sigma != 0)
676 next->y_resolution=geometry_info.rho/geometry_info.sigma;
677 (void) DeleteImageProperty(next,"exif:YResolution");
679 value=GetImageProperty(next,"tiff:ResolutionUnit");
680 if (value == (char *) NULL)
681 value=GetImageProperty(next,"exif:ResolutionUnit");
682 if (value != (char *) NULL)
684 next->units=(ResolutionType) (StringToLong(value)-1);
685 (void) DeleteImageProperty(next,"exif:ResolutionUnit");
686 (void) DeleteImageProperty(next,"tiff:ResolutionUnit");
688 if (next->page.width == 0)
689 next->page.width=next->columns;
690 if (next->page.height == 0)
691 next->page.height=next->rows;
692 option=GetImageOption(read_info,"caption");
693 if (option != (const char *) NULL)
695 property=InterpretImageProperties(read_info,next,option,exception);
696 (void) SetImageProperty(next,"caption",property);
697 property=DestroyString(property);
699 option=GetImageOption(read_info,"comment");
700 if (option != (const char *) NULL)
702 property=InterpretImageProperties(read_info,next,option,exception);
703 (void) SetImageProperty(next,"comment",property);
704 property=DestroyString(property);
706 option=GetImageOption(read_info,"label");
707 if (option != (const char *) NULL)
709 property=InterpretImageProperties(read_info,next,option,exception);
710 (void) SetImageProperty(next,"label",property);
711 property=DestroyString(property);
713 if (LocaleCompare(next->magick,"TEXT") == 0)
714 (void) ParseAbsoluteGeometry("0x0+0+0",&next->page);
715 if ((read_info->extract != (char *) NULL) &&
716 (read_info->stream == (StreamHandler) NULL))
721 flags=ParseAbsoluteGeometry(read_info->extract,&geometry);
722 if ((next->columns != geometry.width) ||
723 (next->rows != geometry.height))
725 if (((flags & XValue) != 0) || ((flags & YValue) != 0))
730 crop_image=CropImage(next,&geometry,exception);
731 if (crop_image != (Image *) NULL)
732 ReplaceImageInList(&next,crop_image);
735 if (((flags & WidthValue) != 0) || ((flags & HeightValue) != 0))
740 flags=ParseRegionGeometry(next,read_info->extract,&geometry,
742 size_image=ResizeImage(next,geometry.width,geometry.height,
743 next->filter,next->blur,exception);
744 if (size_image != (Image *) NULL)
745 ReplaceImageInList(&next,size_image);
749 profile=GetImageProfile(next,"icc");
750 if (profile == (const StringInfo *) NULL)
751 profile=GetImageProfile(next,"icm");
752 profile=GetImageProfile(next,"iptc");
753 if (profile == (const StringInfo *) NULL)
754 profile=GetImageProfile(next,"8bim");
755 (void) FormatMagickTime(GetBlobProperties(next)->st_mtime,MaxTextExtent,
757 (void) SetImageProperty(next,"date:modify",timestamp);
758 (void) FormatMagickTime(GetBlobProperties(next)->st_ctime,MaxTextExtent,
760 (void) SetImageProperty(next,"date:create",timestamp);
761 option=GetImageOption(image_info,"delay");
762 if (option != (const char *) NULL)
767 flags=ParseGeometry(option,&geometry_info);
768 if ((flags & GreaterValue) != 0)
770 if (next->delay > (size_t) floor(geometry_info.rho+0.5))
771 next->delay=(size_t) floor(geometry_info.rho+0.5);
774 if ((flags & LessValue) != 0)
776 if (next->delay < (size_t) floor(geometry_info.rho+0.5))
777 next->ticks_per_second=(ssize_t) floor(geometry_info.sigma+0.5);
780 next->delay=(size_t) floor(geometry_info.rho+0.5);
781 if ((flags & SigmaValue) != 0)
782 next->ticks_per_second=(ssize_t) floor(geometry_info.sigma+0.5);
784 option=GetImageOption(image_info,"dispose");
785 if (option != (const char *) NULL)
786 next->dispose=(DisposeType) ParseCommandOption(MagickDisposeOptions,
788 if (read_info->verbose != MagickFalse)
789 (void) IdentifyImage(next,stderr,MagickFalse,exception);
792 read_info=DestroyImageInfo(read_info);
793 return(GetFirstImageInList(image));
797 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
801 % R e a d I m a g e s %
805 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
807 % ReadImages() reads one or more images and returns them as an image list.
809 % The format of the ReadImage method is:
811 % Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
813 % A description of each parameter follows:
815 % o image_info: the image info.
817 % o exception: return any errors or warnings in this structure.
820 MagickExport Image *ReadImages(const ImageInfo *image_info,
821 ExceptionInfo *exception)
824 filename[MaxTextExtent];
834 Read image list from a file.
836 assert(image_info != (ImageInfo *) NULL);
837 assert(image_info->signature == MagickSignature);
838 if (image_info->debug != MagickFalse)
839 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
840 image_info->filename);
841 assert(exception != (ExceptionInfo *) NULL);
842 (void) InterpretImageFilename(image_info,(Image *) NULL,image_info->filename,
843 (int) image_info->scene,filename);
844 if (LocaleCompare(filename,image_info->filename) != 0)
854 Images of the form image-%d.png[1-5].
856 read_info=CloneImageInfo(image_info);
857 sans=AcquireExceptionInfo();
858 (void) SetImageInfo(read_info,0,sans);
859 sans=DestroyExceptionInfo(sans);
860 if (read_info->number_scenes == 0)
862 read_info=DestroyImageInfo(read_info);
863 return(ReadImage(image_info,exception));
865 (void) CopyMagickString(filename,read_info->filename,MaxTextExtent);
866 images=NewImageList();
867 extent=(ssize_t) (read_info->scene+read_info->number_scenes);
868 for (scene=(ssize_t) read_info->scene; scene < (ssize_t) extent; scene++)
870 (void) InterpretImageFilename(image_info,(Image *) NULL,filename,(int)
871 scene,read_info->filename);
872 image=ReadImage(read_info,exception);
873 if (image == (Image *) NULL)
875 AppendImageToList(&images,image);
877 read_info=DestroyImageInfo(read_info);
880 return(ReadImage(image_info,exception));
884 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
888 + R e a d I n l i n e I m a g e %
892 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
894 % ReadInlineImage() reads a Base64-encoded inline image or image sequence.
895 % The method returns a NULL if there is a memory shortage or if the image
896 % cannot be read. On failure, a NULL image is returned and exception
897 % describes the reason for the failure.
899 % The format of the ReadInlineImage method is:
901 % Image *ReadInlineImage(const ImageInfo *image_info,const char *content,
902 % ExceptionInfo *exception)
904 % A description of each parameter follows:
906 % o image_info: the image info.
908 % o content: the image encoded in Base64.
910 % o exception: return any errors or warnings in this structure.
913 MagickExport Image *ReadInlineImage(const ImageInfo *image_info,
914 const char *content,ExceptionInfo *exception)
932 Skip over header (e.g. data:image/gif;base64,).
934 image=NewImageList();
935 for (p=content; (*p != ',') && (*p != '\0'); p++) ;
937 ThrowReaderException(CorruptImageError,"CorruptImage");
940 blob=Base64Decode(p,&length);
942 ThrowReaderException(CorruptImageError,"CorruptImage");
943 read_info=CloneImageInfo(image_info);
944 (void) SetImageInfoProgressMonitor(read_info,(MagickProgressMonitor) NULL,
946 *read_info->filename='\0';
947 *read_info->magick='\0';
948 image=BlobToImage(read_info,blob,length,exception);
949 blob=(unsigned char *) RelinquishMagickMemory(blob);
950 read_info=DestroyImageInfo(read_info);
955 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
959 % W r i t e I m a g e %
963 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
965 % WriteImage() writes an image or an image sequence to a file or file handle.
966 % If writing to a file is on disk, the name is defined by the filename member
967 % of the image structure. WriteImage() returns MagickFalse is there is a
968 % memory shortage or if the image cannot be written. Check the exception
969 % member of image to determine the cause for any failure.
971 % The format of the WriteImage method is:
973 % MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image,
974 % ExceptionInfo *exception)
976 % A description of each parameter follows:
978 % o image_info: the image info.
980 % o image: the image.
982 % o exception: return any errors or warnings in this structure.
985 MagickExport MagickBooleanType WriteImage(const ImageInfo *image_info,
986 Image *image,ExceptionInfo *exception)
989 filename[MaxTextExtent];
1020 Determine image type from filename prefix or suffix (e.g. image.jpg).
1022 assert(image_info != (ImageInfo *) NULL);
1023 assert(image_info->signature == MagickSignature);
1024 if (image->debug != MagickFalse)
1025 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1026 image_info->filename);
1027 assert(image != (Image *) NULL);
1028 assert(image->signature == MagickSignature);
1029 assert(exception != (ExceptionInfo *) NULL);
1030 sans_exception=AcquireExceptionInfo();
1031 write_info=CloneImageInfo(image_info);
1032 (void) CopyMagickString(write_info->filename,image->filename,MaxTextExtent);
1033 if (*write_info->magick == '\0')
1034 (void) CopyMagickString(write_info->magick,image->magick,MaxTextExtent);
1035 (void) SetImageInfo(write_info,1,sans_exception);
1036 if (LocaleCompare(write_info->magick,"clipmask") == 0)
1038 if (image->clip_mask == (Image *) NULL)
1040 (void) ThrowMagickException(exception,GetMagickModule(),
1041 OptionError,"NoClipPathDefined","`%s'",image->filename);
1042 return(MagickFalse);
1044 image=image->clip_mask;
1045 (void) SetImageInfo(write_info,1,sans_exception);
1047 (void) CopyMagickString(filename,image->filename,MaxTextExtent);
1048 (void) CopyMagickString(image->filename,write_info->filename,MaxTextExtent);
1049 domain=CoderPolicyDomain;
1050 rights=WritePolicyRights;
1051 if (IsRightsAuthorized(domain,rights,write_info->magick) == MagickFalse)
1053 sans_exception=DestroyExceptionInfo(sans_exception);
1055 ThrowBinaryException(PolicyError,"NotAuthorized",filename);
1057 magick_info=GetMagickInfo(write_info->magick,sans_exception);
1058 sans_exception=DestroyExceptionInfo(sans_exception);
1059 if (magick_info != (const MagickInfo *) NULL)
1061 if (GetMagickEndianSupport(magick_info) == MagickFalse)
1062 image->endian=UndefinedEndian;
1064 if ((image_info->endian == UndefinedEndian) &&
1065 (GetMagickRawSupport(magick_info) != MagickFalse))
1071 image->endian=(*(char *) &lsb_first) == 1 ? LSBEndian : MSBEndian;
1074 (void) SyncImageProfiles(image);
1075 option=GetImageOption(image_info,"delegate:bimodal");
1076 if ((option != (const char *) NULL) &&
1077 (IsMagickTrue(option) != MagickFalse) &&
1078 (write_info->page == (char *) NULL) &&
1079 (GetPreviousImageInList(image) == (Image *) NULL) &&
1080 (GetNextImageInList(image) == (Image *) NULL) &&
1081 (IsTaintImage(image) == MagickFalse))
1083 delegate_info=GetDelegateInfo(image->magick,write_info->magick,exception);
1084 if ((delegate_info != (const DelegateInfo *) NULL) &&
1085 (GetDelegateMode(delegate_info) == 0) &&
1086 (IsPathAccessible(image->magick_filename) != MagickFalse))
1089 Process image with bi-modal delegate.
1091 (void) CopyMagickString(image->filename,image->magick_filename,
1093 status=InvokeDelegate(write_info,image,image->magick,
1094 write_info->magick,exception);
1095 write_info=DestroyImageInfo(write_info);
1096 (void) CopyMagickString(image->filename,filename,MaxTextExtent);
1101 temporary=MagickFalse;
1102 if ((magick_info != (const MagickInfo *) NULL) &&
1103 (GetMagickSeekableStream(magick_info) != MagickFalse))
1106 filename[MaxTextExtent];
1108 (void) CopyMagickString(filename,image->filename,MaxTextExtent);
1109 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
1110 (void) CopyMagickString(image->filename,filename,MaxTextExtent);
1111 if (status != MagickFalse)
1113 if (IsBlobSeekable(image) == MagickFalse)
1116 A seekable stream is required by the encoder.
1118 write_info->adjoin=MagickTrue;
1119 (void) CopyMagickString(write_info->filename,image->filename,
1121 (void) AcquireUniqueFilename(image->filename);
1122 temporary=MagickTrue;
1124 (void) CloseBlob(image);
1127 if (constitute_semaphore == (SemaphoreInfo *) NULL)
1128 AcquireSemaphoreInfo(&constitute_semaphore);
1129 if ((magick_info != (const MagickInfo *) NULL) &&
1130 (GetImageEncoder(magick_info) != (EncodeImageHandler *) NULL))
1133 Call appropriate image writer based on image type.
1135 thread_support=GetMagickThreadSupport(magick_info);
1136 if ((thread_support & EncoderThreadSupport) == 0)
1137 LockSemaphoreInfo(constitute_semaphore);
1138 status=GetImageEncoder(magick_info)(write_info,image,exception);
1139 if ((thread_support & EncoderThreadSupport) == 0)
1140 UnlockSemaphoreInfo(constitute_semaphore);
1144 delegate_info=GetDelegateInfo((char *) NULL,write_info->magick,exception);
1145 if (delegate_info != (DelegateInfo *) NULL)
1148 Process the image with delegate.
1150 *write_info->filename='\0';
1151 if (GetDelegateThreadSupport(delegate_info) == MagickFalse)
1152 LockSemaphoreInfo(constitute_semaphore);
1153 status=InvokeDelegate(write_info,image,(char *) NULL,
1154 write_info->magick,exception);
1155 if (GetDelegateThreadSupport(delegate_info) == MagickFalse)
1156 UnlockSemaphoreInfo(constitute_semaphore);
1157 (void) CopyMagickString(image->filename,filename,MaxTextExtent);
1161 sans_exception=AcquireExceptionInfo();
1162 magick_info=GetMagickInfo(write_info->magick,sans_exception);
1163 sans_exception=DestroyExceptionInfo(sans_exception);
1164 if ((write_info->affirm == MagickFalse) &&
1165 (magick_info == (const MagickInfo *) NULL))
1167 (void) CopyMagickString(write_info->magick,image->magick,
1169 magick_info=GetMagickInfo(write_info->magick,exception);
1171 if ((magick_info == (const MagickInfo *) NULL) ||
1172 (GetImageEncoder(magick_info) == (EncodeImageHandler *) NULL))
1175 extension[MaxTextExtent];
1177 GetPathComponent(image->filename,ExtensionPath,extension);
1178 if (*extension != '\0')
1179 magick_info=GetMagickInfo(extension,exception);
1181 magick_info=GetMagickInfo(image->magick,exception);
1182 (void) CopyMagickString(image->filename,filename,MaxTextExtent);
1184 if ((magick_info == (const MagickInfo *) NULL) ||
1185 (GetImageEncoder(magick_info) == (EncodeImageHandler *) NULL))
1186 (void) ThrowMagickException(exception,GetMagickModule(),
1187 MissingDelegateError,"NoEncodeDelegateForThisImageFormat","`%s'",
1192 Call appropriate image writer based on image type.
1194 thread_support=GetMagickThreadSupport(magick_info);
1195 if ((thread_support & EncoderThreadSupport) == 0)
1196 LockSemaphoreInfo(constitute_semaphore);
1197 status=GetImageEncoder(magick_info)(write_info,image,exception);
1198 if ((thread_support & EncoderThreadSupport) == 0)
1199 UnlockSemaphoreInfo(constitute_semaphore);
1203 if (GetBlobError(image) != MagickFalse)
1204 ThrowFileException(exception,FileOpenError,
1205 "AnErrorHasOccurredWritingToFile",image->filename);
1206 if (temporary == MagickTrue)
1209 Copy temporary image file to permanent.
1211 status=OpenBlob(write_info,image,ReadBinaryBlobMode,exception);
1212 if (status != MagickFalse)
1213 status=ImageToFile(image,write_info->filename,exception);
1214 (void) CloseBlob(image);
1215 (void) RelinquishUniqueFileResource(image->filename);
1216 (void) CopyMagickString(image->filename,write_info->filename,
1219 if ((LocaleCompare(write_info->magick,"info") != 0) &&
1220 (write_info->verbose != MagickFalse))
1221 (void) IdentifyImage(image,stdout,MagickFalse,exception);
1222 write_info=DestroyImageInfo(write_info);
1227 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1231 % W r i t e I m a g e s %
1235 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1237 % WriteImages() writes an image sequence into one or more files. While
1238 % WriteImage() can write an image sequence, it is limited to writing
1239 % the sequence into a single file using a format which supports multiple
1240 % frames. WriteImages(), however, does not have this limitation, instead it
1241 % generates multiple output files if necessary (or when requested). When
1242 % ImageInfo's adjoin flag is set to MagickFalse, the file name is expected
1243 % to include a printf-style formatting string for the frame number (e.g.
1246 % The format of the WriteImages method is:
1248 % MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
1249 % const char *filename,ExceptionInfo *exception)
1251 % A description of each parameter follows:
1253 % o image_info: the image info.
1255 % o images: the image list.
1257 % o filename: the image filename.
1259 % o exception: return any errors or warnings in this structure.
1262 MagickExport MagickBooleanType WriteImages(const ImageInfo *image_info,
1263 Image *images,const char *filename,ExceptionInfo *exception)
1265 #define WriteImageTag "Write/Image"
1282 MagickProgressMonitor
1294 assert(image_info != (const ImageInfo *) NULL);
1295 assert(image_info->signature == MagickSignature);
1296 assert(images != (Image *) NULL);
1297 assert(images->signature == MagickSignature);
1298 if (images->debug != MagickFalse)
1299 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
1300 assert(exception != (ExceptionInfo *) NULL);
1301 write_info=CloneImageInfo(image_info);
1302 images=GetFirstImageInList(images);
1303 blob=CloneBlobInfo(images->blob); /* thread specific I/O handler */
1304 DestroyBlob(images);
1306 if (filename != (const char *) NULL)
1307 for (p=images; p != (Image *) NULL; p=GetNextImageInList(p))
1308 (void) CopyMagickString(p->filename,filename,MaxTextExtent);
1309 (void) CopyMagickString(write_info->filename,images->filename,MaxTextExtent);
1310 if (*write_info->magick == '\0')
1311 (void) CopyMagickString(write_info->magick,images->magick,MaxTextExtent);
1312 sans_exception=AcquireExceptionInfo();
1313 (void) SetImageInfo(write_info,(unsigned int) GetImageListLength(images),
1315 sans_exception=DestroyExceptionInfo(sans_exception);
1317 for ( ; GetNextImageInList(p) != (Image *) NULL; p=GetNextImageInList(p))
1318 if (p->scene >= GetNextImageInList(p)->scene)
1324 Generate consistent scene numbers.
1326 i=(ssize_t) images->scene;
1327 for (p=images; p != (Image *) NULL; p=GetNextImageInList(p))
1328 p->scene=(size_t) i++;
1335 progress_monitor=(MagickProgressMonitor) NULL;
1337 number_images=GetImageListLength(images);
1338 for (p=images; p != (Image *) NULL; p=GetNextImageInList(p))
1340 if (number_images != 1)
1341 progress_monitor=SetImageProgressMonitor(p,(MagickProgressMonitor) NULL,
1343 status&=WriteImage(write_info,p,exception);
1344 GetImageException(p,exception);
1345 if (number_images != 1)
1346 (void) SetImageProgressMonitor(p,progress_monitor,p->client_data);
1347 if (write_info->adjoin != MagickFalse)
1349 if (number_images != 1)
1351 proceed=SetImageProgress(p,WriteImageTag,i++,number_images);
1352 if (proceed == MagickFalse)
1356 write_info=DestroyImageInfo(write_info);
1357 return(status != 0 ? MagickTrue : MagickFalse);