2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % Read/Write X Windows System Bitmap Format %
20 % Copyright 1999-2011 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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "MagickCore/studio.h"
43 #include "MagickCore/blob.h"
44 #include "MagickCore/blob-private.h"
45 #include "MagickCore/cache.h"
46 #include "MagickCore/color-private.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/magick.h"
56 #include "MagickCore/memory_.h"
57 #include "MagickCore/monitor.h"
58 #include "MagickCore/monitor-private.h"
59 #include "MagickCore/pixel-accessor.h"
60 #include "MagickCore/quantum-private.h"
61 #include "MagickCore/static.h"
62 #include "MagickCore/string_.h"
63 #include "MagickCore/module.h"
64 #include "MagickCore/utility.h"
69 static MagickBooleanType
70 WriteXBMImage(const ImageInfo *,Image *,ExceptionInfo *);
73 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
81 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
83 % IsXBM() returns MagickTrue if the image format type, identified by the
84 % magick string, is XBM.
86 % The format of the IsXBM method is:
88 % MagickBooleanType IsXBM(const unsigned char *magick,const size_t length)
90 % A description of each parameter follows:
92 % o magick: compare image format pattern against these bytes.
94 % o length: Specifies the length of the magick string.
97 static MagickBooleanType IsXBM(const unsigned char *magick,const size_t length)
101 if (memcmp(magick,"#define",7) == 0)
107 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
111 % R e a d X B M I m a g e %
115 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
117 % ReadXBMImage() reads an X11 bitmap image file and returns it. It
118 % allocates the memory necessary for the new Image structure and returns a
119 % pointer to the new image.
121 % The format of the ReadXBMImage method is:
123 % Image *ReadXBMImage(const ImageInfo *image_info,ExceptionInfo *exception)
125 % A description of each parameter follows:
127 % o image_info: the image info.
129 % o exception: return any errors or warnings in this structure.
133 static int XBMInteger(Image *image,short int *hex_digits)
144 c=ReadBlobByte(image);
151 if (isxdigit(c) != MagickFalse)
153 value=(int) ((size_t) value << 4)+hex_digits[c];
157 if ((hex_digits[c]) < 0 && (flag != 0))
163 static Image *ReadXBMImage(const ImageInfo *image_info,ExceptionInfo *exception)
166 buffer[MaxTextExtent],
182 register unsigned char
210 assert(image_info != (const ImageInfo *) NULL);
211 assert(image_info->signature == MagickSignature);
212 if (image_info->debug != MagickFalse)
213 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
214 image_info->filename);
215 assert(exception != (ExceptionInfo *) NULL);
216 assert(exception->signature == MagickSignature);
217 image=AcquireImage(image_info,exception);
218 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
219 if (status == MagickFalse)
221 image=DestroyImageList(image);
222 return((Image *) NULL);
225 Read X bitmap header.
229 while (ReadBlobString(image,buffer) != (char *) NULL)
230 if (sscanf(buffer,"#define %s %lu",name,&width) == 2)
231 if ((strlen(name) >= 6) &&
232 (LocaleCompare(name+strlen(name)-6,"_width") == 0))
234 while (ReadBlobString(image,buffer) != (char *) NULL)
235 if (sscanf(buffer,"#define %s %lu",name,&height) == 2)
236 if ((strlen(name) >= 7) &&
237 (LocaleCompare(name+strlen(name)-7,"_height") == 0))
239 image->columns=width;
242 image->storage_class=PseudoClass;
245 Scan until hex digits.
248 while (ReadBlobString(image,buffer) != (char *) NULL)
250 if (sscanf(buffer,"static short %s = {",name) == 1)
253 if (sscanf(buffer,"static unsigned char %s = {",name) == 1)
256 if (sscanf(buffer,"static char %s = {",name) == 1)
260 p=(unsigned char *) strrchr(name,'_');
261 if (p == (unsigned char *) NULL)
262 p=(unsigned char *) name;
265 if (LocaleCompare("bits[]",(char *) p) == 0)
268 if ((image->columns == 0) || (image->rows == 0) ||
269 (EOFBlob(image) != MagickFalse))
270 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
272 Initialize image structure.
274 if (AcquireImageColormap(image,image->colors,exception) == MagickFalse)
275 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
279 image->colormap[0].red=(Quantum) QuantumRange;
280 image->colormap[0].green=(Quantum) QuantumRange;
281 image->colormap[0].blue=(Quantum) QuantumRange;
282 image->colormap[1].red=(Quantum) 0;
283 image->colormap[1].green=(Quantum) 0;
284 image->colormap[1].blue=(Quantum) 0;
285 if (image_info->ping != MagickFalse)
287 (void) CloseBlob(image);
288 return(GetFirstImageInList(image));
291 Initialize hex values.
293 hex_digits[(int) '0']=0;
294 hex_digits[(int) '1']=1;
295 hex_digits[(int) '2']=2;
296 hex_digits[(int) '3']=3;
297 hex_digits[(int) '4']=4;
298 hex_digits[(int) '5']=5;
299 hex_digits[(int) '6']=6;
300 hex_digits[(int) '7']=7;
301 hex_digits[(int) '8']=8;
302 hex_digits[(int) '9']=9;
303 hex_digits[(int) 'A']=10;
304 hex_digits[(int) 'B']=11;
305 hex_digits[(int) 'C']=12;
306 hex_digits[(int) 'D']=13;
307 hex_digits[(int) 'E']=14;
308 hex_digits[(int) 'F']=15;
309 hex_digits[(int) 'a']=10;
310 hex_digits[(int) 'b']=11;
311 hex_digits[(int) 'c']=12;
312 hex_digits[(int) 'd']=13;
313 hex_digits[(int) 'e']=14;
314 hex_digits[(int) 'f']=15;
315 hex_digits[(int) 'x']=0;
316 hex_digits[(int) ' ']=(-1);
317 hex_digits[(int) ',']=(-1);
318 hex_digits[(int) '}']=(-1);
319 hex_digits[(int) '\n']=(-1);
320 hex_digits[(int) '\t']=(-1);
325 if (((image->columns % 16) != 0) &&
326 ((image->columns % 16) < 9) && (version == 10))
328 bytes_per_line=(image->columns+7)/8+padding;
329 length=(size_t) image->rows;
330 data=(unsigned char *) AcquireQuantumMemory(length,bytes_per_line*
332 if (data == (unsigned char *) NULL)
333 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
336 for (i=0; i < (ssize_t) (bytes_per_line*image->rows); (i+=2))
338 value=(size_t) XBMInteger(image,hex_digits);
339 *p++=(unsigned char) value;
340 if ((padding == 0) || (((i+2) % bytes_per_line) != 0))
341 *p++=(unsigned char) (value >> 8);
344 for (i=0; i < (ssize_t) (bytes_per_line*image->rows); i++)
346 value=(size_t) XBMInteger(image,hex_digits);
347 *p++=(unsigned char) value;
350 Convert X bitmap image to pixel packets.
353 for (y=0; y < (ssize_t) image->rows; y++)
355 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
356 if (q == (Quantum *) NULL)
360 for (x=0; x < (ssize_t) image->columns; x++)
363 byte=(size_t) (*p++);
364 SetPixelIndex(image,(byte & 0x01) != 0 ? 0x01 : 0x00,q);
369 q+=GetPixelChannels(image);
371 if (SyncAuthenticPixels(image,exception) == MagickFalse)
373 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
375 if (status == MagickFalse)
378 data=(unsigned char *) RelinquishMagickMemory(data);
379 (void) SyncImage(image,exception);
380 (void) CloseBlob(image);
381 return(GetFirstImageInList(image));
385 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
389 % R e g i s t e r X B M I m a g e %
393 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
395 % RegisterXBMImage() adds attributes for the XBM image format to
396 % the list of supported formats. The attributes include the image format
397 % tag, a method to read and/or write the format, whether the format
398 % supports the saving of more than one frame to the same file or blob,
399 % whether the format supports native in-memory I/O, and a brief
400 % description of the format.
402 % The format of the RegisterXBMImage method is:
404 % size_t RegisterXBMImage(void)
407 ModuleExport size_t RegisterXBMImage(void)
412 entry=SetMagickInfo("XBM");
413 entry->decoder=(DecodeImageHandler *) ReadXBMImage;
414 entry->encoder=(EncodeImageHandler *) WriteXBMImage;
415 entry->magick=(IsImageFormatHandler *) IsXBM;
416 entry->adjoin=MagickFalse;
417 entry->description=ConstantString(
418 "X Windows system bitmap (black and white)");
419 entry->module=ConstantString("XBM");
420 (void) RegisterMagickInfo(entry);
421 return(MagickImageCoderSignature);
425 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
429 % U n r e g i s t e r X B M I m a g e %
433 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
435 % UnregisterXBMImage() removes format registrations made by the
436 % XBM module from the list of supported formats.
438 % The format of the UnregisterXBMImage method is:
440 % UnregisterXBMImage(void)
443 ModuleExport void UnregisterXBMImage(void)
445 (void) UnregisterMagickInfo("XBM");
449 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
453 % W r i t e X B M I m a g e %
457 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
459 % WriteXBMImage() writes an image to a file in the X bitmap format.
461 % The format of the WriteXBMImage method is:
463 % MagickBooleanType WriteXBMImage(const ImageInfo *image_info,
464 % Image *image,ExceptionInfo *exception)
466 % A description of each parameter follows.
468 % o image_info: the image info.
470 % o image: The image.
472 % o exception: return any errors or warnings in this structure.
475 static MagickBooleanType WriteXBMImage(const ImageInfo *image_info,Image *image,
476 ExceptionInfo *exception)
479 basename[MaxTextExtent],
480 buffer[MaxTextExtent];
485 register const Quantum
500 Open output image file.
502 assert(image_info != (const ImageInfo *) NULL);
503 assert(image_info->signature == MagickSignature);
504 assert(image != (Image *) NULL);
505 assert(image->signature == MagickSignature);
506 if (image->debug != MagickFalse)
507 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
508 assert(exception != (ExceptionInfo *) NULL);
509 assert(exception->signature == MagickSignature);
510 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
511 if (status == MagickFalse)
513 if (IsRGBColorspace(image->colorspace) == MagickFalse)
514 (void) TransformImageColorspace(image,RGBColorspace,exception);
516 Write X bitmap header.
518 GetPathComponent(image->filename,BasePath,basename);
519 (void) FormatLocaleString(buffer,MaxTextExtent,"#define %s_width %.20g\n",
520 basename,(double) image->columns);
521 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
522 (void) FormatLocaleString(buffer,MaxTextExtent,"#define %s_height %.20g\n",
523 basename,(double) image->rows);
524 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
525 (void) FormatLocaleString(buffer,MaxTextExtent,
526 "static char %s_bits[] = {\n",basename);
527 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
528 (void) CopyMagickString(buffer," ",MaxTextExtent);
529 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
531 Convert MIFF to X bitmap pixels.
533 (void) SetImageType(image,BilevelType,exception);
539 (void) CopyMagickString(buffer," ",MaxTextExtent);
540 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
541 for (y=0; y < (ssize_t) image->rows; y++)
543 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
544 if (p == (const Quantum *) NULL)
546 for (x=0; x < (ssize_t) image->columns; x++)
549 if (GetPixelIntensity(image,p) < ((MagickRealType) QuantumRange/2.0))
555 Write a bitmap byte to the image file.
557 (void) FormatLocaleString(buffer,MaxTextExtent,"0x%02X, ",
558 (unsigned int) (byte & 0xff));
559 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
563 (void) CopyMagickString(buffer,"\n ",MaxTextExtent);
564 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
570 p+=GetPixelChannels(image);
575 Write a bitmap byte to the image file.
578 (void) FormatLocaleString(buffer,MaxTextExtent,"0x%02X, ",
579 (unsigned int) (byte & 0xff));
580 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
584 (void) CopyMagickString(buffer,"\n ",MaxTextExtent);
585 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
591 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
593 if (status == MagickFalse)
596 (void) CopyMagickString(buffer,"};\n",MaxTextExtent);
597 (void) WriteBlob(image,strlen(buffer),(unsigned char *) buffer);
598 (void) CloseBlob(image);