git.sesse.net Git - x264/blob - common/frame.h

   1 /*****************************************************************************
   2  * frame.h: h264 encoder library
   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_FRAME_H
  25 #define X264_FRAME_H
  26
  27 /* number of pixels past the edge of the frame, for motion estimation/compensation */
  28 #define PADH 32
  29 #define PADV 32
  30
  31 typedef struct x264_frame
  32 {
  33     /* */
  34     int     i_poc;
  35     int     i_type;
  36     int     i_qpplus1;
  37     int64_t i_pts;
  38     int64_t i_reordered_pts;
  39     int     i_duration;  /* in SPS time_scale units (i.e 2 * timebase units) used for vfr */
  40     int     i_cpb_duration;
  41     int     i_cpb_delay; /* in SPS time_scale units (i.e 2 * timebase units) */
  42     int     i_dpb_output_delay;
  43     x264_param_t *param;
  44
  45     int     i_frame;     /* Presentation frame number */
  46     int     i_coded;     /* Coded frame number */
  47     int     i_field_cnt; /* Presentation field count */
  48     int     i_frame_num; /* 7.4.3 frame_num */
  49     int     b_kept_as_ref;
  50     int     i_pic_struct;
  51     int     b_keyframe;
  52     uint8_t b_fdec;
  53     uint8_t b_last_minigop_bframe; /* this frame is the last b in a sequence of bframes */
  54     uint8_t i_bframes;   /* number of bframes following this nonb in coded order */
  55     float   f_qp_avg_rc; /* QPs as decided by ratecontrol */
  56     float   f_qp_avg_aq; /* QPs as decided by AQ in addition to ratecontrol */
  57     int     i_poc_l0ref0; /* poc of first refframe in L0, used to check if direct temporal is possible */
  58
  59     /* YUV buffer */
  60     int     i_plane;
  61     int     i_stride[3];
  62     int     i_width[3];
  63     int     i_lines[3];
  64     int     i_stride_lowres;
  65     int     i_width_lowres;
  66     int     i_lines_lowres;
  67     uint8_t *plane[3];
  68     uint8_t *filtered[4]; /* plane[0], H, V, HV */
  69     uint8_t *lowres[4]; /* half-size copy of input frame: Orig, H, V, HV */
  70     uint16_t *integral;
  71
  72     /* for unrestricted mv we allocate more data than needed
  73      * allocated data are stored in buffer */
  74     uint8_t *buffer[4];
  75     uint8_t *buffer_lowres[4];
  76
  77     x264_weight_t weight[16][3]; /* [ref_index][plane] */
  78     uint8_t *weighted[16]; /* plane[0] weighted of the reference frames */
  79     int b_duplicate;
  80     struct x264_frame *orig;
  81
  82     /* motion data */
  83     int8_t  *mb_type;
  84     uint8_t *mb_partition;
  85     int16_t (*mv[2])[2];
  86     int16_t (*mv16x16)[2];
  87     int16_t (*lowres_mvs[2][X264_BFRAME_MAX+1])[2];
  88
  89     /* Stored as (lists_used << LOWRES_COST_SHIFT) + (cost).
  90      * Doesn't need special addressing for intra cost because
  91      * lists_used is guaranteed to be zero in that cast. */
  92     uint16_t (*lowres_costs[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2]);
  93     #define LOWRES_COST_MASK ((1<<14)-1)
  94     #define LOWRES_COST_SHIFT 14
  95
  96     int     *lowres_mv_costs[2][X264_BFRAME_MAX+1];
  97     int8_t  *ref[2];
  98     int     i_ref[2];
  99     int     ref_poc[2][16];
 100     int16_t inv_ref_poc[2]; // inverse values of ref0 poc to avoid divisions in temporal MV prediction
 101
 102     /* for adaptive B-frame decision.
 103      * contains the SATD cost of the lowres frame encoded in various modes
 104      * FIXME: how big an array do we need? */
 105     int     i_cost_est[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
 106     int     i_cost_est_aq[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
 107     int     i_satd; // the i_cost_est of the selected frametype
 108     int     i_intra_mbs[X264_BFRAME_MAX+2];
 109     int     *i_row_satds[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
 110     int     *i_row_satd;
 111     int     *i_row_bits;
 112     float   *f_row_qp;
 113     float   *f_qp_offset;
 114     float   *f_qp_offset_aq;
 115     int     b_intra_calculated;
 116     uint16_t *i_intra_cost;
 117     uint16_t *i_propagate_cost;
 118     uint16_t *i_inv_qscale_factor;
 119     int     b_scenecut; /* Set to zero if the frame cannot possibly be part of a real scenecut. */
 120     float   f_weighted_cost_delta[X264_BFRAME_MAX+2];
 121     uint32_t i_pixel_sum;
 122     uint64_t i_pixel_ssd;
 123
 124     /* hrd */
 125     x264_hrd_t hrd_timing;
 126
 127     /* vbv */
 128     uint8_t i_planned_type[X264_LOOKAHEAD_MAX+1];
 129     int i_planned_satd[X264_LOOKAHEAD_MAX+1];
 130     double f_planned_cpb_duration[X264_LOOKAHEAD_MAX+1];
 131     int i_coded_fields_lookahead;
 132     int i_cpb_delay_lookahead;
 133
 134     /* threading */
 135     int     i_lines_completed; /* in pixels */
 136     int     i_lines_weighted; /* FIXME: this only supports weighting of one reference frame */
 137     int     i_reference_count; /* number of threads using this frame (not necessarily the number of pointers) */
 138     x264_pthread_mutex_t mutex;
 139     x264_pthread_cond_t  cv;
 140
 141     /* periodic intra refresh */
 142     float   f_pir_position;
 143     int     i_pir_start_col;
 144     int     i_pir_end_col;
 145 } x264_frame_t;
 146
 147 /* synchronized frame list */
 148 typedef struct
 149 {
 150    x264_frame_t **list;
 151    int i_max_size;
 152    int i_size;
 153    x264_pthread_mutex_t     mutex;
 154    x264_pthread_cond_t      cv_fill;  /* event signaling that the list became fuller */
 155    x264_pthread_cond_t      cv_empty; /* event signaling that the list became emptier */
 156 } x264_synch_frame_list_t;
 157
 158 typedef void (*x264_deblock_inter_t)( uint8_t *pix, int stride, int alpha, int beta, int8_t *tc0 );
 159 typedef void (*x264_deblock_intra_t)( uint8_t *pix, int stride, int alpha, int beta );
 160 typedef struct
 161 {
 162     x264_deblock_inter_t deblock_v_luma;
 163     x264_deblock_inter_t deblock_h_luma;
 164     x264_deblock_inter_t deblock_v_chroma;
 165     x264_deblock_inter_t deblock_h_chroma;
 166     x264_deblock_intra_t deblock_v_luma_intra;
 167     x264_deblock_intra_t deblock_h_luma_intra;
 168     x264_deblock_intra_t deblock_v_chroma_intra;
 169     x264_deblock_intra_t deblock_h_chroma_intra;
 170 } x264_deblock_function_t;
 171
 172 x264_frame_t *x264_frame_new( x264_t *h, int b_fdec );
 173 void          x264_frame_delete( x264_frame_t *frame );
 174
 175 int           x264_frame_copy_picture( x264_t *h, x264_frame_t *dst, x264_picture_t *src );
 176
 177 void          x264_frame_expand_border( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
 178 void          x264_frame_expand_border_filtered( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
 179 void          x264_frame_expand_border_lowres( x264_frame_t *frame );
 180 void          x264_frame_expand_border_mod16( x264_t *h, x264_frame_t *frame );
 181
 182 void          x264_frame_deblock( x264_t *h );
 183 void          x264_frame_deblock_row( x264_t *h, int mb_y );
 184
 185 void          x264_frame_filter( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
 186 void          x264_frame_init_lowres( x264_t *h, x264_frame_t *frame );
 187
 188 void          x264_deblock_init( int cpu, x264_deblock_function_t *pf );
 189
 190 void          x264_frame_cond_broadcast( x264_frame_t *frame, int i_lines_completed );
 191 void          x264_frame_cond_wait( x264_frame_t *frame, int i_lines_completed );
 192
 193 void          x264_frame_push( x264_frame_t **list, x264_frame_t *frame );
 194 x264_frame_t *x264_frame_pop( x264_frame_t **list );
 195 void          x264_frame_unshift( x264_frame_t **list, x264_frame_t *frame );
 196 x264_frame_t *x264_frame_shift( x264_frame_t **list );
 197 void          x264_frame_push_unused( x264_t *h, x264_frame_t *frame );
 198 void          x264_frame_push_blank_unused( x264_t *h, x264_frame_t *frame );
 199 x264_frame_t *x264_frame_pop_blank_unused( x264_t *h );
 200 void x264_weight_scale_plane( x264_t *h, uint8_t *dst, int i_dst_stride, uint8_t *src, int i_src_stride,
 201                               int i_width, int i_height, x264_weight_t *w );
 202 x264_frame_t *x264_frame_pop_unused( x264_t *h, int b_fdec );
 203 void          x264_frame_sort( x264_frame_t **list, int b_dts );
 204 void          x264_frame_delete_list( x264_frame_t **list );
 205
 206 int           x264_synch_frame_list_init( x264_synch_frame_list_t *slist, int nelem );
 207 void          x264_synch_frame_list_delete( x264_synch_frame_list_t *slist );
 208 void          x264_synch_frame_list_push( x264_synch_frame_list_t *slist, x264_frame_t *frame );
 209
 210 #define x264_frame_sort_dts(list) x264_frame_sort(list, 1)
 211 #define x264_frame_sort_pts(list) x264_frame_sort(list, 0)
 212
 213 #endif