// Copyright 2012 Google Inc. All Rights Reserved.

//

// Use of this source code is governed by a BSD-style license

// that can be found in the COPYING file in the root of the source

// tree. An additional intellectual property rights grant can be found

// in the file PATENTS. All contributing project authors may

// be found in the AUTHORS file in the root of the source tree.

// -----------------------------------------------------------------------------

//

// Author: Jyrki Alakuijala (jyrki@google.com)

//

// Models the histograms of literal and distance codes.

#ifndef WEBP_ENC_HISTOGRAM_ENC_H_

#define WEBP_ENC_HISTOGRAM_ENC_H_

#include "src/enc/backward_references_enc.h"

#include "src/webp/encode.h"

#include "src/webp/format_constants.h"

#include "src/webp/types.h"

#ifdef __cplusplus

extern "C" {

#endif

// Not a trivial literal symbol.

#define VP8L_NON_TRIVIAL_SYM ((uint16_t)(0xffff))

// A simple container for histograms of data.

typedef struct {

  // 'literal' contains green literal, palette-code and

  // copy-length-prefix histogram

  uint32_t* literal;        // Pointer to the allocated buffer for literal.

  uint32_t red[NUM_LITERAL_CODES];

  uint32_t blue[NUM_LITERAL_CODES];

  uint32_t alpha[NUM_LITERAL_CODES];

  // Backward reference prefix-code histogram.

  uint32_t distance[NUM_DISTANCE_CODES];

  int palette_code_bits;

  // The following members are only used within VP8LGetHistoImageSymbols.

  // Index of the unique value of a histogram if any, VP8L_NON_TRIVIAL_SYM

  // otherwise.

  uint16_t trivial_symbol[5];

  uint64_t bit_cost;        // Cached value of total bit cost.

  // Cached values of entropy costs: literal, red, blue, alpha, distance

  uint64_t costs[5];

  uint8_t is_used[5];       // 5 for literal, red, blue, alpha, distance

  uint16_t bin_id;          // entropy bin index.

} VP8LHistogram;

// Collection of histograms with fixed capacity, allocated as one

// big memory chunk. Can be destroyed by calling WebPSafeFree().

typedef struct {

  int size;         // number of slots currently in use

  int max_size;     // maximum capacity

  VP8LHistogram** histograms;

} VP8LHistogramSet;

// Create the histogram.

//

// The input data is the PixOrCopy data, which models the literals, stop

// codes and backward references (both distances and lengths).  Also: if

// palette_code_bits is >= 0, initialize the histogram with this value.

void VP8LHistogramCreate(VP8LHistogram* const h,

                         const VP8LBackwardRefs* const refs,

                         int palette_code_bits);

// Set the palette_code_bits and reset the stats.

// If init_arrays is true, the arrays are also filled with 0's.

void VP8LHistogramInit(VP8LHistogram* const h, int palette_code_bits,

                       int init_arrays);

// Collect all the references into a histogram (without reset)

// The distance modifier function is applied to the distance before

// the histogram is updated. It can be NULL.

void VP8LHistogramStoreRefs(const VP8LBackwardRefs* const refs,

                            int (*const distance_modifier)(int, int),

                            int distance_modifier_arg0,

                            VP8LHistogram* const histo);

// Free the memory allocated for the histogram.

void VP8LFreeHistogram(VP8LHistogram* const histo);

// Free the memory allocated for the histogram set.

void VP8LFreeHistogramSet(VP8LHistogramSet* const histo);

// Allocate an array of pointer to histograms, allocated and initialized

// using 'cache_bits'. Return NULL in case of memory error.

VP8LHistogramSet* VP8LAllocateHistogramSet(int size, int cache_bits);

// Set the histograms in set to 0.

void VP8LHistogramSetClear(VP8LHistogramSet* const set);

// Allocate and initialize histogram object with specified 'cache_bits'.

// Returns NULL in case of memory error.

// Special case of VP8LAllocateHistogramSet, with size equals 1.

VP8LHistogram* VP8LAllocateHistogram(int cache_bits);

static WEBP_INLINE int VP8LHistogramNumCodes(int palette_code_bits) {

  return NUM_LITERAL_CODES + NUM_LENGTH_CODES +

      ((palette_code_bits > 0) ? (1 << palette_code_bits) : 0);

}

Unexecuted instantiation: webp_enc.c:VP8LHistogramNumCodes

Unexecuted instantiation: alpha_enc.c:VP8LHistogramNumCodes

Unexecuted instantiation: vp8l_enc.c:VP8LHistogramNumCodes

Unexecuted instantiation: lossless_enc.c:VP8LHistogramNumCodes

Unexecuted instantiation: backward_references_enc.c:VP8LHistogramNumCodes

Unexecuted instantiation: histogram_enc.c:VP8LHistogramNumCodes

Unexecuted instantiation: near_lossless_enc.c:VP8LHistogramNumCodes

Unexecuted instantiation: predictor_enc.c:VP8LHistogramNumCodes

Unexecuted instantiation: backward_references_cost_enc.c:VP8LHistogramNumCodes

// Builds the histogram image. pic and percent are for progress.

// Returns false in case of error (stored in pic->error_code).

int VP8LGetHistoImageSymbols(int xsize, int ysize,

                             const VP8LBackwardRefs* const refs, int quality,

                             int low_effort, int histogram_bits, int cache_bits,

                             VP8LHistogramSet* const image_histo,

                             VP8LHistogram* const tmp_histo,

                             uint32_t* const histogram_symbols,

                             const WebPPicture* const pic, int percent_range,

                             int* const percent);

// Returns the entropy for the symbols in the input array.

uint64_t VP8LBitsEntropy(const uint32_t* const array, int n);

// Estimate how many bits the combined entropy of literals and distance

// approximately maps to.

uint64_t VP8LHistogramEstimateBits(const VP8LHistogram* const h);

#ifdef __cplusplus

}

#endif

#endif  // WEBP_ENC_HISTOGRAM_ENC_H_