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