uvg266/src/strategies/strategies-picture.h
Ari Koivula 947bae24f9 Update Doxygen documentation
Add module information to all header files.

Update all header file documentations to briefly say what they are, and
to use the javadoc format so the brief actually gets included into the
doxygen documentation.

Remove \file from implementation files, in order to not repeat the info
from the header files.

Add files under strategies and tools to Doxygen and update the Doxygen
settings to be just plain better.

Make README be the main page of Doxygen documentation.
2015-12-17 14:05:50 +02:00

159 lines
6.1 KiB
C

#ifndef STRATEGIES_PICTURE_H_
#define STRATEGIES_PICTURE_H_
/*****************************************************************************
* This file is part of Kvazaar HEVC encoder.
*
* Copyright (C) 2013-2015 Tampere University of Technology and others (see
* COPYING file).
*
* Kvazaar is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the
* Free Software Foundation; either version 2.1 of the License, or (at your
* option) any later version.
*
* Kvazaar is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with Kvazaar. If not, see <http://www.gnu.org/licenses/>.
****************************************************************************/
/**
* \ingroup Optimization
* \file
* Interface for distortion metric functions.
*/
#include "../image.h"
typedef kvz_pixel (*pred_buffer)[32 * 32];
// Function macro for defining hadamard calculating functions
// for fixed size blocks. They calculate hadamard for integer
// multiples of 8x8 with the 8x8 hadamard function.
#define SATD_NxN(suffix, n) \
/* Declare the function in advance, hopefully reducing the probability that the
* macro expands to something unexpected and silently breaks things. */ \
static cost_pixel_nxn_func satd_ ## n ## x ## n ## _ ## suffix;\
static unsigned satd_ ## n ## x ## n ## _ ## suffix ( \
const kvz_pixel * const block1, \
const kvz_pixel * const block2) \
{ \
unsigned sum = 0; \
for (unsigned y = 0; y < (n); y += 8) { \
unsigned row = y * (n); \
for (unsigned x = 0; x < (n); x += 8) { \
sum += satd_8x8_subblock_ ## suffix(&block1[row + x], (n), &block2[row + x], (n)); \
} \
} \
return sum >> (KVZ_BIT_DEPTH - 8); \
}
// Function macro for defining hadamard calculating functions for dynamic size
// blocks. They calculate hadamard for integer multiples of 8x8 with the 8x8
// hadamard function.
#define SATD_ANY_SIZE(suffix) \
static cost_pixel_any_size_func satd_any_size_ ## suffix; \
static unsigned satd_any_size_ ## suffix ( \
int width, int height, \
const kvz_pixel *block1, int stride1, \
const kvz_pixel *block2, int stride2) \
{ \
unsigned sum = 0; \
for (int y = 0; y < height; y += 8) { \
const kvz_pixel *row1 = &block1[y * stride1]; \
const kvz_pixel *row2 = &block2[y * stride2]; \
for (int x = 0; x < width; x += 8) { \
sum += satd_8x8_subblock_ ## suffix(&row1[x], stride1, &row2[x], stride2); \
} \
} \
return sum >> (KVZ_BIT_DEPTH - 8); \
}
typedef unsigned(reg_sad_func)(const kvz_pixel *const data1, const kvz_pixel *const data2,
const int width, const int height,
const unsigned stride1, const unsigned stride2);
typedef unsigned (cost_pixel_nxn_func)(const kvz_pixel *block1, const kvz_pixel *block2);
typedef unsigned (cost_pixel_any_size_func)(
int width, int height,
const kvz_pixel *block1, int stride1,
const kvz_pixel *block2, int stride2
);
typedef void (cost_pixel_nxn_multi_func)(const pred_buffer preds, const kvz_pixel *orig, unsigned num_modes, unsigned *costs_out);
typedef void pixels_blit_func(const kvz_pixel* orig, kvz_pixel *dst,
unsigned width, unsigned height,
unsigned orig_stride, unsigned dst_stride);
// Declare function pointers.
extern reg_sad_func * kvz_reg_sad;
extern cost_pixel_nxn_func * kvz_sad_4x4;
extern cost_pixel_nxn_func * kvz_sad_8x8;
extern cost_pixel_nxn_func * kvz_sad_16x16;
extern cost_pixel_nxn_func * kvz_sad_32x32;
extern cost_pixel_nxn_func * kvz_sad_64x64;
extern cost_pixel_nxn_func * kvz_satd_4x4;
extern cost_pixel_nxn_func * kvz_satd_8x8;
extern cost_pixel_nxn_func * kvz_satd_16x16;
extern cost_pixel_nxn_func * kvz_satd_32x32;
extern cost_pixel_nxn_func * kvz_satd_64x64;
extern cost_pixel_any_size_func *kvz_satd_any_size;
extern cost_pixel_nxn_multi_func * kvz_sad_4x4_dual;
extern cost_pixel_nxn_multi_func * kvz_sad_8x8_dual;
extern cost_pixel_nxn_multi_func * kvz_sad_16x16_dual;
extern cost_pixel_nxn_multi_func * kvz_sad_32x32_dual;
extern cost_pixel_nxn_multi_func * kvz_sad_64x64_dual;
extern cost_pixel_nxn_multi_func * kvz_satd_4x4_dual;
extern cost_pixel_nxn_multi_func * kvz_satd_8x8_dual;
extern cost_pixel_nxn_multi_func * kvz_satd_16x16_dual;
extern cost_pixel_nxn_multi_func * kvz_satd_32x32_dual;
extern cost_pixel_nxn_multi_func * kvz_satd_64x64_dual;
extern pixels_blit_func * kvz_pixels_blit;
int kvz_strategy_register_picture(void* opaque, uint8_t bitdepth);
cost_pixel_nxn_func * kvz_pixels_get_satd_func(unsigned n);
cost_pixel_nxn_func * kvz_pixels_get_sad_func(unsigned n);
cost_pixel_nxn_multi_func * kvz_pixels_get_satd_dual_func(unsigned n);
cost_pixel_nxn_multi_func * kvz_pixels_get_sad_dual_func(unsigned n);
#define STRATEGIES_PICTURE_EXPORTS \
{"reg_sad", (void**) &kvz_reg_sad}, \
{"sad_4x4", (void**) &kvz_sad_4x4}, \
{"sad_8x8", (void**) &kvz_sad_8x8}, \
{"sad_16x16", (void**) &kvz_sad_16x16}, \
{"sad_32x32", (void**) &kvz_sad_32x32}, \
{"sad_64x64", (void**) &kvz_sad_64x64}, \
{"satd_4x4", (void**) &kvz_satd_4x4}, \
{"satd_8x8", (void**) &kvz_satd_8x8}, \
{"satd_16x16", (void**) &kvz_satd_16x16}, \
{"satd_32x32", (void**) &kvz_satd_32x32}, \
{"satd_64x64", (void**) &kvz_satd_64x64}, \
{"satd_any_size", (void**) &kvz_satd_any_size}, \
{"sad_4x4_dual", (void**) &kvz_sad_4x4_dual}, \
{"sad_8x8_dual", (void**) &kvz_sad_8x8_dual}, \
{"sad_16x16_dual", (void**) &kvz_sad_16x16_dual}, \
{"sad_32x32_dual", (void**) &kvz_sad_32x32_dual}, \
{"sad_64x64_dual", (void**) &kvz_sad_64x64_dual}, \
{"satd_4x4_dual", (void**) &kvz_satd_4x4_dual}, \
{"satd_8x8_dual", (void**) &kvz_satd_8x8_dual}, \
{"satd_16x16_dual", (void**) &kvz_satd_16x16_dual}, \
{"satd_32x32_dual", (void**) &kvz_satd_32x32_dual}, \
{"satd_64x64_dual", (void**) &kvz_satd_64x64_dual}, \
{"pixels_blit", (void**) &kvz_pixels_blit}, \
#endif //STRATEGIES_PICTURE_H_