2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % Read/Write Magick Persistant Cache Image Format %
20 % Copyright 1999-2017 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 % https://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/resource_.h"
70 #include "MagickCore/static.h"
71 #include "MagickCore/statistic.h"
72 #include "MagickCore/string_.h"
73 #include "MagickCore/string-private.h"
74 #include "MagickCore/utility.h"
75 #include "MagickCore/version-private.h"
80 static MagickBooleanType
81 WriteMPCImage(const ImageInfo *,Image *,ExceptionInfo *);
84 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
92 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
94 % IsMPC() returns MagickTrue if the image format type, identified by the
95 % magick string, is an Magick Persistent Cache image.
97 % The format of the IsMPC method is:
99 % MagickBooleanType IsMPC(const unsigned char *magick,const size_t length)
101 % A description of each parameter follows:
103 % o magick: compare image format pattern against these bytes.
105 % o length: Specifies the length of the magick string.
108 static MagickBooleanType IsMPC(const unsigned char *magick,const size_t length)
112 if (LocaleNCompare((const char *) magick,"id=MagickCache",14) == 0)
118 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
122 % R e a d C A C H E I m a g e %
126 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
128 % ReadMPCImage() reads an Magick Persistent Cache image file and returns
129 % it. It allocates the memory necessary for the new Image structure and
130 % returns a pointer to the new image.
132 % The format of the ReadMPCImage method is:
134 % Image *ReadMPCImage(const ImageInfo *image_info,ExceptionInfo *exception)
136 % Decompression code contributed by Kyle Shorter.
138 % A description of each parameter follows:
140 % o image_info: the image info.
142 % o exception: return any errors or warnings in this structure.
145 static Image *ReadMPCImage(const ImageInfo *image_info,ExceptionInfo *exception)
148 cache_filename[MagickPathExtent],
149 id[MagickPathExtent],
150 keyword[MagickPathExtent],
196 assert(image_info != (const ImageInfo *) NULL);
197 assert(image_info->signature == MagickCoreSignature);
198 if (image_info->debug != MagickFalse)
199 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
200 image_info->filename);
201 assert(exception != (ExceptionInfo *) NULL);
202 assert(exception->signature == MagickCoreSignature);
203 image=AcquireImage(image_info,exception);
204 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
205 if (status == MagickFalse)
207 image=DestroyImageList(image);
208 return((Image *) NULL);
210 (void) CopyMagickString(cache_filename,image->filename,MagickPathExtent);
211 AppendImageFormat("cache",cache_filename);
212 c=ReadBlobByte(image);
215 image=DestroyImage(image);
216 return((Image *) NULL);
219 (void) ResetMagickMemory(keyword,0,sizeof(keyword));
224 Decode image header; header terminates one character beyond a ':'.
226 profiles=(LinkedListInfo *) NULL;
227 length=MagickPathExtent;
228 options=AcquireString((char *) NULL);
229 signature=GetMagickSignature((const StringInfo *) NULL);
231 image->compression=NoCompression;
232 while ((isgraph(c) != MagickFalse) && (c != (int) ':'))
243 Read comment-- any text between { }.
245 length=MagickPathExtent;
246 comment=AcquireString((char *) NULL);
247 for (p=comment; comment != (char *) NULL; p++)
249 c=ReadBlobByte(image);
251 c=ReadBlobByte(image);
253 if ((c == EOF) || (c == (int) '}'))
255 if ((size_t) (p-comment+1) >= length)
259 comment=(char *) ResizeQuantumMemory(comment,length+
260 MagickPathExtent,sizeof(*comment));
261 if (comment == (char *) NULL)
263 p=comment+strlen(comment);
267 if (comment == (char *) NULL)
268 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
270 (void) SetImageProperty(image,"comment",comment,exception);
271 comment=DestroyString(comment);
272 c=ReadBlobByte(image);
275 if (isalnum(c) != MagickFalse)
280 length=MagickPathExtent;
286 if ((size_t) (p-keyword) < (MagickPathExtent-1))
288 c=ReadBlobByte(image);
292 while (isspace((int) ((unsigned char) c)) != 0)
293 c=ReadBlobByte(image);
297 Get the keyword value.
299 c=ReadBlobByte(image);
300 while ((c != (int) '}') && (c != EOF))
302 if ((size_t) (p-options+1) >= length)
306 options=(char *) ResizeQuantumMemory(options,length+
307 MagickPathExtent,sizeof(*options));
308 if (options == (char *) NULL)
310 p=options+strlen(options);
313 c=ReadBlobByte(image);
316 c=ReadBlobByte(image);
320 c=ReadBlobByte(image);
324 if (isspace((int) ((unsigned char) c)) != 0)
327 if (options == (char *) NULL)
328 ThrowReaderException(ResourceLimitError,
329 "MemoryAllocationFailed");
333 (void) CopyMagickString(options,options+1,strlen(options));
335 Assign a value to the specified keyword.
342 if (LocaleCompare(keyword,"alpha-trait") == 0)
347 alpha_trait=ParseCommandOption(MagickPixelTraitOptions,
348 MagickFalse,options);
351 image->alpha_trait=(PixelTrait) alpha_trait;
354 (void) SetImageProperty(image,keyword,options,exception);
360 if (LocaleCompare(keyword,"background-color") == 0)
362 (void) QueryColorCompliance(options,AllCompliance,
363 &image->background_color,exception);
366 if (LocaleCompare(keyword,"blue-primary") == 0)
368 flags=ParseGeometry(options,&geometry_info);
369 image->chromaticity.blue_primary.x=geometry_info.rho;
370 image->chromaticity.blue_primary.y=geometry_info.sigma;
371 if ((flags & SigmaValue) == 0)
372 image->chromaticity.blue_primary.y=
373 image->chromaticity.blue_primary.x;
376 if (LocaleCompare(keyword,"border-color") == 0)
378 (void) QueryColorCompliance(options,AllCompliance,
379 &image->border_color,exception);
382 (void) SetImageProperty(image,keyword,options,exception);
388 if (LocaleCompare(keyword,"class") == 0)
393 storage_class=ParseCommandOption(MagickClassOptions,
394 MagickFalse,options);
395 if (storage_class < 0)
397 image->storage_class=(ClassType) storage_class;
400 if (LocaleCompare(keyword,"colors") == 0)
402 image->colors=StringToUnsignedLong(options);
405 if (LocaleCompare(keyword,"colorspace") == 0)
410 colorspace=ParseCommandOption(MagickColorspaceOptions,
411 MagickFalse,options);
414 image->colorspace=(ColorspaceType) colorspace;
417 if (LocaleCompare(keyword,"compression") == 0)
422 compression=ParseCommandOption(MagickCompressOptions,
423 MagickFalse,options);
426 image->compression=(CompressionType) compression;
429 if (LocaleCompare(keyword,"columns") == 0)
431 image->columns=StringToUnsignedLong(options);
434 (void) SetImageProperty(image,keyword,options,exception);
440 if (LocaleCompare(keyword,"delay") == 0)
442 image->delay=StringToUnsignedLong(options);
445 if (LocaleCompare(keyword,"depth") == 0)
447 image->depth=StringToUnsignedLong(options);
450 if (LocaleCompare(keyword,"dispose") == 0)
455 dispose=ParseCommandOption(MagickDisposeOptions,MagickFalse,
459 image->dispose=(DisposeType) dispose;
462 (void) SetImageProperty(image,keyword,options,exception);
468 if (LocaleCompare(keyword,"endian") == 0)
473 endian=ParseCommandOption(MagickEndianOptions,MagickFalse,
477 image->endian=(EndianType) endian;
480 if (LocaleCompare(keyword,"error") == 0)
482 image->error.mean_error_per_pixel=StringToDouble(options,
486 (void) SetImageProperty(image,keyword,options,exception);
492 if (LocaleCompare(keyword,"gamma") == 0)
494 image->gamma=StringToDouble(options,(char **) NULL);
497 if (LocaleCompare(keyword,"green-primary") == 0)
499 flags=ParseGeometry(options,&geometry_info);
500 image->chromaticity.green_primary.x=geometry_info.rho;
501 image->chromaticity.green_primary.y=geometry_info.sigma;
502 if ((flags & SigmaValue) == 0)
503 image->chromaticity.green_primary.y=
504 image->chromaticity.green_primary.x;
507 (void) SetImageProperty(image,keyword,options,exception);
513 if (LocaleCompare(keyword,"id") == 0)
515 (void) CopyMagickString(id,options,MagickPathExtent);
518 if (LocaleCompare(keyword,"iterations") == 0)
520 image->iterations=StringToUnsignedLong(options);
523 (void) SetImageProperty(image,keyword,options,exception);
529 if (LocaleCompare(keyword,"magick-signature") == 0)
531 signature=(unsigned int) StringToUnsignedLong(options);
534 if (LocaleCompare(keyword,"mattecolor") == 0)
536 (void) QueryColorCompliance(options,AllCompliance,
537 &image->matte_color,exception);
540 if (LocaleCompare(keyword,"maximum-error") == 0)
542 image->error.normalized_maximum_error=StringToDouble(
543 options,(char **) NULL);
546 if (LocaleCompare(keyword,"mean-error") == 0)
548 image->error.normalized_mean_error=StringToDouble(options,
552 if (LocaleCompare(keyword,"montage") == 0)
554 (void) CloneString(&image->montage,options);
557 (void) SetImageProperty(image,keyword,options,exception);
563 if (LocaleCompare(keyword,"number-channels") == 0)
565 image->number_channels=StringToUnsignedLong(options);
568 if (LocaleCompare(keyword,"number-meta-channels") == 0)
570 image->number_meta_channels=StringToUnsignedLong(options);
571 if (image->number_meta_channels > MaxPixelChannels)
572 ThrowReaderException(CorruptImageError,
573 "ImproperImageHeader");
581 if (LocaleCompare(keyword,"orientation") == 0)
586 orientation=ParseCommandOption(MagickOrientationOptions,
587 MagickFalse,options);
590 image->orientation=(OrientationType) orientation;
593 (void) SetImageProperty(image,keyword,options,exception);
599 if (LocaleCompare(keyword,"page") == 0)
604 geometry=GetPageGeometry(options);
605 (void) ParseAbsoluteGeometry(geometry,&image->page);
606 geometry=DestroyString(geometry);
609 if (LocaleCompare(keyword,"pixel-intensity") == 0)
614 intensity=ParseCommandOption(MagickPixelIntensityOptions,
615 MagickFalse,options);
618 image->intensity=(PixelIntensityMethod) intensity;
621 if ((LocaleNCompare(keyword,"profile:",8) == 0) ||
622 (LocaleNCompare(keyword,"profile-",8) == 0))
624 if (profiles == (LinkedListInfo *) NULL)
625 profiles=NewLinkedList(0);
626 (void) AppendValueToLinkedList(profiles,
627 AcquireString(keyword+8));
628 profile=BlobToStringInfo((const void *) NULL,(size_t)
629 StringToLong(options));
630 if (profile == (StringInfo *) NULL)
631 ThrowReaderException(ResourceLimitError,
632 "MemoryAllocationFailed");
633 (void) SetImageProfile(image,keyword+8,profile,exception);
634 profile=DestroyStringInfo(profile);
637 (void) SetImageProperty(image,keyword,options,exception);
643 if (LocaleCompare(keyword,"quality") == 0)
645 image->quality=StringToUnsignedLong(options);
648 (void) SetImageProperty(image,keyword,options,exception);
654 if (LocaleCompare(keyword,"red-primary") == 0)
656 flags=ParseGeometry(options,&geometry_info);
657 image->chromaticity.red_primary.x=geometry_info.rho;
658 if ((flags & SigmaValue) != 0)
659 image->chromaticity.red_primary.y=geometry_info.sigma;
662 if (LocaleCompare(keyword,"rendering-intent") == 0)
667 rendering_intent=ParseCommandOption(MagickIntentOptions,
668 MagickFalse,options);
669 if (rendering_intent < 0)
671 image->rendering_intent=(RenderingIntent) rendering_intent;
674 if (LocaleCompare(keyword,"resolution") == 0)
676 flags=ParseGeometry(options,&geometry_info);
677 image->resolution.x=geometry_info.rho;
678 image->resolution.y=geometry_info.sigma;
679 if ((flags & SigmaValue) == 0)
680 image->resolution.y=image->resolution.x;
683 if (LocaleCompare(keyword,"rows") == 0)
685 image->rows=StringToUnsignedLong(options);
688 (void) SetImageProperty(image,keyword,options,exception);
694 if (LocaleCompare(keyword,"scene") == 0)
696 image->scene=StringToUnsignedLong(options);
699 (void) SetImageProperty(image,keyword,options,exception);
705 if (LocaleCompare(keyword,"ticks-per-second") == 0)
707 image->ticks_per_second=(ssize_t) StringToLong(options);
710 if (LocaleCompare(keyword,"tile-offset") == 0)
715 geometry=GetPageGeometry(options);
716 (void) ParseAbsoluteGeometry(geometry,&image->tile_offset);
717 geometry=DestroyString(geometry);
719 if (LocaleCompare(keyword,"type") == 0)
724 type=ParseCommandOption(MagickTypeOptions,MagickFalse,
728 image->type=(ImageType) type;
731 (void) SetImageProperty(image,keyword,options,exception);
737 if (LocaleCompare(keyword,"units") == 0)
742 units=ParseCommandOption(MagickResolutionOptions,
743 MagickFalse,options);
746 image->units=(ResolutionType) units;
749 (void) SetImageProperty(image,keyword,options,exception);
755 if (LocaleCompare(keyword,"white-point") == 0)
757 flags=ParseGeometry(options,&geometry_info);
758 image->chromaticity.white_point.x=geometry_info.rho;
759 image->chromaticity.white_point.y=geometry_info.sigma;
760 if ((flags & SigmaValue) == 0)
761 image->chromaticity.white_point.y=
762 image->chromaticity.white_point.x;
765 (void) SetImageProperty(image,keyword,options,exception);
770 (void) SetImageProperty(image,keyword,options,exception);
776 c=ReadBlobByte(image);
777 while (isspace((int) ((unsigned char) c)) != 0)
778 c=ReadBlobByte(image);
780 options=DestroyString(options);
781 (void) ReadBlobByte(image);
783 Verify that required image information is defined.
785 if ((LocaleCompare(id,"MagickCache") != 0) ||
786 (image->storage_class == UndefinedClass) ||
787 (image->compression == UndefinedCompression) || (image->columns == 0) ||
790 if (profiles != (LinkedListInfo *) NULL)
791 profiles=DestroyLinkedList(profiles,RelinquishMagickMemory);
792 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
794 if (signature != GetMagickSignature((const StringInfo *) NULL))
796 if (profiles != (LinkedListInfo *) NULL)
797 profiles=DestroyLinkedList(profiles,RelinquishMagickMemory);
798 ThrowReaderException(CacheError,"IncompatibleAPI");
800 if (image->montage != (char *) NULL)
808 length=MagickPathExtent;
809 image->directory=AcquireString((char *) NULL);
814 if ((strlen(image->directory)+MagickPathExtent) >= length)
817 Allocate more memory for the image directory.
820 image->directory=(char *) ResizeQuantumMemory(image->directory,
821 length+MagickPathExtent,sizeof(*image->directory));
822 if (image->directory == (char *) NULL)
824 if (profiles != (LinkedListInfo *) NULL)
825 profiles=DestroyLinkedList(profiles,RelinquishMagickMemory);
826 ThrowReaderException(CorruptImageError,
827 "UnableToReadImageData");
829 p=image->directory+strlen(image->directory);
831 c=ReadBlobByte(image);
833 } while (c != (int) '\0');
835 if (profiles != (LinkedListInfo *) NULL)
843 register unsigned char
849 ResetLinkedListIterator(profiles);
850 name=(const char *) GetNextValueInLinkedList(profiles);
851 while (name != (const char *) NULL)
853 profile=GetImageProfile(image,name);
854 if (profile != (StringInfo *) NULL)
856 p=GetStringInfoDatum(profile);
857 count=ReadBlob(image,GetStringInfoLength(profile),p);
859 name=(const char *) GetNextValueInLinkedList(profiles);
861 profiles=DestroyLinkedList(profiles,RelinquishMagickMemory);
863 depth=GetImageQuantumDepth(image,MagickFalse);
864 if (image->storage_class == PseudoClass)
873 Create image colormap.
875 packet_size=(size_t) (3UL*depth/8UL);
876 if ((MagickSizeType) (packet_size*image->colors) > GetBlobSize(image))
877 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
878 image->colormap=(PixelInfo *) AcquireQuantumMemory(image->colors+1,
879 sizeof(*image->colormap));
880 if (image->colormap == (PixelInfo *) NULL)
881 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
882 if (image->colors != 0)
885 Read image colormap from file.
887 colormap=(unsigned char *) AcquireQuantumMemory(image->colors,
888 packet_size*sizeof(*colormap));
889 if (colormap == (unsigned char *) NULL)
890 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
891 count=ReadBlob(image,packet_size*image->colors,colormap);
892 if (count != (ssize_t) (packet_size*image->colors))
894 colormap=(unsigned char *) RelinquishMagickMemory(colormap);
895 ThrowReaderException(CorruptImageError,
896 "InsufficientImageDataInFile");
902 colormap=(unsigned char *) RelinquishMagickMemory(colormap);
903 ThrowReaderException(CorruptImageError,
904 "ImageDepthNotSupported");
910 for (i=0; i < (ssize_t) image->colors; i++)
912 p=PushCharPixel(p,&pixel);
913 image->colormap[i].red=(MagickRealType)
914 ScaleCharToQuantum((unsigned char) pixel);
915 p=PushCharPixel(p,&pixel);
916 image->colormap[i].green=(MagickRealType)
917 ScaleCharToQuantum((unsigned char) pixel);
918 p=PushCharPixel(p,&pixel);
919 image->colormap[i].blue=(MagickRealType)
920 ScaleCharToQuantum((unsigned char) pixel);
929 for (i=0; i < (ssize_t) image->colors; i++)
931 p=PushShortPixel(MSBEndian,p,&pixel);
932 image->colormap[i].red=(MagickRealType)
933 ScaleShortToQuantum((Quantum) pixel);
934 p=PushShortPixel(MSBEndian,p,&pixel);
935 image->colormap[i].green=(MagickRealType)
936 ScaleShortToQuantum((Quantum) pixel);
937 p=PushShortPixel(MSBEndian,p,&pixel);
938 image->colormap[i].blue=(MagickRealType)
939 ScaleShortToQuantum((Quantum) pixel);
948 for (i=0; i < (ssize_t) image->colors; i++)
950 p=PushLongPixel(MSBEndian,p,&pixel);
951 image->colormap[i].red=(MagickRealType)
952 ScaleLongToQuantum((Quantum) pixel);
953 p=PushLongPixel(MSBEndian,p,&pixel);
954 image->colormap[i].green=(MagickRealType)
955 ScaleLongToQuantum((Quantum) pixel);
956 p=PushLongPixel(MSBEndian,p,&pixel);
957 image->colormap[i].blue=(MagickRealType)
958 ScaleLongToQuantum((Quantum) pixel);
963 colormap=(unsigned char *) RelinquishMagickMemory(colormap);
966 if (EOFBlob(image) != MagickFalse)
968 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
972 if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))
973 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
975 if ((AcquireMagickResource(WidthResource,image->columns) == MagickFalse) ||
976 (AcquireMagickResource(HeightResource,image->rows) == MagickFalse))
977 ThrowReaderException(ImageError,"WidthOrHeightExceedsLimit");
979 Attach persistent pixel cache.
981 status=PersistPixelCache(image,cache_filename,MagickTrue,&offset,exception);
982 if (status == MagickFalse)
983 ThrowReaderException(CacheError,"UnableToPersistPixelCache");
985 Proceed to next image.
989 c=ReadBlobByte(image);
990 } while ((isgraph(c) == MagickFalse) && (c != EOF));
994 Allocate next image structure.
996 AcquireNextImage(image_info,image,exception);
997 if (GetNextImageInList(image) == (Image *) NULL)
999 image=DestroyImageList(image);
1000 return((Image *) NULL);
1002 image=SyncNextImageInList(image);
1003 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
1004 GetBlobSize(image));
1005 if (status == MagickFalse)
1009 (void) CloseBlob(image);
1010 return(GetFirstImageInList(image));
1014 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1018 % R e g i s t e r M P C I m a g e %
1022 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1024 % RegisterMPCImage() adds properties for the Cache image format to
1025 % the list of supported formats. The properties include the image format
1026 % tag, a method to read and/or write the format, whether the format
1027 % supports the saving of more than one frame to the same file or blob,
1028 % whether the format supports native in-memory I/O, and a brief
1029 % description of the format.
1031 % The format of the RegisterMPCImage method is:
1033 % size_t RegisterMPCImage(void)
1036 ModuleExport size_t RegisterMPCImage(void)
1041 entry=AcquireMagickInfo("MPC","CACHE",
1042 "Magick Persistent Cache image format");
1043 entry->flags|=CoderStealthFlag;
1044 (void) RegisterMagickInfo(entry);
1045 entry=AcquireMagickInfo("MPC","MPC","Magick Persistent Cache image format");
1046 entry->decoder=(DecodeImageHandler *) ReadMPCImage;
1047 entry->encoder=(EncodeImageHandler *) WriteMPCImage;
1048 entry->magick=(IsImageFormatHandler *) IsMPC;
1049 entry->flags|=CoderDecoderSeekableStreamFlag;
1050 (void) RegisterMagickInfo(entry);
1051 return(MagickImageCoderSignature);
1055 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1059 % U n r e g i s t e r M P C I m a g e %
1063 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1065 % UnregisterMPCImage() removes format registrations made by the
1066 % MPC module from the list of supported formats.
1068 % The format of the UnregisterMPCImage method is:
1070 % UnregisterMPCImage(void)
1073 ModuleExport void UnregisterMPCImage(void)
1075 (void) UnregisterMagickInfo("CACHE");
1076 (void) UnregisterMagickInfo("MPC");
1080 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1084 % W r i t e M P C I m a g e %
1088 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1090 % WriteMPCImage() writes an Magick Persistent Cache image to a file.
1092 % The format of the WriteMPCImage method is:
1094 % MagickBooleanType WriteMPCImage(const ImageInfo *image_info,
1095 % Image *image,ExceptionInfo *exception)
1097 % A description of each parameter follows:
1099 % o image_info: the image info.
1101 % o image: the image.
1103 % o exception: return any errors or warnings in this structure.
1107 static inline int open_utf8(const char *path,int flags,mode_t mode)
1109 #if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__) || defined(__MINGW32__) || defined(__MINGW64__)
1110 return(open(path,flags,mode));
1118 path_wide=create_wchar_path(path);
1119 if (path_wide == (wchar_t *) NULL)
1121 status=_wopen(path_wide,flags,mode);
1122 path_wide=(wchar_t *) RelinquishMagickMemory(path_wide);
1127 static MagickBooleanType WriteMPCImage(const ImageInfo *image_info,Image *image,
1128 ExceptionInfo *exception)
1131 buffer[MagickPathExtent],
1132 cache_filename[MagickPathExtent];
1152 Open persistent cache.
1154 assert(image_info != (const ImageInfo *) NULL);
1155 assert(image_info->signature == MagickCoreSignature);
1156 assert(image != (Image *) NULL);
1157 assert(image->signature == MagickCoreSignature);
1158 if (image->debug != MagickFalse)
1159 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
1160 assert(exception != (ExceptionInfo *) NULL);
1161 assert(exception->signature == MagickCoreSignature);
1162 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
1163 if (status == MagickFalse)
1165 (void) CopyMagickString(cache_filename,image->filename,MagickPathExtent);
1166 AppendImageFormat("cache",cache_filename);
1172 Write persistent cache meta-information.
1174 depth=GetImageQuantumDepth(image,MagickTrue);
1175 if ((image->storage_class == PseudoClass) &&
1176 (image->colors > (size_t) (GetQuantumRange(image->depth)+1)))
1177 (void) SetImageStorageClass(image,DirectClass,exception);
1178 (void) WriteBlobString(image,"id=MagickCache\n");
1179 (void) FormatLocaleString(buffer,MagickPathExtent,"magick-signature=%u\n",
1180 GetMagickSignature((const StringInfo *) NULL));
1181 (void) WriteBlobString(image,buffer);
1182 (void) FormatLocaleString(buffer,MagickPathExtent,
1183 "class=%s colors=%.20g alpha-trait=%s\n",CommandOptionToMnemonic(
1184 MagickClassOptions,image->storage_class),(double) image->colors,
1185 CommandOptionToMnemonic(MagickPixelTraitOptions,(ssize_t)
1186 image->alpha_trait));
1187 (void) WriteBlobString(image,buffer);
1188 (void) FormatLocaleString(buffer,MagickPathExtent,
1189 "number-channels=%.20g number-meta-channels=%.20g\n",
1190 (double) image->number_channels,(double) image->number_meta_channels);
1191 (void) WriteBlobString(image,buffer);
1192 (void) FormatLocaleString(buffer,MagickPathExtent,
1193 "columns=%.20g rows=%.20g depth=%.20g\n",(double) image->columns,
1194 (double) image->rows,(double) image->depth);
1195 (void) WriteBlobString(image,buffer);
1196 if (image->type != UndefinedType)
1198 (void) FormatLocaleString(buffer,MagickPathExtent,"type=%s\n",
1199 CommandOptionToMnemonic(MagickTypeOptions,image->type));
1200 (void) WriteBlobString(image,buffer);
1202 (void) FormatLocaleString(buffer,MagickPathExtent,"colorspace=%s\n",
1203 CommandOptionToMnemonic(MagickColorspaceOptions,image->colorspace));
1204 (void) WriteBlobString(image,buffer);
1205 if (image->intensity != UndefinedPixelIntensityMethod)
1207 (void) FormatLocaleString(buffer,MagickPathExtent,
1208 "pixel-intensity=%s\n",CommandOptionToMnemonic(
1209 MagickPixelIntensityOptions,image->intensity));
1210 (void) WriteBlobString(image,buffer);
1212 if (image->endian != UndefinedEndian)
1214 (void) FormatLocaleString(buffer,MagickPathExtent,"endian=%s\n",
1215 CommandOptionToMnemonic(MagickEndianOptions,image->endian));
1216 (void) WriteBlobString(image,buffer);
1218 if (image->compression != UndefinedCompression)
1220 (void) FormatLocaleString(buffer,MagickPathExtent,
1221 "compression=%s quality=%.20g\n",CommandOptionToMnemonic(
1222 MagickCompressOptions,image->compression),(double) image->quality);
1223 (void) WriteBlobString(image,buffer);
1225 if (image->units != UndefinedResolution)
1227 (void) FormatLocaleString(buffer,MagickPathExtent,"units=%s\n",
1228 CommandOptionToMnemonic(MagickResolutionOptions,image->units));
1229 (void) WriteBlobString(image,buffer);
1231 if ((image->resolution.x != 0) || (image->resolution.y != 0))
1233 (void) FormatLocaleString(buffer,MagickPathExtent,
1234 "resolution=%gx%g\n",image->resolution.x,image->resolution.y);
1235 (void) WriteBlobString(image,buffer);
1237 if ((image->page.width != 0) || (image->page.height != 0))
1239 (void) FormatLocaleString(buffer,MagickPathExtent,
1240 "page=%.20gx%.20g%+.20g%+.20g\n",(double) image->page.width,(double)
1241 image->page.height,(double) image->page.x,(double) image->page.y);
1242 (void) WriteBlobString(image,buffer);
1245 if ((image->page.x != 0) || (image->page.y != 0))
1247 (void) FormatLocaleString(buffer,MagickPathExtent,"page=%+ld%+ld\n",
1248 (long) image->page.x,(long) image->page.y);
1249 (void) WriteBlobString(image,buffer);
1251 if ((image->tile_offset.x != 0) || (image->tile_offset.y != 0))
1253 (void) FormatLocaleString(buffer,MagickPathExtent,
1254 "tile-offset=%+ld%+ld\n",(long) image->tile_offset.x,(long)
1255 image->tile_offset.y);
1256 (void) WriteBlobString(image,buffer);
1258 if ((GetNextImageInList(image) != (Image *) NULL) ||
1259 (GetPreviousImageInList(image) != (Image *) NULL))
1261 if (image->scene == 0)
1262 (void) FormatLocaleString(buffer,MagickPathExtent,
1263 "iterations=%.20g delay=%.20g ticks-per-second=%.20g\n",(double)
1264 image->iterations,(double) image->delay,(double)
1265 image->ticks_per_second);
1267 (void) FormatLocaleString(buffer,MagickPathExtent,"scene=%.20g "
1268 "iterations=%.20g delay=%.20g ticks-per-second=%.20g\n",
1269 (double) image->scene,(double) image->iterations,(double)
1270 image->delay,(double) image->ticks_per_second);
1271 (void) WriteBlobString(image,buffer);
1275 if (image->scene != 0)
1277 (void) FormatLocaleString(buffer,MagickPathExtent,"scene=%.20g\n",
1278 (double) image->scene);
1279 (void) WriteBlobString(image,buffer);
1281 if (image->iterations != 0)
1283 (void) FormatLocaleString(buffer,MagickPathExtent,
1284 "iterations=%.20g\n",(double) image->iterations);
1285 (void) WriteBlobString(image,buffer);
1287 if (image->delay != 0)
1289 (void) FormatLocaleString(buffer,MagickPathExtent,"delay=%.20g\n",
1290 (double) image->delay);
1291 (void) WriteBlobString(image,buffer);
1293 if (image->ticks_per_second != UndefinedTicksPerSecond)
1295 (void) FormatLocaleString(buffer,MagickPathExtent,
1296 "ticks-per-second=%.20g\n",(double) image->ticks_per_second);
1297 (void) WriteBlobString(image,buffer);
1300 if (image->gravity != UndefinedGravity)
1302 (void) FormatLocaleString(buffer,MagickPathExtent,"gravity=%s\n",
1303 CommandOptionToMnemonic(MagickGravityOptions,image->gravity));
1304 (void) WriteBlobString(image,buffer);
1306 if (image->dispose != UndefinedDispose)
1308 (void) FormatLocaleString(buffer,MagickPathExtent,"dispose=%s\n",
1309 CommandOptionToMnemonic(MagickDisposeOptions,image->dispose));
1310 (void) WriteBlobString(image,buffer);
1312 if (image->rendering_intent != UndefinedIntent)
1314 (void) FormatLocaleString(buffer,MagickPathExtent,
1315 "rendering-intent=%s\n",CommandOptionToMnemonic(MagickIntentOptions,
1316 image->rendering_intent));
1317 (void) WriteBlobString(image,buffer);
1319 if (image->gamma != 0.0)
1321 (void) FormatLocaleString(buffer,MagickPathExtent,"gamma=%g\n",
1323 (void) WriteBlobString(image,buffer);
1325 if (image->chromaticity.white_point.x != 0.0)
1328 Note chomaticity points.
1330 (void) FormatLocaleString(buffer,MagickPathExtent,"red-primary="
1331 "%g,%g green-primary=%g,%g blue-primary=%g,%g\n",
1332 image->chromaticity.red_primary.x,image->chromaticity.red_primary.y,
1333 image->chromaticity.green_primary.x,
1334 image->chromaticity.green_primary.y,
1335 image->chromaticity.blue_primary.x,
1336 image->chromaticity.blue_primary.y);
1337 (void) WriteBlobString(image,buffer);
1338 (void) FormatLocaleString(buffer,MagickPathExtent,
1339 "white-point=%g,%g\n",image->chromaticity.white_point.x,
1340 image->chromaticity.white_point.y);
1341 (void) WriteBlobString(image,buffer);
1343 if (image->orientation != UndefinedOrientation)
1345 (void) FormatLocaleString(buffer,MagickPathExtent,
1346 "orientation=%s\n",CommandOptionToMnemonic(MagickOrientationOptions,
1347 image->orientation));
1348 (void) WriteBlobString(image,buffer);
1350 if (image->profiles != (void *) NULL)
1361 ResetImageProfileIterator(image);
1362 for (name=GetNextImageProfile(image); name != (const char *) NULL; )
1364 profile=GetImageProfile(image,name);
1365 if (profile != (StringInfo *) NULL)
1367 (void) FormatLocaleString(buffer,MagickPathExtent,
1368 "profile:%s=%.20g\n",name,(double)
1369 GetStringInfoLength(profile));
1370 (void) WriteBlobString(image,buffer);
1372 name=GetNextImageProfile(image);
1375 if (image->montage != (char *) NULL)
1377 (void) FormatLocaleString(buffer,MagickPathExtent,"montage=%s\n",
1379 (void) WriteBlobString(image,buffer);
1381 ResetImagePropertyIterator(image);
1382 property=GetNextImageProperty(image);
1383 while (property != (const char *) NULL)
1385 (void) FormatLocaleString(buffer,MagickPathExtent,"%s=",property);
1386 (void) WriteBlobString(image,buffer);
1387 value=GetImageProperty(image,property,exception);
1388 if (value != (const char *) NULL)
1393 length=strlen(value);
1394 for (i=0; i < (ssize_t) length; i++)
1395 if (isspace((int) ((unsigned char) value[i])) != 0)
1397 if ((i == (ssize_t) length) && (i != 0))
1398 (void) WriteBlob(image,length,(const unsigned char *) value);
1401 (void) WriteBlobByte(image,'{');
1402 if (strchr(value,'}') == (char *) NULL)
1403 (void) WriteBlob(image,length,(const unsigned char *) value);
1405 for (i=0; i < (ssize_t) length; i++)
1407 if (value[i] == (int) '}')
1408 (void) WriteBlobByte(image,'\\');
1409 (void) WriteBlobByte(image,(unsigned char) value[i]);
1411 (void) WriteBlobByte(image,'}');
1414 (void) WriteBlobByte(image,'\n');
1415 property=GetNextImageProperty(image);
1417 (void) WriteBlobString(image,"\f\n:\032");
1418 if (image->montage != (char *) NULL)
1421 Write montage tile directory.
1423 if (image->directory != (char *) NULL)
1424 (void) WriteBlobString(image,image->directory);
1425 (void) WriteBlobByte(image,'\0');
1427 if (image->profiles != 0)
1436 Write image profiles.
1438 ResetImageProfileIterator(image);
1439 name=GetNextImageProfile(image);
1440 while (name != (const char *) NULL)
1442 profile=GetImageProfile(image,name);
1443 (void) WriteBlob(image,GetStringInfoLength(profile),
1444 GetStringInfoDatum(profile));
1445 name=GetNextImageProfile(image);
1448 if (image->storage_class == PseudoClass)
1460 packet_size=(size_t) (3UL*depth/8UL);
1461 colormap=(unsigned char *) AcquireQuantumMemory(image->colors,
1462 packet_size*sizeof(*colormap));
1463 if (colormap == (unsigned char *) NULL)
1464 return(MagickFalse);
1466 Write colormap to file.
1469 for (i=0; i < (ssize_t) image->colors; i++)
1474 ThrowWriterException(CorruptImageError,"ImageDepthNotSupported");
1480 pixel=ScaleQuantumToLong((Quantum) image->colormap[i].red);
1481 q=PopLongPixel(MSBEndian,pixel,q);
1482 pixel=ScaleQuantumToLong((Quantum) image->colormap[i].green);
1483 q=PopLongPixel(MSBEndian,pixel,q);
1484 pixel=ScaleQuantumToLong((Quantum) image->colormap[i].blue);
1485 q=PopLongPixel(MSBEndian,pixel,q);
1493 pixel=ScaleQuantumToShort((Quantum) image->colormap[i].red);
1494 q=PopShortPixel(MSBEndian,pixel,q);
1495 pixel=ScaleQuantumToShort((Quantum) image->colormap[i].green);
1496 q=PopShortPixel(MSBEndian,pixel,q);
1497 pixel=ScaleQuantumToShort((Quantum) image->colormap[i].blue);
1498 q=PopShortPixel(MSBEndian,pixel,q);
1506 pixel=(unsigned char) ScaleQuantumToChar((Quantum)
1507 image->colormap[i].red);
1508 q=PopCharPixel(pixel,q);
1509 pixel=(unsigned char) ScaleQuantumToChar((Quantum)
1510 image->colormap[i].green);
1511 q=PopCharPixel(pixel,q);
1512 pixel=(unsigned char) ScaleQuantumToChar((Quantum)
1513 image->colormap[i].blue);
1514 q=PopCharPixel(pixel,q);
1519 (void) WriteBlob(image,packet_size*image->colors,colormap);
1520 colormap=(unsigned char *) RelinquishMagickMemory(colormap);
1529 register MagickOffsetType
1539 Persistent pixel cache.
1541 pixels=(unsigned char *) GetImagePixelCachePixels(image,&length);
1542 if (pixels == (unsigned char *) NULL)
1543 ThrowWriterException(CacheError,"UnableToPersistPixelCache");
1545 ThrowWriterException(FileOpenError,"UnableToOpenFile");
1546 file=open_utf8(cache_filename,O_WRONLY | O_CREAT | O_BINARY,S_MODE);
1548 ThrowWriterException(CacheError,"UnableToPersistPixelCache");
1550 for (i=0; i < (MagickOffsetType) length; i+=count)
1552 #if !defined(MAGICKCORE_HAVE_PWRITE)
1553 count=write(file,pixels+i,(size_t) MagickMin(length-i,(size_t)
1556 count=pwrite(file,pixels+i,(size_t) MagickMin(length-i,(size_t)
1557 SSIZE_MAX),(off_t) i);
1567 if (i < (MagickOffsetType) length)
1568 ThrowWriterException(CacheError,"UnableToPersistPixelCache");
1570 if (GetNextImageInList(image) == (Image *) NULL)
1572 image=SyncNextImageInList(image);
1573 if (image->progress_monitor != (MagickProgressMonitor) NULL)
1575 status=image->progress_monitor(SaveImagesTag,scene,
1576 GetImageListLength(image),image->client_data);
1577 if (status == MagickFalse)
1581 } while (image_info->adjoin != MagickFalse);
1582 (void) CloseBlob(image);