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