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