Initial branch merge toward rc3
[platform/upstream/libvorbis.git] / lib / bitrate.h
1 /********************************************************************
2  *                                                                  *
3  * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
4  * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
5  * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
6  * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
7  *                                                                  *
8  * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001             *
9  * by the XIPHOPHORUS Company http://www.xiph.org/                  *
10  *                                                                  *
11  ********************************************************************
12
13  function: bitrate tracking and management
14  last mod: $Id: bitrate.h,v 1.2 2001/12/12 09:45:24 xiphmont Exp $
15
16  ********************************************************************/
17
18 #ifndef _V_BITRATE_H_
19 #define _V_BITRATE_H_
20
21 #include "vorbis/codec.h"
22 #include "codec_internal.h"
23 #include "os.h"
24
25 /* encode side bitrate tracking */
26 #define BITTRACK_DIVISOR 16
27 typedef struct bitrate_manager_state {
28   ogg_uint32_t  *queue_binned;
29   ogg_uint32_t  *queue_actual;
30   int            queue_size;
31
32   int            queue_head;
33   int            queue_bins;
34
35   long          *avg_binacc;
36   int            avg_center;
37   int            avg_tail;
38   ogg_uint32_t   avg_centeracc;
39   ogg_uint32_t   avg_sampleacc;
40   ogg_uint32_t   avg_sampledesired;
41   ogg_uint32_t   avg_centerdesired;
42
43   long          *minmax_binstack;
44   long          *minmax_posstack;
45   long          *minmax_limitstack;
46   long           minmax_stackptr;
47
48   long           minmax_acctotal;
49   int            minmax_tail;
50   ogg_uint32_t   minmax_sampleacc;
51   ogg_uint32_t   minmax_sampledesired;
52
53   int            next_to_flush;
54   int            last_to_flush;
55   
56   double         avgfloat;
57   double         avgnoise;
58   long           noisetrigger_postpone;
59   long           noisetrigger_request;
60
61   /* unfortunately, we need to hold queued packet data somewhere */
62   oggpack_buffer *queue_packet_buffers;
63   ogg_packet     *queue_packets;
64
65 } bitrate_manager_state;
66
67 typedef struct bitrate_manager_info{
68   /* detailed bitrate management setup */
69   double queue_avg_time;
70   double queue_avg_center;
71   double queue_minmax_time;
72   double queue_hardmin;
73   double queue_hardmax;
74   double queue_avgmin;
75   double queue_avgmax;
76
77   double avgfloat_initial; /* set by mode */
78   double avgfloat_minimum; /* set by mode */
79   double avgfloat_downslew_max;
80   double avgfloat_upslew_max;
81   double avgfloat_downhyst;
82   double avgfloat_uphyst;
83   double avgfloat_noise_lowtrigger;
84   double avgfloat_noise_hightrigger;
85   double avgfloat_noise_minval;
86   double avgfloat_noise_maxval;
87 } bitrate_manager_info;
88
89 extern void vorbis_bitrate_init(vorbis_info *vi,bitrate_manager_state *bs);
90 extern void vorbis_bitrate_clear(bitrate_manager_state *bs);
91 extern int vorbis_bitrate_managed(vorbis_block *vb);
92 extern int vorbis_bitrate_maxmarkers(void);
93 extern int vorbis_bitrate_addblock(vorbis_block *vb);
94 extern int vorbis_bitrate_flushpacket(vorbis_dsp_state *vd, ogg_packet *op);
95
96 #endif