fix illegal identifiers in multiple inclusion guards
[x262.git] / common / frame.h
1 /*****************************************************************************
2  * frame.h: h264 encoder library
3  *****************************************************************************
4  * Copyright (C) 2003 Laurent Aimar
5  * $Id: frame.h,v 1.1 2004/06/03 19:27:06 fenrir Exp $
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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., 59 Temple Place - Suite 330, 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     void    *buffer[4];
60     void    *buffer_lowres[4];
61
62     /* motion data */
63     int8_t  *mb_type;
64     int16_t (*mv[2])[2];
65     int8_t  *ref[2];
66     int     i_ref[2];
67     int     ref_poc[2][16];
68     int     inv_ref_poc[16]; // inverse values (list0 only) to avoid divisions in MB encoding
69
70     /* for adaptive B-frame decision.
71      * contains the SATD cost of the lowres frame encoded in various modes
72      * FIXME: how big an array do we need? */
73     int     i_cost_est[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
74     int     i_satd; // the i_cost_est of the selected frametype
75     int     i_intra_mbs[X264_BFRAME_MAX+2];
76     int     *i_row_satds[X264_BFRAME_MAX+2][X264_BFRAME_MAX+2];
77     int     *i_row_satd;
78     int     *i_row_bits;
79     int     *i_row_qp;
80
81     /* threading */
82     int     i_lines_completed; /* in pixels */
83     int     i_reference_count; /* number of threads using this frame (not necessarily the number of pointers) */
84     x264_pthread_mutex_t mutex;      
85     x264_pthread_cond_t  cv;
86
87 } x264_frame_t;
88
89 typedef void (*x264_deblock_inter_t)( uint8_t *pix, int stride, int alpha, int beta, int8_t *tc0 );
90 typedef void (*x264_deblock_intra_t)( uint8_t *pix, int stride, int alpha, int beta );
91 typedef struct
92 {
93     x264_deblock_inter_t deblock_v_luma;
94     x264_deblock_inter_t deblock_h_luma;
95     x264_deblock_inter_t deblock_v_chroma;
96     x264_deblock_inter_t deblock_h_chroma;
97     x264_deblock_intra_t deblock_v_luma_intra;
98     x264_deblock_intra_t deblock_h_luma_intra;
99     x264_deblock_intra_t deblock_v_chroma_intra;
100     x264_deblock_intra_t deblock_h_chroma_intra;
101 } x264_deblock_function_t;
102
103 x264_frame_t *x264_frame_new( x264_t *h );
104 void          x264_frame_delete( x264_frame_t *frame );
105
106 int           x264_frame_copy_picture( x264_t *h, x264_frame_t *dst, x264_picture_t *src );
107
108 void          x264_frame_expand_border( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
109 void          x264_frame_expand_border_filtered( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
110 void          x264_frame_expand_border_lowres( x264_frame_t *frame );
111 void          x264_frame_expand_border_mod16( x264_t *h, x264_frame_t *frame );
112
113 void          x264_frame_deblock( x264_t *h );
114 void          x264_frame_deblock_row( x264_t *h, int mb_y );
115
116 void          x264_frame_filter( x264_t *h, x264_frame_t *frame, int mb_y, int b_end );
117 void          x264_frame_init_lowres( x264_t *h, x264_frame_t *frame );
118
119 void          x264_deblock_init( int cpu, x264_deblock_function_t *pf );
120
121 void          x264_frame_cond_broadcast( x264_frame_t *frame, int i_lines_completed );
122 void          x264_frame_cond_wait( x264_frame_t *frame, int i_lines_completed );
123
124 void          x264_frame_push( x264_frame_t **list, x264_frame_t *frame );
125 x264_frame_t *x264_frame_pop( x264_frame_t **list );
126 void          x264_frame_unshift( x264_frame_t **list, x264_frame_t *frame );
127 x264_frame_t *x264_frame_shift( x264_frame_t **list );
128 void          x264_frame_push_unused( x264_t *h, x264_frame_t *frame );
129 x264_frame_t *x264_frame_pop_unused( x264_t *h );
130 void          x264_frame_sort( x264_frame_t **list, int b_dts );
131 #define x264_frame_sort_dts(list) x264_frame_sort(list, 1)
132 #define x264_frame_sort_pts(list) x264_frame_sort(list, 0)
133
134 #endif