(closes issue #10271)
[asterisk/asterisk.git] / include / 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 enum jb_return_code {
39         /* return codes */
40         JB_OK,            /* 0 */
41         JB_EMPTY,         /* 1 */
42         JB_NOFRAME,       /* 2 */
43         JB_INTERP,        /* 3 */
44         JB_DROP,          /* 4 */
45         JB_SCHED          /* 5 */
46 };
47
48 enum jb_frame_type {
49         /* frame types */
50         JB_TYPE_CONTROL,  /* 0            */
51         JB_TYPE_VOICE,    /* 1            */
52         JB_TYPE_VIDEO,    /* 2 - reserved */
53         JB_TYPE_SILENCE   /* 3            */
54 };
55
56 typedef struct jb_conf {
57         /* settings */
58         long max_jitterbuf;     /*!< defines a hard clamp to use in setting the jitter buffer delay */
59         long resync_threshold;  /*!< the jb will resync when delay increases to (2 * jitter) + this param */
60         long max_contig_interp; /*!< the max interp frames to return in a row */
61         long target_extra ;      /*!< amount of additional jitterbuffer adjustment, overrides JB_TARGET_EXTRA */
62 } jb_conf;
63
64 typedef struct jb_info {
65         jb_conf conf;
66
67         /* statistics */
68         long frames_in;         /*!< number of frames input to the jitterbuffer.*/
69         long frames_out;        /*!< number of frames output from the jitterbuffer.*/
70         long frames_late;       /*!< number of frames which were too late, and dropped.*/
71         long frames_lost;       /*!< number of missing frames.*/
72         long frames_dropped;    /*!< number of frames dropped (shrinkage) */
73         long frames_ooo;        /*!< number of frames received out-of-order */
74         long frames_cur;        /*!< number of frames presently in jb, awaiting delivery.*/
75         long jitter;            /*!< jitter measured within current history interval*/
76         long min;               /*!< minimum lateness within current history interval */
77         long current;           /*!< the present jitterbuffer adjustment */
78         long target;            /*!< the target jitterbuffer adjustment */
79         long losspct;           /*!< recent lost frame percentage (* 1000) */
80         long next_voice_ts;     /*!< the ts of the next frame to be read from the jb - in receiver's time */
81         long last_voice_ms;     /*!< the duration of the last voice frame */
82         long silence_begin_ts;  /*!< the time of the last CNG frame, when in silence */
83         long last_adjustment;   /*!< the time of the last adjustment */
84         long last_delay;        /*!< the last now added to history */
85         long cnt_delay_discont; /*!< the count of discontinuous delays */
86         long resync_offset;     /*!< the amount to offset ts to support resyncs */
87         long cnt_contig_interp; /*!< the number of contiguous interp frames returned */
88 } jb_info;
89
90 typedef struct jb_frame {
91         void *data;               /* the frame data */
92         long ts;                  /* the relative delivery time expected */
93         long ms;                  /* the time covered by this frame, in sec/8000 */
94         enum jb_frame_type type;  /* the type of frame */
95         struct jb_frame *next, *prev;
96 } jb_frame;
97
98 typedef struct jitterbuf {
99         jb_info info;
100
101         /* history */
102         long history[JB_HISTORY_SZ];            /*!< history */
103         int  hist_ptr;                          /*!< points to index in history for next entry */
104         long hist_maxbuf[JB_HISTORY_MAXBUF_SZ]; /*!< a sorted buffer of the max delays (highest first) */
105         long hist_minbuf[JB_HISTORY_MAXBUF_SZ]; /*!< a sorted buffer of the min delays (lowest first) */
106         int  hist_maxbuf_valid;                 /*!< are the "maxbuf"/minbuf valid? */
107         unsigned int dropem:1;                  /*!< flag to indicate dropping frames (overload) */
108
109         jb_frame *frames;               /*!< queued frames */
110         jb_frame *free;                 /*!< free frames (avoid malloc?) */
111 } jitterbuf;
112
113
114 /* new jitterbuf */
115 jitterbuf *             jb_new(void);
116
117 /* destroy jitterbuf */
118 void                    jb_destroy(jitterbuf *jb);
119
120 /* reset jitterbuf */
121 /* NOTE:  The jitterbuffer should be empty before you call this, otherwise
122  * you will leak queued frames, and some internal structures */
123 void                    jb_reset(jitterbuf *jb);
124
125 /* queue a frame data=frame data, timings (in ms): ms=length of frame (for voice), ts=ts (sender's time) 
126  * now=now (in receiver's time) return value is one of 
127  * JB_OK: Frame added. Last call to jb_next() still valid
128  * JB_DROP: Drop this frame immediately
129  * JB_SCHED: Frame added. Call jb_next() to get a new time for the next frame
130  */
131 enum jb_return_code jb_put(jitterbuf *jb, void *data, const enum jb_frame_type type, long ms, long ts, long now);
132
133 /* get a frame for time now (receiver's time)  return value is one of
134  * JB_OK:  You've got frame!
135  * JB_DROP: Here's an audio frame you should just drop.  Ask me again for this time..
136  * JB_NOFRAME: There's no frame scheduled for this time.
137  * JB_INTERP: Please interpolate an interpl-length frame for this time (either we need to grow, or there was a lost frame) 
138  * JB_EMPTY: The jb is empty.
139  */
140 enum jb_return_code jb_get(jitterbuf *jb, jb_frame *frame, long now, long interpl);
141
142 /* unconditionally get frames from jitterbuf until empty */
143 enum jb_return_code jb_getall(jitterbuf *jb, jb_frame *frameout);
144
145 /* when is the next frame due out, in receiver's time (0=EMPTY) 
146  * This value may change as frames are added (esp non-audio frames) */
147 long                    jb_next(jitterbuf *jb);
148
149 /*! get jitterbuf info: only "statistics" may be valid */
150 enum jb_return_code jb_getinfo(jitterbuf *jb, jb_info *stats);
151
152 /*! set jitterbuf conf */
153 enum jb_return_code jb_setconf(jitterbuf *jb, jb_conf *conf);
154
155 typedef                 void (*jb_output_function_t)(const char *fmt, ...);
156 void                    jb_setoutput(jb_output_function_t err, jb_output_function_t warn, jb_output_function_t dbg);
157
158 #ifdef __cplusplus
159 }
160 #endif
161
162
163 #endif