2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % Read/Write Magick Persistant Cache Image Format %
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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
43 #include "MagickCore/studio.h"
44 #include "MagickCore/artifact.h"
45 #include "MagickCore/attribute.h"
46 #include "MagickCore/blob.h"
47 #include "MagickCore/blob-private.h"
48 #include "MagickCore/cache.h"
49 #include "MagickCore/color.h"
50 #include "MagickCore/color-private.h"
51 #include "MagickCore/colormap.h"
52 #include "MagickCore/constitute.h"
53 #include "MagickCore/exception.h"
54 #include "MagickCore/exception-private.h"
55 #include "MagickCore/geometry.h"
56 #include "MagickCore/image.h"
57 #include "MagickCore/image-private.h"
58 #include "MagickCore/linked-list.h"
59 #include "MagickCore/list.h"
60 #include "MagickCore/magick.h"
61 #include "MagickCore/memory_.h"
62 #include "MagickCore/module.h"
63 #include "MagickCore/monitor.h"
64 #include "MagickCore/monitor-private.h"
65 #include "MagickCore/option.h"
66 #include "MagickCore/profile.h"
67 #include "MagickCore/property.h"
68 #include "MagickCore/quantum-private.h"
69 #include "MagickCore/static.h"
70 #include "MagickCore/statistic.h"
71 #include "MagickCore/string_.h"
72 #include "MagickCore/string-private.h"
73 #include "MagickCore/utility.h"
74 #include "MagickCore/version-private.h"
79 static MagickBooleanType
80 WriteMPCImage(const ImageInfo *,Image *,ExceptionInfo *);
83 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
91 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
93 % IsMPC() returns MagickTrue if the image format type, identified by the
94 % magick string, is an Magick Persistent Cache image.
96 % The format of the IsMPC method is:
98 % MagickBooleanType IsMPC(const unsigned char *magick,const size_t length)
100 % A description of each parameter follows:
102 % o magick: compare image format pattern against these bytes.
104 % o length: Specifies the length of the magick string.
107 static MagickBooleanType IsMPC(const unsigned char *magick,const size_t length)
111 if (LocaleNCompare((const char *) magick,"id=MagickCache",14) == 0)
117 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
121 % R e a d C A C H E I m a g e %
125 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
127 % ReadMPCImage() reads an Magick Persistent Cache image file and returns
128 % it. It allocates the memory necessary for the new Image structure and
129 % returns a pointer to the new image.
131 % The format of the ReadMPCImage method is:
133 % Image *ReadMPCImage(const ImageInfo *image_info,ExceptionInfo *exception)
135 % Decompression code contributed by Kyle Shorter.
137 % A description of each parameter follows:
139 % o image_info: the image info.
141 % o exception: return any errors or warnings in this structure.
144 static Image *ReadMPCImage(const ImageInfo *image_info,ExceptionInfo *exception)
147 cache_filename[MagickPathExtent],
148 id[MagickPathExtent],
149 keyword[MagickPathExtent],
195 assert(image_info != (const ImageInfo *) NULL);
196 assert(image_info->signature == MagickCoreSignature);
197 if (image_info->debug != MagickFalse)
198 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
199 image_info->filename);
200 assert(exception != (ExceptionInfo *) NULL);
201 assert(exception->signature == MagickCoreSignature);
202 image=AcquireImage(image_info,exception);
203 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
204 if (status == MagickFalse)
206 image=DestroyImageList(image);
207 return((Image *) NULL);
209 (void) CopyMagickString(cache_filename,image->filename,MagickPathExtent);
210 AppendImageFormat("cache",cache_filename);
211 c=ReadBlobByte(image);
214 image=DestroyImage(image);
215 return((Image *) NULL);
218 (void) ResetMagickMemory(keyword,0,sizeof(keyword));
223 Decode image header; header terminates one character beyond a ':'.
225 profiles=(LinkedListInfo *) NULL;
226 length=MagickPathExtent;
227 options=AcquireString((char *) NULL);
228 signature=GetMagickSignature((const StringInfo *) NULL);
230 image->compression=NoCompression;
231 while ((isgraph(c) != MagickFalse) && (c != (int) ':'))
242 Read comment-- any text between { }.
244 length=MagickPathExtent;
245 comment=AcquireString((char *) NULL);
246 for (p=comment; comment != (char *) NULL; p++)
248 c=ReadBlobByte(image);
250 c=ReadBlobByte(image);
252 if ((c == EOF) || (c == (int) '}'))
254 if ((size_t) (p-comment+1) >= length)
258 comment=(char *) ResizeQuantumMemory(comment,length+
259 MagickPathExtent,sizeof(*comment));
260 if (comment == (char *) NULL)
262 p=comment+strlen(comment);
266 if (comment == (char *) NULL)
267 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
269 (void) SetImageProperty(image,"comment",comment,exception);
270 comment=DestroyString(comment);
271 c=ReadBlobByte(image);
274 if (isalnum(c) != MagickFalse)
279 length=MagickPathExtent;
285 if ((size_t) (p-keyword) < (MagickPathExtent-1))
287 c=ReadBlobByte(image);
291 while (isspace((int) ((unsigned char) c)) != 0)
292 c=ReadBlobByte(image);
296 Get the keyword value.
298 c=ReadBlobByte(image);
299 while ((c != (int) '}') && (c != EOF))
301 if ((size_t) (p-options+1) >= length)
305 options=(char *) ResizeQuantumMemory(options,length+
306 MagickPathExtent,sizeof(*options));
307 if (options == (char *) NULL)
309 p=options+strlen(options);
312 c=ReadBlobByte(image);
315 c=ReadBlobByte(image);
319 c=ReadBlobByte(image);
323 if (isspace((int) ((unsigned char) c)) != 0)
326 if (options == (char *) NULL)
327 ThrowReaderException(ResourceLimitError,
328 "MemoryAllocationFailed");
332 (void) CopyMagickString(options,options+1,strlen(options));
334 Assign a value to the specified keyword.
341 if (LocaleCompare(keyword,"alpha-color") == 0)
343 (void) QueryColorCompliance(options,AllCompliance,
344 &image->alpha_color,exception);
347 if (LocaleCompare(keyword,"alpha-trait") == 0)
352 alpha_trait=ParseCommandOption(MagickPixelTraitOptions,
353 MagickFalse,options);
356 image->alpha_trait=(PixelTrait) alpha_trait;
359 (void) SetImageProperty(image,keyword,options,exception);
365 if (LocaleCompare(keyword,"background-color") == 0)
367 (void) QueryColorCompliance(options,AllCompliance,
368 &image->background_color,exception);
371 if (LocaleCompare(keyword,"blue-primary") == 0)
373 flags=ParseGeometry(options,&geometry_info);
374 image->chromaticity.blue_primary.x=geometry_info.rho;
375 image->chromaticity.blue_primary.y=geometry_info.sigma;
376 if ((flags & SigmaValue) == 0)
377 image->chromaticity.blue_primary.y=
378 image->chromaticity.blue_primary.x;
381 if (LocaleCompare(keyword,"border-color") == 0)
383 (void) QueryColorCompliance(options,AllCompliance,
384 &image->border_color,exception);
387 (void) SetImageProperty(image,keyword,options,exception);
393 if (LocaleCompare(keyword,"class") == 0)
398 storage_class=ParseCommandOption(MagickClassOptions,
399 MagickFalse,options);
400 if (storage_class < 0)
402 image->storage_class=(ClassType) storage_class;
405 if (LocaleCompare(keyword,"colors") == 0)
407 image->colors=StringToUnsignedLong(options);
410 if (LocaleCompare(keyword,"colorspace") == 0)
415 colorspace=ParseCommandOption(MagickColorspaceOptions,
416 MagickFalse,options);
419 image->colorspace=(ColorspaceType) colorspace;
422 if (LocaleCompare(keyword,"compression") == 0)
427 compression=ParseCommandOption(MagickCompressOptions,
428 MagickFalse,options);
431 image->compression=(CompressionType) compression;
434 if (LocaleCompare(keyword,"columns") == 0)
436 image->columns=StringToUnsignedLong(options);
439 (void) SetImageProperty(image,keyword,options,exception);
445 if (LocaleCompare(keyword,"delay") == 0)
447 image->delay=StringToUnsignedLong(options);
450 if (LocaleCompare(keyword,"depth") == 0)
452 image->depth=StringToUnsignedLong(options);
455 if (LocaleCompare(keyword,"dispose") == 0)
460 dispose=ParseCommandOption(MagickDisposeOptions,MagickFalse,
464 image->dispose=(DisposeType) dispose;
467 (void) SetImageProperty(image,keyword,options,exception);
473 if (LocaleCompare(keyword,"endian") == 0)
478 endian=ParseCommandOption(MagickEndianOptions,MagickFalse,
482 image->endian=(EndianType) endian;
485 if (LocaleCompare(keyword,"error") == 0)
487 image->error.mean_error_per_pixel=StringToDouble(options,
491 (void) SetImageProperty(image,keyword,options,exception);
497 if (LocaleCompare(keyword,"gamma") == 0)
499 image->gamma=StringToDouble(options,(char **) NULL);
502 if (LocaleCompare(keyword,"green-primary") == 0)
504 flags=ParseGeometry(options,&geometry_info);
505 image->chromaticity.green_primary.x=geometry_info.rho;
506 image->chromaticity.green_primary.y=geometry_info.sigma;
507 if ((flags & SigmaValue) == 0)
508 image->chromaticity.green_primary.y=
509 image->chromaticity.green_primary.x;
512 (void) SetImageProperty(image,keyword,options,exception);
518 if (LocaleCompare(keyword,"id") == 0)
520 (void) CopyMagickString(id,options,MagickPathExtent);
523 if (LocaleCompare(keyword,"iterations") == 0)
525 image->iterations=StringToUnsignedLong(options);
528 (void) SetImageProperty(image,keyword,options,exception);
534 if (LocaleCompare(keyword,"magick-signature") == 0)
536 signature=(unsigned int) StringToUnsignedLong(options);
539 if (LocaleCompare(keyword,"maximum-error") == 0)
541 image->error.normalized_maximum_error=StringToDouble(
542 options,(char **) NULL);
545 if (LocaleCompare(keyword,"mean-error") == 0)
547 image->error.normalized_mean_error=StringToDouble(options,
551 if (LocaleCompare(keyword,"montage") == 0)
553 (void) CloneString(&image->montage,options);
556 (void) SetImageProperty(image,keyword,options,exception);
562 if (LocaleCompare(keyword,"orientation") == 0)
567 orientation=ParseCommandOption(MagickOrientationOptions,
568 MagickFalse,options);
571 image->orientation=(OrientationType) orientation;
574 (void) SetImageProperty(image,keyword,options,exception);
580 if (LocaleCompare(keyword,"page") == 0)
585 geometry=GetPageGeometry(options);
586 (void) ParseAbsoluteGeometry(geometry,&image->page);
587 geometry=DestroyString(geometry);
590 if (LocaleCompare(keyword,"pixel-intensity") == 0)
595 intensity=ParseCommandOption(MagickPixelIntensityOptions,
596 MagickFalse,options);
599 image->intensity=(PixelIntensityMethod) intensity;
602 if ((LocaleNCompare(keyword,"profile:",8) == 0) ||
603 (LocaleNCompare(keyword,"profile-",8) == 0))
605 if (profiles == (LinkedListInfo *) NULL)
606 profiles=NewLinkedList(0);
607 (void) AppendValueToLinkedList(profiles,
608 AcquireString(keyword+8));
609 profile=BlobToStringInfo((const void *) NULL,(size_t)
610 StringToLong(options));
611 if (profile == (StringInfo *) NULL)
612 ThrowReaderException(ResourceLimitError,
613 "MemoryAllocationFailed");
614 (void) SetImageProfile(image,keyword+8,profile,exception);
615 profile=DestroyStringInfo(profile);
618 (void) SetImageProperty(image,keyword,options,exception);
624 if (LocaleCompare(keyword,"quality") == 0)
626 image->quality=StringToUnsignedLong(options);
629 (void) SetImageProperty(image,keyword,options,exception);
635 if (LocaleCompare(keyword,"red-primary") == 0)
637 flags=ParseGeometry(options,&geometry_info);
638 image->chromaticity.red_primary.x=geometry_info.rho;
639 if ((flags & SigmaValue) != 0)
640 image->chromaticity.red_primary.y=geometry_info.sigma;
643 if (LocaleCompare(keyword,"rendering-intent") == 0)
648 rendering_intent=ParseCommandOption(MagickIntentOptions,
649 MagickFalse,options);
650 if (rendering_intent < 0)
652 image->rendering_intent=(RenderingIntent) rendering_intent;
655 if (LocaleCompare(keyword,"resolution") == 0)
657 flags=ParseGeometry(options,&geometry_info);
658 image->resolution.x=geometry_info.rho;
659 image->resolution.y=geometry_info.sigma;
660 if ((flags & SigmaValue) == 0)
661 image->resolution.y=image->resolution.x;
664 if (LocaleCompare(keyword,"rows") == 0)
666 image->rows=StringToUnsignedLong(options);
669 (void) SetImageProperty(image,keyword,options,exception);
675 if (LocaleCompare(keyword,"scene") == 0)
677 image->scene=StringToUnsignedLong(options);
680 (void) SetImageProperty(image,keyword,options,exception);
686 if (LocaleCompare(keyword,"ticks-per-second") == 0)
688 image->ticks_per_second=(ssize_t) StringToLong(options);
691 if (LocaleCompare(keyword,"tile-offset") == 0)
696 geometry=GetPageGeometry(options);
697 (void) ParseAbsoluteGeometry(geometry,&image->tile_offset);
698 geometry=DestroyString(geometry);
700 if (LocaleCompare(keyword,"type") == 0)
705 type=ParseCommandOption(MagickTypeOptions,MagickFalse,
709 image->type=(ImageType) type;
712 (void) SetImageProperty(image,keyword,options,exception);
718 if (LocaleCompare(keyword,"units") == 0)
723 units=ParseCommandOption(MagickResolutionOptions,
724 MagickFalse,options);
727 image->units=(ResolutionType) units;
730 (void) SetImageProperty(image,keyword,options,exception);
736 if (LocaleCompare(keyword,"white-point") == 0)
738 flags=ParseGeometry(options,&geometry_info);
739 image->chromaticity.white_point.x=geometry_info.rho;
740 image->chromaticity.white_point.y=geometry_info.sigma;
741 if ((flags & SigmaValue) == 0)
742 image->chromaticity.white_point.y=
743 image->chromaticity.white_point.x;
746 (void) SetImageProperty(image,keyword,options,exception);
751 (void) SetImageProperty(image,keyword,options,exception);
757 c=ReadBlobByte(image);
758 while (isspace((int) ((unsigned char) c)) != 0)
759 c=ReadBlobByte(image);
761 options=DestroyString(options);
762 (void) ReadBlobByte(image);
764 Verify that required image information is defined.
766 if ((LocaleCompare(id,"MagickCache") != 0) ||
767 (image->storage_class == UndefinedClass) ||
768 (image->compression == UndefinedCompression) || (image->columns == 0) ||
770 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
771 if (signature != GetMagickSignature((const StringInfo *) NULL))
772 ThrowReaderException(CacheError,"IncompatibleAPI");
773 if (image->montage != (char *) NULL)
781 length=MagickPathExtent;
782 image->directory=AcquireString((char *) NULL);
787 if ((strlen(image->directory)+MagickPathExtent) >= length)
790 Allocate more memory for the image directory.
793 image->directory=(char *) ResizeQuantumMemory(image->directory,
794 length+MagickPathExtent,sizeof(*image->directory));
795 if (image->directory == (char *) NULL)
796 ThrowReaderException(CorruptImageError,"UnableToReadImageData");
797 p=image->directory+strlen(image->directory);
799 c=ReadBlobByte(image);
801 } while (c != (int) '\0');
803 if (profiles != (LinkedListInfo *) NULL)
811 register unsigned char
817 ResetLinkedListIterator(profiles);
818 name=(const char *) GetNextValueInLinkedList(profiles);
819 while (name != (const char *) NULL)
821 profile=GetImageProfile(image,name);
822 if (profile != (StringInfo *) NULL)
824 p=GetStringInfoDatum(profile);
825 count=ReadBlob(image,GetStringInfoLength(profile),p);
827 name=(const char *) GetNextValueInLinkedList(profiles);
829 profiles=DestroyLinkedList(profiles,RelinquishMagickMemory);
831 depth=GetImageQuantumDepth(image,MagickFalse);
832 if (image->storage_class == PseudoClass)
835 Create image colormap.
837 if (AcquireImageColormap(image,image->colors,exception) == MagickFalse)
838 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
839 if (image->colors != 0)
848 Read image colormap from file.
850 packet_size=(size_t) (3UL*depth/8UL);
851 colormap=(unsigned char *) AcquireQuantumMemory(image->colors,
852 packet_size*sizeof(*colormap));
853 if (colormap == (unsigned char *) NULL)
854 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
855 count=ReadBlob(image,packet_size*image->colors,colormap);
856 if (count != (ssize_t) (packet_size*image->colors))
857 ThrowReaderException(CorruptImageError,
858 "InsufficientImageDataInFile");
863 ThrowReaderException(CorruptImageError,
864 "ImageDepthNotSupported");
870 for (i=0; i < (ssize_t) image->colors; i++)
872 p=PushCharPixel(p,&pixel);
873 image->colormap[i].red=ScaleCharToQuantum(pixel);
874 p=PushCharPixel(p,&pixel);
875 image->colormap[i].green=ScaleCharToQuantum(pixel);
876 p=PushCharPixel(p,&pixel);
877 image->colormap[i].blue=ScaleCharToQuantum(pixel);
886 for (i=0; i < (ssize_t) image->colors; i++)
888 p=PushShortPixel(MSBEndian,p,&pixel);
889 image->colormap[i].red=ScaleShortToQuantum(pixel);
890 p=PushShortPixel(MSBEndian,p,&pixel);
891 image->colormap[i].green=ScaleShortToQuantum(pixel);
892 p=PushShortPixel(MSBEndian,p,&pixel);
893 image->colormap[i].blue=ScaleShortToQuantum(pixel);
902 for (i=0; i < (ssize_t) image->colors; i++)
904 p=PushLongPixel(MSBEndian,p,&pixel);
905 image->colormap[i].red=ScaleLongToQuantum(pixel);
906 p=PushLongPixel(MSBEndian,p,&pixel);
907 image->colormap[i].green=ScaleLongToQuantum(pixel);
908 p=PushLongPixel(MSBEndian,p,&pixel);
909 image->colormap[i].blue=ScaleLongToQuantum(pixel);
914 colormap=(unsigned char *) RelinquishMagickMemory(colormap);
917 if (EOFBlob(image) != MagickFalse)
919 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
923 if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))
924 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
926 status=SetImageExtent(image,image->columns,image->rows,exception);
927 if (status == MagickFalse)
928 return(DestroyImageList(image));
930 Attach persistent pixel cache.
932 status=PersistPixelCache(image,cache_filename,MagickTrue,&offset,exception);
933 if (status == MagickFalse)
934 ThrowReaderException(CacheError,"UnableToPersistPixelCache");
936 Proceed to next image.
940 c=ReadBlobByte(image);
941 } while ((isgraph(c) == MagickFalse) && (c != EOF));
945 Allocate next image structure.
947 AcquireNextImage(image_info,image,exception);
948 if (GetNextImageInList(image) == (Image *) NULL)
950 image=DestroyImageList(image);
951 return((Image *) NULL);
953 image=SyncNextImageInList(image);
954 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
956 if (status == MagickFalse)
960 (void) CloseBlob(image);
961 return(GetFirstImageInList(image));
965 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
969 % R e g i s t e r M P C I m a g e %
973 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
975 % RegisterMPCImage() adds properties for the Cache image format to
976 % the list of supported formats. The properties include the image format
977 % tag, a method to read and/or write the format, whether the format
978 % supports the saving of more than one frame to the same file or blob,
979 % whether the format supports native in-memory I/O, and a brief
980 % description of the format.
982 % The format of the RegisterMPCImage method is:
984 % size_t RegisterMPCImage(void)
987 ModuleExport size_t RegisterMPCImage(void)
992 entry=AcquireMagickInfo("MPC","CACHE",
993 "Magick Persistent Cache image format");
994 entry->flags|=CoderStealthFlag;
995 (void) RegisterMagickInfo(entry);
996 entry=AcquireMagickInfo("MPC","MPC","Magick Persistent Cache image format");
997 entry->decoder=(DecodeImageHandler *) ReadMPCImage;
998 entry->encoder=(EncodeImageHandler *) WriteMPCImage;
999 entry->magick=(IsImageFormatHandler *) IsMPC;
1000 (void) RegisterMagickInfo(entry);
1001 return(MagickImageCoderSignature);
1005 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1009 % U n r e g i s t e r M P C I m a g e %
1013 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1015 % UnregisterMPCImage() removes format registrations made by the
1016 % MPC module from the list of supported formats.
1018 % The format of the UnregisterMPCImage method is:
1020 % UnregisterMPCImage(void)
1023 ModuleExport void UnregisterMPCImage(void)
1025 (void) UnregisterMagickInfo("CACHE");
1026 (void) UnregisterMagickInfo("MPC");
1030 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1034 % W r i t e M P C I m a g e %
1038 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1040 % WriteMPCImage() writes an Magick Persistent Cache image to a file.
1042 % The format of the WriteMPCImage method is:
1044 % MagickBooleanType WriteMPCImage(const ImageInfo *image_info,
1045 % Image *image,ExceptionInfo *exception)
1047 % A description of each parameter follows:
1049 % o image_info: the image info.
1051 % o image: the image.
1053 % o exception: return any errors or warnings in this structure.
1056 static MagickBooleanType WriteMPCImage(const ImageInfo *image_info,Image *image,
1057 ExceptionInfo *exception)
1060 buffer[MagickPathExtent],
1061 cache_filename[MagickPathExtent];
1081 Open persistent cache.
1083 assert(image_info != (const ImageInfo *) NULL);
1084 assert(image_info->signature == MagickCoreSignature);
1085 assert(image != (Image *) NULL);
1086 assert(image->signature == MagickCoreSignature);
1087 if (image->debug != MagickFalse)
1088 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
1089 assert(exception != (ExceptionInfo *) NULL);
1090 assert(exception->signature == MagickCoreSignature);
1091 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
1092 if (status == MagickFalse)
1094 (void) CopyMagickString(cache_filename,image->filename,MagickPathExtent);
1095 AppendImageFormat("cache",cache_filename);
1101 Write persistent cache meta-information.
1103 depth=GetImageQuantumDepth(image,MagickTrue);
1104 if ((image->storage_class == PseudoClass) &&
1105 (image->colors > (size_t) (GetQuantumRange(image->depth)+1)))
1106 (void) SetImageStorageClass(image,DirectClass,exception);
1107 (void) WriteBlobString(image,"id=MagickCache\n");
1108 (void) FormatLocaleString(buffer,MagickPathExtent,"magick-signature=%u\n",
1109 GetMagickSignature((const StringInfo *) NULL));
1110 (void) WriteBlobString(image,buffer);
1111 (void) FormatLocaleString(buffer,MagickPathExtent,
1112 "class=%s colors=%.20g alpha-trait=%s\n",CommandOptionToMnemonic(
1113 MagickClassOptions,image->storage_class),(double) image->colors,
1114 CommandOptionToMnemonic(MagickPixelTraitOptions,(ssize_t)
1115 image->alpha_trait));
1116 (void) WriteBlobString(image,buffer);
1117 (void) FormatLocaleString(buffer,MagickPathExtent,
1118 "columns=%.20g rows=%.20g depth=%.20g\n",(double) image->columns,
1119 (double) image->rows,(double) image->depth);
1120 (void) WriteBlobString(image,buffer);
1121 if (image->type != UndefinedType)
1123 (void) FormatLocaleString(buffer,MagickPathExtent,"type=%s\n",
1124 CommandOptionToMnemonic(MagickTypeOptions,image->type));
1125 (void) WriteBlobString(image,buffer);
1127 if (image->colorspace != UndefinedColorspace)
1129 (void) FormatLocaleString(buffer,MagickPathExtent,"colorspace=%s\n",
1130 CommandOptionToMnemonic(MagickColorspaceOptions,image->colorspace));
1131 (void) WriteBlobString(image,buffer);
1133 if (image->intensity != UndefinedPixelIntensityMethod)
1135 (void) FormatLocaleString(buffer,MagickPathExtent,
1136 "pixel-intensity=%s\n",CommandOptionToMnemonic(
1137 MagickPixelIntensityOptions,image->intensity));
1138 (void) WriteBlobString(image,buffer);
1140 if (image->endian != UndefinedEndian)
1142 (void) FormatLocaleString(buffer,MagickPathExtent,"endian=%s\n",
1143 CommandOptionToMnemonic(MagickEndianOptions,image->endian));
1144 (void) WriteBlobString(image,buffer);
1146 if (image->compression != UndefinedCompression)
1148 (void) FormatLocaleString(buffer,MagickPathExtent,
1149 "compression=%s quality=%.20g\n",CommandOptionToMnemonic(
1150 MagickCompressOptions,image->compression),(double) image->quality);
1151 (void) WriteBlobString(image,buffer);
1153 if (image->units != UndefinedResolution)
1155 (void) FormatLocaleString(buffer,MagickPathExtent,"units=%s\n",
1156 CommandOptionToMnemonic(MagickResolutionOptions,image->units));
1157 (void) WriteBlobString(image,buffer);
1159 if ((image->resolution.x != 0) || (image->resolution.y != 0))
1161 (void) FormatLocaleString(buffer,MagickPathExtent,
1162 "resolution=%gx%g\n",image->resolution.x,image->resolution.y);
1163 (void) WriteBlobString(image,buffer);
1165 if ((image->page.width != 0) || (image->page.height != 0))
1167 (void) FormatLocaleString(buffer,MagickPathExtent,
1168 "page=%.20gx%.20g%+.20g%+.20g\n",(double) image->page.width,(double)
1169 image->page.height,(double) image->page.x,(double) image->page.y);
1170 (void) WriteBlobString(image,buffer);
1173 if ((image->page.x != 0) || (image->page.y != 0))
1175 (void) FormatLocaleString(buffer,MagickPathExtent,"page=%+ld%+ld\n",
1176 (long) image->page.x,(long) image->page.y);
1177 (void) WriteBlobString(image,buffer);
1179 if ((image->tile_offset.x != 0) || (image->tile_offset.y != 0))
1181 (void) FormatLocaleString(buffer,MagickPathExtent,
1182 "tile-offset=%+ld%+ld\n",(long) image->tile_offset.x,(long)
1183 image->tile_offset.y);
1184 (void) WriteBlobString(image,buffer);
1186 if ((GetNextImageInList(image) != (Image *) NULL) ||
1187 (GetPreviousImageInList(image) != (Image *) NULL))
1189 if (image->scene == 0)
1190 (void) FormatLocaleString(buffer,MagickPathExtent,
1191 "iterations=%.20g delay=%.20g ticks-per-second=%.20g\n",(double)
1192 image->iterations,(double) image->delay,(double)
1193 image->ticks_per_second);
1195 (void) FormatLocaleString(buffer,MagickPathExtent,"scene=%.20g "
1196 "iterations=%.20g delay=%.20g ticks-per-second=%.20g\n",
1197 (double) image->scene,(double) image->iterations,(double)
1198 image->delay,(double) image->ticks_per_second);
1199 (void) WriteBlobString(image,buffer);
1203 if (image->scene != 0)
1205 (void) FormatLocaleString(buffer,MagickPathExtent,"scene=%.20g\n",
1206 (double) image->scene);
1207 (void) WriteBlobString(image,buffer);
1209 if (image->iterations != 0)
1211 (void) FormatLocaleString(buffer,MagickPathExtent,
1212 "iterations=%.20g\n",(double) image->iterations);
1213 (void) WriteBlobString(image,buffer);
1215 if (image->delay != 0)
1217 (void) FormatLocaleString(buffer,MagickPathExtent,"delay=%.20g\n",
1218 (double) image->delay);
1219 (void) WriteBlobString(image,buffer);
1221 if (image->ticks_per_second != UndefinedTicksPerSecond)
1223 (void) FormatLocaleString(buffer,MagickPathExtent,
1224 "ticks-per-second=%.20g\n",(double) image->ticks_per_second);
1225 (void) WriteBlobString(image,buffer);
1228 if (image->gravity != UndefinedGravity)
1230 (void) FormatLocaleString(buffer,MagickPathExtent,"gravity=%s\n",
1231 CommandOptionToMnemonic(MagickGravityOptions,image->gravity));
1232 (void) WriteBlobString(image,buffer);
1234 if (image->dispose != UndefinedDispose)
1236 (void) FormatLocaleString(buffer,MagickPathExtent,"dispose=%s\n",
1237 CommandOptionToMnemonic(MagickDisposeOptions,image->dispose));
1238 (void) WriteBlobString(image,buffer);
1240 if (image->rendering_intent != UndefinedIntent)
1242 (void) FormatLocaleString(buffer,MagickPathExtent,
1243 "rendering-intent=%s\n",CommandOptionToMnemonic(MagickIntentOptions,
1244 image->rendering_intent));
1245 (void) WriteBlobString(image,buffer);
1247 if (image->gamma != 0.0)
1249 (void) FormatLocaleString(buffer,MagickPathExtent,"gamma=%g\n",
1251 (void) WriteBlobString(image,buffer);
1253 if (image->chromaticity.white_point.x != 0.0)
1256 Note chomaticity points.
1258 (void) FormatLocaleString(buffer,MagickPathExtent,"red-primary="
1259 "%g,%g green-primary=%g,%g blue-primary=%g,%g\n",
1260 image->chromaticity.red_primary.x,image->chromaticity.red_primary.y,
1261 image->chromaticity.green_primary.x,
1262 image->chromaticity.green_primary.y,
1263 image->chromaticity.blue_primary.x,
1264 image->chromaticity.blue_primary.y);
1265 (void) WriteBlobString(image,buffer);
1266 (void) FormatLocaleString(buffer,MagickPathExtent,
1267 "white-point=%g,%g\n",image->chromaticity.white_point.x,
1268 image->chromaticity.white_point.y);
1269 (void) WriteBlobString(image,buffer);
1271 if (image->orientation != UndefinedOrientation)
1273 (void) FormatLocaleString(buffer,MagickPathExtent,
1274 "orientation=%s\n",CommandOptionToMnemonic(MagickOrientationOptions,
1275 image->orientation));
1276 (void) WriteBlobString(image,buffer);
1278 if (image->profiles != (void *) NULL)
1289 ResetImageProfileIterator(image);
1290 for (name=GetNextImageProfile(image); name != (const char *) NULL; )
1292 profile=GetImageProfile(image,name);
1293 if (profile != (StringInfo *) NULL)
1295 (void) FormatLocaleString(buffer,MagickPathExtent,
1296 "profile:%s=%.20g\n",name,(double)
1297 GetStringInfoLength(profile));
1298 (void) WriteBlobString(image,buffer);
1300 name=GetNextImageProfile(image);
1303 if (image->montage != (char *) NULL)
1305 (void) FormatLocaleString(buffer,MagickPathExtent,"montage=%s\n",
1307 (void) WriteBlobString(image,buffer);
1309 ResetImagePropertyIterator(image);
1310 property=GetNextImageProperty(image);
1311 while (property != (const char *) NULL)
1313 (void) FormatLocaleString(buffer,MagickPathExtent,"%s=",property);
1314 (void) WriteBlobString(image,buffer);
1315 value=GetImageProperty(image,property,exception);
1316 if (value != (const char *) NULL)
1321 length=strlen(value);
1322 for (i=0; i < (ssize_t) length; i++)
1323 if (isspace((int) ((unsigned char) value[i])) != 0)
1325 if ((i == (ssize_t) length) && (i != 0))
1326 (void) WriteBlob(image,length,(const unsigned char *) value);
1329 (void) WriteBlobByte(image,'{');
1330 if (strchr(value,'}') == (char *) NULL)
1331 (void) WriteBlob(image,length,(const unsigned char *) value);
1333 for (i=0; i < (ssize_t) length; i++)
1335 if (value[i] == (int) '}')
1336 (void) WriteBlobByte(image,'\\');
1337 (void) WriteBlobByte(image,value[i]);
1339 (void) WriteBlobByte(image,'}');
1342 (void) WriteBlobByte(image,'\n');
1343 property=GetNextImageProperty(image);
1345 (void) WriteBlobString(image,"\f\n:\032");
1346 if (image->montage != (char *) NULL)
1349 Write montage tile directory.
1351 if (image->directory != (char *) NULL)
1352 (void) WriteBlobString(image,image->directory);
1353 (void) WriteBlobByte(image,'\0');
1355 if (image->profiles != 0)
1364 Write image profiles.
1366 ResetImageProfileIterator(image);
1367 name=GetNextImageProfile(image);
1368 while (name != (const char *) NULL)
1370 profile=GetImageProfile(image,name);
1371 (void) WriteBlob(image,GetStringInfoLength(profile),
1372 GetStringInfoDatum(profile));
1373 name=GetNextImageProfile(image);
1376 if (image->storage_class == PseudoClass)
1388 packet_size=(size_t) (3UL*depth/8UL);
1389 colormap=(unsigned char *) AcquireQuantumMemory(image->colors,
1390 packet_size*sizeof(*colormap));
1391 if (colormap == (unsigned char *) NULL)
1392 return(MagickFalse);
1394 Write colormap to file.
1397 for (i=0; i < (ssize_t) image->colors; i++)
1402 ThrowWriterException(CorruptImageError,"ImageDepthNotSupported");
1408 pixel=ScaleQuantumToLong(image->colormap[i].red);
1409 q=PopLongPixel(MSBEndian,pixel,q);
1410 pixel=ScaleQuantumToLong(image->colormap[i].green);
1411 q=PopLongPixel(MSBEndian,pixel,q);
1412 pixel=ScaleQuantumToLong(image->colormap[i].blue);
1413 q=PopLongPixel(MSBEndian,pixel,q);
1421 pixel=ScaleQuantumToShort(image->colormap[i].red);
1422 q=PopShortPixel(MSBEndian,pixel,q);
1423 pixel=ScaleQuantumToShort(image->colormap[i].green);
1424 q=PopShortPixel(MSBEndian,pixel,q);
1425 pixel=ScaleQuantumToShort(image->colormap[i].blue);
1426 q=PopShortPixel(MSBEndian,pixel,q);
1434 pixel=(unsigned char) ScaleQuantumToChar(image->colormap[i].red);
1435 q=PopCharPixel(pixel,q);
1436 pixel=(unsigned char) ScaleQuantumToChar(
1437 image->colormap[i].green);
1438 q=PopCharPixel(pixel,q);
1439 pixel=(unsigned char) ScaleQuantumToChar(image->colormap[i].blue);
1440 q=PopCharPixel(pixel,q);
1445 (void) WriteBlob(image,packet_size*image->colors,colormap);
1446 colormap=(unsigned char *) RelinquishMagickMemory(colormap);
1449 Initialize persistent pixel cache.
1451 status=PersistPixelCache(image,cache_filename,MagickFalse,&offset,
1453 if (status == MagickFalse)
1454 ThrowWriterException(CacheError,"UnableToPersistPixelCache");
1455 if (GetNextImageInList(image) == (Image *) NULL)
1457 image=SyncNextImageInList(image);
1458 if (image->progress_monitor != (MagickProgressMonitor) NULL)
1460 status=image->progress_monitor(SaveImagesTag,scene,
1461 GetImageListLength(image),image->client_data);
1462 if (status == MagickFalse)
1466 } while (image_info->adjoin != MagickFalse);
1467 (void) CloseBlob(image);