git migration: Refactor the ASTERISK_FILE_VERSION macro
[asterisk/asterisk.git] / main / abstract_jb.c
index 4cd5ccb..c703c68 100644 (file)
  *
  */
 
+/*** MODULEINFO
+       <support_level>core</support_level>
+ ***/
+
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+ASTERISK_REGISTER_FILE()
 
 #include "asterisk/frame.h"
 #include "asterisk/channel.h"
 #include "asterisk/term.h"
 #include "asterisk/utils.h"
+#include "asterisk/pbx.h"
+#include "asterisk/timing.h"
 
 #include "asterisk/abstract_jb.h"
 #include "fixedjitterbuf.h"
@@ -49,47 +55,10 @@ enum {
        JB_CREATED =              (1 << 2)
 };
 
-/* Hooks for the abstract jb implementation */
-
-/*! \brief Create */
-typedef void * (*jb_create_impl)(struct ast_jb_conf *general_config, long resynch_threshold);
-/*! \brief Destroy */
-typedef void (*jb_destroy_impl)(void *jb);
-/*! \brief Put first frame */
-typedef int (*jb_put_first_impl)(void *jb, struct ast_frame *fin, long now);
-/*! \brief Put frame */
-typedef int (*jb_put_impl)(void *jb, struct ast_frame *fin, long now);
-/*! \brief Get frame for now */
-typedef int (*jb_get_impl)(void *jb, struct ast_frame **fout, long now, long interpl);
-/*! \brief Get next */
-typedef long (*jb_next_impl)(void *jb);
-/*! \brief Remove first frame */
-typedef int (*jb_remove_impl)(void *jb, struct ast_frame **fout);
-/*! \brief Force resynch */
-typedef void (*jb_force_resynch_impl)(void *jb);
-/*! \brief Empty and reset jb */
-typedef void (*jb_empty_and_reset_impl)(void *jb);
-
-/*!
- * \brief Jitterbuffer implementation private struct.
- */
-struct ast_jb_impl
-{
-       char name[AST_JB_IMPL_NAME_SIZE];
-       jb_create_impl create;
-       jb_destroy_impl destroy;
-       jb_put_first_impl put_first;
-       jb_put_impl put;
-       jb_get_impl get;
-       jb_next_impl next;
-       jb_remove_impl remove;
-       jb_force_resynch_impl force_resync;
-       jb_empty_and_reset_impl empty_and_reset;
-};
 
 /* Implementation functions */
 /* fixed */
-static void *jb_create_fixed(struct ast_jb_conf *general_config, long resynch_threshold);
+static void *jb_create_fixed(struct ast_jb_conf *general_config);
 static void jb_destroy_fixed(void *jb);
 static int jb_put_first_fixed(void *jb, struct ast_frame *fin, long now);
 static int jb_put_fixed(void *jb, struct ast_frame *fin, long now);
@@ -99,7 +68,7 @@ static int jb_remove_fixed(void *jb, struct ast_frame **fout);
 static void jb_force_resynch_fixed(void *jb);
 static void jb_empty_and_reset_fixed(void *jb);
 /* adaptive */
-static void * jb_create_adaptive(struct ast_jb_conf *general_config, long resynch_threshold);
+static void * jb_create_adaptive(struct ast_jb_conf *general_config);
 static void jb_destroy_adaptive(void *jb);
 static int jb_put_first_adaptive(void *jb, struct ast_frame *fin, long now);
 static int jb_put_adaptive(void *jb, struct ast_frame *fin, long now);
@@ -113,6 +82,7 @@ static void jb_empty_and_reset_adaptive(void *jb);
 static const struct ast_jb_impl avail_impl[] = {
        {
                .name = "fixed",
+               .type = AST_JB_FIXED,
                .create = jb_create_fixed,
                .destroy = jb_destroy_fixed,
                .put_first = jb_put_first_fixed,
@@ -125,6 +95,7 @@ static const struct ast_jb_impl avail_impl[] = {
        },
        {
                .name = "adaptive",
+               .type = AST_JB_ADAPTIVE,
                .create = jb_create_adaptive,
                .destroy = jb_destroy_adaptive,
                .put_first = jb_put_first_adaptive,
@@ -139,20 +110,11 @@ static const struct ast_jb_impl avail_impl[] = {
 
 static int default_impl = 0;
 
-
-/*! Abstract return codes */
-enum {
-       JB_IMPL_OK,
-       JB_IMPL_DROP,
-       JB_IMPL_INTERP,
-       JB_IMPL_NOFRAME
-};
-
 /* Translations between impl and abstract return codes */
 static const int fixed_to_abstract_code[] =
-       {JB_IMPL_OK, JB_IMPL_DROP, JB_IMPL_INTERP, JB_IMPL_NOFRAME};
+       {AST_JB_IMPL_OK, AST_JB_IMPL_DROP, AST_JB_IMPL_INTERP, AST_JB_IMPL_NOFRAME};
 static const int adaptive_to_abstract_code[] =
-       {JB_IMPL_OK, JB_IMPL_NOFRAME, JB_IMPL_NOFRAME, JB_IMPL_INTERP, JB_IMPL_DROP, JB_IMPL_OK};
+       {AST_JB_IMPL_OK, AST_JB_IMPL_NOFRAME, AST_JB_IMPL_NOFRAME, AST_JB_IMPL_INTERP, AST_JB_IMPL_DROP, AST_JB_IMPL_OK};
 
 /* JB_GET actions (used only for the frames log) */
 static const char * const jb_get_actions[] = {"Delivered", "Dropped", "Interpolated", "No"};
@@ -178,7 +140,7 @@ static long get_now(struct ast_jb *jb, struct timeval *tv);
 
 static void jb_choose_impl(struct ast_channel *chan)
 {
-       struct ast_jb *jb = &chan->jb;
+       struct ast_jb *jb = ast_channel_jb(chan);
        struct ast_jb_conf *jbconf = &jb->conf;
        const struct ast_jb_impl *test_impl;
        int i, avail_impl_count = ARRAY_LEN(avail_impl);
@@ -200,18 +162,18 @@ static void jb_choose_impl(struct ast_channel *chan)
 
 int ast_jb_do_usecheck(struct ast_channel *c0, struct ast_channel *c1)
 {
-       struct ast_jb *jb0 = &c0->jb;
-       struct ast_jb *jb1 = &c1->jb;
+       struct ast_jb *jb0 = ast_channel_jb(c0);
+       struct ast_jb *jb1 = ast_channel_jb(c1);
        struct ast_jb_conf *conf0 = &jb0->conf;
        struct ast_jb_conf *conf1 = &jb1->conf;
-       int c0_wants_jitter = c0->tech->properties & AST_CHAN_TP_WANTSJITTER;
-       int c0_creates_jitter = c0->tech->properties & AST_CHAN_TP_CREATESJITTER;
+       int c0_wants_jitter = ast_channel_tech(c0)->properties & AST_CHAN_TP_WANTSJITTER;
+       int c0_creates_jitter = ast_channel_tech(c0)->properties & AST_CHAN_TP_CREATESJITTER;
        int c0_jb_enabled = ast_test_flag(conf0, AST_JB_ENABLED);
        int c0_force_jb = ast_test_flag(conf0, AST_JB_FORCED);
        int c0_jb_timebase_initialized = ast_test_flag(jb0, JB_TIMEBASE_INITIALIZED);
        int c0_jb_created = ast_test_flag(jb0, JB_CREATED);
-       int c1_wants_jitter = c1->tech->properties & AST_CHAN_TP_WANTSJITTER;
-       int c1_creates_jitter = c1->tech->properties & AST_CHAN_TP_CREATESJITTER;
+       int c1_wants_jitter = ast_channel_tech(c1)->properties & AST_CHAN_TP_WANTSJITTER;
+       int c1_creates_jitter = ast_channel_tech(c1)->properties & AST_CHAN_TP_CREATESJITTER;
        int c1_jb_enabled = ast_test_flag(conf1, AST_JB_ENABLED);
        int c1_force_jb = ast_test_flag(conf1, AST_JB_FORCED);
        int c1_jb_timebase_initialized = ast_test_flag(jb1, JB_TIMEBASE_INITIALIZED);
@@ -261,8 +223,8 @@ int ast_jb_do_usecheck(struct ast_channel *c0, struct ast_channel *c1)
 
 int ast_jb_get_when_to_wakeup(struct ast_channel *c0, struct ast_channel *c1, int time_left)
 {
-       struct ast_jb *jb0 = &c0->jb;
-       struct ast_jb *jb1 = &c1->jb;
+       struct ast_jb *jb0 = ast_channel_jb(c0);
+       struct ast_jb *jb1 = ast_channel_jb(c1);
        int c0_use_jb = ast_test_flag(jb0, JB_USE);
        int c0_jb_is_created = ast_test_flag(jb0, JB_CREATED);
        int c1_use_jb = ast_test_flag(jb1, JB_USE);
@@ -301,7 +263,7 @@ int ast_jb_get_when_to_wakeup(struct ast_channel *c0, struct ast_channel *c1, in
 
 int ast_jb_put(struct ast_channel *chan, struct ast_frame *f)
 {
-       struct ast_jb *jb = &chan->jb;
+       struct ast_jb *jb = ast_channel_jb(chan);
        const struct ast_jb_impl *jbimpl = jb->impl;
        void *jbobj = jb->jbobj;
        struct ast_frame *frr;
@@ -322,15 +284,15 @@ int ast_jb_put(struct ast_channel *chan, struct ast_frame *f)
        /* We consider an enabled jitterbuffer should receive frames with valid timing info. */
        if (!ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO) || f->len < 2 || f->ts < 0) {
                ast_log(LOG_WARNING, "%s received frame with invalid timing info: "
-                       "has_timing_info=%d, len=%ld, ts=%ld, src=%s\n",
-                       chan->name, ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO), f->len, f->ts, f->src);
+                       "has_timing_info=%u, len=%ld, ts=%ld, src=%s\n",
+                       ast_channel_name(chan), ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO), f->len, f->ts, f->src);
                return -1;
        }
 
        frr = ast_frdup(f);
 
        if (!frr) {
-               ast_log(LOG_ERROR, "Failed to isolate frame for the jitterbuffer on channel '%s'\n", chan->name);
+               ast_log(LOG_ERROR, "Failed to isolate frame for the jitterbuffer on channel '%s'\n", ast_channel_name(chan));
                return -1;
        }
 
@@ -346,7 +308,7 @@ int ast_jb_put(struct ast_channel *chan, struct ast_frame *f)
                return 0;
        } else {
                now = get_now(jb, NULL);
-               if (jbimpl->put(jbobj, frr, now) != JB_IMPL_OK) {
+               if (jbimpl->put(jbobj, frr, now) != AST_JB_IMPL_OK) {
                        jb_framelog("JB_PUT {now=%ld}: Dropped frame with ts=%ld and len=%ld\n", now, frr->ts, frr->len);
                        ast_frfree(frr);
                        /*return -1;*/
@@ -366,8 +328,8 @@ int ast_jb_put(struct ast_channel *chan, struct ast_frame *f)
 
 void ast_jb_get_and_deliver(struct ast_channel *c0, struct ast_channel *c1)
 {
-       struct ast_jb *jb0 = &c0->jb;
-       struct ast_jb *jb1 = &c1->jb;
+       struct ast_jb *jb0 = ast_channel_jb(c0);
+       struct ast_jb *jb1 = ast_channel_jb(c1);
        int c0_use_jb = ast_test_flag(jb0, JB_USE);
        int c0_jb_is_created = ast_test_flag(jb0, JB_CREATED);
        int c1_use_jb = ast_test_flag(jb1, JB_USE);
@@ -383,7 +345,7 @@ void ast_jb_get_and_deliver(struct ast_channel *c0, struct ast_channel *c1)
 
 static void jb_get_and_deliver(struct ast_channel *chan)
 {
-       struct ast_jb *jb = &chan->jb;
+       struct ast_jb *jb = ast_channel_jb(chan);
        const struct ast_jb_impl *jbimpl = jb->impl;
        void *jbobj = jb->jbobj;
        struct ast_frame *f, finterp = { .frametype = AST_FRAME_VOICE, };
@@ -398,24 +360,24 @@ static void jb_get_and_deliver(struct ast_channel *chan)
        }
 
        while (now >= jb->next) {
-               interpolation_len = ast_codec_interp_len(jb->last_format);
+               interpolation_len = ast_format_get_default_ms(jb->last_format);
 
                res = jbimpl->get(jbobj, &f, now, interpolation_len);
 
                switch (res) {
-               case JB_IMPL_OK:
+               case AST_JB_IMPL_OK:
                        /* deliver the frame */
                        ast_write(chan, f);
-               case JB_IMPL_DROP:
+               case AST_JB_IMPL_DROP:
                        jb_framelog("\tJB_GET {now=%ld}: %s frame with ts=%ld and len=%ld\n",
                                now, jb_get_actions[res], f->ts, f->len);
-                       jb->last_format = f->subclass.codec;
+                       ao2_replace(jb->last_format, f->subclass.format);
                        ast_frfree(f);
                        break;
-               case JB_IMPL_INTERP:
+               case AST_JB_IMPL_INTERP:
                        /* interpolate a frame */
                        f = &finterp;
-                       f->subclass.codec = jb->last_format;
+                       f->subclass.format = jb->last_format;
                        f->samples  = interpolation_len * 8;
                        f->src  = "JB interpolation";
                        f->delivery = ast_tvadd(jb->timebase, ast_samp2tv(jb->next, 1000));
@@ -424,9 +386,9 @@ static void jb_get_and_deliver(struct ast_channel *chan)
                        ast_write(chan, f);
                        jb_framelog("\tJB_GET {now=%ld}: Interpolated frame with len=%d\n", now, interpolation_len);
                        break;
-               case JB_IMPL_NOFRAME:
+               case AST_JB_IMPL_NOFRAME:
                        ast_log(LOG_WARNING,
-                               "JB_IMPL_NOFRAME is returned from the %s jb when now=%ld >= next=%ld, jbnext=%ld!\n",
+                               "AST_JB_IMPL_NOFRAME is returned from the %s jb when now=%ld >= next=%ld, jbnext=%ld!\n",
                                jbimpl->name, now, jb->next, jbimpl->next(jbobj));
                        jb_framelog("\tJB_GET {now=%ld}: No frame for now!?\n", now);
                        return;
@@ -443,19 +405,18 @@ static void jb_get_and_deliver(struct ast_channel *chan)
 
 static int create_jb(struct ast_channel *chan, struct ast_frame *frr)
 {
-       struct ast_jb *jb = &chan->jb;
+       struct ast_jb *jb = ast_channel_jb(chan);
        struct ast_jb_conf *jbconf = &jb->conf;
        const struct ast_jb_impl *jbimpl = jb->impl;
        void *jbobj;
-       struct ast_channel *bridged;
        long now;
        char logfile_pathname[20 + AST_JB_IMPL_NAME_SIZE + 2*AST_CHANNEL_NAME + 1];
        char name1[AST_CHANNEL_NAME], name2[AST_CHANNEL_NAME], *tmp;
        int res;
 
-       jbobj = jb->jbobj = jbimpl->create(jbconf, jbconf->resync_threshold);
+       jbobj = jb->jbobj = jbimpl->create(jbconf);
        if (!jbobj) {
-               ast_log(LOG_WARNING, "Failed to create jitterbuffer on channel '%s'\n", chan->name);
+               ast_log(LOG_WARNING, "Failed to create jitterbuffer on channel '%s'\n", ast_channel_name(chan));
                return -1;
        }
 
@@ -464,8 +425,8 @@ static int create_jb(struct ast_channel *chan, struct ast_frame *frr)
 
        /* The result of putting the first frame should not differ from OK. However, its possible
           some implementations (i.e. adaptive's when resynch_threshold is specified) to drop it. */
-       if (res != JB_IMPL_OK) {
-               ast_log(LOG_WARNING, "Failed to put first frame in the jitterbuffer on channel '%s'\n", chan->name);
+       if (res != AST_JB_IMPL_OK) {
+               ast_log(LOG_WARNING, "Failed to put first frame in the jitterbuffer on channel '%s'\n", ast_channel_name(chan));
                /*
                jbimpl->destroy(jbobj);
                return -1;
@@ -476,23 +437,24 @@ static int create_jb(struct ast_channel *chan, struct ast_frame *frr)
        jb->next = jbimpl->next(jbobj);
 
        /* Init last format for a first time. */
-       jb->last_format = frr->subclass.codec;
+       jb->last_format = ao2_bump(frr->subclass.format);
 
        /* Create a frame log file */
        if (ast_test_flag(jbconf, AST_JB_LOG)) {
+               RAII_VAR(struct ast_channel *, bridged, ast_channel_bridge_peer(chan), ast_channel_cleanup);
                char safe_logfile[30] = "/tmp/logfile-XXXXXX";
                int safe_fd;
-               snprintf(name2, sizeof(name2), "%s", chan->name);
-               if ((tmp = strchr(name2, '/'))) {
+
+               snprintf(name2, sizeof(name2), "%s", ast_channel_name(chan));
+               while ((tmp = strchr(name2, '/'))) {
                        *tmp = '#';
                }
 
-               bridged = ast_bridged_channel(chan);
                /* We should always have bridged chan if a jitterbuffer is in use */
                ast_assert(bridged != NULL);
 
-               snprintf(name1, sizeof(name1), "%s", bridged->name);
-               if ((tmp = strchr(name1, '/'))) {
+               snprintf(name1, sizeof(name1), "%s", ast_channel_name(bridged));
+               while ((tmp = strchr(name1, '/'))) {
                        *tmp = '#';
                }
 
@@ -508,7 +470,7 @@ static int create_jb(struct ast_channel *chan, struct ast_frame *frr)
                        }
                }
 
-               if (res == JB_IMPL_OK) {
+               if (res == AST_JB_IMPL_OK) {
                        jb_framelog("JB_PUT_FIRST {now=%ld}: Queued frame with ts=%ld and len=%ld\n",
                                now, frr->ts, frr->len);
                } else {
@@ -517,10 +479,10 @@ static int create_jb(struct ast_channel *chan, struct ast_frame *frr)
                }
        }
 
-       ast_verb(3, "%s jitterbuffer created on channel %s\n", jbimpl->name, chan->name);
+       ast_verb(3, "%s jitterbuffer created on channel %s\n", jbimpl->name, ast_channel_name(chan));
 
        /* Free the frame if it has not been queued in the jb */
-       if (res != JB_IMPL_OK) {
+       if (res != AST_JB_IMPL_OK) {
                ast_frfree(frr);
        }
 
@@ -530,7 +492,7 @@ static int create_jb(struct ast_channel *chan, struct ast_frame *frr)
 
 void ast_jb_destroy(struct ast_channel *chan)
 {
-       struct ast_jb *jb = &chan->jb;
+       struct ast_jb *jb = ast_channel_jb(chan);
        const struct ast_jb_impl *jbimpl = jb->impl;
        void *jbobj = jb->jbobj;
        struct ast_frame *f;
@@ -540,9 +502,11 @@ void ast_jb_destroy(struct ast_channel *chan)
                jb->logfile = NULL;
        }
 
+       ao2_cleanup(jb->last_format);
+
        if (ast_test_flag(jb, JB_CREATED)) {
                /* Remove and free all frames still queued in jb */
-               while (jbimpl->remove(jbobj, &f) == JB_IMPL_OK) {
+               while (jbimpl->remove(jbobj, &f) == AST_JB_IMPL_OK) {
                        ast_frfree(f);
                }
 
@@ -551,7 +515,7 @@ void ast_jb_destroy(struct ast_channel *chan)
 
                ast_clear_flag(jb, JB_CREATED);
 
-               ast_verb(3, "%s jitterbuffer destroyed on channel %s\n", jbimpl->name, chan->name);
+               ast_verb(3, "%s jitterbuffer destroyed on channel %s\n", jbimpl->name, ast_channel_name(chan));
        }
 }
 
@@ -607,22 +571,29 @@ int ast_jb_read_conf(struct ast_jb_conf *conf, const char *varname, const char *
        return 0;
 }
 
+void ast_jb_enable_for_channel(struct ast_channel *chan)
+{
+       struct ast_jb_conf conf = ast_channel_jb(chan)->conf;
+       if (ast_test_flag(&conf, AST_JB_ENABLED)) {
+               ast_jb_create_framehook(chan, &conf, 1);
+       }
+}
 
 void ast_jb_configure(struct ast_channel *chan, const struct ast_jb_conf *conf)
 {
-       memcpy(&chan->jb.conf, conf, sizeof(*conf));
+       memcpy(&ast_channel_jb(chan)->conf, conf, sizeof(*conf));
 }
 
 
 void ast_jb_get_config(const struct ast_channel *chan, struct ast_jb_conf *conf)
 {
-       memcpy(conf, &chan->jb.conf, sizeof(*conf));
+       memcpy(conf, &ast_channel_jb((struct ast_channel *) chan)->conf, sizeof(*conf));
 }
 
 void ast_jb_empty_and_reset(struct ast_channel *c0, struct ast_channel *c1)
 {
-       struct ast_jb *jb0 = &c0->jb;
-       struct ast_jb *jb1 = &c1->jb;
+       struct ast_jb *jb0 = ast_channel_jb(c0);
+       struct ast_jb *jb1 = ast_channel_jb(c1);
        int c0_use_jb = ast_test_flag(jb0, JB_USE);
        int c0_jb_is_created = ast_test_flag(jb0, JB_CREATED);
        int c1_use_jb = ast_test_flag(jb1, JB_USE);
@@ -640,12 +611,12 @@ void ast_jb_empty_and_reset(struct ast_channel *c0, struct ast_channel *c1)
 /* Implementation functions */
 
 /* fixed */
-static void * jb_create_fixed(struct ast_jb_conf *general_config, long resynch_threshold)
+static void * jb_create_fixed(struct ast_jb_conf *general_config)
 {
        struct fixed_jb_conf conf;
 
        conf.jbsize = general_config->max_size;
-       conf.resync_threshold = resynch_threshold;
+       conf.resync_threshold = general_config->resync_threshold;
 
        return fixed_jb_new(&conf);
 }
@@ -654,6 +625,9 @@ static void jb_destroy_fixed(void *jb)
 {
        struct fixed_jb *fixedjb = (struct fixed_jb *) jb;
 
+       /* Ensure the fixed jb is empty - otherwise it will raise an ASSERT */
+       jb_empty_and_reset_fixed(jb);
+
        /* destroy the jb */
        fixed_jb_destroy(fixedjb);
 }
@@ -684,7 +658,7 @@ static int jb_put_fixed(void *jb, struct ast_frame *fin, long now)
 static int jb_get_fixed(void *jb, struct ast_frame **fout, long now, long interpl)
 {
        struct fixed_jb *fixedjb = (struct fixed_jb *) jb;
-       struct fixed_jb_frame frame;
+       struct fixed_jb_frame frame = { .data = &ast_null_frame };
        int res;
 
        res = fixed_jb_get(fixedjb, &frame, now, interpl);
@@ -734,7 +708,7 @@ static void jb_empty_and_reset_fixed(void *jb)
 
 /* adaptive */
 
-static void *jb_create_adaptive(struct ast_jb_conf *general_config, long resynch_threshold)
+static void *jb_create_adaptive(struct ast_jb_conf *general_config)
 {
        jb_conf jbconf;
        jitterbuf *adaptivejb;
@@ -762,11 +736,6 @@ static void jb_destroy_adaptive(void *jb)
 
 static int jb_put_first_adaptive(void *jb, struct ast_frame *fin, long now)
 {
-       jitterbuf *adaptivejb = (jitterbuf *) jb;
-
-       /* Initialize the offset to that of the first frame's timestamp */
-       adaptivejb->info.resync_offset = fin->ts;
-
        return jb_put_adaptive(jb, fin, now);
 }
 
@@ -785,7 +754,7 @@ static int jb_put_adaptive(void *jb, struct ast_frame *fin, long now)
 static int jb_get_adaptive(void *jb, struct ast_frame **fout, long now, long interpl)
 {
        jitterbuf *adaptivejb = (jitterbuf *) jb;
-       jb_frame frame;
+       jb_frame frame = { .data = &ast_null_frame };
        int res;
 
        res = jb_get(adaptivejb, &frame, now, interpl);
@@ -831,3 +800,329 @@ static void jb_empty_and_reset_adaptive(void *jb)
 
        jb_reset(adaptivejb);
 }
+
+const struct ast_jb_impl *ast_jb_get_impl(enum ast_jb_type type)
+{
+       int i;
+       for (i = 0; i < ARRAY_LEN(avail_impl); i++) {
+               if (avail_impl[i].type == type) {
+                       return &avail_impl[i];
+               }
+       }
+       return NULL;
+}
+
+#define DEFAULT_TIMER_INTERVAL 20
+#define DEFAULT_SIZE  200
+#define DEFAULT_TARGET_EXTRA  40
+#define DEFAULT_RESYNC  1000
+#define DEFAULT_TYPE AST_JB_FIXED
+
+struct jb_framedata {
+       const struct ast_jb_impl *jb_impl;
+       struct ast_jb_conf jb_conf;
+       struct timeval start_tv;
+       struct ast_format *last_format;
+       struct ast_timer *timer;
+       int timer_interval; /* ms between deliveries */
+       int timer_fd;
+       int first;
+       void *jb_obj;
+};
+
+static void jb_framedata_destroy(struct jb_framedata *framedata)
+{
+       if (framedata->timer) {
+               ast_timer_close(framedata->timer);
+               framedata->timer = NULL;
+       }
+       if (framedata->jb_impl && framedata->jb_obj) {
+               struct ast_frame *f;
+               while (framedata->jb_impl->remove(framedata->jb_obj, &f) == AST_JB_IMPL_OK) {
+                       ast_frfree(f);
+               }
+               framedata->jb_impl->destroy(framedata->jb_obj);
+               framedata->jb_obj = NULL;
+       }
+       ao2_cleanup(framedata->last_format);
+       ast_free(framedata);
+}
+
+void ast_jb_conf_default(struct ast_jb_conf *conf)
+{
+       conf->max_size = DEFAULT_SIZE;
+       conf->resync_threshold = DEFAULT_RESYNC;
+       ast_copy_string(conf->impl, "fixed", sizeof(conf->impl));
+       conf->target_extra = DEFAULT_TARGET_EXTRA;
+}
+
+static void datastore_destroy_cb(void *data) {
+       ast_free(data);
+       ast_debug(1, "JITTERBUFFER datastore destroyed\n");
+}
+
+static const struct ast_datastore_info jb_datastore = {
+       .type = "jitterbuffer",
+       .destroy = datastore_destroy_cb
+};
+
+static void hook_destroy_cb(void *framedata)
+{
+       ast_debug(1, "JITTERBUFFER hook destroyed\n");
+       jb_framedata_destroy((struct jb_framedata *) framedata);
+}
+
+static struct ast_frame *hook_event_cb(struct ast_channel *chan, struct ast_frame *frame, enum ast_framehook_event event, void *data)
+{
+       struct jb_framedata *framedata = data;
+       struct timeval now_tv;
+       unsigned long now;
+       int putframe = 0; /* signifies if audio frame was placed into the buffer or not */
+
+       switch (event) {
+       case AST_FRAMEHOOK_EVENT_READ:
+               break;
+       case AST_FRAMEHOOK_EVENT_ATTACHED:
+       case AST_FRAMEHOOK_EVENT_DETACHED:
+       case AST_FRAMEHOOK_EVENT_WRITE:
+               return frame;
+       }
+
+       if (ast_channel_fdno(chan) == AST_JITTERBUFFER_FD && framedata->timer) {
+               if (ast_timer_ack(framedata->timer, 1) < 0) {
+                       ast_log(LOG_ERROR, "Failed to acknowledge timer in jitter buffer\n");
+                       return frame;
+               }
+       }
+
+       if (!frame) {
+               return frame;
+       }
+
+       now_tv = ast_tvnow();
+       now = ast_tvdiff_ms(now_tv, framedata->start_tv);
+
+       if (frame->frametype == AST_FRAME_VOICE) {
+               int res;
+               struct ast_frame *jbframe;
+
+               if (!ast_test_flag(frame, AST_FRFLAG_HAS_TIMING_INFO) || frame->len < 2 || frame->ts < 0) {
+                       /* only frames with timing info can enter the jitterbuffer */
+                       return frame;
+               }
+
+               jbframe = ast_frisolate(frame);
+               ao2_replace(framedata->last_format, frame->subclass.format);
+
+               if (frame->len && (frame->len != framedata->timer_interval)) {
+                       framedata->timer_interval = frame->len;
+                       ast_timer_set_rate(framedata->timer, 1000 / framedata->timer_interval);
+               }
+               if (!framedata->first) {
+                       framedata->first = 1;
+                       res = framedata->jb_impl->put_first(framedata->jb_obj, jbframe, now);
+               } else {
+                       res = framedata->jb_impl->put(framedata->jb_obj, jbframe, now);
+               }
+
+               if (res == AST_JB_IMPL_OK) {
+                       if (jbframe != frame) {
+                               ast_frfree(frame);
+                       }
+                       frame = &ast_null_frame;
+               } else if (jbframe != frame) {
+                       ast_frfree(jbframe);
+               }
+               putframe = 1;
+       }
+
+       if (frame->frametype == AST_FRAME_NULL) {
+               int res;
+               long next = framedata->jb_impl->next(framedata->jb_obj);
+
+               /* If now is earlier than the next expected output frame
+                * from the jitterbuffer we may choose to pass on retrieving
+                * a frame during this read iteration.  The only exception
+                * to this rule is when an audio frame is placed into the buffer
+                * and the time for the next frame to come out of the buffer is
+                * at least within the timer_interval of the next output frame. By
+                * doing this we are able to feed off the timing of the input frames
+                * and only rely on our jitterbuffer timer when frames are dropped.
+                * During testing, this hybrid form of timing gave more reliable results. */
+               if (now < next) {
+                       long int diff = next - now;
+                       if (!putframe) {
+                               return frame;
+                       } else if (diff >= framedata->timer_interval) {
+                               return frame;
+                       }
+               }
+
+               ast_frfree(frame);
+               frame = &ast_null_frame;
+               res = framedata->jb_impl->get(framedata->jb_obj, &frame, now, framedata->timer_interval);
+               switch (res) {
+               case AST_JB_IMPL_OK:
+                       /* got it, and pass it through */
+                       break;
+               case AST_JB_IMPL_DROP:
+                       ast_frfree(frame);
+                       frame = &ast_null_frame;
+                       break;
+               case AST_JB_IMPL_INTERP:
+                       if (framedata->last_format) {
+                               struct ast_frame tmp = { 0, };
+
+                               tmp.frametype = AST_FRAME_VOICE;
+                               tmp.subclass.format = framedata->last_format;
+                               /* example: 8000hz / (1000 / 20ms) = 160 samples */
+                               tmp.samples = ast_format_get_sample_rate(framedata->last_format) / (1000 / framedata->timer_interval);
+                               tmp.delivery = ast_tvadd(framedata->start_tv, ast_samp2tv(next, 1000));
+                               tmp.offset = AST_FRIENDLY_OFFSET;
+                               tmp.src  = "func_jitterbuffer interpolation";
+                               ast_frfree(frame);
+                               frame = ast_frdup(&tmp);
+                               break;
+                       }
+                       /* else fall through */
+               case AST_JB_IMPL_NOFRAME:
+                       ast_frfree(frame);
+                       frame = &ast_null_frame;
+                       break;
+               }
+       }
+
+       if (frame->frametype == AST_FRAME_CONTROL) {
+               switch(frame->subclass.integer) {
+               case AST_CONTROL_HOLD:
+               case AST_CONTROL_UNHOLD:
+               case AST_CONTROL_T38_PARAMETERS:
+               case AST_CONTROL_SRCUPDATE:
+               case AST_CONTROL_SRCCHANGE:
+                       framedata->jb_impl->force_resync(framedata->jb_obj);
+                       break;
+               default:
+                       break;
+               }
+       }
+
+       return frame;
+}
+
+/* set defaults */
+static int jb_framedata_init(struct jb_framedata *framedata, struct ast_jb_conf *jb_conf)
+{
+       int jb_impl_type = DEFAULT_TYPE;
+       /* Initialize defaults */
+       framedata->timer_fd = -1;
+       memcpy(&framedata->jb_conf, jb_conf, sizeof(*jb_conf));
+
+       /* Figure out implementation type from the configuration implementation string */
+       if (!ast_strlen_zero(jb_conf->impl)) {
+               if (!strcasecmp(jb_conf->impl, "fixed")) {
+                       jb_impl_type = AST_JB_FIXED;
+               } else if (!strcasecmp(jb_conf->impl, "adaptive")) {
+                       jb_impl_type = AST_JB_ADAPTIVE;
+               } else {
+                       ast_log(LOG_WARNING, "Unknown Jitterbuffer type %s. Failed to create jitterbuffer.\n", jb_conf->impl);
+                       return -1;
+               }
+       }
+
+       if (!(framedata->jb_impl = ast_jb_get_impl(jb_impl_type))) {
+               return -1;
+       }
+
+       if (!(framedata->timer = ast_timer_open())) {
+               return -1;
+       }
+
+       framedata->timer_fd = ast_timer_fd(framedata->timer);
+       framedata->timer_interval = DEFAULT_TIMER_INTERVAL;
+       ast_timer_set_rate(framedata->timer, 1000 / framedata->timer_interval);
+       framedata->start_tv = ast_tvnow();
+
+       framedata->jb_obj = framedata->jb_impl->create(&framedata->jb_conf);
+       return 0;
+}
+
+
+void ast_jb_create_framehook(struct ast_channel *chan, struct ast_jb_conf *jb_conf, int prefer_existing)
+{
+       struct jb_framedata *framedata;
+       struct ast_datastore *datastore = NULL;
+       struct ast_framehook_interface interface = {
+               .version = AST_FRAMEHOOK_INTERFACE_VERSION,
+               .event_cb = hook_event_cb,
+               .destroy_cb = hook_destroy_cb,
+       };
+       int i = 0;
+
+       /* If disabled, strip any existing jitterbuffer and don't replace it. */
+       if (!strcasecmp(jb_conf->impl, "disabled")) {
+               int *id;
+               ast_channel_lock(chan);
+               if ((datastore = ast_channel_datastore_find(chan, &jb_datastore, NULL))) {
+                       id = datastore->data;
+                       ast_framehook_detach(chan, *id);
+                       ast_channel_datastore_remove(chan, datastore);
+                       ast_datastore_free(datastore);
+               }
+               ast_channel_unlock(chan);
+               return;
+       }
+
+       if (!(framedata = ast_calloc(1, sizeof(*framedata)))) {
+               return;
+       }
+
+       if (jb_framedata_init(framedata, jb_conf)) {
+               jb_framedata_destroy(framedata);
+               return;
+       }
+
+       interface.data = framedata;
+
+       ast_channel_lock(chan);
+       i = ast_framehook_attach(chan, &interface);
+       if (i >= 0) {
+               int *id;
+               if ((datastore = ast_channel_datastore_find(chan, &jb_datastore, NULL))) {
+                       /* There is already a jitterbuffer on the channel. */
+                       if (prefer_existing) {
+                               /* We prefer the existing jitterbuffer, so remove the new one and keep the old one. */
+                               ast_framehook_detach(chan, i);
+                               ast_channel_unlock(chan);
+                               return;
+                       }
+                       /* We prefer the new jitterbuffer, so strip the old one. */
+                       id = datastore->data;
+                       ast_framehook_detach(chan, *id);
+                       ast_channel_datastore_remove(chan, datastore);
+                       ast_datastore_free(datastore);
+               }
+
+               if (!(datastore = ast_datastore_alloc(&jb_datastore, NULL))) {
+                       ast_framehook_detach(chan, i);
+                       ast_channel_unlock(chan);
+                       return;
+               }
+
+               if (!(id = ast_calloc(1, sizeof(int)))) {
+                       ast_datastore_free(datastore);
+                       ast_framehook_detach(chan, i);
+                       ast_channel_unlock(chan);
+                       return;
+               }
+
+               *id = i; /* Store off the id. The channel is still locked so it is safe to access this ptr. */
+               datastore->data = id;
+               ast_channel_datastore_add(chan, datastore);
+
+               ast_channel_set_fd(chan, AST_JITTERBUFFER_FD, framedata->timer_fd);
+       } else {
+               jb_framedata_destroy(framedata);
+               framedata = NULL;
+       }
+       ast_channel_unlock(chan);
+}