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