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