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