add a comment to indicate which #endif belong to which #define
[ffmpeg.git] / libpostproc / postprocess_internal.h
1 /*
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  */
20
21 /**
22  * @file postprocess_internal.h
23  * internal api header.
24  */
25
26 #ifndef POSTPROCESS_INTERNAL_H
27 #define POSTPROCESS_INTERNAL_H
28
29 #include "avutil.h"
30
31 #define V_DEBLOCK       0x01
32 #define H_DEBLOCK       0x02
33 #define DERING          0x04
34 #define LEVEL_FIX       0x08 ///< Brightness & Contrast
35
36 #define LUM_V_DEBLOCK   V_DEBLOCK               //   1
37 #define LUM_H_DEBLOCK   H_DEBLOCK               //   2
38 #define CHROM_V_DEBLOCK (V_DEBLOCK<<4)          //  16
39 #define CHROM_H_DEBLOCK (H_DEBLOCK<<4)          //  32
40 #define LUM_DERING      DERING                  //   4
41 #define CHROM_DERING    (DERING<<4)             //  64
42 #define LUM_LEVEL_FIX   LEVEL_FIX               //   8
43 #define CHROM_LEVEL_FIX (LEVEL_FIX<<4)          // 128 (not implemented yet)
44
45 // Experimental vertical filters
46 #define V_X1_FILTER     0x0200                  // 512
47 #define V_A_DEBLOCK     0x0400
48
49 // Experimental horizontal filters
50 #define H_X1_FILTER     0x2000                  // 8192
51 #define H_A_DEBLOCK     0x4000
52
53 /// select between full y range (255-0) or standart one (234-16)
54 #define FULL_Y_RANGE    0x8000                  // 32768
55
56 //Deinterlacing Filters
57 #define        LINEAR_IPOL_DEINT_FILTER         0x10000 // 65536
58 #define        LINEAR_BLEND_DEINT_FILTER        0x20000 // 131072
59 #define        CUBIC_BLEND_DEINT_FILTER         0x8000  // (not implemented yet)
60 #define        CUBIC_IPOL_DEINT_FILTER          0x40000 // 262144
61 #define        MEDIAN_DEINT_FILTER              0x80000 // 524288
62 #define        FFMPEG_DEINT_FILTER              0x400000
63 #define        LOWPASS5_DEINT_FILTER            0x800000
64
65 #define TEMP_NOISE_FILTER               0x100000
66 #define FORCE_QUANT                     0x200000
67
68 #if ( defined(__PIC__) || defined(__pic__) ) && ! defined(PIC)
69 #    define PIC
70 #endif
71
72 //use if you want a faster postprocessing code
73 //cannot differentiate between chroma & luma filters (both on or both off)
74 //obviously the -pp option on the command line has no effect except turning the here selected
75 //filters on
76 //#define COMPILE_TIME_MODE 0x77
77
78 #if 1
79 static inline int CLIP(int a){
80         if(a&256) return ((a)>>31)^(-1);
81         else      return a;
82 }
83 //#define CLIP(a) (((a)&256) ? ((a)>>31)^(-1) : (a))
84 #elif 0
85 #define CLIP(a) clip_tab[a]
86 #else
87 #define CLIP(a) (a)
88 #endif
89 /**
90  * Postprocessng filter.
91  */
92 struct PPFilter{
93         const char *shortName;
94         const char *longName;
95         int chromDefault;       ///< is chrominance filtering on by default if this filter is manually activated
96         int minLumQuality;      ///< minimum quality to turn luminance filtering on
97         int minChromQuality;    ///< minimum quality to turn chrominance filtering on
98         int mask;               ///< Bitmask to turn this filter on
99 };
100
101 /**
102  * Postprocessng mode.
103  */
104 typedef struct PPMode{
105         int lumMode;                    ///< acivates filters for luminance
106         int chromMode;                  ///< acivates filters for chrominance
107         int error;                      ///< non zero on error
108
109         int minAllowedY;                ///< for brigtness correction
110         int maxAllowedY;                ///< for brihtness correction
111         float maxClippedThreshold;      ///< amount of "black" u r willing to loose to get a brightness corrected picture
112
113         int maxTmpNoise[3];             ///< for Temporal Noise Reducing filter (Maximal sum of abs differences)
114
115         int baseDcDiff;
116         int flatnessThreshold;
117
118         int forcedQuant;                ///< quantizer if FORCE_QUANT is used
119 } PPMode;
120
121 /**
122  * postprocess context.
123  */
124 typedef struct PPContext{
125         /**
126          * info on struct for av_log
127          */
128         AVClass *av_class;
129
130         uint8_t *tempBlocks; ///<used for the horizontal code
131
132         /**
133          * luma histogram.
134          * we need 64bit here otherwise we'll going to have a problem
135          * after watching a black picture for 5 hours
136          */
137         uint64_t *yHistogram;
138
139         DECLARE_ALIGNED(8, uint64_t, packedYOffset);
140         DECLARE_ALIGNED(8, uint64_t, packedYScale);
141
142         /** Temporal noise reducing buffers */
143         uint8_t *tempBlured[3];
144         int32_t *tempBluredPast[3];
145
146         /** Temporary buffers for handling the last row(s) */
147         uint8_t *tempDst;
148         uint8_t *tempSrc;
149
150         uint8_t *deintTemp;
151
152         DECLARE_ALIGNED(8, uint64_t, pQPb);
153         DECLARE_ALIGNED(8, uint64_t, pQPb2);
154
155         DECLARE_ALIGNED(8, uint64_t, mmxDcOffset[64]);
156         DECLARE_ALIGNED(8, uint64_t, mmxDcThreshold[64]);
157
158         QP_STORE_T *stdQPTable;       ///< used to fix MPEG2 style qscale
159         QP_STORE_T *nonBQPTable;
160         QP_STORE_T *forcedQPTable;
161
162         int QP;
163         int nonBQP;
164
165         int frameNum;
166
167         int cpuCaps;
168
169         int qpStride; ///<size of qp buffers (needed to realloc them if needed)
170         int stride;   ///<size of some buffers (needed to realloc them if needed)
171
172         int hChromaSubSample;
173         int vChromaSubSample;
174
175         PPMode ppMode;
176 } PPContext;
177
178
179 static inline void linecpy(void *dest, void *src, int lines, int stride)
180 {
181         if (stride > 0) {
182                 memcpy(dest, src, lines*stride);
183         } else {
184                 memcpy(dest+(lines-1)*stride, src+(lines-1)*stride, -lines*stride);
185         }
186 }
187
188 #endif // POSTPROCESS_INTERNAL_H