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
  32 {
  33     /* */
  34     int     i_poc;
  35     int     i_type;
  36     int     i_qpplus1;
  37     int64_t i_pts;
  38     int     i_frame;    /* Presentation frame number */
  39     int     i_frame_num; /* Coded frame number */
  40     int     b_kept_as_ref;
  41     float   f_qp_avg_rc; /* QPs as decided by ratecontrol */
  42     float   f_qp_avg_aq; /* QPs as decided by AQ in addition to ratecontrol */
  43
  44     /* YUV buffer */
  45     int     i_plane;
  46     int     i_stride[3];
  47     int     i_width[3];
  48     int     i_lines[3];
  49     int     i_stride_lowres;
  50     int     i_width_lowres;
  51     int     i_lines_lowres;
  52     uint8_t *plane[3];
  53     uint8_t *filtered[4]; /* plane[0], H, V, HV */
  54     uint8_t *lowres[4]; /* half-size copy of input frame: Orig, H, V, HV */
  55     uint16_t *integral;
  56
  57     /* for unrestricted mv we allocate more data than needed
  58      * allocated data are stored in buffer */
  59     uint8_t *buffer[4];
  60     uint8_t *buffer_lowres[4];
  61
  62     /* motion data */
  63     int8_t  *mb_type;
  64     int16_t (*mv[2])[2];
  65     int16_t (*lowres_mvs[2][X264_BFRAME_MAX+1])[2];
  66     int     *lowres_mv_costs[2][X264_BFRAME_MAX+1];
  67     int8_t  *ref[2];
  68     int     i_ref[2];
  69     int     ref_poc[2][16];
  70     int     inv_ref_poc[16]; // inverse values (list0 only) to avoid divisions in MB encoding
  71
  72     /* for adaptive B-frame decision.
  73      * contains the SATD cost of the lowres frame encoded in various modes
  74      * FIXME: how big an array do we need? */
  75     int     i_cost_est[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
  76     int     i_cost_est_aq[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
  77     int     i_satd; // the i_cost_est of the selected frametype
  78     int     i_intra_mbs[X264_BFRAME_MAX+2];
  79     int     *i_row_satds[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
  80     int     *i_row_satd;
  81     int     *i_row_bits;
  82     int     *i_row_qp;
  83     float   *f_qp_offset;
  84     int     b_intra_calculated;
  85     uint16_t *i_intra_cost;
  86     uint16_t *i_inv_qscale_factor;
  87
  88     /* threading */
  89     int     i_lines_completed; /* in pixels */
  90     int     i_reference_count; /* number of threads using this frame (not necessarily the number of pointers) */
  91     x264_pthread_mutex_t mutex;
  92     x264_pthread_cond_t  cv;
  93
  94 } x264_frame_t;
  95
  96 typedef void (*x264_deblock_inter_t)( uint8_t *pix, int stride, int alpha, int beta, int8_t *tc0 );
  97 typedef void (*x264_deblock_intra_t)( uint8_t *pix, int stride, int alpha, int beta );
  98 typedef struct
  99 {
 100     x264_deblock_inter_t deblock_v_luma;
 101     x264_deblock_inter_t deblock_h_luma;
 102     x264_deblock_inter_t deblock_v_chroma;
 103     x264_deblock_inter_t deblock_h_chroma;
 104     x264_deblock_intra_t deblock_v_luma_intra;
 105     x264_deblock_intra_t deblock_h_luma_intra;
 106     x264_deblock_intra_t deblock_v_chroma_intra;
 107     x264_deblock_intra_t deblock_h_chroma_intra;
 108 } x264_deblock_function_t;
 109
 110 x264_frame_t *x264_frame_new( x264_t *h );
 111 void          x264_frame_delete( x264_frame_t *frame );
 112
 113 int           x264_frame_copy_picture( x264_t *h, x264_frame_t *dst, x264_picture_t *src );
 114
 115 void          x264_frame_expand_border( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
 116 void          x264_frame_expand_border_filtered( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
 117 void          x264_frame_expand_border_lowres( x264_frame_t *frame );
 118 void          x264_frame_expand_border_mod16( x264_t *h, x264_frame_t *frame );
 119
 120 void          x264_frame_deblock( x264_t *h );
 121 void          x264_frame_deblock_row( x264_t *h, int mb_y );
 122
 123 void          x264_frame_filter( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
 124 void          x264_frame_init_lowres( x264_t *h, x264_frame_t *frame );
 125
 126 void          x264_deblock_init( int cpu, x264_deblock_function_t *pf );
 127
 128 void          x264_frame_cond_broadcast( x264_frame_t *frame, int i_lines_completed );
 129 void          x264_frame_cond_wait( x264_frame_t *frame, int i_lines_completed );
 130
 131 void          x264_frame_push( x264_frame_t **list, x264_frame_t *frame );
 132 x264_frame_t *x264_frame_pop( x264_frame_t **list );
 133 void          x264_frame_unshift( x264_frame_t **list, x264_frame_t *frame );
 134 x264_frame_t *x264_frame_shift( x264_frame_t **list );
 135 void          x264_frame_push_unused( x264_t *h, x264_frame_t *frame );
 136 x264_frame_t *x264_frame_pop_unused( x264_t *h );
 137 void          x264_frame_sort( x264_frame_t **list, int b_dts );
 138 #define x264_frame_sort_dts(list) x264_frame_sort(list, 1)
 139 #define x264_frame_sort_pts(list) x264_frame_sort(list, 0)
 140
 141 #endif