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