granicus.if.org Git - imagemagick/blob - coders/caption.c

   1 /*
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3 %                                                                             %
   4 %                                                                             %
   5 %                                                                             %
   6 %               CCCC   AAA   PPPP   TTTTT  IIIII   OOO   N   N                %
   7 %              C      A   A  P   P    T      I    O   O  NN  N                %
   8 %              C      AAAAA  PPPP     T      I    O   O  N N N                %
   9 %              C      A   A  P        T      I    O   O  N  NN                %
  10 %               CCCC  A   A  P        T    IIIII   OOO   N   N                %
  11 %                                                                             %
  12 %                                                                             %
  13 %                             Read Text Caption.                              %
  14 %                                                                             %
  15 %                              Software Design                                %
  16 %                                John Cristy                                  %
  17 %                               February 2002                                 %
  18 %                                                                             %
  19 %                                                                             %
  20 %  Copyright 1999-2013 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 %    http://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 */
  38 \f
  39 /*
  40   Include declarations.
  41 */
  42 #include "MagickCore/studio.h"
  43 #include "MagickCore/annotate.h"
  44 #include "MagickCore/artifact.h"
  45 #include "MagickCore/blob.h"
  46 #include "MagickCore/blob-private.h"
  47 #include "MagickCore/composite-private.h"
  48 #include "MagickCore/draw.h"
  49 #include "MagickCore/draw-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/module.h"
  58 #include "MagickCore/option.h"
  59 #include "MagickCore/property.h"
  60 #include "MagickCore/quantum-private.h"
  61 #include "MagickCore/static.h"
  62 #include "MagickCore/string_.h"
  63 #include "MagickCore/string-private.h"
  64 #include "MagickCore/utility.h"
  65 \f
  66 /*
  67 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  68 %                                                                             %
  69 %                                                                             %
  70 %                                                                             %
  71 %   R e a d C A P T I O N I m a g e                                           %
  72 %                                                                             %
  73 %                                                                             %
  74 %                                                                             %
  75 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  76 %
  77 %  ReadCAPTIONImage() reads a CAPTION image file and returns it.  It
  78 %  allocates the memory necessary for the new Image structure and returns a
  79 %  pointer to the new image.
  80 %
  81 %  The format of the ReadCAPTIONImage method is:
  82 %
  83 %      Image *ReadCAPTIONImage(const ImageInfo *image_info,
  84 %        ExceptionInfo *exception)
  85 %
  86 %  A description of each parameter follows:
  87 %
  88 %    o image_info: the image info.
  89 %
  90 %    o exception: return any errors or warnings in this structure.
  91 %
  92 */
  93 static Image *ReadCAPTIONImage(const ImageInfo *image_info,
  94   ExceptionInfo *exception)
  95 {
  96   char
  97     *caption,
  98     geometry[MaxTextExtent],
  99     *property,
 100     *text;
 101
 102   const char
 103     *gravity,
 104     *option;
 105
 106   DrawInfo
 107     *draw_info;
 108
 109   Image
 110     *image;
 111
 112   MagickBooleanType
 113     status;
 114
 115   register ssize_t
 116     i;
 117
 118   size_t
 119     height,
 120     width;
 121
 122   TypeMetric
 123     metrics;
 124
 125   /*
 126     Initialize Image structure.
 127   */
 128   assert(image_info != (const ImageInfo *) NULL);
 129   assert(image_info->signature == MagickSignature);
 130   if (image_info->debug != MagickFalse)
 131     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
 132       image_info->filename);
 133   assert(exception != (ExceptionInfo *) NULL);
 134   assert(exception->signature == MagickSignature);
 135   image=AcquireImage(image_info,exception);
 136   (void) ResetImagePage(image,"0x0+0+0");
 137   /*
 138     Format caption.
 139   */
 140   option=GetImageArtifact(image,"filename");
 141   if (option == (const char *) NULL)
 142     property=InterpretImageProperties(image_info,image,image_info->filename,
 143       exception);
 144   else
 145     if (LocaleNCompare(option,"caption:",8) == 0)
 146       property=InterpretImageProperties(image_info,image,option+8,exception);
 147     else
 148       property=InterpretImageProperties(image_info,image,option,exception);
 149   (void) SetImageProperty(image,"caption",property,exception);
 150   property=DestroyString(property);
 151   caption=ConstantString(GetImageProperty(image,"caption",exception));
 152   draw_info=CloneDrawInfo(image_info,(DrawInfo *) NULL);
 153   (void) CloneString(&draw_info->text,caption);
 154   gravity=GetImageArtifact(image,"gravity");
 155   if (gravity != (char *) NULL)
 156     draw_info->gravity=(GravityType) ParseCommandOption(MagickGravityOptions,
 157       MagickFalse,gravity);
 158   if (image->columns == 0)
 159     {
 160       for ( ; ; draw_info->pointsize*=2.0)
 161       {
 162         text=AcquireString(caption);
 163         i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&text,
 164           exception);
 165         (void) CloneString(&draw_info->text,text);
 166         text=DestroyString(text);
 167         (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 168           -metrics.bounds.x1,metrics.ascent);
 169         if (draw_info->gravity == UndefinedGravity)
 170           (void) CloneString(&draw_info->geometry,geometry);
 171         status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 172         height=(size_t) floor(metrics.height+draw_info->stroke_width+0.5);
 173         if ((height >= image->rows) || (image_info->pointsize != 0.0))
 174           break;
 175       }
 176       draw_info->pointsize/=2.0;
 177       status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 178       width=(size_t) floor(metrics.width+draw_info->stroke_width+0.5);
 179       image->columns=width;
 180     }
 181   if (image->rows == 0)
 182     {
 183       for ( ; ; draw_info->pointsize*=2.0)
 184       {
 185         text=AcquireString(caption);
 186         i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&text,
 187           exception);
 188         (void) CloneString(&draw_info->text,text);
 189         text=DestroyString(text);
 190         (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 191           -metrics.bounds.x1,metrics.ascent);
 192         if (draw_info->gravity == UndefinedGravity)
 193           (void) CloneString(&draw_info->geometry,geometry);
 194         status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 195         width=(size_t) floor(metrics.width+draw_info->stroke_width+0.5);
 196         height=(size_t) floor(metrics.height+draw_info->stroke_width+0.5);
 197         if ((width >= image->columns) || (image_info->pointsize != 0.0))
 198           break;
 199       }
 200       draw_info->pointsize/=2.0;
 201       status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 202       image->rows=(size_t) ((i+1)*(metrics.ascent-metrics.descent+
 203         draw_info->interline_spacing+draw_info->stroke_width)+0.5);
 204     }
 205   if (fabs(image_info->pointsize) < MagickEpsilon)
 206     {
 207       double
 208         high,
 209         low;
 210
 211       /*
 212         Auto fit text into bounding box.
 213       */
 214       for ( ; ; draw_info->pointsize*=2.0)
 215       {
 216         text=AcquireString(caption);
 217         i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&text,
 218           exception);
 219         (void) CloneString(&draw_info->text,text);
 220         text=DestroyString(text);
 221         (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 222           -metrics.bounds.x1,metrics.ascent);
 223         if (draw_info->gravity == UndefinedGravity)
 224           (void) CloneString(&draw_info->geometry,geometry);
 225         status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 226         width=(size_t) floor(metrics.width+draw_info->stroke_width+0.5);
 227         height=(size_t) floor(metrics.height+draw_info->stroke_width+0.5);
 228         if ((width >= image->columns) && (height >= image->rows))
 229           break;
 230         if ((width >= (image->columns << 1)) || (height >= (image->rows << 1)))
 231           break;
 232       }
 233       high=draw_info->pointsize/2.0;
 234       for (low=high/2.0; (high-low) > 1.0; )
 235       {
 236         draw_info->pointsize=(low+high)/2.0;
 237         text=AcquireString(caption);
 238         i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&text,
 239           exception);
 240         (void) CloneString(&draw_info->text,text);
 241         text=DestroyString(text);
 242         (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 243           -metrics.bounds.x1,metrics.ascent);
 244         if (draw_info->gravity == UndefinedGravity)
 245           (void) CloneString(&draw_info->geometry,geometry);
 246         status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 247         width=(size_t) floor(metrics.width+draw_info->stroke_width+0.5);
 248         height=(size_t) floor(metrics.height+draw_info->stroke_width+0.5);
 249         if ((width <= image->columns) && (height <= image->rows))
 250           low=draw_info->pointsize+1.0;
 251         else
 252           high=draw_info->pointsize-1.0;
 253       }
 254       for (draw_info->pointsize=(low+high)/2.0; (high-low) > 1.0; )
 255       {
 256         text=AcquireString(caption);
 257         i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&text,
 258           exception);
 259         (void) CloneString(&draw_info->text,text);
 260         text=DestroyString(text);
 261         (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 262           -metrics.bounds.x1,metrics.ascent);
 263         if (draw_info->gravity == UndefinedGravity)
 264           (void) CloneString(&draw_info->geometry,geometry);
 265         status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 266         width=(size_t) floor(metrics.width+draw_info->stroke_width+0.5);
 267         height=(size_t) floor(metrics.height+draw_info->stroke_width+0.5);
 268         if ((width <= image->columns) && (height <= image->rows))
 269           break;
 270         draw_info->pointsize--;
 271       }
 272       draw_info->pointsize--;
 273     }
 274   (void) CloneString(&draw_info->text,caption);
 275   i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&caption,
 276     exception);
 277   if (SetImageBackgroundColor(image,exception) == MagickFalse)
 278     {
 279       image=DestroyImageList(image);
 280       return((Image *) NULL);
 281     }
 282   /*
 283     Draw caption.
 284   */
 285   (void) CloneString(&draw_info->text,caption);
 286   status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 287   if ((draw_info->gravity != UndefinedGravity) &&
 288       (draw_info->direction != RightToLeftDirection))
 289     image->page.x=(ssize_t) (metrics.bounds.x1-draw_info->stroke_width/2.0);
 290   else
 291     {
 292       (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 293         -metrics.bounds.x1+draw_info->stroke_width/2.0,metrics.ascent+
 294         draw_info->stroke_width/2.0);
 295       if (draw_info->direction == RightToLeftDirection)
 296         (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 297           image->columns-(metrics.bounds.x2+draw_info->stroke_width/2.0),
 298           metrics.ascent+draw_info->stroke_width/2.0);
 299       draw_info->geometry=AcquireString(geometry);
 300     }
 301   status=AnnotateImage(image,draw_info,exception);
 302   draw_info=DestroyDrawInfo(draw_info);
 303   caption=DestroyString(caption);
 304   if (status == MagickFalse)
 305     {
 306       image=DestroyImageList(image);
 307       return((Image *) NULL);
 308     }
 309   return(GetFirstImageInList(image));
 310 }
 311 \f
 312 /*
 313 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 314 %                                                                             %
 315 %                                                                             %
 316 %                                                                             %
 317 %   R e g i s t e r C A P T I O N I m a g e                                   %
 318 %                                                                             %
 319 %                                                                             %
 320 %                                                                             %
 321 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 322 %
 323 %  RegisterCAPTIONImage() adds attributes for the CAPTION image format to
 324 %  the list of supported formats.  The attributes include the image format
 325 %  tag, a method to read and/or write the format, whether the format
 326 %  supports the saving of more than one frame to the same file or blob,
 327 %  whether the format supports native in-memory I/O, and a brief
 328 %  description of the format.
 329 %
 330 %  The format of the RegisterCAPTIONImage method is:
 331 %
 332 %      size_t RegisterCAPTIONImage(void)
 333 %
 334 */
 335 ModuleExport size_t RegisterCAPTIONImage(void)
 336 {
 337   MagickInfo
 338     *entry;
 339
 340   entry=SetMagickInfo("CAPTION");
 341   entry->decoder=(DecodeImageHandler *) ReadCAPTIONImage;
 342   entry->description=ConstantString("Caption");
 343   entry->adjoin=MagickFalse;
 344   entry->module=ConstantString("CAPTION");
 345   (void) RegisterMagickInfo(entry);
 346   return(MagickImageCoderSignature);
 347 }
 348 \f
 349 /*
 350 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 351 %                                                                             %
 352 %                                                                             %
 353 %                                                                             %
 354 %   U n r e g i s t e r C A P T I O N I m a g e                               %
 355 %                                                                             %
 356 %                                                                             %
 357 %                                                                             %
 358 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 359 %
 360 %  UnregisterCAPTIONImage() removes format registrations made by the
 361 %  CAPTION module from the list of supported formats.
 362 %
 363 %  The format of the UnregisterCAPTIONImage method is:
 364 %
 365 %      UnregisterCAPTIONImage(void)
 366 %
 367 */
 368 ModuleExport void UnregisterCAPTIONImage(void)
 369 {
 370   (void) UnregisterMagickInfo("CAPTION");
 371 }