Deprecate avctx.coded_frame
[ffmpeg.git] / libavcodec / motion_est.h
1 /*
2  * Motion estimation
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVCODEC_MOTIONEST_H
22 #define AVCODEC_MOTIONEST_H
23
24 #include <stdint.h>
25
26 #include "avcodec.h"
27 #include "hpeldsp.h"
28 #include "qpeldsp.h"
29
30 struct MpegEncContext;
31
32 #define MAX_MV 2048
33
34 /**
35  * Motion estimation context.
36  */
37 typedef struct MotionEstContext {
38     AVCodecContext *avctx;
39     int skip;                       ///< set if ME is skipped for the current MB
40     int co_located_mv[4][2];        ///< mv from last P-frame for direct mode ME
41     int direct_basis_mv[4][2];
42     uint8_t *scratchpad;            /**< data area for the ME algo, so that
43                                      * the ME does not need to malloc/free. */
44     uint8_t *best_mb;
45     uint8_t *temp_mb[2];
46     uint8_t *temp;
47     int best_bits;
48     uint32_t *map;                  ///< map to avoid duplicate evaluations
49     uint32_t *score_map;            ///< map to store the scores
50     unsigned map_generation;
51     int pre_penalty_factor;
52     int penalty_factor;             /**< an estimate of the bits required to
53                                      * code a given mv value, e.g. (1,0) takes
54                                      * more bits than (0,0). We have to
55                                      * estimate whether any reduction in
56                                      * residual is worth the extra bits. */
57     int sub_penalty_factor;
58     int mb_penalty_factor;
59     int flags;
60     int sub_flags;
61     int mb_flags;
62     int pre_pass;                   ///< = 1 for the pre pass
63     int dia_size;
64     int xmin;
65     int xmax;
66     int ymin;
67     int ymax;
68     int pred_x;
69     int pred_y;
70     uint8_t *src[4][4];
71     uint8_t *ref[4][4];
72     int stride;
73     int uvstride;
74     /* temp variables for picture complexity calculation */
75     int mc_mb_var_sum_temp;
76     int mb_var_sum_temp;
77     int scene_change_score;
78
79     op_pixels_func(*hpel_put)[4];
80     op_pixels_func(*hpel_avg)[4];
81     qpel_mc_func(*qpel_put)[16];
82     qpel_mc_func(*qpel_avg)[16];
83     uint8_t (*mv_penalty)[MAX_MV * 2 + 1]; ///< bit amount needed to encode a MV
84     uint8_t *current_mv_penalty;
85     int (*sub_motion_search)(struct MpegEncContext *s,
86                              int *mx_ptr, int *my_ptr, int dmin,
87                              int src_index, int ref_index,
88                              int size, int h);
89 } MotionEstContext;
90
91 static inline int ff_h263_round_chroma(int x)
92 {
93     //FIXME static or not?
94     static const uint8_t h263_chroma_roundtab[16] = {
95     //  0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15
96         0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1,
97     };
98     return h263_chroma_roundtab[x & 0xf] + (x >> 3);
99 }
100
101 int ff_init_me(struct MpegEncContext *s);
102
103 void ff_estimate_p_frame_motion(struct MpegEncContext *s, int mb_x, int mb_y);
104 void ff_estimate_b_frame_motion(struct MpegEncContext *s, int mb_x, int mb_y);
105
106 int ff_pre_estimate_p_frame_motion(struct MpegEncContext *s,
107                                    int mb_x, int mb_y);
108
109 int ff_epzs_motion_search(struct MpegEncContext *s, int *mx_ptr, int *my_ptr,
110                           int P[10][2], int src_index, int ref_index,
111                           int16_t (*last_mv)[2], int ref_mv_scale, int size,
112                           int h);
113
114 int ff_get_mb_score(struct MpegEncContext *s, int mx, int my, int src_index,
115                     int ref_index, int size, int h, int add_rate);
116
117 int ff_get_best_fcode(struct MpegEncContext *s,
118                       int16_t (*mv_table)[2], int type);
119
120 void ff_fix_long_p_mvs(struct MpegEncContext *s);
121 void ff_fix_long_mvs(struct MpegEncContext *s, uint8_t *field_select_table,
122                      int field_select, int16_t (*mv_table)[2], int f_code,
123                      int type, int truncate);
124
125 #endif /* AVCODEC_MOTIONEST_H */