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