put ast_recvchar under its desc, add desc for ast_senddigit, don't use a
[asterisk/asterisk.git] / include / asterisk / channel.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * General Asterisk channel definitions.
5  * 
6  * Copyright (C) 1999 - 2005, Digium, Inc.
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #ifndef _ASTERISK_CHANNEL_H
15 #define _ASTERISK_CHANNEL_H
16
17 #ifdef SOLARIS
18 #include <solaris-compat/compat.h>
19 #endif
20 #include "asterisk/frame.h"
21 #include "asterisk/sched.h"
22 #include "asterisk/chanvars.h"
23 #include "asterisk/config.h"
24
25 #include <unistd.h>
26 #include <setjmp.h>
27 #if defined(__APPLE__)
28 #include "asterisk/poll-compat.h"
29 #else
30 #include <sys/poll.h>
31 #endif
32
33 #if defined(__cplusplus) || defined(c_plusplus)
34 extern "C" {
35 #endif
36
37 #include "asterisk/lock.h"
38
39 /*! Max length of an extension */
40 #define AST_MAX_EXTENSION       80
41
42 #define AST_MAX_CONTEXT         80
43
44 #include "asterisk/cdr.h"
45 #include "asterisk/monitor.h"
46 #include "asterisk/utils.h"
47
48 #define AST_CHANNEL_NAME        80
49
50 #define MAX_LANGUAGE            20
51
52 #define MAX_MUSICCLASS          20
53
54 #define AST_MAX_FDS             8
55
56 typedef unsigned long long ast_group_t;
57
58 struct ast_generator {
59         void *(*alloc)(struct ast_channel *chan, void *params);
60         void (*release)(struct ast_channel *chan, void *data);
61         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
62 };
63
64 struct ast_callerid {
65         /*! Malloc'd Dialed Number Identifier */
66         char *cid_dnid;                         
67         /*! Malloc'd Caller Number */
68         char *cid_num;
69         /*! Malloc'd Caller Name */
70         char *cid_name;
71         /*! Malloc'd ANI */
72         char *cid_ani;                  
73         /*! Malloc'd RDNIS */
74         char *cid_rdnis;
75         /*! Callerid presentation/screening */
76         int cid_pres;
77         /*! Callerid ANI 2 (Info digits) */
78         int cid_ani2;
79         /*! Callerid Type of Number */
80         int cid_ton;
81         /*! Callerid Transit Network Select */
82         int cid_tns;
83 };
84
85 /*! Structure to describe a channel "technology" */
86
87 struct ast_channel_tech {
88         const char * const type;
89         const char * const description;
90
91         /*! Bitmap of formats this channel can handle */
92         int capabilities;
93
94         /*! Technology Properties */
95         int properties;
96
97         struct ast_channel *(* const requester)(const char *type, int format, void *data, int *cause);
98
99         int (* const devicestate)(void *data);
100
101         /*! Send a literal DTMF digit */
102         int (* const send_digit)(struct ast_channel *chan, char digit);
103
104         /*! Call a given phone number (address, etc), but don't
105            take longer than timeout seconds to do so.  */
106         int (* const call)(struct ast_channel *chan, char *addr, int timeout);
107
108         /*! Hangup (and possibly destroy) the channel */
109         int (* const hangup)(struct ast_channel *chan);
110
111         /*! Answer the line */
112         int (* const answer)(struct ast_channel *chan);
113
114         /*! Read a frame, in standard format */
115         struct ast_frame * (* const read)(struct ast_channel *chan);
116
117         /*! Write a frame, in standard format */
118         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
119
120         /*! Display or transmit text */
121         int (* const send_text)(struct ast_channel *chan, const char *text);
122
123         /*! Display or send an image */
124         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
125
126         /*! Send HTML data */
127         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
128
129         /*! Handle an exception, reading a frame */
130         struct ast_frame * (* const exception)(struct ast_channel *chan);
131
132         /*! Bridge two channels of the same type together */
133         int (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
134                              struct ast_frame **fo, struct ast_channel **rc);
135
136         /*! Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
137         int (* const indicate)(struct ast_channel *c, int condition);
138
139         /*! Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
140         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
141
142         /*! Set a given option */
143         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
144
145         /*! Query a given option */
146         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
147
148         /*! Blind transfer other side */
149         int (* const transfer)(struct ast_channel *chan, const char *newdest);
150
151         /*! Write a frame, in standard format */
152         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
153
154         /*! Find bridged channel */
155         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
156 };
157
158
159 #define CHANSPY_NEW 0
160 #define CHANSPY_RUNNING 1
161 #define CHANSPY_DONE 2
162
163 struct ast_channel_spy {
164         struct ast_frame *queue[2];
165         ast_mutex_t lock;
166         char status;
167         struct ast_channel_spy *next;
168 };
169
170
171 /*! Main Channel structure associated with a channel. */
172 /*! 
173  * This is the side of it mostly used by the pbx and call management.
174  */
175 struct ast_channel {
176         /*! ASCII Description of channel name */
177         char name[AST_CHANNEL_NAME];
178         
179         /*! Technology */
180         const struct ast_channel_tech *tech;
181         /*! Private data used by the technology driver */
182         void *tech_pvt;
183
184         /*! Language requested */
185         char language[MAX_LANGUAGE];            
186         /*! Type of channel */
187         const char *type;                               
188         /*! File descriptor for channel -- Drivers will poll on these file descriptors, so at least one must be non -1.  */
189         int fds[AST_MAX_FDS];                   
190
191         /*! Default music class */
192         char musicclass[MAX_MUSICCLASS];
193         /*! Music State*/
194         void *music_state;
195         /*! Current generator data if there is any */
196         void *generatordata;
197         /*! Current active data generator */
198         struct ast_generator *generator;
199
200         /*! Who are we bridged to, if we're bridged  Do not access directly,
201             use ast_bridged_channel(chan) */
202         struct ast_channel *_bridge;
203         /*! Channel that will masquerade as us */
204         struct ast_channel *masq;               
205         /*! Who we are masquerading as */
206         struct ast_channel *masqr;              
207         /*! Call Detail Record Flags */
208         int cdrflags;                                                                              
209         /*! Whether or not we have been hung up...  Do not set this value
210             directly, use ast_softhangup */
211         int _softhangup;                                
212         /*! Non-zero, set to actual time when channel is to be hung up */
213         time_t  whentohangup;
214         /*! If anyone is blocking, this is them */
215         pthread_t blocker;                      
216         /*! Lock, can be used to lock a channel for some operations */
217         ast_mutex_t lock;                       
218         /*! Procedure causing blocking */
219         const char *blockproc;                  
220
221         /*! Current application */
222         char *appl;                             
223         /*! Data passed to current application */
224         char *data;                             
225         
226         /*! Which fd had an event detected on */
227         int fdno;                               
228         /*! Schedule context */
229         struct sched_context *sched;            
230         /*! For streaming playback, the schedule ID */
231         int streamid;                           
232         /*! Stream itself. */
233         struct ast_filestream *stream;          
234         /*! For streaming playback, the schedule ID */
235         int vstreamid;                          
236         /*! Stream itself. */
237         struct ast_filestream *vstream;         
238         /*! Original writer format */
239         int oldwriteformat;                     
240         
241         /*! Timing fd */
242         int timingfd;
243         int (*timingfunc)(void *data);
244         void *timingdata;
245
246         /*! State of line -- Don't write directly, use ast_setstate */
247         int _state;                             
248         /*! Number of rings so far */
249         int rings;                              
250
251         /*! Kinds of data this channel can natively handle */
252         int nativeformats;                      
253         /*! Requested read format */
254         int readformat;                         
255         /*! Requested write format */
256         int writeformat;                        
257
258         struct ast_callerid cid;
259                 
260         /*! Current extension context */
261         char context[AST_MAX_CONTEXT];
262         /*! Current non-macro context */
263         char macrocontext[AST_MAX_CONTEXT];     
264         /*! Current non-macro extension */
265         char macroexten[AST_MAX_EXTENSION];
266         /*! Current non-macro priority */
267         int macropriority;
268         /*! Current extension number */
269         char exten[AST_MAX_EXTENSION];          
270         /* Current extension priority */
271         int priority;                                           
272         /*! Any/all queued DTMF characters */
273         char dtmfq[AST_MAX_EXTENSION];          
274         /*! DTMF frame */
275         struct ast_frame dtmff;                 
276         /*! Private channel implementation details */
277         struct ast_channel_pvt *pvt;
278
279         /*! PBX private structure */
280         struct ast_pbx *pbx;
281         /*! Set BEFORE PBX is started to determine AMA flags */
282         int     amaflags;                       
283         /*! Account code for billing */
284         char    accountcode[AST_MAX_ACCOUNT_CODE];              
285         /*! Call Detail Record */
286         struct ast_cdr *cdr;                    
287         /*! Whether or not ADSI is detected on CPE */
288         int     adsicpe;
289         /*! Where to forward to if asked to dial on this interface */
290         char call_forward[AST_MAX_EXTENSION];
291
292         /*! Tone zone */
293         struct tone_zone *zone;
294
295         /* Channel monitoring */
296         struct ast_channel_monitor *monitor;
297
298         /*! Track the read/written samples for monitor use */
299         unsigned long insmpl;
300         unsigned long outsmpl;
301
302         /* Frames in/out counters */
303         unsigned int fin;
304         unsigned int fout;
305
306         /* Unique Channel Identifier */
307         char uniqueid[32];
308
309         /* Why is the channel hanged up */
310         int hangupcause;
311         
312         /* A linked list for variables */
313         struct varshead varshead;
314
315         unsigned int callgroup;
316         unsigned int pickupgroup;
317
318         /*! channel flags of AST_FLAG_ type */
319         unsigned int flags;
320         
321         /* ISDN Transfer Capbility - AST_FLAG_DIGITAL is not enough */
322         unsigned short transfercapability;
323
324         struct ast_frame *readq;
325         int alertpipe[2];
326         /*! Write translation path */
327         struct ast_trans_pvt *writetrans;
328         /*! Read translation path */
329         struct ast_trans_pvt *readtrans;
330         /*! Raw read format */
331         int rawreadformat;
332         /*! Raw write format */
333         int rawwriteformat;
334
335         /*! Chan Spy stuff */
336         struct ast_channel_spy *spiers;
337
338         /*! For easy linking */
339         struct ast_channel *next;
340
341 };
342
343 /* Channel tech properties: */
344 /* Channels have this property if they can accept input with jitter; i.e. most VoIP channels */
345 #define AST_CHAN_TP_WANTSJITTER (1 << 0)        
346
347 /* This flag has been deprecated by the transfercapbilty data member in struct ast_channel */
348 /* #define AST_FLAG_DIGITAL     (1 << 0) */     /* if the call is a digital ISDN call */
349 #define AST_FLAG_DEFER_DTMF     (1 << 1)        /* if dtmf should be deferred */
350 #define AST_FLAG_WRITE_INT      (1 << 2)        /* if write should be interrupt generator */
351 #define AST_FLAG_BLOCKING       (1 << 3)        /* if we are blocking */
352 #define AST_FLAG_ZOMBIE         (1 << 4)        /* if we are a zombie */
353 #define AST_FLAG_EXCEPTION      (1 << 5)        /* if there is a pending exception */
354 #define AST_FLAG_MOH            (1 << 6)        /* XXX anthm promises me this will disappear XXX listening to moh */
355 #define AST_FLAG_SPYING         (1 << 7)        /* XXX might also go away XXX is spying on someone */
356 #define AST_FLAG_NBRIDGE        (1 << 8)        /* is it in a native bridge */
357 #define AST_FLAG_IN_AUTOLOOP    (1 << 9)        /* the channel is in an auto-incrementing dialplan processor,
358                                                    so when ->priority is set, it will get incremented before
359                                                    finding the next priority to run
360                                                 */
361
362 #define AST_FEATURE_PLAY_WARNING        (1 << 0)
363 #define AST_FEATURE_REDIRECT            (1 << 1)
364 #define AST_FEATURE_DISCONNECT          (1 << 2)
365 #define AST_FEATURE_ATXFER              (1 << 3)
366 #define AST_FEATURE_AUTOMON             (1 << 4)
367
368 #define AST_FEATURE_FLAG_NEEDSDTMF      (1 << 0)
369
370 struct ast_bridge_config {
371         struct ast_flags features_caller;
372         struct ast_flags features_callee;
373         long timelimit;
374         long play_warning;
375         long warning_freq;
376         char *warning_sound;
377         char *end_sound;
378         char *start_sound;
379         int firstpass;
380         unsigned int flags;
381 };
382
383 struct chanmon;
384
385 #define LOAD_OH(oh) {   \
386         oh.context = context; \
387         oh.exten = exten; \
388         oh.priority = priority; \
389         oh.cid_num = cid_num; \
390         oh.cid_name = cid_name; \
391         oh.vars = vars; \
392
393
394 struct outgoing_helper {
395         const char *context;
396         const char *exten;
397         int priority;
398         const char *cid_num;
399         const char *cid_name;
400         struct ast_variable *vars;
401 };
402
403 #define AST_CDR_TRANSFER        (1 << 0)
404 #define AST_CDR_FORWARD         (1 << 1)
405 #define AST_CDR_CALLWAIT        (1 << 2)
406 #define AST_CDR_CONFERENCE      (1 << 3)
407
408 #define AST_ADSI_UNKNOWN        (0)
409 #define AST_ADSI_AVAILABLE      (1)
410 #define AST_ADSI_UNAVAILABLE    (2)
411 #define AST_ADSI_OFFHOOKONLY    (3)
412
413 #define AST_SOFTHANGUP_DEV                      (1 << 0)        /* Soft hangup by device */
414 #define AST_SOFTHANGUP_ASYNCGOTO        (1 << 1)        /* Soft hangup for async goto */
415 #define AST_SOFTHANGUP_SHUTDOWN         (1 << 2)
416 #define AST_SOFTHANGUP_TIMEOUT          (1 << 3)
417 #define AST_SOFTHANGUP_APPUNLOAD        (1 << 4)
418 #define AST_SOFTHANGUP_EXPLICIT         (1 << 5)
419 #define AST_SOFTHANGUP_UNBRIDGE     (1 << 6)
420
421 /* Bits 0-15 of state are reserved for the state (up/down) of the line */
422 /*! Channel is down and available */
423 #define AST_STATE_DOWN          0               
424 /*! Channel is down, but reserved */
425 #define AST_STATE_RESERVED      1               
426 /*! Channel is off hook */
427 #define AST_STATE_OFFHOOK       2               
428 /*! Digits (or equivalent) have been dialed */
429 #define AST_STATE_DIALING       3               
430 /*! Line is ringing */
431 #define AST_STATE_RING          4               
432 /*! Remote end is ringing */
433 #define AST_STATE_RINGING       5               
434 /*! Line is up */
435 #define AST_STATE_UP            6               
436 /*! Line is busy */
437 #define AST_STATE_BUSY          7               
438 /*! Digits (or equivalent) have been dialed while offhook */
439 #define AST_STATE_DIALING_OFFHOOK       8
440 /*! Channel has detected an incoming call and is waiting for ring */
441 #define AST_STATE_PRERING       9
442
443 /* Bits 16-32 of state are reserved for flags */
444 /*! Do not transmit voice data */
445 #define AST_STATE_MUTE          (1 << 16)       
446
447 /*! Create a channel structure */
448 /*! Returns NULL on failure to allocate. New channels are 
449         by default set to the "default" context and
450         extension "s"
451  */
452 struct ast_channel *ast_channel_alloc(int needalertpipe);
453
454 /*! Queue an outgoing frame */
455 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
456
457 /*! Queue a hangup frame */
458 int ast_queue_hangup(struct ast_channel *chan);
459
460 /*! Queue a control frame */
461 int ast_queue_control(struct ast_channel *chan, int control);
462
463 /*! Change the state of a channel */
464 int ast_setstate(struct ast_channel *chan, int state);
465
466 void ast_change_name(struct ast_channel *chan, char *newname);
467
468 /*! Free a channel structure */
469 void  ast_channel_free(struct ast_channel *);
470
471 /*! Requests a channel */
472 /*! 
473  * \param type type of channel to request
474  * \param format requested channel format
475  * \param data data to pass to the channel requester
476  * Request a channel of a given type, with data as optional information used 
477  * by the low level module
478  * Returns an ast_channel on success, NULL on failure.
479  */
480 struct ast_channel *ast_request(const char *type, int format, void *data, int *status);
481
482 /*!
483  * \param type type of channel to request
484  * \param format requested channel format
485  * \param data data to pass to the channel requester
486  * \param timeout maximum amount of time to wait for an answer
487  * \param why unsuccessful (if unsuceessful)
488  * Request a channel of a given type, with data as optional information used 
489  * by the low level module and attempt to place a call on it
490  * Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
491  * to know if the call was answered or not.
492  */
493 struct ast_channel *ast_request_and_dial(const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname);
494
495 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);
496
497 /*! Register a channel technology */
498 /*! 
499  * \param tech Structure defining channel technology or "type"
500  * Called by a channel module to register the kind of channels it supports.
501  * Returns 0 on success, -1 on failure.
502  */
503 int ast_channel_register(const struct ast_channel_tech *tech);
504
505 /*! Unregister a channel technology */
506 /*
507  * \param tech Structure defining channel technology or "type" that was previously registered
508  * No return value.
509  */
510 void ast_channel_unregister(const struct ast_channel_tech *tech);
511
512 /*! Get a channel technology structure by name
513  * \param name name of technology to find
514  * \return a pointer to the structure, or NULL if no matching technology found
515  */
516 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
517
518 /*! Hang up a channel  */
519 /*! 
520  * \param chan channel to hang up
521  * This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
522  * performs all stream stopping, etc, on the channel that needs to end.
523  * chan is no longer valid after this call.
524  * Returns 0 on success, -1 on failure.
525  */
526 int ast_hangup(struct ast_channel *chan);
527
528 /*! Softly hangup up a channel */
529 /*! 
530  * \param chan channel to be soft-hung-up
531  * Call the protocol layer, but don't destroy the channel structure (use this if you are trying to
532  * safely hangup a channel managed by another thread.
533  * \param cause Ast hangupcause for hangup
534  * Returns 0 regardless
535  */
536 int ast_softhangup(struct ast_channel *chan, int cause);
537 /*! Softly hangup up a channel (no channel lock) 
538  * \param cause Ast hangupcause for hangup */
539 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
540
541 /*! Check to see if a channel is needing hang up */
542 /*! 
543  * \param chan channel on which to check for hang up
544  * This function determines if the channel is being requested to be hung up.
545  * Returns 0 if not, or 1 if hang up is requested (including time-out).
546  */
547 int ast_check_hangup(struct ast_channel *chan);
548
549 /*! Set when to hang a channel up */
550 /*! 
551  * \param chan channel on which to check for hang up
552  * \param offset offset in seconds from current time of when to hang up
553  * This function sets the absolute time out on a channel (when to hang up).
554  */
555 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset);
556
557 /*! Answer a ringing call */
558 /*!
559  * \param chan channel to answer
560  * This function answers a channel and handles all necessary call
561  * setup functions.
562  * Returns 0 on success, -1 on failure
563  */
564 int ast_answer(struct ast_channel *chan);
565
566 /*! Make a call */
567 /*! 
568  * \param chan which channel to make the call on
569  * \param addr destination of the call
570  * \param timeout time to wait on for connect
571  * Place a call, take no longer than timeout ms.  Returns -1 on failure, 
572    0 on not enough time (does not auto matically stop ringing), and  
573    the number of seconds the connect took otherwise.
574    Returns 0 on success, -1 on failure
575    */
576 int ast_call(struct ast_channel *chan, char *addr, int timeout);
577
578 /*! Indicates condition of channel */
579 /*! 
580  * \param chan channel to change the indication
581  * \param condition which condition to indicate on the channel
582  * Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
583  * Returns 0 on success, -1 on failure
584  */
585 int ast_indicate(struct ast_channel *chan, int condition);
586
587 /* Misc stuff */
588
589 /*! Wait for input on a channel */
590 /*! 
591  * \param chan channel to wait on
592  * \param ms length of time to wait on the channel
593  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite). 
594   Returns < 0 on  failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */
595 int ast_waitfor(struct ast_channel *chan, int ms);
596
597 /*! Wait for a specied amount of time, looking for hangups */
598 /*!
599  * \param chan channel to wait for
600  * \param ms length of time in milliseconds to sleep
601  * Waits for a specified amount of time, servicing the channel as required.
602  * returns -1 on hangup, otherwise 0.
603  */
604 int ast_safe_sleep(struct ast_channel *chan, int ms);
605
606 /*! Wait for a specied amount of time, looking for hangups and a condition argument */
607 /*!
608  * \param chan channel to wait for
609  * \param ms length of time in milliseconds to sleep
610  * \param cond a function pointer for testing continue condition
611  * \param data argument to be passed to the condition test function
612  * Waits for a specified amount of time, servicing the channel as required. If cond
613  * returns 0, this function returns.
614  * returns -1 on hangup, otherwise 0.
615  */
616 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
617
618 /*! Waits for activity on a group of channels */
619 /*! 
620  * \param chan an array of pointers to channels
621  * \param n number of channels that are to be waited upon
622  * \param fds an array of fds to wait upon
623  * \param nfds the number of fds to wait upon
624  * \param exception exception flag
625  * \param outfd fd that had activity on it
626  * \param ms how long the wait was
627  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
628    file descriptors.  Returns the channel with activity, or NULL on error or if an FD
629    came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
630    will be -1 */
631 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n, int *fds, int nfds, int *exception, int *outfd, int *ms);
632
633 /*! Waits for input on a group of channels */
634 /*! Wait for input on an array of channels for a given # of milliseconds. Return channel
635    with activity, or NULL if none has activity.  time "ms" is modified in-place, if applicable */
636 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
637
638 /*! Waits for input on an fd */
639 /*! This version works on fd's only.  Be careful with it. */
640 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
641
642
643 /*! Reads a frame */
644 /*!
645  * \param chan channel to read a frame from
646  * Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
647    best just stop reading frames and assume the channel has been
648    disconnected. */
649 struct ast_frame *ast_read(struct ast_channel *chan);
650
651 /*! Write a frame to a channel */
652 /*!
653  * \param chan destination channel of the frame
654  * \param frame frame that will be written
655  * This function writes the given frame to the indicated channel.
656  * It returns 0 on success, -1 on failure.
657  */
658 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
659
660 /*! Write video frame to a channel */
661 /*!
662  * \param chan destination channel of the frame
663  * \param frame frame that will be written
664  * This function writes the given frame to the indicated channel.
665  * It returns 1 on success, 0 if not implemented, and -1 on failure.
666  */
667 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
668
669 /* Send empty audio to prime a channel driver */
670 int ast_prod(struct ast_channel *chan);
671
672 /*! Sets read format on channel chan */
673 /*! 
674  * \param chan channel to change
675  * \param format format to change to
676  * Set read format for channel to whichever component of "format" is best. 
677  * Returns 0 on success, -1 on failure
678  */
679 int ast_set_read_format(struct ast_channel *chan, int format);
680
681 /*! Sets write format on channel chan */
682 /*! 
683  * \param chan channel to change
684  * \param format new format for writing
685  * Set write format for channel to whichever compoent of "format" is best. 
686  * Returns 0 on success, -1 on failure
687  */
688 int ast_set_write_format(struct ast_channel *chan, int format);
689
690 /*! Sends text to a channel */
691 /*! 
692  * \param chan channel to act upon
693  * \param text string of text to send on the channel
694  * Write text to a display on a channel
695  * Returns 0 on success, -1 on failure
696  */
697 int ast_sendtext(struct ast_channel *chan, char *text);
698
699 /*! Receives a text character from a channel */
700 /*! 
701  * \param chan channel to act upon
702  * \param timeout timeout in milliseconds (0 for infinite wait)
703  * Read a char of text from a channel
704  * Returns 0 on success, -1 on failure
705  */
706 int ast_recvchar(struct ast_channel *chan, int timeout);
707
708 /*! Send a DTMF digit to a channel */
709 /*! 
710  * \param chan channel to act upon
711  * \param digit the DTMF digit to send, encoded in ASCII
712  * Send a DTMF digit to a channel.
713  * Returns 0 on success, -1 on failure
714  */
715 int ast_senddigit(struct ast_channel *chan, char digit);
716
717 /*! Receives a text string from a channel */
718 /*! 
719  * \param chan channel to act upon
720  * \param timeout timeout in milliseconds (0 for infinite wait)
721  * \return the received text, or NULL to signify failure.
722  * Read a string of text from a channel
723  */
724 char *ast_recvtext(struct ast_channel *chan, int timeout);
725
726 /*! Browse channels in use */
727 /*! 
728  * \param prev where you want to start in the channel list
729  * Browse the channels currently in use 
730  * Returns the next channel in the list, NULL on end.
731  * If it returns a channel, that channel *has been locked*!
732  */
733 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev);
734
735 /*! Get channel by name (locks channel) */
736 struct ast_channel *ast_get_channel_by_name_locked(const char *chan);
737
738 /*! Get channel by name prefix (locks channel) */
739 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen);
740
741 /*! Waits for a digit */
742 /*! 
743  * \param c channel to wait for a digit on
744  * \param ms how many milliseconds to wait
745  * Wait for a digit.  Returns <0 on error, 0 on no entry, and the digit on success. */
746 int ast_waitfordigit(struct ast_channel *c, int ms);
747
748 /* Same as above with audio fd for outputing read audio and ctrlfd to monitor for
749    reading. Returns 1 if ctrlfd becomes available */
750 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
751
752 /*! Reads multiple digits */
753 /*! 
754  * \param c channel to read from
755  * \param s string to read in to.  Must be at least the size of your length
756  * \param len how many digits to read (maximum)
757  * \param timeout how long to timeout between digits
758  * \param rtimeout timeout to wait on the first digit
759  * \param enders digits to end the string
760  * Read in a digit string "s", max length "len", maximum timeout between 
761    digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
762    for the first digit.  Returns 0 on normal return, or 1 on a timeout.  In the case of
763    a timeout, any digits that were read before the timeout will still be available in s.  
764    RETURNS 2 in full version when ctrlfd is available, NOT 1*/
765 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
766 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
767
768 /*! Report DTMF on channel 0 */
769 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)                
770 /*! Report DTMF on channel 1 */
771 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)                
772 /*! Return all voice frames on channel 0 */
773 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)                
774 /*! Return all voice frames on channel 1 */
775 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)                
776 /*! Ignore all signal frames except NULL */
777 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)                
778
779
780 /*! Makes two channel formats compatible */
781 /*! 
782  * \param c0 first channel to make compatible
783  * \param c1 other channel to make compatible
784  * Set two channels to compatible formats -- call before ast_channel_bridge in general .  Returns 0 on success
785    and -1 if it could not be done */
786 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
787
788 /*! Bridge two channels together */
789 /*! 
790  * \param c0 first channel to bridge
791  * \param c1 second channel to bridge
792  * \param flags for the channels
793  * \param fo destination frame(?)
794  * \param rc destination channel(?)
795  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
796    *rf (remember, it could be NULL) and which channel (0 or 1) in rc */
797 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
798 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);
799
800 /*! Weird function made for call transfers */
801 /*! 
802  * \param original channel to make a copy of
803  * \param clone copy of the original channel
804  * This is a very strange and freaky function used primarily for transfer.  Suppose that
805    "original" and "clone" are two channels in random situations.  This function takes
806    the guts out of "clone" and puts them into the "original" channel, then alerts the
807    channel driver of the change, asking it to fixup any private information (like the
808    p->owner pointer) that is affected by the change.  The physical layer of the original
809    channel is hung up.  */
810 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
811
812 /*! Gives the string form of a given cause code */
813 /*! 
814  * \param cause cause to get the description of
815  * Give a name to a cause code
816  * Returns the text form of the binary cause code given
817  */
818 const char *ast_cause2str(int state);
819
820 /*! Gives the string form of a given channel state */
821 /*! 
822  * \param state state to get the name of
823  * Give a name to a state 
824  * Returns the text form of the binary state given
825  */
826 char *ast_state2str(int state);
827
828 /*! Gives the string form of a given transfer capability */
829 /*!
830  * \param transercapability transfercapabilty to get the name of
831  * Give a name to a transfercapbility
832  * See above
833  * Returns the text form of the binary transfer capbility
834  */
835 char *ast_transfercapability2str(int transfercapability);
836
837 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the
838    low level channel.  See frame.h for options.  Note that many channel drivers may support
839    none or a subset of those features, and you should not count on this if you want your
840    asterisk application to be portable.  They're mainly useful for tweaking performance */
841
842 /*! Sets an option on a channel */
843 /*! 
844  * \param channel channel to set options on
845  * \param option option to change
846  * \param data data specific to option
847  * \param datalen length of the data
848  * \param block blocking or not
849  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply 
850  * Returns 0 on success and -1 on failure
851  */
852 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
853
854 /*! Pick the best codec  */
855 /* Choose the best codec...  Uhhh...   Yah. */
856 extern int ast_best_codec(int fmts);
857
858
859 /*! Checks the value of an option */
860 /*! 
861  * Query the value of an option, optionally blocking until a reply is received
862  * Works similarly to setoption except only reads the options.
863  */
864 struct ast_frame *ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
865
866 /*! Checks for HTML support on a channel */
867 /*! Returns 0 if channel does not support HTML or non-zero if it does */
868 int ast_channel_supports_html(struct ast_channel *channel);
869
870 /*! Sends HTML on given channel */
871 /*! Send HTML or URL on link.  Returns 0 on success or -1 on failure */
872 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
873
874 /*! Sends a URL on a given link */
875 /*! Send URL on link.  Returns 0 on success or -1 on failure */
876 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
877
878 /*! Defers DTMF */
879 /*! Defer DTMF so that you only read things like hangups and audio.  Returns
880    non-zero if channel was already DTMF-deferred or 0 if channel is just now
881    being DTMF-deferred */
882 int ast_channel_defer_dtmf(struct ast_channel *chan);
883
884 /*! Undeos a defer */
885 /*! Undo defer.  ast_read will return any dtmf characters that were queued */
886 void ast_channel_undefer_dtmf(struct ast_channel *chan);
887
888 /*! Initiate system shutdown -- prevents new channels from being allocated.
889     If "hangup" is non-zero, all existing channels will receive soft
890      hangups */
891 void ast_begin_shutdown(int hangup);
892
893 /*! Cancels an existing shutdown and returns to normal operation */
894 void ast_cancel_shutdown(void);
895
896 /*! Returns number of active/allocated channels */
897 int ast_active_channels(void);
898
899 /*! Returns non-zero if Asterisk is being shut down */
900 int ast_shutting_down(void);
901
902 /*! Activate a given generator */
903 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
904
905 /*! Deactive an active generator */
906 void ast_deactivate_generator(struct ast_channel *chan);
907
908 void ast_set_callerid(struct ast_channel *chan, const char *cidnum, const char *cidname, const char *ani);
909
910 /*! Start a tone going */
911 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
912 /*! Stop a tone from playing */
913 void ast_tonepair_stop(struct ast_channel *chan);
914 /*! Play a tone pair for a given amount of time */
915 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
916
917 /*! Automatically service a channel for us... */
918 int ast_autoservice_start(struct ast_channel *chan);
919
920 /*! Stop servicing a channel for us...  Returns -1 on error or if channel has been hungup */
921 int ast_autoservice_stop(struct ast_channel *chan);
922
923 /* If built with zaptel optimizations, force a scheduled expiration on the
924    timer fd, at which point we call the callback function / data */
925 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(void *data), void *data);
926
927 /*!     \brief Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
928    and 1 if supported and requested 
929         \param chan current channel
930         \param dest destination extension for transfer
931 */
932 int ast_transfer(struct ast_channel *chan, char *dest);
933
934 int ast_do_masquerade(struct ast_channel *chan);
935
936 /*!     \brief Find bridged channel 
937         \param chan Current channel
938 */
939 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
940
941 /*!
942   \brief Inherits channel variable from parent to child channel
943   \param parent Parent channel
944   \param child Child channel
945
946   Scans all channel variables in the parent channel, looking for those
947   that should be copied into the child channel.
948   Variables whose names begin with a single '_' are copied into the
949   child channel with the prefix removed.
950   Variables whose names begin with '__' are copied into the child
951   channel with their names unchanged.
952 */
953 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
954
955 /*!
956   \brief adds a list of channel variables to a channel
957   \param chan the channel
958   \param vars a linked list of variables
959
960   Variable names can be for a regular channel variable or a dialplan function
961   that has the ability to be written to.
962 */
963 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
964
965 /* Misc. functions below */
966
967 /* Helper function for migrating select to poll */
968 static inline int ast_fdisset(struct pollfd *pfds, int fd, int max, int *start)
969 {
970         int x;
971         for (x=start ? *start : 0;x<max;x++)
972                 if (pfds[x].fd == fd) {
973                         if (start) {
974                                 if (x==*start)
975                                         (*start)++;
976                         }
977                         return pfds[x].revents;
978                 }
979         return 0;
980 }
981
982 #ifdef SOLARIS
983 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
984 {
985         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
986         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
987         if (tvdiff->tv_usec < 0) {
988                 tvdiff->tv_sec --;
989                 tvdiff->tv_usec += 1000000;
990         }
991
992 }
993 #endif
994
995 /*! Waits for activity on a group of channels */
996 /*! 
997  * \param nfds the maximum number of file descriptors in the sets
998  * \param rfds file descriptors to check for read availability
999  * \param wfds file descriptors to check for write availability
1000  * \param efds file descriptors to check for exceptions (OOB data)
1001  * \param tvp timeout while waiting for events
1002  * This is the same as a standard select(), except it guarantees the
1003  * behaviour where the passed struct timeval is updated with how much
1004  * time was not slept while waiting for the specified events
1005  */
1006 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
1007 {
1008 #ifdef __linux__
1009         return select(nfds, rfds, wfds, efds, tvp);
1010 #else
1011         if (tvp) {
1012                 struct timeval tv, tvstart, tvend, tvlen;
1013                 int res;
1014
1015                 tv = *tvp;
1016                 gettimeofday(&tvstart, NULL);
1017                 res = select(nfds, rfds, wfds, efds, tvp);
1018                 gettimeofday(&tvend, NULL);
1019                 timersub(&tvend, &tvstart, &tvlen);
1020                 timersub(&tv, &tvlen, tvp);
1021                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
1022                         tvp->tv_sec = 0;
1023                         tvp->tv_usec = 0;
1024                 }
1025                 return res;
1026         }
1027         else
1028                 return select(nfds, rfds, wfds, efds, NULL);
1029 #endif
1030 }
1031
1032 #if !defined(ast_strdupa) && defined(__GNUC__)
1033 # define ast_strdupa(s)                                                                 \
1034   (__extension__                                                                                \
1035     ({                                                                                                  \
1036       __const char *__old = (s);                                                \
1037       size_t __len = strlen (__old) + 1;                                \
1038       char *__new = (char *) __builtin_alloca (__len);  \
1039       (char *) memcpy (__new, __old, __len);                    \
1040     }))
1041 #endif
1042
1043 #ifdef DO_CRASH
1044 #define CRASH do { fprintf(stderr, "!! Forcing immediate crash a-la abort !!\n"); *((int *)0) = 0; } while(0)
1045 #else
1046 #define CRASH do { } while(0)
1047 #endif
1048
1049 #define CHECK_BLOCKING(c) {      \
1050                                                         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
1051                                                                 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); \
1052                                                                 CRASH; \
1053                                                         } else { \
1054                                                                 (c)->blocker = pthread_self(); \
1055                                                                 (c)->blockproc = __PRETTY_FUNCTION__; \
1056                                                                         ast_set_flag(c, AST_FLAG_BLOCKING); \
1057                                                                         } }
1058
1059 extern ast_group_t ast_get_group(char *s);
1060 /* print call- and pickup groups into buffer */
1061 extern char *ast_print_group(char *buf, int buflen, ast_group_t group);
1062
1063
1064 #if defined(__cplusplus) || defined(c_plusplus)
1065 }
1066 #endif
1067
1068 #endif