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