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