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