granicus.if.org Git - imagemagick/blob - coders/histogram.c

   1 /*
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3 %                                                                             %
   4 %                                                                             %
   5 %                                                                             %
   6 %       H   H  IIIII  SSSSS  TTTTT   OOO    GGGG  RRRR    AAA   M   M         %
   7 %       H   H    I    SS       T    O   O  G      R   R  A   A  MM MM         %
   8 %       HHHHH    I     SSS     T    O   O  G  GG  RRRR   AAAAA  M M M         %
   9 %       H   H    I       SS    T    O   O  G   G  R R    A   A  M   M         %
  10 %       H   H  IIIII  SSSSS    T     OOO    GGG   R  R   A   A  M   M         %
  11 %                                                                             %
  12 %                                                                             %
  13 %                          Write A Histogram Image.                           %
  14 %                                                                             %
  15 %                              Software Design                                %
  16 %                                   Cristy                                    %
  17 %                                 July 1992                                   %
  18 %                                                                             %
  19 %                                                                             %
  20 %  Copyright 1999-2014 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 \f
  39 /*
  40   Include declarations.
  41 */
  42 #include "MagickCore/studio.h"
  43 #include "MagickCore/artifact.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/constitute.h"
  50 #include "MagickCore/exception.h"
  51 #include "MagickCore/exception-private.h"
  52 #include "MagickCore/geometry.h"
  53 #include "MagickCore/histogram.h"
  54 #include "MagickCore/image-private.h"
  55 #include "MagickCore/magick.h"
  56 #include "MagickCore/memory_.h"
  57 #include "MagickCore/monitor.h"
  58 #include "MagickCore/monitor-private.h"
  59 #include "MagickCore/option.h"
  60 #include "MagickCore/pixel-accessor.h"
  61 #include "MagickCore/property.h"
  62 #include "MagickCore/quantum-private.h"
  63 #include "MagickCore/resource_.h"
  64 #include "MagickCore/static.h"
  65 #include "MagickCore/statistic.h"
  66 #include "MagickCore/string_.h"
  67 #include "MagickCore/module.h"
  68 #include "MagickCore/token.h"
  69 #include "MagickCore/utility.h"
  70 \f
  71 /*
  72   Forward declarations.
  73 */
  74 static MagickBooleanType
  75   WriteHISTOGRAMImage(const ImageInfo *,Image *,ExceptionInfo *);
  76 \f
  77 /*
  78 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  79 %                                                                             %
  80 %                                                                             %
  81 %                                                                             %
  82 %   R e g i s t e r H I S T O G R A M I m a g e                               %
  83 %                                                                             %
  84 %                                                                             %
  85 %                                                                             %
  86 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  87 %
  88 %  RegisterHISTOGRAMImage() adds attributes for the Histogram image format
  89 %  to the 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 RegisterHISTOGRAMImage method is:
  96 %
  97 %      size_t RegisterHISTOGRAMImage(void)
  98 %
  99 */
 100 ModuleExport size_t RegisterHISTOGRAMImage(void)
 101 {
 102   MagickInfo
 103     *entry;
 104
 105   entry=SetMagickInfo("HISTOGRAM");
 106   entry->encoder=(EncodeImageHandler *) WriteHISTOGRAMImage;
 107   entry->adjoin=MagickFalse;
 108   entry->format_type=ImplicitFormatType;
 109   entry->description=ConstantString("Histogram of the image");
 110   entry->module=ConstantString("HISTOGRAM");
 111   (void) RegisterMagickInfo(entry);
 112   return(MagickImageCoderSignature);
 113 }
 114 \f
 115 /*
 116 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 117 %                                                                             %
 118 %                                                                             %
 119 %                                                                             %
 120 %   U n r e g i s t e r H I S T O G R A M I m a g e                           %
 121 %                                                                             %
 122 %                                                                             %
 123 %                                                                             %
 124 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 125 %
 126 %  UnregisterHISTOGRAMImage() removes format registrations made by the
 127 %  HISTOGRAM module from the list of supported formats.
 128 %
 129 %  The format of the UnregisterHISTOGRAMImage method is:
 130 %
 131 %      UnregisterHISTOGRAMImage(void)
 132 %
 133 */
 134 ModuleExport void UnregisterHISTOGRAMImage(void)
 135 {
 136   (void) UnregisterMagickInfo("HISTOGRAM");
 137 }
 138 \f
 139 /*
 140 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 141 %                                                                             %
 142 %                                                                             %
 143 %                                                                             %
 144 %   W r i t e H I S T O G R A M I m a g e                                     %
 145 %                                                                             %
 146 %                                                                             %
 147 %                                                                             %
 148 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 149 %
 150 %  WriteHISTOGRAMImage() writes an image to a file in Histogram format.
 151 %  The image shows a histogram of the color (or gray) values in the image.  The
 152 %  image consists of three overlaid histograms:  a red one for the red channel,
 153 %  a green one for the green channel, and a blue one for the blue channel.  The
 154 %  image comment contains a list of unique pixel values and the number of times
 155 %  each occurs in the image.
 156 %
 157 %  This method is strongly based on a similar one written by
 158 %  muquit@warm.semcor.com which in turn is based on ppmhistmap of netpbm.
 159 %
 160 %  The format of the WriteHISTOGRAMImage method is:
 161 %
 162 %      MagickBooleanType WriteHISTOGRAMImage(const ImageInfo *image_info,
 163 %        Image *image,ExceptionInfo *exception)
 164 %
 165 %  A description of each parameter follows.
 166 %
 167 %    o image_info: the image info.
 168 %
 169 %    o image:  The image.
 170 %
 171 %    o exception: return any errors or warnings in this structure.
 172 %
 173 */
 174
 175 static inline size_t MagickMax(const size_t x,const size_t y)
 176 {
 177   if (x > y)
 178     return(x);
 179   return(y);
 180 }
 181
 182 static MagickBooleanType WriteHISTOGRAMImage(const ImageInfo *image_info,
 183   Image *image,ExceptionInfo *exception)
 184 {
 185 #define HistogramDensity  "256x200"
 186
 187   char
 188     filename[MaxTextExtent];
 189
 190   const char
 191     *option;
 192
 193   Image
 194     *histogram_image;
 195
 196   ImageInfo
 197     *write_info;
 198
 199   MagickBooleanType
 200     status;
 201
 202   PixelInfo
 203     *histogram;
 204
 205   double
 206     maximum,
 207     scale;
 208
 209   RectangleInfo
 210     geometry;
 211
 212   register const Quantum
 213     *p;
 214
 215   register Quantum
 216     *q,
 217     *r;
 218
 219   register ssize_t
 220     x;
 221
 222   size_t
 223     length;
 224
 225   ssize_t
 226     y;
 227
 228   /*
 229     Allocate histogram image.
 230   */
 231   assert(image_info != (const ImageInfo *) NULL);
 232   assert(image_info->signature == MagickSignature);
 233   assert(image != (Image *) NULL);
 234   assert(image->signature == MagickSignature);
 235   if (image->debug != MagickFalse)
 236     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
 237       image_info->filename);
 238   SetGeometry(image,&geometry);
 239   if (image_info->density == (char *) NULL)
 240     (void) ParseAbsoluteGeometry(HistogramDensity,&geometry);
 241   else
 242     (void) ParseAbsoluteGeometry(image_info->density,&geometry);
 243   histogram_image=CloneImage(image,geometry.width,geometry.height,MagickTrue,
 244     exception);
 245   if (histogram_image == (Image *) NULL)
 246     ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
 247   (void) SetImageStorageClass(histogram_image,DirectClass,exception);
 248   /*
 249     Allocate histogram count arrays.
 250   */
 251   length=MagickMax((size_t) ScaleQuantumToChar(QuantumRange)+1UL,
 252     histogram_image->columns);
 253   histogram=(PixelInfo *) AcquireQuantumMemory(length,sizeof(*histogram));
 254   if (histogram == (PixelInfo *) NULL)
 255     {
 256       histogram_image=DestroyImage(histogram_image);
 257       ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
 258     }
 259   /*
 260     Initialize histogram count arrays.
 261   */
 262   (void) ResetMagickMemory(histogram,0,length*sizeof(*histogram));
 263   for (y=0; y < (ssize_t) image->rows; y++)
 264   {
 265     p=GetVirtualPixels(image,0,y,image->columns,1,exception);
 266     if (p == (const Quantum *) NULL)
 267       break;
 268     for (x=0; x < (ssize_t) image->columns; x++)
 269     {
 270       if ((GetPixelRedTraits(image) & UpdatePixelTrait) != 0)
 271         histogram[ScaleQuantumToChar(GetPixelRed(image,p))].red++;
 272       if ((GetPixelGreenTraits(image) & UpdatePixelTrait) != 0)
 273         histogram[ScaleQuantumToChar(GetPixelGreen(image,p))].green++;
 274       if ((GetPixelBlueTraits(image) & UpdatePixelTrait) != 0)
 275         histogram[ScaleQuantumToChar(GetPixelBlue(image,p))].blue++;
 276       p+=GetPixelChannels(image);
 277     }
 278   }
 279   maximum=histogram[0].red;
 280   for (x=0; x < (ssize_t) histogram_image->columns; x++)
 281   {
 282     if (((GetPixelRedTraits(image) & UpdatePixelTrait) != 0) &&
 283         (maximum < histogram[x].red))
 284       maximum=histogram[x].red;
 285     if (((GetPixelGreenTraits(image) & UpdatePixelTrait) != 0) &&
 286         (maximum < histogram[x].green))
 287       maximum=histogram[x].green;
 288     if (((GetPixelBlueTraits(image) & UpdatePixelTrait) != 0) &&
 289         (maximum < histogram[x].blue))
 290       maximum=histogram[x].blue;
 291   }
 292   scale=(double) histogram_image->rows/maximum;
 293   /*
 294     Initialize histogram image.
 295   */
 296   (void) QueryColorCompliance("#000000",AllCompliance,
 297     &histogram_image->background_color,exception);
 298   (void) SetImageBackgroundColor(histogram_image,exception);
 299   for (x=0; x < (ssize_t) histogram_image->columns; x++)
 300   {
 301     q=GetAuthenticPixels(histogram_image,x,0,1,histogram_image->rows,exception);
 302     if (q == (Quantum *) NULL)
 303       break;
 304     if ((GetPixelRedTraits(image) & UpdatePixelTrait) != 0)
 305       {
 306         y=(ssize_t) ceil(histogram_image->rows-scale*histogram[x].red-0.5);
 307         r=q+y*GetPixelChannels(histogram_image);
 308         for ( ; y < (ssize_t) histogram_image->rows; y++)
 309         {
 310           SetPixelRed(histogram_image,QuantumRange,r);
 311           r+=GetPixelChannels(histogram_image);
 312         }
 313       }
 314     if ((GetPixelGreenTraits(image) & UpdatePixelTrait) != 0)
 315       {
 316         y=(ssize_t) ceil(histogram_image->rows-scale*histogram[x].green-0.5);
 317         r=q+y*GetPixelChannels(histogram_image);
 318         for ( ; y < (ssize_t) histogram_image->rows; y++)
 319         {
 320           SetPixelGreen(histogram_image,QuantumRange,r);
 321           r+=GetPixelChannels(histogram_image);
 322         }
 323       }
 324     if ((GetPixelBlueTraits(image) & UpdatePixelTrait) != 0)
 325       {
 326         y=(ssize_t) ceil(histogram_image->rows-scale*histogram[x].blue-0.5);
 327         r=q+y*GetPixelChannels(histogram_image);
 328         for ( ; y < (ssize_t) histogram_image->rows; y++)
 329         {
 330           SetPixelBlue(histogram_image,QuantumRange,r);
 331           r+=GetPixelChannels(histogram_image);
 332         }
 333       }
 334     if (SyncAuthenticPixels(histogram_image,exception) == MagickFalse)
 335       break;
 336     status=SetImageProgress(image,SaveImageTag,y,histogram_image->rows);
 337     if (status == MagickFalse)
 338       break;
 339   }
 340   histogram=(PixelInfo *) RelinquishMagickMemory(histogram);
 341   option=GetImageOption(image_info,"histogram:unique-colors");
 342   if ((option == (const char *) NULL) || (IsStringTrue(option) != MagickFalse))
 343     {
 344       FILE
 345         *file;
 346
 347       int
 348         unique_file;
 349
 350       /*
 351         Add a unique colors as an image comment.
 352       */
 353       file=(FILE *) NULL;
 354       unique_file=AcquireUniqueFileResource(filename);
 355       if (unique_file != -1)
 356         file=fdopen(unique_file,"wb");
 357       if ((unique_file != -1) && (file != (FILE *) NULL))
 358         {
 359           char
 360             *property;
 361
 362           (void) GetNumberColors(image,file,exception);
 363           (void) fclose(file);
 364           property=FileToString(filename,~0UL,exception);
 365           if (property != (char *) NULL)
 366             {
 367               (void) SetImageProperty(histogram_image,"comment",property,
 368                 exception);
 369               property=DestroyString(property);
 370             }
 371         }
 372       (void) RelinquishUniqueFileResource(filename);
 373     }
 374   /*
 375     Write Histogram image.
 376   */
 377   (void) CopyMagickString(histogram_image->filename,image_info->filename,
 378     MaxTextExtent);
 379   write_info=CloneImageInfo(image_info);
 380   (void) SetImageInfo(write_info,1,exception);
 381   if (LocaleCompare(write_info->magick,"HISTOGRAM") == 0)
 382     (void) FormatLocaleString(histogram_image->filename,MaxTextExtent,"miff:%s",
 383       write_info->filename);
 384   status=WriteImage(write_info,histogram_image,exception);
 385   histogram_image=DestroyImage(histogram_image);
 386   write_info=DestroyImageInfo(write_info);
 387   return(status);
 388 }