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