2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % Render Text Onto A Canvas Image. %
20 % Copyright 1999-2014 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 *,ExceptionInfo *);
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->resolution.x == 0.0) || (image->resolution.y == 0.0))
211 flags=ParseGeometry(PSDensityGeometry,&geometry_info);
212 image->resolution.x=geometry_info.rho;
213 image->resolution.y=geometry_info.sigma;
214 if ((flags & SigmaValue) == 0)
215 image->resolution.y=image->resolution.x;
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->resolution.x)/
228 image->rows=(size_t) floor((((double) page.height*image->resolution.y)/
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,exception);
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,exception);
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,exception);
290 (void) SetImageProgressMonitor(image,progress_monitor,
293 (void) AnnotateImage(image,draw_info,exception);
294 if (p == (char *) NULL)
297 Page is full-- allocate next image structure.
299 *draw_info->text='\0';
301 AcquireNextImage(image_info,image,exception);
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,exception);
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,exception);
325 (void) SetImageProgressMonitor(image,progress_monitor,image->client_data);
327 (void) AnnotateImage(image,draw_info,exception);
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,exception);
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->alpha_trait=UndefinedPixelTrait;
436 if ((i > 0) && (colorspace[i] == 'a'))
439 image->alpha_trait=BlendPixelTrait;
441 type=ParseCommandOption(MagickColorspaceOptions,MagickFalse,colorspace);
443 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
444 (void) SetImageBackgroundColor(image,exception);
445 (void) SetImageColorspace(image,(ColorspaceType) type,exception);
446 GetPixelInfo(image,&pixel);
447 range=GetQuantumRange(image->depth);
448 for (y=0; y < (ssize_t) image->rows; y++)
462 for (x=0; x < (ssize_t) image->columns; x++)
464 if (ReadBlobString(image,text) == (char *) NULL)
466 switch (image->colorspace)
470 if (image->alpha_trait == BlendPixelTrait)
472 count=(ssize_t) sscanf(text,"%ld,%ld: (%lf,%lf",&x_offset,
473 &y_offset,&red,&alpha);
478 count=(ssize_t) sscanf(text,"%ld,%ld: (%lf",&x_offset,&y_offset,
486 if (image->alpha_trait == BlendPixelTrait)
488 count=(ssize_t) sscanf(text,"%ld,%ld: (%lf,%lf,%lf,%lf,%lf",
489 &x_offset,&y_offset,&red,&green,&blue,&black,&alpha);
492 count=(ssize_t) sscanf(text,"%ld,%ld: (%lf,%lf,%lf,%lf",&x_offset,
493 &y_offset,&red,&green,&blue,&black);
498 if (image->alpha_trait == BlendPixelTrait)
500 count=(ssize_t) sscanf(text,"%ld,%ld: (%lf,%lf,%lf,%lf",
501 &x_offset,&y_offset,&red,&green,&blue,&alpha);
504 count=(ssize_t) sscanf(text,"%ld,%ld: (%lf,%lf,%lf",&x_offset,
505 &y_offset,&red,&green,&blue);
509 if (image->colorspace == LabColorspace)
511 green+=(range+1)/2.0;
514 pixel.red=ScaleAnyToQuantum((QuantumAny) (red+0.5),range);
515 pixel.green=ScaleAnyToQuantum((QuantumAny) (green+0.5),range);
516 pixel.blue=ScaleAnyToQuantum((QuantumAny) (blue+0.5),range);
517 pixel.black=ScaleAnyToQuantum((QuantumAny) (black+0.5),range);
518 pixel.alpha=ScaleAnyToQuantum((QuantumAny) (alpha+0.5),range);
519 q=GetAuthenticPixels(image,x_offset,y_offset,1,1,exception);
520 if (q == (Quantum *) NULL)
522 SetPixelInfoPixel(image,&pixel,q);
523 if (SyncAuthenticPixels(image,exception) == MagickFalse)
527 (void) ReadBlobString(image,text);
528 if (LocaleNCompare((char *) text,MagickID,strlen(MagickID)) == 0)
531 Allocate next image structure.
533 AcquireNextImage(image_info,image,exception);
534 if (GetNextImageInList(image) == (Image *) NULL)
536 image=DestroyImageList(image);
537 return((Image *) NULL);
539 image=SyncNextImageInList(image);
540 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
542 if (status == MagickFalse)
545 } while (LocaleNCompare((char *) text,MagickID,strlen(MagickID)) == 0);
546 (void) CloseBlob(image);
547 return(GetFirstImageInList(image));
551 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
555 % R e g i s t e r T X T I m a g e %
559 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
561 % RegisterTXTImage() adds attributes for the TXT image format to the
562 % list of supported formats. The attributes include the image format
563 % tag, a method to read and/or write the format, whether the format
564 % supports the saving of more than one frame to the same file or blob,
565 % whether the format supports native in-memory I/O, and a brief
566 % description of the format.
568 % The format of the RegisterTXTImage method is:
570 % size_t RegisterTXTImage(void)
573 ModuleExport size_t RegisterTXTImage(void)
578 entry=SetMagickInfo("SPARSE-COLOR");
579 entry->encoder=(EncodeImageHandler *) WriteTXTImage;
580 entry->raw=MagickTrue;
581 entry->endian_support=MagickTrue;
582 entry->description=ConstantString("Sparse Color");
583 entry->module=ConstantString("TXT");
584 (void) RegisterMagickInfo(entry);
585 entry=SetMagickInfo("TEXT");
586 entry->decoder=(DecodeImageHandler *) ReadTXTImage;
587 entry->encoder=(EncodeImageHandler *) WriteTXTImage;
588 entry->raw=MagickTrue;
589 entry->endian_support=MagickTrue;
590 entry->description=ConstantString("Text");
591 entry->module=ConstantString("TXT");
592 (void) RegisterMagickInfo(entry);
593 entry=SetMagickInfo("TXT");
594 entry->decoder=(DecodeImageHandler *) ReadTXTImage;
595 entry->encoder=(EncodeImageHandler *) WriteTXTImage;
596 entry->description=ConstantString("Text");
597 entry->magick=(IsImageFormatHandler *) IsTXT;
598 entry->module=ConstantString("TXT");
599 (void) RegisterMagickInfo(entry);
600 return(MagickImageCoderSignature);
604 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
608 % U n r e g i s t e r T X T I m a g e %
612 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
614 % UnregisterTXTImage() removes format registrations made by the
615 % TXT module from the list of supported format.
617 % The format of the UnregisterTXTImage method is:
619 % UnregisterTXTImage(void)
622 ModuleExport void UnregisterTXTImage(void)
624 (void) UnregisterMagickInfo("SPARSE-COLOR");
625 (void) UnregisterMagickInfo("TEXT");
626 (void) UnregisterMagickInfo("TXT");
630 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
634 % W r i t e T X T I m a g e %
638 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
640 % WriteTXTImage writes the pixel values as text numbers.
642 % The format of the WriteTXTImage method is:
644 % MagickBooleanType WriteTXTImage(const ImageInfo *image_info,
645 % Image *image,ExceptionInfo *exception)
647 % A description of each parameter follows.
649 % o image_info: the image info.
651 % o image: The image.
653 % o exception: return any errors or warnings in this structure.
656 static MagickBooleanType WriteTXTImage(const ImageInfo *image_info,Image *image,
657 ExceptionInfo *exception)
660 buffer[MaxTextExtent],
661 colorspace[MaxTextExtent],
662 tuple[MaxTextExtent];
673 register const Quantum
683 Open output image file.
685 assert(image_info != (const ImageInfo *) NULL);
686 assert(image_info->signature == MagickSignature);
687 assert(image != (Image *) NULL);
688 assert(image->signature == MagickSignature);
689 if (image->debug != MagickFalse)
690 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
691 status=OpenBlob(image_info,image,WriteBlobMode,exception);
692 if (status == MagickFalse)
700 (void) CopyMagickString(colorspace,CommandOptionToMnemonic(
701 MagickColorspaceOptions,(ssize_t) image->colorspace),MaxTextExtent);
702 LocaleLower(colorspace);
703 image->depth=GetImageQuantumDepth(image,MagickTrue);
704 if (image->alpha_trait == BlendPixelTrait)
705 (void) ConcatenateMagickString(colorspace,"a",MaxTextExtent);
706 compliance=NoCompliance;
707 if (LocaleCompare(image_info->magick,"SPARSE-COLOR") != 0)
709 (void) FormatLocaleString(buffer,MaxTextExtent,
710 "# ImageMagick pixel enumeration: %.20g,%.20g,%.20g,%s\n",(double)
711 image->columns,(double) image->rows,(double) ((MagickOffsetType)
712 GetQuantumRange(image->depth)),colorspace);
713 (void) WriteBlobString(image,buffer);
714 compliance=SVGCompliance;
716 GetPixelInfo(image,&pixel);
717 for (y=0; y < (ssize_t) image->rows; y++)
719 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
720 if (p == (const Quantum *) NULL)
722 for (x=0; x < (ssize_t) image->columns; x++)
724 GetPixelInfoPixel(image,p,&pixel);
725 if (pixel.colorspace == LabColorspace)
727 pixel.green-=(QuantumRange+1)/2.0;
728 pixel.blue-=(QuantumRange+1)/2.0;
730 if (LocaleCompare(image_info->magick,"SPARSE-COLOR") == 0)
735 if (GetPixelAlpha(image,p) == (Quantum) OpaqueAlpha)
737 GetColorTuple(&pixel,MagickFalse,tuple);
738 (void) FormatLocaleString(buffer,MaxTextExtent,"%.20g,%.20g,",
739 (double) x,(double) y);
740 (void) WriteBlobString(image,buffer);
741 (void) WriteBlobString(image,tuple);
742 (void) WriteBlobString(image," ");
744 p+=GetPixelChannels(image);
747 (void) FormatLocaleString(buffer,MaxTextExtent,"%.20g,%.20g: ",(double)
749 (void) WriteBlobString(image,buffer);
750 (void) CopyMagickString(tuple,"(",MaxTextExtent);
751 if (pixel.colorspace == GRAYColorspace)
752 ConcatenateColorComponent(&pixel,GrayPixelChannel,compliance,
756 ConcatenateColorComponent(&pixel,RedPixelChannel,compliance,tuple);
757 (void) ConcatenateMagickString(tuple,",",MaxTextExtent);
758 ConcatenateColorComponent(&pixel,GreenPixelChannel,compliance,
760 (void) ConcatenateMagickString(tuple,",",MaxTextExtent);
761 ConcatenateColorComponent(&pixel,BluePixelChannel,compliance,tuple);
763 if (pixel.colorspace == CMYKColorspace)
765 (void) ConcatenateMagickString(tuple,",",MaxTextExtent);
766 ConcatenateColorComponent(&pixel,BlackPixelChannel,compliance,
769 if (pixel.alpha_trait == BlendPixelTrait)
771 (void) ConcatenateMagickString(tuple,",",MaxTextExtent);
772 ConcatenateColorComponent(&pixel,AlphaPixelChannel,compliance,
775 (void) ConcatenateMagickString(tuple,")",MaxTextExtent);
776 (void) WriteBlobString(image,tuple);
777 (void) WriteBlobString(image," ");
778 GetColorTuple(&pixel,MagickTrue,tuple);
779 (void) FormatLocaleString(buffer,MaxTextExtent,"%s",tuple);
780 (void) WriteBlobString(image,buffer);
781 (void) WriteBlobString(image," ");
782 (void) QueryColorname(image,&pixel,SVGCompliance,tuple,exception);
783 (void) WriteBlobString(image,tuple);
784 (void) WriteBlobString(image,"\n");
785 p+=GetPixelChannels(image);
787 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
789 if (status == MagickFalse)
792 if (GetNextImageInList(image) == (Image *) NULL)
794 image=SyncNextImageInList(image);
795 status=SetImageProgress(image,SaveImagesTag,scene++,
796 GetImageListLength(image));
797 if (status == MagickFalse)
799 } while (image_info->adjoin != MagickFalse);
800 (void) CloseBlob(image);