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