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=GetImageOption(image_info,"filename");
 141   if (option == (const char *) NULL)
 142     property=InterpretImageProperties((ImageInfo *) image_info,image,
 143       image_info->filename,exception);
 144   else
 145     if (LocaleNCompare(option,"caption:",8) == 0)
 146       property=InterpretImageProperties((ImageInfo *) image_info,image,option+8,
 147         exception);
 148     else
 149       property=InterpretImageProperties((ImageInfo *) image_info,image,option,
 150         exception);
 151   (void) SetImageProperty(image,"caption",property,exception);
 152   property=DestroyString(property);
 153   caption=ConstantString(GetImageProperty(image,"caption",exception));
 154   draw_info=CloneDrawInfo(image_info,(DrawInfo *) NULL);
 155   (void) CloneString(&draw_info->text,caption);
 156   gravity=GetImageOption(image_info,"gravity");
 157   if (gravity != (char *) NULL)
 158     draw_info->gravity=(GravityType) ParseCommandOption(MagickGravityOptions,
 159       MagickFalse,gravity);
 160   if (image->columns == 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       width=(size_t) floor(metrics.width+draw_info->stroke_width+0.5);
 173       image->columns=width;
 174     }
 175   if (image->rows == 0)
 176     {
 177       text=AcquireString(caption);
 178       i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&text,
 179         exception);
 180       (void) CloneString(&draw_info->text,text);
 181       text=DestroyString(text);
 182       (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 183         -metrics.bounds.x1,metrics.ascent);
 184       if (draw_info->gravity == UndefinedGravity)
 185         (void) CloneString(&draw_info->geometry,geometry);
 186       status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 187       image->rows=(size_t) ((i+1)*(metrics.ascent-metrics.descent+
 188         draw_info->interline_spacing+draw_info->stroke_width)+0.5);
 189     }
 190   if (fabs(image_info->pointsize) < MagickEpsilon)
 191     {
 192       double
 193         high,
 194         low;
 195
 196       /*
 197         Auto fit text into bounding box.
 198       */
 199       for ( ; ; draw_info->pointsize*=2.0)
 200       {
 201         text=AcquireString(caption);
 202         i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&text,
 203           exception);
 204         (void) CloneString(&draw_info->text,text);
 205         text=DestroyString(text);
 206         (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 207           -metrics.bounds.x1,metrics.ascent);
 208         if (draw_info->gravity == UndefinedGravity)
 209           (void) CloneString(&draw_info->geometry,geometry);
 210         status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 211         width=(size_t) floor(metrics.width+draw_info->stroke_width+0.5);
 212         height=(size_t) floor(metrics.height+draw_info->stroke_width+0.5);
 213         if ((image->columns != 0) && (image->rows != 0))
 214           {
 215             if ((width >= image->columns) && (height >= image->rows))
 216               break;
 217           }
 218         else
 219           if (((image->columns != 0) && (width >= image->columns)) ||
 220               ((image->rows != 0) && (height >= image->rows)))
 221             break;
 222       }
 223       high=draw_info->pointsize;
 224       for (low=1.0; (high-low) > 1.0; )
 225       {
 226         draw_info->pointsize=(low+high)/2.0;
 227         text=AcquireString(caption);
 228         i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&text,
 229           exception);
 230         (void) CloneString(&draw_info->text,text);
 231         text=DestroyString(text);
 232         (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 233           -metrics.bounds.x1,metrics.ascent);
 234         if (draw_info->gravity == UndefinedGravity)
 235           (void) CloneString(&draw_info->geometry,geometry);
 236         status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 237         width=(size_t) floor(metrics.width+draw_info->stroke_width+0.5);
 238         height=(size_t) floor(metrics.height+draw_info->stroke_width+0.5);
 239         if ((image->columns != 0) && (image->rows != 0))
 240           {
 241             if ((width < image->columns) && (height < image->rows))
 242               low=draw_info->pointsize+1.0;
 243             else
 244               high=draw_info->pointsize-1.0;
 245           }
 246         else
 247           if (((image->columns != 0) && (width < image->columns)) ||
 248               ((image->rows != 0) && (height < image->rows)))
 249             low=draw_info->pointsize+1.0;
 250           else
 251             high=draw_info->pointsize-1.0;
 252       }
 253       draw_info->pointsize=(low+high)/2.0-1.0;
 254     }
 255   (void) CloneString(&draw_info->text,caption);
 256   i=FormatMagickCaption(image,draw_info,MagickFalse,&metrics,&caption,
 257     exception);
 258   if (SetImageBackgroundColor(image,exception) == MagickFalse)
 259     {
 260       image=DestroyImageList(image);
 261       return((Image *) NULL);
 262     }
 263   /*
 264     Draw caption.
 265   */
 266   (void) CloneString(&draw_info->text,caption);
 267   status=GetMultilineTypeMetrics(image,draw_info,&metrics,exception);
 268   if ((draw_info->gravity != UndefinedGravity) &&
 269       (draw_info->direction != RightToLeftDirection))
 270     image->page.x=(ssize_t) (metrics.bounds.x1-draw_info->stroke_width/2.0);
 271   else
 272     {
 273       (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 274         -metrics.bounds.x1+draw_info->stroke_width/2.0,metrics.ascent+
 275         draw_info->stroke_width/2.0);
 276       if (draw_info->direction == RightToLeftDirection)
 277         (void) FormatLocaleString(geometry,MaxTextExtent,"%+g%+g",
 278           image->columns-(metrics.bounds.x2+draw_info->stroke_width/2.0),
 279           metrics.ascent+draw_info->stroke_width/2.0);
 280       draw_info->geometry=AcquireString(geometry);
 281     }
 282   status=AnnotateImage(image,draw_info,exception);
 283   draw_info=DestroyDrawInfo(draw_info);
 284   caption=DestroyString(caption);
 285   if (status == MagickFalse)
 286     {
 287       image=DestroyImageList(image);
 288       return((Image *) NULL);
 289     }
 290   return(GetFirstImageInList(image));
 291 }
 292 \f
 293 /*
 294 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 295 %                                                                             %
 296 %                                                                             %
 297 %                                                                             %
 298 %   R e g i s t e r C A P T I O N I m a g e                                   %
 299 %                                                                             %
 300 %                                                                             %
 301 %                                                                             %
 302 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 303 %
 304 %  RegisterCAPTIONImage() adds attributes for the CAPTION image format to
 305 %  the list of supported formats.  The attributes include the image format
 306 %  tag, a method to read and/or write the format, whether the format
 307 %  supports the saving of more than one frame to the same file or blob,
 308 %  whether the format supports native in-memory I/O, and a brief
 309 %  description of the format.
 310 %
 311 %  The format of the RegisterCAPTIONImage method is:
 312 %
 313 %      size_t RegisterCAPTIONImage(void)
 314 %
 315 */
 316 ModuleExport size_t RegisterCAPTIONImage(void)
 317 {
 318   MagickInfo
 319     *entry;
 320
 321   entry=SetMagickInfo("CAPTION");
 322   entry->decoder=(DecodeImageHandler *) ReadCAPTIONImage;
 323   entry->description=ConstantString("Caption");
 324   entry->adjoin=MagickFalse;
 325   entry->module=ConstantString("CAPTION");
 326   (void) RegisterMagickInfo(entry);
 327   return(MagickImageCoderSignature);
 328 }
 329 \f
 330 /*
 331 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 332 %                                                                             %
 333 %                                                                             %
 334 %                                                                             %
 335 %   U n r e g i s t e r C A P T I O N I m a g e                               %
 336 %                                                                             %
 337 %                                                                             %
 338 %                                                                             %
 339 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 340 %
 341 %  UnregisterCAPTIONImage() removes format registrations made by the
 342 %  CAPTION module from the list of supported formats.
 343 %
 344 %  The format of the UnregisterCAPTIONImage method is:
 345 %
 346 %      UnregisterCAPTIONImage(void)
 347 %
 348 */
 349 ModuleExport void UnregisterCAPTIONImage(void)
 350 {
 351   (void) UnregisterMagickInfo("CAPTION");
 352 }