2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % Render Text Onto A Canvas Image. %
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/annotate.h"
44 #include "MagickCore/attribute.h"
45 #include "MagickCore/blob.h"
46 #include "MagickCore/blob-private.h"
47 #include "MagickCore/cache.h"
48 #include "MagickCore/color.h"
49 #include "MagickCore/color-private.h"
50 #include "MagickCore/colorspace.h"
51 #include "MagickCore/constitute.h"
52 #include "MagickCore/draw.h"
53 #include "MagickCore/exception.h"
54 #include "MagickCore/exception-private.h"
55 #include "MagickCore/geometry.h"
56 #include "MagickCore/image.h"
57 #include "MagickCore/image-private.h"
58 #include "MagickCore/list.h"
59 #include "MagickCore/magick.h"
60 #include "MagickCore/memory_.h"
61 #include "MagickCore/monitor.h"
62 #include "MagickCore/monitor-private.h"
63 #include "MagickCore/option.h"
64 #include "MagickCore/pixel-accessor.h"
65 #include "MagickCore/quantum-private.h"
66 #include "MagickCore/static.h"
67 #include "MagickCore/statistic.h"
68 #include "MagickCore/string_.h"
69 #include "MagickCore/module.h"
74 static MagickBooleanType
75 WriteTXTImage(const ImageInfo *,Image *);
78 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
86 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
88 % IsTXT() returns MagickTrue if the image format type, identified by the magick
91 % The format of the IsTXT method is:
93 % MagickBooleanType IsTXT(const unsigned char *magick,const size_t length)
95 % A description of each parameter follows:
97 % o magick: compare image format pattern against these bytes.
99 % o length: Specifies the length of the magick string.
102 static MagickBooleanType IsTXT(const unsigned char *magick,const size_t length)
104 #define MagickID "# ImageMagick pixel enumeration:"
107 colorspace[MaxTextExtent];
119 if (LocaleNCompare((const char *) magick,MagickID,strlen(MagickID)) != 0)
121 count=(ssize_t) sscanf((const char *) magick+32,"%lu,%lu,%lu,%s",&columns,
122 &rows,&depth,colorspace);
129 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
133 % R e a d T E X T I m a g e %
137 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
139 % ReadTEXTImage() reads a text file and returns it as an image. It
140 % allocates the memory necessary for the new Image structure and returns a
141 % pointer to the new image.
143 % The format of the ReadTEXTImage method is:
145 % Image *ReadTEXTImage(const ImageInfo *image_info,Image *image,
146 % char *text,ExceptionInfo *exception)
148 % A description of each parameter follows:
150 % o image_info: the image info.
152 % o image: the image.
154 % o text: the text storage buffer.
156 % o exception: return any errors or warnings in this structure.
159 static Image *ReadTEXTImage(const ImageInfo *image_info,Image *image,
160 char *text,ExceptionInfo *exception)
163 filename[MaxTextExtent],
164 geometry[MaxTextExtent],
191 assert(image_info != (const ImageInfo *) NULL);
192 assert(image_info->signature == MagickSignature);
193 if (image_info->debug != MagickFalse)
194 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
195 image_info->filename);
196 assert(exception != (ExceptionInfo *) NULL);
197 assert(exception->signature == MagickSignature);
199 Set the page geometry.
201 delta.x=DefaultResolution;
202 delta.y=DefaultResolution;
203 if ((image->x_resolution == 0.0) || (image->y_resolution == 0.0))
211 flags=ParseGeometry(PSDensityGeometry,&geometry_info);
212 image->x_resolution=geometry_info.rho;
213 image->y_resolution=geometry_info.sigma;
214 if ((flags & SigmaValue) == 0)
215 image->y_resolution=image->x_resolution;
221 if (image_info->page != (char *) NULL)
222 (void) ParseAbsoluteGeometry(image_info->page,&page);
224 Initialize Image structure.
226 image->columns=(size_t) floor((((double) page.width*image->x_resolution)/
228 image->rows=(size_t) floor((((double) page.height*image->y_resolution)/
232 texture=(Image *) NULL;
233 if (image_info->texture != (char *) NULL)
238 read_info=CloneImageInfo(image_info);
239 SetImageInfoBlob(read_info,(void *) NULL,0);
240 (void) CopyMagickString(read_info->filename,image_info->texture,
242 texture=ReadImage(read_info,exception);
243 read_info=DestroyImageInfo(read_info);
246 Annotate the text image.
248 (void) SetImageBackgroundColor(image);
249 draw_info=CloneDrawInfo(image_info,(DrawInfo *) NULL);
250 (void) CloneString(&draw_info->text,image_info->filename);
251 (void) FormatLocaleString(geometry,MaxTextExtent,"0x0%+ld%+ld",(long) page.x,
253 (void) CloneString(&draw_info->geometry,geometry);
254 status=GetTypeMetrics(image,draw_info,&metrics);
255 if (status == MagickFalse)
256 ThrowReaderException(TypeError,"UnableToGetTypeMetrics");
257 page.y=(ssize_t) ceil((double) page.y+metrics.ascent-0.5);
258 (void) FormatLocaleString(geometry,MaxTextExtent,"0x0%+ld%+ld",(long) page.x,
260 (void) CloneString(&draw_info->geometry,geometry);
261 (void) CopyMagickString(filename,image_info->filename,MaxTextExtent);
262 if (*draw_info->text != '\0')
263 *draw_info->text='\0';
265 for (offset=2*page.y; p != (char *) NULL; )
268 Annotate image with text.
270 (void) ConcatenateString(&draw_info->text,text);
271 (void) ConcatenateString(&draw_info->text,"\n");
272 offset+=(ssize_t) (metrics.ascent-metrics.descent);
273 if (image->previous == (Image *) NULL)
275 status=SetImageProgress(image,LoadImageTag,offset,image->rows);
276 if (status == MagickFalse)
279 p=ReadBlobString(image,text);
280 if ((offset < (ssize_t) image->rows) && (p != (char *) NULL))
282 if (texture != (Image *) NULL)
284 MagickProgressMonitor
287 progress_monitor=SetImageProgressMonitor(image,
288 (MagickProgressMonitor) NULL,image->client_data);
289 (void) TextureImage(image,texture);
290 (void) SetImageProgressMonitor(image,progress_monitor,
293 (void) AnnotateImage(image,draw_info);
294 if (p == (char *) NULL)
297 Page is full-- allocate next image structure.
299 *draw_info->text='\0';
301 AcquireNextImage(image_info,image);
302 if (GetNextImageInList(image) == (Image *) NULL)
304 image=DestroyImageList(image);
305 return((Image *) NULL);
307 image->next->columns=image->columns;
308 image->next->rows=image->rows;
309 image=SyncNextImageInList(image);
310 (void) CopyMagickString(image->filename,filename,MaxTextExtent);
311 (void) SetImageBackgroundColor(image);
312 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
314 if (status == MagickFalse)
317 if (texture != (Image *) NULL)
319 MagickProgressMonitor
322 progress_monitor=SetImageProgressMonitor(image,
323 (MagickProgressMonitor) NULL,image->client_data);
324 (void) TextureImage(image,texture);
325 (void) SetImageProgressMonitor(image,progress_monitor,image->client_data);
327 (void) AnnotateImage(image,draw_info);
328 if (texture != (Image *) NULL)
329 texture=DestroyImage(texture);
330 draw_info=DestroyDrawInfo(draw_info);
331 (void) CloseBlob(image);
332 return(GetFirstImageInList(image));
336 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
340 % R e a d T X T I m a g e %
344 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
346 % ReadTXTImage() reads a text file and returns it as an image. It allocates
347 % the memory necessary for the new Image structure and returns a pointer to
350 % The format of the ReadTXTImage method is:
352 % Image *ReadTXTImage(const ImageInfo *image_info,ExceptionInfo *exception)
354 % A description of each parameter follows:
356 % o image_info: the image info.
358 % o exception: return any errors or warnings in this structure.
361 static Image *ReadTXTImage(const ImageInfo *image_info,ExceptionInfo *exception)
364 colorspace[MaxTextExtent],
404 assert(image_info != (const ImageInfo *) NULL);
405 assert(image_info->signature == MagickSignature);
406 if (image_info->debug != MagickFalse)
407 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
408 image_info->filename);
409 assert(exception != (ExceptionInfo *) NULL);
410 assert(exception->signature == MagickSignature);
411 image=AcquireImage(image_info);
412 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
413 if (status == MagickFalse)
415 image=DestroyImageList(image);
416 return((Image *) NULL);
418 (void) ResetMagickMemory(text,0,sizeof(text));
419 (void) ReadBlobString(image,text);
420 if (LocaleNCompare((char *) text,MagickID,strlen(MagickID)) != 0)
421 return(ReadTEXTImage(image_info,image,text,exception));
425 count=(ssize_t) sscanf(text+32,"%lu,%lu,%lu,%s",&width,&height,&max_value,
428 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
429 image->columns=width;
431 for (depth=1; (GetQuantumRange(depth)+1) < max_value; depth++) ;
433 LocaleLower(colorspace);
434 i=(ssize_t) strlen(colorspace)-1;
435 image->matte=MagickFalse;
436 if ((i > 0) && (colorspace[i] == 'a'))
439 image->matte=MagickTrue;
441 type=ParseCommandOption(MagickColorspaceOptions,MagickFalse,colorspace);
443 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
444 image->colorspace=(ColorspaceType) type;
445 (void) ResetMagickMemory(&pixel,0,sizeof(pixel));
446 (void) SetImageBackgroundColor(image);
447 range=GetQuantumRange(image->depth);
448 for (y=0; y < (ssize_t) image->rows; y++)
450 for (x=0; x < (ssize_t) image->columns; x++)
452 if (ReadBlobString(image,text) == (char *) NULL)
454 if (image->colorspace == CMYKColorspace)
456 if (image->matte != MagickFalse)
457 count=(ssize_t) sscanf(text,"%ld,%ld: (%u,%u,%u,%u,%u",&x_offset,
458 &y_offset,&pixel.red,&pixel.green,&pixel.blue,&pixel.black,
461 count=(ssize_t) sscanf(text,"%ld,%ld: (%u,%u,%u,%u",&x_offset,
462 &y_offset,&pixel.red,&pixel.green,&pixel.blue,&pixel.black);
465 if (image->matte != MagickFalse)
466 count=(ssize_t) sscanf(text,"%ld,%ld: (%u,%u,%u,%u",&x_offset,
467 &y_offset,&pixel.red,&pixel.green,&pixel.blue,&pixel.alpha);
469 count=(ssize_t) sscanf(text,"%ld,%ld: (%u,%u,%u",&x_offset,
470 &y_offset,&pixel.red,&pixel.green,&pixel.blue);
473 q=GetAuthenticPixels(image,x_offset,y_offset,1,1,exception);
474 if (q == (const Quantum *) NULL)
476 SetPixelRed(image,ScaleAnyToQuantum(pixel.red,range),q);
477 SetPixelGreen(image,ScaleAnyToQuantum(pixel.green,range),q);
478 SetPixelBlue(image,ScaleAnyToQuantum(pixel.blue,range),q);
479 if (image->colorspace == CMYKColorspace)
480 SetPixelBlack(image,ScaleAnyToQuantum(pixel.black,range),q);
481 if (image->matte != MagickFalse)
482 SetPixelAlpha(image,ScaleAnyToQuantum(pixel.alpha,range),q);
483 if (SyncAuthenticPixels(image,exception) == MagickFalse)
487 (void) ReadBlobString(image,text);
488 if (LocaleNCompare((char *) text,MagickID,strlen(MagickID)) == 0)
491 Allocate next image structure.
493 AcquireNextImage(image_info,image);
494 if (GetNextImageInList(image) == (Image *) NULL)
496 image=DestroyImageList(image);
497 return((Image *) NULL);
499 image=SyncNextImageInList(image);
500 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
502 if (status == MagickFalse)
505 } while (LocaleNCompare((char *) text,MagickID,strlen(MagickID)) == 0);
506 (void) CloseBlob(image);
507 return(GetFirstImageInList(image));
511 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
515 % R e g i s t e r T X T I m a g e %
519 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
521 % RegisterTXTImage() adds attributes for the TXT image format to the
522 % list of supported formats. The attributes include the image format
523 % tag, a method to read and/or write the format, whether the format
524 % supports the saving of more than one frame to the same file or blob,
525 % whether the format supports native in-memory I/O, and a brief
526 % description of the format.
528 % The format of the RegisterTXTImage method is:
530 % size_t RegisterTXTImage(void)
533 ModuleExport size_t RegisterTXTImage(void)
538 entry=SetMagickInfo("TEXT");
539 entry->decoder=(DecodeImageHandler *) ReadTXTImage;
540 entry->encoder=(EncodeImageHandler *) WriteTXTImage;
541 entry->raw=MagickTrue;
542 entry->endian_support=MagickTrue;
543 entry->description=ConstantString("Text");
544 entry->module=ConstantString("TXT");
545 (void) RegisterMagickInfo(entry);
546 entry=SetMagickInfo("TXT");
547 entry->decoder=(DecodeImageHandler *) ReadTXTImage;
548 entry->encoder=(EncodeImageHandler *) WriteTXTImage;
549 entry->description=ConstantString("Text");
550 entry->magick=(IsImageFormatHandler *) IsTXT;
551 entry->module=ConstantString("TXT");
552 (void) RegisterMagickInfo(entry);
553 return(MagickImageCoderSignature);
557 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
561 % U n r e g i s t e r T X T I m a g e %
565 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
567 % UnregisterTXTImage() removes format registrations made by the
568 % TXT module from the list of supported format.
570 % The format of the UnregisterTXTImage method is:
572 % UnregisterTXTImage(void)
575 ModuleExport void UnregisterTXTImage(void)
577 (void) UnregisterMagickInfo("TEXT");
578 (void) UnregisterMagickInfo("TXT");
582 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
586 % W r i t e T X T I m a g e %
590 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
592 % WriteTXTImage writes the pixel values as text numbers.
594 % The format of the WriteTXTImage method is:
596 % MagickBooleanType WriteTXTImage(const ImageInfo *image_info,Image *image)
598 % A description of each parameter follows.
600 % o image_info: the image info.
602 % o image: The image.
605 static MagickBooleanType WriteTXTImage(const ImageInfo *image_info,Image *image)
608 buffer[MaxTextExtent],
609 colorspace[MaxTextExtent],
610 tuple[MaxTextExtent];
621 register const Quantum
631 Open output image file.
633 assert(image_info != (const ImageInfo *) NULL);
634 assert(image_info->signature == MagickSignature);
635 assert(image != (Image *) NULL);
636 assert(image->signature == MagickSignature);
637 if (image->debug != MagickFalse)
638 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
639 status=OpenBlob(image_info,image,WriteBlobMode,&image->exception);
640 if (status == MagickFalse)
645 (void) CopyMagickString(colorspace,CommandOptionToMnemonic(
646 MagickColorspaceOptions,(ssize_t) image->colorspace),MaxTextExtent);
647 LocaleLower(colorspace);
648 image->depth=GetImageQuantumDepth(image,MagickTrue);
649 if (image->matte != MagickFalse)
650 (void) ConcatenateMagickString(colorspace,"a",MaxTextExtent);
651 (void) FormatLocaleString(buffer,MaxTextExtent,
652 "# ImageMagick pixel enumeration: %.20g,%.20g,%.20g,%s\n",(double)
653 image->columns,(double) image->rows,(double)
654 GetQuantumRange(image->depth),colorspace);
655 (void) WriteBlobString(image,buffer);
656 GetPixelInfo(image,&pixel);
657 for (y=0; y < (ssize_t) image->rows; y++)
659 p=GetVirtualPixels(image,0,y,image->columns,1,&image->exception);
660 if (p == (const Quantum *) NULL)
662 for (x=0; x < (ssize_t) image->columns; x++)
664 (void) FormatLocaleString(buffer,MaxTextExtent,"%.20g,%.20g: ",(double)
666 (void) WriteBlobString(image,buffer);
667 SetPixelInfo(image,p,&pixel);
668 (void) CopyMagickString(tuple,"(",MaxTextExtent);
669 ConcatenateColorComponent(&pixel,RedPixelChannel,X11Compliance,
671 (void) ConcatenateMagickString(tuple,",",MaxTextExtent);
672 ConcatenateColorComponent(&pixel,GreenPixelChannel,X11Compliance,
674 (void) ConcatenateMagickString(tuple,",",MaxTextExtent);
675 ConcatenateColorComponent(&pixel,BluePixelChannel,X11Compliance,
677 if (pixel.colorspace == CMYKColorspace)
679 (void) ConcatenateMagickString(tuple,",",MaxTextExtent);
680 ConcatenateColorComponent(&pixel,BlackPixelChannel,X11Compliance,
683 if (pixel.matte != MagickFalse)
685 (void) ConcatenateMagickString(tuple,",",MaxTextExtent);
686 ConcatenateColorComponent(&pixel,AlphaPixelChannel,X11Compliance,
689 (void) ConcatenateMagickString(tuple,")",MaxTextExtent);
690 (void) WriteBlobString(image,tuple);
691 (void) WriteBlobString(image," ");
692 GetColorTuple(&pixel,MagickTrue,tuple);
693 (void) FormatLocaleString(buffer,MaxTextExtent,"%s",tuple);
694 (void) WriteBlobString(image,buffer);
695 (void) WriteBlobString(image," ");
696 (void) QueryMagickColorname(image,&pixel,SVGCompliance,tuple,
698 (void) WriteBlobString(image,tuple);
699 (void) WriteBlobString(image,"\n");
700 p+=GetPixelChannels(image);
702 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
704 if (status == MagickFalse)
707 if (GetNextImageInList(image) == (Image *) NULL)
709 image=SyncNextImageInList(image);
710 status=SetImageProgress(image,SaveImagesTag,scene++,
711 GetImageListLength(image));
712 if (status == MagickFalse)
714 } while (image_info->adjoin != MagickFalse);
715 (void) CloseBlob(image);