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