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