Linux x264_cpu_num_processors(): use glibc macros
[x262.git] / common / frame.h
1 /*****************************************************************************
2  * frame.h: frame handling
3  *****************************************************************************
4  * Copyright (C) 2003-2011 x264 project
5  *
6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7  *          Loren Merritt <lorenm@u.washington.edu>
8  *          Jason Garrett-Glaser <darkshikari@gmail.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
35 typedef struct x264_frame
36 {
37     /* */
38     int     i_poc;
39     int     i_delta_poc[2];
40     int     i_type;
41     int     i_qpplus1;
42     int64_t i_pts;
43     int64_t i_dts;
44     int64_t i_reordered_pts;
45     int64_t i_duration;  /* in SPS time_scale units (i.e 2 * timebase units) used for vfr */
46     float   f_duration;  /* in seconds */
47     int64_t i_cpb_duration;
48     int64_t i_cpb_delay; /* in SPS time_scale units (i.e 2 * timebase units) */
49     int64_t i_dpb_output_delay;
50     x264_param_t *param;
51
52     int     i_frame;     /* Presentation frame number */
53     int     i_coded;     /* Coded frame number */
54     int64_t i_field_cnt; /* Presentation field count */
55     int     i_frame_num; /* 7.4.3 frame_num */
56     int     b_kept_as_ref;
57     int     i_pic_struct;
58     int     b_keyframe;
59     uint8_t b_fdec;
60     uint8_t b_last_minigop_bframe; /* this frame is the last b in a sequence of bframes */
61     uint8_t i_bframes;   /* number of bframes following this nonb in coded order */
62     float   f_qp_avg_rc; /* QPs as decided by ratecontrol */
63     float   f_qp_avg_aq; /* QPs as decided by AQ in addition to ratecontrol */
64     int     i_poc_l0ref0; /* poc of first refframe in L0, used to check if direct temporal is possible */
65
66     /* YUV buffer */
67     int     i_plane;
68     int     i_stride[3];
69     int     i_width[3];
70     int     i_lines[3];
71     int     i_stride_lowres;
72     int     i_width_lowres;
73     int     i_lines_lowres;
74     pixel *plane[3];
75     pixel *plane_fld[3];
76     pixel *filtered[3][4]; /* plane[0], H, V, HV */
77     pixel *filtered_fld[3][4];
78     pixel *lowres[4]; /* half-size copy of input frame: Orig, H, V, HV */
79     uint16_t *integral;
80
81     /* for unrestricted mv we allocate more data than needed
82      * allocated data are stored in buffer */
83     pixel *buffer[4];
84     pixel *buffer_fld[4];
85     pixel *buffer_lowres[4];
86
87     x264_weight_t weight[X264_REF_MAX][3]; /* [ref_index][plane] */
88     pixel *weighted[X264_REF_MAX]; /* plane[0] weighted of the reference frames */
89     int b_duplicate;
90     struct x264_frame *orig;
91
92     /* motion data */
93     int8_t  *mb_type;
94     uint8_t *mb_partition;
95     int16_t (*mv[2])[2];
96     int16_t (*mv16x16)[2];
97     int16_t (*lowres_mvs[2][X264_BFRAME_MAX+1])[2];
98     uint8_t *field;
99
100     /* Stored as (lists_used << LOWRES_COST_SHIFT) + (cost).
101      * Doesn't need special addressing for intra cost because
102      * lists_used is guaranteed to be zero in that cast. */
103     uint16_t (*lowres_costs[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2]);
104     #define LOWRES_COST_MASK ((1<<14)-1)
105     #define LOWRES_COST_SHIFT 14
106
107     int     *lowres_mv_costs[2][X264_BFRAME_MAX+1];
108     int8_t  *ref[2];
109     int     i_ref[2];
110     int     ref_poc[2][X264_REF_MAX];
111     int16_t inv_ref_poc[2]; // inverse values of ref0 poc to avoid divisions in temporal MV prediction
112
113     /* for adaptive B-frame decision.
114      * contains the SATD cost of the lowres frame encoded in various modes
115      * FIXME: how big an array do we need? */
116     int     i_cost_est[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
117     int     i_cost_est_aq[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
118     int     i_satd; // the i_cost_est of the selected frametype
119     int     i_intra_mbs[X264_BFRAME_MAX+2];
120     int     *i_row_satds[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
121     int     *i_row_satd;
122     int     *i_row_bits;
123     float   *f_row_qp;
124     float   *f_row_qscale;
125     float   *f_qp_offset;
126     float   *f_qp_offset_aq;
127     int     b_intra_calculated;
128     uint16_t *i_intra_cost;
129     uint16_t *i_propagate_cost;
130     uint16_t *i_inv_qscale_factor;
131     int     b_scenecut; /* Set to zero if the frame cannot possibly be part of a real scenecut. */
132     float   f_weighted_cost_delta[X264_BFRAME_MAX+2];
133     uint32_t i_pixel_sum[3];
134     uint64_t i_pixel_ssd[3];
135
136     /* hrd */
137     x264_hrd_t hrd_timing;
138
139     /* vbv */
140     uint8_t i_planned_type[X264_LOOKAHEAD_MAX+1];
141     int i_planned_satd[X264_LOOKAHEAD_MAX+1];
142     double f_planned_cpb_duration[X264_LOOKAHEAD_MAX+1];
143     int64_t i_coded_fields_lookahead;
144     int64_t i_cpb_delay_lookahead;
145
146     /* threading */
147     int     i_lines_completed; /* in pixels */
148     int     i_lines_weighted; /* FIXME: this only supports weighting of one reference frame */
149     int     i_reference_count; /* number of threads using this frame (not necessarily the number of pointers) */
150     x264_pthread_mutex_t mutex;
151     x264_pthread_cond_t  cv;
152
153     /* periodic intra refresh */
154     float   f_pir_position;
155     int     i_pir_start_col;
156     int     i_pir_end_col;
157     int     i_frames_since_pir;
158
159     /* interactive encoder control */
160     int     b_corrupt;
161
162     /* user sei */
163     x264_sei_t extra_sei;
164 } x264_frame_t;
165
166 /* synchronized frame list */
167 typedef struct
168 {
169    x264_frame_t **list;
170    int i_max_size;
171    int i_size;
172    x264_pthread_mutex_t     mutex;
173    x264_pthread_cond_t      cv_fill;  /* event signaling that the list became fuller */
174    x264_pthread_cond_t      cv_empty; /* event signaling that the list became emptier */
175 } x264_sync_frame_list_t;
176
177 typedef void (*x264_deblock_inter_t)( pixel *pix, int stride, int alpha, int beta, int8_t *tc0 );
178 typedef void (*x264_deblock_intra_t)( pixel *pix, int stride, int alpha, int beta );
179 typedef struct
180 {
181     x264_deblock_inter_t deblock_luma[2];
182     x264_deblock_inter_t deblock_chroma[2];
183     x264_deblock_intra_t deblock_luma_intra[2];
184     x264_deblock_intra_t deblock_chroma_intra[2];
185     void (*deblock_strength) ( uint8_t nnz[X264_SCAN8_SIZE], int8_t ref[2][X264_SCAN8_LUMA_SIZE],
186                                int16_t mv[2][X264_SCAN8_LUMA_SIZE][2], uint8_t bs[2][8][4], int mvy_limit,
187                                int bframe, x264_t *h );
188 } x264_deblock_function_t;
189
190 void          x264_frame_delete( x264_frame_t *frame );
191
192 int           x264_frame_copy_picture( x264_t *h, x264_frame_t *dst, x264_picture_t *src );
193
194 void          x264_frame_expand_border( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
195 void          x264_frame_expand_border_filtered( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
196 void          x264_frame_expand_border_lowres( x264_frame_t *frame );
197 void          x264_frame_expand_border_mod16( x264_t *h, x264_frame_t *frame );
198 void          x264_expand_border_mbpair( x264_t *h, int mb_x, int mb_y );
199
200 void          x264_frame_deblock_row( x264_t *h, int mb_y );
201 void          x264_macroblock_deblock( x264_t *h );
202
203 void          x264_frame_filter( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
204 void          x264_frame_init_lowres( x264_t *h, x264_frame_t *frame );
205
206 void          x264_deblock_init( int cpu, x264_deblock_function_t *pf, int b_mbaff );
207
208 void          x264_frame_cond_broadcast( x264_frame_t *frame, int i_lines_completed );
209 void          x264_frame_cond_wait( x264_frame_t *frame, int i_lines_completed );
210
211 void          x264_frame_push( x264_frame_t **list, x264_frame_t *frame );
212 x264_frame_t *x264_frame_pop( x264_frame_t **list );
213 void          x264_frame_unshift( x264_frame_t **list, x264_frame_t *frame );
214 x264_frame_t *x264_frame_shift( x264_frame_t **list );
215 void          x264_frame_push_unused( x264_t *h, x264_frame_t *frame );
216 void          x264_frame_push_blank_unused( x264_t *h, x264_frame_t *frame );
217 x264_frame_t *x264_frame_pop_blank_unused( x264_t *h );
218 void x264_weight_scale_plane( x264_t *h, pixel *dst, int i_dst_stride, pixel *src, int i_src_stride,
219                               int i_width, int i_height, x264_weight_t *w );
220 x264_frame_t *x264_frame_pop_unused( x264_t *h, int b_fdec );
221 void          x264_frame_sort( x264_frame_t **list, int b_dts );
222 void          x264_frame_delete_list( x264_frame_t **list );
223
224 int           x264_sync_frame_list_init( x264_sync_frame_list_t *slist, int nelem );
225 void          x264_sync_frame_list_delete( x264_sync_frame_list_t *slist );
226 void          x264_sync_frame_list_push( x264_sync_frame_list_t *slist, x264_frame_t *frame );
227 x264_frame_t *x264_sync_frame_list_pop( x264_sync_frame_list_t *slist );
228
229 #define x264_frame_sort_dts(list) x264_frame_sort(list, 1)
230 #define x264_frame_sort_pts(list) x264_frame_sort(list, 0)
231
232 #endif