Clarify comment about parity nibble.
[libav.git] / libpostproc / postprocess_internal.h
CommitLineData
c41d972d 1/*
b78e7197
DB
2 * Copyright (C) 2001-2002 Michael Niedermayer (michaelni@gmx.at)
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
c41d972d 20
b304569a
MN
21/**
22 * @file postprocess_internal.h
23 * internal api header.
24 */
25
5b21bdab
DB
26#ifndef FFMPEG_POSTPROCESS_INTERNAL_H
27#define FFMPEG_POSTPROCESS_INTERNAL_H
699b3f99 28
245976da 29#include "libavutil/avutil.h"
53eecfde 30#include "postprocess.h"
6ab6c7c3 31
bb270c08
DB
32#define V_DEBLOCK 0x01
33#define H_DEBLOCK 0x02
34#define DERING 0x04
35#define LEVEL_FIX 0x08 ///< Brightness & Contrast
36
37#define LUM_V_DEBLOCK V_DEBLOCK // 1
38#define LUM_H_DEBLOCK H_DEBLOCK // 2
39#define CHROM_V_DEBLOCK (V_DEBLOCK<<4) // 16
40#define CHROM_H_DEBLOCK (H_DEBLOCK<<4) // 32
41#define LUM_DERING DERING // 4
42#define CHROM_DERING (DERING<<4) // 64
43#define LUM_LEVEL_FIX LEVEL_FIX // 8
44#define CHROM_LEVEL_FIX (LEVEL_FIX<<4) // 128 (not implemented yet)
c41d972d
MN
45
46// Experimental vertical filters
bb270c08
DB
47#define V_X1_FILTER 0x0200 // 512
48#define V_A_DEBLOCK 0x0400
c41d972d
MN
49
50// Experimental horizontal filters
bb270c08
DB
51#define H_X1_FILTER 0x2000 // 8192
52#define H_A_DEBLOCK 0x4000
c41d972d 53
b304569a 54/// select between full y range (255-0) or standart one (234-16)
bb270c08 55#define FULL_Y_RANGE 0x8000 // 32768
c41d972d
MN
56
57//Deinterlacing Filters
16e0bf73
DB
58#define LINEAR_IPOL_DEINT_FILTER 0x10000 // 65536
59#define LINEAR_BLEND_DEINT_FILTER 0x20000 // 131072
60#define CUBIC_BLEND_DEINT_FILTER 0x8000 // (not implemented yet)
61#define CUBIC_IPOL_DEINT_FILTER 0x40000 // 262144
62#define MEDIAN_DEINT_FILTER 0x80000 // 524288
63#define FFMPEG_DEINT_FILTER 0x400000
64#define LOWPASS5_DEINT_FILTER 0x800000
c41d972d 65
bb270c08
DB
66#define TEMP_NOISE_FILTER 0x100000
67#define FORCE_QUANT 0x200000
c41d972d 68
755bfeab
DB
69//use if you want a faster postprocessing code
70//cannot differentiate between chroma & luma filters (both on or both off)
71//obviously the -pp option on the command line has no effect except turning the here selected
c41d972d
MN
72//filters on
73//#define COMPILE_TIME_MODE 0x77
74
134eb1e5 75static inline int CLIP(int a){
16e0bf73
DB
76 if(a&256) return ((a)>>31)^(-1);
77 else return a;
134eb1e5 78}
b304569a
MN
79/**
80 * Postprocessng filter.
81 */
c41d972d 82struct PPFilter{
16e0bf73
DB
83 const char *shortName;
84 const char *longName;
85 int chromDefault; ///< is chrominance filtering on by default if this filter is manually activated
86 int minLumQuality; ///< minimum quality to turn luminance filtering on
87 int minChromQuality; ///< minimum quality to turn chrominance filtering on
88 int mask; ///< Bitmask to turn this filter on
c41d972d
MN
89};
90
b304569a
MN
91/**
92 * Postprocessng mode.
93 */
c41d972d 94typedef struct PPMode{
16e0bf73
DB
95 int lumMode; ///< acivates filters for luminance
96 int chromMode; ///< acivates filters for chrominance
97 int error; ///< non zero on error
c41d972d 98
16e0bf73
DB
99 int minAllowedY; ///< for brigtness correction
100 int maxAllowedY; ///< for brihtness correction
101 float maxClippedThreshold; ///< amount of "black" u r willing to loose to get a brightness corrected picture
c41d972d 102
16e0bf73 103 int maxTmpNoise[3]; ///< for Temporal Noise Reducing filter (Maximal sum of abs differences)
c41d972d 104
16e0bf73
DB
105 int baseDcDiff;
106 int flatnessThreshold;
c41d972d 107
16e0bf73 108 int forcedQuant; ///< quantizer if FORCE_QUANT is used
c41d972d
MN
109} PPMode;
110
b304569a
MN
111/**
112 * postprocess context.
113 */
c41d972d 114typedef struct PPContext{
16e0bf73
DB
115 /**
116 * info on struct for av_log
117 */
118 const AVClass *av_class;
e7becfb2 119
16e0bf73 120 uint8_t *tempBlocks; ///<used for the horizontal code
c41d972d 121
16e0bf73
DB
122 /**
123 * luma histogram.
124 * we need 64bit here otherwise we'll going to have a problem
125 * after watching a black picture for 5 hours
126 */
127 uint64_t *yHistogram;
c41d972d 128
16e0bf73
DB
129 DECLARE_ALIGNED(8, uint64_t, packedYOffset);
130 DECLARE_ALIGNED(8, uint64_t, packedYScale);
c41d972d 131
16e0bf73 132 /** Temporal noise reducing buffers */
aa089f6c
DB
133 uint8_t *tempBlurred[3];
134 int32_t *tempBlurredPast[3];
c41d972d 135
16e0bf73
DB
136 /** Temporary buffers for handling the last row(s) */
137 uint8_t *tempDst;
138 uint8_t *tempSrc;
c41d972d 139
16e0bf73 140 uint8_t *deintTemp;
c41d972d 141
16e0bf73
DB
142 DECLARE_ALIGNED(8, uint64_t, pQPb);
143 DECLARE_ALIGNED(8, uint64_t, pQPb2);
c41d972d 144
16e0bf73
DB
145 DECLARE_ALIGNED(8, uint64_t, mmxDcOffset[64]);
146 DECLARE_ALIGNED(8, uint64_t, mmxDcThreshold[64]);
88c0bc7e 147
16e0bf73
DB
148 QP_STORE_T *stdQPTable; ///< used to fix MPEG2 style qscale
149 QP_STORE_T *nonBQPTable;
150 QP_STORE_T *forcedQPTable;
88c0bc7e 151
16e0bf73
DB
152 int QP;
153 int nonBQP;
c41d972d 154
16e0bf73 155 int frameNum;
115329f1 156
16e0bf73 157 int cpuCaps;
115329f1 158
16e0bf73
DB
159 int qpStride; ///<size of qp buffers (needed to realloc them if needed)
160 int stride; ///<size of some buffers (needed to realloc them if needed)
115329f1 161
16e0bf73
DB
162 int hChromaSubSample;
163 int vChromaSubSample;
c41d972d 164
16e0bf73 165 PPMode ppMode;
c41d972d
MN
166} PPContext;
167
0426af31 168
16e0bf73
DB
169static inline void linecpy(void *dest, const void *src, int lines, int stride) {
170 if (stride > 0) {
171 memcpy(dest, src, lines*stride);
172 } else {
173 memcpy((uint8_t*)dest+(lines-1)*stride, (const uint8_t*)src+(lines-1)*stride, -lines*stride);
174 }
655f688d 175}
699b3f99 176
5b21bdab 177#endif /* FFMPEG_POSTPROCESS_INTERNAL_H */