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