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