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