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