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