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