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