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