2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10 % IIIII CCCC OOO N N %
13 % Read Microsoft Windows Icon Format %
20 % Copyright 1999-2018 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://imagemagick.org/script/license.php %
28 % Unless required by applicable law or agreed to in writing, software %
29 % distributed under the License is distributed on an "AS IS" BASIS, %
30 % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
31 % See the License for the specific language governing permissions and %
32 % limitations under the License. %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "MagickCore/studio.h"
43 #include "MagickCore/artifact.h"
44 #include "MagickCore/blob.h"
45 #include "MagickCore/blob-private.h"
46 #include "MagickCore/cache.h"
47 #include "MagickCore/colormap.h"
48 #include "MagickCore/colorspace.h"
49 #include "MagickCore/colorspace-private.h"
50 #include "MagickCore/exception.h"
51 #include "MagickCore/exception-private.h"
52 #include "MagickCore/image.h"
53 #include "MagickCore/image-private.h"
54 #include "MagickCore/list.h"
55 #include "MagickCore/log.h"
56 #include "MagickCore/magick.h"
57 #include "MagickCore/memory_.h"
58 #include "MagickCore/monitor.h"
59 #include "MagickCore/monitor-private.h"
60 #include "MagickCore/nt-base-private.h"
61 #include "MagickCore/option.h"
62 #include "MagickCore/pixel-accessor.h"
63 #include "MagickCore/quantize.h"
64 #include "MagickCore/quantum-private.h"
65 #include "MagickCore/static.h"
66 #include "MagickCore/string_.h"
67 #include "MagickCore/module.h"
72 #if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__MINGW32__)
75 #define BI_BITFIELDS 3
82 typedef struct _IconEntry
99 typedef struct _IconFile
110 typedef struct _IconInfo
143 Forward declaractions.
146 *AutoResizeImage(const Image *,const char *,MagickOffsetType *,
149 static MagickBooleanType
150 WriteICONImage(const ImageInfo *,Image *,ExceptionInfo *);
152 Image *AutoResizeImage(const Image *image,const char *option,
153 MagickOffsetType *count,ExceptionInfo *exception)
171 sizes[MAX_SIZES]={256,192,128,96,64,48,40,32,24,16};
177 while (*p != '\0' && i < MAX_SIZES)
182 while ((isspace((int) ((unsigned char) *p)) != 0))
185 size=(size_t)strtol(p,&q,10);
186 if ((p == q) || (size < 16) || (size > 256))
187 return((Image *) NULL);
192 while ((isspace((int) ((unsigned char) *p)) != 0) || (*p == ','))
199 for (i=0; i < *count; i++)
201 resized=ResizeImage(image,sizes[i],sizes[i],image->filter,exception);
202 if (resized == (Image *) NULL)
203 return(DestroyImageList(images));
205 if (images == (Image *) NULL)
208 AppendImageToList(&images,resized);
214 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
218 % R e a d I C O N I m a g e %
222 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
224 % ReadICONImage() reads a Microsoft icon image file and returns it. It
225 % allocates the memory necessary for the new Image structure and returns a
226 % pointer to the new image.
228 % The format of the ReadICONImage method is:
230 % Image *ReadICONImage(const ImageInfo *image_info,
231 % ExceptionInfo *exception)
233 % A description of each parameter follows:
235 % o image_info: the image info.
237 % o exception: return any errors or warnings in this structure.
240 static Image *ReadICONImage(const ImageInfo *image_info,
241 ExceptionInfo *exception)
265 register unsigned char
283 assert(image_info != (const ImageInfo *) NULL);
284 assert(image_info->signature == MagickCoreSignature);
285 (void) LogMagickEvent(CoderEvent,GetMagickModule(),"%s",image_info->filename);
286 assert(exception != (ExceptionInfo *) NULL);
287 assert(exception->signature == MagickCoreSignature);
288 image=AcquireImage(image_info,exception);
289 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
290 if (status == MagickFalse)
292 image=DestroyImageList(image);
293 return((Image *) NULL);
295 icon_file.reserved=(short) ReadBlobLSBShort(image);
296 icon_file.resource_type=(short) ReadBlobLSBShort(image);
297 icon_file.count=(short) ReadBlobLSBShort(image);
298 if ((icon_file.reserved != 0) ||
299 ((icon_file.resource_type != 1) && (icon_file.resource_type != 2)) ||
300 (icon_file.count > MaxIcons))
301 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
303 for (i=0; i < icon_file.count; i++)
305 icon_file.directory[i].width=(unsigned char) ReadBlobByte(image);
306 icon_file.directory[i].height=(unsigned char) ReadBlobByte(image);
307 icon_file.directory[i].colors=(unsigned char) ReadBlobByte(image);
308 icon_file.directory[i].reserved=(unsigned char) ReadBlobByte(image);
309 icon_file.directory[i].planes=(unsigned short) ReadBlobLSBShort(image);
310 icon_file.directory[i].bits_per_pixel=(unsigned short)
311 ReadBlobLSBShort(image);
312 icon_file.directory[i].size=ReadBlobLSBLong(image);
313 icon_file.directory[i].offset=ReadBlobLSBLong(image);
314 if (EOFBlob(image) != MagickFalse)
316 extent=MagickMax(extent,icon_file.directory[i].size);
318 if ((EOFBlob(image) != MagickFalse) || (extent > GetBlobSize(image)))
319 ThrowReaderException(CorruptImageError,"UnexpectedEndOfFile");
321 for (i=0; i < icon_file.count; i++)
324 Verify Icon identifier.
326 offset=(ssize_t) SeekBlob(image,(MagickOffsetType)
327 icon_file.directory[i].offset,SEEK_SET);
329 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
330 icon_info.size=ReadBlobLSBLong(image);
331 icon_info.width=(unsigned char) ReadBlobLSBSignedLong(image);
332 icon_info.height=(unsigned char) (ReadBlobLSBSignedLong(image)/2);
333 icon_info.planes=ReadBlobLSBShort(image);
334 icon_info.bits_per_pixel=ReadBlobLSBShort(image);
335 if (EOFBlob(image) != MagickFalse)
337 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
341 if (((icon_info.planes == 18505) && (icon_info.bits_per_pixel == 21060)) ||
342 (icon_info.size == 0x474e5089))
357 Icon image encoded as a compressed PNG image.
359 length=icon_file.directory[i].size;
360 if ((length < 16) || (~length < 16))
361 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
362 png=(unsigned char *) AcquireQuantumMemory(length+16,sizeof(*png));
363 if (png == (unsigned char *) NULL)
364 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
365 (void) memcpy(png,"\211PNG\r\n\032\n\000\000\000\015",12);
366 png[12]=(unsigned char) icon_info.planes;
367 png[13]=(unsigned char) (icon_info.planes >> 8);
368 png[14]=(unsigned char) icon_info.bits_per_pixel;
369 png[15]=(unsigned char) (icon_info.bits_per_pixel >> 8);
370 count=ReadBlob(image,length,png+16);
371 if (count != (ssize_t) length)
373 png=(unsigned char *) RelinquishMagickMemory(png);
374 ThrowReaderException(CorruptImageError,
375 "InsufficientImageDataInFile");
377 read_info=CloneImageInfo(image_info);
378 (void) CopyMagickString(read_info->magick,"PNG",MagickPathExtent);
379 icon_image=BlobToImage(read_info,png,length+16,exception);
380 read_info=DestroyImageInfo(read_info);
381 png=(unsigned char *) RelinquishMagickMemory(png);
382 if (icon_image == (Image *) NULL)
383 return(DestroyImageList(image));
384 DestroyBlob(icon_image);
385 icon_image->blob=ReferenceBlob(image->blob);
386 ReplaceImageInList(&image,icon_image);
390 if (icon_info.bits_per_pixel > 32)
391 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
392 icon_info.compression=ReadBlobLSBLong(image);
393 icon_info.image_size=ReadBlobLSBLong(image);
394 icon_info.x_pixels=ReadBlobLSBLong(image);
395 icon_info.y_pixels=ReadBlobLSBLong(image);
396 icon_info.number_colors=ReadBlobLSBLong(image);
397 if (icon_info.number_colors > GetBlobSize(image))
398 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
399 icon_info.colors_important=ReadBlobLSBLong(image);
400 image->alpha_trait=BlendPixelTrait;
401 image->columns=(size_t) icon_file.directory[i].width;
402 if ((ssize_t) image->columns > icon_info.width)
403 image->columns=(size_t) icon_info.width;
404 if (image->columns == 0)
406 image->rows=(size_t) icon_file.directory[i].height;
407 if ((ssize_t) image->rows > icon_info.height)
408 image->rows=(size_t) icon_info.height;
409 if (image->rows == 0)
411 image->depth=icon_info.bits_per_pixel;
412 if (image->depth > 16)
414 if (image->debug != MagickFalse)
416 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
417 " scene = %.20g",(double) i);
418 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
419 " size = %.20g",(double) icon_info.size);
420 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
421 " width = %.20g",(double) icon_file.directory[i].width);
422 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
423 " height = %.20g",(double) icon_file.directory[i].height);
424 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
425 " colors = %.20g",(double ) icon_info.number_colors);
426 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
427 " planes = %.20g",(double) icon_info.planes);
428 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
429 " bpp = %.20g",(double) icon_info.bits_per_pixel);
431 if ((icon_info.number_colors != 0) || (icon_info.bits_per_pixel <= 16U))
433 image->storage_class=PseudoClass;
434 image->colors=icon_info.number_colors;
435 if ((image->colors == 0) || (image->colors > 256))
436 image->colors=one << icon_info.bits_per_pixel;
438 if (image->storage_class == PseudoClass)
447 Read Icon raster colormap.
449 if (image->colors > GetBlobSize(image))
450 ThrowReaderException(CorruptImageError,
451 "InsufficientImageDataInFile");
452 if (AcquireImageColormap(image,image->colors,exception) ==
454 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
455 icon_colormap=(unsigned char *) AcquireQuantumMemory((size_t)
456 image->colors,4UL*sizeof(*icon_colormap));
457 if (icon_colormap == (unsigned char *) NULL)
458 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
459 count=ReadBlob(image,(size_t) (4*image->colors),icon_colormap);
460 if (count != (ssize_t) (4*image->colors))
462 icon_colormap=(unsigned char *) RelinquishMagickMemory(
464 ThrowReaderException(CorruptImageError,
465 "InsufficientImageDataInFile");
468 for (j=0; j < (ssize_t) image->colors; j++)
470 image->colormap[j].blue=(Quantum) ScaleCharToQuantum(*p++);
471 image->colormap[j].green=(Quantum) ScaleCharToQuantum(*p++);
472 image->colormap[j].red=(Quantum) ScaleCharToQuantum(*p++);
475 icon_colormap=(unsigned char *) RelinquishMagickMemory(icon_colormap);
478 Convert Icon raster image to pixel packets.
480 if ((image_info->ping != MagickFalse) &&
481 (image_info->number_scenes != 0))
482 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
484 status=SetImageExtent(image,image->columns,image->rows,exception);
485 if (status == MagickFalse)
486 return(DestroyImageList(image));
487 bytes_per_line=(((image->columns*icon_info.bits_per_pixel)+31) &
489 (void) bytes_per_line;
490 scanline_pad=((((image->columns*icon_info.bits_per_pixel)+31) & ~31)-
491 (image->columns*icon_info.bits_per_pixel)) >> 3;
492 switch (icon_info.bits_per_pixel)
497 Convert bitmap scanline.
499 for (y=(ssize_t) image->rows-1; y >= 0; y--)
501 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
502 if (q == (Quantum *) NULL)
504 for (x=0; x < (ssize_t) (image->columns-7); x+=8)
506 byte=(size_t) ReadBlobByte(image);
507 for (bit=0; bit < 8; bit++)
509 SetPixelIndex(image,((byte & (0x80 >> bit)) != 0 ? 0x01 :
511 q+=GetPixelChannels(image);
514 if ((image->columns % 8) != 0)
516 byte=(size_t) ReadBlobByte(image);
517 for (bit=0; bit < (image->columns % 8); bit++)
519 SetPixelIndex(image,((byte & (0x80 >> bit)) != 0 ? 0x01 :
521 q+=GetPixelChannels(image);
524 for (x=0; x < (ssize_t) scanline_pad; x++)
525 (void) ReadBlobByte(image);
526 if (SyncAuthenticPixels(image,exception) == MagickFalse)
528 if (image->previous == (Image *) NULL)
530 status=SetImageProgress(image,LoadImageTag,image->rows-y-1,
532 if (status == MagickFalse)
541 Read 4-bit Icon scanline.
543 for (y=(ssize_t) image->rows-1; y >= 0; y--)
545 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
546 if (q == (Quantum *) NULL)
548 for (x=0; x < ((ssize_t) image->columns-1); x+=2)
550 byte=(size_t) ReadBlobByte(image);
551 SetPixelIndex(image,((byte >> 4) & 0xf),q);
552 q+=GetPixelChannels(image);
553 SetPixelIndex(image,((byte) & 0xf),q);
554 q+=GetPixelChannels(image);
556 if ((image->columns % 2) != 0)
558 byte=(size_t) ReadBlobByte(image);
559 SetPixelIndex(image,((byte >> 4) & 0xf),q);
560 q+=GetPixelChannels(image);
562 for (x=0; x < (ssize_t) scanline_pad; x++)
563 (void) ReadBlobByte(image);
564 if (SyncAuthenticPixels(image,exception) == MagickFalse)
566 if (image->previous == (Image *) NULL)
568 status=SetImageProgress(image,LoadImageTag,image->rows-y-1,
570 if (status == MagickFalse)
579 Convert PseudoColor scanline.
581 for (y=(ssize_t) image->rows-1; y >= 0; y--)
583 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
584 if (q == (Quantum *) NULL)
586 for (x=0; x < (ssize_t) image->columns; x++)
588 byte=(size_t) ReadBlobByte(image);
589 SetPixelIndex(image,(Quantum) byte,q);
590 q+=GetPixelChannels(image);
592 for (x=0; x < (ssize_t) scanline_pad; x++)
593 (void) ReadBlobByte(image);
594 if (SyncAuthenticPixels(image,exception) == MagickFalse)
596 if (image->previous == (Image *) NULL)
598 status=SetImageProgress(image,LoadImageTag,image->rows-y-1,
600 if (status == MagickFalse)
609 Convert PseudoColor scanline.
611 for (y=(ssize_t) image->rows-1; y >= 0; y--)
613 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
614 if (q == (Quantum *) NULL)
616 for (x=0; x < (ssize_t) image->columns; x++)
618 byte=(size_t) ReadBlobByte(image);
619 byte|=((size_t) ReadBlobByte(image) << 8);
620 SetPixelIndex(image,(Quantum) byte,q);
621 q+=GetPixelChannels(image);
623 for (x=0; x < (ssize_t) scanline_pad; x++)
624 (void) ReadBlobByte(image);
625 if (SyncAuthenticPixels(image,exception) == MagickFalse)
627 if (image->previous == (Image *) NULL)
629 status=SetImageProgress(image,LoadImageTag,image->rows-y-1,
631 if (status == MagickFalse)
641 Convert DirectColor scanline.
643 for (y=(ssize_t) image->rows-1; y >= 0; y--)
645 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
646 if (q == (Quantum *) NULL)
648 for (x=0; x < (ssize_t) image->columns; x++)
650 SetPixelBlue(image,ScaleCharToQuantum((unsigned char)
651 ReadBlobByte(image)),q);
652 SetPixelGreen(image,ScaleCharToQuantum((unsigned char)
653 ReadBlobByte(image)),q);
654 SetPixelRed(image,ScaleCharToQuantum((unsigned char)
655 ReadBlobByte(image)),q);
656 if (icon_info.bits_per_pixel == 32)
657 SetPixelAlpha(image,ScaleCharToQuantum((unsigned char)
658 ReadBlobByte(image)),q);
659 q+=GetPixelChannels(image);
661 if (icon_info.bits_per_pixel == 24)
662 for (x=0; x < (ssize_t) scanline_pad; x++)
663 (void) ReadBlobByte(image);
664 if (SyncAuthenticPixels(image,exception) == MagickFalse)
666 if (image->previous == (Image *) NULL)
668 status=SetImageProgress(image,LoadImageTag,image->rows-y-1,
670 if (status == MagickFalse)
677 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
679 if ((image_info->ping == MagickFalse) &&
680 (icon_info.bits_per_pixel <= 16))
681 (void) SyncImage(image,exception);
682 if (icon_info.bits_per_pixel != 32)
685 Read the ICON alpha mask.
687 image->storage_class=DirectClass;
688 for (y=(ssize_t) image->rows-1; y >= 0; y--)
690 q=GetAuthenticPixels(image,0,y,image->columns,1,exception);
691 if (q == (Quantum *) NULL)
693 for (x=0; x < ((ssize_t) image->columns-7); x+=8)
695 byte=(size_t) ReadBlobByte(image);
696 for (bit=0; bit < 8; bit++)
698 SetPixelAlpha(image,(((byte & (0x80 >> bit)) != 0) ?
699 TransparentAlpha : OpaqueAlpha),q);
700 q+=GetPixelChannels(image);
703 if ((image->columns % 8) != 0)
705 byte=(size_t) ReadBlobByte(image);
706 for (bit=0; bit < (image->columns % 8); bit++)
708 SetPixelAlpha(image,(((byte & (0x80 >> bit)) != 0) ?
709 TransparentAlpha : OpaqueAlpha),q);
710 q+=GetPixelChannels(image);
713 if ((image->columns % 32) != 0)
714 for (x=0; x < (ssize_t) ((32-(image->columns % 32))/8); x++)
715 (void) ReadBlobByte(image);
716 if (SyncAuthenticPixels(image,exception) == MagickFalse)
720 if (EOFBlob(image) != MagickFalse)
722 ThrowFileException(exception,CorruptImageError,
723 "UnexpectedEndOfFile",image->filename);
728 Proceed to next image.
730 if (image_info->number_scenes != 0)
731 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
733 if (i < (ssize_t) (icon_file.count-1))
736 Allocate next image structure.
738 AcquireNextImage(image_info,image,exception);
739 if (GetNextImageInList(image) == (Image *) NULL)
744 image=SyncNextImageInList(image);
745 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
747 if (status == MagickFalse)
751 (void) CloseBlob(image);
752 if (status == MagickFalse)
753 return(DestroyImageList(image));
754 return(GetFirstImageInList(image));
758 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
762 % R e g i s t e r I C O N I m a g e %
766 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
768 % RegisterICONImage() adds attributes for the Icon image format to
769 % the list of supported formats. The attributes include the image format
770 % tag, a method to read and/or write the format, whether the format
771 % supports the saving of more than one frame to the same file or blob,
772 % whether the format supports native in-memory I/O, and a brief
773 % description of the format.
775 % The format of the RegisterICONImage method is:
777 % size_t RegisterICONImage(void)
780 ModuleExport size_t RegisterICONImage(void)
785 entry=AcquireMagickInfo("ICON","CUR","Microsoft icon");
786 entry->decoder=(DecodeImageHandler *) ReadICONImage;
787 entry->encoder=(EncodeImageHandler *) WriteICONImage;
788 entry->flags^=CoderAdjoinFlag;
789 entry->flags|=CoderDecoderSeekableStreamFlag;
790 entry->flags|=CoderEncoderSeekableStreamFlag;
791 (void) RegisterMagickInfo(entry);
792 entry=AcquireMagickInfo("ICON","ICO","Microsoft icon");
793 entry->decoder=(DecodeImageHandler *) ReadICONImage;
794 entry->encoder=(EncodeImageHandler *) WriteICONImage;
795 entry->flags|=CoderDecoderSeekableStreamFlag;
796 entry->flags|=CoderEncoderSeekableStreamFlag;
797 (void) RegisterMagickInfo(entry);
798 entry=AcquireMagickInfo("ICON","ICON","Microsoft icon");
799 entry->decoder=(DecodeImageHandler *) ReadICONImage;
800 entry->encoder=(EncodeImageHandler *) WriteICONImage;
801 entry->flags^=CoderAdjoinFlag;
802 entry->flags|=CoderDecoderSeekableStreamFlag;
803 entry->flags|=CoderEncoderSeekableStreamFlag;
804 (void) RegisterMagickInfo(entry);
805 return(MagickImageCoderSignature);
809 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
813 % U n r e g i s t e r I C O N I m a g e %
817 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
819 % UnregisterICONImage() removes format registrations made by the
820 % ICON module from the list of supported formats.
822 % The format of the UnregisterICONImage method is:
824 % UnregisterICONImage(void)
827 ModuleExport void UnregisterICONImage(void)
829 (void) UnregisterMagickInfo("CUR");
830 (void) UnregisterMagickInfo("ICO");
831 (void) UnregisterMagickInfo("ICON");
835 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
839 % W r i t e I C O N I m a g e %
843 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
845 % WriteICONImage() writes an image in Microsoft Windows bitmap encoded
846 % image format, version 3 for Windows or (if the image has a matte channel)
849 % It encodes any subimage as a compressed PNG image ("BI_PNG)", only when its
850 % dimensions are 256x256 and image->compression is undefined or is defined as
853 % The format of the WriteICONImage method is:
855 % MagickBooleanType WriteICONImage(const ImageInfo *image_info,
856 % Image *image,ExceptionInfo *exception)
858 % A description of each parameter follows.
860 % o image_info: the image info.
862 % o image: The image.
864 % o exception: return any errors or warnings in this structure.
867 static MagickBooleanType WriteICONImage(const ImageInfo *image_info,
868 Image *image,ExceptionInfo *exception)
890 register const Quantum
897 register unsigned char
912 Open output image file.
914 assert(image_info != (const ImageInfo *) NULL);
915 assert(image_info->signature == MagickCoreSignature);
916 assert(image != (Image *) NULL);
917 assert(image->signature == MagickCoreSignature);
918 (void) LogMagickEvent(CoderEvent,GetMagickModule(),"%s",image->filename);
919 assert(exception != (ExceptionInfo *) NULL);
920 assert(exception->signature == MagickCoreSignature);
921 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
922 if (status == MagickFalse)
924 images=(Image *) NULL;
925 option=GetImageOption(image_info,"icon:auto-resize");
926 if (option != (const char *) NULL)
928 images=AutoResizeImage(image,option,&scene,exception);
929 if (images == (Image *) NULL)
930 ThrowWriterException(ImageError,"InvalidDimensions");
938 if ((image->columns > 256L) || (image->rows > 256L))
939 ThrowWriterException(ImageError,"WidthOrHeightExceedsLimit");
941 next=SyncNextImageInList(next);
942 } while ((next != (Image *) NULL) && (image_info->adjoin != MagickFalse));
945 Dump out a ICON header template to be properly initialized later.
947 (void) WriteBlobLSBShort(image,0);
948 (void) WriteBlobLSBShort(image,1);
949 (void) WriteBlobLSBShort(image,(unsigned char) scene);
950 (void) memset(&icon_file,0,sizeof(icon_file));
951 (void) memset(&icon_info,0,sizeof(icon_info));
953 next=(images != (Image *) NULL) ? images : image;
956 (void) WriteBlobByte(image,icon_file.directory[scene].width);
957 (void) WriteBlobByte(image,icon_file.directory[scene].height);
958 (void) WriteBlobByte(image,icon_file.directory[scene].colors);
959 (void) WriteBlobByte(image,icon_file.directory[scene].reserved);
960 (void) WriteBlobLSBShort(image,icon_file.directory[scene].planes);
961 (void) WriteBlobLSBShort(image,icon_file.directory[scene].bits_per_pixel);
962 (void) WriteBlobLSBLong(image,(unsigned int)
963 icon_file.directory[scene].size);
964 (void) WriteBlobLSBLong(image,(unsigned int)
965 icon_file.directory[scene].offset);
967 next=SyncNextImageInList(next);
968 } while ((next != (Image *) NULL) && (image_info->adjoin != MagickFalse));
970 next=(images != (Image *) NULL) ? images : image;
971 imageListLength=GetImageListLength(image);
974 if ((next->columns > 255L) && (next->rows > 255L) &&
975 ((next->compression == UndefinedCompression) ||
976 (next->compression == ZipCompression)))
990 write_image=CloneImage(next,0,0,MagickTrue,exception);
991 if (write_image == (Image *) NULL)
993 images=DestroyImageList(images);
996 write_info=CloneImageInfo(image_info);
997 (void) CopyMagickString(write_info->magick,"PNG",MagickPathExtent);
1000 /* Don't write any ancillary chunks except for gAMA */
1001 (void) SetImageArtifact(write_image,"png:include-chunk","none,gama");
1003 /* Only write PNG32 formatted PNG (32-bit RGBA), 8 bits per channel */
1004 (void) SetImageArtifact(write_image,"png:format","png32");
1006 png=(unsigned char *) ImageToBlob(write_info,write_image,&length,
1008 write_image=DestroyImageList(write_image);
1009 write_info=DestroyImageInfo(write_info);
1010 if (png == (unsigned char *) NULL)
1012 images=DestroyImageList(images);
1013 return(MagickFalse);
1015 icon_file.directory[scene].width=0;
1016 icon_file.directory[scene].height=0;
1017 icon_file.directory[scene].colors=0;
1018 icon_file.directory[scene].reserved=0;
1019 icon_file.directory[scene].planes=1;
1020 icon_file.directory[scene].bits_per_pixel=32;
1021 icon_file.directory[scene].size=(size_t) length;
1022 icon_file.directory[scene].offset=(size_t) TellBlob(image);
1023 (void) WriteBlob(image,(size_t) length,png);
1024 png=(unsigned char *) RelinquishMagickMemory(png);
1029 Initialize ICON raster file header.
1031 (void) TransformImageColorspace(next,sRGBColorspace,exception);
1032 icon_info.file_size=14+12+28;
1033 icon_info.offset_bits=icon_info.file_size;
1034 icon_info.compression=BI_RGB;
1035 if ((next->storage_class != DirectClass) && (next->colors > 256))
1036 (void) SetImageStorageClass(next,DirectClass,exception);
1037 if (next->storage_class == DirectClass)
1040 Full color ICON raster.
1042 icon_info.number_colors=0;
1043 icon_info.bits_per_pixel=32;
1044 icon_info.compression=(size_t) BI_RGB;
1052 Colormapped ICON raster.
1054 icon_info.bits_per_pixel=8;
1055 if (next->colors <= 256)
1056 icon_info.bits_per_pixel=8;
1057 if (next->colors <= 16)
1058 icon_info.bits_per_pixel=4;
1059 if (next->colors <= 2)
1060 icon_info.bits_per_pixel=1;
1062 icon_info.number_colors=one << icon_info.bits_per_pixel;
1063 if (icon_info.number_colors < next->colors)
1065 (void) SetImageStorageClass(next,DirectClass,exception);
1066 icon_info.number_colors=0;
1067 icon_info.bits_per_pixel=(unsigned short) 24;
1068 icon_info.compression=(size_t) BI_RGB;
1073 icon_info.file_size+=3*(one << icon_info.bits_per_pixel);
1074 icon_info.offset_bits+=3*(one << icon_info.bits_per_pixel);
1075 icon_info.file_size+=(one << icon_info.bits_per_pixel);
1076 icon_info.offset_bits+=(one << icon_info.bits_per_pixel);
1079 bytes_per_line=(((next->columns*icon_info.bits_per_pixel)+31) &
1081 icon_info.ba_offset=0;
1082 icon_info.width=(ssize_t) next->columns;
1083 icon_info.height=(ssize_t) next->rows;
1085 icon_info.image_size=bytes_per_line*next->rows;
1087 icon_info.size+=(4*icon_info.number_colors);
1088 icon_info.size+=icon_info.image_size;
1089 icon_info.size+=(((icon_info.width+31) & ~31) >> 3)*icon_info.height;
1090 icon_info.file_size+=icon_info.image_size;
1091 icon_info.x_pixels=0;
1092 icon_info.y_pixels=0;
1093 switch (next->units)
1095 case UndefinedResolution:
1096 case PixelsPerInchResolution:
1098 icon_info.x_pixels=(size_t) (100.0*next->resolution.x/2.54);
1099 icon_info.y_pixels=(size_t) (100.0*next->resolution.y/2.54);
1102 case PixelsPerCentimeterResolution:
1104 icon_info.x_pixels=(size_t) (100.0*next->resolution.x);
1105 icon_info.y_pixels=(size_t) (100.0*next->resolution.y);
1109 icon_info.colors_important=icon_info.number_colors;
1111 Convert MIFF to ICON raster pixels.
1113 pixels=(unsigned char *) AcquireQuantumMemory((size_t)
1114 icon_info.image_size,sizeof(*pixels));
1115 if (pixels == (unsigned char *) NULL)
1117 images=DestroyImageList(images);
1118 ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
1120 (void) memset(pixels,0,(size_t) icon_info.image_size);
1121 switch (icon_info.bits_per_pixel)
1130 Convert PseudoClass image to a ICON monochrome image.
1132 for (y=0; y < (ssize_t) next->rows; y++)
1134 p=GetVirtualPixels(next,0,y,next->columns,1,exception);
1135 if (p == (const Quantum *) NULL)
1137 q=pixels+(next->rows-y-1)*bytes_per_line;
1140 for (x=0; x < (ssize_t) next->columns; x++)
1143 byte|=GetPixelIndex(next,p) != 0 ? 0x01 : 0x00;
1147 *q++=(unsigned char) byte;
1151 p+=GetPixelChannels(image);
1154 *q++=(unsigned char) (byte << (8-bit));
1155 if (next->previous == (Image *) NULL)
1157 status=SetImageProgress(next,SaveImageTag,y,next->rows);
1158 if (status == MagickFalse)
1171 Convert PseudoClass image to a ICON monochrome image.
1173 for (y=0; y < (ssize_t) next->rows; y++)
1175 p=GetVirtualPixels(next,0,y,next->columns,1,exception);
1176 if (p == (const Quantum *) NULL)
1178 q=pixels+(next->rows-y-1)*bytes_per_line;
1181 for (x=0; x < (ssize_t) next->columns; x++)
1184 byte|=((size_t) GetPixelIndex(next,p) & 0x0f);
1188 *q++=(unsigned char) byte;
1192 p+=GetPixelChannels(image);
1195 *q++=(unsigned char) (byte << 4);
1196 if (next->previous == (Image *) NULL)
1198 status=SetImageProgress(next,SaveImageTag,y,next->rows);
1199 if (status == MagickFalse)
1208 Convert PseudoClass packet to ICON pixel.
1210 for (y=0; y < (ssize_t) next->rows; y++)
1212 p=GetVirtualPixels(next,0,y,next->columns,1,exception);
1213 if (p == (const Quantum *) NULL)
1215 q=pixels+(next->rows-y-1)*bytes_per_line;
1216 for (x=0; x < (ssize_t) next->columns; x++)
1218 *q++=(unsigned char) GetPixelIndex(next,p);
1219 p+=GetPixelChannels(image);
1221 if (next->previous == (Image *) NULL)
1223 status=SetImageProgress(next,SaveImageTag,y,next->rows);
1224 if (status == MagickFalse)
1234 Convert DirectClass packet to ICON BGR888 or BGRA8888 pixel.
1236 for (y=0; y < (ssize_t) next->rows; y++)
1238 p=GetVirtualPixels(next,0,y,next->columns,1,exception);
1239 if (p == (const Quantum *) NULL)
1241 q=pixels+(next->rows-y-1)*bytes_per_line;
1242 for (x=0; x < (ssize_t) next->columns; x++)
1244 *q++=ScaleQuantumToChar(GetPixelBlue(next,p));
1245 *q++=ScaleQuantumToChar(GetPixelGreen(next,p));
1246 *q++=ScaleQuantumToChar(GetPixelRed(next,p));
1247 if (next->alpha_trait == UndefinedPixelTrait)
1248 *q++=ScaleQuantumToChar(QuantumRange);
1250 *q++=ScaleQuantumToChar(GetPixelAlpha(next,p));
1251 p+=GetPixelChannels(next);
1253 if (icon_info.bits_per_pixel == 24)
1254 for (x=3L*(ssize_t) next->columns; x < (ssize_t) bytes_per_line; x++)
1256 if (next->previous == (Image *) NULL)
1258 status=SetImageProgress(next,SaveImageTag,y,next->rows);
1259 if (status == MagickFalse)
1267 Write 40-byte version 3+ bitmap header.
1269 icon_file.directory[scene].width=(unsigned char) icon_info.width;
1270 icon_file.directory[scene].height=(unsigned char) icon_info.height;
1271 icon_file.directory[scene].colors=(unsigned char)
1272 icon_info.number_colors;
1273 icon_file.directory[scene].reserved=0;
1274 icon_file.directory[scene].planes=icon_info.planes;
1275 icon_file.directory[scene].bits_per_pixel=icon_info.bits_per_pixel;
1276 icon_file.directory[scene].size=icon_info.size;
1277 icon_file.directory[scene].offset=(size_t) TellBlob(image);
1278 (void) WriteBlobLSBLong(image,(unsigned int) 40);
1279 (void) WriteBlobLSBLong(image,(unsigned int) icon_info.width);
1280 (void) WriteBlobLSBLong(image,(unsigned int) icon_info.height*2);
1281 (void) WriteBlobLSBShort(image,icon_info.planes);
1282 (void) WriteBlobLSBShort(image,icon_info.bits_per_pixel);
1283 (void) WriteBlobLSBLong(image,(unsigned int) icon_info.compression);
1284 (void) WriteBlobLSBLong(image,(unsigned int) icon_info.image_size);
1285 (void) WriteBlobLSBLong(image,(unsigned int) icon_info.x_pixels);
1286 (void) WriteBlobLSBLong(image,(unsigned int) icon_info.y_pixels);
1287 (void) WriteBlobLSBLong(image,(unsigned int) icon_info.number_colors);
1288 (void) WriteBlobLSBLong(image,(unsigned int) icon_info.colors_important);
1289 if (next->storage_class == PseudoClass)
1295 Dump colormap to file.
1297 icon_colormap=(unsigned char *) AcquireQuantumMemory((size_t)
1298 (1UL << icon_info.bits_per_pixel),4UL*sizeof(*icon_colormap));
1299 if (icon_colormap == (unsigned char *) NULL)
1301 images=DestroyImageList(images);
1302 ThrowWriterException(ResourceLimitError,
1303 "MemoryAllocationFailed");
1306 for (i=0; i < (ssize_t) next->colors; i++)
1308 *q++=ScaleQuantumToChar(next->colormap[i].blue);
1309 *q++=ScaleQuantumToChar(next->colormap[i].green);
1310 *q++=ScaleQuantumToChar(next->colormap[i].red);
1311 *q++=(unsigned char) 0x0;
1313 for ( ; i < (ssize_t) (1UL << icon_info.bits_per_pixel); i++)
1315 *q++=(unsigned char) 0x00;
1316 *q++=(unsigned char) 0x00;
1317 *q++=(unsigned char) 0x00;
1318 *q++=(unsigned char) 0x00;
1320 (void) WriteBlob(image,(size_t) (4UL*(1UL <<
1321 icon_info.bits_per_pixel)),icon_colormap);
1322 icon_colormap=(unsigned char *) RelinquishMagickMemory(
1325 (void) WriteBlob(image,(size_t) icon_info.image_size,pixels);
1326 pixels=(unsigned char *) RelinquishMagickMemory(pixels);
1330 scanline_pad=(((next->columns+31) & ~31)-next->columns) >> 3;
1331 for (y=((ssize_t) next->rows - 1); y >= 0; y--)
1337 p=GetVirtualPixels(next,0,y,next->columns,1,exception);
1338 if (p == (const Quantum *) NULL)
1342 for (x=0; x < (ssize_t) next->columns; x++)
1345 if ((next->alpha_trait != UndefinedPixelTrait) &&
1346 (GetPixelAlpha(next,p) == (Quantum) TransparentAlpha))
1351 (void) WriteBlobByte(image,(unsigned char) byte);
1355 p+=GetPixelChannels(next);
1358 (void) WriteBlobByte(image,(unsigned char) (byte << (8-bit)));
1359 for (i=0; i < (ssize_t) scanline_pad; i++)
1360 (void) WriteBlobByte(image,(unsigned char) 0);
1363 if (GetNextImageInList(next) == (Image *) NULL)
1365 status=SetImageProgress(next,SaveImagesTag,scene++,imageListLength);
1366 if (status == MagickFalse)
1368 next=SyncNextImageInList(next);
1369 } while ((next != (Image *) NULL) && (image_info->adjoin != MagickFalse));
1370 offset=SeekBlob(image,0,SEEK_SET);
1372 (void) WriteBlobLSBShort(image,0);
1373 (void) WriteBlobLSBShort(image,1);
1374 (void) WriteBlobLSBShort(image,(unsigned short) (scene+1));
1376 next=(images != (Image *) NULL) ? images : image;
1379 (void) WriteBlobByte(image,icon_file.directory[scene].width);
1380 (void) WriteBlobByte(image,icon_file.directory[scene].height);
1381 (void) WriteBlobByte(image,icon_file.directory[scene].colors);
1382 (void) WriteBlobByte(image,icon_file.directory[scene].reserved);
1383 (void) WriteBlobLSBShort(image,icon_file.directory[scene].planes);
1384 (void) WriteBlobLSBShort(image,icon_file.directory[scene].bits_per_pixel);
1385 (void) WriteBlobLSBLong(image,(unsigned int)
1386 icon_file.directory[scene].size);
1387 (void) WriteBlobLSBLong(image,(unsigned int)
1388 icon_file.directory[scene].offset);
1390 next=SyncNextImageInList(next);
1391 } while ((next != (Image *) NULL) && (image_info->adjoin != MagickFalse));
1392 (void) CloseBlob(image);
1393 images=DestroyImageList(images);