finish merging doxygen updates from issue #5605
[asterisk/asterisk.git] / jitterbuf.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2004-2005, Horizon Wimba, Inc.
5  *
6  * Contributors:
7  * Steve Kann <stevek@stevek.com>
8  *
9  * Copyright on this file is disclaimed to Digium for inclusion in Asterisk
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  * This program is free software, distributed under the terms of
18  * the GNU General Public License Version 2. See the LICENSE file
19  * at the top of the source tree.
20  */
21
22 /*! \file
23  *
24  * \brief jitterbuf: an application-independent jitterbuffer
25  * \author Steve Kann <stevek@stevek.com>
26  *
27  */
28
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include "jitterbuf.h"
38
39 /*! define these here, just for ancient compiler systems */
40 #define JB_LONGMAX 2147483647L
41 #define JB_LONGMIN (-JB_LONGMAX - 1L)
42
43 #define jb_warn(...) (warnf ? warnf(__VA_ARGS__) : (void)0)
44 #define jb_err(...) (errf ? errf(__VA_ARGS__) : (void)0)
45 #define jb_dbg(...) (dbgf ? dbgf(__VA_ARGS__) : (void)0)
46
47 #ifdef DEEP_DEBUG
48 #define jb_dbg2(...) (dbgf ? dbgf(__VA_ARGS__) : (void)0)
49 #else
50 #define jb_dbg2(...) ((void)0)
51 #endif
52
53 static jb_output_function_t warnf, errf, dbgf;
54
55 void jb_setoutput(jb_output_function_t err, jb_output_function_t warn, jb_output_function_t dbg) 
56 {
57         errf = err;
58         warnf = warn;
59         dbgf = dbg;
60 }
61
62 static void increment_losspct(jitterbuf *jb) 
63 {
64         jb->info.losspct = (100000 + 499 * jb->info.losspct)/500;    
65 }
66
67 static void decrement_losspct(jitterbuf *jb) 
68 {
69         jb->info.losspct = (499 * jb->info.losspct)/500;    
70 }
71
72 void jb_reset(jitterbuf *jb) 
73 {
74         /* only save settings */
75         jb_conf s = jb->info.conf;
76         memset(jb,0,sizeof(jitterbuf));
77         jb->info.conf = s;
78
79         /* initialize length */
80         jb->info.current = jb->info.target = JB_TARGET_EXTRA; 
81         jb->info.silence_begin_ts = -1; 
82 }
83
84 jitterbuf * jb_new() 
85 {
86         jitterbuf *jb;
87
88
89         jb = malloc(sizeof(jitterbuf));
90         if (!jb) 
91                 return NULL;
92
93         jb_reset(jb);
94
95         jb_dbg2("jb_new() = %x\n", jb);
96         return jb;
97 }
98
99 void jb_destroy(jitterbuf *jb) 
100 {
101         jb_frame *frame; 
102         jb_dbg2("jb_destroy(%x)\n", jb);
103
104         /* free all the frames on the "free list" */
105         frame = jb->free;
106         while (frame != NULL) {
107                 jb_frame *next = frame->next;
108                 free(frame);
109                 frame = next;
110         }
111
112         /* free ourselves! */ 
113         free(jb);
114 }
115
116
117
118 #if 0
119 static int longcmp(const void *a, const void *b) 
120 {
121         return *(long *)a - *(long *)b;
122 }
123 #endif
124
125 /*!     \brief simple history manipulation 
126         \note maybe later we can make the history buckets variable size, or something? */
127 /* drop parameter determines whether we will drop outliers to minimize
128  * delay */
129 static int history_put(jitterbuf *jb, long ts, long now, long ms) 
130 {
131         long delay = now - (ts - jb->info.resync_offset);
132         long threshold = 2 * jb->info.jitter + jb->info.conf.resync_threshold;
133         long kicked;
134
135         /* don't add special/negative times to history */
136         if (ts <= 0) 
137                 return 0;
138
139         /* check for drastic change in delay */
140         if (jb->info.conf.resync_threshold != -1) {
141                 if (abs(delay - jb->info.last_delay) > threshold) {
142                         jb->info.cnt_delay_discont++;
143                         if (jb->info.cnt_delay_discont > 3) {
144                                 /* resync the jitterbuffer */
145                                 jb->info.cnt_delay_discont = 0;
146                                 jb->hist_ptr = 0;
147                                 jb->hist_maxbuf_valid = 0;
148
149                                 jb_warn("Resyncing the jb. last_delay %ld, this delay %ld, threshold %ld, new offset %ld\n", jb->info.last_delay, delay, threshold, ts - now);
150                                 jb->info.resync_offset = ts - now;
151                                 jb->info.last_delay = delay = 0; /* after resync, frame is right on time */
152                         } else {
153                                 return -1;
154                         }
155                 } else {
156                         jb->info.last_delay = delay;
157                         jb->info.cnt_delay_discont = 0;
158                 }
159         }
160
161         kicked = jb->history[jb->hist_ptr & JB_HISTORY_SZ];
162
163         jb->history[(jb->hist_ptr++) % JB_HISTORY_SZ] = delay;
164
165         /* optimization; the max/min buffers don't need to be recalculated, if this packet's
166          * entry doesn't change them.  This happens if this packet is not involved, _and_ any packet
167          * that got kicked out of the history is also not involved 
168          * We do a number of comparisons, but it's probably still worthwhile, because it will usually
169          * succeed, and should be a lot faster than going through all 500 packets in history */
170         if (!jb->hist_maxbuf_valid)
171                 return 0;
172
173         /* don't do this until we've filled history 
174          * (reduces some edge cases below) */
175         if (jb->hist_ptr < JB_HISTORY_SZ)
176                 goto invalidate;
177
178         /* if the new delay would go into min */
179         if (delay < jb->hist_minbuf[JB_HISTORY_MAXBUF_SZ-1])
180                 goto invalidate;
181     
182         /* or max.. */
183         if (delay > jb->hist_maxbuf[JB_HISTORY_MAXBUF_SZ-1])
184                 goto invalidate;
185
186         /* or the kicked delay would be in min */
187         if (kicked <= jb->hist_minbuf[JB_HISTORY_MAXBUF_SZ-1]) 
188                 goto invalidate;
189
190         if (kicked >= jb->hist_maxbuf[JB_HISTORY_MAXBUF_SZ-1]) 
191                 goto invalidate;
192
193         /* if we got here, we don't need to invalidate, 'cause this delay didn't 
194          * affect things */
195         return 0;
196         /* end optimization */
197
198
199 invalidate:
200         jb->hist_maxbuf_valid = 0;
201         return 0;
202 }
203
204 static void history_calc_maxbuf(jitterbuf *jb) 
205 {
206         int i,j;
207
208         if (jb->hist_ptr == 0) 
209                 return;
210
211
212         /* initialize maxbuf/minbuf to the latest value */
213         for (i=0;i<JB_HISTORY_MAXBUF_SZ;i++) {
214 /*
215  * jb->hist_maxbuf[i] = jb->history[(jb->hist_ptr-1) % JB_HISTORY_SZ];
216  * jb->hist_minbuf[i] = jb->history[(jb->hist_ptr-1) % JB_HISTORY_SZ];
217  */
218                 jb->hist_maxbuf[i] = JB_LONGMIN;
219                 jb->hist_minbuf[i] = JB_LONGMAX;
220         }
221
222         /* use insertion sort to populate maxbuf */
223         /* we want it to be the top "n" values, in order */
224
225         /* start at the beginning, or JB_HISTORY_SZ frames ago */
226         i = (jb->hist_ptr > JB_HISTORY_SZ) ? (jb->hist_ptr - JB_HISTORY_SZ) : 0; 
227
228         for (;i<jb->hist_ptr;i++) {
229                 long toins = jb->history[i % JB_HISTORY_SZ];
230
231                 /* if the maxbuf should get this */
232                 if (toins > jb->hist_maxbuf[JB_HISTORY_MAXBUF_SZ-1])  {
233
234                         /* insertion-sort it into the maxbuf */
235                         for (j=0;j<JB_HISTORY_MAXBUF_SZ;j++) {
236                                 /* found where it fits */
237                                 if (toins > jb->hist_maxbuf[j]) {
238                                         /* move over */
239                                         memmove(jb->hist_maxbuf+j+1,jb->hist_maxbuf+j, (JB_HISTORY_MAXBUF_SZ-(j+1)) * sizeof(long));
240                                         /* insert */
241                                         jb->hist_maxbuf[j] = toins;
242
243                                         break;
244                                 }
245                         }
246                 }
247
248                 /* if the minbuf should get this */
249                 if (toins < jb->hist_minbuf[JB_HISTORY_MAXBUF_SZ-1])  {
250
251                         /* insertion-sort it into the maxbuf */
252                         for (j=0;j<JB_HISTORY_MAXBUF_SZ;j++) {
253                                 /* found where it fits */
254                                 if (toins < jb->hist_minbuf[j]) {
255                                         /* move over */
256                                         memmove(jb->hist_minbuf+j+1,jb->hist_minbuf+j, (JB_HISTORY_MAXBUF_SZ-(j+1)) * sizeof(long));
257                                         /* insert */
258                                         jb->hist_minbuf[j] = toins;
259
260                                         break;
261                                 }
262                         }
263                 }
264
265                 if (0) { 
266                         int k;
267                         fprintf(stderr, "toins = %ld\n", toins);
268                         fprintf(stderr, "maxbuf =");
269                         for (k=0;k<JB_HISTORY_MAXBUF_SZ;k++) 
270                                 fprintf(stderr, "%ld ", jb->hist_maxbuf[k]);
271                         fprintf(stderr, "\nminbuf =");
272                         for (k=0;k<JB_HISTORY_MAXBUF_SZ;k++) 
273                                 fprintf(stderr, "%ld ", jb->hist_minbuf[k]);
274                         fprintf(stderr, "\n");
275                 }
276         }
277
278         jb->hist_maxbuf_valid = 1;
279 }
280
281 static void history_get(jitterbuf *jb) 
282 {
283         long max, min, jitter;
284         int index;
285         int count;
286
287         if (!jb->hist_maxbuf_valid) 
288                 history_calc_maxbuf(jb);
289
290         /* count is how many items in history we're examining */
291         count = (jb->hist_ptr < JB_HISTORY_SZ) ? jb->hist_ptr : JB_HISTORY_SZ;
292
293         /* index is the "n"ths highest/lowest that we'll look for */
294         index = count * JB_HISTORY_DROPPCT / 100;
295
296         /* sanity checks for index */
297         if (index > (JB_HISTORY_MAXBUF_SZ - 1)) 
298                 index = JB_HISTORY_MAXBUF_SZ - 1;
299
300
301         if (index < 0) {
302                 jb->info.min = 0;
303                 jb->info.jitter = 0;
304                 return;
305         }
306
307         max = jb->hist_maxbuf[index];
308         min = jb->hist_minbuf[index];
309
310         jitter = max - min;
311
312         /* these debug stmts compare the difference between looking at the absolute jitter, and the
313          * values we get by throwing away the outliers */
314         /*
315         fprintf(stderr, "[%d] min=%d, max=%d, jitter=%d\n", index, min, max, jitter);
316         fprintf(stderr, "[%d] min=%d, max=%d, jitter=%d\n", 0, jb->hist_minbuf[0], jb->hist_maxbuf[0], jb->hist_maxbuf[0]-jb->hist_minbuf[0]);
317         */
318
319         jb->info.min = min;
320         jb->info.jitter = jitter;
321 }
322
323 /* returns 1 if frame was inserted into head of queue, 0 otherwise */
324 static int queue_put(jitterbuf *jb, void *data, int type, long ms, long ts) 
325 {
326         jb_frame *frame;
327         jb_frame *p;
328         int head = 0;
329         long resync_ts = ts - jb->info.resync_offset;
330
331         frame = jb->free;
332         if (frame) {
333                 jb->free = frame->next;
334         } else {
335                 frame = malloc(sizeof(jb_frame));
336         }
337
338         if (!frame) {
339                 jb_err("cannot allocate frame\n");
340                 return 0;
341         }
342
343         jb->info.frames_cur++;
344
345         frame->data = data;
346         frame->ts = resync_ts;
347         frame->ms = ms;
348         frame->type = type;
349
350         /* 
351          * frames are a circular list, jb-frames points to to the lowest ts, 
352          * jb->frames->prev points to the highest ts
353          */
354
355         if (!jb->frames) {  /* queue is empty */
356                 jb->frames = frame;
357                 frame->next = frame;
358                 frame->prev = frame;
359                 head = 1;
360         } else if (resync_ts < jb->frames->ts) {
361                 frame->next = jb->frames;
362                 frame->prev = jb->frames->prev;
363
364                 frame->next->prev = frame;
365                 frame->prev->next = frame;
366
367                 /* frame is out of order */
368                 jb->info.frames_ooo++;
369
370                 jb->frames = frame;
371                 head = 1;
372         } else { 
373                 p = jb->frames;
374
375                 /* frame is out of order */
376                 if (resync_ts < p->prev->ts) jb->info.frames_ooo++;
377
378                 while (resync_ts < p->prev->ts && p->prev != jb->frames) 
379                         p = p->prev;
380
381                 frame->next = p;
382                 frame->prev = p->prev;
383
384                 frame->next->prev = frame;
385                 frame->prev->next = frame;
386         }
387         return head;
388 }
389
390 static long queue_next(jitterbuf *jb) 
391 {
392         if (jb->frames) 
393                 return jb->frames->ts;
394         else 
395                 return -1;
396 }
397
398 static long queue_last(jitterbuf *jb) 
399 {
400         if (jb->frames) 
401                 return jb->frames->prev->ts;
402         else 
403                 return -1;
404 }
405
406 static jb_frame *_queue_get(jitterbuf *jb, long ts, int all) 
407 {
408         jb_frame *frame;
409         frame = jb->frames;
410
411         if (!frame)
412                 return NULL;
413
414         /*jb_warn("queue_get: ASK %ld FIRST %ld\n", ts, frame->ts); */
415
416         if (all || ts >= frame->ts) {
417                 /* remove this frame */
418                 frame->prev->next = frame->next;
419                 frame->next->prev = frame->prev;
420
421                 if (frame->next == frame)
422                         jb->frames = NULL;
423                 else
424                         jb->frames = frame->next;
425
426
427                 /* insert onto "free" single-linked list */
428                 frame->next = jb->free;
429                 jb->free = frame;
430
431                 jb->info.frames_cur--;
432
433                 /* we return the frame pointer, even though it's on free list, 
434                  * but caller must copy data */
435                 return frame;
436         } 
437
438         return NULL;
439 }
440
441 static jb_frame *queue_get(jitterbuf *jb, long ts) 
442 {
443         return _queue_get(jb,ts,0);
444 }
445
446 static jb_frame *queue_getall(jitterbuf *jb) 
447 {
448         return _queue_get(jb,0,1);
449 }
450
451 #if 0
452 /* some diagnostics */
453 static void jb_dbginfo(jitterbuf *jb) 
454 {
455         if (dbgf == NULL) 
456                 return;
457
458         jb_dbg("\njb info: fin=%ld fout=%ld flate=%ld flost=%ld fdrop=%ld fcur=%ld\n",
459                 jb->info.frames_in, jb->info.frames_out, jb->info.frames_late, jb->info.frames_lost, jb->info.frames_dropped, jb->info.frames_cur);
460         
461         jb_dbg("jitter=%ld current=%ld target=%ld min=%ld sil=%d len=%d len/fcur=%ld\n",
462                 jb->info.jitter, jb->info.current, jb->info.target, jb->info.min, jb->info.silence_begin_ts, jb->info.current - jb->info.min, 
463                 jb->info.frames_cur ? (jb->info.current - jb->info.min)/jb->info.frames_cur : -8);
464         if (jb->info.frames_in > 0) 
465                 jb_dbg("jb info: Loss PCT = %ld%%, Late PCT = %ld%%\n",
466                         jb->info.frames_lost * 100/(jb->info.frames_in + jb->info.frames_lost), 
467                         jb->info.frames_late * 100/jb->info.frames_in);
468         jb_dbg("jb info: queue %d -> %d.  last_ts %d (queue len: %d) last_ms %d\n",
469                 queue_next(jb), 
470                 queue_last(jb),
471                 jb->info.next_voice_ts, 
472                 queue_last(jb) - queue_next(jb),
473                 jb->info.last_voice_ms);
474 }
475 #endif
476
477 #ifdef DEEP_DEBUG
478 static void jb_chkqueue(jitterbuf *jb) 
479 {
480         int i=0;
481         jb_frame *p = jb->frames;
482
483         if (!p) {
484                 return;
485         }
486
487         do {
488                 if (p->next == NULL)  {
489                         jb_err("Queue is BROKEN at item [%d]", i);      
490                 }
491                 i++;
492                 p=p->next;
493         } while (p->next != jb->frames);
494 }
495
496 static void jb_dbgqueue(jitterbuf *jb) 
497 {
498         int i=0;
499         jb_frame *p = jb->frames;
500
501         jb_dbg("queue: ");
502
503         if (!p) {
504                 jb_dbg("EMPTY\n");
505                 return;
506         }
507
508         do {
509                 jb_dbg("[%d]=%ld ", i++, p->ts);
510                 p=p->next;
511         } while (p->next != jb->frames);
512
513         jb_dbg("\n");
514 }
515 #endif
516
517 int jb_put(jitterbuf *jb, void *data, int type, long ms, long ts, long now) 
518 {
519         jb_dbg2("jb_put(%x,%x,%ld,%ld,%ld)\n", jb, data, ms, ts, now);
520
521         jb->info.frames_in++;
522
523         if (type == JB_TYPE_VOICE) {
524                 /* presently, I'm only adding VOICE frames to history and drift calculations; mostly because with the
525                  * IAX integrations, I'm sending retransmitted control frames with their awkward timestamps through */
526                 if (history_put(jb,ts,now,ms))
527                         return JB_DROP;
528         }
529
530         /* if put into head of queue, caller needs to reschedule */
531         if (queue_put(jb,data,type,ms,ts)) {
532                 return JB_SCHED;
533         }
534         return JB_OK;
535 }
536
537
538 static int _jb_get(jitterbuf *jb, jb_frame *frameout, long now, long interpl) 
539 {
540         jb_frame *frame;
541         long diff;
542         static int dbg_cnt = 0;
543
544         /*if ((now - jb_next(jb)) > 2 * jb->info.last_voice_ms) jb_warn("SCHED: %ld", (now - jb_next(jb))); */
545         /* get jitter info */
546         history_get(jb);
547
548         if (dbg_cnt && dbg_cnt % 50 == 0) {
549                 jb_dbg("\n");
550         }
551         dbg_cnt++;
552
553         /* target */
554         jb->info.target = jb->info.jitter + jb->info.min + JB_TARGET_EXTRA; 
555
556         /* if a hard clamp was requested, use it */
557         if ((jb->info.conf.max_jitterbuf) && ((jb->info.target - jb->info.min) > jb->info.conf.max_jitterbuf)) {
558                 jb_dbg("clamping target from %d to %d\n", (jb->info.target - jb->info.min), jb->info.conf.max_jitterbuf);
559                 jb->info.target = jb->info.min + jb->info.conf.max_jitterbuf;
560         }
561
562         diff = jb->info.target - jb->info.current;
563
564         /* jb_warn("diff = %d lms=%d last = %d now = %d\n", diff,  */
565         /*      jb->info.last_voice_ms, jb->info.last_adjustment, now); */
566
567         /* let's work on non-silent case first */
568         if (!jb->info.silence_begin_ts) { 
569                 /* we want to grow */
570                 if ((diff > 0) && 
571                         /* we haven't grown in the delay length */
572                         (((jb->info.last_adjustment + JB_ADJUST_DELAY) < now) || 
573                         /* we need to grow more than the "length" we have left */
574                         (diff > queue_last(jb)  - queue_next(jb)) ) ) {
575                         /* grow by interp frame length */
576                         jb->info.current += interpl;
577                         jb->info.next_voice_ts += interpl;
578                         jb->info.last_voice_ms = interpl;
579                         jb->info.last_adjustment = now;
580                         jb->info.cnt_contig_interp++;
581                         if (jb->info.conf.max_contig_interp && jb->info.cnt_contig_interp >= jb->info.conf.max_contig_interp) {
582                                 jb->info.silence_begin_ts = jb->info.next_voice_ts - jb->info.current;
583                         }
584                         jb_dbg("G");
585                         return JB_INTERP;
586                 }
587
588                 frame = queue_get(jb, jb->info.next_voice_ts - jb->info.current);
589
590                 /* not a voice frame; just return it. */
591                 if (frame && frame->type != JB_TYPE_VOICE) {
592                         if (frame->type == JB_TYPE_SILENCE) {
593                                 jb->info.silence_begin_ts = frame->ts;
594                                 jb->info.cnt_contig_interp = 0;
595                         }
596
597                         *frameout = *frame;
598                         jb->info.frames_out++;
599                         jb_dbg("o");
600                         return JB_OK;
601                 }
602
603
604                 /* voice frame is later than expected */
605                 if (frame && frame->ts + jb->info.current < jb->info.next_voice_ts) {
606                         if (frame->ts + jb->info.current > jb->info.next_voice_ts - jb->info.last_voice_ms) {
607                                 /* either we interpolated past this frame in the last jb_get */
608                                 /* or the frame is still in order, but came a little too quick */ 
609                                 *frameout = *frame;
610                                 /* reset expectation for next frame */
611                                 jb->info.next_voice_ts = frame->ts + jb->info.current + frame->ms;
612                                 jb->info.frames_out++;
613                                 decrement_losspct(jb);
614                                 jb->info.cnt_contig_interp = 0;
615                                 jb_dbg("v");
616                                 return JB_OK;
617                         } else {
618                                 /* voice frame is late */
619                                 *frameout = *frame;
620                                 jb->info.frames_out++;
621                                 decrement_losspct(jb);
622                                 jb->info.frames_late++;
623                                 jb->info.frames_lost--;
624                                 jb_dbg("l");
625                                 /*jb_warn("\nlate: wanted=%ld, this=%ld, next=%ld\n", jb->info.next_voice_ts - jb->info.current, frame->ts, queue_next(jb));
626                                 jb_warninfo(jb); */
627                                 return JB_DROP;
628                         }
629                 }
630
631                 /* keep track of frame sizes, to allow for variable sized-frames */
632                 if (frame && frame->ms > 0) {
633                         jb->info.last_voice_ms = frame->ms;
634                 }
635
636                 /* we want to shrink; shrink at 1 frame / 500ms */
637                 /* unless we don't have a frame, then shrink 1 frame */
638                 /* every 80ms (though perhaps we can shrink even faster */
639                 /* in this case) */
640                 if (diff < -JB_TARGET_EXTRA && 
641                         ((!frame && jb->info.last_adjustment + 80 < now) || 
642                         (jb->info.last_adjustment + 500 < now))) {
643
644                         jb->info.last_adjustment = now;
645                         jb->info.cnt_contig_interp = 0;
646
647                         if (frame) {
648                                 *frameout = *frame;
649                                 /* shrink by frame size we're throwing out */
650                                 jb->info.current -= frame->ms;
651                                 jb->info.frames_out++;
652                                 decrement_losspct(jb);
653                                 jb->info.frames_dropped++;
654                                 jb_dbg("s");
655                                 return JB_DROP;
656                         } else {
657                                 /* shrink by last_voice_ms */
658                                 jb->info.current -= jb->info.last_voice_ms;
659                                 jb->info.frames_lost++;
660                                 increment_losspct(jb);
661                                 jb_dbg("S");
662                                 return JB_NOFRAME;
663                         }
664                 }
665
666                 /* lost frame */
667                 if (!frame) {
668                         /* this is a bit of a hack for now, but if we're close to
669                          * target, and we find a missing frame, it makes sense to
670                          * grow, because the frame might just be a bit late;
671                          * otherwise, we presently get into a pattern where we return
672                          * INTERP for the lost frame, then it shows up next, and we
673                          * throw it away because it's late */
674                         /* I've recently only been able to replicate this using
675                          * iaxclient talking to app_echo on asterisk.  In this case,
676                          * my outgoing packets go through asterisk's (old)
677                          * jitterbuffer, and then might get an unusual increasing delay 
678                          * there if it decides to grow?? */
679                         /* Update: that might have been a different bug, that has been fixed..
680                          * But, this still seemed like a good idea, except that it ended up making a single actual
681                          * lost frame get interpolated two or more times, when there was "room" to grow, so it might
682                          * be a bit of a bad idea overall */
683                         /*if (diff > -1 * jb->info.last_voice_ms) { 
684                                 jb->info.current += jb->info.last_voice_ms;
685                                 jb->info.last_adjustment = now;
686                                 jb_warn("g");
687                                 return JB_INTERP;
688                         } */
689                         jb->info.frames_lost++;
690                         increment_losspct(jb);
691                         jb->info.next_voice_ts += interpl;
692                         jb->info.last_voice_ms = interpl;
693                         jb->info.cnt_contig_interp++;
694                         if (jb->info.conf.max_contig_interp && jb->info.cnt_contig_interp >= jb->info.conf.max_contig_interp) {
695                                 jb->info.silence_begin_ts = jb->info.next_voice_ts - jb->info.current;
696                         }
697                         jb_dbg("L");
698                         return JB_INTERP;
699                 }
700
701                 /* normal case; return the frame, increment stuff */
702                 *frameout = *frame;
703                 jb->info.next_voice_ts += frame->ms;
704                 jb->info.frames_out++;
705                 jb->info.cnt_contig_interp = 0;
706                 decrement_losspct(jb);
707                 jb_dbg("v");
708                 return JB_OK;
709         } else {     
710                 /* TODO: after we get the non-silent case down, we'll make the
711                  * silent case -- basically, we'll just grow and shrink faster
712                  * here, plus handle next_voice_ts a bit differently */
713       
714                 /* to disable silent special case altogether, just uncomment this: */
715                 /* jb->info.silence_begin_ts = 0; */
716
717                 /* shrink interpl len every 10ms during silence */
718                 if (diff < -JB_TARGET_EXTRA &&
719                         jb->info.last_adjustment + 10 <= now) {
720                         jb->info.current -= interpl;
721                         jb->info.last_adjustment = now;
722                 }
723
724                 frame = queue_get(jb, now - jb->info.current);
725                 if (!frame) {
726                         return JB_NOFRAME;
727                 } else if (frame->type != JB_TYPE_VOICE) {
728                         /* normal case; in silent mode, got a non-voice frame */
729                         *frameout = *frame;
730                         jb->info.frames_out++;
731                         return JB_OK;
732                 }
733                 if (frame->ts < jb->info.silence_begin_ts) {
734                         /* voice frame is late */
735                         *frameout = *frame;
736                         jb->info.frames_out++;
737                         decrement_losspct(jb);
738                         jb->info.frames_late++;
739                         jb->info.frames_lost--;
740                         jb_dbg("l");
741                         /*jb_warn("\nlate: wanted=%ld, this=%ld, next=%ld\n", jb->info.next_voice_ts - jb->info.current, frame->ts, queue_next(jb));
742                         jb_warninfo(jb); */
743                         return JB_DROP;
744                 } else {
745                         /* voice frame */
746                         /* try setting current to target right away here */
747                         jb->info.current = jb->info.target;
748                         jb->info.silence_begin_ts = 0;
749                         jb->info.next_voice_ts = frame->ts + jb->info.current + frame->ms;
750                         jb->info.last_voice_ms = frame->ms;
751                         jb->info.frames_out++;
752                         decrement_losspct(jb);
753                         *frameout = *frame;
754                         jb_dbg("V");
755                         return JB_OK;
756                 }
757         }
758 }
759
760 long jb_next(jitterbuf *jb) 
761 {
762         if (jb->info.silence_begin_ts) {
763                 long next = queue_next(jb);
764                 if (next > 0) { 
765                         history_get(jb);
766                         /* shrink during silence */
767                         if (jb->info.target - jb->info.current < -JB_TARGET_EXTRA)
768                                 return jb->info.last_adjustment + 10;
769                         return next + jb->info.target;
770                 }
771                 else 
772                         return JB_LONGMAX;
773         } else {
774                 return jb->info.next_voice_ts;
775         }
776 }
777
778 int jb_get(jitterbuf *jb, jb_frame *frameout, long now, long interpl) 
779 {
780         int ret = _jb_get(jb,frameout,now,interpl);
781 #if 0
782         static int lastts=0;
783         int thists = ((ret == JB_OK) || (ret == JB_DROP)) ? frameout->ts : 0;
784         jb_warn("jb_get(%x,%x,%ld) = %d (%d)\n", jb, frameout, now, ret, thists);
785         if (thists && thists < lastts) jb_warn("XXXX timestamp roll-back!!!\n");
786         lastts = thists;
787 #endif
788         if(ret == JB_INTERP) 
789                 frameout->ms = jb->info.last_voice_ms;
790         
791         return ret;
792 }
793
794 int jb_getall(jitterbuf *jb, jb_frame *frameout) 
795 {
796         jb_frame *frame;
797         frame = queue_getall(jb);
798
799         if (!frame) {
800                 return JB_NOFRAME;
801         }
802
803         *frameout = *frame;
804         return JB_OK;
805 }
806
807
808 int jb_getinfo(jitterbuf *jb, jb_info *stats) 
809 {
810
811         history_get(jb);
812
813         *stats = jb->info;
814
815         return JB_OK;
816 }
817
818 int jb_setconf(jitterbuf *jb, jb_conf *conf) 
819 {
820         /* take selected settings from the struct */
821
822         jb->info.conf.max_jitterbuf = conf->max_jitterbuf;
823         jb->info.conf.resync_threshold = conf->resync_threshold;
824         jb->info.conf.max_contig_interp = conf->max_contig_interp;
825
826         return JB_OK;
827 }
828
829