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