1 /***************************************************************************** 2 * frame.h: frame handling 3 ***************************************************************************** 4 * Copyright (C) 2003-2021 x264 project 5 * 6 * Authors: Laurent Aimar <fenrir@via.ecp.fr> 7 * Loren Merritt <lorenm@u.washington.edu> 8 * Fiona Glaser <fiona@x264.com> 9 * 10 * This program is free software; you can redistribute it and/or modify 11 * it under the terms of the GNU General Public License as published by 12 * the Free Software Foundation; either version 2 of the License, or 13 * (at your option) any later version. 14 * 15 * This program is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program; if not, write to the Free Software 22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111, USA. 23 * 24 * This program is also available under a commercial proprietary license. 25 * For more information, contact us at licensing@x264.com. 26 *****************************************************************************/ 27 28 #ifndef X264_FRAME_H 29 #define X264_FRAME_H 30 31 /* number of pixels past the edge of the frame, for motion estimation/compensation */ 32 #define PADH 32 33 #define PADV 32 34 #define PADH_ALIGN X264_MAX( PADH, NATIVE_ALIGN / SIZEOF_PIXEL ) 35 #define PADH2 (PADH_ALIGN + PADH) 36 37 typedef struct x264_frame 38 { 39 /* */ 40 uint8_t *base; /* Base pointer for all malloced data in this frame. */ 41 int i_poc; 42 int i_delta_poc[2]; 43 int i_type; 44 int i_forced_type; 45 int i_qpplus1; 46 int64_t i_pts; 47 int64_t i_dts; 48 int64_t i_reordered_pts; 49 int64_t i_duration; /* in SPS time_scale units (i.e 2 * timebase units) used for vfr */ 50 float f_duration; /* in seconds */ 51 int64_t i_cpb_duration; 52 int64_t i_cpb_delay; /* in SPS time_scale units (i.e 2 * timebase units) */ 53 int64_t i_dpb_output_delay; 54 x264_param_t *param; 55 56 int i_frame; /* Presentation frame number */ 57 int i_coded; /* Coded frame number */ 58 int64_t i_field_cnt; /* Presentation field count */ 59 int i_frame_num; /* 7.4.3 frame_num */ 60 int b_kept_as_ref; 61 int i_pic_struct; 62 int b_keyframe; 63 uint8_t b_fdec; 64 uint8_t b_last_minigop_bframe; /* this frame is the last b in a sequence of bframes */ 65 uint8_t i_bframes; /* number of bframes following this nonb in coded order */ 66 float f_qp_avg_rc; /* QPs as decided by ratecontrol */ 67 float f_qp_avg_aq; /* QPs as decided by AQ in addition to ratecontrol */ 68 float f_crf_avg; /* Average effective CRF for this frame */ 69 int i_poc_l0ref0; /* poc of first refframe in L0, used to check if direct temporal is possible */ 70 71 /* YUV buffer */ 72 int i_csp; /* Internal csp */ 73 int i_plane; 74 int i_stride[3]; 75 int i_width[3]; 76 int i_lines[3]; 77 int i_stride_lowres; 78 int i_width_lowres; 79 int i_lines_lowres; 80 pixel *plane[3]; 81 pixel *plane_fld[3]; 82 pixel *filtered[3][4]; /* plane[0], H, V, HV */ 83 pixel *filtered_fld[3][4]; 84 pixel *lowres[4]; /* half-size copy of input frame: Orig, H, V, HV */ 85 uint16_t *integral; 86 87 /* for unrestricted mv we allocate more data than needed 88 * allocated data are stored in buffer */ 89 pixel *buffer[4]; 90 pixel *buffer_fld[4]; 91 pixel *buffer_lowres; 92 93 x264_weight_t weight[X264_REF_MAX][3]; /* [ref_index][plane] */ 94 pixel *weighted[X264_REF_MAX]; /* plane[0] weighted of the reference frames */ 95 int b_duplicate; 96 struct x264_frame *orig; 97 98 /* motion data */ 99 int8_t *mb_type; 100 uint8_t *mb_partition; 101 int16_t (*mv[2])[2]; 102 int16_t (*mv16x16)[2]; 103 int16_t (*lowres_mvs[2][X264_BFRAME_MAX+1])[2]; 104 uint8_t *field; 105 uint8_t *effective_qp; 106 107 /* Stored as (lists_used << LOWRES_COST_SHIFT) + (cost). 108 * Doesn't need special addressing for intra cost because 109 * lists_used is guaranteed to be zero in that cast. */ 110 uint16_t (*lowres_costs[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2]); 111 #define LOWRES_COST_MASK ((1<<14)-1) 112 #define LOWRES_COST_SHIFT 14 113 114 int *lowres_mv_costs[2][X264_BFRAME_MAX+1]; 115 int8_t *ref[2]; 116 int i_ref[2]; 117 int ref_poc[2][X264_REF_MAX]; 118 int16_t inv_ref_poc[2]; // inverse values of ref0 poc to avoid divisions in temporal MV prediction 119 120 /* for adaptive B-frame decision. 121 * contains the SATD cost of the lowres frame encoded in various modes 122 * FIXME: how big an array do we need? */ 123 int i_cost_est[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2]; 124 int i_cost_est_aq[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2]; 125 int i_satd; // the i_cost_est of the selected frametype 126 int i_intra_mbs[X264_BFRAME_MAX+2]; 127 int *i_row_satds[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2]; 128 int *i_row_satd; 129 int *i_row_bits; 130 float *f_row_qp; 131 float *f_row_qscale; 132 float *f_qp_offset; 133 float *f_qp_offset_aq; 134 int b_intra_calculated; 135 uint16_t *i_intra_cost; 136 uint16_t *i_propagate_cost; 137 uint16_t *i_inv_qscale_factor; 138 int b_scenecut; /* Set to zero if the frame cannot possibly be part of a real scenecut. */ 139 float f_weighted_cost_delta[X264_BFRAME_MAX+2]; 140 uint32_t i_pixel_sum[3]; 141 uint64_t i_pixel_ssd[3]; 142 143 /* hrd */ 144 x264_hrd_t hrd_timing; 145 146 /* vbv */ 147 uint8_t i_planned_type[X264_LOOKAHEAD_MAX+1]; 148 int i_planned_satd[X264_LOOKAHEAD_MAX+1]; 149 double f_planned_cpb_duration[X264_LOOKAHEAD_MAX+1]; 150 int64_t i_coded_fields_lookahead; 151 int64_t i_cpb_delay_lookahead; 152 153 /* threading */ 154 int i_lines_completed; /* in pixels */ 155 int i_lines_weighted; /* FIXME: this only supports weighting of one reference frame */ 156 int i_reference_count; /* number of threads using this frame (not necessarily the number of pointers) */ 157 x264_pthread_mutex_t mutex; 158 x264_pthread_cond_t cv; 159 int i_slice_count; /* Atomically written to/read from with slice threads */ 160 161 /* periodic intra refresh */ 162 float f_pir_position; 163 int i_pir_start_col; 164 int i_pir_end_col; 165 int i_frames_since_pir; 166 167 /* interactive encoder control */ 168 int b_corrupt; 169 170 /* user sei */ 171 x264_sei_t extra_sei; 172 173 /* user data */ 174 void *opaque; 175 176 /* user frame properties */ 177 uint8_t *mb_info; 178 void (*mb_info_free)( void* ); 179 180 #if HAVE_OPENCL 181 x264_frame_opencl_t opencl; 182 #endif 183 } x264_frame_t; 184 185 /* synchronized frame list */ 186 typedef struct 187 { 188 x264_frame_t **list; 189 int i_max_size; 190 int i_size; 191 x264_pthread_mutex_t mutex; 192 x264_pthread_cond_t cv_fill; /* event signaling that the list became fuller */ 193 x264_pthread_cond_t cv_empty; /* event signaling that the list became emptier */ 194 } x264_sync_frame_list_t; 195 196 typedef void (*x264_deblock_inter_t)( pixel *pix, intptr_t stride, int alpha, int beta, int8_t *tc0 ); 197 typedef void (*x264_deblock_intra_t)( pixel *pix, intptr_t stride, int alpha, int beta ); 198 typedef struct 199 { 200 x264_deblock_inter_t deblock_luma[2]; 201 x264_deblock_inter_t deblock_chroma[2]; 202 x264_deblock_inter_t deblock_h_chroma_420; 203 x264_deblock_inter_t deblock_h_chroma_422; 204 x264_deblock_intra_t deblock_luma_intra[2]; 205 x264_deblock_intra_t deblock_chroma_intra[2]; 206 x264_deblock_intra_t deblock_h_chroma_420_intra; 207 x264_deblock_intra_t deblock_h_chroma_422_intra; 208 x264_deblock_inter_t deblock_luma_mbaff; 209 x264_deblock_inter_t deblock_chroma_mbaff; 210 x264_deblock_inter_t deblock_chroma_420_mbaff; 211 x264_deblock_inter_t deblock_chroma_422_mbaff; 212 x264_deblock_intra_t deblock_luma_intra_mbaff; 213 x264_deblock_intra_t deblock_chroma_intra_mbaff; 214 x264_deblock_intra_t deblock_chroma_420_intra_mbaff; 215 x264_deblock_intra_t deblock_chroma_422_intra_mbaff; 216 void (*deblock_strength)( uint8_t nnz[X264_SCAN8_SIZE], int8_t ref[2][X264_SCAN8_LUMA_SIZE], 217 int16_t mv[2][X264_SCAN8_LUMA_SIZE][2], uint8_t bs[2][8][4], int mvy_limit, 218 int bframe ); 219 } x264_deblock_function_t; 220 221 #define x264_frame_delete x264_template(frame_delete) 222 void x264_frame_delete( x264_frame_t *frame ); 223 224 #define x264_frame_copy_picture x264_template(frame_copy_picture) 225 int x264_frame_copy_picture( x264_t *h, x264_frame_t *dst, x264_picture_t *src ); 226 227 #define x264_frame_expand_border x264_template(frame_expand_border) 228 void x264_frame_expand_border( x264_t *h, x264_frame_t *frame, int mb_y ); 229 #define x264_frame_expand_border_filtered x264_template(frame_expand_border_filtered) 230 void x264_frame_expand_border_filtered( x264_t *h, x264_frame_t *frame, int mb_y, int b_end ); 231 #define x264_frame_expand_border_lowres x264_template(frame_expand_border_lowres) 232 void x264_frame_expand_border_lowres( x264_frame_t *frame ); 233 #define x264_frame_expand_border_chroma x264_template(frame_expand_border_chroma) 234 void x264_frame_expand_border_chroma( x264_t *h, x264_frame_t *frame, int plane ); 235 #define x264_frame_expand_border_mod16 x264_template(frame_expand_border_mod16) 236 void x264_frame_expand_border_mod16( x264_t *h, x264_frame_t *frame ); 237 #define x264_expand_border_mbpair x264_template(expand_border_mbpair) 238 void x264_expand_border_mbpair( x264_t *h, int mb_x, int mb_y ); 239 240 #define x264_frame_deblock_row x264_template(frame_deblock_row) 241 void x264_frame_deblock_row( x264_t *h, int mb_y ); 242 #define x264_macroblock_deblock x264_template(macroblock_deblock) 243 void x264_macroblock_deblock( x264_t *h ); 244 245 #define x264_frame_filter x264_template(frame_filter) 246 void x264_frame_filter( x264_t *h, x264_frame_t *frame, int mb_y, int b_end ); 247 #define x264_frame_init_lowres x264_template(frame_init_lowres) 248 void x264_frame_init_lowres( x264_t *h, x264_frame_t *frame ); 249 250 #define x264_deblock_init x264_template(deblock_init) 251 void x264_deblock_init( uint32_t cpu, x264_deblock_function_t *pf, int b_mbaff ); 252 253 #define x264_frame_cond_broadcast x264_template(frame_cond_broadcast) 254 void x264_frame_cond_broadcast( x264_frame_t *frame, int i_lines_completed ); 255 #define x264_frame_cond_wait x264_template(frame_cond_wait) 256 int x264_frame_cond_wait( x264_frame_t *frame, int i_lines_completed ); 257 #define x264_frame_new_slice x264_template(frame_new_slice) 258 int x264_frame_new_slice( x264_t *h, x264_frame_t *frame ); 259 260 #define x264_threadslice_cond_broadcast x264_template(threadslice_cond_broadcast) 261 void x264_threadslice_cond_broadcast( x264_t *h, int pass ); 262 #define x264_threadslice_cond_wait x264_template(threadslice_cond_wait) 263 void x264_threadslice_cond_wait( x264_t *h, int pass ); 264 265 #define x264_frame_push x264_template(frame_push) 266 X264_API void x264_frame_push( x264_frame_t **list, x264_frame_t *frame ); 267 #define x264_frame_pop x264_template(frame_pop) 268 X264_API x264_frame_t *x264_frame_pop( x264_frame_t **list ); 269 #define x264_frame_unshift x264_template(frame_unshift) 270 X264_API void x264_frame_unshift( x264_frame_t **list, x264_frame_t *frame ); 271 #define x264_frame_shift x264_template(frame_shift) 272 X264_API x264_frame_t *x264_frame_shift( x264_frame_t **list ); 273 274 #define x264_frame_push_unused x264_template(frame_push_unused) 275 void x264_frame_push_unused( x264_t *h, x264_frame_t *frame ); 276 #define x264_frame_push_blank_unused x264_template(frame_push_blank_unused) 277 void x264_frame_push_blank_unused( x264_t *h, x264_frame_t *frame ); 278 #define x264_frame_pop_blank_unused x264_template(frame_pop_blank_unused) 279 x264_frame_t *x264_frame_pop_blank_unused( x264_t *h ); 280 #define x264_weight_scale_plane x264_template(weight_scale_plane) 281 void x264_weight_scale_plane( x264_t *h, pixel *dst, intptr_t i_dst_stride, pixel *src, intptr_t i_src_stride, 282 int i_width, int i_height, x264_weight_t *w ); 283 #define x264_frame_pop_unused x264_template(frame_pop_unused) 284 x264_frame_t *x264_frame_pop_unused( x264_t *h, int b_fdec ); 285 #define x264_frame_delete_list x264_template(frame_delete_list) 286 void x264_frame_delete_list( x264_frame_t **list ); 287 288 #define x264_sync_frame_list_init x264_template(sync_frame_list_init) 289 int x264_sync_frame_list_init( x264_sync_frame_list_t *slist, int nelem ); 290 #define x264_sync_frame_list_delete x264_template(sync_frame_list_delete) 291 void x264_sync_frame_list_delete( x264_sync_frame_list_t *slist ); 292 #define x264_sync_frame_list_push x264_template(sync_frame_list_push) 293 void x264_sync_frame_list_push( x264_sync_frame_list_t *slist, x264_frame_t *frame ); 294 #define x264_sync_frame_list_pop x264_template(sync_frame_list_pop) 295 x264_frame_t *x264_sync_frame_list_pop( x264_sync_frame_list_t *slist ); 296 297 #endif 298