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