Start untangling header inclusion in a way that does not affect
[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 #if defined(__cplusplus) || defined(c_plusplus)
36 extern "C" {
37 #endif
38
39 struct ast_channel;
40 struct ast_frame;
41
42 /* Configuration flags */
43 enum {
44         AST_JB_ENABLED = (1 << 0),
45         AST_JB_FORCED =  (1 << 1),
46         AST_JB_LOG =     (1 << 2)
47 };
48
49 #define AST_JB_IMPL_NAME_SIZE 12
50
51 /*!
52  * \brief General jitterbuffer configuration.
53  */
54 struct ast_jb_conf
55 {
56         /*! \brief Combination of the AST_JB_ENABLED, AST_JB_FORCED and AST_JB_LOG flags. */
57         unsigned int flags;
58         /*! \brief Max size of the jitterbuffer implementation. */
59         long max_size;
60         /*! \brief Resynchronization threshold of the jitterbuffer implementation. */
61         long resync_threshold;
62         /*! \brief Name of the jitterbuffer implementation to be used. */
63         char impl[AST_JB_IMPL_NAME_SIZE];
64 };
65
66
67 /* Jitterbuffer configuration property names */
68 #define AST_JB_CONF_PREFIX "jb"
69 #define AST_JB_CONF_ENABLE "enable"
70 #define AST_JB_CONF_FORCE "force"
71 #define AST_JB_CONF_MAX_SIZE "maxsize"
72 #define AST_JB_CONF_RESYNCH_THRESHOLD "resyncthreshold"
73 #define AST_JB_CONF_IMPL "impl"
74 #define AST_JB_CONF_LOG "log"
75
76
77 struct ast_jb_impl;
78
79
80 /*!
81  * \brief General jitterbuffer state.
82  */
83 struct ast_jb
84 {
85         /*! \brief Jitterbuffer configuration. */
86         struct ast_jb_conf conf;
87         /*! \brief Jitterbuffer implementation to be used. */
88         struct ast_jb_impl *impl;
89         /*! \brief Jitterbuffer object, passed to the implementation. */
90         void *jbobj;
91         /*! \brief The time the jitterbuffer was created. */
92         struct timeval timebase;
93         /*! \brief The time the next frame should be played. */
94         long next;
95         /*! \brief Voice format of the last frame in. */
96         int last_format;
97         /*! \brief File for frame timestamp tracing. */
98         FILE *logfile;
99         /*! \brief Jitterbuffer internal state flags. */
100         unsigned int flags;
101 };
102
103
104 /*!
105  * \brief Checks the need of a jb use in a generic bridge.
106  * \param c0 first bridged channel.
107  * \param c1 second bridged channel.
108  *
109  * Called from ast_generic_bridge() when two channels are entering in a bridge.
110  * The function checks the need of a jitterbuffer, depending on both channel's
111  * configuration and technology properties. As a result, this function sets
112  * appropriate internal jb flags to the channels, determining further behaviour
113  * of the bridged jitterbuffers.
114  *
115  * \retval zero if there are no jitter buffers in use
116  * \retval non-zero if there are
117  */
118 int ast_jb_do_usecheck(struct ast_channel *c0, struct ast_channel *c1);
119
120
121 /*!
122  * \brief Calculates the time, left to the closest delivery moment in a bridge.
123  * \param c0 first bridged channel.
124  * \param c1 second bridged channel.
125  * \param time_left bridge time limit, or -1 if not set.
126  *
127  * Called from ast_generic_bridge() to determine the maximum time to wait for
128  * activity in ast_waitfor_n() call. If neihter of the channels is using jb,
129  * this function returns the time limit passed.
130  *
131  * \return maximum time to wait.
132  */
133 int ast_jb_get_when_to_wakeup(struct ast_channel *c0, struct ast_channel *c1, int time_left);
134
135
136 /*!
137  * \brief Puts a frame into a channel jitterbuffer.
138  * \param chan channel.
139  * \param f frame.
140  *
141  * Called from ast_generic_bridge() to put a frame into a channel's jitterbuffer.
142  * The function will successfuly enqueue a frame if and only if:
143  * 1. the channel is using a jitterbuffer (as determined by ast_jb_do_usecheck()),
144  * 2. the frame's type is AST_FRAME_VOICE,
145  * 3. the frame has timing info set and has length >= 2 ms,
146  * 4. there is no some internal error happened (like failed memory allocation).
147  * Frames, successfuly queued, should be delivered by the channel's jitterbuffer,
148  * when their delivery time has came.
149  * Frames, not successfuly queued, should be delivered immediately.
150  * Dropped by the jb implementation frames are considered successfuly enqueued as
151  * far as they should not be delivered at all.
152  *
153  * \retval 0 if the frame was queued
154  * \retval -1 if not
155  */
156 int ast_jb_put(struct ast_channel *chan, struct ast_frame *f);
157
158
159 /*!
160  * \brief Deliver the queued frames that should be delivered now for both channels.
161  * \param c0 first bridged channel.
162  * \param c1 second bridged channel.
163  *
164  * Called from ast_generic_bridge() to deliver any frames, that should be delivered
165  * for the moment of invocation. Does nothing if neihter of the channels is using jb
166  * or has any frames currently queued in. The function delivers frames usig ast_write()
167  * each of the channels.
168  */
169 void ast_jb_get_and_deliver(struct ast_channel *c0, struct ast_channel *c1);
170
171
172 /*!
173  * \brief Destroys jitterbuffer on a channel.
174  * \param chan channel.
175  *
176  * Called from ast_channel_free() when a channel is destroyed.
177  */
178 void ast_jb_destroy(struct ast_channel *chan);
179
180
181 /*!
182  * \brief Sets jitterbuffer configuration property.
183  * \param conf configuration to store the property in.
184  * \param varname property name.
185  * \param value property value.
186  *
187  * Called from a channel driver to build a jitterbuffer configuration tipically when
188  * reading a configuration file. It is not neccessary for a channel driver to know
189  * each of the jb configuration property names. The jitterbuffer itself knows them.
190  * The channel driver can pass each config var it reads through this function. It will
191  * return 0 if the variable was consumed from the jb conf.
192  *
193  * \return zero if the property was set to the configuration, -1 if not.
194  */
195 int ast_jb_read_conf(struct ast_jb_conf *conf, const char *varname, const char *value);
196
197
198 /*!
199  * \brief Configures a jitterbuffer on a channel.
200  * \param chan channel to configure.
201  * \param conf configuration to apply.
202  *
203  * Called from a channel driver when a channel is created and its jitterbuffer needs
204  * to be configured.
205  */
206 void ast_jb_configure(struct ast_channel *chan, const struct ast_jb_conf *conf);
207
208
209 /*!
210  * \brief Copies a channel's jitterbuffer configuration.
211  * \param chan channel.
212  * \param conf destination.
213  */
214 void ast_jb_get_config(const struct ast_channel *chan, struct ast_jb_conf *conf);
215
216
217 #if defined(__cplusplus) || defined(c_plusplus)
218 }
219 #endif
220
221 #endif /* _ABSTRACT_JB_H_ */