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