root/ImageMagick/trunk/coders/caption.c

Revision 1, 11.1 KB (checked in by cristy, 3 months ago)


Line 
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-2009 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
39/*
40  Include declarations.
41*/
42#include "magick/studio.h"
43#include "magick/annotate.h"
44#include "magick/blob.h"
45#include "magick/blob-private.h"
46#include "magick/draw.h"
47#include "magick/exception.h"
48#include "magick/exception-private.h"
49#include "magick/image.h"
50#include "magick/image-private.h"
51#include "magick/list.h"
52#include "magick/magick.h"
53#include "magick/memory_.h"
54#include "magick/option.h"
55#include "magick/property.h"
56#include "magick/quantum-private.h"
57#include "magick/static.h"
58#include "magick/string_.h"
59#include "magick/module.h"
60
61/*
62%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
63%                                                                             %
64%                                                                             %
65%                                                                             %
66%   R e a d C A P T I O N I m a g e                                           %
67%                                                                             %
68%                                                                             %
69%                                                                             %
70%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
71%
72%  ReadCAPTIONImage() reads a CAPTION image file and returns it.  It
73%  allocates the memory necessary for the new Image structure and returns a
74%  pointer to the new image.
75%
76%  The format of the ReadCAPTIONImage method is:
77%
78%      Image *ReadCAPTIONImage(const ImageInfo *image_info,
79%        ExceptionInfo *exception)
80%
81%  A description of each parameter follows:
82%
83%    o image_info: the image info.
84%
85%    o exception: return any errors or warnings in this structure.
86%
87*/
88static Image *ReadCAPTIONImage(const ImageInfo *image_info,
89  ExceptionInfo *exception)
90{
91  char
92    *caption,
93    geometry[MaxTextExtent],
94    *property;
95
96  const char
97    *gravity;
98
99  DrawInfo
100    *draw_info;
101
102  Image
103    *image;
104
105  MagickBooleanType
106    status;
107
108  register long
109    i;
110
111  TypeMetric
112    metrics;
113
114  unsigned long
115    height,
116    width;
117
118  /*
119    Initialize Image structure.
120  */
121  assert(image_info != (const ImageInfo *) NULL);
122  assert(image_info->signature == MagickSignature);
123  if (image_info->debug != MagickFalse)
124    (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
125      image_info->filename);
126  assert(exception != (ExceptionInfo *) NULL);
127  assert(exception->signature == MagickSignature);
128  image=AcquireImage(image_info);
129  if (image->columns == 0)
130    ThrowReaderException(OptionError,"MustSpecifyImageSize");
131  (void) ResetImagePage(image,"0x0+0+0");
132  /*
133    Format caption.
134  */
135  property=InterpretImageProperties(image_info,image,image_info->filename);
136  (void) SetImageProperty(image,"caption",property);
137  property=DestroyString(property);
138  caption=ConstantString(GetImageProperty(image,"caption"));
139  draw_info=CloneDrawInfo(image_info,(DrawInfo *) NULL);
140  draw_info->text=ConstantString(caption);
141  gravity=GetImageOption(image_info,"gravity");
142  if (gravity != (char *) NULL)
143    draw_info->gravity=(GravityType) ParseMagickOption(MagickGravityOptions,
144      MagickFalse,gravity);
145  if ((*caption != '\0') && (image->rows != 0) &&
146      (image_info->pointsize == 0.0))
147    {
148      char
149        *text;
150
151      /*
152        Scale text to fit bounding box.
153      */
154      for ( ; ; )
155      {
156        text=AcquireString(caption);
157        i=FormatMagickCaption(image,draw_info,&metrics,&text);
158        (void) CloneString(&draw_info->text,text);
159        text=DestroyString(text);
160        (void) FormatMagickString(geometry,MaxTextExtent,"%+g%+g",
161          -metrics.bounds.x1,metrics.ascent);
162        if (draw_info->gravity == UndefinedGravity)
163          (void) CloneString(&draw_info->geometry,geometry);
164        status=GetMultilineTypeMetrics(image,draw_info,&metrics);
165        width=(unsigned long) (metrics.width+draw_info->stroke_width+0.5);
166        height=(unsigned long) (metrics.height+draw_info->stroke_width+0.5);
167        if ((width > (image->columns+1)) || (height > (image->rows+1)))
168          break;
169        draw_info->pointsize*=2.0;
170      }
171      draw_info->pointsize/=2.0;
172      for ( ; ; )
173      {
174        text=AcquireString(caption);
175        i=FormatMagickCaption(image,draw_info,&metrics,&text);
176        (void) CloneString(&draw_info->text,text);
177        text=DestroyString(text);
178        (void) FormatMagickString(geometry,MaxTextExtent,"%+g%+g",
179          -metrics.bounds.x1,metrics.ascent);
180        if (draw_info->gravity == UndefinedGravity)
181          (void) CloneString(&draw_info->geometry,geometry);
182        status=GetMultilineTypeMetrics(image,draw_info,&metrics);
183        width=(unsigned long) (metrics.width+draw_info->stroke_width+0.5);
184        height=(unsigned long) (metrics.height+draw_info->stroke_width+0.5);
185        if ((width > (image->columns+1)) || (height > (image->rows+1)))
186          break;
187        draw_info->pointsize++;
188      }
189      draw_info->pointsize--;
190    }
191  i=FormatMagickCaption(image,draw_info,&metrics,&caption);
192  if (image->rows == 0)
193    image->rows=(unsigned long) ((i+1)*(metrics.ascent-metrics.descent+
194      draw_info->stroke_width)+0.5);
195  if (image->rows == 0)
196    image->rows=(unsigned long) ((i+1)*draw_info->pointsize+
197      draw_info->stroke_width+0.5);
198  (void) SetImageBackgroundColor(image);
199  /*
200    Draw caption.
201  */
202  (void) CloneString(&draw_info->text,caption);
203  status=GetMultilineTypeMetrics(image,draw_info,&metrics);
204  if (draw_info->gravity != UndefinedGravity)
205    image->page.x=(long) (metrics.bounds.x1-draw_info->stroke_width/2.0);
206  else
207    {
208      (void) FormatMagickString(geometry,MaxTextExtent,"%+g%+g",
209        -metrics.bounds.x1+draw_info->stroke_width/2.0,metrics.ascent+
210        draw_info->stroke_width/2.0);
211      (void) CloneString(&draw_info->geometry,geometry);
212    }
213  (void) AnnotateImage(image,draw_info);
214  draw_info=DestroyDrawInfo(draw_info);
215  caption=DestroyString(caption);
216  return(GetFirstImageInList(image));
217}
218
219/*
220%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
221%                                                                             %
222%                                                                             %
223%                                                                             %
224%   R e g i s t e r C A P T I O N I m a g e                                   %
225%                                                                             %
226%                                                                             %
227%                                                                             %
228%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
229%
230%  RegisterCAPTIONImage() adds attributes for the CAPTION image format to
231%  the list of supported formats.  The attributes include the image format
232%  tag, a method to read and/or write the format, whether the format
233%  supports the saving of more than one frame to the same file or blob,
234%  whether the format supports native in-memory I/O, and a brief
235%  description of the format.
236%
237%  The format of the RegisterCAPTIONImage method is:
238%
239%      unsigned long RegisterCAPTIONImage(void)
240%
241*/
242ModuleExport unsigned long RegisterCAPTIONImage(void)
243{
244  MagickInfo
245    *entry;
246
247  entry=SetMagickInfo("CAPTION");
248  entry->decoder=(DecodeImageHandler *) ReadCAPTIONImage;
249  entry->adjoin=MagickFalse;
250  entry->format_type=ExplicitFormatType;
251  entry->description=ConstantString("Image caption");
252  entry->module=ConstantString("CAPTION");
253  (void) RegisterMagickInfo(entry);
254  return(MagickImageCoderSignature);
255}
256
257/*
258%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
259%                                                                             %
260%                                                                             %
261%                                                                             %
262%   U n r e g i s t e r C A P T I O N I m a g e                               %
263%                                                                             %
264%                                                                             %
265%                                                                             %
266%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
267%
268%  UnregisterCAPTIONImage() removes format registrations made by the
269%  CAPTION module from the list of supported formats.
270%
271%  The format of the UnregisterCAPTIONImage method is:
272%
273%      UnregisterCAPTIONImage(void)
274%
275*/
276ModuleExport void UnregisterCAPTIONImage(void)
277{
278  (void) UnregisterMagickInfo("CAPTION");
279}
Note: See TracBrowser for help on using the browser.