x86: faster AVX2 iDCT, AVX deblock_luma_h, deblock_luma_h_intra
[x262.git] / common / common.h
1 /*****************************************************************************
2  * common.h: misc common functions
3  *****************************************************************************
4  * Copyright (C) 2003-2013 x264 project
5  *
6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7  *          Loren Merritt <lorenm@u.washington.edu>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
22  *
23  * This program is also available under a commercial proprietary license.
24  * For more information, contact us at licensing@x264.com.
25  *****************************************************************************/
26
27 #ifndef X264_COMMON_H
28 #define X264_COMMON_H
29
30 /****************************************************************************
31  * Macros
32  ****************************************************************************/
33 #define X264_MIN(a,b) ( (a)<(b) ? (a) : (b) )
34 #define X264_MAX(a,b) ( (a)>(b) ? (a) : (b) )
35 #define X264_MIN3(a,b,c) X264_MIN((a),X264_MIN((b),(c)))
36 #define X264_MAX3(a,b,c) X264_MAX((a),X264_MAX((b),(c)))
37 #define X264_MIN4(a,b,c,d) X264_MIN((a),X264_MIN3((b),(c),(d)))
38 #define X264_MAX4(a,b,c,d) X264_MAX((a),X264_MAX3((b),(c),(d)))
39 #define XCHG(type,a,b) do{ type t = a; a = b; b = t; } while(0)
40 #define IS_DISPOSABLE(type) ( type == X264_TYPE_B )
41 #define FIX8(f) ((int)(f*(1<<8)+.5))
42 #define ALIGN(x,a) (((x)+((a)-1))&~((a)-1))
43 #define ARRAY_ELEMS(a) ((sizeof(a))/(sizeof(a[0])))
44
45 #define CHECKED_MALLOC( var, size )\
46 do {\
47     var = x264_malloc( size );\
48     if( !var )\
49         goto fail;\
50 } while( 0 )
51 #define CHECKED_MALLOCZERO( var, size )\
52 do {\
53     CHECKED_MALLOC( var, size );\
54     memset( var, 0, size );\
55 } while( 0 )
56
57 #define ARRAY_SIZE(array)  (sizeof(array)/sizeof(array[0]))
58
59 #define X264_BFRAME_MAX 16
60 #define X264_REF_MAX 16
61 #define X264_THREAD_MAX 128
62 #define X264_LOOKAHEAD_THREAD_MAX 16
63 #define X264_PCM_COST (FRAME_SIZE(256*BIT_DEPTH)+16)
64 #define X264_LOOKAHEAD_MAX 250
65 #define QP_BD_OFFSET (6*(BIT_DEPTH-8))
66 #define QP_MAX_SPEC (51+QP_BD_OFFSET)
67 #define QP_MAX (QP_MAX_SPEC+18)
68 #define QP_MAX_MAX (51+2*6+18)
69 #define PIXEL_MAX ((1 << BIT_DEPTH)-1)
70 // arbitrary, but low because SATD scores are 1/4 normal
71 #define X264_LOOKAHEAD_QP (12+QP_BD_OFFSET)
72 #define SPEC_QP(x) X264_MIN((x), QP_MAX_SPEC)
73
74 // number of pixels (per thread) in progress at any given time.
75 // 16 for the macroblock in progress + 3 for deblocking + 3 for motion compensation filter + 2 for extra safety
76 #define X264_THREAD_HEIGHT 24
77
78 /* WEIGHTP_FAKE is set when mb_tree & psy are enabled, but normal weightp is disabled
79  * (such as in baseline). It checks for fades in lookahead and adjusts qp accordingly
80  * to increase quality. Defined as (-1) so that if(i_weighted_pred > 0) is true only when
81  * real weights are being used. */
82
83 #define X264_WEIGHTP_FAKE (-1)
84
85 #define NALU_OVERHEAD 5 // startcode + NAL type costs 5 bytes per frame
86 #define FILLER_OVERHEAD (NALU_OVERHEAD+1)
87
88 /****************************************************************************
89  * Includes
90  ****************************************************************************/
91 #include "osdep.h"
92 #include <stdarg.h>
93 #include <stddef.h>
94 #include <stdlib.h>
95 #include <string.h>
96 #include <assert.h>
97 #include <limits.h>
98
99 #if HAVE_INTERLACED
100 #   define MB_INTERLACED h->mb.b_interlaced
101 #   define SLICE_MBAFF h->sh.b_mbaff
102 #   define PARAM_INTERLACED h->param.b_interlaced
103 #else
104 #   define MB_INTERLACED 0
105 #   define SLICE_MBAFF 0
106 #   define PARAM_INTERLACED 0
107 #endif
108
109 #ifdef CHROMA_FORMAT
110 #    define CHROMA_H_SHIFT (CHROMA_FORMAT == CHROMA_420 || CHROMA_FORMAT == CHROMA_422)
111 #    define CHROMA_V_SHIFT (CHROMA_FORMAT == CHROMA_420)
112 #else
113 #    define CHROMA_FORMAT h->sps->i_chroma_format_idc
114 #    define CHROMA_H_SHIFT h->mb.chroma_h_shift
115 #    define CHROMA_V_SHIFT h->mb.chroma_v_shift
116 #endif
117
118 #define CHROMA_SIZE(s) ((s)>>(CHROMA_H_SHIFT+CHROMA_V_SHIFT))
119 #define FRAME_SIZE(s) ((s)+2*CHROMA_SIZE(s))
120 #define CHROMA444 (CHROMA_FORMAT == CHROMA_444)
121
122 /* Unions for type-punning.
123  * Mn: load or store n bits, aligned, native-endian
124  * CPn: copy n bits, aligned, native-endian
125  * we don't use memcpy for CPn because memcpy's args aren't assumed to be aligned */
126 typedef union { uint16_t i; uint8_t  c[2]; } MAY_ALIAS x264_union16_t;
127 typedef union { uint32_t i; uint16_t b[2]; uint8_t  c[4]; } MAY_ALIAS x264_union32_t;
128 typedef union { uint64_t i; uint32_t a[2]; uint16_t b[4]; uint8_t c[8]; } MAY_ALIAS x264_union64_t;
129 typedef struct { uint64_t i[2]; } x264_uint128_t;
130 typedef union { x264_uint128_t i; uint64_t a[2]; uint32_t b[4]; uint16_t c[8]; uint8_t d[16]; } MAY_ALIAS x264_union128_t;
131 #define M16(src) (((x264_union16_t*)(src))->i)
132 #define M32(src) (((x264_union32_t*)(src))->i)
133 #define M64(src) (((x264_union64_t*)(src))->i)
134 #define M128(src) (((x264_union128_t*)(src))->i)
135 #define M128_ZERO ((x264_uint128_t){{0,0}})
136 #define CP16(dst,src) M16(dst) = M16(src)
137 #define CP32(dst,src) M32(dst) = M32(src)
138 #define CP64(dst,src) M64(dst) = M64(src)
139 #define CP128(dst,src) M128(dst) = M128(src)
140
141 #if HIGH_BIT_DEPTH
142     typedef uint16_t pixel;
143     typedef uint64_t pixel4;
144     typedef int32_t  dctcoef;
145     typedef uint32_t udctcoef;
146
147 #   define PIXEL_SPLAT_X4(x) ((x)*0x0001000100010001ULL)
148 #   define MPIXEL_X4(src) M64(src)
149 #else
150     typedef uint8_t  pixel;
151     typedef uint32_t pixel4;
152     typedef int16_t  dctcoef;
153     typedef uint16_t udctcoef;
154
155 #   define PIXEL_SPLAT_X4(x) ((x)*0x01010101U)
156 #   define MPIXEL_X4(src) M32(src)
157 #endif
158
159 #define BIT_DEPTH X264_BIT_DEPTH
160
161 #define CPPIXEL_X4(dst,src) MPIXEL_X4(dst) = MPIXEL_X4(src)
162
163 #define X264_SCAN8_LUMA_SIZE (5*8)
164 #define X264_SCAN8_SIZE (X264_SCAN8_LUMA_SIZE*3)
165 #define X264_SCAN8_0 (4+1*8)
166
167 /* Scan8 organization:
168  *    0 1 2 3 4 5 6 7
169  * 0  DY    y y y y y
170  * 1        y Y Y Y Y
171  * 2        y Y Y Y Y
172  * 3        y Y Y Y Y
173  * 4        y Y Y Y Y
174  * 5  DU    u u u u u
175  * 6        u U U U U
176  * 7        u U U U U
177  * 8        u U U U U
178  * 9        u U U U U
179  * 10 DV    v v v v v
180  * 11       v V V V V
181  * 12       v V V V V
182  * 13       v V V V V
183  * 14       v V V V V
184  * DY/DU/DV are for luma/chroma DC.
185  */
186
187 #define LUMA_DC   48
188 #define CHROMA_DC 49
189
190 static const uint8_t x264_scan8[16*3 + 3] =
191 {
192     4+ 1*8, 5+ 1*8, 4+ 2*8, 5+ 2*8,
193     6+ 1*8, 7+ 1*8, 6+ 2*8, 7+ 2*8,
194     4+ 3*8, 5+ 3*8, 4+ 4*8, 5+ 4*8,
195     6+ 3*8, 7+ 3*8, 6+ 4*8, 7+ 4*8,
196     4+ 6*8, 5+ 6*8, 4+ 7*8, 5+ 7*8,
197     6+ 6*8, 7+ 6*8, 6+ 7*8, 7+ 7*8,
198     4+ 8*8, 5+ 8*8, 4+ 9*8, 5+ 9*8,
199     6+ 8*8, 7+ 8*8, 6+ 9*8, 7+ 9*8,
200     4+11*8, 5+11*8, 4+12*8, 5+12*8,
201     6+11*8, 7+11*8, 6+12*8, 7+12*8,
202     4+13*8, 5+13*8, 4+14*8, 5+14*8,
203     6+13*8, 7+13*8, 6+14*8, 7+14*8,
204     0+ 0*8, 0+ 5*8, 0+10*8
205 };
206
207 #include "x264.h"
208 #if HAVE_OPENCL
209 #include "opencl.h"
210 #endif
211 #include "cabac.h"
212 #include "bitstream.h"
213 #include "set.h"
214 #include "predict.h"
215 #include "pixel.h"
216 #include "mc.h"
217 #include "frame.h"
218 #include "dct.h"
219 #include "quant.h"
220 #include "cpu.h"
221 #include "threadpool.h"
222
223 /****************************************************************************
224  * General functions
225  ****************************************************************************/
226 /* x264_malloc : will do or emulate a memalign
227  * you have to use x264_free for buffers allocated with x264_malloc */
228 void *x264_malloc( int );
229 void  x264_free( void * );
230
231 /* x264_slurp_file: malloc space for the whole file and read it */
232 char *x264_slurp_file( const char *filename );
233
234 /* mdate: return the current date in microsecond */
235 int64_t x264_mdate( void );
236
237 /* x264_param2string: return a (malloced) string containing most of
238  * the encoding options */
239 char *x264_param2string( x264_param_t *p, int b_res );
240
241 /* log */
242 void x264_log( x264_t *h, int i_level, const char *psz_fmt, ... );
243
244 void x264_reduce_fraction( uint32_t *n, uint32_t *d );
245 void x264_reduce_fraction64( uint64_t *n, uint64_t *d );
246 void x264_cavlc_init( x264_t *h );
247 void x264_cabac_init( x264_t *h );
248
249 static ALWAYS_INLINE pixel x264_clip_pixel( int x )
250 {
251     return ( (x & ~PIXEL_MAX) ? (-x)>>31 & PIXEL_MAX : x );
252 }
253
254 static ALWAYS_INLINE int x264_clip3( int v, int i_min, int i_max )
255 {
256     return ( (v < i_min) ? i_min : (v > i_max) ? i_max : v );
257 }
258
259 static ALWAYS_INLINE double x264_clip3f( double v, double f_min, double f_max )
260 {
261     return ( (v < f_min) ? f_min : (v > f_max) ? f_max : v );
262 }
263
264 static ALWAYS_INLINE int x264_median( int a, int b, int c )
265 {
266     int t = (a-b)&((a-b)>>31);
267     a -= t;
268     b += t;
269     b -= (b-c)&((b-c)>>31);
270     b += (a-b)&((a-b)>>31);
271     return b;
272 }
273
274 static ALWAYS_INLINE void x264_median_mv( int16_t *dst, int16_t *a, int16_t *b, int16_t *c )
275 {
276     dst[0] = x264_median( a[0], b[0], c[0] );
277     dst[1] = x264_median( a[1], b[1], c[1] );
278 }
279
280 static ALWAYS_INLINE int x264_predictor_difference( int16_t (*mvc)[2], intptr_t i_mvc )
281 {
282     int sum = 0;
283     for( int i = 0; i < i_mvc-1; i++ )
284     {
285         sum += abs( mvc[i][0] - mvc[i+1][0] )
286              + abs( mvc[i][1] - mvc[i+1][1] );
287     }
288     return sum;
289 }
290
291 static ALWAYS_INLINE uint16_t x264_cabac_mvd_sum( uint8_t *mvdleft, uint8_t *mvdtop )
292 {
293     int amvd0 = abs(mvdleft[0]) + abs(mvdtop[0]);
294     int amvd1 = abs(mvdleft[1]) + abs(mvdtop[1]);
295     amvd0 = (amvd0 > 2) + (amvd0 > 32);
296     amvd1 = (amvd1 > 2) + (amvd1 > 32);
297     return amvd0 + (amvd1<<8);
298 }
299
300 extern const uint8_t x264_exp2_lut[64];
301 extern const float x264_log2_lut[128];
302 extern const float x264_log2_lz_lut[32];
303
304 /* Not a general-purpose function; multiplies input by -1/6 to convert
305  * qp to qscale. */
306 static ALWAYS_INLINE int x264_exp2fix8( float x )
307 {
308     int i = x*(-64.f/6.f) + 512.5f;
309     if( i < 0 ) return 0;
310     if( i > 1023 ) return 0xffff;
311     return (x264_exp2_lut[i&63]+256) << (i>>6) >> 8;
312 }
313
314 static ALWAYS_INLINE float x264_log2( uint32_t x )
315 {
316     int lz = x264_clz( x );
317     return x264_log2_lut[(x<<lz>>24)&0x7f] + x264_log2_lz_lut[lz];
318 }
319
320 /****************************************************************************
321  *
322  ****************************************************************************/
323 enum slice_type_e
324 {
325     SLICE_TYPE_P  = 0,
326     SLICE_TYPE_B  = 1,
327     SLICE_TYPE_I  = 2,
328 };
329
330 static const char slice_type_to_char[] = { 'P', 'B', 'I' };
331
332 enum sei_payload_type_e
333 {
334     SEI_BUFFERING_PERIOD       = 0,
335     SEI_PIC_TIMING             = 1,
336     SEI_PAN_SCAN_RECT          = 2,
337     SEI_FILLER                 = 3,
338     SEI_USER_DATA_REGISTERED   = 4,
339     SEI_USER_DATA_UNREGISTERED = 5,
340     SEI_RECOVERY_POINT         = 6,
341     SEI_DEC_REF_PIC_MARKING    = 7,
342     SEI_FRAME_PACKING          = 45,
343 };
344
345 typedef struct
346 {
347     x264_sps_t *sps;
348     x264_pps_t *pps;
349
350     int i_type;
351     int i_first_mb;
352     int i_last_mb;
353
354     int i_pps_id;
355
356     int i_frame_num;
357
358     int b_mbaff;
359     int b_field_pic;
360     int b_bottom_field;
361
362     int i_idr_pic_id;   /* -1 if nal_type != 5 */
363
364     int i_poc;
365     int i_delta_poc_bottom;
366
367     int i_delta_poc[2];
368     int i_redundant_pic_cnt;
369
370     int b_direct_spatial_mv_pred;
371
372     int b_num_ref_idx_override;
373     int i_num_ref_idx_l0_active;
374     int i_num_ref_idx_l1_active;
375
376     int b_ref_pic_list_reordering[2];
377     struct
378     {
379         int idc;
380         int arg;
381     } ref_pic_list_order[2][X264_REF_MAX];
382
383     /* P-frame weighting */
384     int b_weighted_pred;
385     x264_weight_t weight[X264_REF_MAX*2][3];
386
387     int i_mmco_remove_from_end;
388     int i_mmco_command_count;
389     struct /* struct for future expansion */
390     {
391         int i_difference_of_pic_nums;
392         int i_poc;
393     } mmco[X264_REF_MAX];
394
395     int i_cabac_init_idc;
396
397     int i_qp;
398     int i_qp_delta;
399     int b_sp_for_swidth;
400     int i_qs_delta;
401
402     /* deblocking filter */
403     int i_disable_deblocking_filter_idc;
404     int i_alpha_c0_offset;
405     int i_beta_offset;
406
407 } x264_slice_header_t;
408
409 typedef struct x264_lookahead_t
410 {
411     volatile uint8_t              b_exit_thread;
412     uint8_t                       b_thread_active;
413     uint8_t                       b_analyse_keyframe;
414     int                           i_last_keyframe;
415     int                           i_slicetype_length;
416     x264_frame_t                  *last_nonb;
417     x264_pthread_t                thread_handle;
418     x264_sync_frame_list_t        ifbuf;
419     x264_sync_frame_list_t        next;
420     x264_sync_frame_list_t        ofbuf;
421 } x264_lookahead_t;
422
423 typedef struct x264_ratecontrol_t   x264_ratecontrol_t;
424
425 typedef struct x264_left_table_t
426 {
427     uint8_t intra[4];
428     uint8_t nnz[4];
429     uint8_t nnz_chroma[4];
430     uint8_t mv[4];
431     uint8_t ref[4];
432 } x264_left_table_t;
433
434 /* Current frame stats */
435 typedef struct
436 {
437     /* MV bits (MV+Ref+Block Type) */
438     int i_mv_bits;
439     /* Texture bits (DCT coefs) */
440     int i_tex_bits;
441     /* ? */
442     int i_misc_bits;
443     /* MB type counts */
444     int i_mb_count[19];
445     int i_mb_count_i;
446     int i_mb_count_p;
447     int i_mb_count_skip;
448     int i_mb_count_8x8dct[2];
449     int i_mb_count_ref[2][X264_REF_MAX*2];
450     int i_mb_partition[17];
451     int i_mb_cbp[6];
452     int i_mb_pred_mode[4][13];
453     int i_mb_field[3];
454     /* Adaptive direct mv pred */
455     int i_direct_score[2];
456     /* Metrics */
457     int64_t i_ssd[3];
458     double f_ssim;
459     int i_ssim_cnt;
460 } x264_frame_stat_t;
461
462 struct x264_t
463 {
464     /* encoder parameters */
465     x264_param_t    param;
466
467     x264_t          *thread[X264_THREAD_MAX+1];
468     x264_t          *lookahead_thread[X264_LOOKAHEAD_THREAD_MAX];
469     int             b_thread_active;
470     int             i_thread_phase; /* which thread to use for the next frame */
471     int             i_thread_idx;   /* which thread this is */
472     int             i_threadslice_start; /* first row in this thread slice */
473     int             i_threadslice_end; /* row after the end of this thread slice */
474     int             i_threadslice_pass; /* which pass of encoding we are on */
475     x264_threadpool_t *threadpool;
476     x264_threadpool_t *lookaheadpool;
477     x264_pthread_mutex_t mutex;
478     x264_pthread_cond_t cv;
479
480     /* bitstream output */
481     struct
482     {
483         int         i_nal;
484         int         i_nals_allocated;
485         x264_nal_t  *nal;
486         int         i_bitstream;    /* size of p_bitstream */
487         uint8_t     *p_bitstream;   /* will hold data for all nal */
488         bs_t        bs;
489     } out;
490
491     uint8_t *nal_buffer;
492     int      nal_buffer_size;
493
494     /**** thread synchronization starts here ****/
495
496     /* frame number/poc */
497     int             i_frame;
498     int             i_frame_num;
499
500     int             i_thread_frames; /* Number of different frames being encoded by threads;
501                                       * 1 when sliced-threads is on. */
502     int             i_nal_type;
503     int             i_nal_ref_idc;
504
505     int64_t         i_disp_fields;  /* Number of displayed fields (both coded and implied via pic_struct) */
506     int             i_disp_fields_last_frame;
507     int64_t         i_prev_duration; /* Duration of previous frame */
508     int64_t         i_coded_fields; /* Number of coded fields (both coded and implied via pic_struct) */
509     int64_t         i_cpb_delay;    /* Equal to number of fields preceding this field
510                                      * since last buffering_period SEI */
511     int64_t         i_coded_fields_lookahead; /* Use separate counters for lookahead */
512     int64_t         i_cpb_delay_lookahead;
513
514     int64_t         i_cpb_delay_pir_offset;
515     int64_t         i_cpb_delay_pir_offset_next;
516
517     int             b_queued_intra_refresh;
518     int64_t         i_last_idr_pts;
519
520     int             i_idr_pic_id;
521
522     /* quantization matrix for decoding, [cqm][qp%6][coef] */
523     int             (*dequant4_mf[4])[16];   /* [4][6][16] */
524     int             (*dequant8_mf[4])[64];   /* [4][6][64] */
525     /* quantization matrix for trellis, [cqm][qp][coef] */
526     int             (*unquant4_mf[4])[16];   /* [4][52][16] */
527     int             (*unquant8_mf[4])[64];   /* [4][52][64] */
528     /* quantization matrix for deadzone */
529     udctcoef        (*quant4_mf[4])[16];     /* [4][52][16] */
530     udctcoef        (*quant8_mf[4])[64];     /* [4][52][64] */
531     udctcoef        (*quant4_bias[4])[16];   /* [4][52][16] */
532     udctcoef        (*quant8_bias[4])[64];   /* [4][52][64] */
533     udctcoef        (*quant4_bias0[4])[16];  /* [4][52][16] */
534     udctcoef        (*quant8_bias0[4])[64];  /* [4][52][64] */
535     udctcoef        (*nr_offset_emergency)[4][64];
536
537     /* mv/ref cost arrays. */
538     uint16_t *cost_mv[QP_MAX+1];
539     uint16_t *cost_mv_fpel[QP_MAX+1][4];
540
541     const uint8_t   *chroma_qp_table; /* includes both the nonlinear luma->chroma mapping and chroma_qp_offset */
542
543     /* Slice header */
544     x264_slice_header_t sh;
545
546     /* SPS / PPS */
547     x264_sps_t      sps[1];
548     x264_pps_t      pps[1];
549
550     /* Slice header backup, for SEI_DEC_REF_PIC_MARKING */
551     int b_sh_backup;
552     x264_slice_header_t sh_backup;
553
554     /* cabac context */
555     x264_cabac_t    cabac;
556
557     struct
558     {
559         /* Frames to be encoded (whose types have been decided) */
560         x264_frame_t **current;
561         /* Unused frames: 0 = fenc, 1 = fdec */
562         x264_frame_t **unused[2];
563
564         /* Unused blank frames (for duplicates) */
565         x264_frame_t **blank_unused;
566
567         /* frames used for reference + sentinels */
568         x264_frame_t *reference[X264_REF_MAX+2];
569
570         int i_last_keyframe;       /* Frame number of the last keyframe */
571         int i_last_idr;            /* Frame number of the last IDR (not RP)*/
572         int i_poc_last_open_gop;   /* Poc of the I frame of the last open-gop. The value
573                                     * is only assigned during the period between that
574                                     * I frame and the next P or I frame, else -1 */
575
576         int i_input;    /* Number of input frames already accepted */
577
578         int i_max_dpb;  /* Number of frames allocated in the decoded picture buffer */
579         int i_max_ref0;
580         int i_max_ref1;
581         int i_delay;    /* Number of frames buffered for B reordering */
582         int     i_bframe_delay;
583         int64_t i_bframe_delay_time;
584         int64_t i_first_pts;
585         int64_t i_prev_reordered_pts[2];
586         int64_t i_largest_pts;
587         int64_t i_second_largest_pts;
588         int b_have_lowres;  /* Whether 1/2 resolution luma planes are being used */
589         int b_have_sub8x8_esa;
590     } frames;
591
592     /* current frame being encoded */
593     x264_frame_t    *fenc;
594
595     /* frame being reconstructed */
596     x264_frame_t    *fdec;
597
598     /* references lists */
599     int             i_ref[2];
600     x264_frame_t    *fref[2][X264_REF_MAX+3];
601     x264_frame_t    *fref_nearest[2];
602     int             b_ref_reorder[2];
603
604     /* hrd */
605     int initial_cpb_removal_delay;
606     int initial_cpb_removal_delay_offset;
607     int64_t i_reordered_pts_delay;
608
609     /* Current MB DCT coeffs */
610     struct
611     {
612         ALIGNED_N( dctcoef luma16x16_dc[3][16] );
613         ALIGNED_16( dctcoef chroma_dc[2][8] );
614         // FIXME share memory?
615         ALIGNED_N( dctcoef luma8x8[12][64] );
616         ALIGNED_N( dctcoef luma4x4[16*3][16] );
617     } dct;
618
619     /* MB table and cache for current frame/mb */
620     struct
621     {
622         int     i_mb_width;
623         int     i_mb_height;
624         int     i_mb_count;                 /* number of mbs in a frame */
625
626         /* Chroma subsampling */
627         int     chroma_h_shift;
628         int     chroma_v_shift;
629
630         /* Strides */
631         int     i_mb_stride;
632         int     i_b8_stride;
633         int     i_b4_stride;
634         int     left_b8[2];
635         int     left_b4[2];
636
637         /* Current index */
638         int     i_mb_x;
639         int     i_mb_y;
640         int     i_mb_xy;
641         int     i_b8_xy;
642         int     i_b4_xy;
643
644         /* Search parameters */
645         int     i_me_method;
646         int     i_subpel_refine;
647         int     b_chroma_me;
648         int     b_trellis;
649         int     b_noise_reduction;
650         int     b_dct_decimate;
651         int     i_psy_rd; /* Psy RD strength--fixed point value*/
652         int     i_psy_trellis; /* Psy trellis strength--fixed point value*/
653
654         int     b_interlaced;
655         int     b_adaptive_mbaff; /* MBAFF+subme 0 requires non-adaptive MBAFF i.e. all field mbs */
656
657         /* Allowed qpel MV range to stay within the picture + emulated edge pixels */
658         int     mv_min[2];
659         int     mv_max[2];
660         int     mv_miny_row[3]; /* 0 == top progressive, 1 == bot progressive, 2 == interlaced */
661         int     mv_maxy_row[3];
662         /* Subpel MV range for motion search.
663          * same mv_min/max but includes levels' i_mv_range. */
664         int     mv_min_spel[2];
665         int     mv_max_spel[2];
666         int     mv_miny_spel_row[3];
667         int     mv_maxy_spel_row[3];
668         /* Fullpel MV range for motion search */
669         ALIGNED_8( int16_t mv_limit_fpel[2][2] ); /* min_x, min_y, max_x, max_y */
670         int     mv_miny_fpel_row[3];
671         int     mv_maxy_fpel_row[3];
672
673         /* neighboring MBs */
674         unsigned int i_neighbour;
675         unsigned int i_neighbour8[4];       /* neighbours of each 8x8 or 4x4 block that are available */
676         unsigned int i_neighbour4[16];      /* at the time the block is coded */
677         unsigned int i_neighbour_intra;     /* for constrained intra pred */
678         unsigned int i_neighbour_frame;     /* ignoring slice boundaries */
679         int     i_mb_type_top;
680         int     i_mb_type_left[2];
681         int     i_mb_type_topleft;
682         int     i_mb_type_topright;
683         int     i_mb_prev_xy;
684         int     i_mb_left_xy[2];
685         int     i_mb_top_xy;
686         int     i_mb_topleft_xy;
687         int     i_mb_topright_xy;
688         int     i_mb_top_y;
689         int     i_mb_topleft_y;
690         int     i_mb_topright_y;
691         const x264_left_table_t *left_index_table;
692         int     i_mb_top_mbpair_xy;
693         int     topleft_partition;
694         int     b_allow_skip;
695         int     field_decoding_flag;
696
697         /**** thread synchronization ends here ****/
698         /* subsequent variables are either thread-local or constant,
699          * and won't be copied from one thread to another */
700
701         /* mb table */
702         int8_t  *type;                      /* mb type */
703         uint8_t *partition;                 /* mb partition */
704         int8_t  *qp;                        /* mb qp */
705         int16_t *cbp;                       /* mb cbp: 0x0?: luma, 0x?0: chroma, 0x100: luma dc, 0x0200 and 0x0400: chroma dc  (all set for PCM)*/
706         int8_t  (*intra4x4_pred_mode)[8];   /* intra4x4 pred mode. for non I4x4 set to I_PRED_4x4_DC(2) */
707                                             /* actually has only 7 entries; set to 8 for write-combining optimizations */
708         uint8_t (*non_zero_count)[16*3];    /* nzc. for I_PCM set to 16 */
709         int8_t  *chroma_pred_mode;          /* chroma_pred_mode. cabac only. for non intra I_PRED_CHROMA_DC(0) */
710         int16_t (*mv[2])[2];                /* mb mv. set to 0 for intra mb */
711         uint8_t (*mvd[2])[8][2];            /* absolute value of mb mv difference with predict, clipped to [0,33]. set to 0 if intra. cabac only */
712         int8_t   *ref[2];                   /* mb ref. set to -1 if non used (intra or Lx only) */
713         int16_t (*mvr[2][X264_REF_MAX*2])[2];/* 16x16 mv for each possible ref */
714         int8_t  *skipbp;                    /* block pattern for SKIP or DIRECT (sub)mbs. B-frames + cabac only */
715         int8_t  *mb_transform_size;         /* transform_size_8x8_flag of each mb */
716         uint16_t *slice_table;              /* sh->first_mb of the slice that the indexed mb is part of
717                                              * NOTE: this will fail on resolutions above 2^16 MBs... */
718         uint8_t *field;
719
720          /* buffer for weighted versions of the reference frames */
721         pixel *p_weight_buf[X264_REF_MAX];
722
723         /* current value */
724         int     i_type;
725         int     i_partition;
726         ALIGNED_4( uint8_t i_sub_partition[4] );
727         int     b_transform_8x8;
728
729         int     i_cbp_luma;
730         int     i_cbp_chroma;
731
732         int     i_intra16x16_pred_mode;
733         int     i_chroma_pred_mode;
734
735         /* skip flags for i4x4 and i8x8
736          * 0 = encode as normal.
737          * 1 (non-RD only) = the DCT is still in h->dct, restore fdec and skip reconstruction.
738          * 2 (RD only) = the DCT has since been overwritten by RD; restore that too. */
739         int i_skip_intra;
740         /* skip flag for motion compensation */
741         /* if we've already done MC, we don't need to do it again */
742         int b_skip_mc;
743         /* set to true if we are re-encoding a macroblock. */
744         int b_reencode_mb;
745         int ip_offset; /* Used by PIR to offset the quantizer of intra-refresh blocks. */
746         int b_deblock_rdo;
747         int b_overflow; /* If CAVLC had a level code overflow during bitstream writing. */
748
749         struct
750         {
751             /* space for p_fenc and p_fdec */
752 #define FENC_STRIDE 16
753 #define FDEC_STRIDE 32
754             ALIGNED_16( pixel fenc_buf[48*FENC_STRIDE] );
755             ALIGNED_N( pixel fdec_buf[52*FDEC_STRIDE] );
756
757             /* i4x4 and i8x8 backup data, for skipping the encode stage when possible */
758             ALIGNED_16( pixel i4x4_fdec_buf[16*16] );
759             ALIGNED_16( pixel i8x8_fdec_buf[16*16] );
760             ALIGNED_16( dctcoef i8x8_dct_buf[3][64] );
761             ALIGNED_16( dctcoef i4x4_dct_buf[15][16] );
762             uint32_t i4x4_nnz_buf[4];
763             uint32_t i8x8_nnz_buf[4];
764             int i4x4_cbp;
765             int i8x8_cbp;
766
767             /* Psy trellis DCT data */
768             ALIGNED_16( dctcoef fenc_dct8[4][64] );
769             ALIGNED_16( dctcoef fenc_dct4[16][16] );
770
771             /* Psy RD SATD/SA8D scores cache */
772             ALIGNED_N( uint64_t fenc_hadamard_cache[9] );
773             ALIGNED_N( uint32_t fenc_satd_cache[32] );
774
775             /* pointer over mb of the frame to be compressed */
776             pixel *p_fenc[3]; /* y,u,v */
777             /* pointer to the actual source frame, not a block copy */
778             pixel *p_fenc_plane[3];
779
780             /* pointer over mb of the frame to be reconstructed  */
781             pixel *p_fdec[3];
782
783             /* pointer over mb of the references */
784             int i_fref[2];
785             /* [12]: yN, yH, yV, yHV, (NV12 ? uv : I444 ? (uN, uH, uV, uHV, vN, ...)) */
786             pixel *p_fref[2][X264_REF_MAX*2][12];
787             pixel *p_fref_w[X264_REF_MAX*2];  /* weighted fullpel luma */
788             uint16_t *p_integral[2][X264_REF_MAX];
789
790             /* fref stride */
791             int     i_stride[3];
792         } pic;
793
794         /* cache */
795         struct
796         {
797             /* real intra4x4_pred_mode if I_4X4 or I_8X8, I_PRED_4x4_DC if mb available, -1 if not */
798             ALIGNED_8( int8_t intra4x4_pred_mode[X264_SCAN8_LUMA_SIZE] );
799
800             /* i_non_zero_count if available else 0x80 */
801             ALIGNED_16( uint8_t non_zero_count[X264_SCAN8_SIZE] );
802
803             /* -1 if unused, -2 if unavailable */
804             ALIGNED_4( int8_t ref[2][X264_SCAN8_LUMA_SIZE] );
805
806             /* 0 if not available */
807             ALIGNED_16( int16_t mv[2][X264_SCAN8_LUMA_SIZE][2] );
808             ALIGNED_8( uint8_t mvd[2][X264_SCAN8_LUMA_SIZE][2] );
809
810             /* 1 if SKIP or DIRECT. set only for B-frames + CABAC */
811             ALIGNED_4( int8_t skip[X264_SCAN8_LUMA_SIZE] );
812
813             ALIGNED_4( int16_t direct_mv[2][4][2] );
814             ALIGNED_4( int8_t  direct_ref[2][4] );
815             int     direct_partition;
816             ALIGNED_4( int16_t pskip_mv[2] );
817
818             /* number of neighbors (top and left) that used 8x8 dct */
819             int     i_neighbour_transform_size;
820             int     i_neighbour_skip;
821
822             /* neighbor CBPs */
823             int     i_cbp_top;
824             int     i_cbp_left;
825
826             /* extra data required for mbaff in mv prediction */
827             int16_t topright_mv[2][3][2];
828             int8_t  topright_ref[2][3];
829
830             /* current mb deblock strength */
831             uint8_t (*deblock_strength)[8][4];
832         } cache;
833
834         /* */
835         int     i_qp;       /* current qp */
836         int     i_chroma_qp;
837         int     i_last_qp;  /* last qp */
838         int     i_last_dqp; /* last delta qp */
839         int     b_variable_qp; /* whether qp is allowed to vary per macroblock */
840         int     b_lossless;
841         int     b_direct_auto_read; /* take stats for --direct auto from the 2pass log */
842         int     b_direct_auto_write; /* analyse direct modes, to use and/or save */
843
844         /* lambda values */
845         int     i_trellis_lambda2[2][2]; /* [luma,chroma][inter,intra] */
846         int     i_psy_rd_lambda;
847         int     i_chroma_lambda2_offset;
848
849         /* B_direct and weighted prediction */
850         int16_t dist_scale_factor_buf[2][2][X264_REF_MAX*2][4];
851         int16_t (*dist_scale_factor)[4];
852         int8_t bipred_weight_buf[2][2][X264_REF_MAX*2][4];
853         int8_t (*bipred_weight)[4];
854         /* maps fref1[0]'s ref indices into the current list0 */
855 #define map_col_to_list0(col) h->mb.map_col_to_list0[(col)+2]
856         int8_t  map_col_to_list0[X264_REF_MAX+2];
857         int ref_blind_dupe; /* The index of the blind reference frame duplicate. */
858         int8_t deblock_ref_table[X264_REF_MAX*2+2];
859 #define deblock_ref_table(x) h->mb.deblock_ref_table[(x)+2]
860     } mb;
861
862     /* rate control encoding only */
863     x264_ratecontrol_t *rc;
864
865     /* stats */
866     struct
867     {
868         /* Current frame stats */
869         x264_frame_stat_t frame;
870
871         /* Cumulated stats */
872
873         /* per slice info */
874         int     i_frame_count[3];
875         int64_t i_frame_size[3];
876         double  f_frame_qp[3];
877         int     i_consecutive_bframes[X264_BFRAME_MAX+1];
878         /* */
879         double  f_ssd_global[3];
880         double  f_psnr_average[3];
881         double  f_psnr_mean_y[3];
882         double  f_psnr_mean_u[3];
883         double  f_psnr_mean_v[3];
884         double  f_ssim_mean_y[3];
885         double  f_frame_duration[3];
886         /* */
887         int64_t i_mb_count[3][19];
888         int64_t i_mb_partition[2][17];
889         int64_t i_mb_count_8x8dct[2];
890         int64_t i_mb_count_ref[2][2][X264_REF_MAX*2];
891         int64_t i_mb_cbp[6];
892         int64_t i_mb_pred_mode[4][13];
893         int64_t i_mb_field[3];
894         /* */
895         int     i_direct_score[2];
896         int     i_direct_frames[2];
897         /* num p-frames weighted */
898         int     i_wpred[2];
899
900     } stat;
901
902     /* 0 = luma 4x4, 1 = luma 8x8, 2 = chroma 4x4, 3 = chroma 8x8 */
903     udctcoef (*nr_offset)[64];
904     uint32_t (*nr_residual_sum)[64];
905     uint32_t *nr_count;
906
907     ALIGNED_N( udctcoef nr_offset_denoise[4][64] );
908     ALIGNED_N( uint32_t nr_residual_sum_buf[2][4][64] );
909     uint32_t nr_count_buf[2][4];
910
911     uint8_t luma2chroma_pixel[7]; /* Subsampled pixel size */
912
913     /* Buffers that are allocated per-thread even in sliced threads. */
914     void *scratch_buffer; /* for any temporary storage that doesn't want repeated malloc */
915     void *scratch_buffer2; /* if the first one's already in use */
916     pixel *intra_border_backup[5][3]; /* bottom pixels of the previous mb row, used for intra prediction after the framebuffer has been deblocked */
917     /* Deblock strength values are stored for each 4x4 partition. In MBAFF
918      * there are four extra values that need to be stored, located in [4][i]. */
919     uint8_t (*deblock_strength[2])[2][8][4];
920
921     /* CPU functions dependents */
922     x264_predict_t      predict_16x16[4+3];
923     x264_predict8x8_t   predict_8x8[9+3];
924     x264_predict_t      predict_4x4[9+3];
925     x264_predict_t      predict_chroma[4+3];
926     x264_predict_t      predict_8x8c[4+3];
927     x264_predict_t      predict_8x16c[4+3];
928     x264_predict_8x8_filter_t predict_8x8_filter;
929
930     x264_pixel_function_t pixf;
931     x264_mc_functions_t   mc;
932     x264_dct_function_t   dctf;
933     x264_zigzag_function_t zigzagf;
934     x264_zigzag_function_t zigzagf_interlaced;
935     x264_zigzag_function_t zigzagf_progressive;
936     x264_quant_function_t quantf;
937     x264_deblock_function_t loopf;
938     x264_bitstream_function_t bsf;
939
940 #if HAVE_VISUALIZE
941     struct visualize_t *visualize;
942 #endif
943     x264_lookahead_t *lookahead;
944
945 #if HAVE_OPENCL
946     x264_opencl_t opencl;
947 #endif
948 };
949
950 // included at the end because it needs x264_t
951 #include "macroblock.h"
952
953 static int ALWAYS_INLINE x264_predictor_roundclip( int16_t (*dst)[2], int16_t (*mvc)[2], int i_mvc, int16_t mv_limit[2][2], uint32_t pmv )
954 {
955     int cnt = 0;
956     for( int i = 0; i < i_mvc; i++ )
957     {
958         int mx = (mvc[i][0] + 2) >> 2;
959         int my = (mvc[i][1] + 2) >> 2;
960         uint32_t mv = pack16to32_mask(mx, my);
961         if( !mv || mv == pmv ) continue;
962         dst[cnt][0] = x264_clip3( mx, mv_limit[0][0], mv_limit[1][0] );
963         dst[cnt][1] = x264_clip3( my, mv_limit[0][1], mv_limit[1][1] );
964         cnt++;
965     }
966     return cnt;
967 }
968
969 static int ALWAYS_INLINE x264_predictor_clip( int16_t (*dst)[2], int16_t (*mvc)[2], int i_mvc, int16_t mv_limit[2][2], uint32_t pmv )
970 {
971     int cnt = 0;
972     int qpel_limit[4] = {mv_limit[0][0] << 2, mv_limit[0][1] << 2, mv_limit[1][0] << 2, mv_limit[1][1] << 2};
973     for( int i = 0; i < i_mvc; i++ )
974     {
975         uint32_t mv = M32( mvc[i] );
976         int mx = mvc[i][0];
977         int my = mvc[i][1];
978         if( !mv || mv == pmv ) continue;
979         dst[cnt][0] = x264_clip3( mx, qpel_limit[0], qpel_limit[2] );
980         dst[cnt][1] = x264_clip3( my, qpel_limit[1], qpel_limit[3] );
981         cnt++;
982     }
983     return cnt;
984 }
985
986 #if ARCH_X86 || ARCH_X86_64
987 #include "x86/util.h"
988 #endif
989
990 #include "rectangle.h"
991
992 #endif
993