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-2012 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 "MagickCore/studio.h"
43 #include "MagickCore/annotate.h"
44 #include "MagickCore/attribute.h"
45 #include "MagickCore/blob.h"
46 #include "MagickCore/blob-private.h"
47 #include "MagickCore/cache.h"
48 #include "MagickCore/color.h"
49 #include "MagickCore/color-private.h"
50 #include "MagickCore/colorspace.h"
51 #include "MagickCore/constitute.h"
52 #include "MagickCore/draw.h"
53 #include "MagickCore/exception.h"
54 #include "MagickCore/exception-private.h"
55 #include "MagickCore/geometry.h"
56 #include "MagickCore/image.h"
57 #include "MagickCore/image-private.h"
58 #include "MagickCore/list.h"
59 #include "MagickCore/magick.h"
60 #include "MagickCore/memory_.h"
61 #include "MagickCore/monitor.h"
62 #include "MagickCore/monitor-private.h"
63 #include "MagickCore/option.h"
64 #include "MagickCore/pixel-accessor.h"
65 #include "MagickCore/quantum-private.h"
66 #include "MagickCore/static.h"
67 #include "MagickCore/statistic.h"
68 #include "MagickCore/string_.h"
69 #include "MagickCore/module.h"
74 static MagickBooleanType
75 WriteDEBUGImage(const ImageInfo *,Image *,ExceptionInfo *);
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,
155 % Image *image,ExceptionInfo *exception)
157 % A description of each parameter follows.
159 % o image_info: the image info.
161 % o image: The image.
163 % o exception: return any errors or warnings in this structure.
166 static MagickBooleanType WriteDEBUGImage(const ImageInfo *image_info,
167 Image *image,ExceptionInfo *exception)
170 buffer[MaxTextExtent],
171 colorspace[MaxTextExtent],
172 tuple[MaxTextExtent];
186 register const Quantum
193 Open output image file.
195 assert(image_info != (const ImageInfo *) NULL);
196 assert(image_info->signature == MagickSignature);
197 assert(image != (Image *) NULL);
198 assert(image->signature == MagickSignature);
199 if (image->debug != MagickFalse)
200 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
201 status=OpenBlob(image_info,image,WriteBlobMode,exception);
202 if (status == MagickFalse)
207 (void) CopyMagickString(colorspace,CommandOptionToMnemonic(
208 MagickColorspaceOptions,(ssize_t) image->colorspace),MaxTextExtent);
209 LocaleLower(colorspace);
210 image->depth=GetImageQuantumDepth(image,MagickTrue);
211 if (image->matte != MagickFalse)
212 (void) ConcatenateMagickString(colorspace,"a",MaxTextExtent);
213 (void) FormatLocaleString(buffer,MaxTextExtent,
214 "# ImageMagick pixel debugging: %.20g,%.20g,%.20g,%s\n",(double)
215 image->columns,(double) image->rows,(double) ((MagickOffsetType)
216 GetQuantumRange(image->depth)),colorspace);
217 (void) WriteBlobString(image,buffer);
218 GetPixelInfo(image,&pixel);
219 for (y=0; y < (ssize_t) image->rows; y++)
221 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
222 if (p == (const Quantum *) NULL)
224 for (x=0; x < (ssize_t) image->columns; x++)
226 (void) FormatLocaleString(buffer,MaxTextExtent,"%.20g,%.20g: ",(double)
228 (void) WriteBlobString(image,buffer);
229 GetPixelInfoPixel(image,p,&pixel);
230 (void) FormatLocaleString(tuple,MaxTextExtent,"%.20g,%.20g,%.20g ",
231 (double) pixel.red,(double) pixel.green,(double) pixel.blue);
232 if (pixel.colorspace == CMYKColorspace)
235 black[MaxTextExtent];
237 (void) FormatLocaleString(black,MaxTextExtent,",%.20g ",
238 (double) pixel.black);
239 (void) ConcatenateMagickString(tuple,black,MaxTextExtent);
241 if (pixel.matte != MagickFalse)
244 alpha[MaxTextExtent];
246 (void) FormatLocaleString(alpha,MaxTextExtent,",%.20g ",
247 (double) pixel.alpha);
248 (void) ConcatenateMagickString(tuple,alpha,MaxTextExtent);
250 (void) WriteBlobString(image,tuple);
251 (void) WriteBlobString(image,"\n");
252 p+=GetPixelChannels(image);
254 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
256 if (status == MagickFalse)
259 if (GetNextImageInList(image) == (Image *) NULL)
261 image=SyncNextImageInList(image);
262 status=SetImageProgress(image,SaveImagesTag,scene++,
263 GetImageListLength(image));
264 if (status == MagickFalse)
266 } while (image_info->adjoin != MagickFalse);
267 (void) CloseBlob(image);