uil.c revision 8941c70abb86cb5841cc745b991002d87eb09339 
1/*
2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3%                                                                             %
4%                                                                             %
5%                                                                             %
6%                            U   U  IIIII  L                                  %
7%                            U   U    I    L                                  %
8%                            U   U    I    L                                  %
9%                            U   U    I    L                                  %
10%                             UUU   IIIII  LLLLL                              %
11%                                                                             %
12%                                                                             %
13%                          Write X-Motif UIL Table.                           %
14%                                                                             %
15%                              Software Design                                %
16%                                John Cristy                                  %
17%                                 July 1992                                   %
18%                                                                             %
19%                                                                             %
20%  Copyright 1999-2012 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 "MagickCore/studio.h"
43#include "MagickCore/attribute.h"
44#include "MagickCore/blob.h"
45#include "MagickCore/blob-private.h"
46#include "MagickCore/cache.h"
47#include "MagickCore/color.h"
48#include "MagickCore/color-private.h"
49#include "MagickCore/colorspace.h"
50#include "MagickCore/colorspace-private.h"
51#include "MagickCore/exception.h"
52#include "MagickCore/exception-private.h"
53#include "MagickCore/image-private.h"
54#include "MagickCore/magick.h"
55#include "MagickCore/memory_.h"
56#include "MagickCore/monitor.h"
57#include "MagickCore/monitor-private.h"
58#include "MagickCore/pixel-accessor.h"
59#include "MagickCore/quantum-private.h"
60#include "MagickCore/static.h"
61#include "MagickCore/string_.h"
62#include "MagickCore/module.h"
63#include "MagickCore/utility.h"
64
65/*
66  Forward declarations.
67*/
68static MagickBooleanType
69  WriteUILImage(const ImageInfo *,Image *,ExceptionInfo *);
70
71/*
72%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
73%                                                                             %
74%                                                                             %
75%                                                                             %
76%   R e g i s t e r U I L I m a g e                                           %
77%                                                                             %
78%                                                                             %
79%                                                                             %
80%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
81%
82%  RegisterUILImage() adds attributes for the UIL image format to
83%  the list of supported formats.  The attributes include the image format
84%  tag, a method to read and/or write the format, whether the format
85%  supports the saving of more than one frame to the same file or blob,
86%  whether the format supports native in-memory I/O, and a brief
87%  description of the format.
88%
89%  The format of the RegisterUILImage method is:
90%
91%      size_t RegisterUILImage(void)
92%
93*/
94ModuleExport size_t RegisterUILImage(void)
95{
96  MagickInfo
97    *entry;
98
99  entry=SetMagickInfo("UIL");
100  entry->encoder=(EncodeImageHandler *) WriteUILImage;
101  entry->adjoin=MagickFalse;
102  entry->description=ConstantString("X-Motif UIL table");
103  entry->module=ConstantString("UIL");
104  (void) RegisterMagickInfo(entry);
105  return(MagickImageCoderSignature);
106}
107
108/*
109%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
110%                                                                             %
111%                                                                             %
112%                                                                             %
113%   U n r e g i s t e r U I L I m a g e                                       %
114%                                                                             %
115%                                                                             %
116%                                                                             %
117%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
118%
119%  UnregisterUILImage() removes format registrations made by the
120%  UIL module from the list of supported formats.
121%
122%  The format of the UnregisterUILImage method is:
123%
124%      UnregisterUILImage(void)
125%
126*/
127ModuleExport void UnregisterUILImage(void)
128{
129  (void) UnregisterMagickInfo("UIL");
130}
131
132/*
133%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
134%                                                                             %
135%                                                                             %
136%                                                                             %
137%   W r i t e U I L I m a g e                                                 %
138%                                                                             %
139%                                                                             %
140%                                                                             %
141%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
142%
143%  Procedure WriteUILImage() writes an image to a file in the X-Motif UIL table
144%  format.
145%
146%  The format of the WriteUILImage method is:
147%
148%      MagickBooleanType WriteUILImage(const ImageInfo *image_info,
149%        Image *image,ExceptionInfo *exception)
150%
151%  A description of each parameter follows.
152%
153%    o image_info: the image info.
154%
155%    o image:  The image.
156%
157%    o exception: return any errors or warnings in this structure.
158%
159*/
160static MagickBooleanType WriteUILImage(const ImageInfo *image_info,Image *image,
161  ExceptionInfo *exception)
162{
163#define MaxCixels  92
164
165  char
166    basename[MaxTextExtent],
167    buffer[MaxTextExtent],
168    name[MaxTextExtent],
169    *symbol;
170
171  int
172    j;
173
174  MagickBooleanType
175    status,
176    transparent;
177
178  MagickSizeType
179    number_pixels;
180
181  PixelInfo
182    pixel;
183
184  register const Quantum
185    *p;
186
187  register ssize_t
188    i,
189    x;
190
191  size_t
192    characters_per_pixel,
193    colors;
194
195  ssize_t
196    k,
197    y;
198
199  static const char
200    Cixel[MaxCixels+1] = " .XoO+@#$%&*=-;:>,<1234567890qwertyuipasdfghjk"
201                         "lzxcvbnmMNBVCZASDFGHJKLPIUYTREWQ!~^/()_`'][{}|";
202
203  /*
204    Open output image file.
205  */
206  assert(image_info != (const ImageInfo *) NULL);
207  assert(image_info->signature == MagickSignature);
208  assert(image != (Image *) NULL);
209  assert(image->signature == MagickSignature);
210  if (image->debug != MagickFalse)
211    (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
212  assert(exception != (ExceptionInfo *) NULL);
213  assert(exception->signature == MagickSignature);
214  status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
215  if (status == MagickFalse)
216    return(status);
217  if (IssRGBColorspace(image->colorspace) == MagickFalse)
218    (void) TransformImageColorspace(image,sRGBColorspace,exception);
219  transparent=MagickFalse;
220  i=0;
221  p=(const Quantum *) NULL;
222  if (image->storage_class == PseudoClass)
223    colors=image->colors;
224  else
225    {
226      unsigned char
227        *matte_image;
228
229      /*
230        Convert DirectClass to PseudoClass image.
231      */
232      matte_image=(unsigned char *) NULL;
233      if (image->matte != MagickFalse)
234        {
235          /*
236            Map all the transparent pixels.
237          */
238          number_pixels=(MagickSizeType) image->columns*image->rows;
239          if (number_pixels != ((MagickSizeType) (size_t) number_pixels))
240            ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
241          matte_image=(unsigned char *) AcquireQuantumMemory(image->columns,
242            image->rows*sizeof(*matte_image));
243          if (matte_image == (unsigned char *) NULL)
244            ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
245          for (y=0; y < (ssize_t) image->rows; y++)
246          {
247            p=GetVirtualPixels(image,0,y,image->columns,1,exception);
248            if (p == (const Quantum *) NULL)
249              break;
250            for (x=0; x < (ssize_t) image->columns; x++)
251            {
252              matte_image[i]=(unsigned char) (GetPixelAlpha(image,p) ==
253                (Quantum) TransparentAlpha ? 1 : 0);
254              if (matte_image[i] != 0)
255                transparent=MagickTrue;
256              i++;
257              p+=GetPixelChannels(image);
258            }
259          }
260        }
261      (void) SetImageType(image,PaletteType,exception);
262      colors=image->colors;
263      if (transparent != MagickFalse)
264        {
265          register Quantum
266            *q;
267
268          colors++;
269          for (y=0; y < (ssize_t) image->rows; y++)
270          {
271            q=GetAuthenticPixels(image,0,y,image->columns,1,exception);
272            if (q == (Quantum *) NULL)
273              break;
274            for (x=0; x < (ssize_t) image->columns; x++)
275            {
276              if (matte_image[i] != 0)
277                SetPixelIndex(image,image->colors,q);
278              p++;
279              q+=GetPixelChannels(image);
280            }
281          }
282        }
283      if (matte_image != (unsigned char *) NULL)
284        matte_image=(unsigned char *) RelinquishMagickMemory(matte_image);
285    }
286  /*
287    Compute the character per pixel.
288  */
289  characters_per_pixel=1;
290  for (k=MaxCixels; (ssize_t) colors > k; k*=MaxCixels)
291    characters_per_pixel++;
292  /*
293    UIL header.
294  */
295  symbol=AcquireString("");
296  (void) WriteBlobString(image,"/* UIL */\n");
297  GetPathComponent(image->filename,BasePath,basename);
298  (void) FormatLocaleString(buffer,MaxTextExtent,
299    "value\n  %s_ct : color_table(\n",basename);
300  (void) WriteBlobString(image,buffer);
301  GetPixelInfo(image,&pixel);
302  for (i=0; i < (ssize_t) colors; i++)
303  {
304    /*
305      Define UIL color.
306    */
307    pixel=image->colormap[i];
308    pixel.colorspace=sRGBColorspace;
309    pixel.depth=8;
310    pixel.alpha=(MagickRealType) OpaqueAlpha;
311    GetColorTuple(&pixel,MagickTrue,name);
312    if (transparent != MagickFalse)
313      if (i == (ssize_t) (colors-1))
314        (void) CopyMagickString(name,"None",MaxTextExtent);
315    /*
316      Write UIL color.
317    */
318    k=i % MaxCixels;
319    symbol[0]=Cixel[k];
320    for (j=1; j < (int) characters_per_pixel; j++)
321    {
322      k=((i-k)/MaxCixels) % MaxCixels;
323      symbol[j]=Cixel[k];
324    }
325    symbol[j]='\0';
326    (void) SubstituteString(&symbol,"'","''");
327    if (LocaleCompare(name,"None") == 0)
328      (void) FormatLocaleString(buffer,MaxTextExtent,
329        "    background color = '%s'",symbol);
330    else
331      (void) FormatLocaleString(buffer,MaxTextExtent,
332        "    color('%s',%s) = '%s'",name,
333        GetPixelInfoIntensity(image->colormap+i) <
334        (QuantumRange/2) ? "background" : "foreground",symbol);
335    (void) WriteBlobString(image,buffer);
336    (void) FormatLocaleString(buffer,MaxTextExtent,"%s",
337      (i == (ssize_t) (colors-1) ? ");\n" : ",\n"));
338    (void) WriteBlobString(image,buffer);
339  }
340  /*
341    Define UIL pixels.
342  */
343  GetPathComponent(image->filename,BasePath,basename);
344  (void) FormatLocaleString(buffer,MaxTextExtent,
345    "  %s_icon : icon(color_table = %s_ct,\n",basename,basename);
346  (void) WriteBlobString(image,buffer);
347  for (y=0; y < (ssize_t) image->rows; y++)
348  {
349    p=GetVirtualPixels(image,0,y,image->columns,1,exception);
350    if (p == (const Quantum *) NULL)
351      break;
352    (void) WriteBlobString(image,"    \"");
353    for (x=0; x < (ssize_t) image->columns; x++)
354    {
355      k=((ssize_t) GetPixelIndex(image,p) % MaxCixels);
356      symbol[0]=Cixel[k];
357      for (j=1; j < (int) characters_per_pixel; j++)
358      {
359        k=(((int) GetPixelIndex(image,p)-k)/MaxCixels) %
360          MaxCixels;
361        symbol[j]=Cixel[k];
362      }
363      symbol[j]='\0';
364      (void) CopyMagickString(buffer,symbol,MaxTextExtent);
365      (void) WriteBlobString(image,buffer);
366      p+=GetPixelChannels(image);
367    }
368    (void) FormatLocaleString(buffer,MaxTextExtent,"\"%s\n",
369      (y == (ssize_t) (image->rows-1) ? ");" : ","));
370    (void) WriteBlobString(image,buffer);
371    status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
372      image->rows);
373    if (status == MagickFalse)
374      break;
375  }
376  symbol=DestroyString(symbol);
377  (void) CloseBlob(image);
378  return(MagickTrue);
379}
380