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