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