8a5e3d27ffdb30e2ac562fa47b54713f5b5288c8
[asterisk/asterisk.git] / include / asterisk / abstract_jb.h
1 /*
2  * abstract_jb: common implementation-independent jitterbuffer stuff
3  *
4  * Copyright (C) 2005, Attractel OOD
5  *
6  * Contributors:
7  * Slav Klenov <slav@securax.org>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  *
19  * A license has been granted to Digium (via disclaimer) for the use of
20  * this code.
21  */
22
23 /*! \file
24  *
25  * \brief Common implementation-independent jitterbuffer stuff.
26  * 
27  * \author Slav Klenov <slav@securax.org>
28  */
29
30 #ifndef _ABSTRACT_JB_H_
31 #define _ABSTRACT_JB_H_
32
33 #include <sys/time.h>
34
35 #include "asterisk/format.h"
36
37 #if defined(__cplusplus) || defined(c_plusplus)
38 extern "C" {
39 #endif
40
41 struct ast_frame;
42
43 /* Configuration flags */
44 enum {
45         AST_JB_ENABLED = (1 << 0),
46         AST_JB_FORCED =  (1 << 1),
47         AST_JB_LOG =     (1 << 2)
48 };
49
50 enum ast_jb_type {
51         AST_JB_FIXED,
52         AST_JB_ADAPTIVE,
53 };
54
55 /*! Abstract return codes */
56 enum {
57         AST_JB_IMPL_OK,
58         AST_JB_IMPL_DROP,
59         AST_JB_IMPL_INTERP,
60         AST_JB_IMPL_NOFRAME
61 };
62
63 #define AST_JB_IMPL_NAME_SIZE 12
64
65 /*!
66  * \brief General jitterbuffer configuration.
67  */
68 struct ast_jb_conf
69 {
70         /*! \brief Combination of the AST_JB_ENABLED, AST_JB_FORCED and AST_JB_LOG flags. */
71         unsigned int flags;
72         /*! \brief Max size of the jitterbuffer implementation. */
73         long max_size;
74         /*! \brief Resynchronization threshold of the jitterbuffer implementation. */
75         long resync_threshold;
76         /*! \brief Name of the jitterbuffer implementation to be used. */
77         char impl[AST_JB_IMPL_NAME_SIZE];
78         /*! \brief amount of additional jitterbuffer adjustment */
79         long target_extra;
80 };
81
82
83 /* Jitterbuffer configuration property names */
84 #define AST_JB_CONF_PREFIX "jb"
85 #define AST_JB_CONF_ENABLE "enable"
86 #define AST_JB_CONF_FORCE "force"
87 #define AST_JB_CONF_MAX_SIZE "maxsize"
88 #define AST_JB_CONF_RESYNCH_THRESHOLD "resyncthreshold"
89 #define AST_JB_CONF_TARGET_EXTRA "targetextra"
90 #define AST_JB_CONF_IMPL "impl"
91 #define AST_JB_CONF_LOG "log"
92
93 /* Hooks for the abstract jb implementation */
94 /*! \brief Create */
95 typedef void * (*jb_create_impl)(struct ast_jb_conf *general_config);
96 /*! \brief Destroy */
97 typedef void (*jb_destroy_impl)(void *jb);
98 /*! \brief Put first frame */
99 typedef int (*jb_put_first_impl)(void *jb, struct ast_frame *fin, long now);
100 /*! \brief Put frame */
101 typedef int (*jb_put_impl)(void *jb, struct ast_frame *fin, long now);
102 /*! \brief Get frame for now */
103 typedef int (*jb_get_impl)(void *jb, struct ast_frame **fout, long now, long interpl);
104 /*! \brief Get next */
105 typedef long (*jb_next_impl)(void *jb);
106 /*! \brief Remove first frame */
107 typedef int (*jb_remove_impl)(void *jb, struct ast_frame **fout);
108 /*! \brief Force resynch */
109 typedef void (*jb_force_resynch_impl)(void *jb);
110 /*! \brief Empty and reset jb */
111 typedef void (*jb_empty_and_reset_impl)(void *jb);
112
113
114 /*!
115  * \brief Jitterbuffer implementation struct.
116  */
117 struct ast_jb_impl
118 {
119         char name[AST_JB_IMPL_NAME_SIZE];
120         enum ast_jb_type type;
121         jb_create_impl create;
122         jb_destroy_impl destroy;
123         jb_put_first_impl put_first;
124         jb_put_impl put;
125         jb_get_impl get;
126         jb_next_impl next;
127         jb_remove_impl remove;
128         jb_force_resynch_impl force_resync;
129         jb_empty_and_reset_impl empty_and_reset;
130 };
131
132 /*!
133  * \brief General jitterbuffer state.
134  */
135 struct ast_jb
136 {
137         /*! \brief Jitterbuffer configuration. */
138         struct ast_jb_conf conf;
139         /*! \brief Jitterbuffer implementation to be used. */
140         const struct ast_jb_impl *impl;
141         /*! \brief Jitterbuffer object, passed to the implementation. */
142         void *jbobj;
143         /*! \brief The time the jitterbuffer was created. */
144         struct timeval timebase;
145         /*! \brief The time the next frame should be played. */
146         long next;
147         /*! \brief Voice format of the last frame in. */
148         struct ast_format *last_format;
149         /*! \brief File for frame timestamp tracing. */
150         FILE *logfile;
151         /*! \brief Jitterbuffer internal state flags. */
152         unsigned int flags;
153 };
154
155
156 /*!
157  * \brief Checks the need of a jb use in a generic bridge.
158  * \param c0 first bridged channel.
159  * \param c1 second bridged channel.
160  *
161  * Called from ast_generic_bridge() when two channels are entering in a bridge.
162  * The function checks the need of a jitterbuffer, depending on both channel's
163  * configuration and technology properties. As a result, this function sets
164  * appropriate internal jb flags to the channels, determining further behaviour
165  * of the bridged jitterbuffers.
166  *
167  * \retval zero if there are no jitter buffers in use
168  * \retval non-zero if there are
169  */
170 int ast_jb_do_usecheck(struct ast_channel *c0, struct ast_channel *c1);
171
172
173 /*!
174  * \brief Calculates the time, left to the closest delivery moment in a bridge.
175  * \param c0 first bridged channel.
176  * \param c1 second bridged channel.
177  * \param time_left bridge time limit, or -1 if not set.
178  *
179  * Called from ast_generic_bridge() to determine the maximum time to wait for
180  * activity in ast_waitfor_n() call. If neihter of the channels is using jb,
181  * this function returns the time limit passed.
182  *
183  * \return maximum time to wait.
184  */
185 int ast_jb_get_when_to_wakeup(struct ast_channel *c0, struct ast_channel *c1, int time_left);
186
187
188 /*!
189  * \brief Puts a frame into a channel jitterbuffer.
190  * \param chan channel.
191  * \param f frame.
192  *
193  * Called from ast_generic_bridge() to put a frame into a channel's jitterbuffer.
194  * The function will successfuly enqueue a frame if and only if:
195  * 1. the channel is using a jitterbuffer (as determined by ast_jb_do_usecheck()),
196  * 2. the frame's type is AST_FRAME_VOICE,
197  * 3. the frame has timing info set and has length >= 2 ms,
198  * 4. there is no some internal error happened (like failed memory allocation).
199  * Frames, successfuly queued, should be delivered by the channel's jitterbuffer,
200  * when their delivery time has came.
201  * Frames, not successfuly queued, should be delivered immediately.
202  * Dropped by the jb implementation frames are considered successfuly enqueued as
203  * far as they should not be delivered at all.
204  *
205  * \retval 0 if the frame was queued
206  * \retval -1 if not
207  */
208 int ast_jb_put(struct ast_channel *chan, struct ast_frame *f);
209
210
211 /*!
212  * \brief Deliver the queued frames that should be delivered now for both channels.
213  * \param c0 first bridged channel.
214  * \param c1 second bridged channel.
215  *
216  * Called from ast_generic_bridge() to deliver any frames, that should be delivered
217  * for the moment of invocation. Does nothing if neihter of the channels is using jb
218  * or has any frames currently queued in. The function delivers frames usig ast_write()
219  * each of the channels.
220  */
221 void ast_jb_get_and_deliver(struct ast_channel *c0, struct ast_channel *c1);
222
223
224 /*!
225  * \brief Destroys jitterbuffer on a channel.
226  * \param chan channel.
227  *
228  * Called from ast_channel_free() when a channel is destroyed.
229  */
230 void ast_jb_destroy(struct ast_channel *chan);
231
232
233 /*!
234  * \brief Sets jitterbuffer configuration property.
235  * \param conf configuration to store the property in.
236  * \param varname property name.
237  * \param value property value.
238  *
239  * Called from a channel driver to build a jitterbuffer configuration typically when
240  * reading a configuration file. It is not necessary for a channel driver to know
241  * each of the jb configuration property names. The jitterbuffer itself knows them.
242  * The channel driver can pass each config var it reads through this function. It will
243  * return 0 if the variable was consumed from the jb conf.
244  *
245  * \return zero if the property was set to the configuration, -1 if not.
246  */
247 int ast_jb_read_conf(struct ast_jb_conf *conf, const char *varname, const char *value);
248
249 /*!
250  * \since 12.0
251  * \brief Sets a jitterbuffer frame hook on the channel based on the channel's stored
252  *        jitterbuffer configuration
253  *
254  * \param chan Which channel is being set up
255  */
256 void ast_jb_enable_for_channel(struct ast_channel *chan);
257
258 /*!
259  * \brief Configures a jitterbuffer on a channel.
260  * \param chan channel to configure.
261  * \param conf configuration to apply.
262  *
263  * Called from a channel driver when a channel is created and its jitterbuffer needs
264  * to be configured.
265  */
266 void ast_jb_configure(struct ast_channel *chan, const struct ast_jb_conf *conf);
267
268 /*!
269  * \brief Copies a channel's jitterbuffer configuration.
270  * \param chan channel.
271  * \param conf destination.
272  */
273 void ast_jb_get_config(const struct ast_channel *chan, struct ast_jb_conf *conf);
274
275 /*!
276  * \brief drops all frames from a jitterbuffer and resets it
277  * \param c0 one channel of a bridge
278  * \param c1 the other channel of the bridge
279  */
280 void ast_jb_empty_and_reset(struct ast_channel *c0, struct ast_channel *c1);
281
282 const struct ast_jb_impl *ast_jb_get_impl(enum ast_jb_type type);
283
284 /*!
285  * \since 12
286  * \brief Sets the contents of an ast_jb_conf struct to the default jitterbuffer settings
287  *
288  * \param conf Which jitterbuffer is being set
289  */
290 void ast_jb_conf_default(struct ast_jb_conf *conf);
291
292 /*!
293  * \since 12
294  * \brief Applies a jitterbuffer framehook to a channel based on a provided jitterbuffer config
295  *
296  * \param chan Which channel the jitterbuffer is being set on
297  * \param jb_conf Configuration to use for the jitterbuffer
298  * \param prefer_existing If this is true and a jitterbuffer already exists for the channel,
299  *        use the existing jitterbuffer
300  */
301 void ast_jb_create_framehook(struct ast_channel *chan, struct ast_jb_conf *jb_conf, int prefer_existing);
302
303 #if defined(__cplusplus) || defined(c_plusplus)
304 }
305 #endif
306
307 #endif /* _ABSTRACT_JB_H_ */