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