d90be73e6f62a4644f7ad6b9325ffb784bc86f12
[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, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
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 #include <asterisk/frame.h>
18 #include <asterisk/sched.h>
19 #include <asterisk/chanvars.h>
20 #include <unistd.h>
21 #include <setjmp.h>
22 #include <pthread.h>
23
24 #if defined(__cplusplus) || defined(c_plusplus)
25 extern "C" {
26 #endif
27
28 #include <asterisk/lock.h>
29
30 //! Max length of an extension
31 #define AST_MAX_EXTENSION 80
32
33 #include <asterisk/cdr.h>
34 #include <asterisk/monitor.h>
35
36
37 #define AST_CHANNEL_NAME 80
38 #define AST_CHANNEL_MAX_STACK 32
39
40 #define MAX_LANGUAGE 20
41
42
43 #define AST_MAX_FDS 8
44
45 struct ast_generator {
46         void *(*alloc)(struct ast_channel *chan, void *params);
47         void (*release)(struct ast_channel *chan, void *data);
48         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
49 };
50
51 //! Main Channel structure associated with a channel.
52 /*! 
53  * This is the side of it mostly used by the pbx and call management.
54  */
55 struct ast_channel {
56         /*! ASCII Description of channel name */
57         char name[AST_CHANNEL_NAME];            
58         /*! Language requested */
59         char language[MAX_LANGUAGE];            
60         /*! Type of channel */
61         char *type;                             
62         /*! File descriptor for channel -- Drivers will poll on these file descriptors, so at least one must be non -1.  */
63         int fds[AST_MAX_FDS];                   
64
65         /*! Default music class */
66         char musicclass[MAX_LANGUAGE];
67
68         /*! Current generator data if there is any */
69         void *generatordata;
70         /*! Current active data generator */
71         struct ast_generator *generator;
72         /*! Whether or not the generator should be interrupted by write */
73         int writeinterrupt;
74
75         /*! Who are we bridged to, if we're bridged */
76         struct ast_channel *bridge;
77         /*! Who did we call? */
78         struct ast_channel *dialed;
79         /*! Who called us? */
80         struct ast_channel *dialing;
81         /*! Reverse the dialed link (0 false, 1 true) */
82         int reversedialed;
83         /*! Channel that will masquerade as us */
84         struct ast_channel *masq;               
85         /*! Who we are masquerading as */
86         struct ast_channel *masqr;              
87         /*! Call Detail Record Flags */
88         int cdrflags;                                                                              
89         /*! Whether or not we're blocking */
90         int blocking;                           
91         /*! Whether or not we have been hung up...  Do not set this value
92             directly, use ast_softhangup */
93         int _softhangup;                                
94         /*! Non-zero if this is a zombie channel */
95         int zombie;                                     
96         /*! Non-zero, set to actual time when channel is to be hung up */
97         time_t  whentohangup;
98         /*! If anyone is blocking, this is them */
99         pthread_t blocker;                      
100         /*! Lock, can be used to lock a channel for some operations */
101         ast_mutex_t lock;                       
102         /*! Procedure causing blocking */
103         char *blockproc;                        
104
105         /*! Current application */
106         char *appl;                             
107         /*! Data passed to current application */
108         char *data;                             
109         
110         /*! Has an exception been detected */
111         int exception;                          
112         /*! Which fd had an event detected on */
113         int fdno;                               
114         /*! Schedule context */
115         struct sched_context *sched;            
116         /*! For streaming playback, the schedule ID */
117         int streamid;                           
118         /*! Stream itself. */
119         struct ast_filestream *stream;          
120         /*! For streaming playback, the schedule ID */
121         int vstreamid;                          
122         /*! Stream itself. */
123         struct ast_filestream *vstream;         
124         /*! Original writer format */
125         int oldwriteformat;                     
126         
127         /*! Timing fd */
128         int timingfd;
129         int (*timingfunc)(void *data);
130         void *timingdata;
131
132         /*! State of line -- Don't write directly, use ast_setstate */
133         int _state;                             
134         /*! Number of rings so far */
135         int rings;                              
136         /*! Current level of application */
137         int stack;
138
139
140         /*! Kinds of data this channel can natively handle */
141         int nativeformats;                      
142         /*! Requested read format */
143         int readformat;                         
144         /*! Requested write format */
145         int writeformat;                        
146
147         
148         /*! Malloc'd Dialed Number Identifier */
149         char *dnid;                             
150         /*! Malloc'd Caller ID */
151         char *callerid;                         
152         /*! Malloc'd ANI */
153         char *ani;                      
154         /*! Malloc'd RDNIS */
155         char *rdnis;
156         /*! Hide callerid from user */
157         int restrictcid;
158         /*! Callerid presentation/screening */
159         int callingpres;
160
161         
162         /*! Current extension context */
163         char context[AST_MAX_EXTENSION];        
164         /*! Current non-macro context */
165         char macrocontext[AST_MAX_EXTENSION];   
166         /*! Current non-macro extension */
167         char macroexten[AST_MAX_EXTENSION];
168         /*! Current non-macro priority */
169         int macropriority;
170         /*! Current extension number */
171         char exten[AST_MAX_EXTENSION];          
172         /* Current extension priority */
173         int priority;                                           
174         /*! Application information -- see assigned numbers */
175         void *app[AST_CHANNEL_MAX_STACK];       
176         /*! Any/all queued DTMF characters */
177         char dtmfq[AST_MAX_EXTENSION];          
178         /*! Are DTMF digits being deferred */
179         int deferdtmf;                          
180         /*! DTMF frame */
181         struct ast_frame dtmff;                 
182         /*! Private channel implementation details */
183         struct ast_channel_pvt *pvt;
184
185                                                 
186         /*! Jump buffer used for returning from applications */
187         jmp_buf jmp[AST_CHANNEL_MAX_STACK];     
188
189         struct ast_pbx *pbx;
190         /*! Set BEFORE PBX is started to determine AMA flags */
191         int     amaflags;                       
192         /*! Account code for billing */
193         char    accountcode[20];                
194         /*! Call Detail Record */
195         struct ast_cdr *cdr;                    
196         /*! Whether or not ADSI is detected on CPE */
197         int     adsicpe;
198         /*! Where to forward to if asked to dial on this interface */
199         char call_forward[AST_MAX_EXTENSION];
200
201         /*! Tone zone */
202         struct tone_zone *zone;
203
204         /* Channel monitoring */
205         struct ast_channel_monitor *monitor;
206
207         /*! Track the read/written samples for monitor use */
208         unsigned long insmpl;
209         unsigned long outsmpl;
210
211         /* Frames in/out counters */
212         unsigned int fin;
213         unsigned int fout;
214
215         /* Unique Channel Identifier */
216         char uniqueid[32];
217
218         /* Why is the channel hanged up */
219         int hangupcause;
220         
221         /* A linked list for variables */
222         struct ast_var_t *vars; 
223         AST_LIST_HEAD(varshead,ast_var_t) varshead;
224
225         unsigned int callgroup;
226         unsigned int pickupgroup;
227         
228         /*! For easy linking */
229         struct ast_channel *next;
230
231 };
232
233 struct chanmon;
234
235 #define LOAD_OH(oh) {   \
236         oh.context = context; \
237         oh.exten = exten; \
238         oh.priority = priority; \
239         oh.callerid = callerid; \
240         oh.variable = variable; \
241
242
243 struct outgoing_helper {
244         char *context;
245         char *exten;
246         int priority;
247         char *callerid;
248         char *variable;
249 };
250
251 #define AST_CDR_TRANSFER        (1 << 0)
252 #define AST_CDR_FORWARD         (1 << 1)
253 #define AST_CDR_CALLWAIT        (1 << 2)
254 #define AST_CDR_CONFERENCE      (1 << 3)
255
256 #define AST_ADSI_UNKNOWN        (0)
257 #define AST_ADSI_AVAILABLE      (1)
258 #define AST_ADSI_UNAVAILABLE    (2)
259 #define AST_ADSI_OFFHOOKONLY    (3)
260
261 #define AST_SOFTHANGUP_DEV                      (1 << 0)        /* Soft hangup by device */
262 #define AST_SOFTHANGUP_ASYNCGOTO        (1 << 1)        /* Soft hangup for async goto */
263 #define AST_SOFTHANGUP_SHUTDOWN         (1 << 2)
264 #define AST_SOFTHANGUP_TIMEOUT          (1 << 3)
265 #define AST_SOFTHANGUP_APPUNLOAD        (1 << 4)
266 #define AST_SOFTHANGUP_EXPLICIT         (1 << 5)
267
268 /* Bits 0-15 of state are reserved for the state (up/down) of the line */
269 /*! Channel is down and available */
270 #define AST_STATE_DOWN          0               
271 /*! Channel is down, but reserved */
272 #define AST_STATE_RESERVED      1               
273 /*! Channel is off hook */
274 #define AST_STATE_OFFHOOK       2               
275 /*! Digits (or equivalent) have been dialed */
276 #define AST_STATE_DIALING       3               
277 /*! Line is ringing */
278 #define AST_STATE_RING          4               
279 /*! Remote end is ringing */
280 #define AST_STATE_RINGING       5               
281 /*! Line is up */
282 #define AST_STATE_UP            6               
283 /*! Line is busy */
284 #define AST_STATE_BUSY          7               
285
286 /* Bits 16-32 of state are reserved for flags */
287 /*! Do not transmit voice data */
288 #define AST_STATE_MUTE          (1 << 16)       
289
290 /*! Device is valid but channel didn't know state */
291 #define AST_DEVICE_UNKNOWN      0
292 /*! Device is not used */
293 #define AST_DEVICE_NOT_INUSE    1
294 /*! Device is in use */
295 #define AST_DEVICE_INUSE        2
296 /*! Device is busy */
297 #define AST_DEVICE_BUSY         3
298 /*! Device is invalid */
299 #define AST_DEVICE_INVALID      4
300 /*! Device is unavailable */
301 #define AST_DEVICE_UNAVAILABLE  5
302
303 //! Requests a channel
304 /*! 
305  * \param type type of channel to request
306  * \param format requested channel format
307  * \param data data to pass to the channel requester
308  * Request a channel of a given type, with data as optional information used 
309  * by the low level module
310  * Returns an ast_channel on success, NULL on failure.
311  */
312 struct ast_channel *ast_request(char *type, int format, void *data);
313
314 //! Search the Channels by Name
315 /*!
316  * \param device like a dialstring
317  * Search the Device in active channels by compare the channelname against 
318  * the devicename. Compared are only the first chars to the first '-' char.
319  * Returns an AST_DEVICE_UNKNOWN if no channel found or
320  * AST_DEVICE_INUSE if a channel is found
321  */
322 int ast_parse_device_state(char *device);
323
324 //! Asks a channel for device state
325 /*!
326  * \param device like a dialstring
327  * Asks a channel for device state, data is  normaly a number from dialstring
328  * used by the low level module
329  * Trys the channel devicestate callback if not supported search in the
330  * active channels list for the device.
331  * Returns an AST_DEVICE_??? state -1 on failure
332  */
333 int ast_device_state(char *device);
334
335 /*!
336  * \param type type of channel to request
337  * \param format requested channel format
338  * \param data data to pass to the channel requester
339  * \param timeout maximum amount of time to wait for an answer
340  * \param why unsuccessful (if unsuceessful)
341  * Request a channel of a given type, with data as optional information used 
342  * by the low level module and attempt to place a call on it
343  * Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
344  * to know if the call was answered or not.
345  */
346 struct ast_channel *ast_request_and_dial(char *type, int format, void *data, int timeout, int *reason, char *callerid);
347
348 struct ast_channel *__ast_request_and_dial(char *type, int format, void *data, int timeout, int *reason, char *callerid, struct outgoing_helper *oh);
349
350 //! Registers a channel
351 /*! 
352  * \param type type of channel you are registering
353  * \param description short description of the channel
354  * \param capabilities a bit mask of the capabilities of the channel
355  * \param requester a function pointer that properly responds to a call.  See one of the channel drivers for details.
356  * Called by a channel module to register the kind of channels it supports.
357  * It supplies a brief type, a longer, but still short description, and a
358  * routine that creates a channel
359  * Returns 0 on success, -1 on failure.
360  */
361 int ast_channel_register(char *type, char *description, int capabilities, 
362                         struct ast_channel* (*requester)(char *type, int format, void *data));
363
364 /* Same like the upper function but with support for devicestate */
365 int ast_channel_register_ex(char *type, char *description, int capabilities,
366                 struct ast_channel *(*requester)(char *type, int format, void *data),
367                 int (*devicestate)(void *data));
368
369 //! Unregister a channel class
370 /*
371  * \param type the character string that corresponds to the channel you wish to unregister
372  * Basically just unregisters the channel with the asterisk channel system
373  * No return value.
374  */
375 void ast_channel_unregister(char *type);
376
377 //! Hang up a channel 
378 /*! 
379  * \param chan channel to hang up
380  * This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
381  * performs all stream stopping, etc, on the channel that needs to end.
382  * chan is no longer valid after this call.
383  * Returns 0 on success, -1 on failure.
384  */
385 int ast_hangup(struct ast_channel *chan);
386
387 //! Softly hangup up a channel
388 /*! 
389  * \param chan channel to be soft-hung-up
390  * Call the protocol layer, but don't destroy the channel structure (use this if you are trying to
391  * safely hangup a channel managed by another thread.
392  * Returns 0 regardless
393  */
394 int ast_softhangup(struct ast_channel *chan, int cause);
395 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
396
397 //! Check to see if a channel is needing hang up
398 /*! 
399  * \param chan channel on which to check for hang up
400  * This function determines if the channel is being requested to be hung up.
401  * Returns 0 if not, or 1 if hang up is requested (including time-out).
402  */
403 int ast_check_hangup(struct ast_channel *chan);
404
405 //! Set when to hang a channel up
406 /*! 
407  * \param chan channel on which to check for hang up
408  * \param offset offset in seconds from current time of when to hang up
409  * This function sets the absolute time out on a channel (when to hang up).
410  */
411 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset);
412
413 //! Answer a ringing call
414 /*!
415  * \param chan channel to answer
416  * This function answers a channel and handles all necessary call
417  * setup functions.
418  * Returns 0 on success, -1 on failure
419  */
420 int ast_answer(struct ast_channel *chan);
421
422 //! Make a call
423 /*! 
424  * \param chan which channel to make the call on
425  * \param addr destination of the call
426  * \param timeout time to wait on for connect
427  * Place a call, take no longer than timeout ms.  Returns -1 on failure, 
428    0 on not enough time (does not auto matically stop ringing), and  
429    the number of seconds the connect took otherwise.
430    Returns 0 on success, -1 on failure
431    */
432 int ast_call(struct ast_channel *chan, char *addr, int timeout);
433
434 //! Indicates condition of channel
435 /*! 
436  * \param chan channel to change the indication
437  * \param condition which condition to indicate on the channel
438  * Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
439  * Returns 0 on success, -1 on failure
440  */
441 int ast_indicate(struct ast_channel *chan, int condition);
442
443 /* Misc stuff */
444
445 //! Wait for input on a channel
446 /*! 
447  * \param chan channel to wait on
448  * \param ms length of time to wait on the channel
449  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite). 
450   Returns < 0 on  failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */
451 int ast_waitfor(struct ast_channel *chan, int ms);
452
453 //! Wait for a specied amount of time, looking for hangups
454 /*!
455  * \param chan channel to wait for
456  * \param ms length of time in milliseconds to sleep
457  * Waits for a specified amount of time, servicing the channel as required.
458  * returns -1 on hangup, otherwise 0.
459  */
460 int ast_safe_sleep(struct ast_channel *chan, int ms);
461
462 //! Wait for a specied amount of time, looking for hangups and a condition argument
463 /*!
464  * \param chan channel to wait for
465  * \param ms length of time in milliseconds to sleep
466  * \param cond a function pointer for testing continue condition
467  * \param data argument to be passed to the condition test function
468  * Waits for a specified amount of time, servicing the channel as required. If cond
469  * returns 0, this function returns.
470  * returns -1 on hangup, otherwise 0.
471  */
472 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
473
474 //! Waits for activity on a group of channels
475 /*! 
476  * \param chan an array of pointers to channels
477  * \param n number of channels that are to be waited upon
478  * \param fds an array of fds to wait upon
479  * \param nfds the number of fds to wait upon
480  * \param exception exception flag
481  * \param outfd fd that had activity on it
482  * \param ms how long the wait was
483  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
484    file descriptors.  Returns the channel with activity, or NULL on error or if an FD
485    came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
486    will be -1 */
487 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n, int *fds, int nfds, int *exception, int *outfd, int *ms);
488
489 //! Waits for input on a group of channels
490 /*! Wait for input on an array of channels for a given # of milliseconds. Return channel
491    with activity, or NULL if none has activity.  time "ms" is modified in-place, if applicable */
492 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
493
494 //! Waits for input on an fd
495 /*! This version works on fd's only.  Be careful with it. */
496 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
497
498
499 //! Reads a frame
500 /*!
501  * \param chan channel to read a frame from
502  * Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
503    best just stop reading frames and assume the channel has been
504    disconnected. */
505 struct ast_frame *ast_read(struct ast_channel *chan);
506
507 //! Write a frame to a channel
508 /*!
509  * \param chan destination channel of the frame
510  * \param frame frame that will be written
511  * This function writes the given frame to the indicated channel.
512  * It returns 0 on success, -1 on failure.
513  */
514 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
515
516 //! Write video frame to a channel
517 /*!
518  * \param chan destination channel of the frame
519  * \param frame frame that will be written
520  * This function writes the given frame to the indicated channel.
521  * It returns 1 on success, 0 if not implemented, and -1 on failure.
522  */
523 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
524
525 /* Send empty audio to prime a channel driver */
526 int ast_prod(struct ast_channel *chan);
527
528 //! Sets read format on channel chan
529 /*! 
530  * \param chan channel to change
531  * \param format format to change to
532  * Set read format for channel to whichever component of "format" is best. 
533  * Returns 0 on success, -1 on failure
534  */
535 int ast_set_read_format(struct ast_channel *chan, int format);
536
537 //! Sets write format on channel chan
538 /*! 
539  * \param chan channel to change
540  * \param format new format for writing
541  * Set write format for channel to whichever compoent of "format" is best. 
542  * Returns 0 on success, -1 on failure
543  */
544 int ast_set_write_format(struct ast_channel *chan, int format);
545
546 //! Sends text to a channel
547 /*! 
548  * \param chan channel to act upon
549  * \param text string of text to send on the channel
550  * Write text to a display on a channel
551  * Returns 0 on success, -1 on failure
552  */
553 int ast_sendtext(struct ast_channel *chan, char *text);
554
555 //! Receives a text character from a channel
556 /*! 
557  * \param chan channel to act upon
558  * \param timeout timeout in milliseconds (0 for infinite wait)
559  * Read a char of text from a channel
560  * Returns 0 on success, -1 on failure
561  */
562 int ast_recvchar(struct ast_channel *chan, int timeout);
563
564 //! Browse channels in use
565 /*! 
566  * \param prev where you want to start in the channel list
567  * Browse the channels currently in use 
568  * Returns the next channel in the list, NULL on end.
569  */
570 struct ast_channel *ast_channel_walk(struct ast_channel *prev);
571
572 //! Waits for a digit
573 /*! 
574  * \param c channel to wait for a digit on
575  * \param ms how many milliseconds to wait
576  * Wait for a digit.  Returns <0 on error, 0 on no entry, and the digit on success. */
577 char ast_waitfordigit(struct ast_channel *c, int ms);
578
579 /* Same as above with audio fd for outputing read audio and ctrlfd to monitor for
580    reading. Returns 1 if ctrlfd becomes available */
581 char ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
582
583 //! Reads multiple digits
584 /*! 
585  * \param c channel to read from
586  * \param s string to read in to.  Must be at least the size of your length
587  * \param len how many digits to read (maximum)
588  * \param timeout how long to timeout between digits
589  * \param rtimeout timeout to wait on the first digit
590  * \param enders digits to end the string
591  * Read in a digit string "s", max length "len", maximum timeout between 
592    digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
593    for the first digit.  Returns 0 on normal return, or 1 on a timeout.  In the case of
594    a timeout, any digits that were read before the timeout will still be available in s.  
595    RETURNS 2 in full version when ctrlfd is available, NOT 1*/
596 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
597 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
598
599 /*! Report DTMF on channel 0 */
600 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)                
601 /*! Report DTMF on channel 1 */
602 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)                
603 /*! Return all voice frames on channel 0 */
604 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)                
605 /*! Return all voice frames on channel 1 */
606 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)                
607 /*! Ignore all signal frames except NULL */
608 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)                
609
610
611 //! Makes two channel formats compatible
612 /*! 
613  * \param c0 first channel to make compatible
614  * \param c1 other channel to make compatible
615  * Set two channels to compatible formats -- call before ast_channel_bridge in general .  Returns 0 on success
616    and -1 if it could not be done */
617 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
618
619 //! Bridge two channels together
620 /*! 
621  * \param c0 first channel to bridge
622  * \param c1 second channel to bridge
623  * \param flags for the channels
624  * \param fo destination frame(?)
625  * \param rc destination channel(?)
626  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
627    *rf (remember, it could be NULL) and which channel (0 or 1) in rc */
628 int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc);
629
630 //! Weird function made for call transfers
631 /*! 
632  * \param original channel to make a copy of
633  * \param clone copy of the original channel
634  * This is a very strange and freaky function used primarily for transfer.  Suppose that
635    "original" and "clone" are two channels in random situations.  This function takes
636    the guts out of "clone" and puts them into the "original" channel, then alerts the
637    channel driver of the change, asking it to fixup any private information (like the
638    p->owner pointer) that is affected by the change.  The physical layer of the original
639    channel is hung up.  */
640 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
641
642 //! Gives the string form of a given state
643 /*! 
644  * \param state state to get the name of
645  * Give a name to a state 
646  * Pretty self explanatory.
647  * Returns the text form of the binary state given
648  */
649 char *ast_state2str(int state);
650
651 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the
652    low level channel.  See frame.h for options.  Note that many channel drivers may support
653    none or a subset of those features, and you should not count on this if you want your
654    asterisk application to be portable.  They're mainly useful for tweaking performance */
655
656 //! Sets an option on a channel
657 /*! 
658  * \param channel channel to set options on
659  * \param option option to change
660  * \param data data specific to option
661  * \param datalen length of the data
662  * \param block blocking or not
663  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply 
664  * Returns 0 on success and -1 on failure
665  */
666 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
667
668 //! Checks the value of an option
669 /*! 
670  * Query the value of an option, optionally blocking until a reply is received
671  * Works similarly to setoption except only reads the options.
672  */
673 struct ast_frame *ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
674
675 //! Checks for HTML support on a channel
676 /*! Returns 0 if channel does not support HTML or non-zero if it does */
677 int ast_channel_supports_html(struct ast_channel *channel);
678
679 //! Sends HTML on given channel
680 /*! Send HTML or URL on link.  Returns 0 on success or -1 on failure */
681 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, char *data, int datalen);
682
683 //! Sends a URL on a given link
684 /*! Send URL on link.  Returns 0 on success or -1 on failure */
685 int ast_channel_sendurl(struct ast_channel *channel, char *url);
686
687 //! Defers DTMF
688 /*! Defer DTMF so that you only read things like hangups and audio.  Returns
689    non-zero if channel was already DTMF-deferred or 0 if channel is just now
690    being DTMF-deferred */
691 int ast_channel_defer_dtmf(struct ast_channel *chan);
692
693 //! Undeos a defer
694 /*! Undo defer.  ast_read will return any dtmf characters that were queued */
695 void ast_channel_undefer_dtmf(struct ast_channel *chan);
696
697 /*! Initiate system shutdown -- prevents new channels from being allocated.
698     If "hangup" is non-zero, all existing channels will receive soft
699      hangups */
700 void ast_begin_shutdown(int hangup);
701
702 /*! Cancels an existing shutdown and returns to normal operation */
703 void ast_cancel_shutdown(void);
704
705 /*! Returns number of active/allocated channels */
706 int ast_active_channels(void);
707
708 /*! Returns non-zero if Asterisk is being shut down */
709 int ast_shutting_down(void);
710
711 /*! Activate a given generator */
712 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
713
714 /*! Deactive an active generator */
715 void ast_deactivate_generator(struct ast_channel *chan);
716
717 void ast_set_callerid(struct ast_channel *chan, char *callerid, int  anitoo);
718
719 /*! Start a tone going */
720 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
721 /*! Stop a tone from playing */
722 void ast_tonepair_stop(struct ast_channel *chan);
723 /*! Play a tone pair for a given amount of time */
724 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
725
726 /*! Automatically service a channel for us... */
727 int ast_autoservice_start(struct ast_channel *chan);
728
729 /*! Stop servicing a channel for us...  Returns -1 on error or if channel has been hungup */
730 int ast_autoservice_stop(struct ast_channel *chan);
731
732 /* If built with zaptel optimizations, force a scheduled expiration on the
733    timer fd, at which point we call the callback function / data */
734 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(void *data), void *data);
735
736 /* Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
737    and 1 if supported and requested */
738 int ast_transfer(struct ast_channel *chan, char *dest);
739
740 /* Misc. functions below */
741
742 //! Waits for activity on a group of channels
743 /*! 
744  * \param nfds the maximum number of file descriptors in the sets
745  * \param rfds file descriptors to check for read availability
746  * \param wfds file descriptors to check for write availability
747  * \param efds file descriptors to check for exceptions (OOB data)
748  * \param tvp timeout while waiting for events
749  * This is the same as a standard select(), except it guarantees the
750  * behaviour where the passed struct timeval is updated with how much
751  * time was not slept while waiting for the specified events
752  */
753 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
754 {
755 #ifdef __linux__
756         return select(nfds, rfds, wfds, efds, tvp);
757 #else
758         if (tvp) {
759                 struct timeval tv, tvstart, tvend, tvlen;
760                 int res;
761
762                 tv = *tvp;
763                 gettimeofday(&tvstart, NULL);
764                 res = select(nfds, rfds, wfds, efds, tvp);
765                 gettimeofday(&tvend, NULL);
766                 timersub(&tvend, &tvstart, &tvlen);
767                 timersub(&tv, &tvlen, tvp);
768                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
769                         tvp->tv_sec = 0;
770                         tvp->tv_usec = 0;
771                 }
772                 return res;
773         }
774         else
775                 return select(nfds, rfds, wfds, efds, NULL);
776 #endif
777 }
778
779 #if !defined(ast_strdupa) && defined(__GNUC__)
780 # define ast_strdupa(s)                                                                 \
781   (__extension__                                                                                \
782     ({                                                                                                  \
783       __const char *__old = (s);                                                \
784       size_t __len = strlen (__old) + 1;                                \
785       char *__new = (char *) __builtin_alloca (__len);  \
786       (char *) memcpy (__new, __old, __len);                    \
787     }))
788 #endif
789
790 #ifdef DO_CRASH
791 #define CRASH do { fprintf(stderr, "!! Forcing immediate crash a-la abort !!\n"); *((int *)0) = 0; } while(0)
792 #else
793 #define CRASH do { } while(0)
794 #endif
795
796 #define CHECK_BLOCKING(c) {      \
797                                                         if ((c)->blocking) {\
798                                                                 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); \
799                                                                 CRASH; \
800                                                         } else { \
801                                                                 (c)->blocker = pthread_self(); \
802                                                                 (c)->blockproc = __PRETTY_FUNCTION__; \
803                                                                         c->blocking = -1; \
804                                                                         } }
805
806 #if defined(__cplusplus) || defined(c_plusplus)
807 }
808 #endif
809
810
811 #endif