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