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