]> granicus.if.org Git - imagemagick/blob - coders/pdb.c
977f1077f7daee2b63748fac96299da16e88de80
[imagemagick] / coders / pdb.c
1 /*
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %                                                                             %
4 %                                                                             %
5 %                                                                             %
6 %                            PPPP   DDDD   BBBB                               %
7 %                            P   P  D   D  B   B                              %
8 %                            PPPP   D   D  BBBB                               %
9 %                            P      D   D  B   B                              %
10 %                            P      DDDD   BBBB                               %
11 %                                                                             %
12 %                                                                             %
13 %               Read/Write Palm Database ImageViewer Image Format             %
14 %                                                                             %
15 %                              Software Design                                %
16 %                                   Cristy                                    %
17 %                                 July 1992                                   %
18 %                                                                             %
19 %                                                                             %
20 %  Copyright 1999-2018 ImageMagick Studio LLC, a non-profit organization      %
21 %  dedicated to making software imaging solutions freely available.           %
22 %                                                                             %
23 %  You may not use this file except in compliance with the License.  You may  %
24 %  obtain a copy of the License at                                            %
25 %                                                                             %
26 %    https://www.imagemagick.org/script/license.php                           %
27 %                                                                             %
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.                                             %
33 %                                                                             %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
35 %
36 %
37 %   20071202 TS * rewrote RLE decoder - old version could cause buffer overflows
38 %               * failure of RLE decoding now thows error RLEDecoderError
39 %               * fixed bug in RLE decoding - now all rows are decoded, not just
40 %     the first one
41 %   * fixed bug in reader - record offsets now handled correctly
42 %   * fixed bug in reader - only bits 0..2 indicate compression type
43 %               * in writer: now using image color count instead of depth
44 */
45 \f
46 /*
47   Include declarations.
48 */
49 #include "MagickCore/studio.h"
50 #include "MagickCore/attribute.h"
51 #include "MagickCore/blob.h"
52 #include "MagickCore/blob-private.h"
53 #include "MagickCore/cache.h"
54 #include "MagickCore/colormap-private.h"
55 #include "MagickCore/color-private.h"
56 #include "MagickCore/colormap.h"
57 #include "MagickCore/colorspace.h"
58 #include "MagickCore/colorspace-private.h"
59 #include "MagickCore/constitute.h"
60 #include "MagickCore/exception.h"
61 #include "MagickCore/exception-private.h"
62 #include "MagickCore/image.h"
63 #include "MagickCore/image-private.h"
64 #include "MagickCore/list.h"
65 #include "MagickCore/magick.h"
66 #include "MagickCore/memory_.h"
67 #include "MagickCore/monitor.h"
68 #include "MagickCore/monitor-private.h"
69 #include "MagickCore/pixel-accessor.h"
70 #include "MagickCore/property.h"
71 #include "MagickCore/quantum-private.h"
72 #include "MagickCore/quantum-private.h"
73 #include "MagickCore/static.h"
74 #include "MagickCore/string_.h"
75 #include "MagickCore/module.h"
76 \f
77 /*
78   Typedef declarations.
79 */
80 typedef struct _PDBInfo
81 {
82   char
83     name[32];
84
85   short int
86     attributes,
87     version;
88
89   size_t
90     create_time,
91     modify_time,
92     archive_time,
93     modify_number,
94     application_info,
95     sort_info;
96
97   char
98     type[4],  /* database type identifier "vIMG" */
99     id[4];    /* database creator identifier "View" */
100
101   size_t
102     seed,
103     next_record;
104
105   short int
106     number_records;
107 } PDBInfo;
108
109 typedef struct _PDBImage
110 {
111   char
112     name[32],
113     version;
114
115   size_t
116     reserved_1,
117     note;
118
119   short int
120     x_last,
121     y_last;
122
123   size_t
124     reserved_2;
125
126   short int
127     width,
128     height;
129
130   unsigned char
131     type;
132
133   unsigned short
134     x_anchor,
135     y_anchor;
136 } PDBImage;
137 /*
138   Forward declarations.
139 */
140 static MagickBooleanType
141   WritePDBImage(const ImageInfo *,Image *,ExceptionInfo *);
142 \f
143 /*
144 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
145 %                                                                             %
146 %                                                                             %
147 %                                                                             %
148 %   D e c o d e I m a g e                                                     %
149 %                                                                             %
150 %                                                                             %
151 %                                                                             %
152 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
153 %
154 %  DecodeImage unpacks the packed image pixels into runlength-encoded
155 %  pixel packets.
156 %
157 %  The format of the DecodeImage method is:
158 %
159 %      MagickBooleanType DecodeImage(Image *image,unsigned char *pixels,
160 %        const size_t length)
161 %
162 %  A description of each parameter follows:
163 %
164 %    o image: the address of a structure of type Image.
165 %
166 %    o pixels:  The address of a byte (8 bits) array of pixel data created by
167 %      the decoding process.
168 %
169 %    o length:  Number of bytes to read into buffer 'pixels'.
170 %
171 */
172 static MagickBooleanType DecodeImage(Image *image, unsigned char *pixels,
173   const size_t length)
174 {
175 #define RLE_MODE_NONE -1
176 #define RLE_MODE_COPY  0
177 #define RLE_MODE_RUN   1
178
179   int           data = 0, count = 0;
180   unsigned char *p;
181   int           mode = RLE_MODE_NONE;
182
183   for (p = pixels; p < pixels + length; p++) {
184     if (0 == count) {
185       data = ReadBlobByte( image );
186       if (-1 == data) return MagickFalse;
187       if (data > 128) {
188         mode  = RLE_MODE_RUN;
189         count = data - 128 + 1;
190         data  = ReadBlobByte( image );
191         if (-1 == data) return MagickFalse;
192       } else {
193         mode  = RLE_MODE_COPY;
194         count = data + 1;
195       }
196     }
197
198     if (RLE_MODE_COPY == mode) {
199       data = ReadBlobByte( image );
200       if (-1 == data) return MagickFalse;
201     }
202     *p = (unsigned char)data;
203     --count;
204   }
205   return MagickTrue;
206 }
207 \f
208 /*
209 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
210 %                                                                             %
211 %                                                                             %
212 %                                                                             %
213 %   I s P D B                                                                 %
214 %                                                                             %
215 %                                                                             %
216 %                                                                             %
217 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
218 %
219 %  IsPDB() returns MagickTrue if the image format type, identified by the
220 %  magick string, is PDB.
221 %
222 %  The format of the ReadPDBImage method is:
223 %
224 %      MagickBooleanType IsPDB(const unsigned char *magick,const size_t length)
225 %
226 %  A description of each parameter follows:
227 %
228 %    o magick: compare image format pattern against these bytes.
229 %
230 %    o length: Specifies the length of the magick string.
231 %
232 */
233 static MagickBooleanType IsPDB(const unsigned char *magick,const size_t length)
234 {
235   if (length < 68)
236     return(MagickFalse);
237   if (memcmp(magick+60,"vIMGView",8) == 0)
238     return(MagickTrue);
239   return(MagickFalse);
240 }
241 \f
242 /*
243 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
244 %                                                                             %
245 %                                                                             %
246 %                                                                             %
247 %   R e a d P D B I m a g e                                                   %
248 %                                                                             %
249 %                                                                             %
250 %                                                                             %
251 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
252 %
253 %  ReadPDBImage() reads an Pilot image file and returns it.  It
254 %  allocates the memory necessary for the new Image structure and returns a
255 %  pointer to the new image.
256 %
257 %  The format of the ReadPDBImage method is:
258 %
259 %      Image *ReadPDBImage(const ImageInfo *image_info,ExceptionInfo *exception)
260 %
261 %  A description of each parameter follows:
262 %
263 %    o image_info: the image info.
264 %
265 %    o exception: return any errors or warnings in this structure.
266 %
267 */
268 static Image *ReadPDBImage(const ImageInfo *image_info,ExceptionInfo *exception)
269 {
270   unsigned char
271     attributes,
272     tag[3];
273
274   Image
275     *image;
276
277   MagickBooleanType
278     status;
279
280   PDBImage
281     pdb_image;
282
283   PDBInfo
284     pdb_info;
285
286   Quantum
287     index;
288
289   register ssize_t
290     x;
291
292   register Quantum
293     *q;
294
295   register unsigned char
296     *p;
297
298   size_t
299     bits_per_pixel,
300     num_pad_bytes,
301     one,
302     packets;
303
304   ssize_t
305     count,
306     img_offset,
307     comment_offset = 0,
308     y;
309
310   unsigned char
311     *pixels;
312
313   /*
314     Open image file.
315   */
316   assert(image_info != (const ImageInfo *) NULL);
317   assert(image_info->signature == MagickCoreSignature);
318   if (image_info->debug != MagickFalse)
319     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
320       image_info->filename);
321   assert(exception != (ExceptionInfo *) NULL);
322   assert(exception->signature == MagickCoreSignature);
323   image=AcquireImage(image_info,exception);
324   status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
325   if (status == MagickFalse)
326     {
327       image=DestroyImageList(image);
328       return((Image *) NULL);
329     }
330   /*
331     Determine if this a PDB image file.
332   */
333   (void) ResetMagickMemory(&pdb_info,0,sizeof(pdb_info));
334   count=ReadBlob(image,sizeof(pdb_info.name),(unsigned char *) pdb_info.name);
335   if (count != sizeof(pdb_info.name))
336     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
337   pdb_info.attributes=(short) ReadBlobMSBShort(image);
338   pdb_info.version=(short) ReadBlobMSBShort(image);
339   pdb_info.create_time=ReadBlobMSBLong(image);
340   pdb_info.modify_time=ReadBlobMSBLong(image);
341   pdb_info.archive_time=ReadBlobMSBLong(image);
342   pdb_info.modify_number=ReadBlobMSBLong(image);
343   pdb_info.application_info=ReadBlobMSBLong(image);
344   pdb_info.sort_info=ReadBlobMSBLong(image);
345   (void) ReadBlob(image,4,(unsigned char *) pdb_info.type);
346   (void) ReadBlob(image,4,(unsigned char *) pdb_info.id);
347   pdb_info.seed=ReadBlobMSBLong(image);
348   pdb_info.next_record=ReadBlobMSBLong(image);
349   pdb_info.number_records=(short) ReadBlobMSBShort(image);
350   if ((memcmp(pdb_info.type,"vIMG",4) != 0) ||
351       (memcmp(pdb_info.id,"View",4) != 0))
352     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
353   if (pdb_info.next_record != 0)
354     ThrowReaderException(CoderError,"MultipleRecordListNotSupported");
355   /*
356     Read record header.
357   */
358   img_offset=(ssize_t) ReadBlobMSBSignedLong(image);
359   attributes=(unsigned char) ReadBlobByte(image);
360   (void) attributes;
361   count=ReadBlob(image,3,(unsigned char *) tag);
362   if (count != 3  ||  memcmp(tag,"\x6f\x80\x00",3) != 0)
363     ThrowReaderException(CorruptImageError,"CorruptImage");
364   if (pdb_info.number_records > 1)
365     {
366       comment_offset=(ssize_t) ReadBlobMSBSignedLong(image);
367       attributes=(unsigned char) ReadBlobByte(image);
368       count=ReadBlob(image,3,(unsigned char *) tag);
369       if (count != 3  ||  memcmp(tag,"\x6f\x80\x01",3) != 0)
370         ThrowReaderException(CorruptImageError,"CorruptImage");
371     }
372   num_pad_bytes = (size_t) (img_offset - TellBlob( image ));
373   while (num_pad_bytes-- != 0)
374   {
375     int
376       c;
377
378     c=ReadBlobByte(image);
379     if (c == EOF)
380       break;
381   }
382   /*
383     Read image header.
384   */
385   count=ReadBlob(image,sizeof(pdb_image.name),(unsigned char *) pdb_image.name);
386   if (count != sizeof(pdb_image.name))
387     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
388   pdb_image.version=ReadBlobByte(image);
389   pdb_image.type=(unsigned char) (ReadBlobByte(image));
390   pdb_image.reserved_1=ReadBlobMSBLong(image);
391   pdb_image.note=ReadBlobMSBLong(image);
392   pdb_image.x_last=(short) ReadBlobMSBShort(image);
393   pdb_image.y_last=(short) ReadBlobMSBShort(image);
394   pdb_image.reserved_2=ReadBlobMSBLong(image);
395   pdb_image.x_anchor=ReadBlobMSBShort(image);
396   pdb_image.y_anchor=ReadBlobMSBShort(image);
397   pdb_image.width=(short) ReadBlobMSBShort(image);
398   pdb_image.height=(short) ReadBlobMSBShort(image);
399   /*
400     Initialize image structure.
401   */
402   image->columns=(size_t) pdb_image.width;
403   image->rows=(size_t) pdb_image.height;
404   image->depth=8;
405   image->storage_class=PseudoClass;
406   bits_per_pixel=pdb_image.type == 0 ? 2UL : pdb_image.type == 2 ? 4UL : 1UL;
407   one=1;
408   if (AcquireImageColormap(image,one << bits_per_pixel,exception) == MagickFalse)
409     ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
410   if (image_info->ping != MagickFalse)
411     {
412       (void) CloseBlob(image);
413       return(GetFirstImageInList(image));
414     }
415   status=SetImageExtent(image,image->columns,image->rows,exception);
416   if (status == MagickFalse)
417     return(DestroyImageList(image));
418   packets=(bits_per_pixel*image->columns+7)/8;
419   pixels=(unsigned char *) AcquireQuantumMemory(packets+257UL,image->rows*
420     sizeof(*pixels));
421   if (pixels == (unsigned char *) NULL)
422     ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
423   (void) ResetMagickMemory(pixels,0,(packets+257UL)*image->rows*sizeof(*pixels));
424   switch (pdb_image.version & 0x07) 
425   {
426     case 0:
427     {
428       image->compression=NoCompression;
429       count=(ssize_t) ReadBlob(image,packets*image->rows,pixels);
430       break;
431     }
432     case 1:
433     {
434       image->compression=RLECompression;
435       if (!DecodeImage(image,pixels,packets*image->rows))
436         {
437           pixels=(unsigned char *) RelinquishMagickMemory(pixels);
438           ThrowReaderException(CorruptImageError,"RLEDecoderError");
439         }
440       break;
441     }
442     default:
443     {
444       pixels=(unsigned char *) RelinquishMagickMemory(pixels);
445       ThrowReaderException(CorruptImageError,
446         "UnrecognizedImageCompressionType");
447     }
448   }
449   p=pixels;
450   switch (bits_per_pixel)
451   {
452     case 1:
453     {
454       int
455         bit;
456
457       /*
458         Read 1-bit PDB image.
459       */
460       for (y=0; y < (ssize_t) image->rows; y++)
461       {
462         q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
463         if (q == (Quantum *) NULL)
464           break;
465         for (x=0; x < ((ssize_t) image->columns-7); x+=8)
466         {
467           for (bit=0; bit < 8; bit++)
468           {
469             index=(Quantum) (*p & (0x80 >> bit) ? 0x00 : 0x01);
470             SetPixelIndex(image,index,q);
471             q+=GetPixelChannels(image);
472           }
473           p++;
474         }
475         if (SyncAuthenticPixels(image,exception) == MagickFalse)
476           break;
477         status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
478           image->rows);
479         if (status == MagickFalse)
480           break;
481       }
482       (void) SyncImage(image,exception);
483       break;
484     }
485     case 2:
486     {
487       /*
488         Read 2-bit PDB image.
489       */
490       for (y=0; y < (ssize_t) image->rows; y++)
491       {
492         q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
493         if (q == (Quantum *) NULL)
494           break;
495         for (x=0; x < (ssize_t) image->columns-3; x+=4)
496         {
497           index=ConstrainColormapIndex(image,3UL-((*p >> 6) & 0x03),exception);
498           SetPixelIndex(image,index,q);
499           q+=GetPixelChannels(image);
500           index=ConstrainColormapIndex(image,3UL-((*p >> 4) & 0x03),exception);
501           SetPixelIndex(image,index,q);
502           q+=GetPixelChannels(image);
503           index=ConstrainColormapIndex(image,3UL-((*p >> 2) & 0x03),exception);
504           SetPixelIndex(image,index,q);
505           q+=GetPixelChannels(image);
506           index=ConstrainColormapIndex(image,3UL-((*p) & 0x03),exception);
507           SetPixelIndex(image,index,q);
508           p++;
509           q+=GetPixelChannels(image);
510         }
511         if (SyncAuthenticPixels(image,exception) == MagickFalse)
512           break;
513         status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
514           image->rows);
515         if (status == MagickFalse)
516           break;
517       }
518       (void) SyncImage(image,exception);
519       break;
520     }
521     case 4:
522     {
523       /*
524         Read 4-bit PDB image.
525       */
526       for (y=0; y < (ssize_t) image->rows; y++)
527       {
528         q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
529         if (q == (Quantum *) NULL)
530           break;
531         for (x=0; x < (ssize_t) image->columns-1; x+=2)
532         {
533           index=ConstrainColormapIndex(image,15UL-((*p >> 4) & 0x0f),exception);
534           SetPixelIndex(image,index,q);
535           q+=GetPixelChannels(image);
536           index=ConstrainColormapIndex(image,15UL-((*p) & 0x0f),exception);
537           SetPixelIndex(image,index,q);
538           p++;
539           q+=GetPixelChannels(image);
540         }
541         if (SyncAuthenticPixels(image,exception) == MagickFalse)
542           break;
543         status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
544           image->rows);
545         if (status == MagickFalse)
546           break;
547       }
548       (void) SyncImage(image,exception);
549       break;
550     }
551     default:
552     {
553       pixels=(unsigned char *) RelinquishMagickMemory(pixels);
554       ThrowReaderException(CorruptImageError,"ImproperImageHeader");
555     }
556   }
557   pixels=(unsigned char *) RelinquishMagickMemory(pixels);
558   if (EOFBlob(image) != MagickFalse)
559     ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
560       image->filename);
561   if (pdb_info.number_records > 1)
562     {
563       char
564         *comment;
565
566       int
567         c;
568
569       register char
570         *p;
571
572       size_t
573         length;
574
575       num_pad_bytes = (size_t) (comment_offset - TellBlob( image ));
576       while (num_pad_bytes-- != 0)
577       {
578         int
579           c;
580
581         c=ReadBlobByte(image);
582         if (c == EOF)
583           break;
584       }
585
586       /*
587         Read comment.
588       */
589       c=ReadBlobByte(image);
590       length=MagickPathExtent;
591       comment=AcquireString((char *) NULL);
592       for (p=comment; c != EOF; p++)
593       {
594         if ((size_t) (p-comment+MagickPathExtent) >= length)
595           {
596             *p='\0';
597             length<<=1;
598             length+=MagickPathExtent;
599             comment=(char *) ResizeQuantumMemory(comment,length+
600               MagickPathExtent,sizeof(*comment));
601             if (comment == (char *) NULL)
602               break;
603             p=comment+strlen(comment);
604           }
605         *p=c;
606         c=ReadBlobByte(image);
607       }
608       *p='\0';
609       if (comment == (char *) NULL)
610         ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
611       (void) SetImageProperty(image,"comment",comment,exception);
612       comment=DestroyString(comment);
613     }
614   (void) CloseBlob(image);
615   return(GetFirstImageInList(image));
616 }
617 \f
618 /*
619 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
620 %                                                                             %
621 %                                                                             %
622 %                                                                             %
623 %   R e g i s t e r P D B I m a g e                                           %
624 %                                                                             %
625 %                                                                             %
626 %                                                                             %
627 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
628 %
629 %  RegisterPDBImage() adds properties for the PDB image format to
630 %  the list of supported formats.  The properties include the image format
631 %  tag, a method to read and/or write the format, whether the format
632 %  supports the saving of more than one frame to the same file or blob,
633 %  whether the format supports native in-memory I/O, and a brief
634 %  description of the format.
635 %
636 %  The format of the RegisterPDBImage method is:
637 %
638 %      size_t RegisterPDBImage(void)
639 %
640 */
641 ModuleExport size_t RegisterPDBImage(void)
642 {
643   MagickInfo
644     *entry;
645
646   entry=AcquireMagickInfo("PDB","PDB","Palm Database ImageViewer Format");
647   entry->decoder=(DecodeImageHandler *) ReadPDBImage;
648   entry->encoder=(EncodeImageHandler *) WritePDBImage;
649   entry->magick=(IsImageFormatHandler *) IsPDB;
650   (void) RegisterMagickInfo(entry);
651   return(MagickImageCoderSignature);
652 }
653 \f
654 /*
655 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
656 %                                                                             %
657 %                                                                             %
658 %                                                                             %
659 %   U n r e g i s t e r P D B I m a g e                                       %
660 %                                                                             %
661 %                                                                             %
662 %                                                                             %
663 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
664 %
665 %  UnregisterPDBImage() removes format registrations made by the
666 %  PDB module from the list of supported formats.
667 %
668 %  The format of the UnregisterPDBImage method is:
669 %
670 %      UnregisterPDBImage(void)
671 %
672 */
673 ModuleExport void UnregisterPDBImage(void)
674 {
675   (void) UnregisterMagickInfo("PDB");
676 }
677 \f
678 /*
679 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
680 %                                                                             %
681 %                                                                             %
682 %                                                                             %
683 %   W r i t e P D B I m a g e                                                 %
684 %                                                                             %
685 %                                                                             %
686 %                                                                             %
687 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
688 %
689 %  WritePDBImage() writes an image
690 %
691 %  The format of the WritePDBImage method is:
692 %
693 %      MagickBooleanType WritePDBImage(const ImageInfo *image_info,
694 %        Image *image,ExceptionInfo *exception)
695 %
696 %  A description of each parameter follows.
697 %
698 %    o image_info: the image info.
699 %
700 %    o image:  The image.
701 %
702 %    o exception: return any errors or warnings in this structure.
703 %
704 */
705
706 static unsigned char *EncodeRLE(unsigned char *destination,
707   unsigned char *source,size_t literal,size_t repeat)
708 {
709   if (literal > 0)
710     *destination++=(unsigned char) (literal-1);
711   (void) CopyMagickMemory(destination,source,literal);
712   destination+=literal;
713   if (repeat > 0)
714     {
715       *destination++=(unsigned char) (0x80 | (repeat-1));
716       *destination++=source[literal];
717     }
718   return(destination);
719 }
720
721 static MagickBooleanType WritePDBImage(const ImageInfo *image_info,Image *image,
722   ExceptionInfo *exception)
723 {
724   const char
725     *comment;
726
727   int
728     bits;
729
730   MagickBooleanType
731     status;
732
733   PDBImage
734     pdb_image;
735
736   PDBInfo
737     pdb_info;
738
739   QuantumInfo
740     *quantum_info;
741
742   register const Quantum
743     *p;
744
745   register ssize_t
746     x;
747
748   register unsigned char
749     *q;
750
751   size_t
752     bits_per_pixel,
753     literal,
754     packets,
755     packet_size,
756     repeat;
757
758   ssize_t
759     y;
760
761   unsigned char
762     *buffer,
763     *runlength,
764     *scanline;
765
766   /*
767     Open output image file.
768   */
769   assert(image_info != (const ImageInfo *) NULL);
770   assert(image_info->signature == MagickCoreSignature);
771   assert(image != (Image *) NULL);
772   assert(image->signature == MagickCoreSignature);
773   if (image->debug != MagickFalse)
774     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
775   assert(exception != (ExceptionInfo *) NULL);
776   assert(exception->signature == MagickCoreSignature);
777   status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
778   if (status == MagickFalse)
779     return(status);
780   (void) TransformImageColorspace(image,sRGBColorspace,exception);
781   if (SetImageMonochrome(image,exception) != MagickFalse) {
782     bits_per_pixel=1;
783   } else if (image->colors <= 4) {
784     bits_per_pixel=2;
785   } else if (image->colors <= 8) {
786     bits_per_pixel=3;
787   } else {
788     bits_per_pixel=4;
789   }
790   (void) ResetMagickMemory(&pdb_info,0,sizeof(pdb_info));
791   (void) CopyMagickString(pdb_info.name,image_info->filename,
792     sizeof(pdb_info.name));
793   pdb_info.attributes=0;
794   pdb_info.version=0;
795   pdb_info.create_time=time(NULL);
796   pdb_info.modify_time=pdb_info.create_time;
797   pdb_info.archive_time=0;
798   pdb_info.modify_number=0;
799   pdb_info.application_info=0;
800   pdb_info.sort_info=0;
801   (void) CopyMagickMemory(pdb_info.type,"vIMG",4);
802   (void) CopyMagickMemory(pdb_info.id,"View",4);
803   pdb_info.seed=0;
804   pdb_info.next_record=0;
805   comment=GetImageProperty(image,"comment",exception);
806   pdb_info.number_records=(comment == (const char *) NULL ? 1 : 2);
807   (void) WriteBlob(image,sizeof(pdb_info.name),(unsigned char *) pdb_info.name);
808   (void) WriteBlobMSBShort(image,(unsigned short) pdb_info.attributes);
809   (void) WriteBlobMSBShort(image,(unsigned short) pdb_info.version);
810   (void) WriteBlobMSBLong(image,(unsigned int) pdb_info.create_time);
811   (void) WriteBlobMSBLong(image,(unsigned int) pdb_info.modify_time);
812   (void) WriteBlobMSBLong(image,(unsigned int) pdb_info.archive_time);
813   (void) WriteBlobMSBLong(image,(unsigned int) pdb_info.modify_number);
814   (void) WriteBlobMSBLong(image,(unsigned int) pdb_info.application_info);
815   (void) WriteBlobMSBLong(image,(unsigned int) pdb_info.sort_info);
816   (void) WriteBlob(image,4,(unsigned char *) pdb_info.type);
817   (void) WriteBlob(image,4,(unsigned char *) pdb_info.id);
818   (void) WriteBlobMSBLong(image,(unsigned int) pdb_info.seed);
819   (void) WriteBlobMSBLong(image,(unsigned int) pdb_info.next_record);
820   (void) WriteBlobMSBShort(image,(unsigned short) pdb_info.number_records);
821   (void) CopyMagickString(pdb_image.name,pdb_info.name,sizeof(pdb_image.name));
822   pdb_image.version=1;  /* RLE Compressed */
823   switch (bits_per_pixel)
824   {
825     case 1: pdb_image.type=(unsigned char) 0xff; break;  /* monochrome */
826     case 2: pdb_image.type=(unsigned char) 0x00; break;  /* 2 bit gray */
827     default: pdb_image.type=(unsigned char) 0x02;  /* 4 bit gray */
828   }
829   pdb_image.reserved_1=0;
830   pdb_image.note=0;
831   pdb_image.x_last=0;
832   pdb_image.y_last=0;
833   pdb_image.reserved_2=0;
834   pdb_image.x_anchor=(unsigned short) 0xffff;
835   pdb_image.y_anchor=(unsigned short) 0xffff;
836   pdb_image.width=(short) image->columns;
837   if (image->columns % 16)
838     pdb_image.width=(short) (16*(image->columns/16+1));
839   pdb_image.height=(short) image->rows;
840   packets=((bits_per_pixel*image->columns+7)/8);
841   packet_size=(size_t) (image->depth > 8 ? 2 : 1);
842   runlength=(unsigned char *) AcquireQuantumMemory(9UL*packets,
843     image->rows*sizeof(*runlength));
844   buffer=(unsigned char *) AcquireQuantumMemory(512,sizeof(*buffer));
845   scanline=(unsigned char *) AcquireQuantumMemory(image->columns,packet_size*
846     sizeof(*scanline));
847   if ((runlength == (unsigned char *) NULL) ||
848       (buffer == (unsigned char *) NULL) ||
849       (scanline == (unsigned char *) NULL))
850     {
851       if (runlength != (unsigned char *) NULL)
852         runlength=(unsigned char *) RelinquishMagickMemory(runlength);
853       if (buffer != (unsigned char *) NULL)
854         buffer=(unsigned char *) RelinquishMagickMemory(buffer);
855       if (scanline != (unsigned char *) NULL)
856         scanline=(unsigned char *) RelinquishMagickMemory(scanline);
857       ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
858     }
859   if (IssRGBCompatibleColorspace(image->colorspace) == MagickFalse)
860     (void) TransformImageColorspace(image,sRGBColorspace,exception);
861   /*
862     Convert to GRAY raster scanline.
863   */
864   quantum_info=AcquireQuantumInfo(image_info,image);
865   if (quantum_info == (QuantumInfo *) NULL)
866     ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
867   status=SetQuantumDepth(image,quantum_info,image->depth > 8 ? 16 : 8);
868   bits=8/(int) bits_per_pixel-1;  /* start at most significant bits */
869   literal=0;
870   repeat=0;
871   q=runlength;
872   buffer[0]=0x00;
873   for (y=0; y < (ssize_t) image->rows; y++)
874   {
875     p=GetVirtualPixels(image,0,y,image->columns,1,exception);
876     if (p == (const Quantum *) NULL)
877       break;
878     (void) ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
879       GrayQuantum,scanline,exception);
880     for (x=0; x < (ssize_t) pdb_image.width; x++)
881     {
882       if (x < (ssize_t) image->columns)
883         buffer[literal+repeat]|=(0xff-scanline[x*packet_size]) >>
884           (8-bits_per_pixel) << bits*bits_per_pixel;
885       bits--;
886       if (bits < 0)
887         {
888           if (((literal+repeat) > 0) &&
889               (buffer[literal+repeat] == buffer[literal+repeat-1]))
890             {
891               if (repeat == 0)
892                 {
893                   literal--;
894                   repeat++;
895                 }
896               repeat++;
897               if (0x7f < repeat)
898                 {
899                   q=EncodeRLE(q,buffer,literal,repeat);
900                   literal=0;
901                   repeat=0;
902                 }
903             }
904           else
905             {
906               if (repeat >= 2)
907                 literal+=repeat;
908               else
909                 {
910                   q=EncodeRLE(q,buffer,literal,repeat);
911                   buffer[0]=buffer[literal+repeat];
912                   literal=0;
913                 }
914               literal++;
915               repeat=0;
916               if (0x7f < literal)
917                 {
918                   q=EncodeRLE(q,buffer,(literal < 0x80 ? literal : 0x80),0);
919                   (void) CopyMagickMemory(buffer,buffer+literal+repeat,0x80);
920                   literal-=0x80;
921                 }
922             }
923         bits=8/(int) bits_per_pixel-1;
924         buffer[literal+repeat]=0x00;
925       }
926     }
927     status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
928       image->rows);
929     if (status == MagickFalse)
930       break;
931   }
932   q=EncodeRLE(q,buffer,literal,repeat);
933   scanline=(unsigned char *) RelinquishMagickMemory(scanline);
934   buffer=(unsigned char *) RelinquishMagickMemory(buffer);
935   quantum_info=DestroyQuantumInfo(quantum_info);
936   /*
937     Write the Image record header.
938   */
939   (void) WriteBlobMSBLong(image,(unsigned int)
940     (TellBlob(image)+8*pdb_info.number_records));
941   (void) WriteBlobByte(image,0x40);
942   (void) WriteBlobByte(image,0x6f);
943   (void) WriteBlobByte(image,0x80);
944   (void) WriteBlobByte(image,0);
945   if (pdb_info.number_records > 1)
946     {
947       /*
948         Write the comment record header.
949       */
950       (void) WriteBlobMSBLong(image,(unsigned int) (TellBlob(image)+8+58+q-
951         runlength));
952       (void) WriteBlobByte(image,0x40);
953       (void) WriteBlobByte(image,0x6f);
954       (void) WriteBlobByte(image,0x80);
955       (void) WriteBlobByte(image,1);
956     }
957   /*
958     Write the Image data.
959   */
960   (void) WriteBlob(image,sizeof(pdb_image.name),(unsigned char *)
961     pdb_image.name);
962   (void) WriteBlobByte(image,(unsigned char) pdb_image.version);
963   (void) WriteBlobByte(image,pdb_image.type);
964   (void) WriteBlobMSBLong(image,(unsigned int) pdb_image.reserved_1);
965   (void) WriteBlobMSBLong(image,(unsigned int) pdb_image.note);
966   (void) WriteBlobMSBShort(image,(unsigned short) pdb_image.x_last);
967   (void) WriteBlobMSBShort(image,(unsigned short) pdb_image.y_last);
968   (void) WriteBlobMSBLong(image,(unsigned int) pdb_image.reserved_2);
969   (void) WriteBlobMSBShort(image,pdb_image.x_anchor);
970   (void) WriteBlobMSBShort(image,pdb_image.y_anchor);
971   (void) WriteBlobMSBShort(image,(unsigned short) pdb_image.width);
972   (void) WriteBlobMSBShort(image,(unsigned short) pdb_image.height);
973   (void) WriteBlob(image,(size_t) (q-runlength),runlength);
974   runlength=(unsigned char *) RelinquishMagickMemory(runlength);
975   if (pdb_info.number_records > 1)
976     (void) WriteBlobString(image,comment);
977   (void) CloseBlob(image);
978   return(MagickTrue);
979 }