Convert to a unified "dctcoeff" type for DCT data
[x262.git] / common / common.h
1 /*****************************************************************************
2  * common.h: h264 encoder
3  *****************************************************************************
4  * Copyright (C) 2003-2008 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
24 #ifndef X264_COMMON_H
25 #define X264_COMMON_H
26
27 /****************************************************************************
28  * Macros
29  ****************************************************************************/
30 #define X264_MIN(a,b) ( (a)<(b) ? (a) : (b) )
31 #define X264_MAX(a,b) ( (a)>(b) ? (a) : (b) )
32 #define X264_MIN3(a,b,c) X264_MIN((a),X264_MIN((b),(c)))
33 #define X264_MAX3(a,b,c) X264_MAX((a),X264_MAX((b),(c)))
34 #define X264_MIN4(a,b,c,d) X264_MIN((a),X264_MIN3((b),(c),(d)))
35 #define X264_MAX4(a,b,c,d) X264_MAX((a),X264_MAX3((b),(c),(d)))
36 #define XCHG(type,a,b) do{ type t = a; a = b; b = t; } while(0)
37 #define IS_DISPOSABLE(type) ( type == X264_TYPE_B )
38 #define FIX8(f) ((int)(f*(1<<8)+.5))
39
40 #define CHECKED_MALLOC( var, size )\
41 do {\
42     var = x264_malloc( size );\
43     if( !var )\
44         goto fail;\
45 } while( 0 )
46 #define CHECKED_MALLOCZERO( var, size )\
47 do {\
48     CHECKED_MALLOC( var, size );\
49     memset( var, 0, size );\
50 } while( 0 )
51
52 #define X264_BFRAME_MAX 16
53 #define X264_THREAD_MAX 128
54 #define X264_PCM_COST (386*8)
55 #define X264_LOOKAHEAD_MAX 250
56 // arbitrary, but low because SATD scores are 1/4 normal
57 #define X264_LOOKAHEAD_QP 12
58
59 // number of pixels (per thread) in progress at any given time.
60 // 16 for the macroblock in progress + 3 for deblocking + 3 for motion compensation filter + 2 for extra safety
61 #define X264_THREAD_HEIGHT 24
62
63 /* WEIGHTP_FAKE is set when mb_tree & psy are enabled, but normal weightp is disabled
64  * (such as in baseline). It checks for fades in lookahead and adjusts qp accordingly
65  * to increase quality. Defined as (-1) so that if(i_weighted_pred > 0) is true only when
66  * real weights are being used. */
67
68 #define X264_WEIGHTP_FAKE (-1)
69
70 #define NALU_OVERHEAD 5 // startcode + NAL type costs 5 bytes per frame
71 #define FILLER_OVERHEAD (NALU_OVERHEAD+1)
72
73 /****************************************************************************
74  * Includes
75  ****************************************************************************/
76 #include "osdep.h"
77 #include <stdarg.h>
78 #include <stddef.h>
79 #include <stdlib.h>
80 #include <string.h>
81 #include <assert.h>
82 #include <limits.h>
83
84 /* Unions for type-punning.
85  * Mn: load or store n bits, aligned, native-endian
86  * CPn: copy n bits, aligned, native-endian
87  * we don't use memcpy for CPn because memcpy's args aren't assumed to be aligned */
88 typedef union { uint16_t i; uint8_t  c[2]; } MAY_ALIAS x264_union16_t;
89 typedef union { uint32_t i; uint16_t b[2]; uint8_t  c[4]; } MAY_ALIAS x264_union32_t;
90 typedef union { uint64_t i; uint32_t a[2]; uint16_t b[4]; uint8_t c[8]; } MAY_ALIAS x264_union64_t;
91 typedef struct { uint64_t i[2]; } x264_uint128_t;
92 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;
93 #define M16(src) (((x264_union16_t*)(src))->i)
94 #define M32(src) (((x264_union32_t*)(src))->i)
95 #define M64(src) (((x264_union64_t*)(src))->i)
96 #define M128(src) (((x264_union128_t*)(src))->i)
97 #define M128_ZERO ((x264_uint128_t){{0,0}})
98 #define CP16(dst,src) M16(dst) = M16(src)
99 #define CP32(dst,src) M32(dst) = M32(src)
100 #define CP64(dst,src) M64(dst) = M64(src)
101 #define CP128(dst,src) M128(dst) = M128(src)
102
103 typedef uint8_t pixel;
104 typedef uint32_t pixel4;
105 typedef int16_t dctcoef;
106
107 #define PIXEL_SPLAT_X4(x) ((x)*0x01010101U)
108 #define MPIXEL_X4(src) M32(src)
109 #define CPPIXEL_X4(dst,src) CP32(dst,src)
110 #define CPPIXEL_X8(dst,src) CP64(dst,src)
111 #define MDCT_X2(dct) M32(dct)
112 #define CPDCT_X2(dst,src) CP32(dst,src)
113 #define CPDCT_X4(dst,src) CP64(dst,src)
114
115 #define X264_SCAN8_SIZE (6*8)
116 #define X264_SCAN8_LUMA_SIZE (5*8)
117 #define X264_SCAN8_0 (4+1*8)
118
119 static const int x264_scan8[16+2*4+3] =
120 {
121     /* Luma */
122     4+1*8, 5+1*8, 4+2*8, 5+2*8,
123     6+1*8, 7+1*8, 6+2*8, 7+2*8,
124     4+3*8, 5+3*8, 4+4*8, 5+4*8,
125     6+3*8, 7+3*8, 6+4*8, 7+4*8,
126
127     /* Cb */
128     1+1*8, 2+1*8,
129     1+2*8, 2+2*8,
130
131     /* Cr */
132     1+4*8, 2+4*8,
133     1+5*8, 2+5*8,
134
135     /* Luma DC */
136     4+5*8,
137
138     /* Chroma DC */
139     6+5*8, 7+5*8
140 };
141 /*
142    0 1 2 3 4 5 6 7
143  0
144  1   B B   L L L L
145  2   B B   L L L L
146  3         L L L L
147  4   R R   L L L L
148  5   R R   Dy  DuDv
149 */
150
151 #include "x264.h"
152 #include "bitstream.h"
153 #include "set.h"
154 #include "predict.h"
155 #include "pixel.h"
156 #include "mc.h"
157 #include "frame.h"
158 #include "dct.h"
159 #include "cabac.h"
160 #include "quant.h"
161 #include "cpu.h"
162
163 /****************************************************************************
164  * General functions
165  ****************************************************************************/
166 /* x264_malloc : will do or emulate a memalign
167  * you have to use x264_free for buffers allocated with x264_malloc */
168 void *x264_malloc( int );
169 void  x264_free( void * );
170
171 /* x264_slurp_file: malloc space for the whole file and read it */
172 char *x264_slurp_file( const char *filename );
173
174 /* mdate: return the current date in microsecond */
175 int64_t x264_mdate( void );
176
177 /* x264_param2string: return a (malloced) string containing most of
178  * the encoding options */
179 char *x264_param2string( x264_param_t *p, int b_res );
180
181 /* log */
182 void x264_log( x264_t *h, int i_level, const char *psz_fmt, ... );
183
184 void x264_reduce_fraction( uint32_t *n, uint32_t *d );
185 void x264_init_vlc_tables();
186
187 static ALWAYS_INLINE pixel x264_clip_pixel( int x )
188 {
189     return x&(~255) ? (-x)>>31 : x;
190 }
191
192 static ALWAYS_INLINE int x264_clip3( int v, int i_min, int i_max )
193 {
194     return ( (v < i_min) ? i_min : (v > i_max) ? i_max : v );
195 }
196
197 static ALWAYS_INLINE double x264_clip3f( double v, double f_min, double f_max )
198 {
199     return ( (v < f_min) ? f_min : (v > f_max) ? f_max : v );
200 }
201
202 static ALWAYS_INLINE int x264_median( int a, int b, int c )
203 {
204     int t = (a-b)&((a-b)>>31);
205     a -= t;
206     b += t;
207     b -= (b-c)&((b-c)>>31);
208     b += (a-b)&((a-b)>>31);
209     return b;
210 }
211
212 static ALWAYS_INLINE void x264_median_mv( int16_t *dst, int16_t *a, int16_t *b, int16_t *c )
213 {
214     dst[0] = x264_median( a[0], b[0], c[0] );
215     dst[1] = x264_median( a[1], b[1], c[1] );
216 }
217
218 static ALWAYS_INLINE int x264_predictor_difference( int16_t (*mvc)[2], intptr_t i_mvc )
219 {
220     int sum = 0;
221     for( int i = 0; i < i_mvc-1; i++ )
222     {
223         sum += abs( mvc[i][0] - mvc[i+1][0] )
224              + abs( mvc[i][1] - mvc[i+1][1] );
225     }
226     return sum;
227 }
228
229 static ALWAYS_INLINE uint16_t x264_cabac_mvd_sum( uint8_t *mvdleft, uint8_t *mvdtop )
230 {
231     int amvd0 = abs(mvdleft[0]) + abs(mvdtop[0]);
232     int amvd1 = abs(mvdleft[1]) + abs(mvdtop[1]);
233     amvd0 = (amvd0 > 2) + (amvd0 > 32);
234     amvd1 = (amvd1 > 2) + (amvd1 > 32);
235     return amvd0 + (amvd1<<8);
236 }
237
238 static void ALWAYS_INLINE x264_predictor_roundclip( int16_t (*dst)[2], int16_t (*mvc)[2], int i_mvc, int mv_x_min, int mv_x_max, int mv_y_min, int mv_y_max )
239 {
240     for( int i = 0; i < i_mvc; i++ )
241     {
242         int mx = (mvc[i][0] + 2) >> 2;
243         int my = (mvc[i][1] + 2) >> 2;
244         dst[i][0] = x264_clip3( mx, mv_x_min, mv_x_max );
245         dst[i][1] = x264_clip3( my, mv_y_min, mv_y_max );
246     }
247 }
248
249 extern const uint8_t x264_exp2_lut[64];
250 extern const float x264_log2_lut[128];
251 extern const float x264_log2_lz_lut[32];
252
253 /* Not a general-purpose function; multiplies input by -1/6 to convert
254  * qp to qscale. */
255 static ALWAYS_INLINE int x264_exp2fix8( float x )
256 {
257     int i = x*(-64.f/6.f) + 512.5f;
258     if( i < 0 ) return 0;
259     if( i > 1023 ) return 0xffff;
260     return (x264_exp2_lut[i&63]+256) << (i>>6) >> 8;
261 }
262
263 static ALWAYS_INLINE float x264_log2( uint32_t x )
264 {
265     int lz = x264_clz( x );
266     return x264_log2_lut[(x<<lz>>24)&0x7f] + x264_log2_lz_lut[lz];
267 }
268
269 /****************************************************************************
270  *
271  ****************************************************************************/
272 enum slice_type_e
273 {
274     SLICE_TYPE_P  = 0,
275     SLICE_TYPE_B  = 1,
276     SLICE_TYPE_I  = 2,
277     SLICE_TYPE_SP = 3,
278     SLICE_TYPE_SI = 4
279 };
280
281 static const char slice_type_to_char[] = { 'P', 'B', 'I', 'S', 'S' };
282
283 enum sei_payload_type_e
284 {
285     SEI_BUFFERING_PERIOD       = 0,
286     SEI_PIC_TIMING             = 1,
287     SEI_PAN_SCAN_RECT          = 2,
288     SEI_FILLER                 = 3,
289     SEI_USER_DATA_REGISTERED   = 4,
290     SEI_USER_DATA_UNREGISTERED = 5,
291     SEI_RECOVERY_POINT         = 6,
292 };
293
294 typedef struct
295 {
296     x264_sps_t *sps;
297     x264_pps_t *pps;
298
299     int i_type;
300     int i_first_mb;
301     int i_last_mb;
302
303     int i_pps_id;
304
305     int i_frame_num;
306
307     int b_mbaff;
308     int b_field_pic;
309     int b_bottom_field;
310
311     int i_idr_pic_id;   /* -1 if nal_type != 5 */
312
313     int i_poc;
314     int i_delta_poc_bottom;
315
316     int i_delta_poc[2];
317     int i_redundant_pic_cnt;
318
319     int b_direct_spatial_mv_pred;
320
321     int b_num_ref_idx_override;
322     int i_num_ref_idx_l0_active;
323     int i_num_ref_idx_l1_active;
324
325     int b_ref_pic_list_reordering_l0;
326     int b_ref_pic_list_reordering_l1;
327     struct
328     {
329         int idc;
330         int arg;
331     } ref_pic_list_order[2][16];
332
333     /* P-frame weighting */
334     x264_weight_t weight[32][3];
335
336     int i_mmco_remove_from_end;
337     int i_mmco_command_count;
338     struct /* struct for future expansion */
339     {
340         int i_difference_of_pic_nums;
341         int i_poc;
342     } mmco[16];
343
344     int i_cabac_init_idc;
345
346     int i_qp;
347     int i_qp_delta;
348     int b_sp_for_swidth;
349     int i_qs_delta;
350
351     /* deblocking filter */
352     int i_disable_deblocking_filter_idc;
353     int i_alpha_c0_offset;
354     int i_beta_offset;
355
356 } x264_slice_header_t;
357
358 typedef struct x264_lookahead_t
359 {
360     volatile uint8_t              b_exit_thread;
361     uint8_t                       b_thread_active;
362     uint8_t                       b_analyse_keyframe;
363     int                           i_last_keyframe;
364     int                           i_slicetype_length;
365     x264_frame_t                  *last_nonb;
366     x264_synch_frame_list_t       ifbuf;
367     x264_synch_frame_list_t       next;
368     x264_synch_frame_list_t       ofbuf;
369 } x264_lookahead_t;
370
371 typedef struct x264_ratecontrol_t   x264_ratecontrol_t;
372
373 struct x264_t
374 {
375     /* encoder parameters */
376     x264_param_t    param;
377
378     x264_t          *thread[X264_THREAD_MAX+1];
379     x264_pthread_t  thread_handle;
380     int             b_thread_active;
381     int             i_thread_phase; /* which thread to use for the next frame */
382     int             i_threadslice_start; /* first row in this thread slice */
383     int             i_threadslice_end; /* row after the end of this thread slice */
384
385     /* bitstream output */
386     struct
387     {
388         int         i_nal;
389         int         i_nals_allocated;
390         x264_nal_t  *nal;
391         int         i_bitstream;    /* size of p_bitstream */
392         uint8_t     *p_bitstream;   /* will hold data for all nal */
393         bs_t        bs;
394     } out;
395
396     uint8_t *nal_buffer;
397     int      nal_buffer_size;
398
399     /**** thread synchronization starts here ****/
400
401     /* frame number/poc */
402     int             i_frame;
403     int             i_frame_num;
404
405     int             i_thread_frames; /* Number of different frames being encoded by threads;
406                                       * 1 when sliced-threads is on. */
407     int             i_nal_type;
408     int             i_nal_ref_idc;
409
410     int             i_disp_fields;  /* Number of displayed fields (both coded and implied via pic_struct) */
411     int             i_disp_fields_last_frame;
412     int             i_prev_duration; /* Duration of previous frame */
413     int             i_coded_fields; /* Number of coded fields (both coded and implied via pic_struct) */
414     int             i_cpb_delay;    /* Equal to number of fields preceding this field
415                                      * since last buffering_period SEI */
416     int             i_coded_fields_lookahead; /* Use separate counters for lookahead */
417     int             i_cpb_delay_lookahead;
418
419     int             b_queued_intra_refresh;
420
421     /* We use only one SPS and one PPS */
422     x264_sps_t      sps_array[1];
423     x264_sps_t      *sps;
424     x264_pps_t      pps_array[1];
425     x264_pps_t      *pps;
426     int             i_idr_pic_id;
427
428     /* Timebase multiplier for DTS compression */
429     int             i_dts_compress_multiplier;
430
431     /* quantization matrix for decoding, [cqm][qp%6][coef] */
432     int             (*dequant4_mf[4])[16];   /* [4][6][16] */
433     int             (*dequant8_mf[2])[64];   /* [2][6][64] */
434     /* quantization matrix for trellis, [cqm][qp][coef] */
435     int             (*unquant4_mf[4])[16];   /* [4][52][16] */
436     int             (*unquant8_mf[2])[64];   /* [2][52][64] */
437     /* quantization matrix for deadzone */
438     uint16_t        (*quant4_mf[4])[16];     /* [4][52][16] */
439     uint16_t        (*quant8_mf[2])[64];     /* [2][52][64] */
440     uint16_t        (*quant4_bias[4])[16];   /* [4][52][16] */
441     uint16_t        (*quant8_bias[2])[64];   /* [2][52][64] */
442
443     /* mv/ref cost arrays.  Indexed by lambda instead of
444      * qp because, due to rounding, some quantizers share
445      * lambdas.  This saves memory. */
446     uint16_t *cost_mv[92];
447     uint16_t *cost_mv_fpel[92][4];
448
449     const uint8_t   *chroma_qp_table; /* includes both the nonlinear luma->chroma mapping and chroma_qp_offset */
450
451     /* Slice header */
452     x264_slice_header_t sh;
453
454     /* cabac context */
455     x264_cabac_t    cabac;
456
457     struct
458     {
459         /* Frames to be encoded (whose types have been decided) */
460         x264_frame_t **current;
461         /* Unused frames: 0 = fenc, 1 = fdec */
462         x264_frame_t **unused[2];
463
464         /* Unused blank frames (for duplicates) */
465         x264_frame_t **blank_unused;
466
467         /* frames used for reference + sentinels */
468         x264_frame_t *reference[16+2];
469
470         int i_last_keyframe; /* Frame number of the last keyframe */
471
472         int i_input;    /* Number of input frames already accepted */
473
474         int i_max_dpb;  /* Number of frames allocated in the decoded picture buffer */
475         int i_max_ref0;
476         int i_max_ref1;
477         int i_delay;    /* Number of frames buffered for B reordering */
478         int     i_bframe_delay;
479         int64_t i_bframe_delay_time;
480         int64_t i_init_delta;
481         int64_t i_prev_reordered_pts[2];
482         int64_t i_largest_pts;
483         int64_t i_second_largest_pts;
484         int b_have_lowres;  /* Whether 1/2 resolution luma planes are being used */
485         int b_have_sub8x8_esa;
486     } frames;
487
488     /* current frame being encoded */
489     x264_frame_t    *fenc;
490
491     /* frame being reconstructed */
492     x264_frame_t    *fdec;
493
494     /* references lists */
495     int             i_ref0;
496     x264_frame_t    *fref0[16+3];     /* ref list 0 */
497     int             i_ref1;
498     x264_frame_t    *fref1[16+3];     /* ref list 1 */
499     int             b_ref_reorder[2];
500
501     /* hrd */
502     int initial_cpb_removal_delay;
503     int initial_cpb_removal_delay_offset;
504     int64_t i_reordered_pts_delay;
505
506     /* Current MB DCT coeffs */
507     struct
508     {
509         ALIGNED_16( dctcoef luma16x16_dc[16] );
510         ALIGNED_16( dctcoef chroma_dc[2][4] );
511         // FIXME share memory?
512         ALIGNED_16( dctcoef luma8x8[4][64] );
513         ALIGNED_16( dctcoef luma4x4[16+8][16] );
514     } dct;
515
516     /* MB table and cache for current frame/mb */
517     struct
518     {
519         int     i_mb_count;                 /* number of mbs in a frame */
520
521         /* Strides */
522         int     i_mb_stride;
523         int     i_b8_stride;
524         int     i_b4_stride;
525
526         /* Current index */
527         int     i_mb_x;
528         int     i_mb_y;
529         int     i_mb_xy;
530         int     i_b8_xy;
531         int     i_b4_xy;
532
533         /* Search parameters */
534         int     i_me_method;
535         int     i_subpel_refine;
536         int     b_chroma_me;
537         int     b_trellis;
538         int     b_noise_reduction;
539         int     b_dct_decimate;
540         int     i_psy_rd; /* Psy RD strength--fixed point value*/
541         int     i_psy_trellis; /* Psy trellis strength--fixed point value*/
542
543         int     b_interlaced;
544
545         /* Allowed qpel MV range to stay within the picture + emulated edge pixels */
546         int     mv_min[2];
547         int     mv_max[2];
548         /* Subpel MV range for motion search.
549          * same mv_min/max but includes levels' i_mv_range. */
550         int     mv_min_spel[2];
551         int     mv_max_spel[2];
552         /* Fullpel MV range for motion search */
553         int     mv_min_fpel[2];
554         int     mv_max_fpel[2];
555
556         /* neighboring MBs */
557         unsigned int i_neighbour;
558         unsigned int i_neighbour8[4];       /* neighbours of each 8x8 or 4x4 block that are available */
559         unsigned int i_neighbour4[16];      /* at the time the block is coded */
560         unsigned int i_neighbour_intra;     /* for constrained intra pred */
561         unsigned int i_neighbour_frame;     /* ignoring slice boundaries */
562         int     i_mb_type_top;
563         int     i_mb_type_left;
564         int     i_mb_type_topleft;
565         int     i_mb_type_topright;
566         int     i_mb_prev_xy;
567         int     i_mb_left_xy;
568         int     i_mb_top_xy;
569         int     i_mb_topleft_xy;
570         int     i_mb_topright_xy;
571
572         /**** thread synchronization ends here ****/
573         /* subsequent variables are either thread-local or constant,
574          * and won't be copied from one thread to another */
575
576         /* mb table */
577         int8_t  *type;                      /* mb type */
578         uint8_t *partition;                 /* mb partition */
579         int8_t  *qp;                        /* mb qp */
580         int16_t *cbp;                       /* mb cbp: 0x0?: luma, 0x?0: chroma, 0x100: luma dc, 0x0200 and 0x0400: chroma dc  (all set for PCM)*/
581         int8_t  (*intra4x4_pred_mode)[8];   /* intra4x4 pred mode. for non I4x4 set to I_PRED_4x4_DC(2) */
582                                             /* actually has only 7 entries; set to 8 for write-combining optimizations */
583         uint8_t (*non_zero_count)[16+4+4];  /* nzc. for I_PCM set to 16 */
584         int8_t  *chroma_pred_mode;          /* chroma_pred_mode. cabac only. for non intra I_PRED_CHROMA_DC(0) */
585         int16_t (*mv[2])[2];                /* mb mv. set to 0 for intra mb */
586         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 */
587         int8_t   *ref[2];                   /* mb ref. set to -1 if non used (intra or Lx only) */
588         int16_t (*mvr[2][32])[2];           /* 16x16 mv for each possible ref */
589         int8_t  *skipbp;                    /* block pattern for SKIP or DIRECT (sub)mbs. B-frames + cabac only */
590         int8_t  *mb_transform_size;         /* transform_size_8x8_flag of each mb */
591         uint16_t *slice_table;              /* sh->first_mb of the slice that the indexed mb is part of
592                                              * NOTE: this will fail on resolutions above 2^16 MBs... */
593
594          /* buffer for weighted versions of the reference frames */
595         pixel *p_weight_buf[16];
596
597         /* current value */
598         int     i_type;
599         int     i_partition;
600         ALIGNED_4( uint8_t i_sub_partition[4] );
601         int     b_transform_8x8;
602
603         int     i_cbp_luma;
604         int     i_cbp_chroma;
605
606         int     i_intra16x16_pred_mode;
607         int     i_chroma_pred_mode;
608
609         /* skip flags for i4x4 and i8x8
610          * 0 = encode as normal.
611          * 1 (non-RD only) = the DCT is still in h->dct, restore fdec and skip reconstruction.
612          * 2 (RD only) = the DCT has since been overwritten by RD; restore that too. */
613         int i_skip_intra;
614         /* skip flag for motion compensation */
615         /* if we've already done MC, we don't need to do it again */
616         int b_skip_mc;
617         /* set to true if we are re-encoding a macroblock. */
618         int b_reencode_mb;
619         int ip_offset; /* Used by PIR to offset the quantizer of intra-refresh blocks. */
620
621         struct
622         {
623             /* space for p_fenc and p_fdec */
624 #define FENC_STRIDE 16
625 #define FDEC_STRIDE 32
626             ALIGNED_16( pixel fenc_buf[24*FENC_STRIDE] );
627             ALIGNED_16( pixel fdec_buf[27*FDEC_STRIDE] );
628
629             /* i4x4 and i8x8 backup data, for skipping the encode stage when possible */
630             ALIGNED_16( pixel i4x4_fdec_buf[16*16] );
631             ALIGNED_16( pixel i8x8_fdec_buf[16*16] );
632             ALIGNED_16( dctcoef i8x8_dct_buf[3][64] );
633             ALIGNED_16( dctcoef i4x4_dct_buf[15][16] );
634             uint32_t i4x4_nnz_buf[4];
635             uint32_t i8x8_nnz_buf[4];
636             int i4x4_cbp;
637             int i8x8_cbp;
638
639             /* Psy trellis DCT data */
640             ALIGNED_16( dctcoef fenc_dct8[4][64] );
641             ALIGNED_16( dctcoef fenc_dct4[16][16] );
642
643             /* Psy RD SATD/SA8D scores cache */
644             ALIGNED_16( uint64_t fenc_hadamard_cache[9] );
645             ALIGNED_16( uint32_t fenc_satd_cache[32] );
646
647             /* pointer over mb of the frame to be compressed */
648             pixel *p_fenc[3];
649             /* pointer to the actual source frame, not a block copy */
650             pixel *p_fenc_plane[3];
651
652             /* pointer over mb of the frame to be reconstructed  */
653             pixel *p_fdec[3];
654
655             /* pointer over mb of the references */
656             int i_fref[2];
657             pixel *p_fref[2][32][4+2]; /* last: lN, lH, lV, lHV, cU, cV */
658             pixel *p_fref_w[32];  /* weighted fullpel luma */
659             uint16_t *p_integral[2][16];
660
661             /* fref stride */
662             int     i_stride[3];
663         } pic;
664
665         /* cache */
666         struct
667         {
668             /* real intra4x4_pred_mode if I_4X4 or I_8X8, I_PRED_4x4_DC if mb available, -1 if not */
669             ALIGNED_8( int8_t intra4x4_pred_mode[X264_SCAN8_LUMA_SIZE] );
670
671             /* i_non_zero_count if available else 0x80 */
672             ALIGNED_16( uint8_t non_zero_count[X264_SCAN8_SIZE] );
673
674             /* -1 if unused, -2 if unavailable */
675             ALIGNED_4( int8_t ref[2][X264_SCAN8_LUMA_SIZE] );
676
677             /* 0 if not available */
678             ALIGNED_16( int16_t mv[2][X264_SCAN8_LUMA_SIZE][2] );
679             ALIGNED_8( uint8_t mvd[2][X264_SCAN8_LUMA_SIZE][2] );
680
681             /* 1 if SKIP or DIRECT. set only for B-frames + CABAC */
682             ALIGNED_4( int8_t skip[X264_SCAN8_LUMA_SIZE] );
683
684             ALIGNED_4( int16_t direct_mv[2][4][2] );
685             ALIGNED_4( int8_t  direct_ref[2][4] );
686             int     direct_partition;
687             ALIGNED_4( int16_t pskip_mv[2] );
688
689             /* number of neighbors (top and left) that used 8x8 dct */
690             int     i_neighbour_transform_size;
691             int     i_neighbour_interlaced;
692
693             /* neighbor CBPs */
694             int     i_cbp_top;
695             int     i_cbp_left;
696         } cache;
697
698         /* */
699         int     i_qp;       /* current qp */
700         int     i_chroma_qp;
701         int     i_last_qp;  /* last qp */
702         int     i_last_dqp; /* last delta qp */
703         int     b_variable_qp; /* whether qp is allowed to vary per macroblock */
704         int     b_lossless;
705         int     b_direct_auto_read; /* take stats for --direct auto from the 2pass log */
706         int     b_direct_auto_write; /* analyse direct modes, to use and/or save */
707
708         /* lambda values */
709         int     i_trellis_lambda2[2][2]; /* [luma,chroma][inter,intra] */
710         int     i_psy_rd_lambda;
711         int     i_chroma_lambda2_offset;
712
713         /* B_direct and weighted prediction */
714         int16_t dist_scale_factor_buf[2][32][4];
715         int16_t (*dist_scale_factor)[4];
716         int8_t bipred_weight_buf[2][32][4];
717         int8_t (*bipred_weight)[4];
718         /* maps fref1[0]'s ref indices into the current list0 */
719 #define map_col_to_list0(col) h->mb.map_col_to_list0[(col)+2]
720         int8_t  map_col_to_list0[18];
721         int ref_blind_dupe; /* The index of the blind reference frame duplicate. */
722         int8_t deblock_ref_table[32+2];
723 #define deblock_ref_table(x) h->mb.deblock_ref_table[(x)+2]
724     } mb;
725
726     /* rate control encoding only */
727     x264_ratecontrol_t *rc;
728
729     /* stats */
730     struct
731     {
732         /* Current frame stats */
733         struct
734         {
735             /* MV bits (MV+Ref+Block Type) */
736             int i_mv_bits;
737             /* Texture bits (DCT coefs) */
738             int i_tex_bits;
739             /* ? */
740             int i_misc_bits;
741             /* MB type counts */
742             int i_mb_count[19];
743             int i_mb_count_i;
744             int i_mb_count_p;
745             int i_mb_count_skip;
746             int i_mb_count_8x8dct[2];
747             int i_mb_count_ref[2][32];
748             int i_mb_partition[17];
749             int i_mb_cbp[6];
750             int i_mb_pred_mode[4][13];
751             /* Adaptive direct mv pred */
752             int i_direct_score[2];
753             /* Metrics */
754             int64_t i_ssd[3];
755             double f_ssim;
756         } frame;
757
758         /* Cumulated stats */
759
760         /* per slice info */
761         int     i_frame_count[5];
762         int64_t i_frame_size[5];
763         double  f_frame_qp[5];
764         int     i_consecutive_bframes[X264_BFRAME_MAX+1];
765         /* */
766         int64_t i_ssd_global[5];
767         double  f_psnr_average[5];
768         double  f_psnr_mean_y[5];
769         double  f_psnr_mean_u[5];
770         double  f_psnr_mean_v[5];
771         double  f_ssim_mean_y[5];
772         /* */
773         int64_t i_mb_count[5][19];
774         int64_t i_mb_partition[2][17];
775         int64_t i_mb_count_8x8dct[2];
776         int64_t i_mb_count_ref[2][2][32];
777         int64_t i_mb_cbp[6];
778         int64_t i_mb_pred_mode[4][13];
779         /* */
780         int     i_direct_score[2];
781         int     i_direct_frames[2];
782         /* num p-frames weighted */
783         int     i_wpred[3];
784
785     } stat;
786
787     ALIGNED_16( uint32_t nr_residual_sum[2][64] );
788     ALIGNED_16( uint16_t nr_offset[2][64] );
789     uint32_t        nr_count[2];
790
791     /* Buffers that are allocated per-thread even in sliced threads. */
792     void *scratch_buffer; /* for any temporary storage that doesn't want repeated malloc */
793     pixel *intra_border_backup[2][3]; /* bottom pixels of the previous mb row, used for intra prediction after the framebuffer has been deblocked */
794     uint8_t (*deblock_strength[2])[2][4][4];
795
796     /* CPU functions dependents */
797     x264_predict_t      predict_16x16[4+3];
798     x264_predict_t      predict_8x8c[4+3];
799     x264_predict8x8_t   predict_8x8[9+3];
800     x264_predict_t      predict_4x4[9+3];
801     x264_predict_8x8_filter_t predict_8x8_filter;
802
803     x264_pixel_function_t pixf;
804     x264_mc_functions_t   mc;
805     x264_dct_function_t   dctf;
806     x264_zigzag_function_t zigzagf;
807     x264_quant_function_t quantf;
808     x264_deblock_function_t loopf;
809     x264_bitstream_function_t bsf;
810
811 #ifdef HAVE_VISUALIZE
812     struct visualize_t *visualize;
813 #endif
814     x264_lookahead_t *lookahead;
815 };
816
817 // included at the end because it needs x264_t
818 #include "macroblock.h"
819 #include "rectangle.h"
820
821 #ifdef HAVE_MMX
822 #include "x86/util.h"
823 #endif
824
825 #endif
826