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