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