1 /*****************************************************************************
2 * common.h: h264 encoder
3 *****************************************************************************
4 * Copyright (C) 2003-2008 x264 project
6 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7 * Loren Merritt <lorenm@u.washington.edu>
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.
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.
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 *****************************************************************************/
27 /****************************************************************************
29 ****************************************************************************/
30 #define X264_MIN(a,b) ( (a)<(b) ? (a) : (b) )
31 #define X264_MAX(a,b) ( (a)>(b) ? (a) : (b) )
32 #define X264_MIN3(a,b,c) X264_MIN((a),X264_MIN((b),(c)))
33 #define X264_MAX3(a,b,c) X264_MAX((a),X264_MAX((b),(c)))
34 #define X264_MIN4(a,b,c,d) X264_MIN((a),X264_MIN3((b),(c),(d)))
35 #define X264_MAX4(a,b,c,d) X264_MAX((a),X264_MAX3((b),(c),(d)))
36 #define XCHG(type,a,b) do{ type t = a; a = b; b = t; } while(0)
37 #define IS_DISPOSABLE(type) ( type == X264_TYPE_B )
38 #define FIX8(f) ((int)(f*(1<<8)+.5))
40 #define CHECKED_MALLOC( var, size )\
42 var = x264_malloc( size );\
46 #define CHECKED_MALLOCZERO( var, size )\
48 CHECKED_MALLOC( var, size );\
49 memset( var, 0, size );\
52 #define X264_BFRAME_MAX 16
53 #define X264_THREAD_MAX 128
54 #define X264_PCM_COST (386*8)
55 #define X264_LOOKAHEAD_MAX 250
56 // arbitrary, but low because SATD scores are 1/4 normal
57 #define X264_LOOKAHEAD_QP 12
59 // number of pixels (per thread) in progress at any given time.
60 // 16 for the macroblock in progress + 3 for deblocking + 3 for motion compensation filter + 2 for extra safety
61 #define X264_THREAD_HEIGHT 24
63 /* WEIGHTP_FAKE is set when mb_tree & psy are enabled, but normal weightp is disabled
64 * (such as in baseline). It checks for fades in lookahead and adjusts qp accordingly
65 * to increase quality. Defined as (-1) so that if(i_weighted_pred > 0) is true only when
66 * real weights are being used. */
68 #define X264_WEIGHTP_FAKE (-1)
70 #define NALU_OVERHEAD 5 // startcode + NAL type costs 5 bytes per frame
71 #define FILLER_OVERHEAD (NALU_OVERHEAD+1)
73 /****************************************************************************
75 ****************************************************************************/
84 /* Unions for type-punning.
85 * Mn: load or store n bits, aligned, native-endian
86 * CPn: copy n bits, aligned, native-endian
87 * we don't use memcpy for CPn because memcpy's args aren't assumed to be aligned */
88 typedef union { uint16_t i; uint8_t c[2]; } MAY_ALIAS x264_union16_t;
89 typedef union { uint32_t i; uint16_t b[2]; uint8_t c[4]; } MAY_ALIAS x264_union32_t;
90 typedef union { uint64_t i; uint32_t a[2]; uint16_t b[4]; uint8_t c[8]; } MAY_ALIAS x264_union64_t;
91 #define M16(src) (((x264_union16_t*)(src))->i)
92 #define M32(src) (((x264_union32_t*)(src))->i)
93 #define M64(src) (((x264_union64_t*)(src))->i)
94 #define CP16(dst,src) M16(dst) = M16(src)
95 #define CP32(dst,src) M32(dst) = M32(src)
96 #define CP64(dst,src) M64(dst) = M64(src)
109 /****************************************************************************
111 ****************************************************************************/
112 /* x264_malloc : will do or emulate a memalign
113 * you have to use x264_free for buffers allocated with x264_malloc */
114 void *x264_malloc( int );
115 void x264_free( void * );
117 /* x264_slurp_file: malloc space for the whole file and read it */
118 char *x264_slurp_file( const char *filename );
120 /* mdate: return the current date in microsecond */
121 int64_t x264_mdate( void );
123 /* x264_param2string: return a (malloced) string containing most of
124 * the encoding options */
125 char *x264_param2string( x264_param_t *p, int b_res );
127 int x264_nal_encode( uint8_t *dst, x264_nal_t *nal, int b_annexb, int b_long_startcode );
130 void x264_log( x264_t *h, int i_level, const char *psz_fmt, ... );
132 void x264_reduce_fraction( int *n, int *d );
133 void x264_init_vlc_tables();
135 static inline uint8_t x264_clip_uint8( int x )
137 return x&(~255) ? (-x)>>31 : x;
140 static inline int x264_clip3( int v, int i_min, int i_max )
142 return ( (v < i_min) ? i_min : (v > i_max) ? i_max : v );
145 static inline double x264_clip3f( double v, double f_min, double f_max )
147 return ( (v < f_min) ? f_min : (v > f_max) ? f_max : v );
150 static inline int x264_median( int a, int b, int c )
152 int t = (a-b)&((a-b)>>31);
155 b -= (b-c)&((b-c)>>31);
156 b += (a-b)&((a-b)>>31);
160 static inline void x264_median_mv( int16_t *dst, int16_t *a, int16_t *b, int16_t *c )
162 dst[0] = x264_median( a[0], b[0], c[0] );
163 dst[1] = x264_median( a[1], b[1], c[1] );
166 static inline int x264_predictor_difference( int16_t (*mvc)[2], intptr_t i_mvc )
169 for( i = 0; i < i_mvc-1; i++ )
171 sum += abs( mvc[i][0] - mvc[i+1][0] )
172 + abs( mvc[i][1] - mvc[i+1][1] );
177 static inline uint16_t x264_cabac_mvd_sum( uint8_t *mvdleft, uint8_t *mvdtop )
179 int amvd0 = abs(mvdleft[0]) + abs(mvdtop[0]);
180 int amvd1 = abs(mvdleft[1]) + abs(mvdtop[1]);
181 amvd0 = (amvd0 > 2) + (amvd0 > 32);
182 amvd1 = (amvd1 > 2) + (amvd1 > 32);
183 return amvd0 + (amvd1<<8);
186 extern const uint8_t x264_exp2_lut[64];
187 extern const float x264_log2_lut[128];
188 extern const float x264_log2_lz_lut[32];
190 /* Not a general-purpose function; multiplies input by -1/6 to convert
192 static ALWAYS_INLINE int x264_exp2fix8( float x )
194 int i = x*(-64.f/6.f) + 512.5f;
195 if( i < 0 ) return 0;
196 if( i > 1023 ) return 0xffff;
197 return (x264_exp2_lut[i&63]+256) << (i>>6) >> 8;
200 static ALWAYS_INLINE float x264_log2( uint32_t x )
202 int lz = x264_clz( x );
203 return x264_log2_lut[(x<<lz>>24)&0x7f] + x264_log2_lz_lut[lz];
206 /****************************************************************************
208 ****************************************************************************/
218 static const char slice_type_to_char[] = { 'P', 'B', 'I', 'S', 'S' };
220 enum sei_payload_type_e
222 SEI_BUFFERING_PERIOD = 0,
224 SEI_PAN_SCAN_RECT = 2,
226 SEI_USER_DATA_REGISTERED = 4,
227 SEI_USER_DATA_UNREGISTERED = 5,
228 SEI_RECOVERY_POINT = 6,
248 int i_idr_pic_id; /* -1 if nal_type != 5 */
251 int i_delta_poc_bottom;
254 int i_redundant_pic_cnt;
256 int b_direct_spatial_mv_pred;
258 int b_num_ref_idx_override;
259 int i_num_ref_idx_l0_active;
260 int i_num_ref_idx_l1_active;
262 int b_ref_pic_list_reordering_l0;
263 int b_ref_pic_list_reordering_l1;
268 } ref_pic_list_order[2][16];
270 /* P-frame weighting */
271 x264_weight_t weight[32][3];
273 int i_mmco_remove_from_end;
274 int i_mmco_command_count;
275 struct /* struct for future expansion */
277 int i_difference_of_pic_nums;
281 int i_cabac_init_idc;
288 /* deblocking filter */
289 int i_disable_deblocking_filter_idc;
290 int i_alpha_c0_offset;
293 } x264_slice_header_t;
295 typedef struct x264_lookahead_t
297 volatile uint8_t b_exit_thread;
298 uint8_t b_thread_active;
299 uint8_t b_analyse_keyframe;
301 int i_slicetype_length;
302 x264_frame_t *last_nonb;
303 x264_synch_frame_list_t ifbuf;
304 x264_synch_frame_list_t next;
305 x264_synch_frame_list_t ofbuf;
310 #define X264_SCAN8_SIZE (6*8)
311 #define X264_SCAN8_0 (4+1*8)
313 static const int x264_scan8[16+2*4+3] =
316 4+1*8, 5+1*8, 4+2*8, 5+2*8,
317 6+1*8, 7+1*8, 6+2*8, 7+2*8,
318 4+3*8, 5+3*8, 4+4*8, 5+4*8,
319 6+3*8, 7+3*8, 6+4*8, 7+4*8,
345 typedef struct x264_ratecontrol_t x264_ratecontrol_t;
349 /* encoder parameters */
352 x264_t *thread[X264_THREAD_MAX+1];
353 x264_pthread_t thread_handle;
355 int i_thread_phase; /* which thread to use for the next frame */
356 int i_threadslice_start; /* first row in this thread slice */
357 int i_threadslice_end; /* row after the end of this thread slice */
359 /* bitstream output */
363 int i_nals_allocated;
365 int i_bitstream; /* size of p_bitstream */
366 uint8_t *p_bitstream; /* will hold data for all nal */
373 /**** thread synchronization starts here ****/
375 /* frame number/poc */
379 int i_thread_frames; /* Number of different frames being encoded by threads;
380 * 1 when sliced-threads is on. */
384 int i_disp_fields; /* Number of displayed fields (both coded and implied via pic_struct) */
385 int i_disp_fields_last_frame;
386 int i_prev_duration; /* Duration of previous frame */
387 int i_coded_fields; /* Number of coded fields (both coded and implied via pic_struct) */
388 int i_cpb_delay; /* Equal to number of fields preceding this field
389 * since last buffering_period SEI */
390 int i_coded_fields_lookahead; /* Use separate counters for lookahead */
391 int i_cpb_delay_lookahead;
393 /* We use only one SPS and one PPS */
394 x264_sps_t sps_array[1];
396 x264_pps_t pps_array[1];
400 /* Timebase multiplier for DTS compression */
401 int i_dts_compress_multiplier;
403 /* quantization matrix for decoding, [cqm][qp%6][coef] */
404 int (*dequant4_mf[4])[16]; /* [4][6][16] */
405 int (*dequant8_mf[2])[64]; /* [2][6][64] */
406 /* quantization matrix for trellis, [cqm][qp][coef] */
407 int (*unquant4_mf[4])[16]; /* [4][52][16] */
408 int (*unquant8_mf[2])[64]; /* [2][52][64] */
409 /* quantization matrix for deadzone */
410 uint16_t (*quant4_mf[4])[16]; /* [4][52][16] */
411 uint16_t (*quant8_mf[2])[64]; /* [2][52][64] */
412 uint16_t (*quant4_bias[4])[16]; /* [4][52][16] */
413 uint16_t (*quant8_bias[2])[64]; /* [2][52][64] */
415 /* mv/ref cost arrays. Indexed by lambda instead of
416 * qp because, due to rounding, some quantizers share
417 * lambdas. This saves memory. */
418 uint16_t *cost_mv[92];
419 uint16_t *cost_mv_fpel[92][4];
421 const uint8_t *chroma_qp_table; /* includes both the nonlinear luma->chroma mapping and chroma_qp_offset */
424 x264_slice_header_t sh;
431 /* Frames to be encoded (whose types have been decided) */
432 x264_frame_t **current;
433 /* Unused frames: 0 = fenc, 1 = fdec */
434 x264_frame_t **unused[2];
436 /* Unused blank frames (for duplicates) */
437 x264_frame_t **blank_unused;
439 /* frames used for reference + sentinels */
440 x264_frame_t *reference[16+2];
442 int i_last_keyframe; /* Frame number of the last keyframe */
444 int i_input; /* Number of input frames already accepted */
446 int i_max_dpb; /* Number of frames allocated in the decoded picture buffer */
449 int i_delay; /* Number of frames buffered for B reordering */
451 int64_t i_bframe_delay_time;
452 int64_t i_init_delta;
453 int64_t i_prev_reordered_pts[2];
454 int64_t i_largest_pts;
455 int64_t i_second_largest_pts;
456 int b_have_lowres; /* Whether 1/2 resolution luma planes are being used */
457 int b_have_sub8x8_esa;
460 /* current frame being encoded */
463 /* frame being reconstructed */
466 /* references lists */
468 x264_frame_t *fref0[16+3]; /* ref list 0 */
470 x264_frame_t *fref1[16+3]; /* ref list 1 */
471 int b_ref_reorder[2];
474 int initial_cpb_removal_delay;
477 /* Current MB DCT coeffs */
480 ALIGNED_16( int16_t luma16x16_dc[16] );
481 ALIGNED_16( int16_t chroma_dc[2][4] );
482 // FIXME share memory?
483 ALIGNED_16( int16_t luma8x8[4][64] );
484 ALIGNED_16( int16_t luma4x4[16+8][16] );
487 /* MB table and cache for current frame/mb */
490 int i_mb_count; /* number of mbs in a frame */
504 /* Search parameters */
509 int b_noise_reduction;
511 int i_psy_rd; /* Psy RD strength--fixed point value*/
512 int i_psy_trellis; /* Psy trellis strength--fixed point value*/
516 /* Allowed qpel MV range to stay within the picture + emulated edge pixels */
519 /* Subpel MV range for motion search.
520 * same mv_min/max but includes levels' i_mv_range. */
523 /* Fullpel MV range for motion search */
527 /* neighboring MBs */
528 unsigned int i_neighbour;
529 unsigned int i_neighbour8[4]; /* neighbours of each 8x8 or 4x4 block that are available */
530 unsigned int i_neighbour4[16]; /* at the time the block is coded */
531 unsigned int i_neighbour_intra; /* for constrained intra pred */
534 int i_mb_type_topleft;
535 int i_mb_type_topright;
539 /**** thread synchronization ends here ****/
540 /* subsequent variables are either thread-local or constant,
541 * and won't be copied from one thread to another */
544 int8_t *type; /* mb type */
545 uint8_t *partition; /* mb partition */
546 int8_t *qp; /* mb qp */
547 int16_t *cbp; /* mb cbp: 0x0?: luma, 0x?0: chroma, 0x100: luma dc, 0x0200 and 0x0400: chroma dc (all set for PCM)*/
548 int8_t (*intra4x4_pred_mode)[8]; /* intra4x4 pred mode. for non I4x4 set to I_PRED_4x4_DC(2) */
549 /* actually has only 7 entries; set to 8 for write-combining optimizations */
550 uint8_t (*non_zero_count)[16+4+4]; /* nzc. for I_PCM set to 16 */
551 int8_t *chroma_pred_mode; /* chroma_pred_mode. cabac only. for non intra I_PRED_CHROMA_DC(0) */
552 int16_t (*mv[2])[2]; /* mb mv. set to 0 for intra mb */
553 uint8_t (*mvd[2])[2]; /* absolute value of mb mv difference with predict, clipped to [0,33]. set to 0 if intra. cabac only */
554 int8_t *ref[2]; /* mb ref. set to -1 if non used (intra or Lx only) */
555 int16_t (*mvr[2][32])[2]; /* 16x16 mv for each possible ref */
556 int8_t *skipbp; /* block pattern for SKIP or DIRECT (sub)mbs. B-frames + cabac only */
557 int8_t *mb_transform_size; /* transform_size_8x8_flag of each mb */
558 uint8_t *intra_border_backup[2][3]; /* bottom pixels of the previous mb row, used for intra prediction after the framebuffer has been deblocked */
560 /* buffer for weighted versions of the reference frames */
561 uint8_t *p_weight_buf[16];
566 ALIGNED_4( uint8_t i_sub_partition[4] );
572 int i_intra16x16_pred_mode;
573 int i_chroma_pred_mode;
575 /* skip flags for i4x4 and i8x8
576 * 0 = encode as normal.
577 * 1 (non-RD only) = the DCT is still in h->dct, restore fdec and skip reconstruction.
578 * 2 (RD only) = the DCT has since been overwritten by RD; restore that too. */
580 /* skip flag for motion compensation */
581 /* if we've already done MC, we don't need to do it again */
583 /* set to true if we are re-encoding a macroblock. */
585 int ip_offset; /* Used by PIR to offset the quantizer of intra-refresh blocks. */
589 /* space for p_fenc and p_fdec */
590 #define FENC_STRIDE 16
591 #define FDEC_STRIDE 32
592 ALIGNED_16( uint8_t fenc_buf[24*FENC_STRIDE] );
593 ALIGNED_16( uint8_t fdec_buf[27*FDEC_STRIDE] );
595 /* i4x4 and i8x8 backup data, for skipping the encode stage when possible */
596 ALIGNED_16( uint8_t i4x4_fdec_buf[16*16] );
597 ALIGNED_16( uint8_t i8x8_fdec_buf[16*16] );
598 ALIGNED_16( int16_t i8x8_dct_buf[3][64] );
599 ALIGNED_16( int16_t i4x4_dct_buf[15][16] );
600 uint32_t i4x4_nnz_buf[4];
601 uint32_t i8x8_nnz_buf[4];
605 /* Psy trellis DCT data */
606 ALIGNED_16( int16_t fenc_dct8[4][64] );
607 ALIGNED_16( int16_t fenc_dct4[16][16] );
609 /* Psy RD SATD/SA8D scores cache */
610 ALIGNED_16( uint64_t fenc_hadamard_cache[9] );
611 ALIGNED_16( uint32_t fenc_satd_cache[32] );
613 /* pointer over mb of the frame to be compressed */
615 /* pointer to the actual source frame, not a block copy */
616 uint8_t *p_fenc_plane[3];
618 /* pointer over mb of the frame to be reconstructed */
621 /* pointer over mb of the references */
623 uint8_t *p_fref[2][32][4+2]; /* last: lN, lH, lV, lHV, cU, cV */
624 uint8_t *p_fref_w[32]; /* weighted fullpel luma */
625 uint16_t *p_integral[2][16];
634 /* real intra4x4_pred_mode if I_4X4 or I_8X8, I_PRED_4x4_DC if mb available, -1 if not */
635 ALIGNED_8( int8_t intra4x4_pred_mode[X264_SCAN8_SIZE] );
637 /* i_non_zero_count if available else 0x80 */
638 ALIGNED_4( uint8_t non_zero_count[X264_SCAN8_SIZE] );
640 /* -1 if unused, -2 if unavailable */
641 ALIGNED_4( int8_t ref[2][X264_SCAN8_SIZE] );
643 /* 0 if not available */
644 ALIGNED_16( int16_t mv[2][X264_SCAN8_SIZE][2] );
645 ALIGNED_8( uint8_t mvd[2][X264_SCAN8_SIZE][2] );
647 /* 1 if SKIP or DIRECT. set only for B-frames + CABAC */
648 ALIGNED_4( int8_t skip[X264_SCAN8_SIZE] );
650 ALIGNED_4( int16_t direct_mv[2][4][2] );
651 ALIGNED_4( int8_t direct_ref[2][4] );
652 int direct_partition;
653 ALIGNED_4( int16_t pskip_mv[2] );
655 /* number of neighbors (top and left) that used 8x8 dct */
656 int i_neighbour_transform_size;
657 int i_neighbour_interlaced;
665 int i_qp; /* current qp */
667 int i_last_qp; /* last qp */
668 int i_last_dqp; /* last delta qp */
669 int b_variable_qp; /* whether qp is allowed to vary per macroblock */
671 int b_direct_auto_read; /* take stats for --direct auto from the 2pass log */
672 int b_direct_auto_write; /* analyse direct modes, to use and/or save */
675 int i_trellis_lambda2[2][2]; /* [luma,chroma][inter,intra] */
677 int i_chroma_lambda2_offset;
679 /* B_direct and weighted prediction */
680 int16_t dist_scale_factor_buf[2][32][4];
681 int16_t (*dist_scale_factor)[4];
682 int8_t bipred_weight_buf[2][32][4];
683 int8_t (*bipred_weight)[4];
684 /* maps fref1[0]'s ref indices into the current list0 */
685 #define map_col_to_list0(col) h->mb.map_col_to_list0[(col)+2]
686 int8_t map_col_to_list0[18];
687 int ref_blind_dupe; /* The index of the blind reference frame duplicate. */
690 /* rate control encoding only */
691 x264_ratecontrol_t *rc;
696 /* Current frame stats */
699 /* MV bits (MV+Ref+Block Type) */
701 /* Texture bits (DCT coefs) */
710 int i_mb_count_8x8dct[2];
711 int i_mb_count_ref[2][32];
712 int i_mb_partition[17];
714 int i_mb_pred_mode[3][13];
715 /* Adaptive direct mv pred */
716 int i_direct_score[2];
722 /* Cumulated stats */
725 int i_frame_count[5];
726 int64_t i_frame_size[5];
727 double f_frame_qp[5];
728 int i_consecutive_bframes[X264_BFRAME_MAX+1];
730 int64_t i_ssd_global[5];
731 double f_psnr_average[5];
732 double f_psnr_mean_y[5];
733 double f_psnr_mean_u[5];
734 double f_psnr_mean_v[5];
735 double f_ssim_mean_y[5];
737 int64_t i_mb_count[5][19];
738 int64_t i_mb_partition[2][17];
739 int64_t i_mb_count_8x8dct[2];
740 int64_t i_mb_count_ref[2][2][32];
742 int64_t i_mb_pred_mode[3][13];
744 int i_direct_score[2];
745 int i_direct_frames[2];
746 /* num p-frames weighted */
751 ALIGNED_16( uint32_t nr_residual_sum[2][64] );
752 ALIGNED_16( uint16_t nr_offset[2][64] );
753 uint32_t nr_count[2];
755 void *scratch_buffer; /* for any temporary storage that doesn't want repeated malloc */
757 /* CPU functions dependents */
758 x264_predict_t predict_16x16[4+3];
759 x264_predict_t predict_8x8c[4+3];
760 x264_predict8x8_t predict_8x8[9+3];
761 x264_predict_t predict_4x4[9+3];
762 x264_predict_8x8_filter_t predict_8x8_filter;
764 x264_pixel_function_t pixf;
765 x264_mc_functions_t mc;
766 x264_dct_function_t dctf;
767 x264_zigzag_function_t zigzagf;
768 x264_quant_function_t quantf;
769 x264_deblock_function_t loopf;
771 #ifdef HAVE_VISUALIZE
772 struct visualize_t *visualize;
774 x264_lookahead_t *lookahead;
777 // included at the end because it needs x264_t
778 #include "macroblock.h"
781 #include "x86/util.h"