1 /*
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 % %
4 % %
5 % %
6 % DDDD EEEEE BBBB U U GGGG %
7 % D D E B B U U G %
8 % D D EEE BBBB U U G GG %
9 % D D E B B U U G G %
10 % DDDD EEEEE BBBB UUU GGG %
11 % %
12 % %
13 % Image Pixel Values for Debugging. %
14 % %
15 % Software Design %
16 % Cristy %
17 % July 1992 %
18 % %
19 % %
20 % Copyright 1999-2021 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 % https://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/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"
70
71 /*
72 Forward declarations.
73 */
74 static MagickBooleanType
75 WriteDEBUGImage(const ImageInfo *,Image *,ExceptionInfo *);
76
77 /*
78 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
79 % %
80 % %
81 % %
82 % R e g i s t e r D E B U G I m a g e %
83 % %
84 % %
85 % %
86 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
87 %
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.
94 %
95 % The format of the RegisterDEBUGImage method is:
96 %
97 % size_t RegisterDEBUGImage(void)
98 %
99 */
RegisterDEBUGImage(void)100 ModuleExport size_t RegisterDEBUGImage(void)
101 {
102 MagickInfo
103 *entry;
104
105 entry=AcquireMagickInfo("DEBUG","DEBUG","Image pixel values for debugging");
106 entry->encoder=(EncodeImageHandler *) WriteDEBUGImage;
107 entry->flags|=CoderRawSupportFlag;
108 entry->flags|=CoderStealthFlag;
109 (void) RegisterMagickInfo(entry);
110 return(MagickImageCoderSignature);
111 }
112
113 /*
114 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
115 % %
116 % %
117 % %
118 % U n r e g i s t e r D E B U G I m a g e %
119 % %
120 % %
121 % %
122 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
123 %
124 % UnregisterDEBUGImage() removes format registrations made by the
125 % DEBUG module from the list of supported format.
126 %
127 % The format of the UnregisterDEBUGImage method is:
128 %
129 % UnregisterDEBUGImage(void)
130 %
131 */
UnregisterDEBUGImage(void)132 ModuleExport void UnregisterDEBUGImage(void)
133 {
134 (void) UnregisterMagickInfo("DEBUG");
135 }
136
137 /*
138 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
139 % %
140 % %
141 % %
142 % W r i t e D E B U G I m a g e %
143 % %
144 % %
145 % %
146 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
147 %
148 % WriteDEBUGImage writes the image pixel values with 20 places of precision.
149 %
150 % The format of the WriteDEBUGImage method is:
151 %
152 % MagickBooleanType WriteDEBUGImage(const ImageInfo *image_info,
153 % Image *image,ExceptionInfo *exception)
154 %
155 % A description of each parameter follows.
156 %
157 % o image_info: the image info.
158 %
159 % o image: The image.
160 %
161 % o exception: return any errors or warnings in this structure.
162 %
163 */
WriteDEBUGImage(const ImageInfo * image_info,Image * image,ExceptionInfo * exception)164 static MagickBooleanType WriteDEBUGImage(const ImageInfo *image_info,
165 Image *image,ExceptionInfo *exception)
166 {
167 char
168 buffer[MagickPathExtent],
169 colorspace[MagickPathExtent],
170 tuple[MagickPathExtent];
171
172 ssize_t
173 y;
174
175 MagickBooleanType
176 status;
177
178 MagickOffsetType
179 scene;
180
181 PixelInfo
182 pixel;
183
184 const Quantum
185 *p;
186
187 ssize_t
188 x;
189
190 size_t
191 imageListLength;
192
193 /*
194 Open output image file.
195 */
196 assert(image_info != (const ImageInfo *) NULL);
197 assert(image_info->signature == MagickCoreSignature);
198 assert(image != (Image *) NULL);
199 assert(image->signature == MagickCoreSignature);
200 if (image->debug != MagickFalse)
201 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
202 status=OpenBlob(image_info,image,WriteBlobMode,exception);
203 if (status == MagickFalse)
204 return(status);
205 scene=0;
206 imageListLength=GetImageListLength(image);
207 do
208 {
209 (void) CopyMagickString(colorspace,CommandOptionToMnemonic(
210 MagickColorspaceOptions,(ssize_t) image->colorspace),MagickPathExtent);
211 LocaleLower(colorspace);
212 image->depth=GetImageQuantumDepth(image,MagickTrue);
213 if (image->alpha_trait != UndefinedPixelTrait)
214 (void) ConcatenateMagickString(colorspace,"a",MagickPathExtent);
215 (void) FormatLocaleString(buffer,MagickPathExtent,
216 "# ImageMagick pixel debugging: %.20g,%.20g,%.20g,%s\n",(double)
217 image->columns,(double) image->rows,(double) ((MagickOffsetType)
218 GetQuantumRange(image->depth)),colorspace);
219 (void) WriteBlobString(image,buffer);
220 GetPixelInfo(image,&pixel);
221 for (y=0; y < (ssize_t) image->rows; y++)
222 {
223 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
224 if (p == (const Quantum *) NULL)
225 break;
226 for (x=0; x < (ssize_t) image->columns; x++)
227 {
228 (void) FormatLocaleString(buffer,MagickPathExtent,"%.20g,%.20g: ",(double)
229 x,(double) y);
230 (void) WriteBlobString(image,buffer);
231 GetPixelInfoPixel(image,p,&pixel);
232 (void) FormatLocaleString(tuple,MagickPathExtent,"%.20g,%.20g,%.20g ",
233 (double) pixel.red,(double) pixel.green,(double) pixel.blue);
234 if (pixel.colorspace == CMYKColorspace)
235 {
236 char
237 black[MagickPathExtent];
238
239 (void) FormatLocaleString(black,MagickPathExtent,",%.20g ",
240 (double) pixel.black);
241 (void) ConcatenateMagickString(tuple,black,MagickPathExtent);
242 }
243 if (pixel.alpha_trait != UndefinedPixelTrait)
244 {
245 char
246 alpha[MagickPathExtent];
247
248 (void) FormatLocaleString(alpha,MagickPathExtent,",%.20g ",
249 (double) pixel.alpha);
250 (void) ConcatenateMagickString(tuple,alpha,MagickPathExtent);
251 }
252 (void) WriteBlobString(image,tuple);
253 (void) WriteBlobString(image,"\n");
254 p+=GetPixelChannels(image);
255 }
256 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
257 image->rows);
258 if (status == MagickFalse)
259 break;
260 }
261 if (GetNextImageInList(image) == (Image *) NULL)
262 break;
263 image=SyncNextImageInList(image);
264 status=SetImageProgress(image,SaveImagesTag,scene++,imageListLength);
265 if (status == MagickFalse)
266 break;
267 } while (image_info->adjoin != MagickFalse);
268 (void) CloseBlob(image);
269 return(MagickTrue);
270 }
271