9380d7884d99c6c5aa709ba88134eb1ed92583cf
[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
24 #include <unistd.h>
25 #include <setjmp.h>
26 #if defined(__APPLE__)
27 #include "asterisk/poll-compat.h"
28 #else
29 #include <sys/poll.h>
30 #endif
31
32 #if defined(__cplusplus) || defined(c_plusplus)
33 extern "C" {
34 #endif
35
36 #include "asterisk/lock.h"
37
38 /*! Max length of an extension */
39 #define AST_MAX_EXTENSION 80
40
41 #include "asterisk/cdr.h"
42 #include "asterisk/monitor.h"
43 #include "asterisk/utils.h"
44
45
46 #define AST_CHANNEL_NAME 80
47
48 #define MAX_LANGUAGE 20
49
50 #define MAX_MUSICCLASS 20
51
52 #define AST_MAX_FDS 8
53
54 typedef unsigned long long ast_group_t;
55
56 struct ast_generator {
57         void *(*alloc)(struct ast_channel *chan, void *params);
58         void (*release)(struct ast_channel *chan, void *data);
59         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
60 };
61
62 struct ast_callerid {
63         /*! Malloc'd Dialed Number Identifier */
64         char *cid_dnid;                         
65         /*! Malloc'd Caller Number */
66         char *cid_num;
67         /*! Malloc'd Caller Name */
68         char *cid_name;
69         /*! Malloc'd ANI */
70         char *cid_ani;                  
71         /*! Malloc'd RDNIS */
72         char *cid_rdnis;
73         /*! Callerid presentation/screening */
74         int cid_pres;
75         /*! Callerid ANI 2 (Info digits) */
76         int cid_ani2;
77         /*! Callerid Type of Number */
78         int cid_ton;
79         /*! Callerid Transit Network Select */
80         int cid_tns;
81 };
82
83 /*! Structure to describe a channel "technology" */
84
85 struct ast_channel_tech {
86         const char * const type;
87         const char * const description;
88
89         /*! Bitmap of formats this channel can handle */
90         int capabilities;
91
92         /*! Technology Properties */
93         int properties;
94
95         struct ast_channel *(* const requester)(const char *type, int format, void *data, int *cause);
96
97         int (* const devicestate)(void *data);
98
99         /*! Send a literal DTMF digit */
100         int (* const send_digit)(struct ast_channel *chan, char digit);
101
102         /*! Call a given phone number (address, etc), but don't
103            take longer than timeout seconds to do so.  */
104         int (* const call)(struct ast_channel *chan, char *addr, int timeout);
105
106         /*! Hangup (and possibly destroy) the channel */
107         int (* const hangup)(struct ast_channel *chan);
108
109         /*! Answer the line */
110         int (* const answer)(struct ast_channel *chan);
111
112         /*! Read a frame, in standard format */
113         struct ast_frame * (* const read)(struct ast_channel *chan);
114
115         /*! Write a frame, in standard format */
116         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
117
118         /*! Display or transmit text */
119         int (* const send_text)(struct ast_channel *chan, const char *text);
120
121         /*! Display or send an image */
122         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
123
124         /*! Send HTML data */
125         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
126
127         /*! Handle an exception, reading a frame */
128         struct ast_frame * (* const exception)(struct ast_channel *chan);
129
130         /*! Bridge two channels of the same type together */
131         int (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
132                              struct ast_frame **fo, struct ast_channel **rc);
133
134         /*! Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
135         int (* const indicate)(struct ast_channel *c, int condition);
136
137         /*! Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
138         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
139
140         /*! Set a given option */
141         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
142
143         /*! Query a given option */
144         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
145
146         /*! Blind transfer other side */
147         int (* const transfer)(struct ast_channel *chan, const char *newdest);
148
149         /*! Write a frame, in standard format */
150         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
151
152         /*! Find bridged channel */
153         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
154 };
155
156
157 #define CHANSPY_NEW 0
158 #define CHANSPY_RUNNING 1
159 #define CHANSPY_DONE 2
160
161 struct ast_channel_spy {
162         struct ast_frame *queue[2];
163         ast_mutex_t lock;
164         char status;
165         struct ast_channel_spy *next;
166 };
167
168
169 /*! Main Channel structure associated with a channel. */
170 /*! 
171  * This is the side of it mostly used by the pbx and call management.
172  */
173 struct ast_channel {
174         /*! ASCII Description of channel name */
175         char name[AST_CHANNEL_NAME];
176         
177         /*! Technology */
178         const struct ast_channel_tech *tech;
179         /*! Private data used by the technology driver */
180         void *tech_pvt;
181
182         /*! Language requested */
183         char language[MAX_LANGUAGE];            
184         /*! Type of channel */
185         const char *type;                               
186         /*! File descriptor for channel -- Drivers will poll on these file descriptors, so at least one must be non -1.  */
187         int fds[AST_MAX_FDS];                   
188
189         /*! Default music class */
190         char musicclass[MAX_MUSICCLASS];
191         /*! Music State*/
192         void *music_state;
193         /*! Current generator data if there is any */
194         void *generatordata;
195         /*! Current active data generator */
196         struct ast_generator *generator;
197
198         /*! Who are we bridged to, if we're bridged  Do not access directly,
199             use ast_bridged_channel(chan) */
200         struct ast_channel *_bridge;
201         /*! Channel that will masquerade as us */
202         struct ast_channel *masq;               
203         /*! Who we are masquerading as */
204         struct ast_channel *masqr;              
205         /*! Call Detail Record Flags */
206         int cdrflags;                                                                              
207         /*! Whether or not we have been hung up...  Do not set this value
208             directly, use ast_softhangup */
209         int _softhangup;                                
210         /*! Non-zero, set to actual time when channel is to be hung up */
211         time_t  whentohangup;
212         /*! If anyone is blocking, this is them */
213         pthread_t blocker;                      
214         /*! Lock, can be used to lock a channel for some operations */
215         ast_mutex_t lock;                       
216         /*! Procedure causing blocking */
217         const char *blockproc;                  
218
219         /*! Current application */
220         char *appl;                             
221         /*! Data passed to current application */
222         char *data;                             
223         
224         /*! Which fd had an event detected on */
225         int fdno;                               
226         /*! Schedule context */
227         struct sched_context *sched;            
228         /*! For streaming playback, the schedule ID */
229         int streamid;                           
230         /*! Stream itself. */
231         struct ast_filestream *stream;          
232         /*! For streaming playback, the schedule ID */
233         int vstreamid;                          
234         /*! Stream itself. */
235         struct ast_filestream *vstream;         
236         /*! Original writer format */
237         int oldwriteformat;                     
238         
239         /*! Timing fd */
240         int timingfd;
241         int (*timingfunc)(void *data);
242         void *timingdata;
243
244         /*! State of line -- Don't write directly, use ast_setstate */
245         int _state;                             
246         /*! Number of rings so far */
247         int rings;                              
248
249         /*! Kinds of data this channel can natively handle */
250         int nativeformats;                      
251         /*! Requested read format */
252         int readformat;                         
253         /*! Requested write format */
254         int writeformat;                        
255
256         struct ast_callerid cid;
257                 
258         /*! Current extension context */
259         char context[AST_MAX_EXTENSION];        
260         /*! Current non-macro context */
261         char macrocontext[AST_MAX_EXTENSION];   
262         /*! Current non-macro extension */
263         char macroexten[AST_MAX_EXTENSION];
264         /*! Current non-macro priority */
265         int macropriority;
266         /*! Current extension number */
267         char exten[AST_MAX_EXTENSION];          
268         /* Current extension priority */
269         int priority;                                           
270         /*! Any/all queued DTMF characters */
271         char dtmfq[AST_MAX_EXTENSION];          
272         /*! DTMF frame */
273         struct ast_frame dtmff;                 
274         /*! Private channel implementation details */
275         struct ast_channel_pvt *pvt;
276
277         /*! PBX private structure */
278         struct ast_pbx *pbx;
279         /*! Set BEFORE PBX is started to determine AMA flags */
280         int     amaflags;                       
281         /*! Account code for billing */
282         char    accountcode[AST_MAX_ACCOUNT_CODE];              
283         /*! Call Detail Record */
284         struct ast_cdr *cdr;                    
285         /*! Whether or not ADSI is detected on CPE */
286         int     adsicpe;
287         /*! Where to forward to if asked to dial on this interface */
288         char call_forward[AST_MAX_EXTENSION];
289
290         /*! Tone zone */
291         struct tone_zone *zone;
292
293         /* Channel monitoring */
294         struct ast_channel_monitor *monitor;
295
296         /*! Track the read/written samples for monitor use */
297         unsigned long insmpl;
298         unsigned long outsmpl;
299
300         /* Frames in/out counters */
301         unsigned int fin;
302         unsigned int fout;
303
304         /* Unique Channel Identifier */
305         char uniqueid[32];
306
307         /* Why is the channel hanged up */
308         int hangupcause;
309         
310         /* A linked list for variables */
311         struct varshead varshead;
312
313         unsigned int callgroup;
314         unsigned int pickupgroup;
315
316         /*! channel flags of AST_FLAG_ type */
317         unsigned int flags;
318         
319         /* ISDN Transfer Capbility - AST_FLAG_DIGITAL is not enough */
320         unsigned short transfercapability;
321
322         struct ast_frame *readq;
323         int alertpipe[2];
324         /*! Write translation path */
325         struct ast_trans_pvt *writetrans;
326         /*! Read translation path */
327         struct ast_trans_pvt *readtrans;
328         /*! Raw read format */
329         int rawreadformat;
330         /*! Raw write format */
331         int rawwriteformat;
332
333         /*! Chan Spy stuff */
334         struct ast_channel_spy *spiers;
335
336         /*! For easy linking */
337         struct ast_channel *next;
338
339 };
340
341 /* Channel tech properties: */
342 /* Channels have this property if they can accept input with jitter; i.e. most VoIP channels */
343 #define AST_CHAN_TP_WANTSJITTER (1 << 0)        
344
345 /* This flag has been deprecated by the transfercapbilty data member in struct ast_channel */
346 /* #define AST_FLAG_DIGITAL     (1 << 0) */     /* if the call is a digital ISDN call */
347 #define AST_FLAG_DEFER_DTMF     (1 << 1)        /* if dtmf should be deferred */
348 #define AST_FLAG_WRITE_INT      (1 << 2)        /* if write should be interrupt generator */
349 #define AST_FLAG_BLOCKING       (1 << 3)        /* if we are blocking */
350 #define AST_FLAG_ZOMBIE         (1 << 4)        /* if we are a zombie */
351 #define AST_FLAG_EXCEPTION      (1 << 5)        /* if there is a pending exception */
352 #define AST_FLAG_MOH            (1 << 6)        /* XXX anthm promises me this will disappear XXX listening to moh */
353 #define AST_FLAG_SPYING         (1 << 7)        /* XXX might also go away XXX is spying on someone */
354 #define AST_FLAG_NBRIDGE        (1 << 8)        /* is it in a native bridge */
355 #define AST_FLAG_IN_AUTOLOOP    (1 << 9)        /* the channel is in an auto-incrementing dialplan processor,
356                                                    so when ->priority is set, it will get incremented before
357                                                    finding the next priority to run
358                                                 */
359
360 #define AST_FEATURE_PLAY_WARNING        (1 << 0)
361 #define AST_FEATURE_REDIRECT            (1 << 1)
362 #define AST_FEATURE_DISCONNECT          (1 << 2)
363 #define AST_FEATURE_ATXFER              (1 << 3)
364 #define AST_FEATURE_AUTOMON             (1 << 4)
365
366 #define AST_FEATURE_FLAG_NEEDSDTMF      (1 << 0)
367
368 struct ast_bridge_config {
369         struct ast_flags features_caller;
370         struct ast_flags features_callee;
371         long timelimit;
372         long play_warning;
373         long warning_freq;
374         char *warning_sound;
375         char *end_sound;
376         char *start_sound;
377         int firstpass;
378         unsigned int flags;
379 };
380
381 struct chanmon;
382
383 #define LOAD_OH(oh) {   \
384         oh.context = context; \
385         oh.exten = exten; \
386         oh.priority = priority; \
387         oh.cid_num = cid_num; \
388         oh.cid_name = cid_name; \
389         oh.variable = variable; \
390         oh.account = account; \
391
392
393 struct outgoing_helper {
394         const char *context;
395         const char *exten;
396         int priority;
397         const char *cid_num;
398         const char *cid_name;
399         const char *variable;
400         const char *account;
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
707 int ast_senddigit(struct ast_channel *chan, char digit);
708
709 int ast_recvchar(struct ast_channel *chan, int timeout);
710
711 /*! Receives a text string from a channel */
712 /*! 
713  * \param chan channel to act upon
714  * \param timeout timeout in milliseconds (0 for infinite wait)
715  * \return the received text, or NULL to signify failure.
716  * Read a string of text from a channel
717  */
718 char *ast_recvtext(struct ast_channel *chan, int timeout);
719
720 /*! Browse channels in use */
721 /*! 
722  * \param prev where you want to start in the channel list
723  * Browse the channels currently in use 
724  * Returns the next channel in the list, NULL on end.
725  * If it returns a channel, that channel *has been locked*!
726  */
727 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev);
728
729 /*! Get channel by name (locks channel) */
730 struct ast_channel *ast_get_channel_by_name_locked(const char *chan);
731
732 /*! Get channel by name prefix (locks channel) */
733 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen);
734
735 /*! Waits for a digit */
736 /*! 
737  * \param c channel to wait for a digit on
738  * \param ms how many milliseconds to wait
739  * Wait for a digit.  Returns <0 on error, 0 on no entry, and the digit on success. */
740 int ast_waitfordigit(struct ast_channel *c, int ms);
741
742 /* Same as above with audio fd for outputing read audio and ctrlfd to monitor for
743    reading. Returns 1 if ctrlfd becomes available */
744 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
745
746 /*! Reads multiple digits */
747 /*! 
748  * \param c channel to read from
749  * \param s string to read in to.  Must be at least the size of your length
750  * \param len how many digits to read (maximum)
751  * \param timeout how long to timeout between digits
752  * \param rtimeout timeout to wait on the first digit
753  * \param enders digits to end the string
754  * Read in a digit string "s", max length "len", maximum timeout between 
755    digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
756    for the first digit.  Returns 0 on normal return, or 1 on a timeout.  In the case of
757    a timeout, any digits that were read before the timeout will still be available in s.  
758    RETURNS 2 in full version when ctrlfd is available, NOT 1*/
759 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
760 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
761
762 /*! Report DTMF on channel 0 */
763 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)                
764 /*! Report DTMF on channel 1 */
765 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)                
766 /*! Return all voice frames on channel 0 */
767 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)                
768 /*! Return all voice frames on channel 1 */
769 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)                
770 /*! Ignore all signal frames except NULL */
771 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)                
772
773
774 /*! Makes two channel formats compatible */
775 /*! 
776  * \param c0 first channel to make compatible
777  * \param c1 other channel to make compatible
778  * Set two channels to compatible formats -- call before ast_channel_bridge in general .  Returns 0 on success
779    and -1 if it could not be done */
780 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
781
782 /*! Bridge two channels together */
783 /*! 
784  * \param c0 first channel to bridge
785  * \param c1 second channel to bridge
786  * \param flags for the channels
787  * \param fo destination frame(?)
788  * \param rc destination channel(?)
789  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
790    *rf (remember, it could be NULL) and which channel (0 or 1) in rc */
791 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
792 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);
793
794 /*! Weird function made for call transfers */
795 /*! 
796  * \param original channel to make a copy of
797  * \param clone copy of the original channel
798  * This is a very strange and freaky function used primarily for transfer.  Suppose that
799    "original" and "clone" are two channels in random situations.  This function takes
800    the guts out of "clone" and puts them into the "original" channel, then alerts the
801    channel driver of the change, asking it to fixup any private information (like the
802    p->owner pointer) that is affected by the change.  The physical layer of the original
803    channel is hung up.  */
804 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
805
806 /*! Gives the string form of a given cause code */
807 /*! 
808  * \param cause cause to get the description of
809  * Give a name to a cause code
810  * Returns the text form of the binary cause code given
811  */
812 const char *ast_cause2str(int state);
813
814 /*! Gives the string form of a given channel state */
815 /*! 
816  * \param state state to get the name of
817  * Give a name to a state 
818  * Returns the text form of the binary state given
819  */
820 char *ast_state2str(int state);
821
822 /*! Gives the string form of a given transfer capability */
823 /*!
824  * \param transercapability transfercapabilty to get the name of
825  * Give a name to a transfercapbility
826  * See above
827  * Returns the text form of the binary transfer capbility
828  */
829 char *ast_transfercapability2str(int transfercapability);
830
831 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the
832    low level channel.  See frame.h for options.  Note that many channel drivers may support
833    none or a subset of those features, and you should not count on this if you want your
834    asterisk application to be portable.  They're mainly useful for tweaking performance */
835
836 /*! Sets an option on a channel */
837 /*! 
838  * \param channel channel to set options on
839  * \param option option to change
840  * \param data data specific to option
841  * \param datalen length of the data
842  * \param block blocking or not
843  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply 
844  * Returns 0 on success and -1 on failure
845  */
846 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
847
848 /*! Pick the best codec  */
849 /* Choose the best codec...  Uhhh...   Yah. */
850 extern int ast_best_codec(int fmts);
851
852
853 /*! Checks the value of an option */
854 /*! 
855  * Query the value of an option, optionally blocking until a reply is received
856  * Works similarly to setoption except only reads the options.
857  */
858 struct ast_frame *ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
859
860 /*! Checks for HTML support on a channel */
861 /*! Returns 0 if channel does not support HTML or non-zero if it does */
862 int ast_channel_supports_html(struct ast_channel *channel);
863
864 /*! Sends HTML on given channel */
865 /*! Send HTML or URL on link.  Returns 0 on success or -1 on failure */
866 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
867
868 /*! Sends a URL on a given link */
869 /*! Send URL on link.  Returns 0 on success or -1 on failure */
870 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
871
872 /*! Defers DTMF */
873 /*! Defer DTMF so that you only read things like hangups and audio.  Returns
874    non-zero if channel was already DTMF-deferred or 0 if channel is just now
875    being DTMF-deferred */
876 int ast_channel_defer_dtmf(struct ast_channel *chan);
877
878 /*! Undeos a defer */
879 /*! Undo defer.  ast_read will return any dtmf characters that were queued */
880 void ast_channel_undefer_dtmf(struct ast_channel *chan);
881
882 /*! Initiate system shutdown -- prevents new channels from being allocated.
883     If "hangup" is non-zero, all existing channels will receive soft
884      hangups */
885 void ast_begin_shutdown(int hangup);
886
887 /*! Cancels an existing shutdown and returns to normal operation */
888 void ast_cancel_shutdown(void);
889
890 /*! Returns number of active/allocated channels */
891 int ast_active_channels(void);
892
893 /*! Returns non-zero if Asterisk is being shut down */
894 int ast_shutting_down(void);
895
896 /*! Activate a given generator */
897 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
898
899 /*! Deactive an active generator */
900 void ast_deactivate_generator(struct ast_channel *chan);
901
902 void ast_set_callerid(struct ast_channel *chan, const char *cidnum, const char *cidname, const char *ani);
903
904 /*! Start a tone going */
905 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
906 /*! Stop a tone from playing */
907 void ast_tonepair_stop(struct ast_channel *chan);
908 /*! Play a tone pair for a given amount of time */
909 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
910
911 /*! Automatically service a channel for us... */
912 int ast_autoservice_start(struct ast_channel *chan);
913
914 /*! Stop servicing a channel for us...  Returns -1 on error or if channel has been hungup */
915 int ast_autoservice_stop(struct ast_channel *chan);
916
917 /* If built with zaptel optimizations, force a scheduled expiration on the
918    timer fd, at which point we call the callback function / data */
919 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(void *data), void *data);
920
921 /*!     \brief Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
922    and 1 if supported and requested 
923         \param chan current channel
924         \param dest destination extension for transfer
925 */
926 int ast_transfer(struct ast_channel *chan, char *dest);
927
928 int ast_do_masquerade(struct ast_channel *chan);
929
930 /*!     \brief Find bridged channel 
931         \param chan Current channel
932 */
933 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
934
935 /*!
936   \brief Inherits channel variable from parent to child channel
937   \param parent Parent channel
938   \param child Child channel
939
940   Scans all channel variables in the parent channel, looking for those
941   that should be copied into the child channel.
942   Variables whose names begin with a single '_' are copied into the
943   child channel with the prefix removed.
944   Variables whose names begin with '__' are copied into the child
945   channel with their names unchanged.
946 */
947 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
948
949 /* Misc. functions below */
950
951 /* Helper function for migrating select to poll */
952 static inline int ast_fdisset(struct pollfd *pfds, int fd, int max, int *start)
953 {
954         int x;
955         for (x=start ? *start : 0;x<max;x++)
956                 if (pfds[x].fd == fd) {
957                         if (start) {
958                                 if (x==*start)
959                                         (*start)++;
960                         }
961                         return pfds[x].revents;
962                 }
963         return 0;
964 }
965
966 #ifdef SOLARIS
967 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
968 {
969         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
970         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
971         if (tvdiff->tv_usec < 0) {
972                 tvdiff->tv_sec --;
973                 tvdiff->tv_usec += 1000000;
974         }
975
976 }
977 #endif
978
979 /*! Waits for activity on a group of channels */
980 /*! 
981  * \param nfds the maximum number of file descriptors in the sets
982  * \param rfds file descriptors to check for read availability
983  * \param wfds file descriptors to check for write availability
984  * \param efds file descriptors to check for exceptions (OOB data)
985  * \param tvp timeout while waiting for events
986  * This is the same as a standard select(), except it guarantees the
987  * behaviour where the passed struct timeval is updated with how much
988  * time was not slept while waiting for the specified events
989  */
990 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
991 {
992 #ifdef __linux__
993         return select(nfds, rfds, wfds, efds, tvp);
994 #else
995         if (tvp) {
996                 struct timeval tv, tvstart, tvend, tvlen;
997                 int res;
998
999                 tv = *tvp;
1000                 gettimeofday(&tvstart, NULL);
1001                 res = select(nfds, rfds, wfds, efds, tvp);
1002                 gettimeofday(&tvend, NULL);
1003                 timersub(&tvend, &tvstart, &tvlen);
1004                 timersub(&tv, &tvlen, tvp);
1005                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
1006                         tvp->tv_sec = 0;
1007                         tvp->tv_usec = 0;
1008                 }
1009                 return res;
1010         }
1011         else
1012                 return select(nfds, rfds, wfds, efds, NULL);
1013 #endif
1014 }
1015
1016 #if !defined(ast_strdupa) && defined(__GNUC__)
1017 # define ast_strdupa(s)                                                                 \
1018   (__extension__                                                                                \
1019     ({                                                                                                  \
1020       __const char *__old = (s);                                                \
1021       size_t __len = strlen (__old) + 1;                                \
1022       char *__new = (char *) __builtin_alloca (__len);  \
1023       (char *) memcpy (__new, __old, __len);                    \
1024     }))
1025 #endif
1026
1027 #ifdef DO_CRASH
1028 #define CRASH do { fprintf(stderr, "!! Forcing immediate crash a-la abort !!\n"); *((int *)0) = 0; } while(0)
1029 #else
1030 #define CRASH do { } while(0)
1031 #endif
1032
1033 #define CHECK_BLOCKING(c) {      \
1034                                                         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
1035                                                                 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); \
1036                                                                 CRASH; \
1037                                                         } else { \
1038                                                                 (c)->blocker = pthread_self(); \
1039                                                                 (c)->blockproc = __PRETTY_FUNCTION__; \
1040                                                                         ast_set_flag(c, AST_FLAG_BLOCKING); \
1041                                                                         } }
1042
1043 extern ast_group_t ast_get_group(char *s);
1044 /* print call- and pickup groups into buffer */
1045 extern char *ast_print_group(char *buf, int buflen, ast_group_t group);
1046
1047
1048 #if defined(__cplusplus) || defined(c_plusplus)
1049 }
1050 #endif
1051
1052 #endif