5923f7cc1c86fd8f046211d8d31490328d381c56
[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 };
586
587 /*! \brief ast_bridge_config flags */
588 enum {
589         AST_FEATURE_PLAY_WARNING = (1 << 0),
590         AST_FEATURE_REDIRECT =     (1 << 1),
591         AST_FEATURE_DISCONNECT =   (1 << 2),
592         AST_FEATURE_ATXFER =       (1 << 3),
593         AST_FEATURE_AUTOMON =      (1 << 4),
594         AST_FEATURE_PARKCALL =     (1 << 5),
595         AST_FEATURE_AUTOMIXMON =   (1 << 6),
596 };
597
598 /*! \brief bridge configuration */
599 struct ast_bridge_config {
600         struct ast_flags features_caller;
601         struct ast_flags features_callee;
602         struct timeval start_time;
603         long feature_timer;
604         long timelimit;
605         long play_warning;
606         long warning_freq;
607         const char *warning_sound;
608         const char *end_sound;
609         const char *start_sound;
610         int firstpass;
611         unsigned int flags;
612 };
613
614 struct chanmon;
615
616 struct outgoing_helper {
617         const char *context;
618         const char *exten;
619         int priority;
620         const char *cid_num;
621         const char *cid_name;
622         const char *account;
623         struct ast_variable *vars;
624         struct ast_channel *parent_channel;
625 };
626
627 enum {
628         AST_CDR_TRANSFER =   (1 << 0),
629         AST_CDR_FORWARD =    (1 << 1),
630         AST_CDR_CALLWAIT =   (1 << 2),
631         AST_CDR_CONFERENCE = (1 << 3),
632 };
633
634 enum {
635         /*! Soft hangup by device */
636         AST_SOFTHANGUP_DEV =       (1 << 0),
637         /*! Soft hangup for async goto */
638         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
639         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
640         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
641         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
642         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
643         AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
644 };
645
646
647 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
648 enum channelreloadreason {
649         CHANNEL_MODULE_LOAD,
650         CHANNEL_MODULE_RELOAD,
651         CHANNEL_CLI_RELOAD,
652         CHANNEL_MANAGER_RELOAD,
653 };
654
655 /*! 
656  * \brief Create a channel datastore structure 
657  *
658  * \note None of the datastore API calls lock the ast_channel they are using.
659  *       So, the channel should be locked before calling the functions that
660  *       take a channel argument.
661  */
662 struct ast_datastore *ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid);
663
664 /*! \brief Free a channel datastore structure */
665 int ast_channel_datastore_free(struct ast_datastore *datastore);
666
667 /*! \brief Inherit datastores from a parent to a child. */
668 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
669
670 /*! 
671  * \brief Add a datastore to a channel 
672  *
673  * \note The channel should be locked before calling this function.
674  *
675  * \retval 0 success
676  * \retval non-zero failure
677  */
678
679 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
680
681 /*! 
682  * \brief Remove a datastore from a channel 
683  *
684  * \note The channel should be locked before calling this function.
685  *
686  * \retval 0 success
687  * \retval non-zero failure
688  */
689 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
690
691 /*! 
692  * \brief Find a datastore on a channel 
693  *
694  * \note The channel should be locked before calling this function.
695  *
696  * \note The datastore returned from this function must not be used if the
697  *       reference to the channel is released.
698  */
699 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
700
701 /*! \brief Change the state of a channel */
702 int ast_setstate(struct ast_channel *chan, enum ast_channel_state);
703
704 /*! 
705  * \brief Create a channel structure 
706  *
707  * \retval NULL failure
708  * \retval non-NULL successfully allocated channel
709  *
710  * \note By default, new channels are set to the "s" extension
711  *       and "default" context.
712  */
713 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, ...);
714
715 /*! 
716  * \brief Queue an outgoing frame 
717  *
718  * \note The channel does not need to be locked before calling this function.
719  */
720 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
721
722 /*! 
723  * \brief Queue a hangup frame 
724  *
725  * \note The channel does not need to be locked before calling this function.
726  */
727 int ast_queue_hangup(struct ast_channel *chan);
728
729 /*! 
730  * \brief Queue a hangup frame with hangupcause set
731  *
732  * \note The channel does not need to be locked before calling this function.
733  * \param chan channel to queue frame onto
734  * \param cause the hangup cause
735  */
736 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
737
738 /*!
739  * \brief Queue a control frame with payload
740  *
741  * \param chan channel to queue frame onto
742  * \param control type of control frame
743  *
744  * \note The channel does not need to be locked before calling this function.
745  *
746  * \retval zero on success
747  * \retval non-zero on failure
748  */
749 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
750
751 /*!
752  * \brief Queue a control frame with payload
753  *
754  * \param chan channel to queue frame onto
755  * \param control type of control frame
756  * \param data pointer to payload data to be included in frame
757  * \param datalen number of bytes of payload data
758  *
759  * \retval 0 success
760  * \retval non-zero failure
761  *
762  * The supplied payload data is copied into the frame, so the caller's copy
763  * is not modified nor freed, and the resulting frame will retain a copy of
764  * the data even if the caller frees their local copy.
765  *
766  * \note This method should be treated as a 'network transport'; in other
767  * words, your frames may be transferred across an IAX2 channel to another
768  * system, which may be a different endianness than yours. Because of this,
769  * you should ensure that either your frames will never be expected to work
770  * across systems, or that you always put your payload data into 'network byte
771  * order' before calling this function.
772  *
773  * \note The channel does not need to be locked before calling this function.
774  */
775 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
776                            const void *data, size_t datalen);
777
778 /*! 
779  * \brief Change channel name 
780  *
781  * \note The channel must be locked before calling this function.
782  */
783 void ast_change_name(struct ast_channel *chan, char *newname);
784
785 /*! \brief Free a channel structure */
786 void  ast_channel_free(struct ast_channel *);
787
788 /*! 
789  * \brief Requests a channel 
790  *
791  * \param type type of channel to request
792  * \param format requested channel format (codec)
793  * \param data data to pass to the channel requester
794  * \param status status
795  *
796  * Request a channel of a given type, with data as optional information used 
797  * by the low level module
798  *
799  * \retval NULL failure
800  * \retval non-NULL channel on success
801  */
802 struct ast_channel *ast_request(const char *type, int format, void *data, int *status);
803
804 /*!
805  * \brief Request a channel of a given type, with data as optional information used 
806  *        by the low level module and attempt to place a call on it
807  *
808  * \param type type of channel to request
809  * \param format requested channel format
810  * \param data data to pass to the channel requester
811  * \param timeout maximum amount of time to wait for an answer
812  * \param reason why unsuccessful (if unsuccessful)
813  * \param cid_num Caller-ID Number
814  * \param cid_name Caller-ID Name (ascii)
815  *
816  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
817  * to know if the call was answered or not.
818  */
819 struct ast_channel *ast_request_and_dial(const char *type, int format, void *data,
820         int timeout, int *reason, const char *cid_num, const char *cid_name);
821
822 /*!
823  * \brief Request a channel of a given type, with data as optional information used 
824  * by the low level module and attempt to place a call on it
825  * \param type type of channel to request
826  * \param format requested channel format
827  * \param data data to pass to the channel requester
828  * \param timeout maximum amount of time to wait for an answer
829  * \param reason why unsuccessful (if unsuccessful)
830  * \param cid_num Caller-ID Number
831  * \param cid_name Caller-ID Name (ascii)
832  * \param oh Outgoing helper
833  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
834  * to know if the call was answered or not.
835  */
836 struct ast_channel *__ast_request_and_dial(const char *type, int format, void *data,
837         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
838
839 /*!\brief Register a channel technology (a new channel driver)
840  * Called by a channel module to register the kind of channels it supports.
841  * \param tech Structure defining channel technology or "type"
842  * \return Returns 0 on success, -1 on failure.
843  */
844 int ast_channel_register(const struct ast_channel_tech *tech);
845
846 /*! \brief Unregister a channel technology 
847  * \param tech Structure defining channel technology or "type" that was previously registered
848  * \return No return value.
849  */
850 void ast_channel_unregister(const struct ast_channel_tech *tech);
851
852 /*! \brief Get a channel technology structure by name
853  * \param name name of technology to find
854  * \return a pointer to the structure, or NULL if no matching technology found
855  */
856 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
857
858 #ifdef CHANNEL_TRACE
859 /*! \brief Update the context backtrace if tracing is enabled
860  * \return Returns 0 on success, -1 on failure
861  */
862 int ast_channel_trace_update(struct ast_channel *chan);
863
864 /*! \brief Enable context tracing in the channel
865  * \return Returns 0 on success, -1 on failure
866  */
867 int ast_channel_trace_enable(struct ast_channel *chan);
868
869 /*! \brief Disable context tracing in the channel.
870  * \note Does not remove current trace entries
871  * \return Returns 0 on success, -1 on failure
872  */
873 int ast_channel_trace_disable(struct ast_channel *chan);
874
875 /*! \brief Whether or not context tracing is enabled
876  * \return Returns -1 when the trace is enabled. 0 if not.
877  */
878 int ast_channel_trace_is_enabled(struct ast_channel *chan);
879
880 /*! \brief Put the channel backtrace in a string
881  * \return Returns the amount of lines in the backtrace. -1 on error.
882  */
883 int ast_channel_trace_serialize(struct ast_channel *chan, struct ast_str **out);
884 #endif
885
886 /*! \brief Hang up a channel  
887  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
888  * performs all stream stopping, etc, on the channel that needs to end.
889  * chan is no longer valid after this call.
890  * \param chan channel to hang up
891  * \return Returns 0 on success, -1 on failure.
892  */
893 int ast_hangup(struct ast_channel *chan);
894
895 /*! 
896  * \brief Softly hangup up a channel 
897  *
898  * \param chan channel to be soft-hung-up
899  * \param cause Ast hangupcause for hangup
900  *
901  * Call the protocol layer, but don't destroy the channel structure 
902  * (use this if you are trying to
903  * safely hangup a channel managed by another thread.
904  *
905  * \note The channel passed to this function does not need to be locked.
906  *
907  * \return Returns 0 regardless
908  */
909 int ast_softhangup(struct ast_channel *chan, int cause);
910
911 /*! \brief Softly hangup up a channel (no channel lock) 
912  * \param chan channel to be soft-hung-up
913  * \param cause Ast hangupcause for hangup (see cause.h) */
914 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
915
916 /*! \brief Check to see if a channel is needing hang up 
917  * \param chan channel on which to check for hang up
918  * This function determines if the channel is being requested to be hung up.
919  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
920  */
921 int ast_check_hangup(struct ast_channel *chan);
922
923 /*! \brief Compare a offset with the settings of when to hang a channel up 
924  * \param chan channel on which to check for hang up
925  * \param offset offset in seconds and useconds from current time
926  * \return 1, 0, or -1
927  * This function compares a offset from current time with the absolute time 
928  * out on a channel (when to hang up). If the absolute time out on a channel
929  * is earlier than current time plus the offset, it returns 1, if the two
930  * time values are equal, it return 0, otherwise, it return -1.
931  */
932 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__ ((deprecated));
933 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
934
935 /*! \brief Set when to hang a channel up 
936  *
937  * \param chan channel on which to check for hang up
938  * \param offset offset in seconds and useconds relative to the current time of when to hang up
939  *
940  * This function sets the absolute time out on a channel (when to hang up).
941  *
942  * \note This function does not require that the channel is locked before
943  *       calling it.
944  *
945  * \return Nothing
946  */
947 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__ ((deprecated));
948 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
949
950 /*! 
951  * \brief Answer a channel
952  * 
953  * \param chan channel to answer
954  *
955  * This function answers a channel and handles all necessary call
956  * setup functions.
957  *
958  * \note The channel passed does not need to be locked.
959  *
960  * \retval 0 on success
961  * \retval non-zero on failure
962  */
963 int ast_answer(struct ast_channel *chan);
964 int __ast_answer(struct ast_channel *chan, unsigned int delay);
965
966 /*! \brief Make a call 
967  * \param chan which channel to make the call on
968  * \param addr destination of the call
969  * \param timeout time to wait on for connect
970  * Place a call, take no longer than timeout ms. 
971    \return Returns -1 on failure, 0 on not enough time 
972    (does not automatically stop ringing), and  
973    the number of seconds the connect took otherwise.
974    */
975 int ast_call(struct ast_channel *chan, char *addr, int timeout);
976
977 /*! \brief Indicates condition of channel 
978  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
979  * \param chan channel to change the indication
980  * \param condition which condition to indicate on the channel
981  * \return Returns 0 on success, -1 on failure
982  */
983 int ast_indicate(struct ast_channel *chan, int condition);
984
985 /*! \brief Indicates condition of channel, with payload
986  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
987  * \param chan channel to change the indication
988  * \param condition which condition to indicate on the channel
989  * \param data pointer to payload data
990  * \param datalen size of payload data
991  * \return Returns 0 on success, -1 on failure
992  */
993 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
994
995 /* Misc stuff ------------------------------------------------ */
996
997 /*! \brief Wait for input on a channel 
998  * \param chan channel to wait on
999  * \param ms length of time to wait on the channel
1000  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite). 
1001   \return Returns < 0 on  failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */
1002 int ast_waitfor(struct ast_channel *chan, int ms);
1003
1004 /*! \brief Wait for a specified amount of time, looking for hangups 
1005  * \param chan channel to wait for
1006  * \param ms length of time in milliseconds to sleep
1007  * Waits for a specified amount of time, servicing the channel as required.
1008  * \return returns -1 on hangup, otherwise 0.
1009  */
1010 int ast_safe_sleep(struct ast_channel *chan, int ms);
1011
1012 /*! \brief Wait for a specified amount of time, looking for hangups and a condition argument 
1013  * \param chan channel to wait for
1014  * \param ms length of time in milliseconds to sleep
1015  * \param cond a function pointer for testing continue condition
1016  * \param data argument to be passed to the condition test function
1017  * \return returns -1 on hangup, otherwise 0.
1018  * Waits for a specified amount of time, servicing the channel as required. If cond
1019  * returns 0, this function returns.
1020  */
1021 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1022
1023 /*! \brief Waits for activity on a group of channels 
1024  * \param chan an array of pointers to channels
1025  * \param n number of channels that are to be waited upon
1026  * \param fds an array of fds to wait upon
1027  * \param nfds the number of fds to wait upon
1028  * \param exception exception flag
1029  * \param outfd fd that had activity on it
1030  * \param ms how long the wait was
1031  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1032    file descriptors.
1033    \return Returns the channel with activity, or NULL on error or if an FD
1034    came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1035    will be -1 */
1036 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1037         int *fds, int nfds, int *exception, int *outfd, int *ms);
1038
1039 /*! \brief Waits for input on a group of channels
1040    Wait for input on an array of channels for a given # of milliseconds. 
1041         \return Return channel with activity, or NULL if none has activity.  
1042         \param chan an array of pointers to channels
1043         \param n number of channels that are to be waited upon
1044         \param ms time "ms" is modified in-place, if applicable */
1045 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1046
1047 /*! \brief Waits for input on an fd
1048         This version works on fd's only.  Be careful with it. */
1049 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1050
1051
1052 /*! \brief Reads a frame
1053  * \param chan channel to read a frame from
1054  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1055         best just stop reading frames and assume the channel has been
1056         disconnected. */
1057 struct ast_frame *ast_read(struct ast_channel *chan);
1058
1059 /*! \brief Reads a frame, returning AST_FRAME_NULL frame if audio. 
1060         \param chan channel to read a frame from
1061         \return  Returns a frame, or NULL on error.  If it returns NULL, you
1062                 best just stop reading frames and assume the channel has been
1063                 disconnected.  
1064         \note Audio is replaced with AST_FRAME_NULL to avoid 
1065         transcode when the resulting audio is not necessary. */
1066 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1067
1068 /*! \brief Write a frame to a channel 
1069  * This function writes the given frame to the indicated channel.
1070  * \param chan destination channel of the frame
1071  * \param frame frame that will be written
1072  * \return It returns 0 on success, -1 on failure.
1073  */
1074 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1075
1076 /*! \brief Write video frame to a channel 
1077  * This function writes the given frame to the indicated channel.
1078  * \param chan destination channel of the frame
1079  * \param frame frame that will be written
1080  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1081  */
1082 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1083
1084 /*! \brief Write text frame to a channel 
1085  * This function writes the given frame to the indicated channel.
1086  * \param chan destination channel of the frame
1087  * \param frame frame that will be written
1088  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1089  */
1090 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1091
1092 /*! \brief Send empty audio to prime a channel driver */
1093 int ast_prod(struct ast_channel *chan);
1094
1095 /*! \brief Sets read format on channel chan
1096  * Set read format for channel to whichever component of "format" is best. 
1097  * \param chan channel to change
1098  * \param format format to change to
1099  * \return Returns 0 on success, -1 on failure
1100  */
1101 int ast_set_read_format(struct ast_channel *chan, int format);
1102
1103 /*! \brief Sets write format on channel chan
1104  * Set write format for channel to whichever component of "format" is best. 
1105  * \param chan channel to change
1106  * \param format new format for writing
1107  * \return Returns 0 on success, -1 on failure
1108  */
1109 int ast_set_write_format(struct ast_channel *chan, int format);
1110
1111 /*! 
1112  * \brief Sends text to a channel 
1113  *
1114  * \param chan channel to act upon
1115  * \param text string of text to send on the channel
1116  *
1117  * Write text to a display on a channel
1118  *
1119  * \note The channel does not need to be locked before calling this function.
1120  *
1121  * \retval 0 on success 
1122  * \retval -1 on failure
1123  */
1124 int ast_sendtext(struct ast_channel *chan, const char *text);
1125
1126 /*! \brief Receives a text character from a channel
1127  * \param chan channel to act upon
1128  * \param timeout timeout in milliseconds (0 for infinite wait)
1129  * Read a char of text from a channel
1130  * Returns 0 on success, -1 on failure
1131  */
1132 int ast_recvchar(struct ast_channel *chan, int timeout);
1133
1134 /*! \brief Send a DTMF digit to a channel
1135  * Send a DTMF digit to a channel.
1136  * \param chan channel to act upon
1137  * \param digit the DTMF digit to send, encoded in ASCII
1138  * \param duration the duration of the digit ending in ms
1139  * \return Returns 0 on success, -1 on failure
1140  */
1141 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
1142
1143 /*! \brief Send a DTMF digit to a channel
1144  * Send a DTMF digit to a channel.
1145  * \param chan channel to act upon
1146  * \param digit the DTMF digit to send, encoded in ASCII
1147  * \return Returns 0 on success, -1 on failure
1148  */
1149 int ast_senddigit_begin(struct ast_channel *chan, char digit);
1150
1151 /*! \brief Send a DTMF digit to a channel
1152
1153  * Send a DTMF digit to a channel.
1154  * \param chan channel to act upon
1155  * \param digit the DTMF digit to send, encoded in ASCII
1156  * \param duration the duration of the digit ending in ms
1157  * \return Returns 0 on success, -1 on failure
1158  */
1159 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
1160
1161 /*! \brief Receives a text string from a channel
1162  * Read a string of text from a channel
1163  * \param chan channel to act upon
1164  * \param timeout timeout in milliseconds (0 for infinite wait)
1165  * \return the received text, or NULL to signify failure.
1166  */
1167 char *ast_recvtext(struct ast_channel *chan, int timeout);
1168
1169 /*! \brief Browse channels in use
1170  * Browse the channels currently in use 
1171  * \param prev where you want to start in the channel list
1172  * \return Returns the next channel in the list, NULL on end.
1173  *      If it returns a channel, that channel *has been locked*!
1174  */
1175 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev);
1176
1177 /*! \brief Get channel by name or uniqueid (locks channel) */
1178 struct ast_channel *ast_get_channel_by_name_locked(const char *chan);
1179
1180 /*! \brief Get channel by name or uniqueid prefix (locks channel) */
1181 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen);
1182
1183 /*! \brief Get channel by name or uniqueid prefix (locks channel) */
1184 struct ast_channel *ast_walk_channel_by_name_prefix_locked(const struct ast_channel *chan, const char *name, const int namelen);
1185
1186 /*! \brief Get channel by exten (and optionally context) and lock it */
1187 struct ast_channel *ast_get_channel_by_exten_locked(const char *exten, const char *context);
1188
1189 /*! \brief Get next channel by exten (and optionally context) and lock it */
1190 struct ast_channel *ast_walk_channel_by_exten_locked(const struct ast_channel *chan, const char *exten,
1191                                                      const char *context);
1192
1193 /*! ! \brief Waits for a digit
1194  * \param c channel to wait for a digit on
1195  * \param ms how many milliseconds to wait
1196  * \return Returns <0 on error, 0 on no entry, and the digit on success. */
1197 int ast_waitfordigit(struct ast_channel *c, int ms);
1198
1199 /*! \brief Wait for a digit
1200  Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading. 
1201  * \param c channel to wait for a digit on
1202  * \param ms how many milliseconds to wait
1203  * \param audiofd audio file descriptor to write to if audio frames are received
1204  * \param ctrlfd control file descriptor to monitor for reading
1205  * \return Returns 1 if ctrlfd becomes available */
1206 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
1207
1208 /*! Reads multiple digits 
1209  * \param c channel to read from
1210  * \param s string to read in to.  Must be at least the size of your length
1211  * \param len how many digits to read (maximum)
1212  * \param timeout how long to timeout between digits
1213  * \param rtimeout timeout to wait on the first digit
1214  * \param enders digits to end the string
1215  * Read in a digit string "s", max length "len", maximum timeout between 
1216    digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
1217    for the first digit.  Returns 0 on normal return, or 1 on a timeout.  In the case of
1218    a timeout, any digits that were read before the timeout will still be available in s.  
1219    RETURNS 2 in full version when ctrlfd is available, NOT 1*/
1220 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
1221 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
1222
1223 /*! \brief Report DTMF on channel 0 */
1224 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)                
1225 /*! \brief Report DTMF on channel 1 */
1226 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)                
1227 /*! \brief Return all voice frames on channel 0 */
1228 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)                
1229 /*! \brief Return all voice frames on channel 1 */
1230 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)                
1231 /*! \brief Ignore all signal frames except NULL */
1232 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)                
1233
1234
1235 /*! \brief Makes two channel formats compatible 
1236  * \param c0 first channel to make compatible
1237  * \param c1 other channel to make compatible
1238  * Set two channels to compatible formats -- call before ast_channel_bridge in general .  
1239  * \return Returns 0 on success and -1 if it could not be done */
1240 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
1241
1242 /*! Bridge two channels together (early)
1243  * \param c0 first channel to bridge
1244  * \param c1 second channel to bridge
1245  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
1246  * \return Returns 0 on success and -1 if it could not be done */
1247 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1248
1249 /*! Bridge two channels together 
1250  * \param c0 first channel to bridge
1251  * \param c1 second channel to bridge
1252  * \param config config for the channels
1253  * \param fo destination frame(?)
1254  * \param rc destination channel(?)
1255  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
1256    *rf (remember, it could be NULL) and which channel (0 or 1) in rc */
1257 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
1258 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,
1259         struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
1260
1261 /*! 
1262  * \brief Weird function made for call transfers
1263  *
1264  * \param original channel to make a copy of
1265  * \param clone copy of the original channel
1266  *
1267  * This is a very strange and freaky function used primarily for transfer.  Suppose that
1268  * "original" and "clone" are two channels in random situations.  This function takes
1269  * the guts out of "clone" and puts them into the "original" channel, then alerts the
1270  * channel driver of the change, asking it to fixup any private information (like the
1271  * p->owner pointer) that is affected by the change.  The physical layer of the original
1272  * channel is hung up.  
1273  *
1274  * \note Neither channel passed here needs to be locked before calling this function.
1275  */
1276 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
1277
1278 /*! Gives the string form of a given cause code */
1279 /*! 
1280  * \param state cause to get the description of
1281  * Give a name to a cause code
1282  * Returns the text form of the binary cause code given
1283  */
1284 const char *ast_cause2str(int state) attribute_pure;
1285
1286 /*! Convert the string form of a cause code to a number */
1287 /*! 
1288  * \param name string form of the cause
1289  * Returns the cause code
1290  */
1291 int ast_str2cause(const char *name) attribute_pure;
1292
1293 /*! Gives the string form of a given channel state */
1294 /*! 
1295  * \param ast_channel_state state to get the name of
1296  * Give a name to a state 
1297  * Returns the text form of the binary state given
1298  */
1299 const char *ast_state2str(enum ast_channel_state);
1300
1301 /*! Gives the string form of a given transfer capability */
1302 /*!
1303  * \param transfercapability transfercapabilty to get the name of
1304  * Give a name to a transfercapbility
1305  * See above
1306  * Returns the text form of the binary transfer capability
1307  */
1308 char *ast_transfercapability2str(int transfercapability) attribute_const;
1309
1310 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the
1311    low level channel.  See frame.h for options.  Note that many channel drivers may support
1312    none or a subset of those features, and you should not count on this if you want your
1313    asterisk application to be portable.  They're mainly useful for tweaking performance */
1314
1315 /*! Sets an option on a channel */
1316 /*! 
1317  * \param channel channel to set options on
1318  * \param option option to change
1319  * \param data data specific to option
1320  * \param datalen length of the data
1321  * \param block blocking or not
1322  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply 
1323  * Returns 0 on success and -1 on failure
1324  */
1325 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
1326
1327 /*! Pick the best codec  */
1328 /* Choose the best codec...  Uhhh...   Yah. */
1329 int ast_best_codec(int fmts);
1330
1331
1332 /*! Checks the value of an option */
1333 /*! 
1334  * Query the value of an option
1335  * Works similarly to setoption except only reads the options.
1336  */
1337 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
1338
1339 /*! Checks for HTML support on a channel */
1340 /*! Returns 0 if channel does not support HTML or non-zero if it does */
1341 int ast_channel_supports_html(struct ast_channel *channel);
1342
1343 /*! Sends HTML on given channel */
1344 /*! Send HTML or URL on link.  Returns 0 on success or -1 on failure */
1345 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
1346
1347 /*! Sends a URL on a given link */
1348 /*! Send URL on link.  Returns 0 on success or -1 on failure */
1349 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
1350
1351 /*! Defers DTMF */
1352 /*! Defer DTMF so that you only read things like hangups and audio.  Returns
1353    non-zero if channel was already DTMF-deferred or 0 if channel is just now
1354    being DTMF-deferred */
1355 int ast_channel_defer_dtmf(struct ast_channel *chan);
1356
1357 /*! Undo defer.  ast_read will return any dtmf characters that were queued */
1358 void ast_channel_undefer_dtmf(struct ast_channel *chan);
1359
1360 /*! Initiate system shutdown -- prevents new channels from being allocated.
1361     If "hangup" is non-zero, all existing channels will receive soft
1362      hangups */
1363 void ast_begin_shutdown(int hangup);
1364
1365 /*! Cancels an existing shutdown and returns to normal operation */
1366 void ast_cancel_shutdown(void);
1367
1368 /*! Returns number of active/allocated channels */
1369 int ast_active_channels(void);
1370
1371 /*! Returns non-zero if Asterisk is being shut down */
1372 int ast_shutting_down(void);
1373
1374 /*! Activate a given generator */
1375 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
1376
1377 /*! Deactivate an active generator */
1378 void ast_deactivate_generator(struct ast_channel *chan);
1379
1380 /*!
1381  * \brief Set caller ID number, name and ANI
1382  *
1383  * \note The channel does not need to be locked before calling this function.
1384  */
1385 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
1386
1387 /*! Set the file descriptor on the channel */
1388 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
1389
1390 /*! Add a channel to an optimized waitfor */
1391 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
1392
1393 /*! Delete a channel from an optimized waitfor */
1394 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
1395
1396 /*! Start a tone going */
1397 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1398 /*! Stop a tone from playing */
1399 void ast_tonepair_stop(struct ast_channel *chan);
1400 /*! Play a tone pair for a given amount of time */
1401 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1402
1403 /*!
1404  * \brief Automatically service a channel for us... 
1405  *
1406  * \retval 0 success
1407  * \retval -1 failure, or the channel is already being autoserviced
1408  */
1409 int ast_autoservice_start(struct ast_channel *chan);
1410
1411 /*! 
1412  * \brief Stop servicing a channel for us...  
1413  *
1414  * \retval 0 success
1415  * \retval -1 error, or the channel has been hungup 
1416  */
1417 int ast_autoservice_stop(struct ast_channel *chan);
1418
1419 /*!
1420  * \brief Enable or disable timer ticks for a channel
1421  *
1422  * \arg rate number of timer ticks per second
1423  *
1424  * If timers are supported, force a scheduled expiration on the
1425  * timer fd, at which point we call the callback function / data 
1426  *
1427  * Call this function with a rate of 0 to turn off the timer ticks
1428  */
1429 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
1430
1431 /*!     \brief Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
1432    and 1 if supported and requested 
1433         \param chan current channel
1434         \param dest destination extension for transfer
1435 */
1436 int ast_transfer(struct ast_channel *chan, char *dest);
1437
1438 /*!     \brief  Start masquerading a channel
1439         XXX This is a seriously whacked out operation.  We're essentially putting the guts of
1440            the clone channel into the original channel.  Start by killing off the original
1441            channel's backend.   I'm not sure we're going to keep this function, because
1442            while the features are nice, the cost is very high in terms of pure nastiness. XXX
1443         \param chan     Channel to masquerade
1444 */
1445 int ast_do_masquerade(struct ast_channel *chan);
1446
1447 /*!     \brief Find bridged channel 
1448         \param chan Current channel
1449 */
1450 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
1451
1452 /*!
1453   \brief Inherits channel variable from parent to child channel
1454   \param parent Parent channel
1455   \param child Child channel
1456
1457   Scans all channel variables in the parent channel, looking for those
1458   that should be copied into the child channel.
1459   Variables whose names begin with a single '_' are copied into the
1460   child channel with the prefix removed.
1461   Variables whose names begin with '__' are copied into the child
1462   channel with their names unchanged.
1463 */
1464 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
1465
1466 /*!
1467   \brief adds a list of channel variables to a channel
1468   \param chan the channel
1469   \param vars a linked list of variables
1470
1471   Variable names can be for a regular channel variable or a dialplan function
1472   that has the ability to be written to.
1473 */
1474 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
1475
1476 /*!
1477   \brief An opaque 'object' structure use by silence generators on channels.
1478  */
1479 struct ast_silence_generator;
1480
1481 /*!
1482   \brief Starts a silence generator on the given channel.
1483   \param chan The channel to generate silence on
1484   \return An ast_silence_generator pointer, or NULL if an error occurs
1485
1486   This function will cause SLINEAR silence to be generated on the supplied
1487   channel until it is disabled; if the channel cannot be put into SLINEAR
1488   mode then the function will fail.
1489
1490   The pointer returned by this function must be preserved and passed to
1491   ast_channel_stop_silence_generator when you wish to stop the silence
1492   generation.
1493  */
1494 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
1495
1496 /*!
1497   \brief Stops a previously-started silence generator on the given channel.
1498   \param chan The channel to operate on
1499   \param state The ast_silence_generator pointer return by a previous call to
1500   ast_channel_start_silence_generator.
1501   \return nothing
1502
1503   This function will stop the operating silence generator and return the channel
1504   to its previous write format.
1505  */
1506 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
1507
1508 /*!
1509   \brief Check if the channel can run in internal timing mode.
1510   \param chan The channel to check
1511   \return boolean
1512
1513   This function will return 1 if internal timing is enabled and the timing
1514   device is available.
1515  */
1516 int ast_internal_timing_enabled(struct ast_channel *chan);
1517
1518 /* Misc. functions below */
1519
1520 /*! \brief if fd is a valid descriptor, set *pfd with the descriptor
1521  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
1522  * return value to the index into the array)
1523  */
1524 static inline int ast_add_fd(struct pollfd *pfd, int fd)
1525 {
1526         pfd->fd = fd;
1527         pfd->events = POLLIN | POLLPRI;
1528         return fd >= 0;
1529 }
1530
1531 /*! \brief Helper function for migrating select to poll */
1532 static inline int ast_fdisset(struct pollfd *pfds, int fd, int max, int *start)
1533 {
1534         int x;
1535         int dummy=0;
1536
1537         if (fd < 0)
1538                 return 0;
1539         if (!start)
1540                 start = &dummy;
1541         for (x = *start; x<max; x++)
1542                 if (pfds[x].fd == fd) {
1543                         if (x == *start)
1544                                 (*start)++;
1545                         return pfds[x].revents;
1546                 }
1547         return 0;
1548 }
1549
1550 #ifndef HAVE_TIMERSUB
1551 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
1552 {
1553         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
1554         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
1555         if (tvdiff->tv_usec < 0) {
1556                 tvdiff->tv_sec --;
1557                 tvdiff->tv_usec += 1000000;
1558         }
1559
1560 }
1561 #endif
1562
1563 /*! \brief Waits for activity on a group of channels 
1564  * \param nfds the maximum number of file descriptors in the sets
1565  * \param rfds file descriptors to check for read availability
1566  * \param wfds file descriptors to check for write availability
1567  * \param efds file descriptors to check for exceptions (OOB data)
1568  * \param tvp timeout while waiting for events
1569  * This is the same as a standard select(), except it guarantees the
1570  * behaviour where the passed struct timeval is updated with how much
1571  * time was not slept while waiting for the specified events
1572  */
1573 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
1574 {
1575 #ifdef __linux__
1576         return select(nfds, rfds, wfds, efds, tvp);
1577 #else
1578         if (tvp) {
1579                 struct timeval tv, tvstart, tvend, tvlen;
1580                 int res;
1581
1582                 tv = *tvp;
1583                 gettimeofday(&tvstart, NULL);
1584                 res = select(nfds, rfds, wfds, efds, tvp);
1585                 gettimeofday(&tvend, NULL);
1586                 timersub(&tvend, &tvstart, &tvlen);
1587                 timersub(&tv, &tvlen, tvp);
1588                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
1589                         tvp->tv_sec = 0;
1590                         tvp->tv_usec = 0;
1591                 }
1592                 return res;
1593         }
1594         else
1595                 return select(nfds, rfds, wfds, efds, NULL);
1596 #endif
1597 }
1598
1599 /*! \brief Retrieves the current T38 state of a channel */
1600 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
1601 {
1602         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
1603         int datalen = sizeof(state);
1604
1605         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
1606
1607         return state;
1608 }
1609
1610 #define CHECK_BLOCKING(c) do {   \
1611         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
1612                 if (option_debug) \
1613                         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); \
1614         } else { \
1615                 (c)->blocker = pthread_self(); \
1616                 (c)->blockproc = __PRETTY_FUNCTION__; \
1617                 ast_set_flag(c, AST_FLAG_BLOCKING); \
1618         } } while (0)
1619
1620 ast_group_t ast_get_group(const char *s);
1621
1622 /*! \brief print call- and pickup groups into buffer */
1623 char *ast_print_group(char *buf, int buflen, ast_group_t group);
1624
1625 /*! \brief Convert enum channelreloadreason to text string for manager event
1626         \param reason   Enum channelreloadreason - reason for reload (manager, cli, start etc)
1627 */
1628 const char *channelreloadreason2txt(enum channelreloadreason reason);
1629
1630 /*! \brief return an ast_variable list of channeltypes */
1631 struct ast_variable *ast_channeltype_list(void);
1632
1633 /*!
1634   \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
1635   \param reason  The integer argument, usually taken from AST_CONTROL_ macros
1636   \return char pointer explaining the code
1637  */
1638 const char *ast_channel_reason2str(int reason);
1639
1640 /*! \brief channel group info
1641  */
1642 struct ast_group_info {
1643         struct ast_channel *chan;
1644         char *category;
1645         char *group;
1646         AST_LIST_ENTRY(ast_group_info) list;   
1647 };
1648
1649
1650 #if defined(__cplusplus) || defined(c_plusplus)
1651 }
1652 #endif
1653
1654 #endif /* _ASTERISK_CHANNEL_H */