2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % Read/Write Magick Persistant Cache Image Format %
20 % Copyright 1999-2015 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/hashmap.h"
57 #include "MagickCore/image.h"
58 #include "MagickCore/image-private.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[MaxTextExtent],
149 keyword[MaxTextExtent],
195 assert(image_info != (const ImageInfo *) NULL);
196 assert(image_info->signature == MagickSignature);
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 == MagickSignature);
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,MaxTextExtent);
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=MaxTextExtent;
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=MaxTextExtent;
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 MaxTextExtent,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)
284 if ((size_t) (p-keyword) < (MaxTextExtent-1))
286 c=ReadBlobByte(image);
290 while (isspace((int) ((unsigned char) c)) != 0)
291 c=ReadBlobByte(image);
295 Get the keyword value.
297 c=ReadBlobByte(image);
298 while ((c != (int) '}') && (c != EOF))
300 if ((size_t) (p-options+1) >= length)
304 options=(char *) ResizeQuantumMemory(options,length+
305 MaxTextExtent,sizeof(*options));
306 if (options == (char *) NULL)
308 p=options+strlen(options);
310 if (options == (char *) NULL)
311 ThrowReaderException(ResourceLimitError,
312 "MemoryAllocationFailed");
314 c=ReadBlobByte(image);
317 c=ReadBlobByte(image);
321 c=ReadBlobByte(image);
325 if (isspace((int) ((unsigned char) c)) != 0)
331 (void) CopyMagickString(options,options+1,strlen(options));
333 Assign a value to the specified keyword.
340 if (LocaleCompare(keyword,"alpha-trait") == 0)
345 alpha_trait=ParseCommandOption(MagickPixelTraitOptions,
346 MagickFalse,options);
349 image->alpha_trait=(PixelTrait) alpha_trait;
352 (void) SetImageProperty(image,keyword,options,exception);
358 if (LocaleCompare(keyword,"background-color") == 0)
360 (void) QueryColorCompliance(options,AllCompliance,
361 &image->background_color,exception);
364 if (LocaleCompare(keyword,"blue-primary") == 0)
366 flags=ParseGeometry(options,&geometry_info);
367 image->chromaticity.blue_primary.x=geometry_info.rho;
368 image->chromaticity.blue_primary.y=geometry_info.sigma;
369 if ((flags & SigmaValue) == 0)
370 image->chromaticity.blue_primary.y=
371 image->chromaticity.blue_primary.x;
374 if (LocaleCompare(keyword,"border-color") == 0)
376 (void) QueryColorCompliance(options,AllCompliance,
377 &image->border_color,exception);
380 (void) SetImageProperty(image,keyword,options,exception);
386 if (LocaleCompare(keyword,"class") == 0)
391 storage_class=ParseCommandOption(MagickClassOptions,
392 MagickFalse,options);
393 if (storage_class < 0)
395 image->storage_class=(ClassType) storage_class;
398 if (LocaleCompare(keyword,"colors") == 0)
400 image->colors=StringToUnsignedLong(options);
403 if (LocaleCompare(keyword,"colorspace") == 0)
408 colorspace=ParseCommandOption(MagickColorspaceOptions,
409 MagickFalse,options);
412 image->colorspace=(ColorspaceType) colorspace;
415 if (LocaleCompare(keyword,"compression") == 0)
420 compression=ParseCommandOption(MagickCompressOptions,
421 MagickFalse,options);
424 image->compression=(CompressionType) compression;
427 if (LocaleCompare(keyword,"columns") == 0)
429 image->columns=StringToUnsignedLong(options);
432 (void) SetImageProperty(image,keyword,options,exception);
438 if (LocaleCompare(keyword,"delay") == 0)
440 image->delay=StringToUnsignedLong(options);
443 if (LocaleCompare(keyword,"depth") == 0)
445 image->depth=StringToUnsignedLong(options);
448 if (LocaleCompare(keyword,"dispose") == 0)
453 dispose=ParseCommandOption(MagickDisposeOptions,MagickFalse,
457 image->dispose=(DisposeType) dispose;
460 (void) SetImageProperty(image,keyword,options,exception);
466 if (LocaleCompare(keyword,"endian") == 0)
471 endian=ParseCommandOption(MagickEndianOptions,MagickFalse,
475 image->endian=(EndianType) endian;
478 if (LocaleCompare(keyword,"error") == 0)
480 image->error.mean_error_per_pixel=StringToDouble(options,
484 (void) SetImageProperty(image,keyword,options,exception);
490 if (LocaleCompare(keyword,"gamma") == 0)
492 image->gamma=StringToDouble(options,(char **) NULL);
495 if (LocaleCompare(keyword,"green-primary") == 0)
497 flags=ParseGeometry(options,&geometry_info);
498 image->chromaticity.green_primary.x=geometry_info.rho;
499 image->chromaticity.green_primary.y=geometry_info.sigma;
500 if ((flags & SigmaValue) == 0)
501 image->chromaticity.green_primary.y=
502 image->chromaticity.green_primary.x;
505 (void) SetImageProperty(image,keyword,options,exception);
511 if (LocaleCompare(keyword,"id") == 0)
513 (void) CopyMagickString(id,options,MaxTextExtent);
516 if (LocaleCompare(keyword,"iterations") == 0)
518 image->iterations=StringToUnsignedLong(options);
521 (void) SetImageProperty(image,keyword,options,exception);
527 if (LocaleCompare(keyword,"magick-signature") == 0)
529 signature=(unsigned int) StringToUnsignedLong(options);
532 if (LocaleCompare(keyword,"matte-color") == 0)
534 (void) QueryColorCompliance(options,AllCompliance,
535 &image->matte_color,exception);
538 if (LocaleCompare(keyword,"maximum-error") == 0)
540 image->error.normalized_maximum_error=StringToDouble(
541 options,(char **) NULL);
544 if (LocaleCompare(keyword,"mean-error") == 0)
546 image->error.normalized_mean_error=StringToDouble(options,
550 if (LocaleCompare(keyword,"montage") == 0)
552 (void) CloneString(&image->montage,options);
555 (void) SetImageProperty(image,keyword,options,exception);
561 if (LocaleCompare(keyword,"orientation") == 0)
566 orientation=ParseCommandOption(MagickOrientationOptions,
567 MagickFalse,options);
570 image->orientation=(OrientationType) orientation;
573 (void) SetImageProperty(image,keyword,options,exception);
579 if (LocaleCompare(keyword,"page") == 0)
584 geometry=GetPageGeometry(options);
585 (void) ParseAbsoluteGeometry(geometry,&image->page);
586 geometry=DestroyString(geometry);
589 if (LocaleCompare(keyword,"pixel-intensity") == 0)
594 intensity=ParseCommandOption(MagickPixelIntensityOptions,
595 MagickFalse,options);
598 image->intensity=(PixelIntensityMethod) intensity;
601 if ((LocaleNCompare(keyword,"profile:",8) == 0) ||
602 (LocaleNCompare(keyword,"profile-",8) == 0))
604 if (profiles == (LinkedListInfo *) NULL)
605 profiles=NewLinkedList(0);
606 (void) AppendValueToLinkedList(profiles,
607 AcquireString(keyword+8));
608 profile=BlobToStringInfo((const void *) NULL,(size_t)
609 StringToLong(options));
610 if (profile == (StringInfo *) NULL)
611 ThrowReaderException(ResourceLimitError,
612 "MemoryAllocationFailed");
613 (void) SetImageProfile(image,keyword+8,profile,exception);
614 profile=DestroyStringInfo(profile);
617 (void) SetImageProperty(image,keyword,options,exception);
623 if (LocaleCompare(keyword,"quality") == 0)
625 image->quality=StringToUnsignedLong(options);
628 (void) SetImageProperty(image,keyword,options,exception);
634 if (LocaleCompare(keyword,"red-primary") == 0)
636 flags=ParseGeometry(options,&geometry_info);
637 image->chromaticity.red_primary.x=geometry_info.rho;
638 if ((flags & SigmaValue) != 0)
639 image->chromaticity.red_primary.y=geometry_info.sigma;
642 if (LocaleCompare(keyword,"rendering-intent") == 0)
647 rendering_intent=ParseCommandOption(MagickIntentOptions,
648 MagickFalse,options);
649 if (rendering_intent < 0)
651 image->rendering_intent=(RenderingIntent) rendering_intent;
654 if (LocaleCompare(keyword,"resolution") == 0)
656 flags=ParseGeometry(options,&geometry_info);
657 image->resolution.x=geometry_info.rho;
658 image->resolution.y=geometry_info.sigma;
659 if ((flags & SigmaValue) == 0)
660 image->resolution.y=image->resolution.x;
663 if (LocaleCompare(keyword,"rows") == 0)
665 image->rows=StringToUnsignedLong(options);
668 (void) SetImageProperty(image,keyword,options,exception);
674 if (LocaleCompare(keyword,"scene") == 0)
676 image->scene=StringToUnsignedLong(options);
679 (void) SetImageProperty(image,keyword,options,exception);
685 if (LocaleCompare(keyword,"ticks-per-second") == 0)
687 image->ticks_per_second=(ssize_t) StringToLong(options);
690 if (LocaleCompare(keyword,"tile-offset") == 0)
695 geometry=GetPageGeometry(options);
696 (void) ParseAbsoluteGeometry(geometry,&image->tile_offset);
697 geometry=DestroyString(geometry);
699 if (LocaleCompare(keyword,"type") == 0)
704 type=ParseCommandOption(MagickTypeOptions,MagickFalse,
708 image->type=(ImageType) type;
711 (void) SetImageProperty(image,keyword,options,exception);
717 if (LocaleCompare(keyword,"units") == 0)
722 units=ParseCommandOption(MagickResolutionOptions,
723 MagickFalse,options);
726 image->units=(ResolutionType) units;
729 (void) SetImageProperty(image,keyword,options,exception);
735 if (LocaleCompare(keyword,"white-point") == 0)
737 flags=ParseGeometry(options,&geometry_info);
738 image->chromaticity.white_point.x=geometry_info.rho;
739 image->chromaticity.white_point.y=geometry_info.sigma;
740 if ((flags & SigmaValue) == 0)
741 image->chromaticity.white_point.y=
742 image->chromaticity.white_point.x;
745 (void) SetImageProperty(image,keyword,options,exception);
750 (void) SetImageProperty(image,keyword,options,exception);
756 c=ReadBlobByte(image);
757 while (isspace((int) ((unsigned char) c)) != 0)
758 c=ReadBlobByte(image);
760 options=DestroyString(options);
761 (void) ReadBlobByte(image);
763 Verify that required image information is defined.
765 if ((LocaleCompare(id,"MagickCache") != 0) ||
766 (image->storage_class == UndefinedClass) ||
767 (image->compression == UndefinedCompression) || (image->columns == 0) ||
769 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
770 if (signature != GetMagickSignature((const StringInfo *) NULL))
771 ThrowReaderException(CacheError,"IncompatibleAPI");
772 if (image->montage != (char *) NULL)
780 length=MaxTextExtent;
781 image->directory=AcquireString((char *) NULL);
786 if ((strlen(image->directory)+MaxTextExtent) >= length)
789 Allocate more memory for the image directory.
792 image->directory=(char *) ResizeQuantumMemory(image->directory,
793 length+MaxTextExtent,sizeof(*image->directory));
794 if (image->directory == (char *) NULL)
795 ThrowReaderException(CorruptImageError,"UnableToReadImageData");
796 p=image->directory+strlen(image->directory);
798 c=ReadBlobByte(image);
800 } while (c != (int) '\0');
802 if (profiles != (LinkedListInfo *) NULL)
810 register unsigned char
816 ResetLinkedListIterator(profiles);
817 name=(const char *) GetNextValueInLinkedList(profiles);
818 while (name != (const char *) NULL)
820 profile=GetImageProfile(image,name);
821 if (profile != (StringInfo *) NULL)
823 p=GetStringInfoDatum(profile);
824 count=ReadBlob(image,GetStringInfoLength(profile),p);
826 name=(const char *) GetNextValueInLinkedList(profiles);
828 profiles=DestroyLinkedList(profiles,RelinquishMagickMemory);
830 depth=GetImageQuantumDepth(image,MagickFalse);
831 if (image->storage_class == PseudoClass)
834 Create image colormap.
836 if (AcquireImageColormap(image,image->colors,exception) == MagickFalse)
837 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
838 if (image->colors != 0)
847 Read image colormap from file.
849 packet_size=(size_t) (3UL*depth/8UL);
850 colormap=(unsigned char *) AcquireQuantumMemory(image->colors,
851 packet_size*sizeof(*colormap));
852 if (colormap == (unsigned char *) NULL)
853 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
854 count=ReadBlob(image,packet_size*image->colors,colormap);
855 if (count != (ssize_t) (packet_size*image->colors))
856 ThrowReaderException(CorruptImageError,
857 "InsufficientImageDataInFile");
862 ThrowReaderException(CorruptImageError,
863 "ImageDepthNotSupported");
869 for (i=0; i < (ssize_t) image->colors; i++)
871 p=PushCharPixel(p,&pixel);
872 image->colormap[i].red=ScaleCharToQuantum(pixel);
873 p=PushCharPixel(p,&pixel);
874 image->colormap[i].green=ScaleCharToQuantum(pixel);
875 p=PushCharPixel(p,&pixel);
876 image->colormap[i].blue=ScaleCharToQuantum(pixel);
885 for (i=0; i < (ssize_t) image->colors; i++)
887 p=PushShortPixel(MSBEndian,p,&pixel);
888 image->colormap[i].red=ScaleShortToQuantum(pixel);
889 p=PushShortPixel(MSBEndian,p,&pixel);
890 image->colormap[i].green=ScaleShortToQuantum(pixel);
891 p=PushShortPixel(MSBEndian,p,&pixel);
892 image->colormap[i].blue=ScaleShortToQuantum(pixel);
901 for (i=0; i < (ssize_t) image->colors; i++)
903 p=PushLongPixel(MSBEndian,p,&pixel);
904 image->colormap[i].red=ScaleLongToQuantum(pixel);
905 p=PushLongPixel(MSBEndian,p,&pixel);
906 image->colormap[i].green=ScaleLongToQuantum(pixel);
907 p=PushLongPixel(MSBEndian,p,&pixel);
908 image->colormap[i].blue=ScaleLongToQuantum(pixel);
913 colormap=(unsigned char *) RelinquishMagickMemory(colormap);
916 if (EOFBlob(image) != MagickFalse)
918 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
922 if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))
923 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
926 Attach persistent pixel cache.
928 status=PersistPixelCache(image,cache_filename,MagickTrue,&offset,exception);
929 if (status == MagickFalse)
930 ThrowReaderException(CacheError,"UnableToPersistPixelCache");
932 Proceed to next image.
936 c=ReadBlobByte(image);
937 } while ((isgraph(c) == MagickFalse) && (c != EOF));
941 Allocate next image structure.
943 AcquireNextImage(image_info,image,exception);
944 if (GetNextImageInList(image) == (Image *) NULL)
946 image=DestroyImageList(image);
947 return((Image *) NULL);
949 image=SyncNextImageInList(image);
950 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
952 if (status == MagickFalse)
956 (void) CloseBlob(image);
957 return(GetFirstImageInList(image));
961 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
965 % R e g i s t e r M P C I m a g e %
969 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
971 % RegisterMPCImage() adds properties for the Cache image format to
972 % the list of supported formats. The properties include the image format
973 % tag, a method to read and/or write the format, whether the format
974 % supports the saving of more than one frame to the same file or blob,
975 % whether the format supports native in-memory I/O, and a brief
976 % description of the format.
978 % The format of the RegisterMPCImage method is:
980 % size_t RegisterMPCImage(void)
983 ModuleExport size_t RegisterMPCImage(void)
988 entry=SetMagickInfo("CACHE");
989 entry->description=ConstantString("Magick Persistent Cache image format");
990 entry->module=ConstantString("CACHE");
991 entry->stealth=MagickTrue;
992 (void) RegisterMagickInfo(entry);
993 entry=SetMagickInfo("MPC");
994 entry->decoder=(DecodeImageHandler *) ReadMPCImage;
995 entry->encoder=(EncodeImageHandler *) WriteMPCImage;
996 entry->magick=(IsImageFormatHandler *) IsMPC;
997 entry->description=ConstantString("Magick Persistent Cache image format");
998 entry->module=ConstantString("MPC");
999 (void) RegisterMagickInfo(entry);
1000 return(MagickImageCoderSignature);
1004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1008 % U n r e g i s t e r M P C I m a g e %
1012 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1014 % UnregisterMPCImage() removes format registrations made by the
1015 % MPC module from the list of supported formats.
1017 % The format of the UnregisterMPCImage method is:
1019 % UnregisterMPCImage(void)
1022 ModuleExport void UnregisterMPCImage(void)
1024 (void) UnregisterMagickInfo("CACHE");
1025 (void) UnregisterMagickInfo("MPC");
1029 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1033 % W r i t e M P C I m a g e %
1037 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1039 % WriteMPCImage() writes an Magick Persistent Cache image to a file.
1041 % The format of the WriteMPCImage method is:
1043 % MagickBooleanType WriteMPCImage(const ImageInfo *image_info,
1044 % Image *image,ExceptionInfo *exception)
1046 % A description of each parameter follows:
1048 % o image_info: the image info.
1050 % o image: the image.
1052 % o exception: return any errors or warnings in this structure.
1055 static MagickBooleanType WriteMPCImage(const ImageInfo *image_info,Image *image,
1056 ExceptionInfo *exception)
1059 buffer[MaxTextExtent],
1060 cache_filename[MaxTextExtent];
1080 Open persistent cache.
1082 assert(image_info != (const ImageInfo *) NULL);
1083 assert(image_info->signature == MagickSignature);
1084 assert(image != (Image *) NULL);
1085 assert(image->signature == MagickSignature);
1086 if (image->debug != MagickFalse)
1087 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
1088 assert(exception != (ExceptionInfo *) NULL);
1089 assert(exception->signature == MagickSignature);
1090 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
1091 if (status == MagickFalse)
1093 (void) CopyMagickString(cache_filename,image->filename,MaxTextExtent);
1094 AppendImageFormat("cache",cache_filename);
1100 Write persistent cache meta-information.
1102 depth=GetImageQuantumDepth(image,MagickTrue);
1103 if ((image->storage_class == PseudoClass) &&
1104 (image->colors > (size_t) (GetQuantumRange(image->depth)+1)))
1105 (void) SetImageStorageClass(image,DirectClass,exception);
1106 (void) WriteBlobString(image,"id=MagickCache\n");
1107 (void) FormatLocaleString(buffer,MaxTextExtent,"magick-signature=%u\n",
1108 GetMagickSignature((const StringInfo *) NULL));
1109 (void) WriteBlobString(image,buffer);
1110 (void) FormatLocaleString(buffer,MaxTextExtent,
1111 "class=%s colors=%.20g alpha-trait=%s\n",CommandOptionToMnemonic(
1112 MagickClassOptions,image->storage_class),(double) image->colors,
1113 CommandOptionToMnemonic(MagickPixelTraitOptions,(ssize_t)
1114 image->alpha_trait));
1115 (void) WriteBlobString(image,buffer);
1116 (void) FormatLocaleString(buffer,MaxTextExtent,
1117 "columns=%.20g rows=%.20g depth=%.20g\n",(double) image->columns,
1118 (double) image->rows,(double) image->depth);
1119 (void) WriteBlobString(image,buffer);
1120 if (image->type != UndefinedType)
1122 (void) FormatLocaleString(buffer,MaxTextExtent,"type=%s\n",
1123 CommandOptionToMnemonic(MagickTypeOptions,image->type));
1124 (void) WriteBlobString(image,buffer);
1126 if (image->colorspace != UndefinedColorspace)
1128 (void) FormatLocaleString(buffer,MaxTextExtent,"colorspace=%s\n",
1129 CommandOptionToMnemonic(MagickColorspaceOptions,image->colorspace));
1130 (void) WriteBlobString(image,buffer);
1132 if (image->intensity != UndefinedPixelIntensityMethod)
1134 (void) FormatLocaleString(buffer,MaxTextExtent,"pixel-intensity=%s\n",
1135 CommandOptionToMnemonic(MagickPixelIntensityOptions,
1137 (void) WriteBlobString(image,buffer);
1139 if (image->endian != UndefinedEndian)
1141 (void) FormatLocaleString(buffer,MaxTextExtent,"endian=%s\n",
1142 CommandOptionToMnemonic(MagickEndianOptions,image->endian));
1143 (void) WriteBlobString(image,buffer);
1145 if (image->compression != UndefinedCompression)
1147 (void) FormatLocaleString(buffer,MaxTextExtent,
1148 "compression=%s quality=%.20g\n",CommandOptionToMnemonic(
1149 MagickCompressOptions,image->compression),(double) image->quality);
1150 (void) WriteBlobString(image,buffer);
1152 if (image->units != UndefinedResolution)
1154 (void) FormatLocaleString(buffer,MaxTextExtent,"units=%s\n",
1155 CommandOptionToMnemonic(MagickResolutionOptions,image->units));
1156 (void) WriteBlobString(image,buffer);
1158 if ((image->resolution.x != 0) || (image->resolution.y != 0))
1160 (void) FormatLocaleString(buffer,MaxTextExtent,
1161 "resolution=%gx%g\n",image->resolution.x,image->resolution.y);
1162 (void) WriteBlobString(image,buffer);
1164 if ((image->page.width != 0) || (image->page.height != 0))
1166 (void) FormatLocaleString(buffer,MaxTextExtent,
1167 "page=%.20gx%.20g%+.20g%+.20g\n",(double) image->page.width,(double)
1168 image->page.height,(double) image->page.x,(double) image->page.y);
1169 (void) WriteBlobString(image,buffer);
1172 if ((image->page.x != 0) || (image->page.y != 0))
1174 (void) FormatLocaleString(buffer,MaxTextExtent,"page=%+ld%+ld\n",
1175 (long) image->page.x,(long) image->page.y);
1176 (void) WriteBlobString(image,buffer);
1178 if ((image->page.x != 0) || (image->page.y != 0))
1180 (void) FormatLocaleString(buffer,MaxTextExtent,"tile-offset=%+ld%+ld\n",
1181 (long) image->tile_offset.x,(long) image->tile_offset.y);
1182 (void) WriteBlobString(image,buffer);
1184 if ((GetNextImageInList(image) != (Image *) NULL) ||
1185 (GetPreviousImageInList(image) != (Image *) NULL))
1187 if (image->scene == 0)
1188 (void) FormatLocaleString(buffer,MaxTextExtent,
1189 "iterations=%.20g delay=%.20g ticks-per-second=%.20g\n",(double)
1190 image->iterations,(double) image->delay,(double)
1191 image->ticks_per_second);
1193 (void) FormatLocaleString(buffer,MaxTextExtent,"scene=%.20g "
1194 "iterations=%.20g delay=%.20g ticks-per-second=%.20g\n",
1195 (double) image->scene,(double) image->iterations,(double)
1196 image->delay,(double) image->ticks_per_second);
1197 (void) WriteBlobString(image,buffer);
1201 if (image->scene != 0)
1203 (void) FormatLocaleString(buffer,MaxTextExtent,"scene=%.20g\n",
1204 (double) image->scene);
1205 (void) WriteBlobString(image,buffer);
1207 if (image->iterations != 0)
1209 (void) FormatLocaleString(buffer,MaxTextExtent,"iterations=%.20g\n",
1210 (double) image->iterations);
1211 (void) WriteBlobString(image,buffer);
1213 if (image->delay != 0)
1215 (void) FormatLocaleString(buffer,MaxTextExtent,"delay=%.20g\n",
1216 (double) image->delay);
1217 (void) WriteBlobString(image,buffer);
1219 if (image->ticks_per_second != UndefinedTicksPerSecond)
1221 (void) FormatLocaleString(buffer,MaxTextExtent,
1222 "ticks-per-second=%.20g\n",(double) image->ticks_per_second);
1223 (void) WriteBlobString(image,buffer);
1226 if (image->gravity != UndefinedGravity)
1228 (void) FormatLocaleString(buffer,MaxTextExtent,"gravity=%s\n",
1229 CommandOptionToMnemonic(MagickGravityOptions,image->gravity));
1230 (void) WriteBlobString(image,buffer);
1232 if (image->dispose != UndefinedDispose)
1234 (void) FormatLocaleString(buffer,MaxTextExtent,"dispose=%s\n",
1235 CommandOptionToMnemonic(MagickDisposeOptions,image->dispose));
1236 (void) WriteBlobString(image,buffer);
1238 if (image->rendering_intent != UndefinedIntent)
1240 (void) FormatLocaleString(buffer,MaxTextExtent,
1241 "rendering-intent=%s\n",CommandOptionToMnemonic(MagickIntentOptions,
1242 image->rendering_intent));
1243 (void) WriteBlobString(image,buffer);
1245 if (image->gamma != 0.0)
1247 (void) FormatLocaleString(buffer,MaxTextExtent,"gamma=%g\n",
1249 (void) WriteBlobString(image,buffer);
1251 if (image->chromaticity.white_point.x != 0.0)
1254 Note chomaticity points.
1256 (void) FormatLocaleString(buffer,MaxTextExtent,"red-primary="
1257 "%g,%g green-primary=%g,%g blue-primary=%g,%g\n",
1258 image->chromaticity.red_primary.x,image->chromaticity.red_primary.y,
1259 image->chromaticity.green_primary.x,
1260 image->chromaticity.green_primary.y,
1261 image->chromaticity.blue_primary.x,
1262 image->chromaticity.blue_primary.y);
1263 (void) WriteBlobString(image,buffer);
1264 (void) FormatLocaleString(buffer,MaxTextExtent,
1265 "white-point=%g,%g\n",image->chromaticity.white_point.x,
1266 image->chromaticity.white_point.y);
1267 (void) WriteBlobString(image,buffer);
1269 if (image->orientation != UndefinedOrientation)
1271 (void) FormatLocaleString(buffer,MaxTextExtent,
1272 "orientation=%s\n",CommandOptionToMnemonic(MagickOrientationOptions,
1273 image->orientation));
1274 (void) WriteBlobString(image,buffer);
1276 if (image->profiles != (void *) NULL)
1287 ResetImageProfileIterator(image);
1288 for (name=GetNextImageProfile(image); name != (const char *) NULL; )
1290 profile=GetImageProfile(image,name);
1291 if (profile != (StringInfo *) NULL)
1293 (void) FormatLocaleString(buffer,MaxTextExtent,
1294 "profile:%s=%.20g\n",name,(double)
1295 GetStringInfoLength(profile));
1296 (void) WriteBlobString(image,buffer);
1298 name=GetNextImageProfile(image);
1301 if (image->montage != (char *) NULL)
1303 (void) FormatLocaleString(buffer,MaxTextExtent,"montage=%s\n",
1305 (void) WriteBlobString(image,buffer);
1307 ResetImagePropertyIterator(image);
1308 property=GetNextImageProperty(image);
1309 while (property != (const char *) NULL)
1311 (void) FormatLocaleString(buffer,MaxTextExtent,"%s=",property);
1312 (void) WriteBlobString(image,buffer);
1313 value=GetImageProperty(image,property,exception);
1314 if (value != (const char *) NULL)
1319 length=strlen(value);
1320 for (i=0; i < (ssize_t) length; i++)
1321 if (isspace((int) ((unsigned char) value[i])) != 0)
1323 if ((i == (ssize_t) length) && (i != 0))
1324 (void) WriteBlob(image,length,(const unsigned char *) value);
1327 (void) WriteBlobByte(image,'{');
1328 if (strchr(value,'}') == (char *) NULL)
1329 (void) WriteBlob(image,length,(const unsigned char *) value);
1331 for (i=0; i < (ssize_t) length; i++)
1333 if (value[i] == (int) '}')
1334 (void) WriteBlobByte(image,'\\');
1335 (void) WriteBlobByte(image,value[i]);
1337 (void) WriteBlobByte(image,'}');
1340 (void) WriteBlobByte(image,'\n');
1341 property=GetNextImageProperty(image);
1343 (void) WriteBlobString(image,"\f\n:\032");
1344 if (image->montage != (char *) NULL)
1347 Write montage tile directory.
1349 if (image->directory != (char *) NULL)
1350 (void) WriteBlobString(image,image->directory);
1351 (void) WriteBlobByte(image,'\0');
1353 if (image->profiles != 0)
1362 Write image profiles.
1364 ResetImageProfileIterator(image);
1365 name=GetNextImageProfile(image);
1366 while (name != (const char *) NULL)
1368 profile=GetImageProfile(image,name);
1369 (void) WriteBlob(image,GetStringInfoLength(profile),
1370 GetStringInfoDatum(profile));
1371 name=GetNextImageProfile(image);
1374 if (image->storage_class == PseudoClass)
1386 packet_size=(size_t) (3UL*depth/8UL);
1387 colormap=(unsigned char *) AcquireQuantumMemory(image->colors,
1388 packet_size*sizeof(*colormap));
1389 if (colormap == (unsigned char *) NULL)
1390 return(MagickFalse);
1392 Write colormap to file.
1395 for (i=0; i < (ssize_t) image->colors; i++)
1400 ThrowWriterException(CorruptImageError,"ImageDepthNotSupported");
1406 pixel=ScaleQuantumToLong(image->colormap[i].red);
1407 q=PopLongPixel(MSBEndian,pixel,q);
1408 pixel=ScaleQuantumToLong(image->colormap[i].green);
1409 q=PopLongPixel(MSBEndian,pixel,q);
1410 pixel=ScaleQuantumToLong(image->colormap[i].blue);
1411 q=PopLongPixel(MSBEndian,pixel,q);
1419 pixel=ScaleQuantumToShort(image->colormap[i].red);
1420 q=PopShortPixel(MSBEndian,pixel,q);
1421 pixel=ScaleQuantumToShort(image->colormap[i].green);
1422 q=PopShortPixel(MSBEndian,pixel,q);
1423 pixel=ScaleQuantumToShort(image->colormap[i].blue);
1424 q=PopShortPixel(MSBEndian,pixel,q);
1432 pixel=(unsigned char) ScaleQuantumToChar(image->colormap[i].red);
1433 q=PopCharPixel(pixel,q);
1434 pixel=(unsigned char) ScaleQuantumToChar(
1435 image->colormap[i].green);
1436 q=PopCharPixel(pixel,q);
1437 pixel=(unsigned char) ScaleQuantumToChar(image->colormap[i].blue);
1438 q=PopCharPixel(pixel,q);
1443 (void) WriteBlob(image,packet_size*image->colors,colormap);
1444 colormap=(unsigned char *) RelinquishMagickMemory(colormap);
1447 Initialize persistent pixel cache.
1449 status=PersistPixelCache(image,cache_filename,MagickFalse,&offset,
1451 if (status == MagickFalse)
1452 ThrowWriterException(CacheError,"UnableToPersistPixelCache");
1453 if (GetNextImageInList(image) == (Image *) NULL)
1455 image=SyncNextImageInList(image);
1456 if (image->progress_monitor != (MagickProgressMonitor) NULL)
1458 status=image->progress_monitor(SaveImagesTag,scene,
1459 GetImageListLength(image),image->client_data);
1460 if (status == MagickFalse)
1464 } while (image_info->adjoin != MagickFalse);
1465 (void) CloseBlob(image);