CABAC/CAVLC: use the new bit-iterating macro here too
[x264/x264-sandbox.git] / encoder / ratecontrol.h
1 /*****************************************************************************
2  * ratecontrol.h: ratecontrol
3  *****************************************************************************
4  * Copyright (C) 2003-2013 x264 project
5  *
6  * Authors: Loren Merritt <lorenm@u.washington.edu>
7  *          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., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
22  *
23  * This program is also available under a commercial proprietary license.
24  * For more information, contact us at licensing@x264.com.
25  *****************************************************************************/
26
27 #ifndef X264_RATECONTROL_H
28 #define X264_RATECONTROL_H
29
30 /* Completely arbitrary.  Ratecontrol lowers relative quality at higher framerates
31  * and the reverse at lower framerates; this serves as the center of the curve.
32  * Halve all the values for frame-packed 3D to compensate for the "doubled"
33  * framerate. */
34 #define BASE_FRAME_DURATION (0.04f / ((h->param.i_frame_packing == 5)+1))
35
36 /* Arbitrary limitations as a sanity check. */
37 #define MAX_FRAME_DURATION (1.00f / ((h->param.i_frame_packing == 5)+1))
38 #define MIN_FRAME_DURATION (0.01f / ((h->param.i_frame_packing == 5)+1))
39
40 #define CLIP_DURATION(f) x264_clip3f(f,MIN_FRAME_DURATION,MAX_FRAME_DURATION)
41
42 int  x264_ratecontrol_new   ( x264_t * );
43 void x264_ratecontrol_delete( x264_t * );
44
45 void x264_ratecontrol_init_reconfigurable( x264_t *h, int b_init );
46
47 void x264_adaptive_quant_frame( x264_t *h, x264_frame_t *frame, float *quant_offsets );
48 int  x264_macroblock_tree_read( x264_t *h, x264_frame_t *frame, float *quant_offsets );
49 int  x264_reference_build_list_optimal( x264_t *h );
50 void x264_thread_sync_ratecontrol( x264_t *cur, x264_t *prev, x264_t *next );
51 void x264_ratecontrol_start( x264_t *, int i_force_qp, int overhead );
52 int  x264_ratecontrol_slice_type( x264_t *, int i_frame );
53 void x264_ratecontrol_set_weights( x264_t *h, x264_frame_t *frm );
54 int  x264_ratecontrol_mb( x264_t *, int bits );
55 int  x264_ratecontrol_qp( x264_t * );
56 int  x264_ratecontrol_mb_qp( x264_t *h );
57 int  x264_ratecontrol_end( x264_t *, int bits, int *filler );
58 void x264_ratecontrol_summary( x264_t * );
59 void x264_ratecontrol_set_estimated_size( x264_t *, int bits );
60 int  x264_ratecontrol_get_estimated_size( x264_t const *);
61 int  x264_rc_analyse_slice( x264_t *h );
62 int x264_weighted_reference_duplicate( x264_t *h, int i_ref, const x264_weight_t *w );
63 void x264_threads_distribute_ratecontrol( x264_t *h );
64 void x264_threads_merge_ratecontrol( x264_t *h );
65 void x264_hrd_fullness( x264_t *h );
66 #endif
67