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