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