Add Doxygen documentation for API changes from 1.6.0 to 1.6.1
[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 briding 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
128 #ifdef HAVE_SYS_POLL_H
129 #include <sys/poll.h>
130 #else
131 #include "asterisk/poll-compat.h"
132 #endif
133
134 #if defined(__cplusplus) || defined(c_plusplus)
135 extern "C" {
136 #endif
137
138 #define AST_MAX_EXTENSION       80      /*!< Max length of an extension */
139 #define AST_MAX_CONTEXT         80      /*!< Max length of a context */
140 #define AST_CHANNEL_NAME        80      /*!< Max length of an ast_channel name */
141 #define MAX_LANGUAGE            20      /*!< Max length of the language setting */
142 #define MAX_MUSICCLASS          80      /*!< Max length of the music class setting */
143
144 #include "asterisk/frame.h"
145 #include "asterisk/sched.h"
146 #include "asterisk/chanvars.h"
147 #include "asterisk/config.h"
148 #include "asterisk/lock.h"
149 #include "asterisk/cdr.h"
150 #include "asterisk/utils.h"
151 #include "asterisk/linkedlists.h"
152 #include "asterisk/stringfields.h"
153 #include "asterisk/datastore.h"
154
155 #define DATASTORE_INHERIT_FOREVER       INT_MAX
156
157 #define AST_MAX_FDS             10
158 /*
159  * We have AST_MAX_FDS file descriptors in a channel.
160  * Some of them have a fixed use:
161  */
162 #define AST_ALERT_FD    (AST_MAX_FDS-1)         /*!< used for alertpipe */
163 #define AST_TIMING_FD   (AST_MAX_FDS-2)         /*!< used for timingfd */
164 #define AST_AGENT_FD    (AST_MAX_FDS-3)         /*!< used by agents for pass through */
165 #define AST_GENERATOR_FD        (AST_MAX_FDS-4) /*!< used by generator */
166
167 enum ast_bridge_result {
168         AST_BRIDGE_COMPLETE = 0,
169         AST_BRIDGE_FAILED = -1,
170         AST_BRIDGE_FAILED_NOWARN = -2,
171         AST_BRIDGE_RETRY = -3,
172 };
173
174 typedef unsigned long long ast_group_t;
175
176 /*! \todo Add an explanation of an Asterisk generator
177 */
178 struct ast_generator {
179         void *(*alloc)(struct ast_channel *chan, void *params);
180         void (*release)(struct ast_channel *chan, void *data);
181         /*! This function gets called with the channel unlocked, but is called in
182          *  the context of the channel thread so we know the channel is not going
183          *  to disappear.  This callback is responsible for locking the channel as
184          *  necessary. */
185         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
186         /*! This gets called when DTMF_END frames are read from the channel */
187         void (*digit)(struct ast_channel *chan, char digit);
188 };
189
190 /*! \brief Structure for all kinds of caller ID identifications.
191  * \note All string fields here are malloc'ed, so they need to be
192  * freed when the structure is deleted.
193  * Also, NULL and "" must be considered equivalent.
194  *
195  * SIP and IAX2 has utf8 encoded Unicode caller ID names.
196  * In some cases, we also have an alternative (RPID) E.164 number that can be used
197  * as caller ID on numeric E.164 phone networks (DAHDI or SIP/IAX2 to pstn gateway).
198  *
199  * \todo Implement settings for transliteration between UTF8 caller ID names in
200  *       to Ascii Caller ID's (DAHDI). Östen Åsklund might be transliterated into
201  *       Osten Asklund or Oesten Aasklund depending upon language and person...
202  *       We need automatic routines for incoming calls and static settings for
203  *       our own accounts.
204  */
205 struct ast_callerid {
206         char *cid_dnid;         /*!< Malloc'd Dialed Number Identifier */
207         char *cid_num;          /*!< Malloc'd Caller Number */
208         char *cid_name;         /*!< Malloc'd Caller Name (ASCII) */
209         char *cid_ani;          /*!< Malloc'd ANI */
210         char *cid_rdnis;        /*!< Malloc'd RDNIS */
211         int cid_pres;           /*!< Callerid presentation/screening */
212         int cid_ani2;           /*!< Callerid ANI 2 (Info digits) */
213         int cid_ton;            /*!< Callerid Type of Number */
214         int cid_tns;            /*!< Callerid Transit Network Select */
215 };
216
217 /*! \brief
218         Structure to describe a channel "technology", ie a channel driver
219         See for examples:
220         \arg chan_iax2.c - The Inter-Asterisk exchange protocol
221         \arg chan_sip.c - The SIP channel driver
222         \arg chan_dahdi.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
223
224         If you develop your own channel driver, this is where you
225         tell the PBX at registration of your driver what properties
226         this driver supports and where different callbacks are
227         implemented.
228 */
229 struct ast_channel_tech {
230         const char * const type;
231         const char * const description;
232
233         int capabilities;               /*!< Bitmap of formats this channel can handle */
234
235         int properties;                 /*!< Technology Properties */
236
237         /*! \brief Requester - to set up call data structures (pvt's) */
238         struct ast_channel *(* const requester)(const char *type, int format, void *data, int *cause);
239
240         int (* const devicestate)(void *data);  /*!< Devicestate call back */
241
242         /*!
243          * \brief Start sending a literal DTMF digit
244          *
245          * \note The channel is not locked when this function gets called.
246          */
247         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
248
249         /*!
250          * \brief Stop sending a literal DTMF digit
251          *
252          * \note The channel is not locked when this function gets called.
253          */
254         int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
255
256         /*! \brief Call a given phone number (address, etc), but don't
257            take longer than timeout seconds to do so.  */
258         int (* const call)(struct ast_channel *chan, char *addr, int timeout);
259
260         /*! \brief Hangup (and possibly destroy) the channel */
261         int (* const hangup)(struct ast_channel *chan);
262
263         /*! \brief Answer the channel */
264         int (* const answer)(struct ast_channel *chan);
265
266         /*! \brief Read a frame, in standard format (see frame.h) */
267         struct ast_frame * (* const read)(struct ast_channel *chan);
268
269         /*! \brief Write a frame, in standard format (see frame.h) */
270         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
271
272         /*! \brief Display or transmit text */
273         int (* const send_text)(struct ast_channel *chan, const char *text);
274
275         /*! \brief Display or send an image */
276         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
277
278         /*! \brief Send HTML data */
279         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
280
281         /*! \brief Handle an exception, reading a frame */
282         struct ast_frame * (* const exception)(struct ast_channel *chan);
283
284         /*! \brief Bridge two channels of the same type together */
285         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
286                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
287
288         /*! \brief Bridge two channels of the same type together (early) */
289         enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
290
291         /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
292         int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
293
294         /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
295         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
296
297         /*! \brief Set a given option */
298         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
299
300         /*! \brief Query a given option */
301         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
302
303         /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
304         int (* const transfer)(struct ast_channel *chan, const char *newdest);
305
306         /*! \brief Write a frame, in standard format */
307         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
308
309         /*! \brief Write a text frame, in standard format */
310         int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
311
312         /*! \brief Find bridged channel */
313         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
314
315         /*! \brief Provide additional read items for CHANNEL() dialplan function */
316         int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
317
318         /*! \brief Provide additional write items for CHANNEL() dialplan function */
319         int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
320
321         /*! \brief Retrieve base channel (agent and local) */
322         struct ast_channel* (* get_base_channel)(struct ast_channel *chan);
323
324         /*! \brief Set base channel (agent and local) */
325         int (* set_base_channel)(struct ast_channel *chan, struct ast_channel *base);
326
327         /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
328         const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
329 };
330
331 struct ast_epoll_data;
332
333 /*!
334  * The high bit of the frame count is used as a debug marker, so
335  * increments of the counters must be done with care.
336  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
337  */
338 #define DEBUGCHAN_FLAG  0x80000000
339
340 /* XXX not ideal to evaluate x twice... */
341 #define FRAMECOUNT_INC(x)       ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
342
343 /*!
344  * The current value of the debug flags is stored in the two
345  * variables global_fin and global_fout (declared in main/channel.c)
346  */
347 extern unsigned long global_fin, global_fout;
348
349 enum ast_channel_adsicpe {
350         AST_ADSI_UNKNOWN,
351         AST_ADSI_AVAILABLE,
352         AST_ADSI_UNAVAILABLE,
353         AST_ADSI_OFFHOOKONLY,
354 };
355
356 /*!
357  * \brief ast_channel states
358  *
359  * \note Bits 0-15 of state are reserved for the state (up/down) of the line
360  *       Bits 16-32 of state are reserved for flags
361  */
362 enum ast_channel_state {
363         AST_STATE_DOWN,                 /*!< Channel is down and available */
364         AST_STATE_RESERVED,             /*!< Channel is down, but reserved */
365         AST_STATE_OFFHOOK,              /*!< Channel is off hook */
366         AST_STATE_DIALING,              /*!< Digits (or equivalent) have been dialed */
367         AST_STATE_RING,                 /*!< Line is ringing */
368         AST_STATE_RINGING,              /*!< Remote end is ringing */
369         AST_STATE_UP,                   /*!< Line is up */
370         AST_STATE_BUSY,                 /*!< Line is busy */
371         AST_STATE_DIALING_OFFHOOK,      /*!< Digits (or equivalent) have been dialed while offhook */
372         AST_STATE_PRERING,              /*!< Channel has detected an incoming call and is waiting for ring */
373
374         AST_STATE_MUTE = (1 << 16),     /*!< Do not transmit voice data */
375 };
376
377 /*!
378  * \brief Possible T38 states on channels
379  */
380 enum ast_t38_state {
381         T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
382         T38_STATE_UNKNOWN,      /*!< The channel supports T38 but the current status is unknown */
383         T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
384         T38_STATE_REJECTED,     /*!< Remote side has rejected our offer */
385         T38_STATE_NEGOTIATED,   /*!< T38 established */
386 };
387
388 /*! \brief Main Channel structure associated with a channel.
389  * This is the side of it mostly used by the pbx and call management.
390  *
391  * \note XXX It is important to remember to increment .cleancount each time
392  *       this structure is changed. XXX
393  *
394  * \note When adding fields to this structure, it is important to add the field
395  *       'in position' with like-aligned fields, so as to keep the compiler from
396  *       having to add padding to align fields. The structure's fields are sorted
397  *       in this order: pointers, structures, long, int/enum, short, char. This
398  *       is especially important on 64-bit architectures, where mixing 4-byte
399  *       and 8-byte fields causes 4 bytes of padding to be added before many
400  *       8-byte fields.
401  */
402
403 struct ast_channel {
404         const struct ast_channel_tech *tech;            /*!< Technology (point to channel driver) */
405         void *tech_pvt;                                 /*!< Private data used by the technology driver */
406         void *music_state;                              /*!< Music State*/
407         void *generatordata;                            /*!< Current generator data if there is any */
408         struct ast_generator *generator;                /*!< Current active data generator */
409         struct ast_channel *_bridge;                    /*!< Who are we bridged to, if we're bridged.
410                                                              Who is proxying for us, if we are proxied (i.e. chan_agent).
411                                                              Do not access directly, use ast_bridged_channel(chan) */
412         struct ast_channel *masq;                       /*!< Channel that will masquerade as us */
413         struct ast_channel *masqr;                      /*!< Who we are masquerading as */
414         const char *blockproc;                          /*!< Procedure causing blocking */
415         const char *appl;                               /*!< Current application */
416         const char *data;                               /*!< Data passed to current application */
417         struct sched_context *sched;                    /*!< Schedule context */
418         struct ast_filestream *stream;                  /*!< Stream itself. */
419         struct ast_filestream *vstream;                 /*!< Video Stream itself. */
420         int (*timingfunc)(const void *data);
421         void *timingdata;
422         struct ast_pbx *pbx;                            /*!< PBX private structure for this channel */
423         struct ast_trans_pvt *writetrans;               /*!< Write translation path */
424         struct ast_trans_pvt *readtrans;                /*!< Read translation path */
425         struct ast_audiohook_list *audiohooks;
426         struct ast_cdr *cdr;                            /*!< Call Detail Record */
427         struct ast_tone_zone *zone;                     /*!< Tone zone as set in indications.conf or
428                                                              in the CHANNEL dialplan function */
429         struct ast_channel_monitor *monitor;            /*!< Channel monitoring */
430 #ifdef HAVE_EPOLL
431         struct ast_epoll_data *epfd_data[AST_MAX_FDS];
432 #endif
433
434         AST_DECLARE_STRING_FIELDS(
435                 AST_STRING_FIELD(name);                 /*!< ASCII unique channel name */
436                 AST_STRING_FIELD(language);             /*!< Language requested for voice prompts */
437                 AST_STRING_FIELD(musicclass);           /*!< Default music class */
438                 AST_STRING_FIELD(accountcode);          /*!< Account code for billing */
439                 AST_STRING_FIELD(call_forward);         /*!< Where to forward to if asked to dial on this interface */
440                 AST_STRING_FIELD(uniqueid);             /*!< Unique Channel Identifier */
441                 AST_STRING_FIELD(parkinglot);           /*! Default parking lot, if empty, default parking lot  */
442                 AST_STRING_FIELD(dialcontext);          /*!< Dial: Extension context that we were called from */
443         );
444
445         struct timeval whentohangup;                    /*!< Non-zero, set to actual time when channel is to be hung up */
446         pthread_t blocker;                              /*!< If anyone is blocking, this is them */
447         ast_mutex_t lock_dont_use;                      /*!< Lock a channel for some operations. See ast_channel_lock() */
448         struct ast_callerid cid;                        /*!< Caller ID, name, presentation etc */
449         struct ast_frame dtmff;                         /*!< DTMF frame */
450         struct varshead varshead;                       /*!< A linked list for channel variables. See \ref AstChanVar */
451         ast_group_t callgroup;                          /*!< Call group for call pickups */
452         ast_group_t pickupgroup;                        /*!< Pickup group - which calls groups can be picked up? */
453         AST_LIST_HEAD_NOLOCK(, ast_frame) readq;
454         AST_LIST_ENTRY(ast_channel) chan_list;          /*!< For easy linking */
455         struct ast_jb jb;                               /*!< The jitterbuffer state */
456         struct timeval dtmf_tv;                         /*!< The time that an in process digit began, or the last digit ended */
457         AST_LIST_HEAD_NOLOCK(datastores, ast_datastore) datastores; /*!< Data stores on the channel */
458
459         unsigned long insmpl;                           /*!< Track the read/written samples for monitor use */
460         unsigned long outsmpl;                          /*!< Track the read/written samples for monitor use */
461
462         int fds[AST_MAX_FDS];                           /*!< File descriptors for channel -- Drivers will poll on
463                                                              these file descriptors, so at least one must be non -1.
464                                                              See \arg \ref AstFileDesc */
465         int cdrflags;                                   /*!< Call Detail Record Flags */
466         int _softhangup;                                /*!< Whether or not we have been hung up...  Do not set this value
467                                                              directly, use ast_softhangup() */
468         int fdno;                                       /*!< Which fd had an event detected on */
469         int streamid;                                   /*!< For streaming playback, the schedule ID */
470         int vstreamid;                                  /*!< For streaming video playback, the schedule ID */
471         int oldwriteformat;                             /*!< Original writer format */
472         int timingfd;                                   /*!< Timing fd */
473         enum ast_channel_state _state;                  /*!< State of line -- Don't write directly, use ast_setstate() */
474         int rings;                                      /*!< Number of rings so far */
475         int priority;                                   /*!< Dialplan: Current extension priority */
476         int macropriority;                              /*!< Macro: Current non-macro priority. See app_macro.c */
477         int amaflags;                                   /*!< Set BEFORE PBX is started to determine AMA flags */
478         enum ast_channel_adsicpe adsicpe;               /*!< Whether or not ADSI is detected on CPE */
479         unsigned int fin;                               /*!< Frames in counters. The high bit is a debug mask, so
480                                                              the counter is only in the remaining bits */
481         unsigned int fout;                              /*!< Frames out counters. The high bit is a debug mask, so
482                                                              the counter is only in the remaining bits */
483         int hangupcause;                                /*!< Why is the channel hanged up. See causes.h */
484         unsigned int flags;                             /*!< channel flags of AST_FLAG_ type */
485         int alertpipe[2];
486         int nativeformats;                              /*!< Kinds of data this channel can natively handle */
487         int readformat;                                 /*!< Requested read format */
488         int writeformat;                                /*!< Requested write format */
489         int rawreadformat;                              /*!< Raw read format */
490         int rawwriteformat;                             /*!< Raw write format */
491         unsigned int emulate_dtmf_duration;             /*!< Number of ms left to emulate DTMF for */
492 #ifdef HAVE_EPOLL
493         int epfd;
494 #endif
495         int visible_indication;                         /*!< Indication currently playing on the channel */
496
497         unsigned short transfercapability;              /*!< ISDN Transfer Capbility - AST_FLAG_DIGITAL is not enough */
498
499         union {
500                 char unused_old_dtmfq[AST_MAX_EXTENSION];                       /*!< (deprecated, use readq instead) Any/all queued DTMF characters */
501                 struct {
502                         struct ast_bridge *bridge;                                      /*!< Bridge this channel is participating in */
503                 };
504         };
505
506         char context[AST_MAX_CONTEXT];                  /*!< Dialplan: Current extension context */
507         char exten[AST_MAX_EXTENSION];                  /*!< Dialplan: Current extension number */
508         char macrocontext[AST_MAX_CONTEXT];             /*!< Macro: Current non-macro context. See app_macro.c */
509         char macroexten[AST_MAX_EXTENSION];             /*!< Macro: Current non-macro extension. See app_macro.c */
510         char emulate_dtmf_digit;                        /*!< Digit being emulated */
511 };
512
513 /*! \brief ast_channel_tech Properties */
514 enum {
515         /*! \brief Channels have this property if they can accept input with jitter;
516          *         i.e. most VoIP channels */
517         AST_CHAN_TP_WANTSJITTER = (1 << 0),
518         /*! \brief Channels have this property if they can create jitter;
519          *         i.e. most VoIP channels */
520         AST_CHAN_TP_CREATESJITTER = (1 << 1),
521 };
522
523 /*! \brief ast_channel flags */
524 enum {
525         /*! Queue incoming dtmf, to be released when this flag is turned off */
526         AST_FLAG_DEFER_DTMF =    (1 << 1),
527         /*! write should be interrupt generator */
528         AST_FLAG_WRITE_INT =     (1 << 2),
529         /*! a thread is blocking on this channel */
530         AST_FLAG_BLOCKING =      (1 << 3),
531         /*! This is a zombie channel */
532         AST_FLAG_ZOMBIE =        (1 << 4),
533         /*! There is an exception pending */
534         AST_FLAG_EXCEPTION =     (1 << 5),
535         /*! Listening to moh XXX anthm promises me this will disappear XXX */
536         AST_FLAG_MOH =           (1 << 6),
537         /*! This channel is spying on another channel */
538         AST_FLAG_SPYING =        (1 << 7),
539         /*! This channel is in a native bridge */
540         AST_FLAG_NBRIDGE =       (1 << 8),
541         /*! the channel is in an auto-incrementing dialplan processor,
542          *  so when ->priority is set, it will get incremented before
543          *  finding the next priority to run */
544         AST_FLAG_IN_AUTOLOOP =   (1 << 9),
545         /*! This is an outgoing call */
546         AST_FLAG_OUTGOING =      (1 << 10),
547         /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
548         AST_FLAG_IN_DTMF =       (1 << 12),
549         /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
550          *  currently being emulated */
551         AST_FLAG_EMULATE_DTMF =  (1 << 13),
552         /*! This is set to tell the channel not to generate DTMF begin frames, and
553          *  to instead only generate END frames. */
554         AST_FLAG_END_DTMF_ONLY = (1 << 14),
555         /*! Flag to show channels that this call is hangup due to the fact that the call
556             was indeed anwered, but in another channel */
557         AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15),
558         /*! This flag indicates that on a masquerade, an active stream should not
559          *  be carried over */
560         AST_FLAG_MASQ_NOSTREAM = (1 << 16),
561         /*! This flag indicates that the hangup exten was run when the bridge terminated,
562          *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
563          *  level */
564         AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
565         /*! This flag indicates that the hangup exten should NOT be run when the
566          *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
567          *  */
568         AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
569 };
570
571 /*! \brief ast_bridge_config flags */
572 enum {
573         AST_FEATURE_PLAY_WARNING = (1 << 0),
574         AST_FEATURE_REDIRECT =     (1 << 1),
575         AST_FEATURE_DISCONNECT =   (1 << 2),
576         AST_FEATURE_ATXFER =       (1 << 3),
577         AST_FEATURE_AUTOMON =      (1 << 4),
578         AST_FEATURE_PARKCALL =     (1 << 5),
579         AST_FEATURE_AUTOMIXMON =   (1 << 6),
580         AST_FEATURE_NO_H_EXTEN =   (1 << 7),
581         AST_FEATURE_WARNING_ACTIVE = (1 << 8),
582 };
583
584 /*! \brief bridge configuration */
585 struct ast_bridge_config {
586         struct ast_flags features_caller;
587         struct ast_flags features_callee;
588         struct timeval start_time;
589         struct timeval nexteventts;
590         long feature_timer;
591         long timelimit;
592         long play_warning;
593         long warning_freq;
594         const char *warning_sound;
595         const char *end_sound;
596         const char *start_sound;
597         int firstpass;
598         unsigned int flags;
599         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
600         void *end_bridge_callback_data;         /*!< Data passed to the callback */
601         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
602          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
603          */
604         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
605 };
606
607 struct chanmon;
608
609 struct outgoing_helper {
610         const char *context;
611         const char *exten;
612         int priority;
613         const char *cid_num;
614         const char *cid_name;
615         const char *account;
616         struct ast_variable *vars;
617         struct ast_channel *parent_channel;
618 };
619
620 enum {
621         AST_CDR_TRANSFER =   (1 << 0),
622         AST_CDR_FORWARD =    (1 << 1),
623         AST_CDR_CALLWAIT =   (1 << 2),
624         AST_CDR_CONFERENCE = (1 << 3),
625 };
626
627 enum {
628         /*! Soft hangup by device */
629         AST_SOFTHANGUP_DEV =       (1 << 0),
630         /*! Soft hangup for async goto */
631         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
632         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
633         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
634         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
635         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
636         AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
637 };
638
639
640 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
641 enum channelreloadreason {
642         CHANNEL_MODULE_LOAD,
643         CHANNEL_MODULE_RELOAD,
644         CHANNEL_CLI_RELOAD,
645         CHANNEL_MANAGER_RELOAD,
646 };
647
648 /*!
649  * \note None of the datastore API calls lock the ast_channel they are using.
650  *       So, the channel should be locked before calling the functions that
651  *       take a channel argument.
652  */
653
654 /*!
655  * \brief Create a channel data store object
656  * \deprecated You should use the ast_datastore_alloc() generic function instead.
657  * \version 1.6.1 deprecated
658  */
659 struct ast_datastore *ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
660         __attribute__((deprecated));
661
662 /*!
663  * \brief Free a channel data store object
664  * \deprecated You should use the ast_datastore_free() generic function instead.
665  * \version 1.6.1 deprecated
666  */
667 int ast_channel_datastore_free(struct ast_datastore *datastore)
668         __attribute__((deprecated));
669
670 /*! \brief Inherit datastores from a parent to a child. */
671 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
672
673 /*!
674  * \brief Add a datastore to a channel
675  *
676  * \note The channel should be locked before calling this function.
677  *
678  * \retval 0 success
679  * \retval non-zero failure
680  */
681
682 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
683
684 /*!
685  * \brief Remove a datastore from a channel
686  *
687  * \note The channel should be locked before calling this function.
688  *
689  * \retval 0 success
690  * \retval non-zero failure
691  */
692 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
693
694 /*!
695  * \brief Find a datastore on a channel
696  *
697  * \note The channel should be locked before calling this function.
698  *
699  * \note The datastore returned from this function must not be used if the
700  *       reference to the channel is released.
701  *
702  * \retval pointer to the datastore if found
703  * \retval NULL if not found
704  */
705 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
706
707 /*! \brief Change the state of a channel */
708 int ast_setstate(struct ast_channel *chan, enum ast_channel_state);
709
710 /*!
711  * \brief Create a channel structure
712  *
713  * \retval NULL failure
714  * \retval non-NULL successfully allocated channel
715  *
716  * \note By default, new channels are set to the "s" extension
717  *       and "default" context.
718  */
719 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)));
720
721 /*!
722  * \brief Queue an outgoing frame
723  *
724  * \note The channel does not need to be locked before calling this function.
725  */
726 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
727
728 /*!
729  * \brief Queue an outgoing frame to the head of the frame queue
730  *
731  * \param chan the channel to queue the frame on
732  * \param f the frame to queue.  Note that this frame will be duplicated by
733  *        this function.  It is the responsibility of the caller to handle
734  *        freeing the memory associated with the frame being passed if
735  *        necessary.
736  *
737  * \retval 0 success
738  * \retval non-zero failure
739  */
740 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
741
742 /*!
743  * \brief Queue a hangup frame
744  *
745  * \note The channel does not need to be locked before calling this function.
746  */
747 int ast_queue_hangup(struct ast_channel *chan);
748
749 /*!
750  * \brief Queue a hangup frame with hangupcause set
751  *
752  * \note The channel does not need to be locked before calling this function.
753  * \param[in] chan channel to queue frame onto
754  * \param[in] cause the hangup cause
755  * \return 0 on success, -1 on error
756  * \since 1.6.1
757  */
758 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
759
760 /*!
761  * \brief Queue a control frame with payload
762  *
763  * \param chan channel to queue frame onto
764  * \param control type of control frame
765  *
766  * \note The channel does not need to be locked before calling this function.
767  *
768  * \retval zero on success
769  * \retval non-zero on failure
770  */
771 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
772
773 /*!
774  * \brief Queue a control frame with payload
775  *
776  * \param chan channel to queue frame onto
777  * \param control type of control frame
778  * \param data pointer to payload data to be included in frame
779  * \param datalen number of bytes of payload data
780  *
781  * \retval 0 success
782  * \retval non-zero failure
783  *
784  * The supplied payload data is copied into the frame, so the caller's copy
785  * is not modified nor freed, and the resulting frame will retain a copy of
786  * the data even if the caller frees their local copy.
787  *
788  * \note This method should be treated as a 'network transport'; in other
789  * words, your frames may be transferred across an IAX2 channel to another
790  * system, which may be a different endianness than yours. Because of this,
791  * you should ensure that either your frames will never be expected to work
792  * across systems, or that you always put your payload data into 'network byte
793  * order' before calling this function.
794  *
795  * \note The channel does not need to be locked before calling this function.
796  */
797 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
798                            const void *data, size_t datalen);
799
800 /*!
801  * \brief Change channel name
802  *
803  * \note The channel must be locked before calling this function.
804  */
805 void ast_change_name(struct ast_channel *chan, char *newname);
806
807 /*! \brief Free a channel structure */
808 void  ast_channel_free(struct ast_channel *);
809
810 /*!
811  * \brief Requests a channel
812  *
813  * \param type type of channel to request
814  * \param format requested channel format (codec)
815  * \param data data to pass to the channel requester
816  * \param status status
817  *
818  * Request a channel of a given type, with data as optional information used
819  * by the low level module
820  *
821  * \retval NULL failure
822  * \retval non-NULL channel on success
823  */
824 struct ast_channel *ast_request(const char *type, int format, void *data, int *status);
825
826 /*!
827  * \brief Request a channel of a given type, with data as optional information used
828  *        by the low level module and attempt to place a call on it
829  *
830  * \param type type of channel to request
831  * \param format requested channel format
832  * \param data data to pass to the channel requester
833  * \param timeout maximum amount of time to wait for an answer
834  * \param reason why unsuccessful (if unsuccessful)
835  * \param cid_num Caller-ID Number
836  * \param cid_name Caller-ID Name (ascii)
837  *
838  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
839  * to know if the call was answered or not.
840  */
841 struct ast_channel *ast_request_and_dial(const char *type, int format, void *data,
842         int timeout, int *reason, const char *cid_num, const char *cid_name);
843
844 /*!
845  * \brief Request a channel of a given type, with data as optional information used
846  * by the low level module and attempt to place a call on it
847  * \param type type of channel to request
848  * \param format requested channel format
849  * \param data data to pass to the channel requester
850  * \param timeout maximum amount of time to wait for an answer
851  * \param reason why unsuccessful (if unsuccessful)
852  * \param cid_num Caller-ID Number
853  * \param cid_name Caller-ID Name (ascii)
854  * \param oh Outgoing helper
855  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
856  * to know if the call was answered or not.
857  */
858 struct ast_channel *__ast_request_and_dial(const char *type, int format, void *data,
859         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
860
861 /*!\brief Register a channel technology (a new channel driver)
862  * Called by a channel module to register the kind of channels it supports.
863  * \param tech Structure defining channel technology or "type"
864  * \return Returns 0 on success, -1 on failure.
865  */
866 int ast_channel_register(const struct ast_channel_tech *tech);
867
868 /*! \brief Unregister a channel technology
869  * \param tech Structure defining channel technology or "type" that was previously registered
870  * \return No return value.
871  */
872 void ast_channel_unregister(const struct ast_channel_tech *tech);
873
874 /*! \brief Get a channel technology structure by name
875  * \param name name of technology to find
876  * \return a pointer to the structure, or NULL if no matching technology found
877  */
878 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
879
880 #ifdef CHANNEL_TRACE
881 /*! \brief Update the context backtrace if tracing is enabled
882  * \return Returns 0 on success, -1 on failure
883  */
884 int ast_channel_trace_update(struct ast_channel *chan);
885
886 /*! \brief Enable context tracing in the channel
887  * \return Returns 0 on success, -1 on failure
888  */
889 int ast_channel_trace_enable(struct ast_channel *chan);
890
891 /*! \brief Disable context tracing in the channel.
892  * \note Does not remove current trace entries
893  * \return Returns 0 on success, -1 on failure
894  */
895 int ast_channel_trace_disable(struct ast_channel *chan);
896
897 /*! \brief Whether or not context tracing is enabled
898  * \return Returns -1 when the trace is enabled. 0 if not.
899  */
900 int ast_channel_trace_is_enabled(struct ast_channel *chan);
901
902 /*! \brief Put the channel backtrace in a string
903  * \return Returns the amount of lines in the backtrace. -1 on error.
904  */
905 int ast_channel_trace_serialize(struct ast_channel *chan, struct ast_str **out);
906 #endif
907
908 /*! \brief Hang up a channel
909  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
910  * performs all stream stopping, etc, on the channel that needs to end.
911  * chan is no longer valid after this call.
912  * \param chan channel to hang up
913  * \return Returns 0 on success, -1 on failure.
914  */
915 int ast_hangup(struct ast_channel *chan);
916
917 /*!
918  * \brief Softly hangup up a channel
919  *
920  * \param chan channel to be soft-hung-up
921  * \param cause Ast hangupcause for hangup
922  *
923  * Call the protocol layer, but don't destroy the channel structure
924  * (use this if you are trying to
925  * safely hangup a channel managed by another thread.
926  *
927  * \note The channel passed to this function does not need to be locked.
928  *
929  * \return Returns 0 regardless
930  */
931 int ast_softhangup(struct ast_channel *chan, int cause);
932
933 /*! \brief Softly hangup up a channel (no channel lock)
934  * \param chan channel to be soft-hung-up
935  * \param cause Ast hangupcause for hangup (see cause.h) */
936 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
937
938 /*! \brief Check to see if a channel is needing hang up
939  * \param chan channel on which to check for hang up
940  * This function determines if the channel is being requested to be hung up.
941  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
942  */
943 int ast_check_hangup(struct ast_channel *chan);
944
945 /*!
946  * \brief Compare a offset with the settings of when to hang a channel up
947  * \param chan channel on which to check for hang up
948  * \param offset offset in seconds from current time
949  * \return 1, 0, or -1
950  * This function compares a offset from current time with the absolute time
951  * out on a channel (when to hang up). If the absolute time out on a channel
952  * is earlier than current time plus the offset, it returns 1, if the two
953  * time values are equal, it return 0, otherwise, it return -1.
954  * \sa ast_channel_cmpwhentohangup_tv()
955  * \version 1.6.1 deprecated function (only had seconds precision)
956  */
957 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
958
959 /*!
960  * \brief Compare a offset with the settings of when to hang a channel up
961  * \param chan channel on which to check for hangup
962  * \param offset offset in seconds and microseconds from current time
963  * \return 1, 0, or -1
964  * This function compares a offset from current time with the absolute time
965  * out on a channel (when to hang up). If the absolute time out on a channel
966  * is earlier than current time plus the offset, it returns 1, if the two
967  * time values are equal, it return 0, otherwise, it return -1.
968  * \since 1.6.1
969  */
970 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
971
972 /*! \brief Set when to hang a channel up
973  *
974  * \param chan channel on which to check for hang up
975  * \param offset offset in seconds relative to the current time of when to hang up
976  *
977  * This function sets the absolute time out on a channel (when to hang up).
978  *
979  * \note This function does not require that the channel is locked before
980  *       calling it.
981  *
982  * \return Nothing
983  * \sa ast_channel_setwhentohangup_tv()
984  * \version 1.6.1 deprecated function (only had seconds precision)
985  */
986 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
987
988 /*! \brief Set when to hang a channel up
989  *
990  * \param chan channel on which to check for hang up
991  * \param offset offset in seconds and useconds relative to the current time of when to hang up
992  *
993  * This function sets the absolute time out on a channel (when to hang up).
994  *
995  * \note This function does not require that the channel is locked before
996  * calling it.
997  *
998  * \return Nothing
999  * \since 1.6.1
1000  */
1001 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1002
1003 /*!
1004  * \brief Answer a channel
1005  *
1006  * \param chan channel to answer
1007  *
1008  * This function answers a channel and handles all necessary call
1009  * setup functions.
1010  *
1011  * \note The channel passed does not need to be locked.
1012  *
1013  * \retval 0 on success
1014  * \retval non-zero on failure
1015  */
1016 int ast_answer(struct ast_channel *chan);
1017 int __ast_answer(struct ast_channel *chan, unsigned int delay, int cdr_answer);
1018
1019 /*! \brief Make a call
1020  * \param chan which channel to make the call on
1021  * \param addr destination of the call
1022  * \param timeout time to wait on for connect
1023  * Place a call, take no longer than timeout ms.
1024    \return Returns -1 on failure, 0 on not enough time
1025    (does not automatically stop ringing), and
1026    the number of seconds the connect took otherwise.
1027    */
1028 int ast_call(struct ast_channel *chan, char *addr, int timeout);
1029
1030 /*! \brief Indicates condition of channel
1031  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1032  * \param chan channel to change the indication
1033  * \param condition which condition to indicate on the channel
1034  * \return Returns 0 on success, -1 on failure
1035  */
1036 int ast_indicate(struct ast_channel *chan, int condition);
1037
1038 /*! \brief Indicates condition of channel, with payload
1039  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1040  * \param chan channel to change the indication
1041  * \param condition which condition to indicate on the channel
1042  * \param data pointer to payload data
1043  * \param datalen size of payload data
1044  * \return Returns 0 on success, -1 on failure
1045  */
1046 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1047
1048 /* Misc stuff ------------------------------------------------ */
1049
1050 /*! \brief Wait for input on a channel
1051  * \param chan channel to wait on
1052  * \param ms length of time to wait on the channel
1053  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1054   \return Returns < 0 on  failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */
1055 int ast_waitfor(struct ast_channel *chan, int ms);
1056
1057 /*! \brief Wait for a specified amount of time, looking for hangups
1058  * \param chan channel to wait for
1059  * \param ms length of time in milliseconds to sleep
1060  * Waits for a specified amount of time, servicing the channel as required.
1061  * \return returns -1 on hangup, otherwise 0.
1062  */
1063 int ast_safe_sleep(struct ast_channel *chan, int ms);
1064
1065 /*! \brief Wait for a specified amount of time, looking for hangups and a condition argument
1066  * \param chan channel to wait for
1067  * \param ms length of time in milliseconds to sleep
1068  * \param cond a function pointer for testing continue condition
1069  * \param data argument to be passed to the condition test function
1070  * \return returns -1 on hangup, otherwise 0.
1071  * Waits for a specified amount of time, servicing the channel as required. If cond
1072  * returns 0, this function returns.
1073  */
1074 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1075
1076 /*! \brief Waits for activity on a group of channels
1077  * \param chan an array of pointers to channels
1078  * \param n number of channels that are to be waited upon
1079  * \param fds an array of fds to wait upon
1080  * \param nfds the number of fds to wait upon
1081  * \param exception exception flag
1082  * \param outfd fd that had activity on it
1083  * \param ms how long the wait was
1084  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1085    file descriptors.
1086    \return Returns the channel with activity, or NULL on error or if an FD
1087    came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1088    will be -1 */
1089 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1090         int *fds, int nfds, int *exception, int *outfd, int *ms);
1091
1092 /*! \brief Waits for input on a group of channels
1093    Wait for input on an array of channels for a given # of milliseconds.
1094         \return Return channel with activity, or NULL if none has activity.
1095         \param chan an array of pointers to channels
1096         \param n number of channels that are to be waited upon
1097         \param ms time "ms" is modified in-place, if applicable */
1098 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1099
1100 /*! \brief Waits for input on an fd
1101         This version works on fd's only.  Be careful with it. */
1102 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1103
1104
1105 /*! \brief Reads a frame
1106  * \param chan channel to read a frame from
1107  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1108         best just stop reading frames and assume the channel has been
1109         disconnected. */
1110 struct ast_frame *ast_read(struct ast_channel *chan);
1111
1112 /*! \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
1113         \param chan channel to read a frame from
1114         \return  Returns a frame, or NULL on error.  If it returns NULL, you
1115                 best just stop reading frames and assume the channel has been
1116                 disconnected.
1117         \note Audio is replaced with AST_FRAME_NULL to avoid
1118         transcode when the resulting audio is not necessary. */
1119 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1120
1121 /*! \brief Write a frame to a channel
1122  * This function writes the given frame to the indicated channel.
1123  * \param chan destination channel of the frame
1124  * \param frame frame that will be written
1125  * \return It returns 0 on success, -1 on failure.
1126  */
1127 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1128
1129 /*! \brief Write video frame to a channel
1130  * This function writes the given frame to the indicated channel.
1131  * \param chan destination channel of the frame
1132  * \param frame frame that will be written
1133  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1134  */
1135 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1136
1137 /*! \brief Write text frame to a channel
1138  * This function writes the given frame to the indicated channel.
1139  * \param chan destination channel of the frame
1140  * \param frame frame that will be written
1141  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1142  */
1143 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1144
1145 /*! \brief Send empty audio to prime a channel driver */
1146 int ast_prod(struct ast_channel *chan);
1147
1148 /*! \brief Sets read format on channel chan
1149  * Set read format for channel to whichever component of "format" is best.
1150  * \param chan channel to change
1151  * \param format format to change to
1152  * \return Returns 0 on success, -1 on failure
1153  */
1154 int ast_set_read_format(struct ast_channel *chan, int format);
1155
1156 /*! \brief Sets write format on channel chan
1157  * Set write format for channel to whichever component of "format" is best.
1158  * \param chan channel to change
1159  * \param format new format for writing
1160  * \return Returns 0 on success, -1 on failure
1161  */
1162 int ast_set_write_format(struct ast_channel *chan, int format);
1163
1164 /*!
1165  * \brief Sends text to a channel
1166  *
1167  * \param chan channel to act upon
1168  * \param text string of text to send on the channel
1169  *
1170  * Write text to a display on a channel
1171  *
1172  * \note The channel does not need to be locked before calling this function.
1173  *
1174  * \retval 0 on success
1175  * \retval -1 on failure
1176  */
1177 int ast_sendtext(struct ast_channel *chan, const char *text);
1178
1179 /*! \brief Receives a text character from a channel
1180  * \param chan channel to act upon
1181  * \param timeout timeout in milliseconds (0 for infinite wait)
1182  * Read a char of text from a channel
1183  * Returns 0 on success, -1 on failure
1184  */
1185 int ast_recvchar(struct ast_channel *chan, int timeout);
1186
1187 /*! \brief Send a DTMF digit to a channel
1188  * Send a DTMF digit to a channel.
1189  * \param chan channel to act upon
1190  * \param digit the DTMF digit to send, encoded in ASCII
1191  * \param duration the duration of the digit ending in ms
1192  * \return Returns 0 on success, -1 on failure
1193  */
1194 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
1195
1196 /*! \brief Send a DTMF digit to a channel
1197  * Send a DTMF digit to a channel.
1198  * \param chan channel to act upon
1199  * \param digit the DTMF digit to send, encoded in ASCII
1200  * \return Returns 0 on success, -1 on failure
1201  */
1202 int ast_senddigit_begin(struct ast_channel *chan, char digit);
1203
1204 /*! \brief Send a DTMF digit to a channel
1205
1206  * Send a DTMF digit to a channel.
1207  * \param chan channel to act upon
1208  * \param digit the DTMF digit to send, encoded in ASCII
1209  * \param duration the duration of the digit ending in ms
1210  * \return Returns 0 on success, -1 on failure
1211  */
1212 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
1213
1214 /*! \brief Receives a text string from a channel
1215  * Read a string of text from a channel
1216  * \param chan channel to act upon
1217  * \param timeout timeout in milliseconds (0 for infinite wait)
1218  * \return the received text, or NULL to signify failure.
1219  */
1220 char *ast_recvtext(struct ast_channel *chan, int timeout);
1221
1222 /*! \brief Browse channels in use
1223  * Browse the channels currently in use
1224  * \param prev where you want to start in the channel list
1225  * \return Returns the next channel in the list, NULL on end.
1226  *      If it returns a channel, that channel *has been locked*!
1227  */
1228 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev);
1229
1230 /*! \brief Get channel by name or uniqueid (locks channel) */
1231 struct ast_channel *ast_get_channel_by_name_locked(const char *chan);
1232
1233 /*! \brief Get channel by name or uniqueid prefix (locks channel) */
1234 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen);
1235
1236 /*! \brief Get channel by name or uniqueid prefix (locks channel) */
1237 struct ast_channel *ast_walk_channel_by_name_prefix_locked(const struct ast_channel *chan, const char *name, const int namelen);
1238
1239 /*! \brief Get channel by exten (and optionally context) and lock it */
1240 struct ast_channel *ast_get_channel_by_exten_locked(const char *exten, const char *context);
1241
1242 /*! \brief Get next channel by exten (and optionally context) and lock it */
1243 struct ast_channel *ast_walk_channel_by_exten_locked(const struct ast_channel *chan, const char *exten,
1244                                                      const char *context);
1245
1246 /*! \brief Search for a channel based on the passed channel matching callback
1247  * Search for a channel based on the specified is_match callback, and return the
1248  * first channel that we match.  When returned, the channel will be locked.  Note
1249  * that the is_match callback is called with the passed channel locked, and should
1250  * return 0 if there is no match, and non-zero if there is.
1251  * \param is_match callback executed on each channel until non-zero is returned, or we
1252  *        run out of channels to search.
1253  * \param data data passed to the is_match callback during each invocation.
1254  * \return Returns the matched channel, or NULL if no channel was matched.
1255  */
1256 struct ast_channel *ast_channel_search_locked(int (*is_match)(struct ast_channel *, void *), void *data);
1257
1258 /*! ! \brief Waits for a digit
1259  * \param c channel to wait for a digit on
1260  * \param ms how many milliseconds to wait
1261  * \return Returns <0 on error, 0 on no entry, and the digit on success. */
1262 int ast_waitfordigit(struct ast_channel *c, int ms);
1263
1264 /*! \brief Wait for a digit
1265  Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
1266  * \param c channel to wait for a digit on
1267  * \param ms how many milliseconds to wait
1268  * \param audiofd audio file descriptor to write to if audio frames are received
1269  * \param ctrlfd control file descriptor to monitor for reading
1270  * \return Returns 1 if ctrlfd becomes available */
1271 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
1272
1273 /*! Reads multiple digits
1274  * \param c channel to read from
1275  * \param s string to read in to.  Must be at least the size of your length
1276  * \param len how many digits to read (maximum)
1277  * \param timeout how long to timeout between digits
1278  * \param rtimeout timeout to wait on the first digit
1279  * \param enders digits to end the string
1280  * Read in a digit string "s", max length "len", maximum timeout between
1281    digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
1282    for the first digit.  Returns 0 on normal return, or 1 on a timeout.  In the case of
1283    a timeout, any digits that were read before the timeout will still be available in s.
1284    RETURNS 2 in full version when ctrlfd is available, NOT 1*/
1285 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
1286 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
1287
1288 /*! \brief Report DTMF on channel 0 */
1289 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
1290 /*! \brief Report DTMF on channel 1 */
1291 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
1292 /*! \brief Return all voice frames on channel 0 */
1293 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)
1294 /*! \brief Return all voice frames on channel 1 */
1295 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)
1296 /*! \brief Ignore all signal frames except NULL */
1297 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)
1298
1299
1300 /*! \brief Makes two channel formats compatible
1301  * \param c0 first channel to make compatible
1302  * \param c1 other channel to make compatible
1303  * Set two channels to compatible formats -- call before ast_channel_bridge in general .
1304  * \return Returns 0 on success and -1 if it could not be done */
1305 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
1306
1307 /*! Bridge two channels together (early)
1308  * \param c0 first channel to bridge
1309  * \param c1 second channel to bridge
1310  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
1311  * \return Returns 0 on success and -1 if it could not be done */
1312 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1313
1314 /*! Bridge two channels together
1315  * \param c0 first channel to bridge
1316  * \param c1 second channel to bridge
1317  * \param config config for the channels
1318  * \param fo destination frame(?)
1319  * \param rc destination channel(?)
1320  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
1321    *rf (remember, it could be NULL) and which channel (0 or 1) in rc */
1322 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
1323 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,
1324         struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
1325
1326 /*!
1327  * \brief Weird function made for call transfers
1328  *
1329  * \param original channel to make a copy of
1330  * \param clone copy of the original channel
1331  *
1332  * This is a very strange and freaky function used primarily for transfer.  Suppose that
1333  * "original" and "clone" are two channels in random situations.  This function takes
1334  * the guts out of "clone" and puts them into the "original" channel, then alerts the
1335  * channel driver of the change, asking it to fixup any private information (like the
1336  * p->owner pointer) that is affected by the change.  The physical layer of the original
1337  * channel is hung up.
1338  *
1339  * \note Neither channel passed here needs to be locked before calling this function.
1340  */
1341 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
1342
1343 /*! Gives the string form of a given cause code */
1344 /*!
1345  * \param state cause to get the description of
1346  * Give a name to a cause code
1347  * Returns the text form of the binary cause code given
1348  */
1349 const char *ast_cause2str(int state) attribute_pure;
1350
1351 /*! Convert the string form of a cause code to a number */
1352 /*!
1353  * \param name string form of the cause
1354  * Returns the cause code
1355  */
1356 int ast_str2cause(const char *name) attribute_pure;
1357
1358 /*! Gives the string form of a given channel state */
1359 /*!
1360  * \param ast_channel_state state to get the name of
1361  * Give a name to a state
1362  * Returns the text form of the binary state given
1363  */
1364 const char *ast_state2str(enum ast_channel_state);
1365
1366 /*! Gives the string form of a given transfer capability */
1367 /*!
1368  * \param transfercapability transfercapabilty to get the name of
1369  * Give a name to a transfercapbility
1370  * See above
1371  * Returns the text form of the binary transfer capability
1372  */
1373 char *ast_transfercapability2str(int transfercapability) attribute_const;
1374
1375 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the
1376    low level channel.  See frame.h for options.  Note that many channel drivers may support
1377    none or a subset of those features, and you should not count on this if you want your
1378    asterisk application to be portable.  They're mainly useful for tweaking performance */
1379
1380 /*! Sets an option on a channel */
1381 /*!
1382  * \param channel channel to set options on
1383  * \param option option to change
1384  * \param data data specific to option
1385  * \param datalen length of the data
1386  * \param block blocking or not
1387  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
1388  * Returns 0 on success and -1 on failure
1389  */
1390 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
1391
1392 /*! Pick the best codec  */
1393 /* Choose the best codec...  Uhhh...   Yah. */
1394 int ast_best_codec(int fmts);
1395
1396
1397 /*! Checks the value of an option */
1398 /*!
1399  * Query the value of an option
1400  * Works similarly to setoption except only reads the options.
1401  */
1402 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
1403
1404 /*! Checks for HTML support on a channel */
1405 /*! Returns 0 if channel does not support HTML or non-zero if it does */
1406 int ast_channel_supports_html(struct ast_channel *channel);
1407
1408 /*! Sends HTML on given channel */
1409 /*! Send HTML or URL on link.  Returns 0 on success or -1 on failure */
1410 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
1411
1412 /*! Sends a URL on a given link */
1413 /*! Send URL on link.  Returns 0 on success or -1 on failure */
1414 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
1415
1416 /*! Defers DTMF */
1417 /*! Defer DTMF so that you only read things like hangups and audio.  Returns
1418    non-zero if channel was already DTMF-deferred or 0 if channel is just now
1419    being DTMF-deferred */
1420 int ast_channel_defer_dtmf(struct ast_channel *chan);
1421
1422 /*! Undo defer.  ast_read will return any dtmf characters that were queued */
1423 void ast_channel_undefer_dtmf(struct ast_channel *chan);
1424
1425 /*! Initiate system shutdown -- prevents new channels from being allocated.
1426     If "hangup" is non-zero, all existing channels will receive soft
1427      hangups */
1428 void ast_begin_shutdown(int hangup);
1429
1430 /*! Cancels an existing shutdown and returns to normal operation */
1431 void ast_cancel_shutdown(void);
1432
1433 /*! Returns number of active/allocated channels */
1434 int ast_active_channels(void);
1435
1436 /*! Returns non-zero if Asterisk is being shut down */
1437 int ast_shutting_down(void);
1438
1439 /*! Activate a given generator */
1440 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
1441
1442 /*! Deactivate an active generator */
1443 void ast_deactivate_generator(struct ast_channel *chan);
1444
1445 /*!
1446  * \brief Set caller ID number, name and ANI
1447  *
1448  * \note The channel does not need to be locked before calling this function.
1449  */
1450 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
1451
1452 /*! Set the file descriptor on the channel */
1453 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
1454
1455 /*! Add a channel to an optimized waitfor */
1456 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
1457
1458 /*! Delete a channel from an optimized waitfor */
1459 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
1460
1461 /*! Start a tone going */
1462 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1463 /*! Stop a tone from playing */
1464 void ast_tonepair_stop(struct ast_channel *chan);
1465 /*! Play a tone pair for a given amount of time */
1466 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1467
1468 /*!
1469  * \brief Automatically service a channel for us...
1470  *
1471  * \retval 0 success
1472  * \retval -1 failure, or the channel is already being autoserviced
1473  */
1474 int ast_autoservice_start(struct ast_channel *chan);
1475
1476 /*!
1477  * \brief Stop servicing a channel for us...
1478  *
1479  * \note if chan is locked prior to calling ast_autoservice_stop, it
1480  * is likely that there will be a deadlock between the thread that calls
1481  * ast_autoservice_stop and the autoservice thread. It is important
1482  * that chan is not locked prior to this call
1483  *
1484  * \retval 0 success
1485  * \retval -1 error, or the channel has been hungup
1486  */
1487 int ast_autoservice_stop(struct ast_channel *chan);
1488
1489 /*!
1490  * \brief Enable or disable timer ticks for a channel
1491  *
1492  * \param rate number of timer ticks per second
1493  *
1494  * If timers are supported, force a scheduled expiration on the
1495  * timer fd, at which point we call the callback function / data
1496  *
1497  * Call this function with a rate of 0 to turn off the timer ticks
1498  *
1499  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
1500  */
1501 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
1502
1503 /*!     \brief Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
1504    and 1 if supported and requested
1505         \param chan current channel
1506         \param dest destination extension for transfer
1507 */
1508 int ast_transfer(struct ast_channel *chan, char *dest);
1509
1510 /*!     \brief  Start masquerading a channel
1511         XXX This is a seriously whacked out operation.  We're essentially putting the guts of
1512            the clone channel into the original channel.  Start by killing off the original
1513            channel's backend.   I'm not sure we're going to keep this function, because
1514            while the features are nice, the cost is very high in terms of pure nastiness. XXX
1515         \param chan     Channel to masquerade
1516 */
1517 int ast_do_masquerade(struct ast_channel *chan);
1518
1519 /*!     \brief Find bridged channel
1520         \param chan Current channel
1521 */
1522 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
1523
1524 /*!
1525   \brief Inherits channel variable from parent to child channel
1526   \param parent Parent channel
1527   \param child Child channel
1528
1529   Scans all channel variables in the parent channel, looking for those
1530   that should be copied into the child channel.
1531   Variables whose names begin with a single '_' are copied into the
1532   child channel with the prefix removed.
1533   Variables whose names begin with '__' are copied into the child
1534   channel with their names unchanged.
1535 */
1536 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
1537
1538 /*!
1539   \brief adds a list of channel variables to a channel
1540   \param chan the channel
1541   \param vars a linked list of variables
1542
1543   Variable names can be for a regular channel variable or a dialplan function
1544   that has the ability to be written to.
1545 */
1546 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
1547
1548 /*!
1549   \brief An opaque 'object' structure use by silence generators on channels.
1550  */
1551 struct ast_silence_generator;
1552
1553 /*!
1554   \brief Starts a silence generator on the given channel.
1555   \param chan The channel to generate silence on
1556   \return An ast_silence_generator pointer, or NULL if an error occurs
1557
1558   This function will cause SLINEAR silence to be generated on the supplied
1559   channel until it is disabled; if the channel cannot be put into SLINEAR
1560   mode then the function will fail.
1561
1562   The pointer returned by this function must be preserved and passed to
1563   ast_channel_stop_silence_generator when you wish to stop the silence
1564   generation.
1565  */
1566 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
1567
1568 /*!
1569   \brief Stops a previously-started silence generator on the given channel.
1570   \param chan The channel to operate on
1571   \param state The ast_silence_generator pointer return by a previous call to
1572   ast_channel_start_silence_generator.
1573   \return nothing
1574
1575   This function will stop the operating silence generator and return the channel
1576   to its previous write format.
1577  */
1578 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
1579
1580 /*!
1581   \brief Check if the channel can run in internal timing mode.
1582   \param chan The channel to check
1583   \return boolean
1584
1585   This function will return 1 if internal timing is enabled and the timing
1586   device is available.
1587  */
1588 int ast_internal_timing_enabled(struct ast_channel *chan);
1589
1590 /* Misc. functions below */
1591
1592 /*! \brief if fd is a valid descriptor, set *pfd with the descriptor
1593  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
1594  * return value to the index into the array)
1595  */
1596 static inline int ast_add_fd(struct pollfd *pfd, int fd)
1597 {
1598         pfd->fd = fd;
1599         pfd->events = POLLIN | POLLPRI;
1600         return fd >= 0;
1601 }
1602
1603 /*! \brief Helper function for migrating select to poll */
1604 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
1605 {
1606         int x;
1607         int dummy = 0;
1608
1609         if (fd < 0)
1610                 return 0;
1611         if (!start)
1612                 start = &dummy;
1613         for (x = *start; x < maximum; x++)
1614                 if (pfds[x].fd == fd) {
1615                         if (x == *start)
1616                                 (*start)++;
1617                         return pfds[x].revents;
1618                 }
1619         return 0;
1620 }
1621
1622 #ifndef HAVE_TIMERSUB
1623 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
1624 {
1625         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
1626         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
1627         if (tvdiff->tv_usec < 0) {
1628                 tvdiff->tv_sec --;
1629                 tvdiff->tv_usec += 1000000;
1630         }
1631
1632 }
1633 #endif
1634
1635 /*! \brief Waits for activity on a group of channels
1636  * \param nfds the maximum number of file descriptors in the sets
1637  * \param rfds file descriptors to check for read availability
1638  * \param wfds file descriptors to check for write availability
1639  * \param efds file descriptors to check for exceptions (OOB data)
1640  * \param tvp timeout while waiting for events
1641  * This is the same as a standard select(), except it guarantees the
1642  * behaviour where the passed struct timeval is updated with how much
1643  * time was not slept while waiting for the specified events
1644  */
1645 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
1646 {
1647 #ifdef __linux__
1648         return select(nfds, rfds, wfds, efds, tvp);
1649 #else
1650         if (tvp) {
1651                 struct timeval tv, tvstart, tvend, tvlen;
1652                 int res;
1653
1654                 tv = *tvp;
1655                 gettimeofday(&tvstart, NULL);
1656                 res = select(nfds, rfds, wfds, efds, tvp);
1657                 gettimeofday(&tvend, NULL);
1658                 timersub(&tvend, &tvstart, &tvlen);
1659                 timersub(&tv, &tvlen, tvp);
1660                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
1661                         tvp->tv_sec = 0;
1662                         tvp->tv_usec = 0;
1663                 }
1664                 return res;
1665         }
1666         else
1667                 return select(nfds, rfds, wfds, efds, NULL);
1668 #endif
1669 }
1670
1671 /*! \brief Retrieves the current T38 state of a channel */
1672 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
1673 {
1674         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
1675         int datalen = sizeof(state);
1676
1677         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
1678
1679         return state;
1680 }
1681
1682 #define CHECK_BLOCKING(c) do {   \
1683         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
1684                 if (option_debug) \
1685                         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); \
1686         } else { \
1687                 (c)->blocker = pthread_self(); \
1688                 (c)->blockproc = __PRETTY_FUNCTION__; \
1689                 ast_set_flag(c, AST_FLAG_BLOCKING); \
1690         } } while (0)
1691
1692 ast_group_t ast_get_group(const char *s);
1693
1694 /*! \brief print call- and pickup groups into buffer */
1695 char *ast_print_group(char *buf, int buflen, ast_group_t group);
1696
1697 /*! \brief Convert enum channelreloadreason to text string for manager event
1698         \param reason   Enum channelreloadreason - reason for reload (manager, cli, start etc)
1699 */
1700 const char *channelreloadreason2txt(enum channelreloadreason reason);
1701
1702 /*! \brief return an ast_variable list of channeltypes */
1703 struct ast_variable *ast_channeltype_list(void);
1704
1705 /*!
1706   \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
1707   \param reason  The integer argument, usually taken from AST_CONTROL_ macros
1708   \return char pointer explaining the code
1709  */
1710 const char *ast_channel_reason2str(int reason);
1711
1712 /*! \brief channel group info
1713  */
1714 struct ast_group_info {
1715         struct ast_channel *chan;
1716         char *category;
1717         char *group;
1718         AST_LIST_ENTRY(ast_group_info) list;
1719 };
1720
1721
1722 #if defined(__cplusplus) || defined(c_plusplus)
1723 }
1724 #endif
1725
1726 #endif /* _ASTERISK_CHANNEL_H */