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