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