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