Eliminate support for direct_8x8_inference=0
[x262.git] / common / common.h
1 /*****************************************************************************
2  * common.h: h264 encoder
3  *****************************************************************************
4  * Copyright (C) 2003-2008 x264 project
5  *
6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7  *          Loren Merritt <lorenm@u.washington.edu>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 #ifndef X264_COMMON_H
25 #define X264_COMMON_H
26
27 /****************************************************************************
28  * Macros
29  ****************************************************************************/
30 #define X264_MIN(a,b) ( (a)<(b) ? (a) : (b) )
31 #define X264_MAX(a,b) ( (a)>(b) ? (a) : (b) )
32 #define X264_MIN3(a,b,c) X264_MIN((a),X264_MIN((b),(c)))
33 #define X264_MAX3(a,b,c) X264_MAX((a),X264_MAX((b),(c)))
34 #define X264_MIN4(a,b,c,d) X264_MIN((a),X264_MIN3((b),(c),(d)))
35 #define X264_MAX4(a,b,c,d) X264_MAX((a),X264_MAX3((b),(c),(d)))
36 #define XCHG(type,a,b) do{ type t = a; a = b; b = t; } while(0)
37 #define FIX8(f) ((int)(f*(1<<8)+.5))
38
39 #define CHECKED_MALLOC( var, size )\
40 {\
41     var = x264_malloc( size );\
42     if( !var )\
43     {\
44         x264_log( h, X264_LOG_ERROR, "malloc failed\n" );\
45         goto fail;\
46     }\
47 }
48
49 #define X264_BFRAME_MAX 16
50 #define X264_THREAD_MAX 128
51 #define X264_SLICE_MAX 4
52 #define X264_NAL_MAX (4 + X264_SLICE_MAX)
53 #define X264_PCM_COST (386*8)
54
55 // number of pixels (per thread) in progress at any given time.
56 // 16 for the macroblock in progress + 3 for deblocking + 3 for motion compensation filter + 2 for extra safety
57 #define X264_THREAD_HEIGHT 24
58
59 /****************************************************************************
60  * Includes
61  ****************************************************************************/
62 #include "osdep.h"
63 #include <stdarg.h>
64 #include <stddef.h>
65 #include <stdlib.h>
66 #include <string.h>
67 #include <assert.h>
68 #include "x264.h"
69 #include "bs.h"
70 #include "set.h"
71 #include "predict.h"
72 #include "pixel.h"
73 #include "mc.h"
74 #include "frame.h"
75 #include "dct.h"
76 #include "cabac.h"
77 #include "quant.h"
78
79 /****************************************************************************
80  * Generals functions
81  ****************************************************************************/
82 /* x264_malloc : will do or emulate a memalign
83  * you have to use x264_free for buffers allocated with x264_malloc */
84 void *x264_malloc( int );
85 void *x264_realloc( void *p, int i_size );
86 void  x264_free( void * );
87
88 /* x264_slurp_file: malloc space for the whole file and read it */
89 char *x264_slurp_file( const char *filename );
90
91 /* mdate: return the current date in microsecond */
92 int64_t x264_mdate( void );
93
94 /* x264_param2string: return a (malloced) string containing most of
95  * the encoding options */
96 char *x264_param2string( x264_param_t *p, int b_res );
97
98 /* log */
99 void x264_log( x264_t *h, int i_level, const char *psz_fmt, ... );
100
101 void x264_reduce_fraction( int *n, int *d );
102 void x264_init_vlc_tables();
103
104 static inline uint8_t x264_clip_uint8( int x )
105 {
106     return x&(~255) ? (-x)>>31 : x;
107 }
108
109 static inline int x264_clip3( int v, int i_min, int i_max )
110 {
111     return ( (v < i_min) ? i_min : (v > i_max) ? i_max : v );
112 }
113
114 static inline double x264_clip3f( double v, double f_min, double f_max )
115 {
116     return ( (v < f_min) ? f_min : (v > f_max) ? f_max : v );
117 }
118
119 static inline int x264_median( int a, int b, int c )
120 {
121     int t = (a-b)&((a-b)>>31);
122     a -= t;
123     b += t;
124     b -= (b-c)&((b-c)>>31);
125     b += (a-b)&((a-b)>>31);
126     return b;
127 }
128
129 static inline void x264_median_mv( int16_t *dst, int16_t *a, int16_t *b, int16_t *c )
130 {
131     dst[0] = x264_median( a[0], b[0], c[0] );
132     dst[1] = x264_median( a[1], b[1], c[1] );
133 }
134
135 static inline int x264_predictor_difference( int16_t (*mvc)[2], intptr_t i_mvc )
136 {
137     int sum = 0, i;
138     for( i = 0; i < i_mvc-1; i++ )
139     {
140         sum += abs( mvc[i][0] - mvc[i+1][0] )
141              + abs( mvc[i][1] - mvc[i+1][1] );
142     }
143     return sum;
144 }
145
146 /****************************************************************************
147  *
148  ****************************************************************************/
149 enum slice_type_e
150 {
151     SLICE_TYPE_P  = 0,
152     SLICE_TYPE_B  = 1,
153     SLICE_TYPE_I  = 2,
154     SLICE_TYPE_SP = 3,
155     SLICE_TYPE_SI = 4
156 };
157
158 static const char slice_type_to_char[] = { 'P', 'B', 'I', 'S', 'S' };
159
160 typedef struct
161 {
162     x264_sps_t *sps;
163     x264_pps_t *pps;
164
165     int i_type;
166     int i_first_mb;
167     int i_last_mb;
168
169     int i_pps_id;
170
171     int i_frame_num;
172
173     int b_mbaff;
174     int b_field_pic;
175     int b_bottom_field;
176
177     int i_idr_pic_id;   /* -1 if nal_type != 5 */
178
179     int i_poc_lsb;
180     int i_delta_poc_bottom;
181
182     int i_delta_poc[2];
183     int i_redundant_pic_cnt;
184
185     int b_direct_spatial_mv_pred;
186
187     int b_num_ref_idx_override;
188     int i_num_ref_idx_l0_active;
189     int i_num_ref_idx_l1_active;
190
191     int b_ref_pic_list_reordering_l0;
192     int b_ref_pic_list_reordering_l1;
193     struct {
194         int idc;
195         int arg;
196     } ref_pic_list_order[2][16];
197
198     int i_cabac_init_idc;
199
200     int i_qp;
201     int i_qp_delta;
202     int b_sp_for_swidth;
203     int i_qs_delta;
204
205     /* deblocking filter */
206     int i_disable_deblocking_filter_idc;
207     int i_alpha_c0_offset;
208     int i_beta_offset;
209
210 } x264_slice_header_t;
211
212 /* From ffmpeg
213  */
214 #define X264_SCAN8_SIZE (6*8)
215 #define X264_SCAN8_0 (4+1*8)
216
217 static const int x264_scan8[16+2*4+3] =
218 {
219     /* Luma */
220     4+1*8, 5+1*8, 4+2*8, 5+2*8,
221     6+1*8, 7+1*8, 6+2*8, 7+2*8,
222     4+3*8, 5+3*8, 4+4*8, 5+4*8,
223     6+3*8, 7+3*8, 6+4*8, 7+4*8,
224
225     /* Cb */
226     1+1*8, 2+1*8,
227     1+2*8, 2+2*8,
228
229     /* Cr */
230     1+4*8, 2+4*8,
231     1+5*8, 2+5*8,
232
233     /* Luma DC */
234     4+5*8,
235
236     /* Chroma DC */
237     5+5*8, 6+5*8
238 };
239 /*
240    0 1 2 3 4 5 6 7
241  0
242  1   B B   L L L L
243  2   B B   L L L L
244  3         L L L L
245  4   R R   L L L L
246  5   R R   DyDuDv
247 */
248
249 typedef struct x264_ratecontrol_t   x264_ratecontrol_t;
250
251 struct x264_t
252 {
253     /* encoder parameters */
254     x264_param_t    param;
255
256     x264_t          *thread[X264_THREAD_MAX];
257     x264_pthread_t  thread_handle;
258     int             b_thread_active;
259     int             i_thread_phase; /* which thread to use for the next frame */
260
261     /* bitstream output */
262     struct
263     {
264         int         i_nal;
265         x264_nal_t  nal[X264_NAL_MAX];
266         int         i_bitstream;    /* size of p_bitstream */
267         uint8_t     *p_bitstream;   /* will hold data for all nal */
268         bs_t        bs;
269         int         i_frame_size;
270     } out;
271
272     /**** thread synchronization starts here ****/
273
274     /* frame number/poc */
275     int             i_frame;
276
277     int             i_frame_offset; /* decoding only */
278     int             i_frame_num;    /* decoding only */
279     int             i_poc_msb;      /* decoding only */
280     int             i_poc_lsb;      /* decoding only */
281     int             i_poc;          /* decoding only */
282
283     int             i_thread_num;   /* threads only */
284     int             i_nal_type;     /* threads only */
285     int             i_nal_ref_idc;  /* threads only */
286
287     /* We use only one SPS and one PPS */
288     x264_sps_t      sps_array[1];
289     x264_sps_t      *sps;
290     x264_pps_t      pps_array[1];
291     x264_pps_t      *pps;
292     int             i_idr_pic_id;
293
294     /* quantization matrix for decoding, [cqm][qp%6][coef_y][coef_x] */
295     int             (*dequant4_mf[4])[4][4]; /* [4][6][4][4] */
296     int             (*dequant8_mf[2])[8][8]; /* [2][6][8][8] */
297     /* quantization matrix for trellis, [cqm][qp][coef] */
298     int             (*unquant4_mf[4])[16];   /* [4][52][16] */
299     int             (*unquant8_mf[2])[64];   /* [2][52][64] */
300     /* quantization matrix for deadzone */
301     uint16_t        (*quant4_mf[4])[16];     /* [4][52][16] */
302     uint16_t        (*quant8_mf[2])[64];     /* [2][52][64] */
303     uint16_t        (*quant4_bias[4])[16];   /* [4][52][16] */
304     uint16_t        (*quant8_bias[2])[64];   /* [2][52][64] */
305
306     const uint8_t   *chroma_qp_table; /* includes both the nonlinear luma->chroma mapping and chroma_qp_offset */
307
308     DECLARE_ALIGNED_16( uint32_t nr_residual_sum[2][64] );
309     DECLARE_ALIGNED_16( uint16_t nr_offset[2][64] );
310     uint32_t        nr_count[2];
311
312     /* Slice header */
313     x264_slice_header_t sh;
314
315     /* cabac context */
316     x264_cabac_t    cabac;
317
318     struct
319     {
320         /* Frames to be encoded (whose types have been decided) */
321         x264_frame_t *current[X264_BFRAME_MAX*4+3];
322         /* Temporary buffer (frames types not yet decided) */
323         x264_frame_t *next[X264_BFRAME_MAX*4+3];
324         /* Unused frames */
325         x264_frame_t *unused[X264_BFRAME_MAX*4 + X264_THREAD_MAX*2 + 16+4];
326         /* For adaptive B decision */
327         x264_frame_t *last_nonb;
328
329         /* frames used for reference + sentinels */
330         x264_frame_t *reference[16+2];
331
332         int i_last_idr; /* Frame number of the last IDR */
333
334         int i_input;    /* Number of input frames already accepted */
335
336         int i_max_dpb;  /* Number of frames allocated in the decoded picture buffer */
337         int i_max_ref0;
338         int i_max_ref1;
339         int i_delay;    /* Number of frames buffered for B reordering */
340         int b_have_lowres;  /* Whether 1/2 resolution luma planes are being used */
341         int b_have_sub8x8_esa;
342     } frames;
343
344     /* current frame being encoded */
345     x264_frame_t    *fenc;
346
347     /* frame being reconstructed */
348     x264_frame_t    *fdec;
349
350     /* references lists */
351     int             i_ref0;
352     x264_frame_t    *fref0[16+3];     /* ref list 0 */
353     int             i_ref1;
354     x264_frame_t    *fref1[16+3];     /* ref list 1 */
355     int             b_ref_reorder[2];
356
357
358
359     /* Current MB DCT coeffs */
360     struct
361     {
362         DECLARE_ALIGNED_16( int16_t luma16x16_dc[16] );
363         DECLARE_ALIGNED_16( int16_t chroma_dc[2][4] );
364         // FIXME share memory?
365         DECLARE_ALIGNED_16( int16_t luma8x8[4][64] );
366         DECLARE_ALIGNED_16( int16_t luma4x4[16+8][16] );
367     } dct;
368
369     /* MB table and cache for current frame/mb */
370     struct
371     {
372         int     i_mb_count;                 /* number of mbs in a frame */
373
374         /* Strides */
375         int     i_mb_stride;
376         int     i_b8_stride;
377         int     i_b4_stride;
378
379         /* Current index */
380         int     i_mb_x;
381         int     i_mb_y;
382         int     i_mb_xy;
383         int     i_b8_xy;
384         int     i_b4_xy;
385
386         /* Search parameters */
387         int     i_me_method;
388         int     i_subpel_refine;
389         int     b_chroma_me;
390         int     b_trellis;
391         int     b_noise_reduction;
392         int     i_psy_rd; /* Psy RD strength--fixed point value*/
393         int     i_psy_trellis; /* Psy trellis strength--fixed point value*/
394
395         int     b_interlaced;
396
397         /* Allowed qpel MV range to stay within the picture + emulated edge pixels */
398         int     mv_min[2];
399         int     mv_max[2];
400         /* Subpel MV range for motion search.
401          * same mv_min/max but includes levels' i_mv_range. */
402         int     mv_min_spel[2];
403         int     mv_max_spel[2];
404         /* Fullpel MV range for motion search */
405         int     mv_min_fpel[2];
406         int     mv_max_fpel[2];
407
408         /* neighboring MBs */
409         unsigned int i_neighbour;
410         unsigned int i_neighbour8[4];       /* neighbours of each 8x8 or 4x4 block that are available */
411         unsigned int i_neighbour4[16];      /* at the time the block is coded */
412         int     i_mb_type_top;
413         int     i_mb_type_left;
414         int     i_mb_type_topleft;
415         int     i_mb_type_topright;
416         int     i_mb_prev_xy;
417         int     i_mb_top_xy;
418
419         /**** thread synchronization ends here ****/
420         /* subsequent variables are either thread-local or constant,
421          * and won't be copied from one thread to another */
422
423         /* mb table */
424         int8_t  *type;                      /* mb type */
425         int8_t  *qp;                        /* mb qp */
426         int16_t *cbp;                       /* mb cbp: 0x0?: luma, 0x?0: chroma, 0x100: luma dc, 0x0200 and 0x0400: chroma dc  (all set for PCM)*/
427         int8_t  (*intra4x4_pred_mode)[8];   /* intra4x4 pred mode. for non I4x4 set to I_PRED_4x4_DC(2) */
428                                             /* actually has only 7 entries; set to 8 for write-combining optimizations */
429         uint8_t (*non_zero_count)[16+4+4];  /* nzc. for I_PCM set to 16 */
430         int8_t  *chroma_pred_mode;          /* chroma_pred_mode. cabac only. for non intra I_PRED_CHROMA_DC(0) */
431         int16_t (*mv[2])[2];                /* mb mv. set to 0 for intra mb */
432         int16_t (*mvd[2])[2];               /* mb mv difference with predict. set to 0 if intra. cabac only */
433         int8_t   *ref[2];                   /* mb ref. set to -1 if non used (intra or Lx only) */
434         int16_t (*mvr[2][32])[2];           /* 16x16 mv for each possible ref */
435         int8_t  *skipbp;                    /* block pattern for SKIP or DIRECT (sub)mbs. B-frames + cabac only */
436         int8_t  *mb_transform_size;         /* transform_size_8x8_flag of each mb */
437         uint8_t *intra_border_backup[2][3]; /* bottom pixels of the previous mb row, used for intra prediction after the framebuffer has been deblocked */
438         uint8_t (*nnz_backup)[16];          /* when using cavlc + 8x8dct, the deblocker uses a modified nnz */
439
440         /* current value */
441         int     i_type;
442         int     i_partition;
443         DECLARE_ALIGNED_4( uint8_t i_sub_partition[4] );
444         int     b_transform_8x8;
445
446         int     i_cbp_luma;
447         int     i_cbp_chroma;
448
449         int     i_intra16x16_pred_mode;
450         int     i_chroma_pred_mode;
451
452         /* skip flags for i4x4 and i8x8
453          * 0 = encode as normal.
454          * 1 (non-RD only) = the DCT is still in h->dct, restore fdec and skip reconstruction.
455          * 2 (RD only) = the DCT has since been overwritten by RD; restore that too. */
456         int i_skip_intra;
457         /* skip flag for motion compensation */
458         /* if we've already done MC, we don't need to do it again */
459         int b_skip_mc;
460
461         struct
462         {
463             /* space for p_fenc and p_fdec */
464 #define FENC_STRIDE 16
465 #define FDEC_STRIDE 32
466             DECLARE_ALIGNED_16( uint8_t fenc_buf[24*FENC_STRIDE] );
467             DECLARE_ALIGNED_16( uint8_t fdec_buf[27*FDEC_STRIDE] );
468
469             /* i4x4 and i8x8 backup data, for skipping the encode stage when possible */
470             DECLARE_ALIGNED_16( uint8_t i4x4_fdec_buf[16*16] );
471             DECLARE_ALIGNED_16( uint8_t i8x8_fdec_buf[16*16] );
472             DECLARE_ALIGNED_16( int16_t i8x8_dct_buf[3][64] );
473             DECLARE_ALIGNED_16( int16_t i4x4_dct_buf[15][16] );
474
475             /* Psy trellis DCT data */
476             DECLARE_ALIGNED_16( int16_t fenc_dct8[4][64] );
477             DECLARE_ALIGNED_16( int16_t fenc_dct4[16][16] );
478
479             /* Psy RD SATD scores */
480             int fenc_satd[4][4];
481             int fenc_satd_sum;
482             int fenc_sa8d[2][2];
483             int fenc_sa8d_sum;
484
485             /* pointer over mb of the frame to be compressed */
486             uint8_t *p_fenc[3];
487             /* pointer to the actual source frame, not a block copy */
488             uint8_t *p_fenc_plane[3];
489
490             /* pointer over mb of the frame to be reconstructed  */
491             uint8_t *p_fdec[3];
492
493             /* pointer over mb of the references */
494             int i_fref[2];
495             uint8_t *p_fref[2][32][4+2]; /* last: lN, lH, lV, lHV, cU, cV */
496             uint16_t *p_integral[2][16];
497
498             /* fref stride */
499             int     i_stride[3];
500         } pic;
501
502         /* cache */
503         struct
504         {
505             /* real intra4x4_pred_mode if I_4X4 or I_8X8, I_PRED_4x4_DC if mb available, -1 if not */
506             int8_t  intra4x4_pred_mode[X264_SCAN8_SIZE];
507
508             /* i_non_zero_count if available else 0x80 */
509             uint8_t non_zero_count[X264_SCAN8_SIZE];
510
511             /* -1 if unused, -2 if unavailable */
512             DECLARE_ALIGNED_4( int8_t ref[2][X264_SCAN8_SIZE] );
513
514             /* 0 if not available */
515             DECLARE_ALIGNED_16( int16_t mv[2][X264_SCAN8_SIZE][2] );
516             DECLARE_ALIGNED_8( int16_t mvd[2][X264_SCAN8_SIZE][2] );
517
518             /* 1 if SKIP or DIRECT. set only for B-frames + CABAC */
519             DECLARE_ALIGNED_4( int8_t skip[X264_SCAN8_SIZE] );
520
521             DECLARE_ALIGNED_16( int16_t direct_mv[2][X264_SCAN8_SIZE][2] );
522             DECLARE_ALIGNED_4( int8_t  direct_ref[2][X264_SCAN8_SIZE] );
523             DECLARE_ALIGNED_4( int16_t pskip_mv[2] );
524
525             /* number of neighbors (top and left) that used 8x8 dct */
526             int     i_neighbour_transform_size;
527             int     i_neighbour_interlaced;
528         } cache;
529
530         /* */
531         int     i_qp;       /* current qp */
532         int     i_chroma_qp;
533         int     i_last_qp;  /* last qp */
534         int     i_last_dqp; /* last delta qp */
535         int     b_variable_qp; /* whether qp is allowed to vary per macroblock */
536         int     b_lossless;
537         int     b_direct_auto_read; /* take stats for --direct auto from the 2pass log */
538         int     b_direct_auto_write; /* analyse direct modes, to use and/or save */
539
540         /* B_direct and weighted prediction */
541         int16_t dist_scale_factor[16][2];
542         int16_t bipred_weight[32][4];
543         /* maps fref1[0]'s ref indices into the current list0 */
544         int8_t  map_col_to_list0_buf[2]; // for negative indices
545         int8_t  map_col_to_list0[16];
546     } mb;
547
548     /* rate control encoding only */
549     x264_ratecontrol_t *rc;
550
551     /* stats */
552     struct
553     {
554         /* Current frame stats */
555         struct
556         {
557             /* MV bits (MV+Ref+Block Type) */
558             int i_mv_bits;
559             /* Texture bits (DCT coefs) */
560             int i_tex_bits;
561             /* ? */
562             int i_misc_bits;
563             /* MB type counts */
564             int i_mb_count[19];
565             int i_mb_count_i;
566             int i_mb_count_p;
567             int i_mb_count_skip;
568             int i_mb_count_8x8dct[2];
569             int i_mb_count_ref[2][32];
570             int i_mb_partition[17];
571             /* Estimated (SATD) cost as Intra/Predicted frame */
572             /* XXX: both omit the cost of MBs coded as P_SKIP */
573             int i_intra_cost;
574             int i_inter_cost;
575             int i_mbs_analysed;
576             /* Adaptive direct mv pred */
577             int i_direct_score[2];
578             /* Metrics */
579             int64_t i_ssd[3];
580             double f_ssim;
581         } frame;
582
583         /* Cumulated stats */
584
585         /* per slice info */
586         int     i_slice_count[5];
587         int64_t i_slice_size[5];
588         double  f_slice_qp[5];
589         int     i_consecutive_bframes[X264_BFRAME_MAX+1];
590         /* */
591         int64_t i_ssd_global[5];
592         double  f_psnr_average[5];
593         double  f_psnr_mean_y[5];
594         double  f_psnr_mean_u[5];
595         double  f_psnr_mean_v[5];
596         double  f_ssim_mean_y[5];
597         /* */
598         int64_t i_mb_count[5][19];
599         int64_t i_mb_partition[2][17];
600         int64_t i_mb_count_8x8dct[2];
601         int64_t i_mb_count_ref[2][2][32];
602         /* */
603         int     i_direct_score[2];
604         int     i_direct_frames[2];
605
606     } stat;
607
608     void *scratch_buffer; /* for any temporary storage that doesn't want repeated malloc */
609
610     /* CPU functions dependents */
611     x264_predict_t      predict_16x16[4+3];
612     x264_predict_t      predict_8x8c[4+3];
613     x264_predict8x8_t   predict_8x8[9+3];
614     x264_predict_t      predict_4x4[9+3];
615
616     x264_pixel_function_t pixf;
617     x264_mc_functions_t   mc;
618     x264_dct_function_t   dctf;
619     x264_zigzag_function_t zigzagf;
620     x264_quant_function_t quantf;
621     x264_deblock_function_t loopf;
622
623 #if VISUALIZE
624     struct visualize_t *visualize;
625 #endif
626 };
627
628 // included at the end because it needs x264_t
629 #include "macroblock.h"
630
631 #ifdef HAVE_MMX
632 #include "x86/util.h"
633 #endif
634
635 #endif
636