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