mirror of http://gerrit.asterisk.org/asterisk
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@5192 65c4cc65-6c06-0410-ace0-fbb531ad65f31.2-netsec
Mark Spencer
20 years ago
parent
6546acebfb
commit
7082d0584e
@ -0,0 +1,698 @@
|
||||
/*
|
||||
* jitterbuf: an application-independent jitterbuffer
|
||||
*
|
||||
* Copyrights:
|
||||
* Copyright (C) 2004-2005, Horizon Wimba, Inc.
|
||||
*
|
||||
* Contributors:
|
||||
* Steve Kann <stevek@stevek.com>
|
||||
*
|
||||
* This program is free software, distributed under the terms of
|
||||
* the GNU Lesser (Library) General Public License
|
||||
*
|
||||
* Copyright on this file is disclaimed to Digium for inclusion in Asterisk
|
||||
*/
|
||||
|
||||
#include "jitterbuf.h"
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
|
||||
/* define these here, just for ancient compiler systems */
|
||||
#define JB_LONGMAX 2147483647L
|
||||
#define JB_LONGMIN (-JB_LONGMAX - 1L)
|
||||
|
||||
#define jb_warn(...) (warnf ? warnf(__VA_ARGS__) : (void)0)
|
||||
#define jb_err(...) (errf ? errf(__VA_ARGS__) : (void)0)
|
||||
#define jb_dbg(...) (dbgf ? dbgf(__VA_ARGS__) : (void)0)
|
||||
|
||||
#ifdef DEEP_DEBUG
|
||||
#define jb_dbg2(...) (dbgf ? dbgf(__VA_ARGS__) : (void)0)
|
||||
#else
|
||||
#define jb_dbg2(...) ((void)0)
|
||||
#endif
|
||||
|
||||
static jb_output_function_t warnf, errf, dbgf;
|
||||
|
||||
void jb_setoutput(jb_output_function_t warn, jb_output_function_t err, jb_output_function_t dbg)
|
||||
{
|
||||
warnf = warn;
|
||||
errf = err;
|
||||
dbgf = dbg;
|
||||
}
|
||||
|
||||
static void increment_losspct(jitterbuf *jb)
|
||||
{
|
||||
jb->info.losspct = (100000 + 499 * jb->info.losspct)/500;
|
||||
}
|
||||
|
||||
static void decrement_losspct(jitterbuf *jb)
|
||||
{
|
||||
jb->info.losspct = (499 * jb->info.losspct)/500;
|
||||
}
|
||||
|
||||
|
||||
static void jb_dbginfo(jitterbuf *jb);
|
||||
|
||||
|
||||
void jb_reset(jitterbuf *jb)
|
||||
{
|
||||
memset(jb,0,sizeof(jitterbuf));
|
||||
|
||||
/* initialize length */
|
||||
jb->info.current = jb->info.target = 0;
|
||||
jb->info.silence = 1;
|
||||
}
|
||||
|
||||
jitterbuf * jb_new()
|
||||
{
|
||||
jitterbuf *jb;
|
||||
|
||||
|
||||
jb = malloc(sizeof(jitterbuf));
|
||||
if(!jb) return NULL;
|
||||
|
||||
jb_reset(jb);
|
||||
|
||||
jb_dbg2("jb_new() = %x\n", jb);
|
||||
return jb;
|
||||
}
|
||||
|
||||
void jb_destroy(jitterbuf *jb)
|
||||
{
|
||||
jb_frame *frame;
|
||||
jb_dbg2("jb_destroy(%x)\n", jb);
|
||||
|
||||
/* free all the frames on the "free list" */
|
||||
frame = jb->free;
|
||||
while(frame != NULL) {
|
||||
jb_frame *next = frame->next;
|
||||
free(frame);
|
||||
frame = next;
|
||||
}
|
||||
|
||||
/* free ourselves! */
|
||||
free(jb);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* simple history manipulation */
|
||||
/* maybe later we can make the history buckets variable size, or something? */
|
||||
/* drop parameter determines whether we will drop outliers to minimize
|
||||
* delay */
|
||||
static int longcmp(const void *a, const void *b)
|
||||
{
|
||||
return *(long *)a - *(long *)b;
|
||||
}
|
||||
|
||||
static void history_put(jitterbuf *jb, long ts, long now)
|
||||
{
|
||||
long delay = now - ts;
|
||||
long kicked;
|
||||
|
||||
/* don't add special/negative times to history */
|
||||
if(ts <= 0) return;
|
||||
|
||||
kicked = jb->history[jb->hist_ptr & JB_HISTORY_SZ];
|
||||
|
||||
jb->history[(jb->hist_ptr++) % JB_HISTORY_SZ] = delay;
|
||||
|
||||
/* optimization; the max/min buffers don't need to be recalculated, if this packet's
|
||||
* entry doesn't change them. This happens if this packet is not involved, _and_ any packet
|
||||
* that got kicked out of the history is also not involved
|
||||
* We do a number of comparisons, but it's probably still worthwhile, because it will usually
|
||||
* succeed, and should be a lot faster than going through all 500 packets in history */
|
||||
if(!jb->hist_maxbuf_valid)
|
||||
return;
|
||||
|
||||
/* don't do this until we've filled history
|
||||
* (reduces some edge cases below) */
|
||||
if(jb->hist_ptr < JB_HISTORY_SZ)
|
||||
goto invalidate;
|
||||
|
||||
/* if the new delay would go into min */
|
||||
if(delay < jb->hist_minbuf[JB_HISTORY_MAXBUF_SZ-1])
|
||||
goto invalidate;
|
||||
|
||||
/* or max.. */
|
||||
if(delay > jb->hist_maxbuf[JB_HISTORY_MAXBUF_SZ-1])
|
||||
goto invalidate;
|
||||
|
||||
/* or the kicked delay would be in min */
|
||||
if(kicked <= jb->hist_minbuf[JB_HISTORY_MAXBUF_SZ-1])
|
||||
goto invalidate;
|
||||
|
||||
if(kicked >= jb->hist_maxbuf[JB_HISTORY_MAXBUF_SZ-1])
|
||||
goto invalidate;
|
||||
|
||||
/* if we got here, we don't need to invalidate, 'cause this delay didn't
|
||||
* affect things */
|
||||
return;
|
||||
/* end optimization */
|
||||
|
||||
|
||||
invalidate:
|
||||
jb->hist_maxbuf_valid = 0;
|
||||
return;
|
||||
}
|
||||
|
||||
static void history_calc_maxbuf(jitterbuf *jb)
|
||||
{
|
||||
int i,j;
|
||||
|
||||
if(jb->hist_ptr == 0) return;
|
||||
|
||||
|
||||
/* initialize maxbuf/minbuf to the latest value */
|
||||
for(i=0;i<JB_HISTORY_MAXBUF_SZ;i++) {
|
||||
/*
|
||||
* jb->hist_maxbuf[i] = jb->history[(jb->hist_ptr-1) % JB_HISTORY_SZ];
|
||||
* jb->hist_minbuf[i] = jb->history[(jb->hist_ptr-1) % JB_HISTORY_SZ];
|
||||
*/
|
||||
jb->hist_maxbuf[i] = JB_LONGMIN;
|
||||
jb->hist_minbuf[i] = JB_LONGMAX;
|
||||
}
|
||||
|
||||
/* use insertion sort to populate maxbuf */
|
||||
/* we want it to be the top "n" values, in order */
|
||||
|
||||
/* start at the beginning, or JB_HISTORY_SZ frames ago */
|
||||
i = (jb->hist_ptr > JB_HISTORY_SZ) ? (jb->hist_ptr - JB_HISTORY_SZ) : 0;
|
||||
|
||||
for(;i<jb->hist_ptr;i++) {
|
||||
long toins = jb->history[i % JB_HISTORY_SZ];
|
||||
|
||||
/* if the maxbuf should get this */
|
||||
if(toins > jb->hist_maxbuf[JB_HISTORY_MAXBUF_SZ-1]) {
|
||||
|
||||
/* insertion-sort it into the maxbuf */
|
||||
for(j=0;j<JB_HISTORY_MAXBUF_SZ;j++) {
|
||||
/* found where it fits */
|
||||
if(toins > jb->hist_maxbuf[j]) {
|
||||
/* move over */
|
||||
memmove(jb->hist_maxbuf+j+1,jb->hist_maxbuf+j, (JB_HISTORY_MAXBUF_SZ-(j+1)) * sizeof(long));
|
||||
/* insert */
|
||||
jb->hist_maxbuf[j] = toins;
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/* if the minbuf should get this */
|
||||
if(toins < jb->hist_minbuf[JB_HISTORY_MAXBUF_SZ-1]) {
|
||||
|
||||
/* insertion-sort it into the maxbuf */
|
||||
for(j=0;j<JB_HISTORY_MAXBUF_SZ;j++) {
|
||||
/* found where it fits */
|
||||
if(toins < jb->hist_minbuf[j]) {
|
||||
/* move over */
|
||||
memmove(jb->hist_minbuf+j+1,jb->hist_minbuf+j, (JB_HISTORY_MAXBUF_SZ-(j+1)) * sizeof(long));
|
||||
/* insert */
|
||||
jb->hist_minbuf[j] = toins;
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if(0) {
|
||||
int k;
|
||||
fprintf(stderr, "toins = %ld\n", toins);
|
||||
fprintf(stderr, "maxbuf =");
|
||||
for(k=0;k<JB_HISTORY_MAXBUF_SZ;k++)
|
||||
fprintf(stderr, "%ld ", jb->hist_maxbuf[k]);
|
||||
fprintf(stderr, "\nminbuf =");
|
||||
for(k=0;k<JB_HISTORY_MAXBUF_SZ;k++)
|
||||
fprintf(stderr, "%ld ", jb->hist_minbuf[k]);
|
||||
fprintf(stderr, "\n");
|
||||
}
|
||||
}
|
||||
|
||||
jb->hist_maxbuf_valid = 1;
|
||||
}
|
||||
|
||||
static void history_get(jitterbuf *jb)
|
||||
{
|
||||
long max, min, jitter;
|
||||
int index;
|
||||
int count;
|
||||
|
||||
if(!jb->hist_maxbuf_valid)
|
||||
history_calc_maxbuf(jb);
|
||||
|
||||
/* count is how many items in history we're examining */
|
||||
count = (jb->hist_ptr < JB_HISTORY_SZ) ? jb->hist_ptr : JB_HISTORY_SZ;
|
||||
|
||||
/* index is the "n"ths highest/lowest that we'll look for */
|
||||
index = count * JB_HISTORY_DROPPCT / 100;
|
||||
|
||||
/* sanity checks for index */
|
||||
if(index > (JB_HISTORY_MAXBUF_SZ - 1)) index = JB_HISTORY_MAXBUF_SZ - 1;
|
||||
|
||||
|
||||
if(index < 0) {
|
||||
jb->info.min = 0;
|
||||
jb->info.jitter = 0;
|
||||
return;
|
||||
}
|
||||
|
||||
max = jb->hist_maxbuf[index];
|
||||
min = jb->hist_minbuf[index];
|
||||
|
||||
jitter = max - min;
|
||||
|
||||
/* these debug stmts compare the difference between looking at the absolute jitter, and the
|
||||
* values we get by throwing away the outliers */
|
||||
/*
|
||||
fprintf(stderr, "[%d] min=%d, max=%d, jitter=%d\n", index, min, max, jitter);
|
||||
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]);
|
||||
*/
|
||||
|
||||
jb->info.min = min;
|
||||
jb->info.jitter = jitter;
|
||||
}
|
||||
|
||||
static void queue_put(jitterbuf *jb, void *data, int type, long ms, long ts)
|
||||
{
|
||||
jb_frame *frame;
|
||||
jb_frame *p;
|
||||
|
||||
frame = jb->free;
|
||||
if(frame) {
|
||||
jb->free = frame->next;
|
||||
} else {
|
||||
frame = malloc(sizeof(jb_frame));
|
||||
}
|
||||
|
||||
if(!frame) {
|
||||
jb_err("cannot allocate frame\n");
|
||||
return;
|
||||
}
|
||||
|
||||
jb->info.frames_cur++;
|
||||
|
||||
frame->data = data;
|
||||
frame->ts = ts;
|
||||
frame->ms = ms;
|
||||
frame->type = type;
|
||||
|
||||
/*
|
||||
* frames are a circular list, jb-frames points to to the lowest ts,
|
||||
* jb->frames->prev points to the highest ts
|
||||
*/
|
||||
|
||||
if(!jb->frames) { /* queue is empty */
|
||||
jb->frames = frame;
|
||||
frame->next = frame;
|
||||
frame->prev = frame;
|
||||
} else if(ts < jb->frames->ts) {
|
||||
frame->next = jb->frames;
|
||||
frame->prev = jb->frames->prev;
|
||||
|
||||
frame->next->prev = frame;
|
||||
frame->prev->next = frame;
|
||||
|
||||
jb->frames = frame;
|
||||
} else {
|
||||
p = jb->frames;
|
||||
|
||||
/* frame is out of order */
|
||||
if(ts < p->prev->ts) jb->info.frames_ooo++;
|
||||
|
||||
while(ts < p->prev->ts && p->prev != jb->frames)
|
||||
p = p->prev;
|
||||
|
||||
frame->next = p;
|
||||
frame->prev = p->prev;
|
||||
|
||||
frame->next->prev = frame;
|
||||
frame->prev->next = frame;
|
||||
}
|
||||
}
|
||||
|
||||
static long queue_next(jitterbuf *jb)
|
||||
{
|
||||
if(jb->frames) return jb->frames->ts;
|
||||
else return -1;
|
||||
}
|
||||
|
||||
static long queue_last(jitterbuf *jb)
|
||||
{
|
||||
if(jb->frames) return jb->frames->prev->ts;
|
||||
else return -1;
|
||||
}
|
||||
|
||||
static jb_frame *_queue_get(jitterbuf *jb, long ts, int all)
|
||||
{
|
||||
jb_frame *frame;
|
||||
frame = jb->frames;
|
||||
|
||||
if(!frame)
|
||||
return NULL;
|
||||
|
||||
/*jb_warn("queue_get: ASK %ld FIRST %ld\n", ts, frame->ts); */
|
||||
|
||||
if(all || ts > frame->ts) {
|
||||
/* remove this frame */
|
||||
frame->prev->next = frame->next;
|
||||
frame->next->prev = frame->prev;
|
||||
|
||||
if(frame->next == frame)
|
||||
jb->frames = NULL;
|
||||
else
|
||||
jb->frames = frame->next;
|
||||
|
||||
|
||||
/* insert onto "free" single-linked list */
|
||||
frame->next = jb->free;
|
||||
jb->free = frame;
|
||||
|
||||
jb->info.frames_cur--;
|
||||
|
||||
/* we return the frame pointer, even though it's on free list,
|
||||
* but caller must copy data */
|
||||
return frame;
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
static jb_frame *queue_get(jitterbuf *jb, long ts)
|
||||
{
|
||||
return _queue_get(jb,ts,0);
|
||||
}
|
||||
|
||||
static jb_frame *queue_getall(jitterbuf *jb)
|
||||
{
|
||||
return _queue_get(jb,0,1);
|
||||
}
|
||||
|
||||
/* some diagnostics */
|
||||
static void jb_dbginfo(jitterbuf *jb)
|
||||
{
|
||||
if(dbgf == NULL) return;
|
||||
|
||||
jb_dbg("\njb info: fin=%ld fout=%ld flate=%ld flost=%ld fdrop=%ld fcur=%ld\n",
|
||||
jb->info.frames_in, jb->info.frames_out, jb->info.frames_late, jb->info.frames_lost, jb->info.frames_dropped, jb->info.frames_cur);
|
||||
|
||||
jb_dbg(" jitter=%ld current=%ld target=%ld min=%ld sil=%d len=%d len/fcur=%ld\n",
|
||||
jb->info.jitter, jb->info.current, jb->info.target, jb->info.min, jb->info.silence, jb->info.current - jb->info.min,
|
||||
jb->info.frames_cur ? (jb->info.current - jb->info.min)/jb->info.frames_cur : -8);
|
||||
if(jb->info.frames_in > 0)
|
||||
jb_dbg("jb info: Loss PCT = %ld%%, Late PCT = %ld%%\n",
|
||||
jb->info.frames_lost * 100/(jb->info.frames_in + jb->info.frames_lost),
|
||||
jb->info.frames_late * 100/jb->info.frames_in);
|
||||
jb_dbg("jb info: queue %d -> %d. last_ts %d (queue len: %d) last_ms %d\n",
|
||||
queue_next(jb),
|
||||
queue_last(jb),
|
||||
jb->info.last_voice_ts,
|
||||
queue_last(jb) - queue_next(jb),
|
||||
jb->info.last_voice_ms);
|
||||
}
|
||||
|
||||
#ifdef DEEP_DEBUG
|
||||
static void jb_chkqueue(jitterbuf *jb)
|
||||
{
|
||||
int i=0;
|
||||
jb_frame *p = jb->frames;
|
||||
|
||||
if(!p) {
|
||||
return;
|
||||
}
|
||||
|
||||
do {
|
||||
if(p->next == NULL) {
|
||||
jb_err("Queue is BROKEN at item [%d]", i);
|
||||
}
|
||||
i++;
|
||||
p=p->next;
|
||||
} while (p->next != jb->frames);
|
||||
}
|
||||
|
||||
static void jb_dbgqueue(jitterbuf *jb)
|
||||
{
|
||||
int i=0;
|
||||
jb_frame *p = jb->frames;
|
||||
|
||||
jb_dbg("queue: ");
|
||||
|
||||
if(!p) {
|
||||
jb_dbg("EMPTY\n");
|
||||
return;
|
||||
}
|
||||
|
||||
do {
|
||||
jb_dbg("[%d]=%ld ", i++, p->ts);
|
||||
p=p->next;
|
||||
} while (p->next != jb->frames);
|
||||
|
||||
jb_dbg("\n");
|
||||
}
|
||||
#endif
|
||||
|
||||
int jb_put(jitterbuf *jb, void *data, int type, long ms, long ts, long now)
|
||||
{
|
||||
jb_dbg2("jb_put(%x,%x,%ld,%ld,%ld)\n", jb, data, ms, ts, now);
|
||||
|
||||
jb->info.frames_in++;
|
||||
|
||||
if(type == JB_TYPE_VOICE) {
|
||||
/* presently, I'm only adding VOICE frames to history and drift calculations; mostly because with the
|
||||
* IAX integrations, I'm sending retransmitted control frames with their awkward timestamps through */
|
||||
history_put(jb,ts,now);
|
||||
}
|
||||
|
||||
queue_put(jb,data,type,ms,ts);
|
||||
|
||||
return JB_OK;
|
||||
}
|
||||
|
||||
|
||||
static int _jb_get(jitterbuf *jb, jb_frame *frameout, long now)
|
||||
{
|
||||
jb_frame *frame;
|
||||
long diff;
|
||||
|
||||
/*if((now - jb_next(jb)) > 2 * jb->info.last_voice_ms) jb_warn("SCHED: %ld", (now - jb_next(jb))); */
|
||||
/* get jitter info */
|
||||
history_get(jb);
|
||||
|
||||
|
||||
/* target */
|
||||
jb->info.target = jb->info.jitter + jb->info.min + 2 * jb->info.last_voice_ms;
|
||||
|
||||
/* if a hard clamp was requested, use it */
|
||||
if((jb->info.max_jitterbuf) && ((jb->info.target - jb->info.min) > jb->info.max_jitterbuf)) {
|
||||
jb_dbg("clamping target from %d to %d\n", (jb->info.target - jb->info.min), jb->info.max_jitterbuf);
|
||||
jb->info.target = jb->info.min + jb->info.max_jitterbuf;
|
||||
}
|
||||
|
||||
diff = jb->info.target - jb->info.current;
|
||||
|
||||
/* jb_warn("diff = %d lms=%d last = %d now = %d\n", diff, */
|
||||
/* jb->info.last_voice_ms, jb->info.last_adjustment, now); */
|
||||
|
||||
/* move up last_voice_ts; it is now the expected voice ts */
|
||||
jb->info.last_voice_ts += jb->info.last_voice_ms;
|
||||
|
||||
/* let's work on non-silent case first */
|
||||
if(!jb->info.silence) {
|
||||
/* we want to grow */
|
||||
if( (diff > 0) &&
|
||||
/* we haven't grown in 2 frames' length */
|
||||
(((jb->info.last_adjustment + 2 * jb->info.last_voice_ms ) < now) ||
|
||||
/* we need to grow more than the "length" we have left */
|
||||
(diff > queue_last(jb) - queue_next(jb)) ) ) {
|
||||
jb->info.current += jb->info.last_voice_ms;
|
||||
jb->info.last_adjustment = now;
|
||||
jb_dbg("G");
|
||||
return JB_INTERP;
|
||||
}
|
||||
|
||||
frame = queue_get(jb, jb->info.last_voice_ts - jb->info.current);
|
||||
|
||||
/* not a voice frame; just return it. */
|
||||
if(frame && frame->type != JB_TYPE_VOICE) {
|
||||
/* rewind last_voice_ts, since this isn't voice */
|
||||
jb->info.last_voice_ts -= jb->info.last_voice_ms;
|
||||
|
||||
if(frame->type == JB_TYPE_SILENCE)
|
||||
jb->info.silence = 1;
|
||||
|
||||
*frameout = *frame;
|
||||
jb->info.frames_out++;
|
||||
jb_dbg("o");
|
||||
return JB_OK;
|
||||
}
|
||||
|
||||
|
||||
/* voice frame is late */
|
||||
if(frame && frame->ts + jb->info.current < jb->info.last_voice_ts - jb->info.last_voice_ms ) {
|
||||
*frameout = *frame;
|
||||
/* rewind last_voice, since we're just dumping */
|
||||
jb->info.last_voice_ts -= jb->info.last_voice_ms;
|
||||
jb->info.frames_out++;
|
||||
decrement_losspct(jb);
|
||||
jb->info.frames_late++;
|
||||
jb->info.frames_lost--;
|
||||
jb_dbg("l");
|
||||
/*jb_warn("\nlate: wanted=%ld, this=%ld, next=%ld\n", jb->info.last_voice_ts - jb->info.current, frame->ts, queue_next(jb));
|
||||
jb_warninfo(jb); */
|
||||
return JB_DROP;
|
||||
}
|
||||
|
||||
/* keep track of frame sizes, to allow for variable sized-frames */
|
||||
if(frame && frame->ms > 0) {
|
||||
jb->info.last_voice_ms = frame->ms;
|
||||
}
|
||||
|
||||
/* we want to shrink; shrink at 1 frame / 500ms */
|
||||
if(diff < -2 * jb->info.last_voice_ms &&
|
||||
((!frame && jb->info.last_adjustment + 80 < now) ||
|
||||
(jb->info.last_adjustment + 500 < now))) {
|
||||
|
||||
/* don't increment last_ts ?? */
|
||||
jb->info.last_voice_ts -= jb->info.last_voice_ms;
|
||||
jb->info.current -= jb->info.last_voice_ms;
|
||||
jb->info.last_adjustment = now;
|
||||
|
||||
if(frame) {
|
||||
*frameout = *frame;
|
||||
jb->info.frames_out++;
|
||||
decrement_losspct(jb);
|
||||
jb->info.frames_dropped++;
|
||||
jb_dbg("s");
|
||||
return JB_DROP;
|
||||
} else {
|
||||
increment_losspct(jb);
|
||||
jb_dbg("S");
|
||||
return JB_NOFRAME;
|
||||
}
|
||||
}
|
||||
|
||||
/* lost frame */
|
||||
if(!frame) {
|
||||
/* this is a bit of a hack for now, but if we're close to
|
||||
* target, and we find a missing frame, it makes sense to
|
||||
* grow, because the frame might just be a bit late;
|
||||
* otherwise, we presently get into a pattern where we return
|
||||
* INTERP for the lost frame, then it shows up next, and we
|
||||
* throw it away because it's late */
|
||||
/* I've recently only been able to replicate this using
|
||||
* iaxclient talking to app_echo on asterisk. In this case,
|
||||
* my outgoing packets go through asterisk's (old)
|
||||
* jitterbuffer, and then might get an unusual increasing delay
|
||||
* there if it decides to grow?? */
|
||||
/* Update: that might have been a different bug, that has been fixed..
|
||||
* But, this still seemed like a good idea, except that it ended up making a single actual
|
||||
* lost frame get interpolated two or more times, when there was "room" to grow, so it might
|
||||
* be a bit of a bad idea overall */
|
||||
/*if(diff > -1 * jb->info.last_voice_ms) {
|
||||
jb->info.current += jb->info.last_voice_ms;
|
||||
jb->info.last_adjustment = now;
|
||||
jb_warn("g");
|
||||
return JB_INTERP;
|
||||
} */
|
||||
jb->info.frames_lost++;
|
||||
increment_losspct(jb);
|
||||
jb_dbg("L");
|
||||
return JB_INTERP;
|
||||
}
|
||||
|
||||
/* normal case; return the frame, increment stuff */
|
||||
*frameout = *frame;
|
||||
jb->info.frames_out++;
|
||||
decrement_losspct(jb);
|
||||
jb_dbg("v");
|
||||
return JB_OK;
|
||||
} else {
|
||||
/* TODO: after we get the non-silent case down, we'll make the
|
||||
* silent case -- basically, we'll just grow and shrink faster
|
||||
* here, plus handle last_voice_ts a bit differently */
|
||||
|
||||
/* to disable silent special case altogether, just uncomment this: */
|
||||
/* jb->info.silence = 0; */
|
||||
|
||||
frame = queue_get(jb, now - jb->info.current);
|
||||
if(!frame) {
|
||||
return JB_NOFRAME;
|
||||
}
|
||||
if(frame && frame->type == JB_TYPE_VOICE) {
|
||||
/* try setting current to target right away here */
|
||||
jb->info.current = jb->info.target;
|
||||
jb->info.silence = 0;
|
||||
jb->info.last_voice_ts = frame->ts + jb->info.current + frame->ms;
|
||||
jb->info.last_voice_ms = frame->ms;
|
||||
*frameout = *frame;
|
||||
jb_dbg("V");
|
||||
return JB_OK;
|
||||
}
|
||||
/* normal case; in silent mode, got a non-voice frame */
|
||||
*frameout = *frame;
|
||||
return JB_OK;
|
||||
}
|
||||
}
|
||||
|
||||
long jb_next(jitterbuf *jb)
|
||||
{
|
||||
if(jb->info.silence) {
|
||||
long next = queue_next(jb);
|
||||
if(next > 0) {
|
||||
history_get(jb);
|
||||
return next + jb->info.target;
|
||||
}
|
||||
else return JB_LONGMAX;
|
||||
} else {
|
||||
return jb->info.last_voice_ts + jb->info.last_voice_ms;
|
||||
}
|
||||
}
|
||||
|
||||
int jb_get(jitterbuf *jb, jb_frame *frameout, long now)
|
||||
{
|
||||
int ret = _jb_get(jb,frameout,now);
|
||||
#if 0
|
||||
static int lastts=0;
|
||||
int thists = ((ret == JB_OK) || (ret == JB_DROP)) ? frameout->ts : 0;
|
||||
jb_warn("jb_get(%x,%x,%ld) = %d (%d)\n", jb, frameout, now, ret, thists);
|
||||
if(thists && thists < lastts) jb_warn("XXXX timestamp roll-back!!!\n");
|
||||
lastts = thists;
|
||||
#endif
|
||||
return ret;
|
||||
}
|
||||
|
||||
int jb_getall(jitterbuf *jb, jb_frame *frameout)
|
||||
{
|
||||
jb_frame *frame;
|
||||
frame = queue_getall(jb);
|
||||
|
||||
if(!frame) {
|
||||
return JB_NOFRAME;
|
||||
}
|
||||
|
||||
*frameout = *frame;
|
||||
return JB_OK;
|
||||
}
|
||||
|
||||
|
||||
int jb_getinfo(jitterbuf *jb, jb_info *stats)
|
||||
{
|
||||
|
||||
history_get(jb);
|
||||
|
||||
*stats = jb->info;
|
||||
|
||||
return JB_OK;
|
||||
}
|
||||
|
||||
int jb_setinfo(jitterbuf *jb, jb_info *settings)
|
||||
{
|
||||
/* take selected settings from the struct */
|
||||
|
||||
jb->info.max_jitterbuf = settings->max_jitterbuf;
|
||||
|
||||
return JB_OK;
|
||||
}
|
||||
|
||||
|
||||
@ -0,0 +1,140 @@
|
||||
/*
|
||||
* jitterbuf: an application-independent jitterbuffer
|
||||
*
|
||||
* Copyrights:
|
||||
* Copyright (C) 2004-2005, Horizon Wimba, Inc.
|
||||
*
|
||||
* Contributors:
|
||||
* Steve Kann <stevek@stevek.com>
|
||||
*
|
||||
* This program is free software, distributed under the terms of
|
||||
* the GNU Lesser (Library) General Public License
|
||||
*
|
||||
* Copyright on this file is disclaimed to Digium for inclusion in Asterisk
|
||||
*/
|
||||
|
||||
#ifndef _JITTERBUF_H_
|
||||
#define _JITTERBUF_H_
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/* configuration constants */
|
||||
/* Number of historical timestamps to use in calculating jitter and drift */
|
||||
#define JB_HISTORY_SZ 500
|
||||
/* what percentage of timestamps should we drop from the history when we examine it;
|
||||
* this might eventually be something made configurable */
|
||||
#define JB_HISTORY_DROPPCT 3
|
||||
/* the maximum droppct we can handle (say it was configurable). */
|
||||
#define JB_HISTORY_DROPPCT_MAX 4
|
||||
/* the size of the buffer we use to keep the top and botton timestamps for dropping */
|
||||
#define JB_HISTORY_MAXBUF_SZ JB_HISTORY_SZ * JB_HISTORY_DROPPCT_MAX / 100
|
||||
|
||||
|
||||
/* return codes */
|
||||
#define JB_OK 0
|
||||
#define JB_EMPTY 1
|
||||
#define JB_NOFRAME 2
|
||||
#define JB_INTERP 3
|
||||
#define JB_DROP 4
|
||||
|
||||
/* frame types */
|
||||
#define JB_TYPE_CONTROL 0
|
||||
#define JB_TYPE_VOICE 1
|
||||
#define JB_TYPE_VIDEO 2 /* reserved */
|
||||
#define JB_TYPE_SILENCE 3
|
||||
|
||||
typedef struct jb_info {
|
||||
/* statistics */
|
||||
long frames_in; /* number of frames input to the jitterbuffer.*/
|
||||
long frames_out; /* number of frames output from the jitterbuffer.*/
|
||||
long frames_late; /* number of frames which were too late, and dropped.*/
|
||||
long frames_lost; /* number of missing frames.*/
|
||||
long frames_dropped; /* number of frames dropped (shrinkage) */
|
||||
long frames_ooo; /* number of frames received out-of-order */
|
||||
long frames_cur; /* number of frames presently in jb, awaiting delivery.*/
|
||||
long jitter; /* jitter measured within current history interval*/
|
||||
long min; /* minimum lateness within current history interval */
|
||||
long current; /* the present jitterbuffer adjustment */
|
||||
long target; /* the target jitterbuffer adjustment */
|
||||
long losspct; /* recent lost frame percentage (* 1000) */
|
||||
long last_voice_ts; /* the last ts that was read from the jb - in receiver's time */
|
||||
long last_voice_ms; /* the duration of the last voice frame */
|
||||
long silence; /* we are presently playing out silence */
|
||||
long last_adjustment; /* the time of the last adjustment */
|
||||
|
||||
/* settings */
|
||||
long max_jitterbuf; /* defines a hard clamp to use in setting the jitter buffer delay */
|
||||
} jb_info;
|
||||
|
||||
typedef struct jb_frame {
|
||||
void *data; /* the frame data */
|
||||
long ts; /* the relative delivery time expected */
|
||||
long ms; /* the time covered by this frame, in sec/8000 */
|
||||
int type; /* the type of frame */
|
||||
struct jb_frame *next, *prev;
|
||||
} jb_frame;
|
||||
|
||||
typedef struct jitterbuf {
|
||||
jb_info info;
|
||||
|
||||
/* history */
|
||||
long history[JB_HISTORY_SZ]; /* history */
|
||||
int hist_ptr; /* points to index in history for next entry */
|
||||
long hist_maxbuf[JB_HISTORY_MAXBUF_SZ]; /* a sorted buffer of the max delays (highest first) */
|
||||
long hist_minbuf[JB_HISTORY_MAXBUF_SZ]; /* a sorted buffer of the min delays (lowest first) */
|
||||
int hist_maxbuf_valid; /* are the "maxbuf"/minbuf valid? */
|
||||
|
||||
|
||||
jb_frame *frames; /* queued frames */
|
||||
jb_frame *free; /* free frames (avoid malloc?) */
|
||||
} jitterbuf;
|
||||
|
||||
|
||||
/* new jitterbuf */
|
||||
jitterbuf * jb_new(void);
|
||||
|
||||
/* destroy jitterbuf */
|
||||
void jb_destroy(jitterbuf *jb);
|
||||
|
||||
/* reset jitterbuf */
|
||||
/* NOTE: The jitterbuffer should be empty before you call this, otherwise
|
||||
* you will leak queued frames, and some internal structures */
|
||||
void jb_reset(jitterbuf *jb);
|
||||
|
||||
/* queue a frame data=frame data, timings (in ms): ms=length of frame (for voice), ts=ts (sender's time)
|
||||
* now=now (in receiver's time)*/
|
||||
int jb_put(jitterbuf *jb, void *data, int type, long ms, long ts, long now);
|
||||
|
||||
/* get a frame for time now (receiver's time) return value is one of
|
||||
* JB_OK: You've got frame!
|
||||
* JB_DROP: Here's an audio frame you should just drop. Ask me again for this time..
|
||||
* JB_NOFRAME: There's no frame scheduled for this time.
|
||||
* JB_INTERP: Please interpolate an audio frame for this time (either we need to grow, or there was a lost frame
|
||||
* JB_EMPTY: The jb is empty.
|
||||
*/
|
||||
int jb_get(jitterbuf *jb, jb_frame *frame, long now);
|
||||
|
||||
/* unconditionally get frames from jitterbuf until empty */
|
||||
int jb_getall(jitterbuf *jb, jb_frame *frameout);
|
||||
|
||||
/* when is the next frame due out, in receiver's time (0=EMPTY)
|
||||
* This value may change as frames are added (esp non-audio frames) */
|
||||
long jb_next(jitterbuf *jb);
|
||||
|
||||
/* get jitterbuf info: only "statistics" may be valid */
|
||||
int jb_getinfo(jitterbuf *jb, jb_info *stats);
|
||||
|
||||
/* set jitterbuf info: only "settings" may be honored */
|
||||
int jb_setinfo(jitterbuf *jb, jb_info *settings);
|
||||
|
||||
typedef void (*jb_output_function_t)(const char *fmt, ...);
|
||||
void jb_setoutput(jb_output_function_t warn, jb_output_function_t err, jb_output_function_t dbg);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
|
||||
#endif
|
||||
@ -0,0 +1,251 @@
|
||||
/*
|
||||
* SpanDSP - a series of DSP components for telephony
|
||||
*
|
||||
* plc.c
|
||||
*
|
||||
* Written by Steve Underwood <steveu@coppice.org>
|
||||
*
|
||||
* Copyright (C) 2004 Steve Underwood
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
||||
*
|
||||
* This version may be optionally licenced under the GNU LGPL licence.
|
||||
* This version is disclaimed to DIGIUM for inclusion in the Asterisk project.
|
||||
*/
|
||||
|
||||
/*! \file */
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <math.h>
|
||||
#include <limits.h>
|
||||
|
||||
#include <asterisk/plc.h>
|
||||
|
||||
#if !defined(FALSE)
|
||||
#define FALSE 0
|
||||
#endif
|
||||
#if !defined(TRUE)
|
||||
#define TRUE (!FALSE)
|
||||
#endif
|
||||
|
||||
/* We do a straight line fade to zero volume in 50ms when we are filling in for missing data. */
|
||||
#define ATTENUATION_INCREMENT 0.0025 /* Attenuation per sample */
|
||||
|
||||
#define ms_to_samples(t) (((t)*SAMPLE_RATE)/1000)
|
||||
|
||||
static inline int16_t fsaturate(double damp)
|
||||
{
|
||||
if (damp > 32767.0)
|
||||
return INT16_MAX;
|
||||
if (damp < -32768.0)
|
||||
return INT16_MIN;
|
||||
return (int16_t) rint(damp);
|
||||
}
|
||||
|
||||
static void save_history(plc_state_t *s, int16_t *buf, int len)
|
||||
{
|
||||
if (len >= PLC_HISTORY_LEN)
|
||||
{
|
||||
/* Just keep the last part of the new data, starting at the beginning of the buffer */
|
||||
memcpy(s->history, buf + len - PLC_HISTORY_LEN, sizeof(int16_t)*PLC_HISTORY_LEN);
|
||||
s->buf_ptr = 0;
|
||||
return;
|
||||
}
|
||||
if (s->buf_ptr + len > PLC_HISTORY_LEN)
|
||||
{
|
||||
/* Wraps around - must break into two sections */
|
||||
memcpy(s->history + s->buf_ptr, buf, sizeof(int16_t)*(PLC_HISTORY_LEN - s->buf_ptr));
|
||||
len -= (PLC_HISTORY_LEN - s->buf_ptr);
|
||||
memcpy(s->history, buf + (PLC_HISTORY_LEN - s->buf_ptr), sizeof(int16_t)*len);
|
||||
s->buf_ptr = len;
|
||||
return;
|
||||
}
|
||||
/* Can use just one section */
|
||||
memcpy(s->history + s->buf_ptr, buf, sizeof(int16_t)*len);
|
||||
s->buf_ptr += len;
|
||||
}
|
||||
/*- End of function --------------------------------------------------------*/
|
||||
|
||||
static void normalise_history(plc_state_t *s)
|
||||
{
|
||||
int16_t tmp[PLC_HISTORY_LEN];
|
||||
|
||||
if (s->buf_ptr == 0)
|
||||
return;
|
||||
memcpy(tmp, s->history, sizeof(int16_t)*s->buf_ptr);
|
||||
memcpy(s->history, s->history + s->buf_ptr, sizeof(int16_t)*(PLC_HISTORY_LEN - s->buf_ptr));
|
||||
memcpy(s->history + PLC_HISTORY_LEN - s->buf_ptr, tmp, sizeof(int16_t)*s->buf_ptr);
|
||||
s->buf_ptr = 0;
|
||||
}
|
||||
/*- End of function --------------------------------------------------------*/
|
||||
|
||||
static int __inline__ amdf_pitch(int min_pitch, int max_pitch, int16_t amp[], int len)
|
||||
{
|
||||
int i;
|
||||
int j;
|
||||
int acc;
|
||||
int min_acc;
|
||||
int pitch;
|
||||
|
||||
pitch = min_pitch;
|
||||
min_acc = INT_MAX;
|
||||
for (i = max_pitch; i <= min_pitch; i++)
|
||||
{
|
||||
acc = 0;
|
||||
for (j = 0; j < len; j++)
|
||||
acc += abs(amp[i + j] - amp[j]);
|
||||
if (acc < min_acc)
|
||||
{
|
||||
min_acc = acc;
|
||||
pitch = i;
|
||||
}
|
||||
}
|
||||
return pitch;
|
||||
}
|
||||
/*- End of function --------------------------------------------------------*/
|
||||
|
||||
int plc_rx(plc_state_t *s, int16_t amp[], int len)
|
||||
{
|
||||
int i;
|
||||
int overlap_len;
|
||||
int pitch_overlap;
|
||||
float old_step;
|
||||
float new_step;
|
||||
float old_weight;
|
||||
float new_weight;
|
||||
float gain;
|
||||
|
||||
if (s->missing_samples)
|
||||
{
|
||||
/* Although we have a real signal, we need to smooth it to fit well
|
||||
with the synthetic signal we used for the previous block */
|
||||
|
||||
/* The start of the real data is overlapped with the next 1/4 cycle
|
||||
of the synthetic data. */
|
||||
pitch_overlap = s->pitch >> 2;
|
||||
if (pitch_overlap > len)
|
||||
pitch_overlap = len;
|
||||
gain = 1.0 - s->missing_samples*ATTENUATION_INCREMENT;
|
||||
if (gain < 0.0)
|
||||
gain = 0.0;
|
||||
new_step = 1.0/pitch_overlap;
|
||||
old_step = new_step*gain;
|
||||
new_weight = new_step;
|
||||
old_weight = (1.0 - new_step)*gain;
|
||||
for (i = 0; i < pitch_overlap; i++)
|
||||
{
|
||||
amp[i] = fsaturate(old_weight*s->pitchbuf[s->pitch_offset] + new_weight*amp[i]);
|
||||
if (++s->pitch_offset >= s->pitch)
|
||||
s->pitch_offset = 0;
|
||||
new_weight += new_step;
|
||||
old_weight -= old_step;
|
||||
if (old_weight < 0.0)
|
||||
old_weight = 0.0;
|
||||
}
|
||||
s->missing_samples = 0;
|
||||
}
|
||||
save_history(s, amp, len);
|
||||
return len;
|
||||
}
|
||||
/*- End of function --------------------------------------------------------*/
|
||||
|
||||
int plc_fillin(plc_state_t *s, int16_t amp[], int len)
|
||||
{
|
||||
int16_t tmp[PLC_PITCH_OVERLAP_MAX];
|
||||
int i;
|
||||
int pitch_overlap;
|
||||
float old_step;
|
||||
float new_step;
|
||||
float old_weight;
|
||||
float new_weight;
|
||||
float gain;
|
||||
int16_t *orig_amp;
|
||||
int orig_len;
|
||||
|
||||
orig_amp = amp;
|
||||
orig_len = len;
|
||||
if (s->missing_samples == 0)
|
||||
{
|
||||
/* As the gap in real speech starts we need to assess the last known pitch,
|
||||
and prepare the synthetic data we will use for fill-in */
|
||||
normalise_history(s);
|
||||
s->pitch = amdf_pitch(PLC_PITCH_MIN, PLC_PITCH_MAX, s->history + PLC_HISTORY_LEN - CORRELATION_SPAN - PLC_PITCH_MIN, CORRELATION_SPAN);
|
||||
/* We overlap a 1/4 wavelength */
|
||||
pitch_overlap = s->pitch >> 2;
|
||||
/* Cook up a single cycle of pitch, using a single of the real signal with 1/4
|
||||
cycle OLA'ed to make the ends join up nicely */
|
||||
/* The first 3/4 of the cycle is a simple copy */
|
||||
for (i = 0; i < s->pitch - pitch_overlap; i++)
|
||||
s->pitchbuf[i] = s->history[PLC_HISTORY_LEN - s->pitch + i];
|
||||
/* The last 1/4 of the cycle is overlapped with the end of the previous cycle */
|
||||
new_step = 1.0/pitch_overlap;
|
||||
new_weight = new_step;
|
||||
for ( ; i < s->pitch; i++)
|
||||
{
|
||||
s->pitchbuf[i] = s->history[PLC_HISTORY_LEN - s->pitch + i]*(1.0 - new_weight) + s->history[PLC_HISTORY_LEN - 2*s->pitch + i]*new_weight;
|
||||
new_weight += new_step;
|
||||
}
|
||||
/* We should now be ready to fill in the gap with repeated, decaying cycles
|
||||
of what is in pitchbuf */
|
||||
|
||||
/* We need to OLA the first 1/4 wavelength of the synthetic data, to smooth
|
||||
it into the previous real data. To avoid the need to introduce a delay
|
||||
in the stream, reverse the last 1/4 wavelength, and OLA with that. */
|
||||
gain = 1.0;
|
||||
new_step = 1.0/pitch_overlap;
|
||||
old_step = new_step;
|
||||
new_weight = new_step;
|
||||
old_weight = 1.0 - new_step;
|
||||
for (i = 0; i < pitch_overlap; i++)
|
||||
{
|
||||
amp[i] = fsaturate(old_weight*s->history[PLC_HISTORY_LEN - 1 - i] + new_weight*s->pitchbuf[i]);
|
||||
new_weight += new_step;
|
||||
old_weight -= old_step;
|
||||
if (old_weight < 0.0)
|
||||
old_weight = 0.0;
|
||||
}
|
||||
s->pitch_offset = i;
|
||||
}
|
||||
else
|
||||
{
|
||||
gain = 1.0 - s->missing_samples*ATTENUATION_INCREMENT;
|
||||
i = 0;
|
||||
}
|
||||
for ( ; gain > 0.0 && i < len; i++)
|
||||
{
|
||||
amp[i] = s->pitchbuf[s->pitch_offset]*gain;
|
||||
gain -= ATTENUATION_INCREMENT;
|
||||
if (++s->pitch_offset >= s->pitch)
|
||||
s->pitch_offset = 0;
|
||||
}
|
||||
for ( ; i < len; i++)
|
||||
amp[i] = 0;
|
||||
s->missing_samples += orig_len;
|
||||
save_history(s, amp, len);
|
||||
return len;
|
||||
}
|
||||
/*- End of function --------------------------------------------------------*/
|
||||
|
||||
plc_state_t *plc_init(plc_state_t *s)
|
||||
{
|
||||
memset(s, 0, sizeof(*s));
|
||||
return s;
|
||||
}
|
||||
/*- End of function --------------------------------------------------------*/
|
||||
/*- End of file ------------------------------------------------------------*/
|
||||
Loading…
Reference in new issue