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