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