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     x264_param_t *param;
  40
  41     int     i_frame;     /* Presentation frame number */
  42     int     i_coded;     /* Coded frame number */
  43     int     i_frame_num; /* 7.4.3 frame_num */
  44     int     b_kept_as_ref;
  45     int     b_keyframe;
  46     uint8_t b_fdec;
  47     uint8_t b_last_minigop_bframe; /* this frame is the last b in a sequence of bframes */
  48     uint8_t i_bframes;   /* number of bframes following this nonb in coded order */
  49     float   f_qp_avg_rc; /* QPs as decided by ratecontrol */
  50     float   f_qp_avg_aq; /* QPs as decided by AQ in addition to ratecontrol */
  51
  52     /* YUV buffer */
  53     int     i_plane;
  54     int     i_stride[3];
  55     int     i_width[3];
  56     int     i_lines[3];
  57     int     i_stride_lowres;
  58     int     i_width_lowres;
  59     int     i_lines_lowres;
  60     uint8_t *plane[3];
  61     uint8_t *filtered[4]; /* plane[0], H, V, HV */
  62     uint8_t *lowres[4]; /* half-size copy of input frame: Orig, H, V, HV */
  63     uint16_t *integral;
  64
  65     /* for unrestricted mv we allocate more data than needed
  66      * allocated data are stored in buffer */
  67     uint8_t *buffer[4];
  68     uint8_t *buffer_lowres[4];
  69
  70     x264_weight_t weight[16][3]; /* [ref_index][plane] */
  71     uint8_t *weighted[16]; /* plane[0] weighted of the reference frames */
  72     int b_duplicate;
  73     struct x264_frame *orig;
  74
  75     /* motion data */
  76     int8_t  *mb_type;
  77     int16_t (*mv[2])[2];
  78     int16_t (*lowres_mvs[2][X264_BFRAME_MAX+1])[2];
  79     uint16_t (*lowres_costs[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2]);
  80     /* Actually a width-2 bitfield with 4 values per uint8_t. */
  81     uint8_t  (*lowres_inter_types[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2]);
  82     int     *lowres_mv_costs[2][X264_BFRAME_MAX+1];
  83     int8_t  *ref[2];
  84     int     i_ref[2];
  85     int     ref_poc[2][16];
  86     int     inv_ref_poc[16]; // inverse values (list0 only) to avoid divisions in MB encoding
  87
  88     /* for adaptive B-frame decision.
  89      * contains the SATD cost of the lowres frame encoded in various modes
  90      * FIXME: how big an array do we need? */
  91     int     i_cost_est[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
  92     int     i_cost_est_aq[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
  93     int     i_satd; // the i_cost_est of the selected frametype
  94     int     i_intra_mbs[X264_BFRAME_MAX+2];
  95     int     *i_row_satds[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
  96     int     *i_row_satd;
  97     int     *i_row_bits;
  98     int     *i_row_qp;
  99     float   *f_qp_offset;
 100     float   *f_qp_offset_aq;
 101     int     b_intra_calculated;
 102     uint16_t *i_intra_cost;
 103     uint16_t *i_propagate_cost;
 104     uint16_t *i_inv_qscale_factor;
 105     int     b_scenecut; /* Set to zero if the frame cannot possibly be part of a real scenecut. */
 106     float   f_weighted_cost_delta[X264_BFRAME_MAX+2];
 107     uint32_t i_pixel_sum;
 108     uint64_t i_pixel_ssd;
 109
 110     /* vbv */
 111     uint8_t i_planned_type[X264_LOOKAHEAD_MAX+1];
 112     int i_planned_satd[X264_LOOKAHEAD_MAX+1];
 113
 114     /* threading */
 115     int     i_lines_completed; /* in pixels */
 116     int     i_lines_weighted; /* FIXME: this only supports weighting of one reference frame */
 117     int     i_reference_count; /* number of threads using this frame (not necessarily the number of pointers) */
 118     x264_pthread_mutex_t mutex;
 119     x264_pthread_cond_t  cv;
 120
 121     /* periodic intra refresh */
 122     float   f_pir_position;
 123     int     i_pir_start_col;
 124     int     i_pir_end_col;
 125 } x264_frame_t;
 126
 127 /* synchronized frame list */
 128 typedef struct
 129 {
 130    x264_frame_t **list;
 131    int i_max_size;
 132    int i_size;
 133    x264_pthread_mutex_t     mutex;
 134    x264_pthread_cond_t      cv_fill;  /* event signaling that the list became fuller */
 135    x264_pthread_cond_t      cv_empty; /* event signaling that the list became emptier */
 136 } x264_synch_frame_list_t;
 137
 138 typedef void (*x264_deblock_inter_t)( uint8_t *pix, int stride, int alpha, int beta, int8_t *tc0 );
 139 typedef void (*x264_deblock_intra_t)( uint8_t *pix, int stride, int alpha, int beta );
 140 typedef struct
 141 {
 142     x264_deblock_inter_t deblock_v_luma;
 143     x264_deblock_inter_t deblock_h_luma;
 144     x264_deblock_inter_t deblock_v_chroma;
 145     x264_deblock_inter_t deblock_h_chroma;
 146     x264_deblock_intra_t deblock_v_luma_intra;
 147     x264_deblock_intra_t deblock_h_luma_intra;
 148     x264_deblock_intra_t deblock_v_chroma_intra;
 149     x264_deblock_intra_t deblock_h_chroma_intra;
 150 } x264_deblock_function_t;
 151
 152 x264_frame_t *x264_frame_new( x264_t *h, int b_fdec );
 153 void          x264_frame_delete( x264_frame_t *frame );
 154
 155 int           x264_frame_copy_picture( x264_t *h, x264_frame_t *dst, x264_picture_t *src );
 156
 157 void          x264_frame_expand_border( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
 158 void          x264_frame_expand_border_filtered( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
 159 void          x264_frame_expand_border_lowres( x264_frame_t *frame );
 160 void          x264_frame_expand_border_mod16( x264_t *h, x264_frame_t *frame );
 161
 162 void          x264_frame_deblock( x264_t *h );
 163 void          x264_frame_deblock_row( x264_t *h, int mb_y );
 164
 165 void          x264_frame_filter( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
 166 void          x264_frame_init_lowres( x264_t *h, x264_frame_t *frame );
 167
 168 void          x264_deblock_init( int cpu, x264_deblock_function_t *pf );
 169
 170 void          x264_frame_cond_broadcast( x264_frame_t *frame, int i_lines_completed );
 171 void          x264_frame_cond_wait( x264_frame_t *frame, int i_lines_completed );
 172
 173 void          x264_frame_push( x264_frame_t **list, x264_frame_t *frame );
 174 x264_frame_t *x264_frame_pop( x264_frame_t **list );
 175 void          x264_frame_unshift( x264_frame_t **list, x264_frame_t *frame );
 176 x264_frame_t *x264_frame_shift( x264_frame_t **list );
 177 void          x264_frame_push_unused( x264_t *h, x264_frame_t *frame );
 178 void          x264_frame_push_blank_unused( x264_t *h, x264_frame_t *frame );
 179 x264_frame_t *x264_frame_pop_blank_unused( x264_t *h );
 180 void x264_weight_scale_plane( x264_t *h, uint8_t *dst, int i_dst_stride, uint8_t *src, int i_src_stride,
 181                               int i_width, int i_height, x264_weight_t *w );
 182 x264_frame_t *x264_frame_pop_unused( x264_t *h, int b_fdec );
 183 void          x264_frame_sort( x264_frame_t **list, int b_dts );
 184 void          x264_frame_delete_list( x264_frame_t **list );
 185
 186 int           x264_synch_frame_list_init( x264_synch_frame_list_t *slist, int nelem );
 187 void          x264_synch_frame_list_delete( x264_synch_frame_list_t *slist );
 188 void          x264_synch_frame_list_push( x264_synch_frame_list_t *slist, x264_frame_t *frame );
 189
 190 #define x264_frame_sort_dts(list) x264_frame_sort(list, 1)
 191 #define x264_frame_sort_pts(list) x264_frame_sort(list, 0)
 192
 193 #endif