frame.h 9.39 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1
/*****************************************************************************
Fiona Glaser's avatar
Fiona Glaser committed
2
 * frame.h: frame handling
Laurent Aimar's avatar
Laurent Aimar committed
3
 *****************************************************************************
Sean McGovern's avatar
Sean McGovern committed
4
 * Copyright (C) 2003-2011 x264 project
Laurent Aimar's avatar
Laurent Aimar committed
5
6
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7
 *          Loren Merritt <lorenm@u.washington.edu>
Fiona Glaser's avatar
Fiona Glaser committed
8
 *          Fiona Glaser <fiona@x264.com>
Laurent Aimar's avatar
Laurent Aimar committed
9
10
11
12
13
14
15
16
17
18
19
20
21
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
Fiona Glaser's avatar
Fiona Glaser committed
23
24
25
 *
 * This program is also available under a commercial proprietary license.
 * For more information, contact us at licensing@x264.com.
Laurent Aimar's avatar
Laurent Aimar committed
26
27
 *****************************************************************************/

28
29
#ifndef X264_FRAME_H
#define X264_FRAME_H
Laurent Aimar's avatar
Laurent Aimar committed
30

31
32
33
34
/* number of pixels past the edge of the frame, for motion estimation/compensation */
#define PADH 32
#define PADV 32

Dylan Yudaken's avatar
Dylan Yudaken committed
35
typedef struct x264_frame
Laurent Aimar's avatar
Laurent Aimar committed
36
37
38
{
    /* */
    int     i_poc;
Fiona Glaser's avatar
Fiona Glaser committed
39
    int     i_delta_poc[2];
Laurent Aimar's avatar
Laurent Aimar committed
40
41
42
    int     i_type;
    int     i_qpplus1;
    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 */
Fiona Glaser's avatar
Fiona Glaser committed
46
    float   f_duration;  /* in seconds */
47
48
49
    int64_t i_cpb_duration;
    int64_t i_cpb_delay; /* in SPS time_scale units (i.e 2 * timebase units) */
    int64_t i_dpb_output_delay;
50
51
    x264_param_t *param;

Fiona Glaser's avatar
Fiona Glaser committed
52
53
    int     i_frame;     /* Presentation frame number */
    int     i_coded;     /* Coded frame number */
54
    int64_t i_field_cnt; /* Presentation field count */
Lamont Alston's avatar
Lamont Alston committed
55
    int     i_frame_num; /* 7.4.3 frame_num */
56
    int     b_kept_as_ref;
57
    int     i_pic_struct;
Fiona Glaser's avatar
Fiona Glaser committed
58
    int     b_keyframe;
Steven Walters's avatar
Steven Walters committed
59
60
61
    uint8_t b_fdec;
    uint8_t b_last_minigop_bframe; /* this frame is the last b in a sequence of bframes */
    uint8_t i_bframes;   /* number of bframes following this nonb in coded order */
62
63
    float   f_qp_avg_rc; /* QPs as decided by ratecontrol */
    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 */
Laurent Aimar's avatar
Laurent Aimar committed
65
66
67

    /* YUV buffer */
    int     i_plane;
Fiona Glaser's avatar
Fiona Glaser committed
68
69
70
    int     i_stride[3];
    int     i_width[3];
    int     i_lines[3];
71
    int     i_stride_lowres;
72
    int     i_width_lowres;
73
    int     i_lines_lowres;
Fiona Glaser's avatar
Fiona Glaser committed
74
75
76
77
    pixel *plane[3];
    pixel *plane_fld[3];
    pixel *filtered[3][4]; /* plane[0], H, V, HV */
    pixel *filtered_fld[3][4];
78
    pixel *lowres[4]; /* half-size copy of input frame: Orig, H, V, HV */
79
    uint16_t *integral;
Laurent Aimar's avatar
Laurent Aimar committed
80
81
82

    /* for unrestricted mv we allocate more data than needed
     * allocated data are stored in buffer */
83
    pixel *buffer[4];
Simon Horlick's avatar
Simon Horlick committed
84
    pixel *buffer_fld[4];
85
    pixel *buffer_lowres[4];
Laurent Aimar's avatar
Laurent Aimar committed
86

87
88
    x264_weight_t weight[X264_REF_MAX][3]; /* [ref_index][plane] */
    pixel *weighted[X264_REF_MAX]; /* plane[0] weighted of the reference frames */
Dylan Yudaken's avatar
Dylan Yudaken committed
89
90
91
    int b_duplicate;
    struct x264_frame *orig;

92
    /* motion data */
93
    int8_t  *mb_type;
94
    uint8_t *mb_partition;
95
    int16_t (*mv[2])[2];
Fiona Glaser's avatar
Fiona Glaser committed
96
    int16_t (*mv16x16)[2];
97
    int16_t (*lowres_mvs[2][X264_BFRAME_MAX+1])[2];
98
    uint8_t *field;
99
100
101
102

    /* Stored as (lists_used << LOWRES_COST_SHIFT) + (cost).
     * Doesn't need special addressing for intra cost because
     * lists_used is guaranteed to be zero in that cast. */
Fiona Glaser's avatar
Fiona Glaser committed
103
    uint16_t (*lowres_costs[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2]);
104
105
106
    #define LOWRES_COST_MASK ((1<<14)-1)
    #define LOWRES_COST_SHIFT 14

107
    int     *lowres_mv_costs[2][X264_BFRAME_MAX+1];
108
109
    int8_t  *ref[2];
    int     i_ref[2];
110
    int     ref_poc[2][X264_REF_MAX];
Fiona Glaser's avatar
Fiona Glaser committed
111
    int16_t inv_ref_poc[2]; // inverse values of ref0 poc to avoid divisions in temporal MV prediction
112

113
114
115
    /* for adaptive B-frame decision.
     * contains the SATD cost of the lowres frame encoded in various modes
     * 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
119
120
121
122
    int     i_satd; // the i_cost_est of the selected frametype
    int     i_intra_mbs[X264_BFRAME_MAX+2];
    int     *i_row_satds[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
    int     *i_row_satd;
    int     *i_row_bits;
123
    float   *f_row_qp;
Fiona Glaser's avatar
Fiona Glaser committed
124
    float   *f_row_qscale;
125
    float   *f_qp_offset;
Fiona Glaser's avatar
Fiona Glaser committed
126
    float   *f_qp_offset_aq;
127
128
    int     b_intra_calculated;
    uint16_t *i_intra_cost;
Loren Merritt's avatar
Loren Merritt committed
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. */
Dylan Yudaken's avatar
Dylan Yudaken committed
132
    float   f_weighted_cost_delta[X264_BFRAME_MAX+2];
133
134
    uint32_t i_pixel_sum[3];
    uint64_t i_pixel_ssd[3];
135

136
137
138
    /* hrd */
    x264_hrd_t hrd_timing;

Fiona Glaser's avatar
Fiona Glaser committed
139
140
141
    /* vbv */
    uint8_t i_planned_type[X264_LOOKAHEAD_MAX+1];
    int i_planned_satd[X264_LOOKAHEAD_MAX+1];
142
    double f_planned_cpb_duration[X264_LOOKAHEAD_MAX+1];
143
144
    int64_t i_coded_fields_lookahead;
    int64_t i_cpb_delay_lookahead;
Fiona Glaser's avatar
Fiona Glaser committed
145

Loren Merritt's avatar
Loren Merritt committed
146
147
    /* threading */
    int     i_lines_completed; /* in pixels */
Dylan Yudaken's avatar
Dylan Yudaken committed
148
    int     i_lines_weighted; /* FIXME: this only supports weighting of one reference frame */
Loren Merritt's avatar
Loren Merritt committed
149
    int     i_reference_count; /* number of threads using this frame (not necessarily the number of pointers) */
Loren Merritt's avatar
Loren Merritt committed
150
    x264_pthread_mutex_t mutex;
151
    x264_pthread_cond_t  cv;
Loren Merritt's avatar
Loren Merritt committed
152

Fiona Glaser's avatar
Fiona Glaser committed
153
154
155
156
    /* periodic intra refresh */
    float   f_pir_position;
    int     i_pir_start_col;
    int     i_pir_end_col;
157
    int     i_frames_since_pir;
158
159
160

    /* interactive encoder control */
    int     b_corrupt;
161
162
163

    /* user sei */
    x264_sei_t extra_sei;
Laurent Aimar's avatar
Laurent Aimar committed
164
165
} x264_frame_t;

Steven Walters's avatar
Steven Walters committed
166
167
168
169
170
171
172
173
174
/* synchronized frame list */
typedef struct
{
   x264_frame_t **list;
   int i_max_size;
   int i_size;
   x264_pthread_mutex_t     mutex;
   x264_pthread_cond_t      cv_fill;  /* event signaling that the list became fuller */
   x264_pthread_cond_t      cv_empty; /* event signaling that the list became emptier */
175
} x264_sync_frame_list_t;
Steven Walters's avatar
Steven Walters committed
176

177
178
typedef void (*x264_deblock_inter_t)( pixel *pix, int stride, int alpha, int beta, int8_t *tc0 );
typedef void (*x264_deblock_intra_t)( pixel *pix, int stride, int alpha, int beta );
Loren Merritt's avatar
Loren Merritt committed
179
180
typedef struct
{
181
182
183
184
    x264_deblock_inter_t deblock_luma[2];
    x264_deblock_inter_t deblock_chroma[2];
    x264_deblock_intra_t deblock_luma_intra[2];
    x264_deblock_intra_t deblock_chroma_intra[2];
185
186
187
188
    x264_deblock_inter_t deblock_luma_mbaff;
    x264_deblock_inter_t deblock_chroma_mbaff;
    x264_deblock_intra_t deblock_luma_intra_mbaff;
    x264_deblock_intra_t deblock_chroma_intra_mbaff;
189
    void (*deblock_strength) ( uint8_t nnz[X264_SCAN8_SIZE], int8_t ref[2][X264_SCAN8_LUMA_SIZE],
190
                               int16_t mv[2][X264_SCAN8_LUMA_SIZE][2], uint8_t bs[2][8][4], int mvy_limit,
Fiona Glaser's avatar
Fiona Glaser committed
191
                               int bframe );
Loren Merritt's avatar
Loren Merritt committed
192
193
} x264_deblock_function_t;

Laurent Aimar's avatar
Laurent Aimar committed
194
195
void          x264_frame_delete( x264_frame_t *frame );

196
int           x264_frame_copy_picture( x264_t *h, x264_frame_t *dst, x264_picture_t *src );
Laurent Aimar's avatar
Laurent Aimar committed
197

Loren Merritt's avatar
Loren Merritt committed
198
199
void          x264_frame_expand_border( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
void          x264_frame_expand_border_filtered( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
200
void          x264_frame_expand_border_lowres( x264_frame_t *frame );
201
void          x264_frame_expand_border_chroma( x264_t *h, x264_frame_t *frame, int plane );
Loren Merritt's avatar
Loren Merritt committed
202
void          x264_frame_expand_border_mod16( x264_t *h, x264_frame_t *frame );
203
void          x264_expand_border_mbpair( x264_t *h, int mb_x, int mb_y );
204

Loren Merritt's avatar
Loren Merritt committed
205
void          x264_frame_deblock_row( x264_t *h, int mb_y );
Fiona Glaser's avatar
Fiona Glaser committed
206
void          x264_macroblock_deblock( x264_t *h );
Laurent Aimar's avatar
Laurent Aimar committed
207

208
209
void          x264_frame_filter( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
void          x264_frame_init_lowres( x264_t *h, x264_frame_t *frame );
210

211
void          x264_deblock_init( int cpu, x264_deblock_function_t *pf, int b_mbaff );
Loren Merritt's avatar
Loren Merritt committed
212

213
void          x264_frame_cond_broadcast( x264_frame_t *frame, int i_lines_completed );
214
215
void          x264_frame_cond_wait( x264_frame_t *frame, int i_lines_completed );

216
217
218
219
220
void          x264_frame_push( x264_frame_t **list, x264_frame_t *frame );
x264_frame_t *x264_frame_pop( x264_frame_t **list );
void          x264_frame_unshift( x264_frame_t **list, x264_frame_t *frame );
x264_frame_t *x264_frame_shift( x264_frame_t **list );
void          x264_frame_push_unused( x264_t *h, x264_frame_t *frame );
Dylan Yudaken's avatar
Dylan Yudaken committed
221
222
void          x264_frame_push_blank_unused( x264_t *h, x264_frame_t *frame );
x264_frame_t *x264_frame_pop_blank_unused( x264_t *h );
223
void x264_weight_scale_plane( x264_t *h, pixel *dst, int i_dst_stride, pixel *src, int i_src_stride,
Dylan Yudaken's avatar
Dylan Yudaken committed
224
                              int i_width, int i_height, x264_weight_t *w );
Steven Walters's avatar
Steven Walters committed
225
226
227
x264_frame_t *x264_frame_pop_unused( x264_t *h, int b_fdec );
void          x264_frame_delete_list( x264_frame_t **list );

228
229
230
231
int           x264_sync_frame_list_init( x264_sync_frame_list_t *slist, int nelem );
void          x264_sync_frame_list_delete( x264_sync_frame_list_t *slist );
void          x264_sync_frame_list_push( x264_sync_frame_list_t *slist, x264_frame_t *frame );
x264_frame_t *x264_sync_frame_list_pop( x264_sync_frame_list_t *slist );
Steven Walters's avatar
Steven Walters committed
232

Laurent Aimar's avatar
Laurent Aimar committed
233
#endif