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