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