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