debug.c revision 4c08aed51c5899665ade97263692328eea4af106
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% John Cristy % 17% July 1992 % 18% % 19% % 20% Copyright 1999-2011 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/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*/ 74static MagickBooleanType 75 WriteDEBUGImage(const ImageInfo *,Image *); 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*/ 100ModuleExport size_t RegisterDEBUGImage(void) 101{ 102 MagickInfo 103 *entry; 104 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); 113} 114 115/* 116%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 117% % 118% % 119% % 120% U n r e g i s t e r D E B U G I m a g e % 121% % 122% % 123% % 124%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 125% 126% UnregisterDEBUGImage() removes format registrations made by the 127% DEBUG module from the list of supported format. 128% 129% The format of the UnregisterDEBUGImage method is: 130% 131% UnregisterDEBUGImage(void) 132% 133*/ 134ModuleExport void UnregisterDEBUGImage(void) 135{ 136 (void) UnregisterMagickInfo("DEBUG"); 137} 138 139/* 140%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 141% % 142% % 143% % 144% W r i t e D E B U G I m a g e % 145% % 146% % 147% % 148%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 149% 150% WriteDEBUGImage writes the image pixel values with 20 places of precision. 151% 152% The format of the WriteDEBUGImage method is: 153% 154% MagickBooleanType WriteDEBUGImage(const ImageInfo *image_info, 155% Image *image) 156% 157% A description of each parameter follows. 158% 159% o image_info: the image info. 160% 161% o image: The image. 162% 163*/ 164static MagickBooleanType WriteDEBUGImage(const ImageInfo *image_info, 165 Image *image) 166{ 167 char 168 buffer[MaxTextExtent], 169 colorspace[MaxTextExtent], 170 tuple[MaxTextExtent]; 171 172 ssize_t 173 y; 174 175 MagickBooleanType 176 status; 177 178 MagickOffsetType 179 scene; 180 181 PixelInfo 182 pixel; 183 184 register const Quantum 185 *p; 186 187 register ssize_t 188 x; 189 190 /* 191 Open output image file. 192 */ 193 assert(image_info != (const ImageInfo *) NULL); 194 assert(image_info->signature == MagickSignature); 195 assert(image != (Image *) NULL); 196 assert(image->signature == MagickSignature); 197 if (image->debug != MagickFalse) 198 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename); 199 status=OpenBlob(image_info,image,WriteBlobMode,&image->exception); 200 if (status == MagickFalse) 201 return(status); 202 scene=0; 203 do 204 { 205 (void) CopyMagickString(colorspace,CommandOptionToMnemonic( 206 MagickColorspaceOptions,(ssize_t) image->colorspace),MaxTextExtent); 207 LocaleLower(colorspace); 208 image->depth=GetImageQuantumDepth(image,MagickTrue); 209 if (image->matte != MagickFalse) 210 (void) ConcatenateMagickString(colorspace,"a",MaxTextExtent); 211 (void) FormatLocaleString(buffer,MaxTextExtent, 212 "# ImageMagick pixel debugging: %.20g,%.20g,%.20g,%s\n",(double) 213 image->columns,(double) image->rows,(double) 214 ((MagickOffsetType) GetQuantumRange(image->depth)),colorspace); 215 (void) WriteBlobString(image,buffer); 216 GetPixelInfo(image,&pixel); 217 for (y=0; y < (ssize_t) image->rows; y++) 218 { 219 p=GetVirtualPixels(image,0,y,image->columns,1,&image->exception); 220 if (p == (const Quantum *) NULL) 221 break; 222 for (x=0; x < (ssize_t) image->columns; x++) 223 { 224 (void) FormatLocaleString(buffer,MaxTextExtent,"%.20g,%.20g: ",(double) 225 x,(double) y); 226 (void) WriteBlobString(image,buffer); 227 SetPixelInfo(image,p,&pixel); 228 (void) FormatLocaleString(tuple,MaxTextExtent,"%.20g,%.20g,%.20g ", 229 (double) pixel.red,(double) pixel.green,(double) pixel.blue); 230 if (pixel.colorspace == CMYKColorspace) 231 { 232 char 233 black[MaxTextExtent]; 234 235 (void) FormatLocaleString(black,MaxTextExtent,",%.20g ", 236 (double) pixel.black); 237 (void) ConcatenateMagickString(tuple,black,MaxTextExtent); 238 } 239 if (pixel.matte != MagickFalse) 240 { 241 char 242 alpha[MaxTextExtent]; 243 244 (void) FormatLocaleString(alpha,MaxTextExtent,",%.20g ", 245 (double) pixel.alpha); 246 (void) ConcatenateMagickString(tuple,alpha,MaxTextExtent); 247 } 248 (void) WriteBlobString(image,tuple); 249 (void) WriteBlobString(image,"\n"); 250 p+=GetPixelChannels(image); 251 } 252 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y, 253 image->rows); 254 if (status == MagickFalse) 255 break; 256 } 257 if (GetNextImageInList(image) == (Image *) NULL) 258 break; 259 image=SyncNextImageInList(image); 260 status=SetImageProgress(image,SaveImagesTag,scene++, 261 GetImageListLength(image)); 262 if (status == MagickFalse) 263 break; 264 } while (image_info->adjoin != MagickFalse); 265 (void) CloseBlob(image); 266 return(MagickTrue); 267} 268