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