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