histogram.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. // Copyright 2012 Google Inc. All Rights Reserved.
  2. //
  3. // Use of this source code is governed by a BSD-style license
  4. // that can be found in the COPYING file in the root of the source
  5. // tree. An additional intellectual property rights grant can be found
  6. // in the file PATENTS. All contributing project authors may
  7. // be found in the AUTHORS file in the root of the source tree.
  8. // -----------------------------------------------------------------------------
  9. //
  10. // Author: Jyrki Alakuijala (jyrki@google.com)
  11. //
  12. // Models the histograms of literal and distance codes.
  13. #ifndef WEBP_ENC_HISTOGRAM_H_
  14. #define WEBP_ENC_HISTOGRAM_H_
  15. #include <assert.h>
  16. #include <stddef.h>
  17. #include <stdlib.h>
  18. #include <stdio.h>
  19. #include <string.h>
  20. #include "./backward_references.h"
  21. #include "../webp/format_constants.h"
  22. #include "../webp/types.h"
  23. #ifdef __cplusplus
  24. extern "C" {
  25. #endif
  26. // A simple container for histograms of data.
  27. typedef struct {
  28. // literal_ contains green literal, palette-code and
  29. // copy-length-prefix histogram
  30. uint32_t* literal_; // Pointer to the allocated buffer for literal.
  31. uint32_t red_[NUM_LITERAL_CODES];
  32. uint32_t blue_[NUM_LITERAL_CODES];
  33. uint32_t alpha_[NUM_LITERAL_CODES];
  34. // Backward reference prefix-code histogram.
  35. uint32_t distance_[NUM_DISTANCE_CODES];
  36. int palette_code_bits_;
  37. double bit_cost_; // cached value of VP8LHistogramEstimateBits(this)
  38. double literal_cost_; // Cached values of dominant entropy costs:
  39. double red_cost_; // literal, red & blue.
  40. double blue_cost_;
  41. } VP8LHistogram;
  42. // Collection of histograms with fixed capacity, allocated as one
  43. // big memory chunk. Can be destroyed by calling WebPSafeFree().
  44. typedef struct {
  45. int size; // number of slots currently in use
  46. int max_size; // maximum capacity
  47. VP8LHistogram** histograms;
  48. } VP8LHistogramSet;
  49. // Create the histogram.
  50. //
  51. // The input data is the PixOrCopy data, which models the literals, stop
  52. // codes and backward references (both distances and lengths). Also: if
  53. // palette_code_bits is >= 0, initialize the histogram with this value.
  54. void VP8LHistogramCreate(VP8LHistogram* const p,
  55. const VP8LBackwardRefs* const refs,
  56. int palette_code_bits);
  57. // Return the size of the histogram for a given palette_code_bits.
  58. int VP8LGetHistogramSize(int palette_code_bits);
  59. // Set the palette_code_bits and reset the stats.
  60. void VP8LHistogramInit(VP8LHistogram* const p, int palette_code_bits);
  61. // Collect all the references into a histogram (without reset)
  62. void VP8LHistogramStoreRefs(const VP8LBackwardRefs* const refs,
  63. VP8LHistogram* const histo);
  64. // Free the memory allocated for the histogram.
  65. void VP8LFreeHistogram(VP8LHistogram* const histo);
  66. // Free the memory allocated for the histogram set.
  67. void VP8LFreeHistogramSet(VP8LHistogramSet* const histo);
  68. // Allocate an array of pointer to histograms, allocated and initialized
  69. // using 'cache_bits'. Return NULL in case of memory error.
  70. VP8LHistogramSet* VP8LAllocateHistogramSet(int size, int cache_bits);
  71. // Allocate and initialize histogram object with specified 'cache_bits'.
  72. // Returns NULL in case of memory error.
  73. // Special case of VP8LAllocateHistogramSet, with size equals 1.
  74. VP8LHistogram* VP8LAllocateHistogram(int cache_bits);
  75. // Accumulate a token 'v' into a histogram.
  76. void VP8LHistogramAddSinglePixOrCopy(VP8LHistogram* const histo,
  77. const PixOrCopy* const v);
  78. // Estimate how many bits the combined entropy of literals and distance
  79. // approximately maps to.
  80. double VP8LHistogramEstimateBits(const VP8LHistogram* const p);
  81. // This function estimates the cost in bits excluding the bits needed to
  82. // represent the entropy code itself.
  83. double VP8LHistogramEstimateBitsBulk(const VP8LHistogram* const p);
  84. static WEBP_INLINE int VP8LHistogramNumCodes(int palette_code_bits) {
  85. return NUM_LITERAL_CODES + NUM_LENGTH_CODES +
  86. ((palette_code_bits > 0) ? (1 << palette_code_bits) : 0);
  87. }
  88. // Builds the histogram image.
  89. int VP8LGetHistoImageSymbols(int xsize, int ysize,
  90. const VP8LBackwardRefs* const refs,
  91. int quality, int histogram_bits, int cache_bits,
  92. VP8LHistogramSet* const image_in,
  93. uint16_t* const histogram_symbols);
  94. #ifdef __cplusplus
  95. }
  96. #endif
  97. #endif // WEBP_ENC_HISTOGRAM_H_