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