8dc18e569c3d66c125276bac9b68bdb228e6607f
[asterisk/asterisk.git] / include / asterisk / channel.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief General Asterisk PBX channel definitions.
21  * \par See also:
22  *  \arg \ref Def_Channel
23  *  \arg \ref channel_drivers
24  */
25
26 /*! \page Def_Channel Asterisk Channels
27         \par What is a Channel?
28         A phone call through Asterisk consists of an incoming
29         connection and an outbound connection. Each call comes
30         in through a channel driver that supports one technology,
31         like SIP, DAHDI, IAX2 etc.
32         \par
33         Each channel driver, technology, has it's own private
34         channel or dialog structure, that is technology-dependent.
35         Each private structure is "owned" by a generic Asterisk
36         channel structure, defined in channel.h and handled by
37         channel.c .
38         \par Call scenario
39         This happens when an incoming call arrives to Asterisk
40         -# Call arrives on a channel driver interface
41         -# Channel driver creates a PBX channel and starts a
42            pbx thread on the channel
43         -# The dial plan is executed
44         -# At this point at least two things can happen:
45                 -# The call is answered by Asterisk and
46                    Asterisk plays a media stream or reads media
47                 -# The dial plan forces Asterisk to create an outbound
48                    call somewhere with the dial (see \ref app_dial.c)
49                    application
50         .
51
52         \par Bridging channels
53         If Asterisk dials out this happens:
54         -# Dial creates an outbound PBX channel and asks one of the
55            channel drivers to create a call
56         -# When the call is answered, Asterisk bridges the media streams
57            so the caller on the first channel can speak with the callee
58            on the second, outbound channel
59         -# In some cases where we have the same technology on both
60            channels and compatible codecs, a native bridge is used.
61            In a native bridge, the channel driver handles forwarding
62            of incoming audio to the outbound stream internally, without
63            sending audio frames through the PBX.
64         -# In SIP, theres an "external native bridge" where Asterisk
65            redirects the endpoint, so audio flows directly between the
66            caller's phone and the callee's phone. Signalling stays in
67            Asterisk in order to be able to provide a proper CDR record
68            for the call.
69
70
71         \par Masquerading channels
72         In some cases, a channel can masquerade itself into another
73         channel. This happens frequently in call transfers, where
74         a new channel takes over a channel that is already involved
75         in a call. The new channel sneaks in and takes over the bridge
76         and the old channel, now a zombie, is hung up.
77
78         \par Reference
79         \arg channel.c - generic functions
80         \arg channel.h - declarations of functions, flags and structures
81         \arg translate.h - Transcoding support functions
82         \arg \ref channel_drivers - Implemented channel drivers
83         \arg \ref Def_Frame Asterisk Multimedia Frames
84         \arg \ref Def_Bridge
85
86 */
87 /*! \page Def_Bridge Asterisk Channel Bridges
88
89         In Asterisk, there's several media bridges.
90
91         The Core bridge handles two channels (a "phone call") and bridge
92         them together.
93
94         The conference bridge (meetme) handles several channels simultaneously
95         with the support of an external timer (DAHDI timer). This is used
96         not only by the Conference application (meetme) but also by the
97         page application and the SLA system introduced in 1.4.
98         The conference bridge does not handle video.
99
100         When two channels of the same type connect, the channel driver
101         or the media subsystem used by the channel driver (i.e. RTP)
102         can create a native bridge without sending media through the
103         core.
104
105         Native bridging can be disabled by a number of reasons,
106         like DTMF being needed by the core or codecs being incompatible
107         so a transcoding module is needed.
108
109 References:
110         \li \see ast_channel_early_bridge()
111         \li \see ast_channel_bridge()
112         \li \see app_meetme.c
113         \li \ref AstRTPbridge
114         \li \see ast_rtp_bridge()
115         \li \ref Def_Channel
116 */
117
118 /*! \page AstFileDesc File descriptors
119         Asterisk File descriptors are connected to each channel (see \ref Def_Channel)
120         in the \ref ast_channel structure.
121 */
122
123 #ifndef _ASTERISK_CHANNEL_H
124 #define _ASTERISK_CHANNEL_H
125
126 #include "asterisk/abstract_jb.h"
127 #include "asterisk/astobj2.h"
128
129 #include "asterisk/poll-compat.h"
130
131 #if defined(__cplusplus) || defined(c_plusplus)
132 extern "C" {
133 #endif
134
135 #define AST_MAX_EXTENSION       80      /*!< Max length of an extension */
136 #define AST_MAX_CONTEXT         80      /*!< Max length of a context */
137 #define AST_CHANNEL_NAME        80      /*!< Max length of an ast_channel name */
138 #define MAX_LANGUAGE            20      /*!< Max length of the language setting */
139 #define MAX_MUSICCLASS          80      /*!< Max length of the music class setting */
140
141 #include "asterisk/frame.h"
142 #include "asterisk/sched.h"
143 #include "asterisk/chanvars.h"
144 #include "asterisk/config.h"
145 #include "asterisk/lock.h"
146 #include "asterisk/cdr.h"
147 #include "asterisk/utils.h"
148 #include "asterisk/linkedlists.h"
149 #include "asterisk/stringfields.h"
150 #include "asterisk/datastore.h"
151
152 #define DATASTORE_INHERIT_FOREVER       INT_MAX
153
154 #define AST_MAX_FDS             10
155 /*
156  * We have AST_MAX_FDS file descriptors in a channel.
157  * Some of them have a fixed use:
158  */
159 #define AST_ALERT_FD    (AST_MAX_FDS-1)         /*!< used for alertpipe */
160 #define AST_TIMING_FD   (AST_MAX_FDS-2)         /*!< used for timingfd */
161 #define AST_AGENT_FD    (AST_MAX_FDS-3)         /*!< used by agents for pass through */
162 #define AST_GENERATOR_FD        (AST_MAX_FDS-4) /*!< used by generator */
163
164 enum ast_bridge_result {
165         AST_BRIDGE_COMPLETE = 0,
166         AST_BRIDGE_FAILED = -1,
167         AST_BRIDGE_FAILED_NOWARN = -2,
168         AST_BRIDGE_RETRY = -3,
169 };
170
171 typedef unsigned long long ast_group_t;
172
173 /*! \todo Add an explanation of an Asterisk generator
174 */
175 struct ast_generator {
176         void *(*alloc)(struct ast_channel *chan, void *params);
177         void (*release)(struct ast_channel *chan, void *data);
178         /*! This function gets called with the channel unlocked, but is called in
179          *  the context of the channel thread so we know the channel is not going
180          *  to disappear.  This callback is responsible for locking the channel as
181          *  necessary. */
182         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
183         /*! This gets called when DTMF_END frames are read from the channel */
184         void (*digit)(struct ast_channel *chan, char digit);
185 };
186
187 /*!
188  * \brief Structure for all kinds of caller ID identifications.
189  * \note All string fields here are malloc'ed, so they need to be
190  * freed when the structure is deleted.
191  * Also, NULL and "" must be considered equivalent.
192  *
193  * \note SIP and IAX2 has utf8 encoded Unicode caller ID names.
194  * In some cases, we also have an alternative (RPID) E.164 number that can be used
195  * as caller ID on numeric E.164 phone networks (DAHDI or SIP/IAX2 to PSTN gateway).
196  *
197  * \todo Implement settings for transliteration between UTF8 caller ID names in
198  *       to Ascii Caller ID's (DAHDI). Östen Åsklund might be transliterated into
199  *       Osten Asklund or Oesten Aasklund depending upon language and person...
200  *       We need automatic routines for incoming calls and static settings for
201  *       our own accounts.
202  */
203 struct ast_callerid {
204         /*!
205          * \brief Malloc'd Dialed Number Identifier
206          * (Field will eventually move to struct ast_channel.dialed.number)
207          */
208         char *cid_dnid;
209
210         /*!
211          * \brief Malloc'd Caller Number
212          * (Field will eventually move to struct ast_channel.caller.id.number)
213          */
214         char *cid_num;
215
216         /*!
217          * \brief Malloc'd Caller Name (ASCII)
218          * (Field will eventually move to struct ast_channel.caller.id.name)
219          */
220         char *cid_name;
221
222         /*!
223          * \brief Malloc'd Automatic Number Identification (ANI)
224          * (Field will eventually move to struct ast_channel.caller.ani)
225          */
226         char *cid_ani;
227
228         /*!
229          * \brief Malloc'd Redirecting Directory Number Information Service (RDNIS)
230          * (Field will eventually move to struct ast_channel.redirecting.from.number)
231          */
232         char *cid_rdnis;
233
234         /*!
235          * \brief Callerid Q.931 encoded number presentation/screening fields
236          * (Field will eventually move to struct ast_channel.caller.id.number_presentation)
237          */
238         int cid_pres;
239
240         /*!
241          * \brief Callerid ANI 2 (Info digits)
242          * (Field will eventually move to struct ast_channel.caller.ani2)
243          */
244         int cid_ani2;
245
246         /*!
247          * \brief Callerid Q.931 encoded type-of-number/numbering-plan fields
248          * \note Currently this value is mostly just passed around the system.
249          * The H.323 interfaces set the value from received messages and uses the value for sent messages.
250          * The DAHDI PRI interfaces set the value from received messages but does not use it for sent messages.
251          * You can read it and set it but only H.323 uses it.
252          * (Field will eventually move to struct ast_channel.caller.id.number_type)
253          */
254         int cid_ton;
255
256         /*!
257          * \brief Callerid Transit Network Select
258          * \note Currently this value is just passed around the system.
259          * You can read it and set it but it is never used for anything.
260          * (Field will eventually move to struct ast_channel.dialed.transit_network_select)
261          */
262         int cid_tns;
263 };
264
265 /*!
266  * \since 1.6.3
267  * \brief Information needed to identify an endpoint in a call.
268  * \note All string fields here are malloc'ed, so they need to be
269  * freed when the structure is deleted.
270  * \note NULL and "" must be considered equivalent.
271  */
272 struct ast_party_id {
273         /*! \brief Subscriber phone number (Malloced) */
274         char *number;
275
276         /*! \brief Subscriber name (Malloced) */
277         char *name;
278
279         /*! \brief Q.931 encoded type-of-number/numbering-plan fields */
280         int number_type;
281
282         /*! \brief Q.931 encoded number presentation/screening fields */
283         int number_presentation;
284 };
285
286 /*!
287  * \since 1.6.3
288  * \brief Connected Line/Party information.
289  * \note All string fields here are malloc'ed, so they need to be
290  * freed when the structure is deleted.
291  * \note NULL and "" must be considered equivalent.
292  */
293 struct ast_party_connected_line {
294         struct ast_party_id id;         /*! \brief Connected party ID */
295
296         /*!
297          * \brief Automatic Number Identification (ANI) (Malloced)
298          * \note Not really part of connected line data but needed to
299          * save the corresponding caller id value.
300          */
301         char *ani;
302
303         /*!
304          * \brief Automatic Number Identification 2 (Info Digits)
305          * \note Not really part of connected line data but needed to
306          * save the corresponding caller id value.
307          */
308         int ani2;
309
310         /*! \brief Information about the source of an update (Q.SIG/ISDN requirement).
311          * \note enum AST_CONNECTED_LINE_UPDATE_SOURCE values
312          * for Normal-Answer, Call-transfer, Call-diversion
313          */
314         int source;
315 };
316
317 /*!
318  * \since 1.6.3
319  * \brief Redirecting Line information.
320  * RDNIS (Redirecting Directory Number Information Service)
321  * Where a call diversion or transfer was invoked.
322  * \note All string fields here are malloc'ed, so they need to be
323  * freed when the structure is deleted.
324  * \note NULL and "" must be considered equivalent.
325  */
326 struct ast_party_redirecting {
327         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) */
328         struct ast_party_id from;
329
330         /*! \brief Call is redirecting to a new party (Sent to the caller) */
331         struct ast_party_id to;
332
333         /*! \brief Number of times the call was redirected */
334         int count;
335
336         /*! \brief enum AST_REDIRECTING_REASON value for redirection */
337         int reason;
338 };
339
340 /*!
341  * \brief
342  * Structure to describe a channel "technology", ie a channel driver
343  * See for examples:
344  * \arg chan_iax2.c - The Inter-Asterisk exchange protocol
345  * \arg chan_sip.c - The SIP channel driver
346  * \arg chan_dahdi.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
347  *
348  * \details
349  * If you develop your own channel driver, this is where you
350  * tell the PBX at registration of your driver what properties
351  * this driver supports and where different callbacks are
352  * implemented.
353  */
354 struct ast_channel_tech {
355         const char * const type;
356         const char * const description;
357
358         int capabilities;               /*!< Bitmap of formats this channel can handle */
359
360         int properties;                 /*!< Technology Properties */
361
362         /*! \brief Requester - to set up call data structures (pvt's) */
363         struct ast_channel *(* const requester)(const char *type, int format, void *data, int *cause);
364
365         int (* const devicestate)(void *data);  /*!< Devicestate call back */
366
367         /*!
368          * \brief Start sending a literal DTMF digit
369          *
370          * \note The channel is not locked when this function gets called.
371          */
372         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
373
374         /*!
375          * \brief Stop sending a literal DTMF digit
376          *
377          * \note The channel is not locked when this function gets called.
378          */
379         int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
380
381         /*! \brief Call a given phone number (address, etc), but don't
382          *  take longer than timeout seconds to do so.  */
383         int (* const call)(struct ast_channel *chan, char *addr, int timeout);
384
385         /*! \brief Hangup (and possibly destroy) the channel */
386         int (* const hangup)(struct ast_channel *chan);
387
388         /*! \brief Answer the channel */
389         int (* const answer)(struct ast_channel *chan);
390
391         /*! \brief Read a frame, in standard format (see frame.h) */
392         struct ast_frame * (* const read)(struct ast_channel *chan);
393
394         /*! \brief Write a frame, in standard format (see frame.h) */
395         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
396
397         /*! \brief Display or transmit text */
398         int (* const send_text)(struct ast_channel *chan, const char *text);
399
400         /*! \brief Display or send an image */
401         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
402
403         /*! \brief Send HTML data */
404         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
405
406         /*! \brief Handle an exception, reading a frame */
407         struct ast_frame * (* const exception)(struct ast_channel *chan);
408
409         /*! \brief Bridge two channels of the same type together */
410         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
411                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
412
413         /*! \brief Bridge two channels of the same type together (early) */
414         enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
415
416         /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
417         int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
418
419         /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
420         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
421
422         /*! \brief Set a given option */
423         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
424
425         /*! \brief Query a given option */
426         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
427
428         /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
429         int (* const transfer)(struct ast_channel *chan, const char *newdest);
430
431         /*! \brief Write a frame, in standard format */
432         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
433
434         /*! \brief Write a text frame, in standard format */
435         int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
436
437         /*! \brief Find bridged channel */
438         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
439
440         /*! \brief Provide additional read items for CHANNEL() dialplan function */
441         int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
442
443         /*! \brief Provide additional write items for CHANNEL() dialplan function */
444         int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
445
446         /*! \brief Retrieve base channel (agent and local) */
447         struct ast_channel* (* get_base_channel)(struct ast_channel *chan);
448
449         /*! \brief Set base channel (agent and local) */
450         int (* set_base_channel)(struct ast_channel *chan, struct ast_channel *base);
451
452         /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
453         const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
454 };
455
456 struct ast_epoll_data;
457
458 /*!
459  * The high bit of the frame count is used as a debug marker, so
460  * increments of the counters must be done with care.
461  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
462  */
463 #define DEBUGCHAN_FLAG  0x80000000
464
465 /* XXX not ideal to evaluate x twice... */
466 #define FRAMECOUNT_INC(x)       ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
467
468 /*!
469  * The current value of the debug flags is stored in the two
470  * variables global_fin and global_fout (declared in main/channel.c)
471  */
472 extern unsigned long global_fin, global_fout;
473
474 enum ast_channel_adsicpe {
475         AST_ADSI_UNKNOWN,
476         AST_ADSI_AVAILABLE,
477         AST_ADSI_UNAVAILABLE,
478         AST_ADSI_OFFHOOKONLY,
479 };
480
481 /*!
482  * \brief ast_channel states
483  *
484  * \note Bits 0-15 of state are reserved for the state (up/down) of the line
485  *       Bits 16-32 of state are reserved for flags
486  */
487 enum ast_channel_state {
488         AST_STATE_DOWN,                 /*!< Channel is down and available */
489         AST_STATE_RESERVED,             /*!< Channel is down, but reserved */
490         AST_STATE_OFFHOOK,              /*!< Channel is off hook */
491         AST_STATE_DIALING,              /*!< Digits (or equivalent) have been dialed */
492         AST_STATE_RING,                 /*!< Line is ringing */
493         AST_STATE_RINGING,              /*!< Remote end is ringing */
494         AST_STATE_UP,                   /*!< Line is up */
495         AST_STATE_BUSY,                 /*!< Line is busy */
496         AST_STATE_DIALING_OFFHOOK,      /*!< Digits (or equivalent) have been dialed while offhook */
497         AST_STATE_PRERING,              /*!< Channel has detected an incoming call and is waiting for ring */
498
499         AST_STATE_MUTE = (1 << 16),     /*!< Do not transmit voice data */
500 };
501
502 /*!
503  * \brief Possible T38 states on channels
504  */
505 enum ast_t38_state {
506         T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
507         T38_STATE_UNKNOWN,      /*!< The channel supports T38 but the current status is unknown */
508         T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
509         T38_STATE_REJECTED,     /*!< Remote side has rejected our offer */
510         T38_STATE_NEGOTIATED,   /*!< T38 established */
511 };
512
513 /*!
514  * \page AstChannel ast_channel locking and reference tracking
515  *
516  * \par Creating Channels
517  * A channel is allocated using the ast_channel_alloc() function.  When created, it is
518  * automatically inserted into the main channels hash table that keeps track of all
519  * active channels in the system.  The hash key is based on the channel name.  Because
520  * of this, if you want to change the name, you _must_ use ast_change_name(), not change
521  * the name field directly.  When ast_channel_alloc() returns a channel pointer, you now
522  * hold a reference to that channel.  In most cases this reference is given to ast_pbx_run().
523  *
524  * \par Channel Locking
525  * There is a lock associated with every ast_channel.  It is allocated internally via astobj2.
526  * To lock or unlock a channel, you must use the ast_channel_lock() wrappers.
527  *
528  * Previously, before ast_channel was converted to astobj2, the channel lock was used in some
529  * additional ways that are no longer necessary.  Before, the only way to ensure that a channel
530  * did not disappear out from under you if you were working with a channel outside of the channel
531  * thread that owns it, was to hold the channel lock.  Now, that is no longer necessary.
532  * You simply must hold a reference to the channel to ensure it does not go away.
533  *
534  * The channel must be locked if you need to ensure that data that you reading from the channel
535  * does not change while you access it.  Further, you must hold the channel lock if you are
536  * making a non-atomic change to channel data.
537  *
538  * \par Channel References
539  * There are multiple ways to get a reference to a channel.  The first is that you hold a reference
540  * to a channel after creating it.  The other ways involve using the channel search or the channel
541  * traversal APIs.  These functions are the ast_channel_get_*() functions or ast_channel_iterator_*()
542  * functions.  Once a reference is retrieved by one of these methods, you know that the channel will
543  * not go away.  So, the channel should only get locked as needed for data access or modification.
544  * But, make sure that the reference gets released when you are done with it!
545  *
546  * There are different things you can do when you are done with a reference to a channel.  The first
547  * is to simply release the reference using ast_channel_unref().  The other option is to call
548  * ast_channel_release().  This function is generally used where ast_channel_free() was used in
549  * the past.  The release function releases a reference as well as ensures that the channel is no
550  * longer in the global channels container.  That way, the channel will get destroyed as soon as any
551  * other pending references get released.
552  *
553  * \par Exceptions to the rules
554  * Even though ast_channel is reference counted, there are some places where pointers to an ast_channel
555  * get stored, but the reference count does not reflect it.  The reason is mostly historical.
556  * The only places where this happens should be places where because of how the code works, we
557  * _know_ that the pointer to the channel will get removed before the channel goes away.  The main
558  * example of this is in channel drivers.  Channel drivers generally store a pointer to their owner
559  * ast_channel in their technology specific pvt struct.  In this case, the channel drivers _know_
560  * that this pointer to the channel will be removed in time, because the channel's hangup callback
561  * gets called before the channel goes away.
562  */
563
564 /*!
565  * \brief Main Channel structure associated with a channel.
566  *
567  * \note XXX It is important to remember to increment .cleancount each time
568  *       this structure is changed. XXX
569  *
570  * \note When adding fields to this structure, it is important to add the field
571  *       'in position' with like-aligned fields, so as to keep the compiler from
572  *       having to add padding to align fields. The structure's fields are sorted
573  *       in this order: pointers, structures, long, int/enum, short, char. This
574  *       is especially important on 64-bit architectures, where mixing 4-byte
575  *       and 8-byte fields causes 4 bytes of padding to be added before many
576  *       8-byte fields.
577  */
578 struct ast_channel {
579         const struct ast_channel_tech *tech;            /*!< Technology (point to channel driver) */
580         void *tech_pvt;                                 /*!< Private data used by the technology driver */
581         void *music_state;                              /*!< Music State*/
582         void *generatordata;                            /*!< Current generator data if there is any */
583         struct ast_generator *generator;                /*!< Current active data generator */
584         struct ast_channel *_bridge;                    /*!< Who are we bridged to, if we're bridged.
585                                                          *   Who is proxying for us, if we are proxied (i.e. chan_agent).
586                                                          *   Do not access directly, use ast_bridged_channel(chan) */
587         struct ast_channel *masq;                       /*!< Channel that will masquerade as us */
588         struct ast_channel *masqr;                      /*!< Who we are masquerading as */
589         const char *blockproc;                          /*!< Procedure causing blocking */
590         const char *appl;                               /*!< Current application */
591         const char *data;                               /*!< Data passed to current application */
592         struct sched_context *sched;                    /*!< Schedule context */
593         struct ast_filestream *stream;                  /*!< Stream itself. */
594         struct ast_filestream *vstream;                 /*!< Video Stream itself. */
595         int (*timingfunc)(const void *data);
596         void *timingdata;
597         struct ast_pbx *pbx;                            /*!< PBX private structure for this channel */
598         struct ast_trans_pvt *writetrans;               /*!< Write translation path */
599         struct ast_trans_pvt *readtrans;                /*!< Read translation path */
600         struct ast_audiohook_list *audiohooks;
601         struct ast_cdr *cdr;                            /*!< Call Detail Record */
602         struct ast_tone_zone *zone;                     /*!< Tone zone as set in indications.conf or
603                                                          *   in the CHANNEL dialplan function */
604         struct ast_channel_monitor *monitor;            /*!< Channel monitoring */
605 #ifdef HAVE_EPOLL
606         struct ast_epoll_data *epfd_data[AST_MAX_FDS];
607 #endif
608
609         AST_DECLARE_STRING_FIELDS(
610                 AST_STRING_FIELD(name);                 /*!< ASCII unique channel name */
611                 AST_STRING_FIELD(language);             /*!< Language requested for voice prompts */
612                 AST_STRING_FIELD(musicclass);           /*!< Default music class */
613                 AST_STRING_FIELD(accountcode);          /*!< Account code for billing */
614                 AST_STRING_FIELD(call_forward);         /*!< Where to forward to if asked to dial on this interface */
615                 AST_STRING_FIELD(uniqueid);             /*!< Unique Channel Identifier */
616                 AST_STRING_FIELD(parkinglot);           /*! Default parking lot, if empty, default parking lot  */
617                 AST_STRING_FIELD(dialcontext);          /*!< Dial: Extension context that we were called from */
618         );
619
620         struct timeval whentohangup;                    /*!< Non-zero, set to actual time when channel is to be hung up */
621         pthread_t blocker;                              /*!< If anyone is blocking, this is them */
622
623         /*!
624          * \brief Channel Caller ID information.
625          * \note The caller id information is the caller id of this
626          * channel when it is used to initiate a call.
627          */
628         struct ast_callerid cid;
629
630         /*!
631          * \brief Channel Connected Line ID information.
632          * \note The connected line information identifies the channel
633          * connected/bridged to this channel.
634          */
635         struct ast_party_connected_line connected;
636
637         /*!
638          * \brief Redirecting/Diversion information
639          * \note Until struct ast_channel.cid.cid_rdnis is replaced
640          * with ast_channel.redirecting.from.number, the
641          * ast_channel.redirecting.from.number field is not used.
642          */
643         struct ast_party_redirecting redirecting;
644
645         struct ast_frame dtmff;                         /*!< DTMF frame */
646         struct varshead varshead;                       /*!< A linked list for channel variables. See \ref AstChanVar */
647         ast_group_t callgroup;                          /*!< Call group for call pickups */
648         ast_group_t pickupgroup;                        /*!< Pickup group - which calls groups can be picked up? */
649         AST_LIST_HEAD_NOLOCK(, ast_frame) readq;
650         AST_LIST_ENTRY(ast_channel) chan_list;          /*!< For easy linking */
651         struct ast_jb jb;                               /*!< The jitterbuffer state */
652         struct timeval dtmf_tv;                         /*!< The time that an in process digit began, or the last digit ended */
653         AST_LIST_HEAD_NOLOCK(datastores, ast_datastore) datastores; /*!< Data stores on the channel */
654         AST_LIST_HEAD_NOLOCK(autochans, ast_autochan) autochans; /*!< Autochans on the channel */
655
656         unsigned long insmpl;                           /*!< Track the read/written samples for monitor use */
657         unsigned long outsmpl;                          /*!< Track the read/written samples for monitor use */
658
659         int fds[AST_MAX_FDS];                           /*!< File descriptors for channel -- Drivers will poll on
660                                                          *   these file descriptors, so at least one must be non -1.
661                                                          *   See \arg \ref AstFileDesc */
662         int cdrflags;                                   /*!< Call Detail Record Flags */
663         int _softhangup;                                /*!< Whether or not we have been hung up...  Do not set this value
664                                                          *   directly, use ast_softhangup() */
665         int fdno;                                       /*!< Which fd had an event detected on */
666         int streamid;                                   /*!< For streaming playback, the schedule ID */
667         int vstreamid;                                  /*!< For streaming video playback, the schedule ID */
668         int oldwriteformat;                             /*!< Original writer format */
669         int timingfd;                                   /*!< Timing fd */
670         enum ast_channel_state _state;                  /*!< State of line -- Don't write directly, use ast_setstate() */
671         int rings;                                      /*!< Number of rings so far */
672         int priority;                                   /*!< Dialplan: Current extension priority */
673         int macropriority;                              /*!< Macro: Current non-macro priority. See app_macro.c */
674         int amaflags;                                   /*!< Set BEFORE PBX is started to determine AMA flags */
675         enum ast_channel_adsicpe adsicpe;               /*!< Whether or not ADSI is detected on CPE */
676         unsigned int fin;                               /*!< Frames in counters. The high bit is a debug mask, so
677                                                          *   the counter is only in the remaining bits */
678         unsigned int fout;                              /*!< Frames out counters. The high bit is a debug mask, so
679                                                          *   the counter is only in the remaining bits */
680         int hangupcause;                                /*!< Why is the channel hanged up. See causes.h */
681         unsigned int flags;                             /*!< channel flags of AST_FLAG_ type */
682         int alertpipe[2];
683         int nativeformats;                              /*!< Kinds of data this channel can natively handle */
684         int readformat;                                 /*!< Requested read format */
685         int writeformat;                                /*!< Requested write format */
686         int rawreadformat;                              /*!< Raw read format */
687         int rawwriteformat;                             /*!< Raw write format */
688         unsigned int emulate_dtmf_duration;             /*!< Number of ms left to emulate DTMF for */
689 #ifdef HAVE_EPOLL
690         int epfd;
691 #endif
692         int visible_indication;                         /*!< Indication currently playing on the channel */
693
694         unsigned short transfercapability;              /*!< ISDN Transfer Capability - AST_FLAG_DIGITAL is not enough */
695
696         struct ast_bridge *bridge;                      /*!< Bridge this channel is participating in */
697         struct ast_timer *timer;                        /*!< timer object that provided timingfd */
698
699         char context[AST_MAX_CONTEXT];                  /*!< Dialplan: Current extension context */
700         char exten[AST_MAX_EXTENSION];                  /*!< Dialplan: Current extension number */
701         char macrocontext[AST_MAX_CONTEXT];             /*!< Macro: Current non-macro context. See app_macro.c */
702         char macroexten[AST_MAX_EXTENSION];             /*!< Macro: Current non-macro extension. See app_macro.c */
703         char emulate_dtmf_digit;                        /*!< Digit being emulated */
704 };
705
706 /*! \brief ast_channel_tech Properties */
707 enum {
708         /*!
709      * \brief Channels have this property if they can accept input with jitter;
710          * i.e. most VoIP channels
711          */
712         AST_CHAN_TP_WANTSJITTER = (1 << 0),
713         /*!
714      * \brief Channels have this property if they can create jitter;
715          * i.e. most VoIP channels
716          */
717         AST_CHAN_TP_CREATESJITTER = (1 << 1),
718 };
719
720 /*! \brief ast_channel flags */
721 enum {
722         /*! Queue incoming DTMF, to be released when this flag is turned off */
723         AST_FLAG_DEFER_DTMF =    (1 << 1),
724         /*! write should be interrupt generator */
725         AST_FLAG_WRITE_INT =     (1 << 2),
726         /*! a thread is blocking on this channel */
727         AST_FLAG_BLOCKING =      (1 << 3),
728         /*! This is a zombie channel */
729         AST_FLAG_ZOMBIE =        (1 << 4),
730         /*! There is an exception pending */
731         AST_FLAG_EXCEPTION =     (1 << 5),
732         /*! Listening to moh XXX anthm promises me this will disappear XXX */
733         AST_FLAG_MOH =           (1 << 6),
734         /*! This channel is spying on another channel */
735         AST_FLAG_SPYING =        (1 << 7),
736         /*! This channel is in a native bridge */
737         AST_FLAG_NBRIDGE =       (1 << 8),
738         /*! the channel is in an auto-incrementing dialplan processor,
739          *  so when ->priority is set, it will get incremented before
740          *  finding the next priority to run */
741         AST_FLAG_IN_AUTOLOOP =   (1 << 9),
742         /*! This is an outgoing call */
743         AST_FLAG_OUTGOING =      (1 << 10),
744         /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
745         AST_FLAG_IN_DTMF =       (1 << 12),
746         /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
747          *  currently being emulated */
748         AST_FLAG_EMULATE_DTMF =  (1 << 13),
749         /*! This is set to tell the channel not to generate DTMF begin frames, and
750          *  to instead only generate END frames. */
751         AST_FLAG_END_DTMF_ONLY = (1 << 14),
752         /*! Flag to show channels that this call is hangup due to the fact that the call
753             was indeed answered, but in another channel */
754         AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15),
755         /*! This flag indicates that on a masquerade, an active stream should not
756          *  be carried over */
757         AST_FLAG_MASQ_NOSTREAM = (1 << 16),
758         /*! This flag indicates that the hangup exten was run when the bridge terminated,
759          *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
760          *  level */
761         AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
762         /*! This flag indicates that the hangup exten should NOT be run when the
763          *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
764          *  */
765         AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
766 };
767
768 /*! \brief ast_bridge_config flags */
769 enum {
770         AST_FEATURE_PLAY_WARNING = (1 << 0),
771         AST_FEATURE_REDIRECT =     (1 << 1),
772         AST_FEATURE_DISCONNECT =   (1 << 2),
773         AST_FEATURE_ATXFER =       (1 << 3),
774         AST_FEATURE_AUTOMON =      (1 << 4),
775         AST_FEATURE_PARKCALL =     (1 << 5),
776         AST_FEATURE_AUTOMIXMON =   (1 << 6),
777         AST_FEATURE_NO_H_EXTEN =   (1 << 7),
778         AST_FEATURE_WARNING_ACTIVE = (1 << 8),
779 };
780
781 /*! \brief bridge configuration */
782 struct ast_bridge_config {
783         struct ast_flags features_caller;
784         struct ast_flags features_callee;
785         struct timeval start_time;
786         struct timeval nexteventts;
787         struct timeval feature_start_time;
788         long feature_timer;
789         long timelimit;
790         long play_warning;
791         long warning_freq;
792         const char *warning_sound;
793         const char *end_sound;
794         const char *start_sound;
795         unsigned int flags;
796         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
797         void *end_bridge_callback_data;         /*!< Data passed to the callback */
798         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
799          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
800          */
801         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
802 };
803
804 struct chanmon;
805
806 struct outgoing_helper {
807         const char *context;
808         const char *exten;
809         int priority;
810         const char *cid_num;
811         const char *cid_name;
812         const char *account;
813         struct ast_variable *vars;
814         struct ast_channel *parent_channel;
815 };
816
817 enum {
818         AST_CDR_TRANSFER =   (1 << 0),
819         AST_CDR_FORWARD =    (1 << 1),
820         AST_CDR_CALLWAIT =   (1 << 2),
821         AST_CDR_CONFERENCE = (1 << 3),
822 };
823
824 enum {
825         /*! Soft hangup by device */
826         AST_SOFTHANGUP_DEV =       (1 << 0),
827         /*! Soft hangup for async goto */
828         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
829         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
830         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
831         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
832         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
833         AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
834 };
835
836
837 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
838 enum channelreloadreason {
839         CHANNEL_MODULE_LOAD,
840         CHANNEL_MODULE_RELOAD,
841         CHANNEL_CLI_RELOAD,
842         CHANNEL_MANAGER_RELOAD,
843 };
844
845 /*!
846  * \note None of the datastore API calls lock the ast_channel they are using.
847  *       So, the channel should be locked before calling the functions that
848  *       take a channel argument.
849  */
850
851 /*!
852  * \brief Create a channel data store object
853  * \deprecated You should use the ast_datastore_alloc() generic function instead.
854  * \version 1.6.1 deprecated
855  */
856 struct ast_datastore *ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
857         __attribute__((deprecated));
858
859 /*!
860  * \brief Free a channel data store object
861  * \deprecated You should use the ast_datastore_free() generic function instead.
862  * \version 1.6.1 deprecated
863  */
864 int ast_channel_datastore_free(struct ast_datastore *datastore)
865         __attribute__((deprecated));
866
867 /*! \brief Inherit datastores from a parent to a child. */
868 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
869
870 /*!
871  * \brief Add a datastore to a channel
872  *
873  * \note The channel should be locked before calling this function.
874  *
875  * \retval 0 success
876  * \retval non-zero failure
877  */
878 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
879
880 /*!
881  * \brief Remove a datastore from a channel
882  *
883  * \note The channel should be locked before calling this function.
884  *
885  * \retval 0 success
886  * \retval non-zero failure
887  */
888 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
889
890 /*!
891  * \brief Find a datastore on a channel
892  *
893  * \note The channel should be locked before calling this function.
894  *
895  * \note The datastore returned from this function must not be used if the
896  *       reference to the channel is released.
897  *
898  * \retval pointer to the datastore if found
899  * \retval NULL if not found
900  */
901 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
902
903 /*! \brief Change the state of a channel */
904 int ast_setstate(struct ast_channel *chan, enum ast_channel_state);
905
906 /*!
907  * \brief Create a channel structure
908  *
909  * \retval NULL failure
910  * \retval non-NULL successfully allocated channel
911  *
912  * \note By default, new channels are set to the "s" extension
913  *       and "default" context.
914  */
915 struct ast_channel *ast_channel_alloc(int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const int amaflag, const char *name_fmt, ...) __attribute__((format(printf, 9, 10)));
916
917 /*!
918  * \brief Queue an outgoing frame
919  *
920  * \note The channel does not need to be locked before calling this function.
921  */
922 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
923
924 /*!
925  * \brief Queue an outgoing frame to the head of the frame queue
926  *
927  * \param chan the channel to queue the frame on
928  * \param f the frame to queue.  Note that this frame will be duplicated by
929  *        this function.  It is the responsibility of the caller to handle
930  *        freeing the memory associated with the frame being passed if
931  *        necessary.
932  *
933  * \retval 0 success
934  * \retval non-zero failure
935  */
936 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
937
938 /*!
939  * \brief Queue a hangup frame
940  *
941  * \note The channel does not need to be locked before calling this function.
942  */
943 int ast_queue_hangup(struct ast_channel *chan);
944
945 /*!
946  * \brief Queue a hangup frame with hangupcause set
947  *
948  * \note The channel does not need to be locked before calling this function.
949  * \param[in] chan channel to queue frame onto
950  * \param[in] cause the hangup cause
951  * \return 0 on success, -1 on error
952  * \since 1.6.1
953  */
954 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
955
956 /*!
957  * \brief Queue a control frame with payload
958  *
959  * \param chan channel to queue frame onto
960  * \param control type of control frame
961  *
962  * \note The channel does not need to be locked before calling this function.
963  *
964  * \retval zero on success
965  * \retval non-zero on failure
966  */
967 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
968
969 /*!
970  * \brief Queue a control frame with payload
971  *
972  * \param chan channel to queue frame onto
973  * \param control type of control frame
974  * \param data pointer to payload data to be included in frame
975  * \param datalen number of bytes of payload data
976  *
977  * \retval 0 success
978  * \retval non-zero failure
979  *
980  * \details
981  * The supplied payload data is copied into the frame, so the caller's copy
982  * is not modified nor freed, and the resulting frame will retain a copy of
983  * the data even if the caller frees their local copy.
984  *
985  * \note This method should be treated as a 'network transport'; in other
986  * words, your frames may be transferred across an IAX2 channel to another
987  * system, which may be a different endianness than yours. Because of this,
988  * you should ensure that either your frames will never be expected to work
989  * across systems, or that you always put your payload data into 'network byte
990  * order' before calling this function.
991  *
992  * \note The channel does not need to be locked before calling this function.
993  */
994 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
995                            const void *data, size_t datalen);
996
997 /*!
998  * \brief Change channel name
999  *
1000  * \pre The channel must be locked before calling this function.
1001  *
1002  * \param chan the channel to change the name of
1003  * \param newname the name to change to
1004  *
1005  * \return nothing
1006  */
1007 void ast_change_name(struct ast_channel *chan, const char *newname);
1008
1009 /*!
1010  * \brief Unlink and release reference to a channel
1011  *
1012  * This function will unlink the channel from the global channels container
1013  * if it is still there and also release the current reference to the channel.
1014  *
1015  * \return NULL, convenient for clearing invalid pointers
1016  */
1017 struct ast_channel *ast_channel_release(struct ast_channel *chan);
1018
1019 /*!
1020  * \brief Requests a channel
1021  *
1022  * \param type type of channel to request
1023  * \param format requested channel format (codec)
1024  * \param data data to pass to the channel requester
1025  * \param status status
1026  *
1027  * \details
1028  * Request a channel of a given type, with data as optional information used
1029  * by the low level module
1030  *
1031  * \retval NULL failure
1032  * \retval non-NULL channel on success
1033  */
1034 struct ast_channel *ast_request(const char *type, int format, void *data, int *status);
1035
1036 /*!
1037  * \brief Request a channel of a given type, with data as optional information used
1038  *        by the low level module and attempt to place a call on it
1039  *
1040  * \param type type of channel to request
1041  * \param format requested channel format
1042  * \param data data to pass to the channel requester
1043  * \param timeout maximum amount of time to wait for an answer
1044  * \param reason why unsuccessful (if unsuccessful)
1045  * \param cid_num Caller-ID Number
1046  * \param cid_name Caller-ID Name (ascii)
1047  *
1048  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1049  * to know if the call was answered or not.
1050  */
1051 struct ast_channel *ast_request_and_dial(const char *type, int format, void *data,
1052         int timeout, int *reason, const char *cid_num, const char *cid_name);
1053
1054 /*!
1055  * \brief Request a channel of a given type, with data as optional information used
1056  * by the low level module and attempt to place a call on it
1057  * \param type type of channel to request
1058  * \param format requested channel format
1059  * \param data data to pass to the channel requester
1060  * \param timeout maximum amount of time to wait for an answer
1061  * \param reason why unsuccessful (if unsuccessful)
1062  * \param cid_num Caller-ID Number
1063  * \param cid_name Caller-ID Name (ascii)
1064  * \param oh Outgoing helper
1065  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1066  * to know if the call was answered or not.
1067  */
1068 struct ast_channel *__ast_request_and_dial(const char *type, int format, void *data,
1069         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1070
1071 /*!
1072  * \brief Register a channel technology (a new channel driver)
1073  * Called by a channel module to register the kind of channels it supports.
1074  * \param tech Structure defining channel technology or "type"
1075  * \return Returns 0 on success, -1 on failure.
1076  */
1077 int ast_channel_register(const struct ast_channel_tech *tech);
1078
1079 /*!
1080  * \brief Unregister a channel technology
1081  * \param tech Structure defining channel technology or "type" that was previously registered
1082  * \return No return value.
1083  */
1084 void ast_channel_unregister(const struct ast_channel_tech *tech);
1085
1086 /*!
1087  * \brief Get a channel technology structure by name
1088  * \param name name of technology to find
1089  * \return a pointer to the structure, or NULL if no matching technology found
1090  */
1091 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1092
1093 #ifdef CHANNEL_TRACE
1094 /*!
1095  * \brief Update the context backtrace if tracing is enabled
1096  * \return Returns 0 on success, -1 on failure
1097  */
1098 int ast_channel_trace_update(struct ast_channel *chan);
1099
1100 /*!
1101  * \brief Enable context tracing in the channel
1102  * \return Returns 0 on success, -1 on failure
1103  */
1104 int ast_channel_trace_enable(struct ast_channel *chan);
1105
1106 /*!
1107  * \brief Disable context tracing in the channel.
1108  * \note Does not remove current trace entries
1109  * \return Returns 0 on success, -1 on failure
1110  */
1111 int ast_channel_trace_disable(struct ast_channel *chan);
1112
1113 /*!
1114  * \brief Whether or not context tracing is enabled
1115  * \return Returns -1 when the trace is enabled. 0 if not.
1116  */
1117 int ast_channel_trace_is_enabled(struct ast_channel *chan);
1118
1119 /*!
1120  * \brief Put the channel backtrace in a string
1121  * \return Returns the amount of lines in the backtrace. -1 on error.
1122  */
1123 int ast_channel_trace_serialize(struct ast_channel *chan, struct ast_str **out);
1124 #endif
1125
1126 /*!
1127  * \brief Hang up a channel
1128  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
1129  * performs all stream stopping, etc, on the channel that needs to end.
1130  * chan is no longer valid after this call.
1131  * \param chan channel to hang up
1132  * \return Returns 0 on success, -1 on failure.
1133  */
1134 int ast_hangup(struct ast_channel *chan);
1135
1136 /*!
1137  * \brief Softly hangup up a channel
1138  *
1139  * \param chan channel to be soft-hung-up
1140  * \param cause Ast hangupcause for hangup
1141  *
1142  * \details
1143  * Call the protocol layer, but don't destroy the channel structure
1144  * (use this if you are trying to
1145  * safely hangup a channel managed by another thread.
1146  *
1147  * \note The channel passed to this function does not need to be locked.
1148  *
1149  * \return Returns 0 regardless
1150  */
1151 int ast_softhangup(struct ast_channel *chan, int cause);
1152
1153 /*!
1154  * \brief Softly hangup up a channel (no channel lock)
1155  * \param chan channel to be soft-hung-up
1156  * \param cause Ast hangupcause for hangup (see cause.h)
1157  */
1158 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
1159
1160 /*! \brief Check to see if a channel is needing hang up
1161  * \param chan channel on which to check for hang up
1162  * This function determines if the channel is being requested to be hung up.
1163  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1164  */
1165 int ast_check_hangup(struct ast_channel *chan);
1166
1167 int ast_check_hangup_locked(struct ast_channel *chan);
1168
1169 /*!
1170  * \brief Compare a offset with the settings of when to hang a channel up
1171  * \param chan channel on which to check for hang up
1172  * \param offset offset in seconds from current time
1173  * \return 1, 0, or -1
1174  * \details
1175  * This function compares a offset from current time with the absolute time
1176  * out on a channel (when to hang up). If the absolute time out on a channel
1177  * is earlier than current time plus the offset, it returns 1, if the two
1178  * time values are equal, it return 0, otherwise, it return -1.
1179  * \sa ast_channel_cmpwhentohangup_tv()
1180  * \version 1.6.1 deprecated function (only had seconds precision)
1181  */
1182 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1183
1184 /*!
1185  * \brief Compare a offset with the settings of when to hang a channel up
1186  * \param chan channel on which to check for hangup
1187  * \param offset offset in seconds and microseconds from current time
1188  * \return 1, 0, or -1
1189  * This function compares a offset from current time with the absolute time
1190  * out on a channel (when to hang up). If the absolute time out on a channel
1191  * is earlier than current time plus the offset, it returns 1, if the two
1192  * time values are equal, it return 0, otherwise, it return -1.
1193  * \since 1.6.1
1194  */
1195 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1196
1197 /*!
1198  * \brief Set when to hang a channel up
1199  *
1200  * \param chan channel on which to check for hang up
1201  * \param offset offset in seconds relative to the current time of when to hang up
1202  *
1203  * \details
1204  * This function sets the absolute time out on a channel (when to hang up).
1205  *
1206  * \note This function does not require that the channel is locked before
1207  *       calling it.
1208  *
1209  * \return Nothing
1210  * \sa ast_channel_setwhentohangup_tv()
1211  * \version 1.6.1 deprecated function (only had seconds precision)
1212  */
1213 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1214
1215 /*!
1216  * \brief Set when to hang a channel up
1217  *
1218  * \param chan channel on which to check for hang up
1219  * \param offset offset in seconds and useconds relative to the current time of when to hang up
1220  *
1221  * This function sets the absolute time out on a channel (when to hang up).
1222  *
1223  * \note This function does not require that the channel is locked before
1224  * calling it.
1225  *
1226  * \return Nothing
1227  * \since 1.6.1
1228  */
1229 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1230
1231 /*!
1232  * \brief Answer a channel
1233  *
1234  * \param chan channel to answer
1235  *
1236  * \details
1237  * This function answers a channel and handles all necessary call
1238  * setup functions.
1239  *
1240  * \note The channel passed does not need to be locked, but is locked
1241  * by the function when needed.
1242  *
1243  * \note This function will wait up to 500 milliseconds for media to
1244  * arrive on the channel before returning to the caller, so that the
1245  * caller can properly assume the channel is 'ready' for media flow.
1246  *
1247  * \retval 0 on success
1248  * \retval non-zero on failure
1249  */
1250 int ast_answer(struct ast_channel *chan);
1251
1252 /*!
1253  * \brief Answer a channel
1254  *
1255  * \param chan channel to answer
1256  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1257  *
1258  * This function answers a channel and handles all necessary call
1259  * setup functions.
1260  *
1261  * \note The channel passed does not need to be locked, but is locked
1262  * by the function when needed.
1263  *
1264  * \note Unlike ast_answer(), this function will not wait for media
1265  * flow to begin. The caller should be careful before sending media
1266  * to the channel before incoming media arrives, as the outgoing
1267  * media may be lost.
1268  *
1269  * \retval 0 on success
1270  * \retval non-zero on failure
1271  */
1272 int ast_raw_answer(struct ast_channel *chan, int cdr_answer);
1273
1274 /*!
1275  * \brief Answer a channel, with a selectable delay before returning
1276  *
1277  * \param chan channel to answer
1278  * \param delay maximum amount of time to wait for incoming media
1279  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1280  *
1281  * This function answers a channel and handles all necessary call
1282  * setup functions.
1283  *
1284  * \note The channel passed does not need to be locked, but is locked
1285  * by the function when needed.
1286  *
1287  * \note This function will wait up to 'delay' milliseconds for media to
1288  * arrive on the channel before returning to the caller, so that the
1289  * caller can properly assume the channel is 'ready' for media flow. If
1290  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1291  *
1292  * \retval 0 on success
1293  * \retval non-zero on failure
1294  */
1295 int __ast_answer(struct ast_channel *chan, unsigned int delay, int cdr_answer);
1296
1297 /*!
1298  * \brief Make a call
1299  * \param chan which channel to make the call on
1300  * \param addr destination of the call
1301  * \param timeout time to wait on for connect
1302  * \details
1303  * Place a call, take no longer than timeout ms.
1304  * \return -1 on failure, 0 on not enough time
1305  * (does not automatically stop ringing), and
1306  * the number of seconds the connect took otherwise.
1307  */
1308 int ast_call(struct ast_channel *chan, char *addr, int timeout);
1309
1310 /*!
1311  * \brief Indicates condition of channel
1312  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1313  * \param chan channel to change the indication
1314  * \param condition which condition to indicate on the channel
1315  * \return Returns 0 on success, -1 on failure
1316  */
1317 int ast_indicate(struct ast_channel *chan, int condition);
1318
1319 /*!
1320  * \brief Indicates condition of channel, with payload
1321  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1322  * \param chan channel to change the indication
1323  * \param condition which condition to indicate on the channel
1324  * \param data pointer to payload data
1325  * \param datalen size of payload data
1326  * \return Returns 0 on success, -1 on failure
1327  */
1328 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1329
1330 /* Misc stuff ------------------------------------------------ */
1331
1332 /*!
1333  * \brief Wait for input on a channel
1334  * \param chan channel to wait on
1335  * \param ms length of time to wait on the channel
1336  * \details
1337  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1338  * \retval < 0 on failure
1339  * \retval 0 if nothing ever arrived
1340  * \retval the # of ms remaining otherwise
1341  */
1342 int ast_waitfor(struct ast_channel *chan, int ms);
1343
1344 /*!
1345  * \brief Wait for a specified amount of time, looking for hangups
1346  * \param chan channel to wait for
1347  * \param ms length of time in milliseconds to sleep
1348  * \details
1349  * Waits for a specified amount of time, servicing the channel as required.
1350  * \return returns -1 on hangup, otherwise 0.
1351  */
1352 int ast_safe_sleep(struct ast_channel *chan, int ms);
1353
1354 /*!
1355  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
1356  * \param chan channel to wait for
1357  * \param ms length of time in milliseconds to sleep
1358  * \param cond a function pointer for testing continue condition
1359  * \param data argument to be passed to the condition test function
1360  * \return returns -1 on hangup, otherwise 0.
1361  * \details
1362  * Waits for a specified amount of time, servicing the channel as required. If cond
1363  * returns 0, this function returns.
1364  */
1365 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1366
1367 /*!
1368  * \brief Waits for activity on a group of channels
1369  * \param chan an array of pointers to channels
1370  * \param n number of channels that are to be waited upon
1371  * \param fds an array of fds to wait upon
1372  * \param nfds the number of fds to wait upon
1373  * \param exception exception flag
1374  * \param outfd fd that had activity on it
1375  * \param ms how long the wait was
1376  * \details
1377  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1378  * file descriptors.
1379  * \return Returns the channel with activity, or NULL on error or if an FD
1380  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1381  * will be -1
1382  */
1383 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1384         int *fds, int nfds, int *exception, int *outfd, int *ms);
1385
1386 /*!
1387  * \brief Waits for input on a group of channels
1388  * Wait for input on an array of channels for a given # of milliseconds.
1389  * \return Return channel with activity, or NULL if none has activity.
1390  * \param chan an array of pointers to channels
1391  * \param n number of channels that are to be waited upon
1392  * \param ms time "ms" is modified in-place, if applicable
1393  */
1394 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1395
1396 /*!
1397  * \brief Waits for input on an fd
1398  * \note This version works on fd's only.  Be careful with it.
1399  */
1400 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1401
1402
1403 /*!
1404  * \brief Reads a frame
1405  * \param chan channel to read a frame from
1406  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1407  * best just stop reading frames and assume the channel has been
1408  * disconnected.
1409  */
1410 struct ast_frame *ast_read(struct ast_channel *chan);
1411
1412 /*!
1413  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
1414  * \param chan channel to read a frame from
1415  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
1416  * best just stop reading frames and assume the channel has been
1417  * disconnected.
1418  * \note Audio is replaced with AST_FRAME_NULL to avoid
1419  * transcode when the resulting audio is not necessary.
1420  */
1421 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1422
1423 /*!
1424  * \brief Write a frame to a channel
1425  * This function writes the given frame to the indicated channel.
1426  * \param chan destination channel of the frame
1427  * \param frame frame that will be written
1428  * \return It returns 0 on success, -1 on failure.
1429  */
1430 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1431
1432 /*!
1433  * \brief Write video frame to a channel
1434  * This function writes the given frame to the indicated channel.
1435  * \param chan destination channel of the frame
1436  * \param frame frame that will be written
1437  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1438  */
1439 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1440
1441 /*!
1442  * \brief Write text frame to a channel
1443  * This function writes the given frame to the indicated channel.
1444  * \param chan destination channel of the frame
1445  * \param frame frame that will be written
1446  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1447  */
1448 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1449
1450 /*! \brief Send empty audio to prime a channel driver */
1451 int ast_prod(struct ast_channel *chan);
1452
1453 /*!
1454  * \brief Sets read format on channel chan
1455  * Set read format for channel to whichever component of "format" is best.
1456  * \param chan channel to change
1457  * \param format format to change to
1458  * \return Returns 0 on success, -1 on failure
1459  */
1460 int ast_set_read_format(struct ast_channel *chan, int format);
1461
1462 /*!
1463  * \brief Sets write format on channel chan
1464  * Set write format for channel to whichever component of "format" is best.
1465  * \param chan channel to change
1466  * \param format new format for writing
1467  * \return Returns 0 on success, -1 on failure
1468  */
1469 int ast_set_write_format(struct ast_channel *chan, int format);
1470
1471 /*!
1472  * \brief Sends text to a channel
1473  *
1474  * \param chan channel to act upon
1475  * \param text string of text to send on the channel
1476  *
1477  * \details
1478  * Write text to a display on a channel
1479  *
1480  * \note The channel does not need to be locked before calling this function.
1481  *
1482  * \retval 0 on success
1483  * \retval -1 on failure
1484  */
1485 int ast_sendtext(struct ast_channel *chan, const char *text);
1486
1487 /*!
1488  * \brief Receives a text character from a channel
1489  * \param chan channel to act upon
1490  * \param timeout timeout in milliseconds (0 for infinite wait)
1491  * \details
1492  * Read a char of text from a channel
1493  * \return 0 on success, -1 on failure
1494  */
1495 int ast_recvchar(struct ast_channel *chan, int timeout);
1496
1497 /*!
1498  * \brief Send a DTMF digit to a channel.
1499  * \param chan channel to act upon
1500  * \param digit the DTMF digit to send, encoded in ASCII
1501  * \param duration the duration of the digit ending in ms
1502  * \return 0 on success, -1 on failure
1503  */
1504 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
1505
1506 /*!
1507  * \brief Send a DTMF digit to a channel.
1508  * \param chan channel to act upon
1509  * \param digit the DTMF digit to send, encoded in ASCII
1510  * \return 0 on success, -1 on failure
1511  */
1512 int ast_senddigit_begin(struct ast_channel *chan, char digit);
1513
1514 /*!
1515  * \brief Send a DTMF digit to a channel.
1516  * \param chan channel to act upon
1517  * \param digit the DTMF digit to send, encoded in ASCII
1518  * \param duration the duration of the digit ending in ms
1519  * \return Returns 0 on success, -1 on failure
1520  */
1521 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
1522
1523 /*!
1524  * \brief Receives a text string from a channel
1525  * Read a string of text from a channel
1526  * \param chan channel to act upon
1527  * \param timeout timeout in milliseconds (0 for infinite wait)
1528  * \return the received text, or NULL to signify failure.
1529  */
1530 char *ast_recvtext(struct ast_channel *chan, int timeout);
1531
1532 /*!
1533  * \brief Waits for a digit
1534  * \param c channel to wait for a digit on
1535  * \param ms how many milliseconds to wait
1536  * \return Returns <0 on error, 0 on no entry, and the digit on success.
1537  */
1538 int ast_waitfordigit(struct ast_channel *c, int ms);
1539
1540 /*!
1541  * \brief Wait for a digit
1542  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
1543  * \param c channel to wait for a digit on
1544  * \param ms how many milliseconds to wait
1545  * \param audiofd audio file descriptor to write to if audio frames are received
1546  * \param ctrlfd control file descriptor to monitor for reading
1547  * \return Returns 1 if ctrlfd becomes available
1548  */
1549 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
1550
1551 /*!
1552  * \brief Reads multiple digits
1553  * \param c channel to read from
1554  * \param s string to read in to.  Must be at least the size of your length
1555  * \param len how many digits to read (maximum)
1556  * \param timeout how long to timeout between digits
1557  * \param rtimeout timeout to wait on the first digit
1558  * \param enders digits to end the string
1559  * \details
1560  * Read in a digit string "s", max length "len", maximum timeout between
1561  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
1562  * for the first digit.
1563  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
1564  * a timeout, any digits that were read before the timeout will still be available in s.
1565  * RETURNS 2 in full version when ctrlfd is available, NOT 1
1566  */
1567 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
1568 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
1569
1570 /*! \brief Report DTMF on channel 0 */
1571 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
1572 /*! \brief Report DTMF on channel 1 */
1573 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
1574 /*! \brief Return all voice frames on channel 0 */
1575 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)
1576 /*! \brief Return all voice frames on channel 1 */
1577 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)
1578 /*! \brief Ignore all signal frames except NULL */
1579 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)
1580
1581
1582 /*!
1583  * \brief Makes two channel formats compatible
1584  * \param c0 first channel to make compatible
1585  * \param c1 other channel to make compatible
1586  * \details
1587  * Set two channels to compatible formats -- call before ast_channel_bridge in general.
1588  * \return Returns 0 on success and -1 if it could not be done
1589  */
1590 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
1591
1592 /*!
1593  * \brief Bridge two channels together (early)
1594  * \param c0 first channel to bridge
1595  * \param c1 second channel to bridge
1596  * \details
1597  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
1598  * \return Returns 0 on success and -1 if it could not be done
1599  */
1600 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1601
1602 /*!
1603  * \brief Bridge two channels together
1604  * \param c0 first channel to bridge
1605  * \param c1 second channel to bridge
1606  * \param config config for the channels
1607  * \param fo destination frame(?)
1608  * \param rc destination channel(?)
1609  * \details
1610  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
1611  * *rf (remember, it could be NULL) and which channel (0 or 1) in rc
1612  */
1613 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
1614 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,
1615         struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
1616
1617 /*!
1618  * \brief Weird function made for call transfers
1619  *
1620  * \param original channel to make a copy of
1621  * \param clone copy of the original channel
1622  *
1623  * \details
1624  * This is a very strange and freaky function used primarily for transfer.  Suppose that
1625  * "original" and "clone" are two channels in random situations.  This function takes
1626  * the guts out of "clone" and puts them into the "original" channel, then alerts the
1627  * channel driver of the change, asking it to fixup any private information (like the
1628  * p->owner pointer) that is affected by the change.  The physical layer of the original
1629  * channel is hung up.
1630  *
1631  * \note Neither channel passed here needs to be locked before calling this function.
1632  */
1633 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
1634
1635 /*!
1636  * \brief Gives the string form of a given cause code.
1637  *
1638  * \param state cause to get the description of
1639  * \return the text form of the binary cause code given
1640  */
1641 const char *ast_cause2str(int state) attribute_pure;
1642
1643 /*!
1644  * \brief Convert the string form of a cause code to a number
1645  *
1646  * \param name string form of the cause
1647  * \return the cause code
1648  */
1649 int ast_str2cause(const char *name) attribute_pure;
1650
1651 /*!
1652  * \brief Gives the string form of a given channel state
1653  *
1654  * \param ast_channel_state state to get the name of
1655  * \return the text form of the binary state given
1656  */
1657 const char *ast_state2str(enum ast_channel_state);
1658
1659 /*!
1660  * \brief Gives the string form of a given transfer capability
1661  *
1662  * \param transfercapability transfer capability to get the name of
1663  * \return the text form of the binary transfer capability
1664  */
1665 char *ast_transfercapability2str(int transfercapability) attribute_const;
1666
1667 /*
1668  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
1669  * low level channel.  See frame.h for options.  Note that many channel drivers may support
1670  * none or a subset of those features, and you should not count on this if you want your
1671  * asterisk application to be portable.  They're mainly useful for tweaking performance
1672  */
1673
1674 /*!
1675  * \brief Sets an option on a channel
1676  *
1677  * \param channel channel to set options on
1678  * \param option option to change
1679  * \param data data specific to option
1680  * \param datalen length of the data
1681  * \param block blocking or not
1682  * \details
1683  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
1684  * \return 0 on success and -1 on failure
1685  */
1686 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
1687
1688 /*! Pick the best codec
1689  * Choose the best codec...  Uhhh...   Yah. */
1690 int ast_best_codec(int fmts);
1691
1692
1693 /*!
1694  * \brief Checks the value of an option
1695  *
1696  * Query the value of an option
1697  * Works similarly to setoption except only reads the options.
1698  */
1699 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
1700
1701 /*!
1702  * \brief Checks for HTML support on a channel
1703  * \return 0 if channel does not support HTML or non-zero if it does
1704  */
1705 int ast_channel_supports_html(struct ast_channel *channel);
1706
1707 /*!
1708  * \brief Sends HTML on given channel
1709  * Send HTML or URL on link.
1710  * \return 0 on success or -1 on failure
1711  */
1712 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
1713
1714 /*!
1715  * \brief Sends a URL on a given link
1716  * Send URL on link.
1717  * \return 0 on success or -1 on failure
1718  */
1719 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
1720
1721 /*!
1722  * \brief Defers DTMF so that you only read things like hangups and audio.
1723  * \return non-zero if channel was already DTMF-deferred or
1724  * 0 if channel is just now being DTMF-deferred
1725  */
1726 int ast_channel_defer_dtmf(struct ast_channel *chan);
1727
1728 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
1729 void ast_channel_undefer_dtmf(struct ast_channel *chan);
1730
1731 /*! Initiate system shutdown -- prevents new channels from being allocated.
1732  * \param hangup  If "hangup" is non-zero, all existing channels will receive soft
1733  *  hangups */
1734 void ast_begin_shutdown(int hangup);
1735
1736 /*! Cancels an existing shutdown and returns to normal operation */
1737 void ast_cancel_shutdown(void);
1738
1739 /*! \return number of active/allocated channels */
1740 int ast_active_channels(void);
1741
1742 /*! \return non-zero if Asterisk is being shut down */
1743 int ast_shutting_down(void);
1744
1745 /*! Activate a given generator */
1746 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
1747
1748 /*! Deactivate an active generator */
1749 void ast_deactivate_generator(struct ast_channel *chan);
1750
1751 /*!
1752  * \brief Set caller ID number, name and ANI
1753  *
1754  * \note The channel does not need to be locked before calling this function.
1755  */
1756 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
1757
1758 /*! Set the file descriptor on the channel */
1759 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
1760
1761 /*! Add a channel to an optimized waitfor */
1762 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
1763
1764 /*! Delete a channel from an optimized waitfor */
1765 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
1766
1767 /*! Start a tone going */
1768 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1769 /*! Stop a tone from playing */
1770 void ast_tonepair_stop(struct ast_channel *chan);
1771 /*! Play a tone pair for a given amount of time */
1772 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1773
1774 /*!
1775  * \brief Automatically service a channel for us...
1776  *
1777  * \retval 0 success
1778  * \retval -1 failure, or the channel is already being autoserviced
1779  */
1780 int ast_autoservice_start(struct ast_channel *chan);
1781
1782 /*!
1783  * \brief Stop servicing a channel for us...
1784  *
1785  * \note if chan is locked prior to calling ast_autoservice_stop, it
1786  * is likely that there will be a deadlock between the thread that calls
1787  * ast_autoservice_stop and the autoservice thread. It is important
1788  * that chan is not locked prior to this call
1789  *
1790  * \retval 0 success
1791  * \retval -1 error, or the channel has been hungup
1792  */
1793 int ast_autoservice_stop(struct ast_channel *chan);
1794
1795 /*!
1796  * \brief Enable or disable timer ticks for a channel
1797  *
1798  * \param rate number of timer ticks per second
1799  *
1800  * \details
1801  * If timers are supported, force a scheduled expiration on the
1802  * timer fd, at which point we call the callback function / data
1803  *
1804  * \note Call this function with a rate of 0 to turn off the timer ticks
1805  *
1806  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
1807  */
1808 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
1809
1810 /*!
1811  * \brief Transfer a channel (if supported).
1812  * \retval -1 on error
1813  * \retval 0 if not supported
1814  * \retval 1 if supported and requested
1815  * \param chan current channel
1816  * \param dest destination extension for transfer
1817  */
1818 int ast_transfer(struct ast_channel *chan, char *dest);
1819
1820 /*!
1821  * \brief Start masquerading a channel
1822  * \details
1823  * XXX This is a seriously whacked out operation.  We're essentially putting the guts of
1824  *     the clone channel into the original channel.  Start by killing off the original
1825  *     channel's backend.   I'm not sure we're going to keep this function, because
1826  *     while the features are nice, the cost is very high in terms of pure nastiness. XXX
1827  * \param chan Channel to masquerade
1828  */
1829 int ast_do_masquerade(struct ast_channel *chan);
1830
1831 /*!
1832  * \brief Find bridged channel
1833  *
1834  * \note This function does _not_ return a reference to the bridged channel.
1835  * The reason for this is mostly historical.  It _should_ return a reference,
1836  * but it will take a lot of work to make the code base account for that.
1837  * So, for now, the old rules still apply for how to handle this function.
1838  * If this function is being used from the channel thread that owns the channel,
1839  * then a reference is already held, and channel locking is not required to
1840  * guarantee that the channel will stay around.  If this function is used
1841  * outside of the associated channel thread, the channel parameter 'chan'
1842  * MUST be locked before calling this function.  Also, 'chan' must remain locked
1843  * for the entire time that the result of this function is being used.
1844  *
1845  * \param chan Current channel
1846  *
1847  * \return A pointer to the bridged channel
1848 */
1849 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
1850
1851 /*!
1852  * \brief Inherits channel variable from parent to child channel
1853  * \param parent Parent channel
1854  * \param child Child channel
1855  *
1856  * \details
1857  * Scans all channel variables in the parent channel, looking for those
1858  * that should be copied into the child channel.
1859  * Variables whose names begin with a single '_' are copied into the
1860  * child channel with the prefix removed.
1861  * Variables whose names begin with '__' are copied into the child
1862  * channel with their names unchanged.
1863  */
1864 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
1865
1866 /*!
1867  * \brief adds a list of channel variables to a channel
1868  * \param chan the channel
1869  * \param vars a linked list of variables
1870  *
1871  * \details
1872  * Variable names can be for a regular channel variable or a dialplan function
1873  * that has the ability to be written to.
1874  */
1875 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
1876
1877 /*!
1878  * \brief An opaque 'object' structure use by silence generators on channels.
1879  */
1880 struct ast_silence_generator;
1881
1882 /*!
1883  * \brief Starts a silence generator on the given channel.
1884  * \param chan The channel to generate silence on
1885  * \return An ast_silence_generator pointer, or NULL if an error occurs
1886  *
1887  * \details
1888  * This function will cause SLINEAR silence to be generated on the supplied
1889  * channel until it is disabled; if the channel cannot be put into SLINEAR
1890  * mode then the function will fail.
1891  *
1892  * \note
1893  * The pointer returned by this function must be preserved and passed to
1894  * ast_channel_stop_silence_generator when you wish to stop the silence
1895  * generation.
1896  */
1897 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
1898
1899 /*!
1900  * \brief Stops a previously-started silence generator on the given channel.
1901  * \param chan The channel to operate on
1902  * \param state The ast_silence_generator pointer return by a previous call to
1903  * ast_channel_start_silence_generator.
1904  * \return nothing
1905  *
1906  * \details
1907  * This function will stop the operating silence generator and return the channel
1908  * to its previous write format.
1909  */
1910 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
1911
1912 /*!
1913  * \brief Check if the channel can run in internal timing mode.
1914  * \param chan The channel to check
1915  * \return boolean
1916  *
1917  * \details
1918  * This function will return 1 if internal timing is enabled and the timing
1919  * device is available.
1920  */
1921 int ast_internal_timing_enabled(struct ast_channel *chan);
1922
1923 /* Misc. functions below */
1924
1925 /*!
1926  * \brief if fd is a valid descriptor, set *pfd with the descriptor
1927  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
1928  * return value to the index into the array)
1929  */
1930 static inline int ast_add_fd(struct pollfd *pfd, int fd)
1931 {
1932         pfd->fd = fd;
1933         pfd->events = POLLIN | POLLPRI;
1934         return fd >= 0;
1935 }
1936
1937 /*! \brief Helper function for migrating select to poll */
1938 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
1939 {
1940         int x;
1941         int dummy = 0;
1942
1943         if (fd < 0)
1944                 return 0;
1945         if (!start)
1946                 start = &dummy;
1947         for (x = *start; x < maximum; x++)
1948                 if (pfds[x].fd == fd) {
1949                         if (x == *start)
1950                                 (*start)++;
1951                         return pfds[x].revents;
1952                 }
1953         return 0;
1954 }
1955
1956 #ifndef HAVE_TIMERSUB
1957 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
1958 {
1959         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
1960         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
1961         if (tvdiff->tv_usec < 0) {
1962                 tvdiff->tv_sec --;
1963                 tvdiff->tv_usec += 1000000;
1964         }
1965
1966 }
1967 #endif
1968
1969 /*!
1970  * \brief Waits for activity on a group of channels
1971  * \param nfds the maximum number of file descriptors in the sets
1972  * \param rfds file descriptors to check for read availability
1973  * \param wfds file descriptors to check for write availability
1974  * \param efds file descriptors to check for exceptions (OOB data)
1975  * \param tvp timeout while waiting for events
1976  * \details
1977  * This is the same as a standard select(), except it guarantees the
1978  * behaviour where the passed struct timeval is updated with how much
1979  * time was not slept while waiting for the specified events
1980  */
1981 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
1982 {
1983 #ifdef __linux__
1984         return select(nfds, rfds, wfds, efds, tvp);
1985 #else
1986         if (tvp) {
1987                 struct timeval tv, tvstart, tvend, tvlen;
1988                 int res;
1989
1990                 tv = *tvp;
1991                 gettimeofday(&tvstart, NULL);
1992                 res = select(nfds, rfds, wfds, efds, tvp);
1993                 gettimeofday(&tvend, NULL);
1994                 timersub(&tvend, &tvstart, &tvlen);
1995                 timersub(&tv, &tvlen, tvp);
1996                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
1997                         tvp->tv_sec = 0;
1998                         tvp->tv_usec = 0;
1999                 }
2000                 return res;
2001         }
2002         else
2003                 return select(nfds, rfds, wfds, efds, NULL);
2004 #endif
2005 }
2006
2007 /*! \brief Retrieves the current T38 state of a channel */
2008 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
2009 {
2010         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2011         int datalen = sizeof(state);
2012
2013         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2014
2015         return state;
2016 }
2017
2018 #define CHECK_BLOCKING(c) do {   \
2019         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
2020                 if (option_debug) \
2021                         ast_log(LOG_DEBUG, "Thread %ld Blocking '%s', already blocked by thread %ld in procedure %s\n", (long) pthread_self(), (c)->name, (long) (c)->blocker, (c)->blockproc); \
2022         } else { \
2023                 (c)->blocker = pthread_self(); \
2024                 (c)->blockproc = __PRETTY_FUNCTION__; \
2025                 ast_set_flag(c, AST_FLAG_BLOCKING); \
2026         } } while (0)
2027
2028 ast_group_t ast_get_group(const char *s);
2029
2030 /*! \brief print call- and pickup groups into buffer */
2031 char *ast_print_group(char *buf, int buflen, ast_group_t group);
2032
2033 /*!
2034  * \brief Convert enum channelreloadreason to text string for manager event
2035  * \param reason The reason for reload (manager, cli, start etc)
2036  */
2037 const char *channelreloadreason2txt(enum channelreloadreason reason);
2038
2039 /*! \brief return an ast_variable list of channeltypes */
2040 struct ast_variable *ast_channeltype_list(void);
2041
2042 /*!
2043  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2044  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
2045  * \return char pointer explaining the code
2046  */
2047 const char *ast_channel_reason2str(int reason);
2048
2049 /*! \brief channel group info */
2050 struct ast_group_info {
2051         struct ast_channel *chan;
2052         char *category;
2053         char *group;
2054         AST_LIST_ENTRY(ast_group_info) group_list;
2055 };
2056
2057 #define ast_channel_lock(chan) ao2_lock(chan)
2058 #define ast_channel_unlock(chan) ao2_unlock(chan)
2059 #define ast_channel_trylock(chan) ao2_trylock(chan)
2060
2061 /*!
2062  * \brief Lock two channels.
2063  */
2064 #define ast_channel_lock_both(chan1, chan2) do { \
2065                 ast_channel_lock(chan1); \
2066                 while (ast_channel_trylock(chan2)) { \
2067                         ast_channel_unlock(chan1); \
2068                         sched_yield(); \
2069                         ast_channel_lock(chan1); \
2070                 } \
2071         } while (0)
2072
2073 #define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
2074 #define ast_channel_unref(c) ({ ao2_ref(c, -1); (NULL); })
2075
2076 /*! Channel Iterating @{ */
2077
2078 /*!
2079  * \brief A channel iterator
2080  *
2081  * This is an opaque type.
2082  */
2083 struct ast_channel_iterator;
2084
2085 /*!
2086  * \brief Destroy a channel iterator
2087  *
2088  * \arg i the itereator to destroy
2089  *
2090  * This function is used to destroy a channel iterator that was retrieved by
2091  * using one of the channel_iterator_new() functions.
2092  *
2093  * \return NULL, for convenience to clear out the pointer to the iterator that
2094  * was just destroyed.
2095  */
2096 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
2097
2098 /*!
2099  * \brief Create a new channel iterator based on extension
2100  *
2101  * \arg ao2_flags astobj2 iterator flags
2102  * \arg exten The extension that channels must be in
2103  * \arg context The context that channels must be in (optional)
2104  *
2105  * After creating an iterator using this function, the ast_channel_iterator_next()
2106  * function can be used to iterate through all channels that are currently
2107  * in the specified context and extension.
2108  *
2109  * \retval NULL on failure
2110  * \retval a new channel iterator based on the specified parameters
2111  */
2112 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(int ao2_flags, const char *exten,
2113         const char *context);
2114
2115 /*!
2116  * \brief Create a new channel iterator based on name
2117  *
2118  * \arg ao2_flags astobj2 iterator flags
2119  * \arg name channel name or channel uniqueid to match
2120  * \arg name_len number of characters in the channel name to match on.  This
2121  *      would be used to match based on name prefix.  If matching on the full
2122  *      channel name is desired, then this parameter should be 0.
2123  *
2124  * After creating an iterator using this function, the ast_channel_iterator_next()
2125  * function can be used to iterate through all channels that exist that have
2126  * the specified name or name prefix.
2127  *
2128  * \retval NULL on failure
2129  * \retval a new channel iterator based on the specified parameters
2130  */
2131 struct ast_channel_iterator *ast_channel_iterator_by_name_new(int ao2_flags, const char *name,
2132         size_t name_len);
2133
2134 /*!
2135  * \brief Create a new channel iterator
2136  *
2137  * \arg ao2_flags astobj2 iterator flags
2138  *
2139  * After creating an iterator using this function, the ast_channel_iterator_next()
2140  * function can be used to iterate through all channels that exist.
2141  *
2142  * \retval NULL on failure
2143  * \retval a new channel iterator
2144  */
2145 struct ast_channel_iterator *ast_channel_iterator_all_new(int ao2_flags);
2146
2147 /*!
2148  * \brief Get the next channel for a channel iterator
2149  *
2150  * \arg i the channel iterator that was created using one of the
2151  *  channel_iterator_new() functions.
2152  *
2153  * This function should be used to iterate through all channels that match a
2154  * specified set of parameters that were provided when the iterator was created.
2155  *
2156  * \retval the next channel that matches the parameters used when the iterator
2157  *         was created.
2158  * \retval NULL, if no more channels match the iterator parameters.
2159  */
2160 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
2161
2162 /*! @} End channel iterator definitions. */
2163
2164 /*!
2165  * \brief Call a function with every active channel
2166  *
2167  * This function executes a callback one time for each active channel on the
2168  * system.  The channel is provided as an argument to the function.
2169  */
2170 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
2171                 void *data, int ao2_flags);
2172
2173 /*! @{ Channel search functions */
2174
2175 /*!
2176  * \brief Find a channel by name
2177  *
2178  * \arg name the name or uniqueid of the channel to search for
2179  *
2180  * Find a channel that has the same name as the provided argument.
2181  *
2182  * \retval a channel with the name specified by the argument
2183  * \retval NULL if no channel was found
2184  */
2185 struct ast_channel *ast_channel_get_by_name(const char *name);
2186
2187 /*!
2188  * \brief Find a channel by a name prefix
2189  *
2190  * \arg name The channel name or uniqueid prefix to search for
2191  * \arg name_len Only search for up to this many characters from the name
2192  *
2193  * Find a channel that has the same name prefix as specified by the arguments.
2194  *
2195  * \retval a channel with the name prefix specified by the arguments
2196  * \retval NULL if no channel was found
2197  */
2198 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
2199
2200 /*!
2201  * \brief Find a channel by extension and context
2202  *
2203  * \arg exten the extension to search for
2204  * \arg context the context to search for (optional)
2205  *
2206  * Return a channel that is currently at the specified extension and context.
2207  *
2208  * \retval a channel that is at the specified extension and context
2209  * \retval NULL if no channel was found
2210  */
2211 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
2212
2213 /*! @} End channel search functions. */
2214
2215 /*!
2216  * \since 1.6.3
2217  * \brief Copy the source caller information to the destination caller.
2218  *
2219  * \param dest Destination caller
2220  * \param src Source caller
2221  *
2222  * \return Nothing
2223  */
2224 void ast_party_caller_copy(struct ast_callerid *dest, const struct ast_callerid *src);
2225
2226 /*!
2227  * \since 1.6.3
2228  * \brief Initialize the given connected line structure.
2229  *
2230  * \param init Connected line structure to initialize.
2231  *
2232  * \return Nothing
2233  */
2234 void ast_party_connected_line_init(struct ast_party_connected_line *init);
2235
2236 /*!
2237  * \since 1.6.3
2238  * \brief Copy the source connected line information to the destination connected line.
2239  *
2240  * \param dest Destination connected line
2241  * \param src Source connected line
2242  *
2243  * \return Nothing
2244  */
2245 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
2246
2247 /*!
2248  * \since 1.6.3
2249  * \brief Initialize the given connected line structure using the given
2250  * guide for a set update operation.
2251  *
2252  * \details
2253  * The initialization is needed to allow a set operation to know if a
2254  * value needs to be updated.  Simple integers need the guide's original
2255  * value in case the set operation is not trying to set a new value.
2256  * String values are simply set to NULL pointers if they are not going
2257  * to be updated.
2258  *
2259  * \param init Connected line structure to initialize.
2260  * \param guide Source connected line to use as a guide in initializing.
2261  *
2262  * \return Nothing
2263  */
2264 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
2265
2266 /*!
2267  * \since 1.6.3
2268  * \brief Set the connected line information based on another connected line source
2269  *
2270  * This is similar to ast_party_connected_line_copy, except that NULL values for
2271  * strings in the src parameter indicate not to update the corresponding dest values.
2272  *
2273  * \param src The source connected line to use as a guide to set the dest
2274  * \param dest The connected line one wishes to update
2275  *
2276  * \return Nada
2277  */
2278 void ast_party_connected_line_set(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
2279
2280 /*!
2281  * \since 1.6.3
2282  * \brief Collect the caller party information into a connected line structure.
2283  *
2284  * \param connected Collected caller information for the connected line
2285  * \param cid Caller information.
2286  *
2287  * \return Nothing
2288  *
2289  * \warning This is a shallow copy.
2290  * \warning DO NOT call ast_party_connected_line_free() on the filled in
2291  * connected line structure!
2292  */
2293 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_callerid *cid);
2294
2295 /*!
2296  * \since 1.6.3
2297  * \brief Destroy the connected line information contents
2298  *
2299  * \param doomed The connected line information to destroy.
2300  *
2301  * \return Nothing
2302  */
2303 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
2304
2305 /*!
2306  * \since 1.6.3
2307  * \brief Copy the source redirecting information to the destination redirecting.
2308  *
2309  * \param dest Destination redirecting
2310  * \param src Source redirecting
2311  *
2312  * \return Nothing
2313  */
2314 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
2315
2316 /*!
2317  * \since 1.6.3
2318  * \brief Initialize the given redirecting id structure using the given guide
2319  * for a set update operation.
2320  *
2321  * \details
2322  * The initialization is needed to allow a set operation to know if a
2323  * value needs to be updated.  Simple integers need the guide's original
2324  * value in case the set operation is not trying to set a new value.
2325  * String values are simply set to NULL pointers if they are not going
2326  * to be updated.
2327  *
2328  * \param init Redirecting id structure to initialize.
2329  * \param guide Source redirecting id to use as a guide in initializing.
2330  *
2331  * \return Nothing
2332  */
2333 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
2334
2335 /*!
2336  * \since 1.6.3
2337  * \brief Destroy the redirecting information contents
2338  *
2339  * \param doomed The redirecting information to destroy.
2340  *
2341  * \return Nothing
2342  */
2343 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
2344
2345 /*!
2346  * \since 1.6.3
2347  * \brief Copy the caller information to the connected line information.
2348  *
2349  * \param dest Destination connected line information
2350  * \param src Source caller information
2351  *
2352  * \return Nothing
2353  *
2354  * \note Assumes locks are already acquired
2355  */
2356 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_callerid *src);
2357
2358 /*!
2359  * \since 1.6.3
2360  * \brief Copy the connected line information to the caller information.
2361  *
2362  * \param dest Destination caller information
2363  * \param src Source connected line information
2364  *
2365  * \return Nothing
2366  *
2367  * \note Assumes locks are already acquired
2368  */
2369 void ast_connected_line_copy_to_caller(struct ast_callerid *dest, const struct ast_party_connected_line *src);
2370
2371 /*!
2372  * \since 1.6.3
2373  * \brief Set the connected line information in the Asterisk channel
2374  *
2375  * \param chan Asterisk channel to set connected line information
2376  * \param connected Connected line information
2377  *
2378  * \return Nothing
2379  *
2380  * \note The channel does not need to be locked before calling this function.
2381  */
2382 void ast_channel_set_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected);
2383
2384 /*!
2385  * \since 1.6.3
2386  * \brief Build the connected line information data frame.
2387  *
2388  * \param data Buffer to fill with the frame data
2389  * \param datalen Size of the buffer to fill
2390  * \param connected Connected line information
2391  *
2392  * \retval -1 if error
2393  * \retval Amount of data buffer used
2394  */
2395 int ast_connected_line_build_data(unsigned char *data, size_t datalen, const struct ast_party_connected_line *connected);
2396
2397 /*!
2398  * \since 1.6.3
2399  * \brief Parse connected line indication frame data
2400  *
2401  * \param data Buffer with the frame data to parse
2402  * \param datalen Size of the buffer
2403  * \param connected Extracted connected line information
2404  *
2405  * \retval 0 on success.
2406  * \retval -1 on error.
2407  *
2408  * \note The filled in connected line structure needs to be initialized by
2409  * ast_party_connected_line_set_init() before calling.  If defaults are not
2410  * required use ast_party_connected_line_init().
2411  * \note The filled in connected line structure needs to be destroyed by
2412  * ast_party_connected_line_free() when it is no longer needed.
2413  */
2414 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
2415
2416 /*!
2417  * \since 1.6.3
2418  * \brief Indicate that the connected line information has changed
2419  *
2420  * \param chan Asterisk channel to indicate connected line information
2421  * \param connected Connected line information
2422  *
2423  * \return Nothing
2424  */
2425 void ast_channel_update_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected);
2426
2427 /*!
2428  * \since 1.6.3
2429  * \brief Queue a connected line update frame on a channel
2430  *
2431  * \param chan Asterisk channel to indicate connected line information
2432  * \param connected Connected line information
2433  *
2434  * \return Nothing
2435  */
2436 void ast_channel_queue_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected);
2437
2438 /*!
2439  * \since 1.6.3
2440  * \brief Set the redirecting id information in the Asterisk channel
2441  *
2442  * \param chan Asterisk channel to set redirecting id information
2443  * \param redirecting Redirecting id information
2444  *
2445  * \return Nothing
2446  *
2447  * \note The channel does not need to be locked before calling this function.
2448  */
2449 void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
2450
2451 /*!
2452  * \since 1.6.3
2453  * \brief Build the redirecting id data frame.
2454  *
2455  * \param data Buffer to fill with the frame data
2456  * \param datalen Size of the buffer to fill
2457  * \param redirecting Redirecting id information
2458  *
2459  * \retval -1 if error
2460  * \retval Amount of data buffer used
2461  */
2462 int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting);
2463
2464 /*!
2465  * \since 1.6.3
2466  * \brief Parse redirecting indication frame data
2467  *
2468  * \param data Buffer with the frame data to parse
2469  * \param datalen Size of the buffer
2470  * \param redirecting Extracted redirecting id information
2471  *
2472  * \retval 0 on success.
2473  * \retval -1 on error.
2474  *
2475  * \note The filled in id structure needs to be initialized by
2476  * ast_party_redirecting_set_init() before calling.
2477  * \note The filled in id structure needs to be destroyed by
2478  * ast_party_redirecting_free() when it is no longer needed.
2479  */
2480 int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
2481
2482 /*!
2483  * \since 1.6.3
2484  * \brief Indicate that the redirecting id has changed
2485  *
2486  * \param chan Asterisk channel to indicate redirecting id information
2487  * \param redirecting Redirecting id information
2488  *
2489  * \return Nothing
2490  */
2491 void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
2492
2493 /*!
2494  * \since 1.6.3
2495  * \brief Queue a redirecting update frame on a channel
2496  *
2497  * \param chan Asterisk channel to indicate redirecting id information
2498  * \param redirecting Redirecting id information
2499  *
2500  * \return Nothing
2501  */
2502 void ast_channel_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
2503
2504 #if defined(__cplusplus) || defined(c_plusplus)
2505 }
2506 #endif
2507
2508 #endif /* _ASTERISK_CHANNEL_H */