Pass accountcode to outgoing spool call when originated with Context&Extension&Priority
[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         oh.account = account; \
242
243
244 struct outgoing_helper {
245         char *context;
246         char *exten;
247         int priority;
248         char *callerid;
249         char *variable;
250         char *account;
251 };
252
253 #define AST_CDR_TRANSFER        (1 << 0)
254 #define AST_CDR_FORWARD         (1 << 1)
255 #define AST_CDR_CALLWAIT        (1 << 2)
256 #define AST_CDR_CONFERENCE      (1 << 3)
257
258 #define AST_ADSI_UNKNOWN        (0)
259 #define AST_ADSI_AVAILABLE      (1)
260 #define AST_ADSI_UNAVAILABLE    (2)
261 #define AST_ADSI_OFFHOOKONLY    (3)
262
263 #define AST_SOFTHANGUP_DEV                      (1 << 0)        /* Soft hangup by device */
264 #define AST_SOFTHANGUP_ASYNCGOTO        (1 << 1)        /* Soft hangup for async goto */
265 #define AST_SOFTHANGUP_SHUTDOWN         (1 << 2)
266 #define AST_SOFTHANGUP_TIMEOUT          (1 << 3)
267 #define AST_SOFTHANGUP_APPUNLOAD        (1 << 4)
268 #define AST_SOFTHANGUP_EXPLICIT         (1 << 5)
269
270 /* Bits 0-15 of state are reserved for the state (up/down) of the line */
271 /*! Channel is down and available */
272 #define AST_STATE_DOWN          0               
273 /*! Channel is down, but reserved */
274 #define AST_STATE_RESERVED      1               
275 /*! Channel is off hook */
276 #define AST_STATE_OFFHOOK       2               
277 /*! Digits (or equivalent) have been dialed */
278 #define AST_STATE_DIALING       3               
279 /*! Line is ringing */
280 #define AST_STATE_RING          4               
281 /*! Remote end is ringing */
282 #define AST_STATE_RINGING       5               
283 /*! Line is up */
284 #define AST_STATE_UP            6               
285 /*! Line is busy */
286 #define AST_STATE_BUSY          7               
287
288 /* Bits 16-32 of state are reserved for flags */
289 /*! Do not transmit voice data */
290 #define AST_STATE_MUTE          (1 << 16)       
291
292 /*! Device is valid but channel didn't know state */
293 #define AST_DEVICE_UNKNOWN      0
294 /*! Device is not used */
295 #define AST_DEVICE_NOT_INUSE    1
296 /*! Device is in use */
297 #define AST_DEVICE_INUSE        2
298 /*! Device is busy */
299 #define AST_DEVICE_BUSY         3
300 /*! Device is invalid */
301 #define AST_DEVICE_INVALID      4
302 /*! Device is unavailable */
303 #define AST_DEVICE_UNAVAILABLE  5
304
305 //! Requests a channel
306 /*! 
307  * \param type type of channel to request
308  * \param format requested channel format
309  * \param data data to pass to the channel requester
310  * Request a channel of a given type, with data as optional information used 
311  * by the low level module
312  * Returns an ast_channel on success, NULL on failure.
313  */
314 struct ast_channel *ast_request(char *type, int format, void *data);
315
316 //! Search the Channels by Name
317 /*!
318  * \param device like a dialstring
319  * Search the Device in active channels by compare the channelname against 
320  * the devicename. Compared are only the first chars to the first '-' char.
321  * Returns an AST_DEVICE_UNKNOWN if no channel found or
322  * AST_DEVICE_INUSE if a channel is found
323  */
324 int ast_parse_device_state(char *device);
325
326 //! Asks a channel for device state
327 /*!
328  * \param device like a dialstring
329  * Asks a channel for device state, data is  normaly a number from dialstring
330  * used by the low level module
331  * Trys the channel devicestate callback if not supported search in the
332  * active channels list for the device.
333  * Returns an AST_DEVICE_??? state -1 on failure
334  */
335 int ast_device_state(char *device);
336
337 /*!
338  * \param type type of channel to request
339  * \param format requested channel format
340  * \param data data to pass to the channel requester
341  * \param timeout maximum amount of time to wait for an answer
342  * \param why unsuccessful (if unsuceessful)
343  * Request a channel of a given type, with data as optional information used 
344  * by the low level module and attempt to place a call on it
345  * Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
346  * to know if the call was answered or not.
347  */
348 struct ast_channel *ast_request_and_dial(char *type, int format, void *data, int timeout, int *reason, char *callerid);
349
350 struct ast_channel *__ast_request_and_dial(char *type, int format, void *data, int timeout, int *reason, char *callerid, struct outgoing_helper *oh);
351
352 //! Registers a channel
353 /*! 
354  * \param type type of channel you are registering
355  * \param description short description of the channel
356  * \param capabilities a bit mask of the capabilities of the channel
357  * \param requester a function pointer that properly responds to a call.  See one of the channel drivers for details.
358  * Called by a channel module to register the kind of channels it supports.
359  * It supplies a brief type, a longer, but still short description, and a
360  * routine that creates a channel
361  * Returns 0 on success, -1 on failure.
362  */
363 int ast_channel_register(char *type, char *description, int capabilities, 
364                         struct ast_channel* (*requester)(char *type, int format, void *data));
365
366 /* Same like the upper function but with support for devicestate */
367 int ast_channel_register_ex(char *type, char *description, int capabilities,
368                 struct ast_channel *(*requester)(char *type, int format, void *data),
369                 int (*devicestate)(void *data));
370
371 //! Unregister a channel class
372 /*
373  * \param type the character string that corresponds to the channel you wish to unregister
374  * Basically just unregisters the channel with the asterisk channel system
375  * No return value.
376  */
377 void ast_channel_unregister(char *type);
378
379 //! Hang up a channel 
380 /*! 
381  * \param chan channel to hang up
382  * This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
383  * performs all stream stopping, etc, on the channel that needs to end.
384  * chan is no longer valid after this call.
385  * Returns 0 on success, -1 on failure.
386  */
387 int ast_hangup(struct ast_channel *chan);
388
389 //! Softly hangup up a channel
390 /*! 
391  * \param chan channel to be soft-hung-up
392  * Call the protocol layer, but don't destroy the channel structure (use this if you are trying to
393  * safely hangup a channel managed by another thread.
394  * Returns 0 regardless
395  */
396 int ast_softhangup(struct ast_channel *chan, int cause);
397 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
398
399 //! Check to see if a channel is needing hang up
400 /*! 
401  * \param chan channel on which to check for hang up
402  * This function determines if the channel is being requested to be hung up.
403  * Returns 0 if not, or 1 if hang up is requested (including time-out).
404  */
405 int ast_check_hangup(struct ast_channel *chan);
406
407 //! Set when to hang a channel up
408 /*! 
409  * \param chan channel on which to check for hang up
410  * \param offset offset in seconds from current time of when to hang up
411  * This function sets the absolute time out on a channel (when to hang up).
412  */
413 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset);
414
415 //! Answer a ringing call
416 /*!
417  * \param chan channel to answer
418  * This function answers a channel and handles all necessary call
419  * setup functions.
420  * Returns 0 on success, -1 on failure
421  */
422 int ast_answer(struct ast_channel *chan);
423
424 //! Make a call
425 /*! 
426  * \param chan which channel to make the call on
427  * \param addr destination of the call
428  * \param timeout time to wait on for connect
429  * Place a call, take no longer than timeout ms.  Returns -1 on failure, 
430    0 on not enough time (does not auto matically stop ringing), and  
431    the number of seconds the connect took otherwise.
432    Returns 0 on success, -1 on failure
433    */
434 int ast_call(struct ast_channel *chan, char *addr, int timeout);
435
436 //! Indicates condition of channel
437 /*! 
438  * \param chan channel to change the indication
439  * \param condition which condition to indicate on the channel
440  * Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
441  * Returns 0 on success, -1 on failure
442  */
443 int ast_indicate(struct ast_channel *chan, int condition);
444
445 /* Misc stuff */
446
447 //! Wait for input on a channel
448 /*! 
449  * \param chan channel to wait on
450  * \param ms length of time to wait on the channel
451  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite). 
452   Returns < 0 on  failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */
453 int ast_waitfor(struct ast_channel *chan, int ms);
454
455 //! Wait for a specied amount of time, looking for hangups
456 /*!
457  * \param chan channel to wait for
458  * \param ms length of time in milliseconds to sleep
459  * Waits for a specified amount of time, servicing the channel as required.
460  * returns -1 on hangup, otherwise 0.
461  */
462 int ast_safe_sleep(struct ast_channel *chan, int ms);
463
464 //! Wait for a specied amount of time, looking for hangups and a condition argument
465 /*!
466  * \param chan channel to wait for
467  * \param ms length of time in milliseconds to sleep
468  * \param cond a function pointer for testing continue condition
469  * \param data argument to be passed to the condition test function
470  * Waits for a specified amount of time, servicing the channel as required. If cond
471  * returns 0, this function returns.
472  * returns -1 on hangup, otherwise 0.
473  */
474 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
475
476 //! Waits for activity on a group of channels
477 /*! 
478  * \param chan an array of pointers to channels
479  * \param n number of channels that are to be waited upon
480  * \param fds an array of fds to wait upon
481  * \param nfds the number of fds to wait upon
482  * \param exception exception flag
483  * \param outfd fd that had activity on it
484  * \param ms how long the wait was
485  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
486    file descriptors.  Returns the channel with activity, or NULL on error or if an FD
487    came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
488    will be -1 */
489 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n, int *fds, int nfds, int *exception, int *outfd, int *ms);
490
491 //! Waits for input on a group of channels
492 /*! Wait for input on an array of channels for a given # of milliseconds. Return channel
493    with activity, or NULL if none has activity.  time "ms" is modified in-place, if applicable */
494 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
495
496 //! Waits for input on an fd
497 /*! This version works on fd's only.  Be careful with it. */
498 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
499
500
501 //! Reads a frame
502 /*!
503  * \param chan channel to read a frame from
504  * Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
505    best just stop reading frames and assume the channel has been
506    disconnected. */
507 struct ast_frame *ast_read(struct ast_channel *chan);
508
509 //! Write a frame to a channel
510 /*!
511  * \param chan destination channel of the frame
512  * \param frame frame that will be written
513  * This function writes the given frame to the indicated channel.
514  * It returns 0 on success, -1 on failure.
515  */
516 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
517
518 //! Write video frame to a channel
519 /*!
520  * \param chan destination channel of the frame
521  * \param frame frame that will be written
522  * This function writes the given frame to the indicated channel.
523  * It returns 1 on success, 0 if not implemented, and -1 on failure.
524  */
525 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
526
527 /* Send empty audio to prime a channel driver */
528 int ast_prod(struct ast_channel *chan);
529
530 //! Sets read format on channel chan
531 /*! 
532  * \param chan channel to change
533  * \param format format to change to
534  * Set read format for channel to whichever component of "format" is best. 
535  * Returns 0 on success, -1 on failure
536  */
537 int ast_set_read_format(struct ast_channel *chan, int format);
538
539 //! Sets write format on channel chan
540 /*! 
541  * \param chan channel to change
542  * \param format new format for writing
543  * Set write format for channel to whichever compoent of "format" is best. 
544  * Returns 0 on success, -1 on failure
545  */
546 int ast_set_write_format(struct ast_channel *chan, int format);
547
548 //! Sends text to a channel
549 /*! 
550  * \param chan channel to act upon
551  * \param text string of text to send on the channel
552  * Write text to a display on a channel
553  * Returns 0 on success, -1 on failure
554  */
555 int ast_sendtext(struct ast_channel *chan, char *text);
556
557 //! Receives a text character from a channel
558 /*! 
559  * \param chan channel to act upon
560  * \param timeout timeout in milliseconds (0 for infinite wait)
561  * Read a char of text from a channel
562  * Returns 0 on success, -1 on failure
563  */
564 int ast_recvchar(struct ast_channel *chan, int timeout);
565
566 //! Browse channels in use
567 /*! 
568  * \param prev where you want to start in the channel list
569  * Browse the channels currently in use 
570  * Returns the next channel in the list, NULL on end.
571  */
572 struct ast_channel *ast_channel_walk(struct ast_channel *prev);
573
574 //! Waits for a digit
575 /*! 
576  * \param c channel to wait for a digit on
577  * \param ms how many milliseconds to wait
578  * Wait for a digit.  Returns <0 on error, 0 on no entry, and the digit on success. */
579 char ast_waitfordigit(struct ast_channel *c, int ms);
580
581 /* Same as above with audio fd for outputing read audio and ctrlfd to monitor for
582    reading. Returns 1 if ctrlfd becomes available */
583 char ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
584
585 //! Reads multiple digits
586 /*! 
587  * \param c channel to read from
588  * \param s string to read in to.  Must be at least the size of your length
589  * \param len how many digits to read (maximum)
590  * \param timeout how long to timeout between digits
591  * \param rtimeout timeout to wait on the first digit
592  * \param enders digits to end the string
593  * Read in a digit string "s", max length "len", maximum timeout between 
594    digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
595    for the first digit.  Returns 0 on normal return, or 1 on a timeout.  In the case of
596    a timeout, any digits that were read before the timeout will still be available in s.  
597    RETURNS 2 in full version when ctrlfd is available, NOT 1*/
598 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
599 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
600
601 /*! Report DTMF on channel 0 */
602 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)                
603 /*! Report DTMF on channel 1 */
604 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)                
605 /*! Return all voice frames on channel 0 */
606 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)                
607 /*! Return all voice frames on channel 1 */
608 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)                
609 /*! Ignore all signal frames except NULL */
610 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)                
611
612
613 //! Makes two channel formats compatible
614 /*! 
615  * \param c0 first channel to make compatible
616  * \param c1 other channel to make compatible
617  * Set two channels to compatible formats -- call before ast_channel_bridge in general .  Returns 0 on success
618    and -1 if it could not be done */
619 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
620
621 //! Bridge two channels together
622 /*! 
623  * \param c0 first channel to bridge
624  * \param c1 second channel to bridge
625  * \param flags for the channels
626  * \param fo destination frame(?)
627  * \param rc destination channel(?)
628  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
629    *rf (remember, it could be NULL) and which channel (0 or 1) in rc */
630 int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc);
631
632 //! Weird function made for call transfers
633 /*! 
634  * \param original channel to make a copy of
635  * \param clone copy of the original channel
636  * This is a very strange and freaky function used primarily for transfer.  Suppose that
637    "original" and "clone" are two channels in random situations.  This function takes
638    the guts out of "clone" and puts them into the "original" channel, then alerts the
639    channel driver of the change, asking it to fixup any private information (like the
640    p->owner pointer) that is affected by the change.  The physical layer of the original
641    channel is hung up.  */
642 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
643
644 //! Gives the string form of a given state
645 /*! 
646  * \param state state to get the name of
647  * Give a name to a state 
648  * Pretty self explanatory.
649  * Returns the text form of the binary state given
650  */
651 char *ast_state2str(int state);
652
653 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the
654    low level channel.  See frame.h for options.  Note that many channel drivers may support
655    none or a subset of those features, and you should not count on this if you want your
656    asterisk application to be portable.  They're mainly useful for tweaking performance */
657
658 //! Sets an option on a channel
659 /*! 
660  * \param channel channel to set options on
661  * \param option option to change
662  * \param data data specific to option
663  * \param datalen length of the data
664  * \param block blocking or not
665  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply 
666  * Returns 0 on success and -1 on failure
667  */
668 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
669
670 //! Checks the value of an option
671 /*! 
672  * Query the value of an option, optionally blocking until a reply is received
673  * Works similarly to setoption except only reads the options.
674  */
675 struct ast_frame *ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
676
677 //! Checks for HTML support on a channel
678 /*! Returns 0 if channel does not support HTML or non-zero if it does */
679 int ast_channel_supports_html(struct ast_channel *channel);
680
681 //! Sends HTML on given channel
682 /*! Send HTML or URL on link.  Returns 0 on success or -1 on failure */
683 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, char *data, int datalen);
684
685 //! Sends a URL on a given link
686 /*! Send URL on link.  Returns 0 on success or -1 on failure */
687 int ast_channel_sendurl(struct ast_channel *channel, char *url);
688
689 //! Defers DTMF
690 /*! Defer DTMF so that you only read things like hangups and audio.  Returns
691    non-zero if channel was already DTMF-deferred or 0 if channel is just now
692    being DTMF-deferred */
693 int ast_channel_defer_dtmf(struct ast_channel *chan);
694
695 //! Undeos a defer
696 /*! Undo defer.  ast_read will return any dtmf characters that were queued */
697 void ast_channel_undefer_dtmf(struct ast_channel *chan);
698
699 /*! Initiate system shutdown -- prevents new channels from being allocated.
700     If "hangup" is non-zero, all existing channels will receive soft
701      hangups */
702 void ast_begin_shutdown(int hangup);
703
704 /*! Cancels an existing shutdown and returns to normal operation */
705 void ast_cancel_shutdown(void);
706
707 /*! Returns number of active/allocated channels */
708 int ast_active_channels(void);
709
710 /*! Returns non-zero if Asterisk is being shut down */
711 int ast_shutting_down(void);
712
713 /*! Activate a given generator */
714 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
715
716 /*! Deactive an active generator */
717 void ast_deactivate_generator(struct ast_channel *chan);
718
719 void ast_set_callerid(struct ast_channel *chan, char *callerid, int  anitoo);
720
721 /*! Start a tone going */
722 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
723 /*! Stop a tone from playing */
724 void ast_tonepair_stop(struct ast_channel *chan);
725 /*! Play a tone pair for a given amount of time */
726 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
727
728 /*! Automatically service a channel for us... */
729 int ast_autoservice_start(struct ast_channel *chan);
730
731 /*! Stop servicing a channel for us...  Returns -1 on error or if channel has been hungup */
732 int ast_autoservice_stop(struct ast_channel *chan);
733
734 /* If built with zaptel optimizations, force a scheduled expiration on the
735    timer fd, at which point we call the callback function / data */
736 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(void *data), void *data);
737
738 /* Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
739    and 1 if supported and requested */
740 int ast_transfer(struct ast_channel *chan, char *dest);
741
742 /* Misc. functions below */
743
744 //! Waits for activity on a group of channels
745 /*! 
746  * \param nfds the maximum number of file descriptors in the sets
747  * \param rfds file descriptors to check for read availability
748  * \param wfds file descriptors to check for write availability
749  * \param efds file descriptors to check for exceptions (OOB data)
750  * \param tvp timeout while waiting for events
751  * This is the same as a standard select(), except it guarantees the
752  * behaviour where the passed struct timeval is updated with how much
753  * time was not slept while waiting for the specified events
754  */
755 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
756 {
757 #ifdef __linux__
758         return select(nfds, rfds, wfds, efds, tvp);
759 #else
760         if (tvp) {
761                 struct timeval tv, tvstart, tvend, tvlen;
762                 int res;
763
764                 tv = *tvp;
765                 gettimeofday(&tvstart, NULL);
766                 res = select(nfds, rfds, wfds, efds, tvp);
767                 gettimeofday(&tvend, NULL);
768                 timersub(&tvend, &tvstart, &tvlen);
769                 timersub(&tv, &tvlen, tvp);
770                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
771                         tvp->tv_sec = 0;
772                         tvp->tv_usec = 0;
773                 }
774                 return res;
775         }
776         else
777                 return select(nfds, rfds, wfds, efds, NULL);
778 #endif
779 }
780
781 #if !defined(ast_strdupa) && defined(__GNUC__)
782 # define ast_strdupa(s)                                                                 \
783   (__extension__                                                                                \
784     ({                                                                                                  \
785       __const char *__old = (s);                                                \
786       size_t __len = strlen (__old) + 1;                                \
787       char *__new = (char *) __builtin_alloca (__len);  \
788       (char *) memcpy (__new, __old, __len);                    \
789     }))
790 #endif
791
792 #ifdef DO_CRASH
793 #define CRASH do { fprintf(stderr, "!! Forcing immediate crash a-la abort !!\n"); *((int *)0) = 0; } while(0)
794 #else
795 #define CRASH do { } while(0)
796 #endif
797
798 #define CHECK_BLOCKING(c) {      \
799                                                         if ((c)->blocking) {\
800                                                                 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); \
801                                                                 CRASH; \
802                                                         } else { \
803                                                                 (c)->blocker = pthread_self(); \
804                                                                 (c)->blockproc = __PRETTY_FUNCTION__; \
805                                                                         c->blocking = -1; \
806                                                                         } }
807
808 #if defined(__cplusplus) || defined(c_plusplus)
809 }
810 #endif
811
812
813 #endif