2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % DDDD EEEEE BBBB U U GGGG %
8 % D D EEE BBBB U U G GG %
10 % DDDD EEEEE BBBB UUU GGG %
13 % Image Pixel Values for Debugging. %
20 % Copyright 1999-2010 ImageMagick Studio LLC, a non-profit organization %
21 % dedicated to making software imaging solutions freely available. %
23 % You may not use this file except in compliance with the License. You may %
24 % obtain a copy of the License at %
26 % http://www.imagemagick.org/script/license.php %
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. %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "magick/studio.h"
43 #include "magick/annotate.h"
44 #include "magick/attribute.h"
45 #include "magick/blob.h"
46 #include "magick/blob-private.h"
47 #include "magick/cache.h"
48 #include "magick/color.h"
49 #include "magick/color-private.h"
50 #include "magick/colorspace.h"
51 #include "magick/constitute.h"
52 #include "magick/draw.h"
53 #include "magick/exception.h"
54 #include "magick/exception-private.h"
55 #include "magick/geometry.h"
56 #include "magick/image.h"
57 #include "magick/image-private.h"
58 #include "magick/list.h"
59 #include "magick/magick.h"
60 #include "magick/memory_.h"
61 #include "magick/monitor.h"
62 #include "magick/monitor-private.h"
63 #include "magick/option.h"
64 #include "magick/pixel-private.h"
65 #include "magick/quantum-private.h"
66 #include "magick/static.h"
67 #include "magick/statistic.h"
68 #include "magick/string_.h"
69 #include "magick/module.h"
74 static MagickBooleanType
75 WriteDEBUGImage(const ImageInfo *,Image *);
78 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
82 % R e g i s t e r D E B U G I m a g e %
86 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
88 % RegisterDEBUGImage() adds attributes for the DEBUG image format to the
89 % list of supported formats. The attributes include the image format
90 % tag, a method to read and/or write the format, whether the format
91 % supports the saving of more than one frame to the same file or blob,
92 % whether the format supports native in-memory I/O, and a brief
93 % description of the format.
95 % The format of the RegisterDEBUGImage method is:
97 % size_t RegisterDEBUGImage(void)
100 ModuleExport size_t RegisterDEBUGImage(void)
105 entry=SetMagickInfo("DEBUG");
106 entry->encoder=(EncodeImageHandler *) WriteDEBUGImage;
107 entry->raw=MagickTrue;
108 entry->stealth=MagickTrue;
109 entry->description=ConstantString("Image pixel values for debugging");
110 entry->module=ConstantString("DEBUG");
111 (void) RegisterMagickInfo(entry);
112 return(MagickImageCoderSignature);
116 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
120 % U n r e g i s t e r D E B U G I m a g e %
124 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
126 % UnregisterDEBUGImage() removes format registrations made by the
127 % DEBUG module from the list of supported format.
129 % The format of the UnregisterDEBUGImage method is:
131 % UnregisterDEBUGImage(void)
134 ModuleExport void UnregisterDEBUGImage(void)
136 (void) UnregisterMagickInfo("DEBUG");
140 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
144 % W r i t e D E B U G I m a g e %
148 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
150 % WriteDEBUGImage writes the image pixel values with 20 places of precision.
152 % The format of the WriteDEBUGImage method is:
154 % MagickBooleanType WriteDEBUGImage(const ImageInfo *image_info,
157 % A description of each parameter follows.
159 % o image_info: the image info.
161 % o image: The image.
164 static MagickBooleanType WriteDEBUGImage(const ImageInfo *image_info,
168 buffer[MaxTextExtent],
169 colorspace[MaxTextExtent],
170 tuple[MaxTextExtent];
184 register const IndexPacket
187 register const PixelPacket
194 Open output image file.
196 assert(image_info != (const ImageInfo *) NULL);
197 assert(image_info->signature == MagickSignature);
198 assert(image != (Image *) NULL);
199 assert(image->signature == MagickSignature);
200 if (image->debug != MagickFalse)
201 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
202 status=OpenBlob(image_info,image,WriteBlobMode,&image->exception);
203 if (status == MagickFalse)
208 (void) CopyMagickString(colorspace,MagickOptionToMnemonic(
209 MagickColorspaceOptions,(ssize_t) image->colorspace),MaxTextExtent);
210 LocaleLower(colorspace);
211 image->depth=GetImageQuantumDepth(image,MagickTrue);
212 if (image->matte != MagickFalse)
213 (void) ConcatenateMagickString(colorspace,"a",MaxTextExtent);
214 (void) FormatMagickString(buffer,MaxTextExtent,
215 "# ImageMagick pixel debugging: %.20g,%.20g,%.20g,%s\n",(double)
216 image->columns,(double) image->rows,(double)
217 GetQuantumRange(image->depth),colorspace);
218 (void) WriteBlobString(image,buffer);
219 GetMagickPixelPacket(image,&pixel);
220 for (y=0; y < (ssize_t) image->rows; y++)
222 p=GetVirtualPixels(image,0,y,image->columns,1,&image->exception);
223 if (p == (const PixelPacket *) NULL)
225 indexes=GetVirtualIndexQueue(image);
226 for (x=0; x < (ssize_t) image->columns; x++)
228 (void) FormatMagickString(buffer,MaxTextExtent,"%.20g,%.20g: ",(double)
230 (void) WriteBlobString(image,buffer);
231 SetMagickPixelPacket(image,p,indexes+x,&pixel);
232 (void) FormatMagickString(tuple,MaxTextExtent,"%.20g,%.20g,%.20g ",
233 (double) pixel.red,(double) pixel.green,(double) pixel.blue);
234 if (pixel.colorspace == CMYKColorspace)
237 black[MaxTextExtent];
239 (void) FormatMagickString(black,MaxTextExtent,",%.20g ",
240 (double) pixel.index);
241 (void) ConcatenateMagickString(tuple,black,MaxTextExtent);
243 if (pixel.matte != MagickFalse)
246 alpha[MaxTextExtent];
248 (void) FormatMagickString(alpha,MaxTextExtent,",%.20g ",
249 (double) (QuantumRange-pixel.opacity));
250 (void) ConcatenateMagickString(tuple,alpha,MaxTextExtent);
252 (void) WriteBlobString(image,tuple);
253 (void) WriteBlobString(image,"\n");
256 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
258 if (status == MagickFalse)
261 if (GetNextImageInList(image) == (Image *) NULL)
263 image=SyncNextImageInList(image);
264 status=SetImageProgress(image,SaveImagesTag,scene++,
265 GetImageListLength(image));
266 if (status == MagickFalse)
268 } while (image_info->adjoin != MagickFalse);
269 (void) CloseBlob(image);