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