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