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