FFmpeg  4.3
motion_est.h
Go to the documentation of this file.
1 /*
2  * Motion estimation
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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_MOTION_EST_H
22 #define AVCODEC_MOTION_EST_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 #if ARCH_IA64 // Limit static arrays to avoid gcc failing "short data segment overflowed"
33 #define MAX_MV 1024
34 #else
35 #define MAX_MV 4096
36 #endif
37 #define MAX_DMV (2*MAX_MV)
38 #define ME_MAP_SIZE 64
39 
40 #define FF_ME_ZERO 0
41 #define FF_ME_EPZS 1
42 #define FF_ME_XONE 2
43 
44 /**
45  * Motion estimation context.
46  */
47 typedef struct MotionEstContext {
49  int skip; ///< set if ME is skipped for the current MB
50  int co_located_mv[4][2]; ///< mv from last P-frame for direct mode ME
51  int direct_basis_mv[4][2];
52  uint8_t *scratchpad; /**< data area for the ME algo, so that
53  * the ME does not need to malloc/free. */
57  int best_bits;
58  uint32_t *map; ///< map to avoid duplicate evaluations
59  uint32_t *score_map; ///< map to store the scores
60  unsigned map_generation;
62  int penalty_factor; /**< an estimate of the bits required to
63  * code a given mv value, e.g. (1,0) takes
64  * more bits than (0,0). We have to
65  * estimate whether any reduction in
66  * residual is worth the extra bits. */
69  int flags;
70  int sub_flags;
71  int mb_flags;
72  int pre_pass; ///< = 1 for the pre pass
73  int dia_size;
74  int xmin;
75  int xmax;
76  int ymin;
77  int ymax;
78  int pred_x;
79  int pred_y;
80  uint8_t *src[4][4];
81  uint8_t *ref[4][4];
82  int stride;
83  int uvstride;
84  /* temp variables for picture complexity calculation */
86  int64_t mb_var_sum_temp;
88 
93  uint8_t (*mv_penalty)[MAX_DMV * 2 + 1]; ///< bit amount needed to encode a MV
96  int *mx_ptr, int *my_ptr, int dmin,
97  int src_index, int ref_index,
98  int size, int h);
100 
101 static inline int ff_h263_round_chroma(int x)
102 {
103  //FIXME static or not?
104  static const uint8_t h263_chroma_roundtab[16] = {
105  // 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
106  0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1,
107  };
108  return h263_chroma_roundtab[x & 0xf] + (x >> 3);
109 }
110 
111 int ff_init_me(struct MpegEncContext *s);
112 
113 void ff_estimate_p_frame_motion(struct MpegEncContext *s, int mb_x, int mb_y);
114 void ff_estimate_b_frame_motion(struct MpegEncContext *s, int mb_x, int mb_y);
115 
117  int mb_x, int mb_y);
118 
119 int ff_epzs_motion_search(struct MpegEncContext *s, int *mx_ptr, int *my_ptr,
120  int P[10][2], int src_index, int ref_index,
121  int16_t (*last_mv)[2], int ref_mv_scale, int size,
122  int h);
123 
124 int ff_get_mb_score(struct MpegEncContext *s, int mx, int my, int src_index,
125  int ref_index, int size, int h, int add_rate);
126 
128  int16_t (*mv_table)[2], int type);
129 
130 void ff_fix_long_p_mvs(struct MpegEncContext *s, int type);
131 void ff_fix_long_mvs(struct MpegEncContext *s, uint8_t *field_select_table,
132  int field_select, int16_t (*mv_table)[2], int f_code,
133  int type, int truncate);
134 
135 #endif /* AVCODEC_MOTION_EST_H */
ff_h263_round_chroma
static int ff_h263_round_chroma(int x)
Definition: motion_est.h:101
MotionEstContext::pred_y
int pred_y
Definition: motion_est.h:79
MotionEstContext::sub_penalty_factor
int sub_penalty_factor
Definition: motion_est.h:67
MotionEstContext::mb_penalty_factor
int mb_penalty_factor
Definition: motion_est.h:68
MotionEstContext::ref
uint8_t * ref[4][4]
Definition: motion_est.h:81
MotionEstContext
Motion estimation context.
Definition: motion_est.h:47
MAX_DMV
#define MAX_DMV
Definition: motion_est.h:37
ff_fix_long_p_mvs
void ff_fix_long_p_mvs(struct MpegEncContext *s, int type)
Definition: motion_est.c:1651
ff_init_me
int ff_init_me(struct MpegEncContext *s)
Definition: motion_est.c:306
MotionEstContext::best_mb
uint8_t * best_mb
Definition: motion_est.h:54
MotionEstContext::co_located_mv
int co_located_mv[4][2]
mv from last P-frame for direct mode ME
Definition: motion_est.h:50
ff_estimate_p_frame_motion
void ff_estimate_p_frame_motion(struct MpegEncContext *s, int mb_x, int mb_y)
Definition: motion_est.c:885
ff_get_best_fcode
int ff_get_best_fcode(struct MpegEncContext *s, int16_t(*mv_table)[2], int type)
Definition: motion_est.c:1598
x
FFmpeg Automated Testing Environment ************************************Introduction Using FATE from your FFmpeg source directory Submitting the results to the FFmpeg result aggregation server Uploading new samples to the fate suite FATE makefile targets and variables Makefile targets Makefile variables Examples Introduction **************FATE is an extended regression suite on the client side and a means for results aggregation and presentation on the server side The first part of this document explains how you can use FATE from your FFmpeg source directory to test your ffmpeg binary The second part describes how you can run FATE to submit the results to FFmpeg’s FATE server In any way you can have a look at the publicly viewable FATE results by visiting this as it can be seen if some test on some platform broke with their recent contribution This usually happens on the platforms the developers could not test on The second part of this document describes how you can run FATE to submit your results to FFmpeg’s FATE server If you want to submit your results be sure to check that your combination of OS and compiler is not already listed on the above mentioned website In the third part you can find a comprehensive listing of FATE makefile targets and variables Using FATE from your FFmpeg source directory **********************************************If you want to run FATE on your machine you need to have the samples in place You can get the samples via the build target fate rsync Use this command from the top level source this will cause FATE to fail NOTE To use a custom wrapper to run the pass ‘ target exec’ to ‘configure’ or set the TARGET_EXEC Make variable Submitting the results to the FFmpeg result aggregation server ****************************************************************To submit your results to the server you should run fate through the shell script ‘tests fate sh’ from the FFmpeg sources This script needs to be invoked with a configuration file as its first argument tests fate sh path to fate_config A configuration file template with comments describing the individual configuration variables can be found at ‘doc fate_config sh template’ Create a configuration that suits your based on the configuration template The ‘slot’ configuration variable can be any string that is not yet but it is suggested that you name it adhering to the following pattern ‘ARCH OS COMPILER COMPILER VERSION’ The configuration file itself will be sourced in a shell therefore all shell features may be used This enables you to setup the environment as you need it for your build For your first test runs the ‘fate_recv’ variable should be empty or commented out This will run everything as normal except that it will omit the submission of the results to the server The following files should be present in $workdir as specified in the configuration it may help to try out the ‘ssh’ command with one or more ‘ v’ options You should get detailed output concerning your SSH configuration and the authentication process The only thing left is to automate the execution of the fate sh script and the synchronisation of the samples directory Uploading new samples to the fate suite *****************************************If you need a sample uploaded send a mail to samples request This is for developers who have an account on the fate suite server If you upload new please make sure they are as small as space on each network bandwidth and so on benefit from smaller test cases Also keep in mind older checkouts use existing sample that means in practice generally do not remove or overwrite files as it likely would break older checkouts or releases Also all needed samples for a commit should be ideally before the push If you need an account for frequently uploading samples or you wish to help others by doing that send a mail to ffmpeg devel rsync vauL Duo x
Definition: fate.txt:150
MotionEstContext::qpel_avg
qpel_mc_func(* qpel_avg)[16]
Definition: motion_est.h:92
type
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf type
Definition: writing_filters.txt:86
MotionEstContext::mv_penalty
uint8_t(* mv_penalty)[MAX_DMV *2+1]
bit amount needed to encode a MV
Definition: motion_est.h:93
MotionEstContext::mb_var_sum_temp
int64_t mb_var_sum_temp
Definition: motion_est.h:86
MotionEstContext::hpel_avg
op_pixels_func(* hpel_avg)[4]
Definition: motion_est.h:90
s
#define s(width, name)
Definition: cbs_vp9.c:257
MotionEstContext::hpel_put
op_pixels_func(* hpel_put)[4]
Definition: motion_est.h:89
MotionEstContext::ymax
int ymax
Definition: motion_est.h:77
MotionEstContext::dia_size
int dia_size
Definition: motion_est.h:73
MpegEncContext::field_select
int field_select[2][2]
Definition: mpegvideo.h:277
MotionEstContext::flags
int flags
Definition: motion_est.h:69
MpegEncContext::mb_y
int mb_y
Definition: mpegvideo.h:288
MpegEncContext::f_code
int f_code
forward MV resolution
Definition: mpegvideo.h:238
qpeldsp.h
MotionEstContext::skip
int skip
set if ME is skipped for the current MB
Definition: motion_est.h:49
ff_estimate_b_frame_motion
void ff_estimate_b_frame_motion(struct MpegEncContext *s, int mb_x, int mb_y)
Definition: motion_est.c:1490
op_pixels_func
void(* op_pixels_func)(uint8_t *block, const uint8_t *pixels, ptrdiff_t line_size, int h)
Definition: hpeldsp.h:38
qpel_mc_func
void(* qpel_mc_func)(uint8_t *dst, const uint8_t *src, ptrdiff_t stride)
Definition: qpeldsp.h:65
ff_epzs_motion_search
int ff_epzs_motion_search(struct MpegEncContext *s, int *mx_ptr, int *my_ptr, int P[10][2], int src_index, int ref_index, int16_t(*last_mv)[2], int ref_mv_scale, int size, int h)
Definition: motion_est_template.c:976
MotionEstContext::xmax
int xmax
Definition: motion_est.h:75
MotionEstContext::qpel_put
qpel_mc_func(* qpel_put)[16]
Definition: motion_est.h:91
MotionEstContext::temp
uint8_t * temp
Definition: motion_est.h:56
MotionEstContext::avctx
AVCodecContext * avctx
Definition: motion_est.h:48
P
#define P
MotionEstContext::stride
int stride
Definition: motion_est.h:82
MotionEstContext::ymin
int ymin
Definition: motion_est.h:76
size
int size
Definition: twinvq_data.h:11134
MotionEstContext::current_mv_penalty
uint8_t * current_mv_penalty
Definition: motion_est.h:94
ff_get_mb_score
int ff_get_mb_score(struct MpegEncContext *s, int mx, int my, int src_index, int ref_index, int size, int h, int add_rate)
Definition: motion_est_template.c:192
MotionEstContext::sub_motion_search
int(* sub_motion_search)(struct MpegEncContext *s, int *mx_ptr, int *my_ptr, int dmin, int src_index, int ref_index, int size, int h)
Definition: motion_est.h:95
MpegEncContext::last_mv
int last_mv[2][2][2]
last MV, used for MV prediction in MPEG-1 & B-frame MPEG-4
Definition: mpegvideo.h:278
MotionEstContext::temp_mb
uint8_t * temp_mb[2]
Definition: motion_est.h:55
MotionEstContext::src
uint8_t * src[4][4]
Definition: motion_est.h:80
MpegEncContext::mb_x
int mb_x
Definition: mpegvideo.h:288
MotionEstContext::direct_basis_mv
int direct_basis_mv[4][2]
Definition: motion_est.h:51
uint8_t
uint8_t
Definition: audio_convert.c:194
MotionEstContext::sub_flags
int sub_flags
Definition: motion_est.h:70
MotionEstContext::score_map
uint32_t * score_map
map to store the scores
Definition: motion_est.h:59
avcodec.h
ff_pre_estimate_p_frame_motion
int ff_pre_estimate_p_frame_motion(struct MpegEncContext *s, int mb_x, int mb_y)
Definition: motion_est.c:1061
MotionEstContext::xmin
int xmin
Definition: motion_est.h:74
MotionEstContext::best_bits
int best_bits
Definition: motion_est.h:57
MotionEstContext::uvstride
int uvstride
Definition: motion_est.h:83
MotionEstContext::penalty_factor
int penalty_factor
an estimate of the bits required to code a given mv value, e.g.
Definition: motion_est.h:62
MotionEstContext::pre_penalty_factor
int pre_penalty_factor
Definition: motion_est.h:61
MotionEstContext::scratchpad
uint8_t * scratchpad
data area for the ME algo, so that the ME does not need to malloc/free.
Definition: motion_est.h:52
AVCodecContext
main external API structure.
Definition: avcodec.h:526
MotionEstContext::mc_mb_var_sum_temp
int64_t mc_mb_var_sum_temp
Definition: motion_est.h:85
MotionEstContext::map_generation
unsigned map_generation
Definition: motion_est.h:60
MotionEstContext::pre_pass
int pre_pass
= 1 for the pre pass
Definition: motion_est.h:72
MotionEstContext::map
uint32_t * map
map to avoid duplicate evaluations
Definition: motion_est.h:58
hpeldsp.h
MotionEstContext::mb_flags
int mb_flags
Definition: motion_est.h:71
MotionEstContext::scene_change_score
int scene_change_score
Definition: motion_est.h:87
h
h
Definition: vp9dsp_template.c:2038
ff_fix_long_mvs
void ff_fix_long_mvs(struct MpegEncContext *s, uint8_t *field_select_table, int field_select, int16_t(*mv_table)[2], int f_code, int type, int truncate)
Definition: motion_est.c:1700
int
int
Definition: ffmpeg_filter.c:192
MpegEncContext
MpegEncContext.
Definition: mpegvideo.h:81
MotionEstContext::pred_x
int pred_x
Definition: motion_est.h:78