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