Move the ratecontrol related code from mpegvideo.h to a separate header file.
[ffmpeg.git] / libavcodec / ratecontrol.h
1 /*
2  * Ratecontrol
3  * Copyright (c) 2000, 2001, 2002 Fabrice Bellard.
4  * Copyright (c) 2002-2004 Michael Niedermayer
5  *
6  * This library 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 of the License, or (at your option) any later version.
10  *
11  * This library 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 this library; 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_RATECONTROL_H
22 #define AVCODEC_RATECONTROL_H
23
24 /**
25  * @file ratecontrol.h
26  * ratecontrol header.
27  */
28
29 typedef struct Predictor{
30     double coeff;
31     double count;
32     double decay;
33 } Predictor;
34
35 typedef struct RateControlEntry{
36     int pict_type;
37     float qscale;
38     int mv_bits;
39     int i_tex_bits;
40     int p_tex_bits;
41     int misc_bits;
42     int header_bits;
43     uint64_t expected_bits;
44     int new_pict_type;
45     float new_qscale;
46     int mc_mb_var_sum;
47     int mb_var_sum;
48     int i_count;
49     int skip_count;
50     int f_code;
51     int b_code;
52 }RateControlEntry;
53
54 /**
55  * rate control context.
56  */
57 typedef struct RateControlContext{
58     FILE *stats_file;
59     int num_entries;              ///< number of RateControlEntries
60     RateControlEntry *entry;
61     double buffer_index;          ///< amount of bits in the video/audio buffer
62     Predictor pred[5];
63     double short_term_qsum;       ///< sum of recent qscales
64     double short_term_qcount;     ///< count of recent qscales
65     double pass1_rc_eq_output_sum;///< sum of the output of the rc equation, this is used for normalization
66     double pass1_wanted_bits;     ///< bits which should have been outputed by the pass1 code (including complexity init)
67     double last_qscale;
68     double last_qscale_for[5];    ///< last qscale for a specific pict type, used for max_diff & ipb factor stuff
69     int last_mc_mb_var_sum;
70     int last_mb_var_sum;
71     uint64_t i_cplx_sum[5];
72     uint64_t p_cplx_sum[5];
73     uint64_t mv_bits_sum[5];
74     uint64_t qscale_sum[5];
75     int frame_count[5];
76     int last_non_b_pict_type;
77
78     void *non_lavc_opaque;        ///< context for non lavc rc code (for example xvid)
79     float dry_run_qscale;         ///< for xvid rc
80     int last_picture_number;      ///< for xvid rc
81 }RateControlContext;
82
83 struct MpegEncContext;
84
85 /* rate control */
86 int ff_rate_control_init(struct MpegEncContext *s);
87 float ff_rate_estimate_qscale(struct MpegEncContext *s, int dry_run);
88 void ff_write_pass1_stats(struct MpegEncContext *s);
89 void ff_rate_control_uninit(struct MpegEncContext *s);
90 int ff_vbv_update(struct MpegEncContext *s, int frame_size);
91 void ff_get_2pass_fcode(struct MpegEncContext *s);
92
93 int ff_xvid_rate_control_init(struct MpegEncContext *s);
94 void ff_xvid_rate_control_uninit(struct MpegEncContext *s);
95 float ff_xvid_rate_estimate_qscale(struct MpegEncContext *s, int dry_run);
96
97 #endif /* AVCODEC_RATECONTROL_H */
98