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