Blindly merge jitter buffer patch of bug #4342)
[asterisk/asterisk.git] / jitterbuf.h
1 /*
2  * jitterbuf: an application-independent jitterbuffer
3  *
4  * Copyrights:
5  * Copyright (C) 2004-2005, Horizon Wimba, Inc.
6  *
7  * Contributors:
8  * Steve Kann <stevek@stevek.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU Lesser (Library) General Public License
12  *
13  * Copyright on this file is disclaimed to Digium for inclusion in Asterisk
14  */
15
16 #ifndef _JITTERBUF_H_
17 #define _JITTERBUF_H_
18
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22
23 /* configuration constants */
24         /* Number of historical timestamps to use in calculating jitter and drift */
25 #define JB_HISTORY_SZ           500     
26         /* what percentage of timestamps should we drop from the history when we examine it;
27          * this might eventually be something made configurable */
28 #define JB_HISTORY_DROPPCT      3
29         /* the maximum droppct we can handle (say it was configurable). */
30 #define JB_HISTORY_DROPPCT_MAX  4
31         /* the size of the buffer we use to keep the top and botton timestamps for dropping */
32 #define JB_HISTORY_MAXBUF_SZ    JB_HISTORY_SZ * JB_HISTORY_DROPPCT_MAX / 100 
33         /* amount of additional jitterbuffer adjustment  */
34 #define JB_TARGET_EXTRA 40
35         /* ms between growing and shrinking; may not be honored if jitterbuffer runs out of space */
36 #define JB_ADJUST_DELAY 40
37
38
39 /* return codes */
40 #define JB_OK           0
41 #define JB_EMPTY        1
42 #define JB_NOFRAME      2
43 #define JB_INTERP       3
44 #define JB_DROP         4
45 #define JB_SCHED        5
46
47 /* frame types */
48 #define JB_TYPE_CONTROL 0
49 #define JB_TYPE_VOICE   1
50 #define JB_TYPE_VIDEO   2  /* reserved */
51 #define JB_TYPE_SILENCE 3
52
53
54 typedef struct jb_conf {
55         /* settings */
56         long max_jitterbuf;     /* defines a hard clamp to use in setting the jitter buffer delay */
57         long resync_threshold;  /* the jb will resync when delay increases to (2 * jitter) + this param */
58 } jb_conf;
59
60 typedef struct jb_info {
61         jb_conf conf;
62
63         /* statistics */
64         long frames_in;         /* number of frames input to the jitterbuffer.*/
65         long frames_out;        /* number of frames output from the jitterbuffer.*/
66         long frames_late;       /* number of frames which were too late, and dropped.*/
67         long frames_lost;       /* number of missing frames.*/
68         long frames_dropped;    /* number of frames dropped (shrinkage) */
69         long frames_ooo;        /* number of frames received out-of-order */
70         long frames_cur;        /* number of frames presently in jb, awaiting delivery.*/
71         long jitter;            /* jitter measured within current history interval*/
72         long min;               /* minimum lateness within current history interval */
73         long current;           /* the present jitterbuffer adjustment */
74         long target;            /* the target jitterbuffer adjustment */
75         long losspct;           /* recent lost frame percentage (* 1000) */
76         long next_voice_ts;     /* the ts of the next frame to be read from the jb - in receiver's time */
77         long last_voice_ms;     /* the duration of the last voice frame */
78         long silence_begin_ts;  /* the time of the last CNG frame, when in silence */
79         long last_adjustment;   /* the time of the last adjustment */
80         long last_delay;        /* the last now added to history */
81         long cnt_delay_discont; /* the count of discontinuous delays */
82         long resync_offset;     /* the amount to offset ts to support resyncs */
83 } jb_info;
84
85 typedef struct jb_frame {
86         void *data;             /* the frame data */
87         long ts;        /* the relative delivery time expected */
88         long ms;        /* the time covered by this frame, in sec/8000 */
89         int  type;      /* the type of frame */
90         struct jb_frame *next, *prev;
91 } jb_frame;
92
93 typedef struct jitterbuf {
94         jb_info info;
95
96         /* history */
97         long history[JB_HISTORY_SZ];            /* history */
98         int  hist_ptr;                          /* points to index in history for next entry */
99         long hist_maxbuf[JB_HISTORY_MAXBUF_SZ]; /* a sorted buffer of the max delays (highest first) */
100         long hist_minbuf[JB_HISTORY_MAXBUF_SZ]; /* a sorted buffer of the min delays (lowest first) */
101         int  hist_maxbuf_valid;                 /* are the "maxbuf"/minbuf valid? */
102
103
104         jb_frame *frames;               /* queued frames */
105         jb_frame *free;                 /* free frames (avoid malloc?) */
106 } jitterbuf;
107
108
109 /* new jitterbuf */
110 jitterbuf *             jb_new(void);
111
112 /* destroy jitterbuf */
113 void                    jb_destroy(jitterbuf *jb);
114
115 /* reset jitterbuf */
116 /* NOTE:  The jitterbuffer should be empty before you call this, otherwise
117  * you will leak queued frames, and some internal structures */
118 void                    jb_reset(jitterbuf *jb);
119
120 /* queue a frame data=frame data, timings (in ms): ms=length of frame (for voice), ts=ts (sender's time) 
121  * now=now (in receiver's time) return value is one of 
122  * JB_OK: Frame added. Last call to jb_next() still valid
123  * JB_DROP: Drop this frame immediately
124  * JB_SCHED: Frame added. Call jb_next() to get a new time for the next frame
125  */
126 int                     jb_put(jitterbuf *jb, void *data, int type, long ms, long ts, long now);
127
128 /* get a frame for time now (receiver's time)  return value is one of
129  * JB_OK:  You've got frame!
130  * JB_DROP: Here's an audio frame you should just drop.  Ask me again for this time..
131  * JB_NOFRAME: There's no frame scheduled for this time.
132  * JB_INTERP: Please interpolate an interpl-length frame for this time (either we need to grow, or there was a lost frame) 
133  * JB_EMPTY: The jb is empty.
134  */
135 int                     jb_get(jitterbuf *jb, jb_frame *frame, long now, long interpl);
136
137 /* unconditionally get frames from jitterbuf until empty */
138 int jb_getall(jitterbuf *jb, jb_frame *frameout);
139
140 /* when is the next frame due out, in receiver's time (0=EMPTY) 
141  * This value may change as frames are added (esp non-audio frames) */
142 long                    jb_next(jitterbuf *jb);
143
144 /* get jitterbuf info: only "statistics" may be valid */
145 int                     jb_getinfo(jitterbuf *jb, jb_info *stats);
146
147 /* set jitterbuf conf */
148 int                     jb_setconf(jitterbuf *jb, jb_conf *conf);
149
150 typedef                 void (*jb_output_function_t)(const char *fmt, ...);
151 void                    jb_setoutput(jb_output_function_t err, jb_output_function_t warn, jb_output_function_t dbg);
152
153 #ifdef __cplusplus
154 }
155 #endif
156
157
158 #endif