Fix building of chan_h323 with gcc-3.3
[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, DAHDI, 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 (DAHDI 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 bridging 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         \li \see ast_channel_early_bridge()
111         \li \see ast_channel_bridge()
112         \li \see app_meetme.c
113         \li \ref AstRTPbridge
114         \li \see ast_rtp_bridge()
115         \li \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 "asterisk/poll-compat.h"
129
130 #if defined(__cplusplus) || defined(c_plusplus)
131 extern "C" {
132 #endif
133
134 #define AST_MAX_EXTENSION       80      /*!< Max length of an extension */
135 #define AST_MAX_CONTEXT         80      /*!< Max length of a context */
136 #define AST_CHANNEL_NAME        80      /*!< Max length of an ast_channel name */
137 #define MAX_LANGUAGE            20      /*!< Max length of the language setting */
138 #define MAX_MUSICCLASS          80      /*!< Max length of the music class setting */
139
140 #include "asterisk/frame.h"
141 #include "asterisk/sched.h"
142 #include "asterisk/chanvars.h"
143 #include "asterisk/config.h"
144 #include "asterisk/lock.h"
145 #include "asterisk/cdr.h"
146 #include "asterisk/utils.h"
147 #include "asterisk/linkedlists.h"
148 #include "asterisk/stringfields.h"
149 #include "asterisk/datastore.h"
150
151 #define DATASTORE_INHERIT_FOREVER       INT_MAX
152
153 #define AST_MAX_FDS             10
154 /*
155  * We have AST_MAX_FDS file descriptors in a channel.
156  * Some of them have a fixed use:
157  */
158 #define AST_ALERT_FD    (AST_MAX_FDS-1)         /*!< used for alertpipe */
159 #define AST_TIMING_FD   (AST_MAX_FDS-2)         /*!< used for timingfd */
160 #define AST_AGENT_FD    (AST_MAX_FDS-3)         /*!< used by agents for pass through */
161 #define AST_GENERATOR_FD        (AST_MAX_FDS-4) /*!< used by generator */
162
163 enum ast_bridge_result {
164         AST_BRIDGE_COMPLETE = 0,
165         AST_BRIDGE_FAILED = -1,
166         AST_BRIDGE_FAILED_NOWARN = -2,
167         AST_BRIDGE_RETRY = -3,
168 };
169
170 typedef unsigned long long ast_group_t;
171
172 /*! \todo Add an explanation of an Asterisk generator
173 */
174 struct ast_generator {
175         void *(*alloc)(struct ast_channel *chan, void *params);
176         void (*release)(struct ast_channel *chan, void *data);
177         /*! This function gets called with the channel unlocked, but is called in
178          *  the context of the channel thread so we know the channel is not going
179          *  to disappear.  This callback is responsible for locking the channel as
180          *  necessary. */
181         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
182         /*! This gets called when DTMF_END frames are read from the channel */
183         void (*digit)(struct ast_channel *chan, char digit);
184 };
185
186 /*!
187  * \brief Structure for all kinds of caller ID identifications.
188  * \note All string fields here are malloc'ed, so they need to be
189  * freed when the structure is deleted.
190  * Also, NULL and "" must be considered equivalent.
191  *
192  * \note SIP and IAX2 has utf8 encoded Unicode caller ID names.
193  * In some cases, we also have an alternative (RPID) E.164 number that can be used
194  * as caller ID on numeric E.164 phone networks (DAHDI or SIP/IAX2 to PSTN gateway).
195  *
196  * \todo Implement settings for transliteration between UTF8 caller ID names in
197  *       to Ascii Caller ID's (DAHDI). Östen Åsklund might be transliterated into
198  *       Osten Asklund or Oesten Aasklund depending upon language and person...
199  *       We need automatic routines for incoming calls and static settings for
200  *       our own accounts.
201  */
202 struct ast_callerid {
203         /*!
204          * \brief Malloc'd Dialed Number Identifier
205          * (Field will eventually move to struct ast_channel.dialed.number)
206          */
207         char *cid_dnid;
208
209         /*!
210          * \brief Malloc'd Caller Number
211          * (Field will eventually move to struct ast_channel.caller.id.number)
212          */
213         char *cid_num;
214
215         /*!
216          * \brief Malloc'd Caller Name (ASCII)
217          * (Field will eventually move to struct ast_channel.caller.id.name)
218          */
219         char *cid_name;
220
221         /*!
222          * \brief Malloc'd Automatic Number Identification (ANI)
223          * (Field will eventually move to struct ast_channel.caller.ani)
224          */
225         char *cid_ani;
226
227         /*!
228          * \brief Malloc'd Redirecting Directory Number Information Service (RDNIS)
229          * (Field will eventually move to struct ast_channel.redirecting.from.number)
230          */
231         char *cid_rdnis;
232
233         /*!
234          * \brief Callerid Q.931 encoded number presentation/screening fields
235          * (Field will eventually move to struct ast_channel.caller.id.number_presentation)
236          */
237         int cid_pres;
238
239         /*!
240          * \brief Callerid ANI 2 (Info digits)
241          * (Field will eventually move to struct ast_channel.caller.ani2)
242          */
243         int cid_ani2;
244
245         /*!
246          * \brief Callerid Q.931 encoded type-of-number/numbering-plan fields
247          * \note Currently this value is mostly just passed around the system.
248          * The H.323 interfaces set the value from received messages and uses the value for sent messages.
249          * The DAHDI PRI interfaces set the value from received messages but does not use it for sent messages.
250          * You can read it and set it but only H.323 uses it.
251          * (Field will eventually move to struct ast_channel.caller.id.number_type)
252          */
253         int cid_ton;
254
255         /*!
256          * \brief Callerid Transit Network Select
257          * \note Currently this value is just passed around the system.
258          * You can read it and set it but it is never used for anything.
259          * (Field will eventually move to struct ast_channel.dialed.transit_network_select)
260          */
261         int cid_tns;
262 };
263
264 /*!
265  * \since 1.6.3
266  * \brief Information needed to identify an endpoint in a call.
267  * \note All string fields here are malloc'ed, so they need to be
268  * freed when the structure is deleted.
269  * \note NULL and "" must be considered equivalent.
270  */
271 struct ast_party_id {
272         /*! \brief Subscriber phone number (Malloced) */
273         char *number;
274
275         /*! \brief Subscriber name (Malloced) */
276         char *name;
277
278         /*! \brief Q.931 encoded type-of-number/numbering-plan fields */
279         int number_type;
280
281         /*! \brief Q.931 encoded number presentation/screening fields */
282         int number_presentation;
283 };
284
285 /*!
286  * \since 1.6.3
287  * \brief Connected Line/Party information.
288  * \note All string fields here are malloc'ed, so they need to be
289  * freed when the structure is deleted.
290  * \note NULL and "" must be considered equivalent.
291  */
292 struct ast_party_connected_line {
293         struct ast_party_id id;         /*! \brief Connected party ID */
294
295         /*!
296          * \brief Automatic Number Identification (ANI) (Malloced)
297          * \note Not really part of connected line data but needed to
298          * save the corresponding caller id value.
299          */
300         char *ani;
301
302         /*!
303          * \brief Automatic Number Identification 2 (Info Digits)
304          * \note Not really part of connected line data but needed to
305          * save the corresponding caller id value.
306          */
307         int ani2;
308
309         /*! \brief Information about the source of an update (Q.SIG/ISDN requirement).
310          * \note enum AST_CONNECTED_LINE_UPDATE_SOURCE values
311          * for Normal-Answer, Call-transfer, Call-diversion
312          */
313         int source;
314 };
315
316 /*!
317  * \since 1.6.3
318  * \brief Redirecting Line information.
319  * RDNIS (Redirecting Directory Number Information Service)
320  * Where a call diversion or transfer was invoked.
321  * \note All string fields here are malloc'ed, so they need to be
322  * freed when the structure is deleted.
323  * \note NULL and "" must be considered equivalent.
324  */
325 struct ast_party_redirecting {
326         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) */
327         struct ast_party_id from;
328
329         /*! \brief Call is redirecting to a new party (Sent to the caller) */
330         struct ast_party_id to;
331
332         /*! \brief Number of times the call was redirected */
333         int count;
334
335         /*! \brief enum AST_REDIRECTING_REASON value for redirection */
336         int reason;
337 };
338
339 /*!
340  * \brief
341  * Structure to describe a channel "technology", ie a channel driver
342  * See for examples:
343  * \arg chan_iax2.c - The Inter-Asterisk exchange protocol
344  * \arg chan_sip.c - The SIP channel driver
345  * \arg chan_dahdi.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
346  *
347  * \details
348  * If you develop your own channel driver, this is where you
349  * tell the PBX at registration of your driver what properties
350  * this driver supports and where different callbacks are
351  * implemented.
352  */
353 struct ast_channel_tech {
354         const char * const type;
355         const char * const description;
356
357         int capabilities;               /*!< Bitmap of formats this channel can handle */
358
359         int properties;                 /*!< Technology Properties */
360
361         /*! \brief Requester - to set up call data structures (pvt's) */
362         struct ast_channel *(* const requester)(const char *type, int format, void *data, int *cause);
363
364         int (* const devicestate)(void *data);  /*!< Devicestate call back */
365
366         /*!
367          * \brief Start sending a literal DTMF digit
368          *
369          * \note The channel is not locked when this function gets called.
370          */
371         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
372
373         /*!
374          * \brief Stop sending a literal DTMF digit
375          *
376          * \note The channel is not locked when this function gets called.
377          */
378         int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
379
380         /*! \brief Call a given phone number (address, etc), but don't
381          *  take longer than timeout seconds to do so.  */
382         int (* const call)(struct ast_channel *chan, char *addr, int timeout);
383
384         /*! \brief Hangup (and possibly destroy) the channel */
385         int (* const hangup)(struct ast_channel *chan);
386
387         /*! \brief Answer the channel */
388         int (* const answer)(struct ast_channel *chan);
389
390         /*! \brief Read a frame, in standard format (see frame.h) */
391         struct ast_frame * (* const read)(struct ast_channel *chan);
392
393         /*! \brief Write a frame, in standard format (see frame.h) */
394         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
395
396         /*! \brief Display or transmit text */
397         int (* const send_text)(struct ast_channel *chan, const char *text);
398
399         /*! \brief Display or send an image */
400         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
401
402         /*! \brief Send HTML data */
403         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
404
405         /*! \brief Handle an exception, reading a frame */
406         struct ast_frame * (* const exception)(struct ast_channel *chan);
407
408         /*! \brief Bridge two channels of the same type together */
409         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
410                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
411
412         /*! \brief Bridge two channels of the same type together (early) */
413         enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
414
415         /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
416         int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
417
418         /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
419         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
420
421         /*! \brief Set a given option */
422         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
423
424         /*! \brief Query a given option */
425         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
426
427         /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
428         int (* const transfer)(struct ast_channel *chan, const char *newdest);
429
430         /*! \brief Write a frame, in standard format */
431         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
432
433         /*! \brief Write a text frame, in standard format */
434         int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
435
436         /*! \brief Find bridged channel */
437         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
438
439         /*! \brief Provide additional read items for CHANNEL() dialplan function */
440         int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
441
442         /*! \brief Provide additional write items for CHANNEL() dialplan function */
443         int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
444
445         /*! \brief Retrieve base channel (agent and local) */
446         struct ast_channel* (* get_base_channel)(struct ast_channel *chan);
447
448         /*! \brief Set base channel (agent and local) */
449         int (* set_base_channel)(struct ast_channel *chan, struct ast_channel *base);
450
451         /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
452         const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
453 };
454
455 struct ast_epoll_data;
456
457 /*!
458  * The high bit of the frame count is used as a debug marker, so
459  * increments of the counters must be done with care.
460  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
461  */
462 #define DEBUGCHAN_FLAG  0x80000000
463
464 /* XXX not ideal to evaluate x twice... */
465 #define FRAMECOUNT_INC(x)       ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
466
467 /*!
468  * The current value of the debug flags is stored in the two
469  * variables global_fin and global_fout (declared in main/channel.c)
470  */
471 extern unsigned long global_fin, global_fout;
472
473 enum ast_channel_adsicpe {
474         AST_ADSI_UNKNOWN,
475         AST_ADSI_AVAILABLE,
476         AST_ADSI_UNAVAILABLE,
477         AST_ADSI_OFFHOOKONLY,
478 };
479
480 /*!
481  * \brief ast_channel states
482  *
483  * \note Bits 0-15 of state are reserved for the state (up/down) of the line
484  *       Bits 16-32 of state are reserved for flags
485  */
486 enum ast_channel_state {
487         AST_STATE_DOWN,                 /*!< Channel is down and available */
488         AST_STATE_RESERVED,             /*!< Channel is down, but reserved */
489         AST_STATE_OFFHOOK,              /*!< Channel is off hook */
490         AST_STATE_DIALING,              /*!< Digits (or equivalent) have been dialed */
491         AST_STATE_RING,                 /*!< Line is ringing */
492         AST_STATE_RINGING,              /*!< Remote end is ringing */
493         AST_STATE_UP,                   /*!< Line is up */
494         AST_STATE_BUSY,                 /*!< Line is busy */
495         AST_STATE_DIALING_OFFHOOK,      /*!< Digits (or equivalent) have been dialed while offhook */
496         AST_STATE_PRERING,              /*!< Channel has detected an incoming call and is waiting for ring */
497
498         AST_STATE_MUTE = (1 << 16),     /*!< Do not transmit voice data */
499 };
500
501 /*!
502  * \brief Possible T38 states on channels
503  */
504 enum ast_t38_state {
505         T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
506         T38_STATE_UNKNOWN,      /*!< The channel supports T38 but the current status is unknown */
507         T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
508         T38_STATE_REJECTED,     /*!< Remote side has rejected our offer */
509         T38_STATE_NEGOTIATED,   /*!< T38 established */
510 };
511
512 /*!
513  * \brief Main Channel structure associated with a channel.
514  * This is the side of it mostly used by the pbx and call management.
515  *
516  * \note XXX It is important to remember to increment .cleancount each time
517  *       this structure is changed. XXX
518  *
519  * \note When adding fields to this structure, it is important to add the field
520  *       'in position' with like-aligned fields, so as to keep the compiler from
521  *       having to add padding to align fields. The structure's fields are sorted
522  *       in this order: pointers, structures, long, int/enum, short, char. This
523  *       is especially important on 64-bit architectures, where mixing 4-byte
524  *       and 8-byte fields causes 4 bytes of padding to be added before many
525  *       8-byte fields.
526  */
527 struct ast_channel {
528         const struct ast_channel_tech *tech;            /*!< Technology (point to channel driver) */
529         void *tech_pvt;                                 /*!< Private data used by the technology driver */
530         void *music_state;                              /*!< Music State*/
531         void *generatordata;                            /*!< Current generator data if there is any */
532         struct ast_generator *generator;                /*!< Current active data generator */
533         struct ast_channel *_bridge;                    /*!< Who are we bridged to, if we're bridged.
534                                                          *   Who is proxying for us, if we are proxied (i.e. chan_agent).
535                                                          *   Do not access directly, use ast_bridged_channel(chan) */
536         struct ast_channel *masq;                       /*!< Channel that will masquerade as us */
537         struct ast_channel *masqr;                      /*!< Who we are masquerading as */
538         const char *blockproc;                          /*!< Procedure causing blocking */
539         const char *appl;                               /*!< Current application */
540         const char *data;                               /*!< Data passed to current application */
541         struct sched_context *sched;                    /*!< Schedule context */
542         struct ast_filestream *stream;                  /*!< Stream itself. */
543         struct ast_filestream *vstream;                 /*!< Video Stream itself. */
544         int (*timingfunc)(const void *data);
545         void *timingdata;
546         struct ast_pbx *pbx;                            /*!< PBX private structure for this channel */
547         struct ast_trans_pvt *writetrans;               /*!< Write translation path */
548         struct ast_trans_pvt *readtrans;                /*!< Read translation path */
549         struct ast_audiohook_list *audiohooks;
550         struct ast_cdr *cdr;                            /*!< Call Detail Record */
551         struct ast_tone_zone *zone;                     /*!< Tone zone as set in indications.conf or
552                                                          *   in the CHANNEL dialplan function */
553         struct ast_channel_monitor *monitor;            /*!< Channel monitoring */
554 #ifdef HAVE_EPOLL
555         struct ast_epoll_data *epfd_data[AST_MAX_FDS];
556 #endif
557
558         AST_DECLARE_STRING_FIELDS(
559                 AST_STRING_FIELD(name);                 /*!< ASCII unique channel name */
560                 AST_STRING_FIELD(language);             /*!< Language requested for voice prompts */
561                 AST_STRING_FIELD(musicclass);           /*!< Default music class */
562                 AST_STRING_FIELD(accountcode);          /*!< Account code for billing */
563                 AST_STRING_FIELD(call_forward);         /*!< Where to forward to if asked to dial on this interface */
564                 AST_STRING_FIELD(uniqueid);             /*!< Unique Channel Identifier */
565                 AST_STRING_FIELD(parkinglot);           /*! Default parking lot, if empty, default parking lot  */
566                 AST_STRING_FIELD(dialcontext);          /*!< Dial: Extension context that we were called from */
567         );
568
569         struct timeval whentohangup;                    /*!< Non-zero, set to actual time when channel is to be hung up */
570         pthread_t blocker;                              /*!< If anyone is blocking, this is them */
571         ast_mutex_t lock_dont_use;                      /*!< Lock a channel for some operations. See ast_channel_lock() */
572
573         /*!
574          * \brief Channel Caller ID information.
575          * \note The caller id information is the caller id of this
576          * channel when it is used to initiate a call.
577          */
578         struct ast_callerid cid;
579
580         /*!
581          * \brief Channel Connected Line ID information.
582          * \note The connected line information identifies the channel
583          * connected/bridged to this channel.
584          */
585         struct ast_party_connected_line connected;
586
587         /*!
588          * \brief Redirecting/Diversion information
589          * \note Until struct ast_channel.cid.cid_rdnis is replaced
590          * with ast_channel.redirecting.from.number, the
591          * ast_channel.redirecting.from.number field is not used.
592          */
593         struct ast_party_redirecting redirecting;
594
595         struct ast_frame dtmff;                         /*!< DTMF frame */
596         struct varshead varshead;                       /*!< A linked list for channel variables. See \ref AstChanVar */
597         ast_group_t callgroup;                          /*!< Call group for call pickups */
598         ast_group_t pickupgroup;                        /*!< Pickup group - which calls groups can be picked up? */
599         AST_LIST_HEAD_NOLOCK(, ast_frame) readq;
600         AST_LIST_ENTRY(ast_channel) chan_list;          /*!< For easy linking */
601         struct ast_jb jb;                               /*!< The jitterbuffer state */
602         struct timeval dtmf_tv;                         /*!< The time that an in process digit began, or the last digit ended */
603         AST_LIST_HEAD_NOLOCK(datastores, ast_datastore) datastores; /*!< Data stores on the channel */
604
605         unsigned long insmpl;                           /*!< Track the read/written samples for monitor use */
606         unsigned long outsmpl;                          /*!< Track the read/written samples for monitor use */
607
608         int fds[AST_MAX_FDS];                           /*!< File descriptors for channel -- Drivers will poll on
609                                                          *   these file descriptors, so at least one must be non -1.
610                                                          *   See \arg \ref AstFileDesc */
611         int cdrflags;                                   /*!< Call Detail Record Flags */
612         int _softhangup;                                /*!< Whether or not we have been hung up...  Do not set this value
613                                                          *   directly, use ast_softhangup() */
614         int fdno;                                       /*!< Which fd had an event detected on */
615         int streamid;                                   /*!< For streaming playback, the schedule ID */
616         int vstreamid;                                  /*!< For streaming video playback, the schedule ID */
617         int oldwriteformat;                             /*!< Original writer format */
618         int timingfd;                                   /*!< Timing fd */
619         enum ast_channel_state _state;                  /*!< State of line -- Don't write directly, use ast_setstate() */
620         int rings;                                      /*!< Number of rings so far */
621         int priority;                                   /*!< Dialplan: Current extension priority */
622         int macropriority;                              /*!< Macro: Current non-macro priority. See app_macro.c */
623         int amaflags;                                   /*!< Set BEFORE PBX is started to determine AMA flags */
624         enum ast_channel_adsicpe adsicpe;               /*!< Whether or not ADSI is detected on CPE */
625         unsigned int fin;                               /*!< Frames in counters. The high bit is a debug mask, so
626                                                          *   the counter is only in the remaining bits */
627         unsigned int fout;                              /*!< Frames out counters. The high bit is a debug mask, so
628                                                          *   the counter is only in the remaining bits */
629         int hangupcause;                                /*!< Why is the channel hanged up. See causes.h */
630         unsigned int flags;                             /*!< channel flags of AST_FLAG_ type */
631         int alertpipe[2];
632         int nativeformats;                              /*!< Kinds of data this channel can natively handle */
633         int readformat;                                 /*!< Requested read format */
634         int writeformat;                                /*!< Requested write format */
635         int rawreadformat;                              /*!< Raw read format */
636         int rawwriteformat;                             /*!< Raw write format */
637         unsigned int emulate_dtmf_duration;             /*!< Number of ms left to emulate DTMF for */
638 #ifdef HAVE_EPOLL
639         int epfd;
640 #endif
641         int visible_indication;                         /*!< Indication currently playing on the channel */
642
643         unsigned short transfercapability;              /*!< ISDN Transfer Capability - AST_FLAG_DIGITAL is not enough */
644
645         union {
646                 char unused_old_dtmfq[AST_MAX_EXTENSION];                       /*!< (deprecated, use readq instead) Any/all queued DTMF characters */
647                 struct {
648                         struct ast_bridge *bridge;                                      /*!< Bridge this channel is participating in */
649                         struct ast_timer *timer;                                        /*!< timer object that provided timingfd */
650                 };
651         };
652
653         char context[AST_MAX_CONTEXT];                  /*!< Dialplan: Current extension context */
654         char exten[AST_MAX_EXTENSION];                  /*!< Dialplan: Current extension number */
655         char macrocontext[AST_MAX_CONTEXT];             /*!< Macro: Current non-macro context. See app_macro.c */
656         char macroexten[AST_MAX_EXTENSION];             /*!< Macro: Current non-macro extension. See app_macro.c */
657         char emulate_dtmf_digit;                        /*!< Digit being emulated */
658 };
659
660 /*! \brief ast_channel_tech Properties */
661 enum {
662         /*!
663      * \brief Channels have this property if they can accept input with jitter;
664          * i.e. most VoIP channels
665          */
666         AST_CHAN_TP_WANTSJITTER = (1 << 0),
667         /*!
668      * \brief Channels have this property if they can create jitter;
669          * i.e. most VoIP channels
670          */
671         AST_CHAN_TP_CREATESJITTER = (1 << 1),
672 };
673
674 /*! \brief ast_channel flags */
675 enum {
676         /*! Queue incoming DTMF, to be released when this flag is turned off */
677         AST_FLAG_DEFER_DTMF =    (1 << 1),
678         /*! write should be interrupt generator */
679         AST_FLAG_WRITE_INT =     (1 << 2),
680         /*! a thread is blocking on this channel */
681         AST_FLAG_BLOCKING =      (1 << 3),
682         /*! This is a zombie channel */
683         AST_FLAG_ZOMBIE =        (1 << 4),
684         /*! There is an exception pending */
685         AST_FLAG_EXCEPTION =     (1 << 5),
686         /*! Listening to moh XXX anthm promises me this will disappear XXX */
687         AST_FLAG_MOH =           (1 << 6),
688         /*! This channel is spying on another channel */
689         AST_FLAG_SPYING =        (1 << 7),
690         /*! This channel is in a native bridge */
691         AST_FLAG_NBRIDGE =       (1 << 8),
692         /*! the channel is in an auto-incrementing dialplan processor,
693          *  so when ->priority is set, it will get incremented before
694          *  finding the next priority to run */
695         AST_FLAG_IN_AUTOLOOP =   (1 << 9),
696         /*! This is an outgoing call */
697         AST_FLAG_OUTGOING =      (1 << 10),
698         /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
699         AST_FLAG_IN_DTMF =       (1 << 12),
700         /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
701          *  currently being emulated */
702         AST_FLAG_EMULATE_DTMF =  (1 << 13),
703         /*! This is set to tell the channel not to generate DTMF begin frames, and
704          *  to instead only generate END frames. */
705         AST_FLAG_END_DTMF_ONLY = (1 << 14),
706         /*! Flag to show channels that this call is hangup due to the fact that the call
707             was indeed answered, but in another channel */
708         AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15),
709         /*! This flag indicates that on a masquerade, an active stream should not
710          *  be carried over */
711         AST_FLAG_MASQ_NOSTREAM = (1 << 16),
712         /*! This flag indicates that the hangup exten was run when the bridge terminated,
713          *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
714          *  level */
715         AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
716         /*! This flag indicates that the hangup exten should NOT be run when the
717          *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
718          *  */
719         AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
720 };
721
722 /*! \brief ast_bridge_config flags */
723 enum {
724         AST_FEATURE_PLAY_WARNING = (1 << 0),
725         AST_FEATURE_REDIRECT =     (1 << 1),
726         AST_FEATURE_DISCONNECT =   (1 << 2),
727         AST_FEATURE_ATXFER =       (1 << 3),
728         AST_FEATURE_AUTOMON =      (1 << 4),
729         AST_FEATURE_PARKCALL =     (1 << 5),
730         AST_FEATURE_AUTOMIXMON =   (1 << 6),
731         AST_FEATURE_NO_H_EXTEN =   (1 << 7),
732         AST_FEATURE_WARNING_ACTIVE = (1 << 8),
733 };
734
735 /*! \brief bridge configuration */
736 struct ast_bridge_config {
737         struct ast_flags features_caller;
738         struct ast_flags features_callee;
739         struct timeval start_time;
740         struct timeval nexteventts;
741         struct timeval feature_start_time;
742         long feature_timer;
743         long timelimit;
744         long play_warning;
745         long warning_freq;
746         const char *warning_sound;
747         const char *end_sound;
748         const char *start_sound;
749         unsigned int flags;
750         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
751         void *end_bridge_callback_data;         /*!< Data passed to the callback */
752         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
753          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
754          */
755         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
756 };
757
758 struct chanmon;
759
760 struct outgoing_helper {
761         const char *context;
762         const char *exten;
763         int priority;
764         const char *cid_num;
765         const char *cid_name;
766         const char *account;
767         struct ast_variable *vars;
768         struct ast_channel *parent_channel;
769 };
770
771 enum {
772         AST_CDR_TRANSFER =   (1 << 0),
773         AST_CDR_FORWARD =    (1 << 1),
774         AST_CDR_CALLWAIT =   (1 << 2),
775         AST_CDR_CONFERENCE = (1 << 3),
776 };
777
778 enum {
779         /*! Soft hangup by device */
780         AST_SOFTHANGUP_DEV =       (1 << 0),
781         /*! Soft hangup for async goto */
782         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
783         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
784         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
785         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
786         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
787         AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
788 };
789
790
791 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
792 enum channelreloadreason {
793         CHANNEL_MODULE_LOAD,
794         CHANNEL_MODULE_RELOAD,
795         CHANNEL_CLI_RELOAD,
796         CHANNEL_MANAGER_RELOAD,
797 };
798
799 /*!
800  * \note None of the datastore API calls lock the ast_channel they are using.
801  *       So, the channel should be locked before calling the functions that
802  *       take a channel argument.
803  */
804
805 /*!
806  * \brief Create a channel data store object
807  * \deprecated You should use the ast_datastore_alloc() generic function instead.
808  * \version 1.6.1 deprecated
809  */
810 struct ast_datastore *ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
811         __attribute__((deprecated));
812
813 /*!
814  * \brief Free a channel data store object
815  * \deprecated You should use the ast_datastore_free() generic function instead.
816  * \version 1.6.1 deprecated
817  */
818 int ast_channel_datastore_free(struct ast_datastore *datastore)
819         __attribute__((deprecated));
820
821 /*! \brief Inherit datastores from a parent to a child. */
822 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
823
824 /*!
825  * \brief Add a datastore to a channel
826  *
827  * \note The channel should be locked before calling this function.
828  *
829  * \retval 0 success
830  * \retval non-zero failure
831  */
832 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
833
834 /*!
835  * \brief Remove a datastore from a channel
836  *
837  * \note The channel should be locked before calling this function.
838  *
839  * \retval 0 success
840  * \retval non-zero failure
841  */
842 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
843
844 /*!
845  * \brief Find a datastore on a channel
846  *
847  * \note The channel should be locked before calling this function.
848  *
849  * \note The datastore returned from this function must not be used if the
850  *       reference to the channel is released.
851  *
852  * \retval pointer to the datastore if found
853  * \retval NULL if not found
854  */
855 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
856
857 /*! \brief Change the state of a channel */
858 int ast_setstate(struct ast_channel *chan, enum ast_channel_state);
859
860 /*!
861  * \brief Create a channel structure
862  *
863  * \retval NULL failure
864  * \retval non-NULL successfully allocated channel
865  *
866  * \note By default, new channels are set to the "s" extension
867  *       and "default" context.
868  */
869 struct ast_channel *ast_channel_alloc(int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const int amaflag, const char *name_fmt, ...) __attribute__((format(printf, 9, 10)));
870
871 /*!
872  * \brief Queue an outgoing frame
873  *
874  * \note The channel does not need to be locked before calling this function.
875  */
876 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
877
878 /*!
879  * \brief Queue an outgoing frame to the head of the frame queue
880  *
881  * \param chan the channel to queue the frame on
882  * \param f the frame to queue.  Note that this frame will be duplicated by
883  *        this function.  It is the responsibility of the caller to handle
884  *        freeing the memory associated with the frame being passed if
885  *        necessary.
886  *
887  * \retval 0 success
888  * \retval non-zero failure
889  */
890 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
891
892 /*!
893  * \brief Queue a hangup frame
894  *
895  * \note The channel does not need to be locked before calling this function.
896  */
897 int ast_queue_hangup(struct ast_channel *chan);
898
899 /*!
900  * \brief Queue a hangup frame with hangupcause set
901  *
902  * \note The channel does not need to be locked before calling this function.
903  * \param[in] chan channel to queue frame onto
904  * \param[in] cause the hangup cause
905  * \return 0 on success, -1 on error
906  * \since 1.6.1
907  */
908 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
909
910 /*!
911  * \brief Queue a control frame with payload
912  *
913  * \param chan channel to queue frame onto
914  * \param control type of control frame
915  *
916  * \note The channel does not need to be locked before calling this function.
917  *
918  * \retval zero on success
919  * \retval non-zero on failure
920  */
921 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
922
923 /*!
924  * \brief Queue a control frame with payload
925  *
926  * \param chan channel to queue frame onto
927  * \param control type of control frame
928  * \param data pointer to payload data to be included in frame
929  * \param datalen number of bytes of payload data
930  *
931  * \retval 0 success
932  * \retval non-zero failure
933  *
934  * \details
935  * The supplied payload data is copied into the frame, so the caller's copy
936  * is not modified nor freed, and the resulting frame will retain a copy of
937  * the data even if the caller frees their local copy.
938  *
939  * \note This method should be treated as a 'network transport'; in other
940  * words, your frames may be transferred across an IAX2 channel to another
941  * system, which may be a different endianness than yours. Because of this,
942  * you should ensure that either your frames will never be expected to work
943  * across systems, or that you always put your payload data into 'network byte
944  * order' before calling this function.
945  *
946  * \note The channel does not need to be locked before calling this function.
947  */
948 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
949                            const void *data, size_t datalen);
950
951 /*!
952  * \brief Change channel name
953  *
954  * \note The channel must be locked before calling this function.
955  */
956 void ast_change_name(struct ast_channel *chan, char *newname);
957
958 /*! \brief Free a channel structure */
959 void  ast_channel_free(struct ast_channel *);
960
961 /*!
962  * \brief Requests a channel
963  *
964  * \param type type of channel to request
965  * \param format requested channel format (codec)
966  * \param data data to pass to the channel requester
967  * \param status status
968  *
969  * \details
970  * Request a channel of a given type, with data as optional information used
971  * by the low level module
972  *
973  * \retval NULL failure
974  * \retval non-NULL channel on success
975  */
976 struct ast_channel *ast_request(const char *type, int format, void *data, int *status);
977
978 /*!
979  * \brief Request a channel of a given type, with data as optional information used
980  *        by the low level module and attempt to place a call on it
981  *
982  * \param type type of channel to request
983  * \param format requested channel format
984  * \param data data to pass to the channel requester
985  * \param timeout maximum amount of time to wait for an answer
986  * \param reason why unsuccessful (if unsuccessful)
987  * \param cid_num Caller-ID Number
988  * \param cid_name Caller-ID Name (ascii)
989  *
990  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
991  * to know if the call was answered or not.
992  */
993 struct ast_channel *ast_request_and_dial(const char *type, int format, void *data,
994         int timeout, int *reason, const char *cid_num, const char *cid_name);
995
996 /*!
997  * \brief Request a channel of a given type, with data as optional information used
998  * by the low level module and attempt to place a call on it
999  * \param type type of channel to request
1000  * \param format requested channel format
1001  * \param data data to pass to the channel requester
1002  * \param timeout maximum amount of time to wait for an answer
1003  * \param reason why unsuccessful (if unsuccessful)
1004  * \param cid_num Caller-ID Number
1005  * \param cid_name Caller-ID Name (ascii)
1006  * \param oh Outgoing helper
1007  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1008  * to know if the call was answered or not.
1009  */
1010 struct ast_channel *__ast_request_and_dial(const char *type, int format, void *data,
1011         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1012
1013 /*!
1014  * \brief Register a channel technology (a new channel driver)
1015  * Called by a channel module to register the kind of channels it supports.
1016  * \param tech Structure defining channel technology or "type"
1017  * \return Returns 0 on success, -1 on failure.
1018  */
1019 int ast_channel_register(const struct ast_channel_tech *tech);
1020
1021 /*!
1022  * \brief Unregister a channel technology
1023  * \param tech Structure defining channel technology or "type" that was previously registered
1024  * \return No return value.
1025  */
1026 void ast_channel_unregister(const struct ast_channel_tech *tech);
1027
1028 /*!
1029  * \brief Get a channel technology structure by name
1030  * \param name name of technology to find
1031  * \return a pointer to the structure, or NULL if no matching technology found
1032  */
1033 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1034
1035 #ifdef CHANNEL_TRACE
1036 /*!
1037  * \brief Update the context backtrace if tracing is enabled
1038  * \return Returns 0 on success, -1 on failure
1039  */
1040 int ast_channel_trace_update(struct ast_channel *chan);
1041
1042 /*!
1043  * \brief Enable context tracing in the channel
1044  * \return Returns 0 on success, -1 on failure
1045  */
1046 int ast_channel_trace_enable(struct ast_channel *chan);
1047
1048 /*!
1049  * \brief Disable context tracing in the channel.
1050  * \note Does not remove current trace entries
1051  * \return Returns 0 on success, -1 on failure
1052  */
1053 int ast_channel_trace_disable(struct ast_channel *chan);
1054
1055 /*!
1056  * \brief Whether or not context tracing is enabled
1057  * \return Returns -1 when the trace is enabled. 0 if not.
1058  */
1059 int ast_channel_trace_is_enabled(struct ast_channel *chan);
1060
1061 /*!
1062  * \brief Put the channel backtrace in a string
1063  * \return Returns the amount of lines in the backtrace. -1 on error.
1064  */
1065 int ast_channel_trace_serialize(struct ast_channel *chan, struct ast_str **out);
1066 #endif
1067
1068 /*!
1069  * \brief Hang up a channel
1070  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
1071  * performs all stream stopping, etc, on the channel that needs to end.
1072  * chan is no longer valid after this call.
1073  * \param chan channel to hang up
1074  * \return Returns 0 on success, -1 on failure.
1075  */
1076 int ast_hangup(struct ast_channel *chan);
1077
1078 /*!
1079  * \brief Softly hangup up a channel
1080  *
1081  * \param chan channel to be soft-hung-up
1082  * \param cause Ast hangupcause for hangup
1083  *
1084  * \details
1085  * Call the protocol layer, but don't destroy the channel structure
1086  * (use this if you are trying to
1087  * safely hangup a channel managed by another thread.
1088  *
1089  * \note The channel passed to this function does not need to be locked.
1090  *
1091  * \return Returns 0 regardless
1092  */
1093 int ast_softhangup(struct ast_channel *chan, int cause);
1094
1095 /*!
1096  * \brief Softly hangup up a channel (no channel lock)
1097  * \param chan channel to be soft-hung-up
1098  * \param cause Ast hangupcause for hangup (see cause.h)
1099  */
1100 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
1101
1102 /*! \brief Check to see if a channel is needing hang up
1103  * \param chan channel on which to check for hang up
1104  * This function determines if the channel is being requested to be hung up.
1105  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1106  */
1107 int ast_check_hangup(struct ast_channel *chan);
1108
1109 /*!
1110  * \brief Compare a offset with the settings of when to hang a channel up
1111  * \param chan channel on which to check for hang up
1112  * \param offset offset in seconds from current time
1113  * \return 1, 0, or -1
1114  * \details
1115  * This function compares a offset from current time with the absolute time
1116  * out on a channel (when to hang up). If the absolute time out on a channel
1117  * is earlier than current time plus the offset, it returns 1, if the two
1118  * time values are equal, it return 0, otherwise, it return -1.
1119  * \sa ast_channel_cmpwhentohangup_tv()
1120  * \version 1.6.1 deprecated function (only had seconds precision)
1121  */
1122 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1123
1124 /*!
1125  * \brief Compare a offset with the settings of when to hang a channel up
1126  * \param chan channel on which to check for hangup
1127  * \param offset offset in seconds and microseconds from current time
1128  * \return 1, 0, or -1
1129  * This function compares a offset from current time with the absolute time
1130  * out on a channel (when to hang up). If the absolute time out on a channel
1131  * is earlier than current time plus the offset, it returns 1, if the two
1132  * time values are equal, it return 0, otherwise, it return -1.
1133  * \since 1.6.1
1134  */
1135 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1136
1137 /*!
1138  * \brief Set when to hang a channel up
1139  *
1140  * \param chan channel on which to check for hang up
1141  * \param offset offset in seconds relative to the current time of when to hang up
1142  *
1143  * \details
1144  * This function sets the absolute time out on a channel (when to hang up).
1145  *
1146  * \note This function does not require that the channel is locked before
1147  *       calling it.
1148  *
1149  * \return Nothing
1150  * \sa ast_channel_setwhentohangup_tv()
1151  * \version 1.6.1 deprecated function (only had seconds precision)
1152  */
1153 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1154
1155 /*!
1156  * \brief Set when to hang a channel up
1157  *
1158  * \param chan channel on which to check for hang up
1159  * \param offset offset in seconds and useconds relative to the current time of when to hang up
1160  *
1161  * This function sets the absolute time out on a channel (when to hang up).
1162  *
1163  * \note This function does not require that the channel is locked before
1164  * calling it.
1165  *
1166  * \return Nothing
1167  * \since 1.6.1
1168  */
1169 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1170
1171 /*!
1172  * \brief Answer a channel
1173  *
1174  * \param chan channel to answer
1175  *
1176  * \details
1177  * This function answers a channel and handles all necessary call
1178  * setup functions.
1179  *
1180  * \note The channel passed does not need to be locked, but is locked
1181  * by the function when needed.
1182  *
1183  * \note This function will wait up to 500 milliseconds for media to
1184  * arrive on the channel before returning to the caller, so that the
1185  * caller can properly assume the channel is 'ready' for media flow.
1186  *
1187  * \retval 0 on success
1188  * \retval non-zero on failure
1189  */
1190 int ast_answer(struct ast_channel *chan);
1191
1192 /*!
1193  * \brief Answer a channel
1194  *
1195  * \param chan channel to answer
1196  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1197  *
1198  * This function answers a channel and handles all necessary call
1199  * setup functions.
1200  *
1201  * \note The channel passed does not need to be locked, but is locked
1202  * by the function when needed.
1203  *
1204  * \note Unlike ast_answer(), this function will not wait for media
1205  * flow to begin. The caller should be careful before sending media
1206  * to the channel before incoming media arrives, as the outgoing
1207  * media may be lost.
1208  *
1209  * \retval 0 on success
1210  * \retval non-zero on failure
1211  */
1212 int ast_raw_answer(struct ast_channel *chan, int cdr_answer);
1213
1214 /*!
1215  * \brief Answer a channel, with a selectable delay before returning
1216  *
1217  * \param chan channel to answer
1218  * \param delay maximum amount of time to wait for incoming media
1219  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1220  *
1221  * This function answers a channel and handles all necessary call
1222  * setup functions.
1223  *
1224  * \note The channel passed does not need to be locked, but is locked
1225  * by the function when needed.
1226  *
1227  * \note This function will wait up to 'delay' milliseconds for media to
1228  * arrive on the channel before returning to the caller, so that the
1229  * caller can properly assume the channel is 'ready' for media flow. If
1230  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1231  *
1232  * \retval 0 on success
1233  * \retval non-zero on failure
1234  */
1235 int __ast_answer(struct ast_channel *chan, unsigned int delay, int cdr_answer);
1236
1237 /*!
1238  * \brief Make a call
1239  * \param chan which channel to make the call on
1240  * \param addr destination of the call
1241  * \param timeout time to wait on for connect
1242  * \details
1243  * Place a call, take no longer than timeout ms.
1244  * \return -1 on failure, 0 on not enough time
1245  * (does not automatically stop ringing), and
1246  * the number of seconds the connect took otherwise.
1247  */
1248 int ast_call(struct ast_channel *chan, char *addr, int timeout);
1249
1250 /*!
1251  * \brief Indicates condition of channel
1252  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1253  * \param chan channel to change the indication
1254  * \param condition which condition to indicate on the channel
1255  * \return Returns 0 on success, -1 on failure
1256  */
1257 int ast_indicate(struct ast_channel *chan, int condition);
1258
1259 /*!
1260  * \brief Indicates condition of channel, with payload
1261  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1262  * \param chan channel to change the indication
1263  * \param condition which condition to indicate on the channel
1264  * \param data pointer to payload data
1265  * \param datalen size of payload data
1266  * \return Returns 0 on success, -1 on failure
1267  */
1268 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1269
1270 /* Misc stuff ------------------------------------------------ */
1271
1272 /*!
1273  * \brief Wait for input on a channel
1274  * \param chan channel to wait on
1275  * \param ms length of time to wait on the channel
1276  * \details
1277  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1278  * \retval < 0 on failure
1279  * \retval 0 if nothing ever arrived
1280  * \retval the # of ms remaining otherwise
1281  */
1282 int ast_waitfor(struct ast_channel *chan, int ms);
1283
1284 /*!
1285  * \brief Wait for a specified amount of time, looking for hangups
1286  * \param chan channel to wait for
1287  * \param ms length of time in milliseconds to sleep
1288  * \details
1289  * Waits for a specified amount of time, servicing the channel as required.
1290  * \return returns -1 on hangup, otherwise 0.
1291  */
1292 int ast_safe_sleep(struct ast_channel *chan, int ms);
1293
1294 /*!
1295  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
1296  * \param chan channel to wait for
1297  * \param ms length of time in milliseconds to sleep
1298  * \param cond a function pointer for testing continue condition
1299  * \param data argument to be passed to the condition test function
1300  * \return returns -1 on hangup, otherwise 0.
1301  * \details
1302  * Waits for a specified amount of time, servicing the channel as required. If cond
1303  * returns 0, this function returns.
1304  */
1305 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1306
1307 /*!
1308  * \brief Waits for activity on a group of channels
1309  * \param chan an array of pointers to channels
1310  * \param n number of channels that are to be waited upon
1311  * \param fds an array of fds to wait upon
1312  * \param nfds the number of fds to wait upon
1313  * \param exception exception flag
1314  * \param outfd fd that had activity on it
1315  * \param ms how long the wait was
1316  * \details
1317  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1318  * file descriptors.
1319  * \return Returns the channel with activity, or NULL on error or if an FD
1320  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1321  * will be -1
1322  */
1323 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1324         int *fds, int nfds, int *exception, int *outfd, int *ms);
1325
1326 /*!
1327  * \brief Waits for input on a group of channels
1328  * Wait for input on an array of channels for a given # of milliseconds.
1329  * \return Return channel with activity, or NULL if none has activity.
1330  * \param chan an array of pointers to channels
1331  * \param n number of channels that are to be waited upon
1332  * \param ms time "ms" is modified in-place, if applicable
1333  */
1334 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1335
1336 /*!
1337  * \brief Waits for input on an fd
1338  * \note This version works on fd's only.  Be careful with it.
1339  */
1340 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1341
1342
1343 /*!
1344  * \brief Reads a frame
1345  * \param chan channel to read a frame from
1346  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1347  * best just stop reading frames and assume the channel has been
1348  * disconnected.
1349  */
1350 struct ast_frame *ast_read(struct ast_channel *chan);
1351
1352 /*!
1353  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
1354  * \param chan channel to read a frame from
1355  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
1356  * best just stop reading frames and assume the channel has been
1357  * disconnected.
1358  * \note Audio is replaced with AST_FRAME_NULL to avoid
1359  * transcode when the resulting audio is not necessary.
1360  */
1361 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1362
1363 /*!
1364  * \brief Write a frame to a channel
1365  * This function writes the given frame to the indicated channel.
1366  * \param chan destination channel of the frame
1367  * \param frame frame that will be written
1368  * \return It returns 0 on success, -1 on failure.
1369  */
1370 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1371
1372 /*!
1373  * \brief Write video frame to a channel
1374  * This function writes the given frame to the indicated channel.
1375  * \param chan destination channel of the frame
1376  * \param frame frame that will be written
1377  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1378  */
1379 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1380
1381 /*!
1382  * \brief Write text frame to a channel
1383  * This function writes the given frame to the indicated channel.
1384  * \param chan destination channel of the frame
1385  * \param frame frame that will be written
1386  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1387  */
1388 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1389
1390 /*! \brief Send empty audio to prime a channel driver */
1391 int ast_prod(struct ast_channel *chan);
1392
1393 /*!
1394  * \brief Sets read format on channel chan
1395  * Set read format for channel to whichever component of "format" is best.
1396  * \param chan channel to change
1397  * \param format format to change to
1398  * \return Returns 0 on success, -1 on failure
1399  */
1400 int ast_set_read_format(struct ast_channel *chan, int format);
1401
1402 /*!
1403  * \brief Sets write format on channel chan
1404  * Set write format for channel to whichever component of "format" is best.
1405  * \param chan channel to change
1406  * \param format new format for writing
1407  * \return Returns 0 on success, -1 on failure
1408  */
1409 int ast_set_write_format(struct ast_channel *chan, int format);
1410
1411 /*!
1412  * \brief Sends text to a channel
1413  *
1414  * \param chan channel to act upon
1415  * \param text string of text to send on the channel
1416  *
1417  * \details
1418  * Write text to a display on a channel
1419  *
1420  * \note The channel does not need to be locked before calling this function.
1421  *
1422  * \retval 0 on success
1423  * \retval -1 on failure
1424  */
1425 int ast_sendtext(struct ast_channel *chan, const char *text);
1426
1427 /*!
1428  * \brief Receives a text character from a channel
1429  * \param chan channel to act upon
1430  * \param timeout timeout in milliseconds (0 for infinite wait)
1431  * \details
1432  * Read a char of text from a channel
1433  * \return 0 on success, -1 on failure
1434  */
1435 int ast_recvchar(struct ast_channel *chan, int timeout);
1436
1437 /*!
1438  * \brief Send a DTMF digit to a channel.
1439  * \param chan channel to act upon
1440  * \param digit the DTMF digit to send, encoded in ASCII
1441  * \param duration the duration of the digit ending in ms
1442  * \return 0 on success, -1 on failure
1443  */
1444 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
1445
1446 /*!
1447  * \brief Send a DTMF digit to a channel.
1448  * \param chan channel to act upon
1449  * \param digit the DTMF digit to send, encoded in ASCII
1450  * \return 0 on success, -1 on failure
1451  */
1452 int ast_senddigit_begin(struct ast_channel *chan, char digit);
1453
1454 /*!
1455  * \brief Send a DTMF digit to a channel.
1456  * \param chan channel to act upon
1457  * \param digit the DTMF digit to send, encoded in ASCII
1458  * \param duration the duration of the digit ending in ms
1459  * \return Returns 0 on success, -1 on failure
1460  */
1461 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
1462
1463 /*!
1464  * \brief Receives a text string from a channel
1465  * Read a string of text from a channel
1466  * \param chan channel to act upon
1467  * \param timeout timeout in milliseconds (0 for infinite wait)
1468  * \return the received text, or NULL to signify failure.
1469  */
1470 char *ast_recvtext(struct ast_channel *chan, int timeout);
1471
1472 /*!
1473  * \brief Browse channels in use
1474  * Browse the channels currently in use
1475  * \param prev where you want to start in the channel list
1476  * \return Returns the next channel in the list, NULL on end.
1477  *         If it returns a channel, that channel *has been locked*!
1478  */
1479 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev);
1480
1481 /*! \brief Get channel by name or uniqueid (locks channel) */
1482 struct ast_channel *ast_get_channel_by_name_locked(const char *chan);
1483
1484 /*! \brief Get channel by name or uniqueid prefix (locks channel) */
1485 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen);
1486
1487 /*! \brief Get channel by name or uniqueid prefix (locks channel) */
1488 struct ast_channel *ast_walk_channel_by_name_prefix_locked(const struct ast_channel *chan, const char *name, const int namelen);
1489
1490 /*! \brief Get channel by exten (and optionally context) and lock it */
1491 struct ast_channel *ast_get_channel_by_exten_locked(const char *exten, const char *context);
1492
1493 /*! \brief Get next channel by exten (and optionally context) and lock it */
1494 struct ast_channel *ast_walk_channel_by_exten_locked(const struct ast_channel *chan, const char *exten,
1495                                                      const char *context);
1496
1497 /*!
1498  * \brief Search for a channel based on the passed channel matching callback
1499  * Search for a channel based on the specified is_match callback, and return the
1500  * first channel that we match.  When returned, the channel will be locked.  Note
1501  * that the is_match callback is called with the passed channel locked, and should
1502  * return 0 if there is no match, and non-zero if there is.
1503  * \param is_match callback executed on each channel until non-zero is returned, or we
1504  *        run out of channels to search.
1505  * \param data data passed to the is_match callback during each invocation.
1506  * \return Returns the matched channel, or NULL if no channel was matched.
1507  */
1508 struct ast_channel *ast_channel_search_locked(int (*is_match)(struct ast_channel *, void *), void *data);
1509
1510 /*!
1511  * \brief Waits for a digit
1512  * \param c channel to wait for a digit on
1513  * \param ms how many milliseconds to wait
1514  * \return Returns <0 on error, 0 on no entry, and the digit on success.
1515  */
1516 int ast_waitfordigit(struct ast_channel *c, int ms);
1517
1518 /*!
1519  * \brief Wait for a digit
1520  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
1521  * \param c channel to wait for a digit on
1522  * \param ms how many milliseconds to wait
1523  * \param audiofd audio file descriptor to write to if audio frames are received
1524  * \param ctrlfd control file descriptor to monitor for reading
1525  * \return Returns 1 if ctrlfd becomes available
1526  */
1527 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
1528
1529 /*!
1530  * \brief Reads multiple digits
1531  * \param c channel to read from
1532  * \param s string to read in to.  Must be at least the size of your length
1533  * \param len how many digits to read (maximum)
1534  * \param timeout how long to timeout between digits
1535  * \param rtimeout timeout to wait on the first digit
1536  * \param enders digits to end the string
1537  * \details
1538  * Read in a digit string "s", max length "len", maximum timeout between
1539  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
1540  * for the first digit.
1541  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
1542  * a timeout, any digits that were read before the timeout will still be available in s.
1543  * RETURNS 2 in full version when ctrlfd is available, NOT 1
1544  */
1545 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
1546 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
1547
1548 /*! \brief Report DTMF on channel 0 */
1549 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
1550 /*! \brief Report DTMF on channel 1 */
1551 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
1552 /*! \brief Return all voice frames on channel 0 */
1553 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)
1554 /*! \brief Return all voice frames on channel 1 */
1555 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)
1556 /*! \brief Ignore all signal frames except NULL */
1557 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)
1558
1559
1560 /*!
1561  * \brief Makes two channel formats compatible
1562  * \param c0 first channel to make compatible
1563  * \param c1 other channel to make compatible
1564  * \details
1565  * Set two channels to compatible formats -- call before ast_channel_bridge in general.
1566  * \return Returns 0 on success and -1 if it could not be done
1567  */
1568 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
1569
1570 /*!
1571  * \brief Bridge two channels together (early)
1572  * \param c0 first channel to bridge
1573  * \param c1 second channel to bridge
1574  * \details
1575  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
1576  * \return Returns 0 on success and -1 if it could not be done
1577  */
1578 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1579
1580 /*!
1581  * \brief Bridge two channels together
1582  * \param c0 first channel to bridge
1583  * \param c1 second channel to bridge
1584  * \param config config for the channels
1585  * \param fo destination frame(?)
1586  * \param rc destination channel(?)
1587  * \details
1588  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
1589  * *rf (remember, it could be NULL) and which channel (0 or 1) in rc
1590  */
1591 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
1592 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,
1593         struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
1594
1595 /*!
1596  * \brief Weird function made for call transfers
1597  *
1598  * \param original channel to make a copy of
1599  * \param clone copy of the original channel
1600  *
1601  * \details
1602  * This is a very strange and freaky function used primarily for transfer.  Suppose that
1603  * "original" and "clone" are two channels in random situations.  This function takes
1604  * the guts out of "clone" and puts them into the "original" channel, then alerts the
1605  * channel driver of the change, asking it to fixup any private information (like the
1606  * p->owner pointer) that is affected by the change.  The physical layer of the original
1607  * channel is hung up.
1608  *
1609  * \note Neither channel passed here needs to be locked before calling this function.
1610  */
1611 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
1612
1613 /*!
1614  * \brief Gives the string form of a given cause code.
1615  *
1616  * \param state cause to get the description of
1617  * \return the text form of the binary cause code given
1618  */
1619 const char *ast_cause2str(int state) attribute_pure;
1620
1621 /*!
1622  * \brief Convert the string form of a cause code to a number
1623  *
1624  * \param name string form of the cause
1625  * \return the cause code
1626  */
1627 int ast_str2cause(const char *name) attribute_pure;
1628
1629 /*!
1630  * \brief Gives the string form of a given channel state
1631  *
1632  * \param ast_channel_state state to get the name of
1633  * \return the text form of the binary state given
1634  */
1635 const char *ast_state2str(enum ast_channel_state);
1636
1637 /*!
1638  * \brief Gives the string form of a given transfer capability
1639  *
1640  * \param transfercapability transfer capability to get the name of
1641  * \return the text form of the binary transfer capability
1642  */
1643 char *ast_transfercapability2str(int transfercapability) attribute_const;
1644
1645 /*
1646  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
1647  * low level channel.  See frame.h for options.  Note that many channel drivers may support
1648  * none or a subset of those features, and you should not count on this if you want your
1649  * asterisk application to be portable.  They're mainly useful for tweaking performance
1650  */
1651
1652 /*!
1653  * \brief Sets an option on a channel
1654  *
1655  * \param channel channel to set options on
1656  * \param option option to change
1657  * \param data data specific to option
1658  * \param datalen length of the data
1659  * \param block blocking or not
1660  * \details
1661  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
1662  * \return 0 on success and -1 on failure
1663  */
1664 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
1665
1666 /*! Pick the best codec
1667  * Choose the best codec...  Uhhh...   Yah. */
1668 int ast_best_codec(int fmts);
1669
1670
1671 /*!
1672  * \brief Checks the value of an option
1673  *
1674  * Query the value of an option
1675  * Works similarly to setoption except only reads the options.
1676  */
1677 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
1678
1679 /*!
1680  * \brief Checks for HTML support on a channel
1681  * \return 0 if channel does not support HTML or non-zero if it does
1682  */
1683 int ast_channel_supports_html(struct ast_channel *channel);
1684
1685 /*!
1686  * \brief Sends HTML on given channel
1687  * Send HTML or URL on link.
1688  * \return 0 on success or -1 on failure
1689  */
1690 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
1691
1692 /*!
1693  * \brief Sends a URL on a given link
1694  * Send URL on link.
1695  * \return 0 on success or -1 on failure
1696  */
1697 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
1698
1699 /*!
1700  * \brief Defers DTMF so that you only read things like hangups and audio.
1701  * \return non-zero if channel was already DTMF-deferred or
1702  * 0 if channel is just now being DTMF-deferred
1703  */
1704 int ast_channel_defer_dtmf(struct ast_channel *chan);
1705
1706 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
1707 void ast_channel_undefer_dtmf(struct ast_channel *chan);
1708
1709 /*! Initiate system shutdown -- prevents new channels from being allocated.
1710  * \param hangup  If "hangup" is non-zero, all existing channels will receive soft
1711  *  hangups */
1712 void ast_begin_shutdown(int hangup);
1713
1714 /*! Cancels an existing shutdown and returns to normal operation */
1715 void ast_cancel_shutdown(void);
1716
1717 /*! \return number of active/allocated channels */
1718 int ast_active_channels(void);
1719
1720 /*! \return non-zero if Asterisk is being shut down */
1721 int ast_shutting_down(void);
1722
1723 /*! Activate a given generator */
1724 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
1725
1726 /*! Deactivate an active generator */
1727 void ast_deactivate_generator(struct ast_channel *chan);
1728
1729 /*!
1730  * \brief Set caller ID number, name and ANI
1731  *
1732  * \note The channel does not need to be locked before calling this function.
1733  */
1734 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
1735
1736 /*! Set the file descriptor on the channel */
1737 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
1738
1739 /*! Add a channel to an optimized waitfor */
1740 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
1741
1742 /*! Delete a channel from an optimized waitfor */
1743 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
1744
1745 /*! Start a tone going */
1746 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1747 /*! Stop a tone from playing */
1748 void ast_tonepair_stop(struct ast_channel *chan);
1749 /*! Play a tone pair for a given amount of time */
1750 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1751
1752 /*!
1753  * \brief Automatically service a channel for us...
1754  *
1755  * \retval 0 success
1756  * \retval -1 failure, or the channel is already being autoserviced
1757  */
1758 int ast_autoservice_start(struct ast_channel *chan);
1759
1760 /*!
1761  * \brief Stop servicing a channel for us...
1762  *
1763  * \note if chan is locked prior to calling ast_autoservice_stop, it
1764  * is likely that there will be a deadlock between the thread that calls
1765  * ast_autoservice_stop and the autoservice thread. It is important
1766  * that chan is not locked prior to this call
1767  *
1768  * \retval 0 success
1769  * \retval -1 error, or the channel has been hungup
1770  */
1771 int ast_autoservice_stop(struct ast_channel *chan);
1772
1773 /*!
1774  * \brief Enable or disable timer ticks for a channel
1775  *
1776  * \param rate number of timer ticks per second
1777  *
1778  * \details
1779  * If timers are supported, force a scheduled expiration on the
1780  * timer fd, at which point we call the callback function / data
1781  *
1782  * \note Call this function with a rate of 0 to turn off the timer ticks
1783  *
1784  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
1785  */
1786 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
1787
1788 /*!
1789  * \brief Transfer a channel (if supported).
1790  * \retval -1 on error
1791  * \retval 0 if not supported
1792  * \retval 1 if supported and requested
1793  * \param chan current channel
1794  * \param dest destination extension for transfer
1795  */
1796 int ast_transfer(struct ast_channel *chan, char *dest);
1797
1798 /*!
1799  * \brief Start masquerading a channel
1800  * \details
1801  * XXX This is a seriously whacked out operation.  We're essentially putting the guts of
1802  *     the clone channel into the original channel.  Start by killing off the original
1803  *     channel's backend.   I'm not sure we're going to keep this function, because
1804  *     while the features are nice, the cost is very high in terms of pure nastiness. XXX
1805  * \param chan Channel to masquerade
1806  */
1807 int ast_do_masquerade(struct ast_channel *chan);
1808
1809 /*!
1810  * \brief Find bridged channel
1811  * \param chan Current channel
1812  */
1813 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
1814
1815 /*!
1816  * \brief Inherits channel variable from parent to child channel
1817  * \param parent Parent channel
1818  * \param child Child channel
1819  *
1820  * \details
1821  * Scans all channel variables in the parent channel, looking for those
1822  * that should be copied into the child channel.
1823  * Variables whose names begin with a single '_' are copied into the
1824  * child channel with the prefix removed.
1825  * Variables whose names begin with '__' are copied into the child
1826  * channel with their names unchanged.
1827  */
1828 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
1829
1830 /*!
1831  * \brief adds a list of channel variables to a channel
1832  * \param chan the channel
1833  * \param vars a linked list of variables
1834  *
1835  * \details
1836  * Variable names can be for a regular channel variable or a dialplan function
1837  * that has the ability to be written to.
1838  */
1839 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
1840
1841 /*!
1842  * \brief An opaque 'object' structure use by silence generators on channels.
1843  */
1844 struct ast_silence_generator;
1845
1846 /*!
1847  * \brief Starts a silence generator on the given channel.
1848  * \param chan The channel to generate silence on
1849  * \return An ast_silence_generator pointer, or NULL if an error occurs
1850  *
1851  * \details
1852  * This function will cause SLINEAR silence to be generated on the supplied
1853  * channel until it is disabled; if the channel cannot be put into SLINEAR
1854  * mode then the function will fail.
1855  *
1856  * \note
1857  * The pointer returned by this function must be preserved and passed to
1858  * ast_channel_stop_silence_generator when you wish to stop the silence
1859  * generation.
1860  */
1861 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
1862
1863 /*!
1864  * \brief Stops a previously-started silence generator on the given channel.
1865  * \param chan The channel to operate on
1866  * \param state The ast_silence_generator pointer return by a previous call to
1867  * ast_channel_start_silence_generator.
1868  * \return nothing
1869  *
1870  * \details
1871  * This function will stop the operating silence generator and return the channel
1872  * to its previous write format.
1873  */
1874 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
1875
1876 /*!
1877  * \brief Check if the channel can run in internal timing mode.
1878  * \param chan The channel to check
1879  * \return boolean
1880  *
1881  * \details
1882  * This function will return 1 if internal timing is enabled and the timing
1883  * device is available.
1884  */
1885 int ast_internal_timing_enabled(struct ast_channel *chan);
1886
1887 /* Misc. functions below */
1888
1889 /*!
1890  * \brief if fd is a valid descriptor, set *pfd with the descriptor
1891  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
1892  * return value to the index into the array)
1893  */
1894 static inline int ast_add_fd(struct pollfd *pfd, int fd)
1895 {
1896         pfd->fd = fd;
1897         pfd->events = POLLIN | POLLPRI;
1898         return fd >= 0;
1899 }
1900
1901 /*! \brief Helper function for migrating select to poll */
1902 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
1903 {
1904         int x;
1905         int dummy = 0;
1906
1907         if (fd < 0)
1908                 return 0;
1909         if (!start)
1910                 start = &dummy;
1911         for (x = *start; x < maximum; x++)
1912                 if (pfds[x].fd == fd) {
1913                         if (x == *start)
1914                                 (*start)++;
1915                         return pfds[x].revents;
1916                 }
1917         return 0;
1918 }
1919
1920 #ifndef HAVE_TIMERSUB
1921 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
1922 {
1923         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
1924         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
1925         if (tvdiff->tv_usec < 0) {
1926                 tvdiff->tv_sec --;
1927                 tvdiff->tv_usec += 1000000;
1928         }
1929
1930 }
1931 #endif
1932
1933 /*!
1934  * \brief Waits for activity on a group of channels
1935  * \param nfds the maximum number of file descriptors in the sets
1936  * \param rfds file descriptors to check for read availability
1937  * \param wfds file descriptors to check for write availability
1938  * \param efds file descriptors to check for exceptions (OOB data)
1939  * \param tvp timeout while waiting for events
1940  * \details
1941  * This is the same as a standard select(), except it guarantees the
1942  * behaviour where the passed struct timeval is updated with how much
1943  * time was not slept while waiting for the specified events
1944  */
1945 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
1946 {
1947 #ifdef __linux__
1948         return select(nfds, rfds, wfds, efds, tvp);
1949 #else
1950         if (tvp) {
1951                 struct timeval tv, tvstart, tvend, tvlen;
1952                 int res;
1953
1954                 tv = *tvp;
1955                 gettimeofday(&tvstart, NULL);
1956                 res = select(nfds, rfds, wfds, efds, tvp);
1957                 gettimeofday(&tvend, NULL);
1958                 timersub(&tvend, &tvstart, &tvlen);
1959                 timersub(&tv, &tvlen, tvp);
1960                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
1961                         tvp->tv_sec = 0;
1962                         tvp->tv_usec = 0;
1963                 }
1964                 return res;
1965         }
1966         else
1967                 return select(nfds, rfds, wfds, efds, NULL);
1968 #endif
1969 }
1970
1971 /*! \brief Retrieves the current T38 state of a channel */
1972 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
1973 {
1974         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
1975         int datalen = sizeof(state);
1976
1977         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
1978
1979         return state;
1980 }
1981
1982 #define CHECK_BLOCKING(c) do {   \
1983         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
1984                 if (option_debug) \
1985                         ast_log(LOG_DEBUG, "Thread %ld Blocking '%s', already blocked by thread %ld in procedure %s\n", (long) pthread_self(), (c)->name, (long) (c)->blocker, (c)->blockproc); \
1986         } else { \
1987                 (c)->blocker = pthread_self(); \
1988                 (c)->blockproc = __PRETTY_FUNCTION__; \
1989                 ast_set_flag(c, AST_FLAG_BLOCKING); \
1990         } } while (0)
1991
1992 ast_group_t ast_get_group(const char *s);
1993
1994 /*! \brief print call- and pickup groups into buffer */
1995 char *ast_print_group(char *buf, int buflen, ast_group_t group);
1996
1997 /*!
1998  * \brief Convert enum channelreloadreason to text string for manager event
1999  * \param reason The reason for reload (manager, cli, start etc)
2000  */
2001 const char *channelreloadreason2txt(enum channelreloadreason reason);
2002
2003 /*! \brief return an ast_variable list of channeltypes */
2004 struct ast_variable *ast_channeltype_list(void);
2005
2006 /*!
2007  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2008  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
2009  * \return char pointer explaining the code
2010  */
2011 const char *ast_channel_reason2str(int reason);
2012
2013 /*! \brief channel group info */
2014 struct ast_group_info {
2015         struct ast_channel *chan;
2016         char *category;
2017         char *group;
2018         AST_LIST_ENTRY(ast_group_info) group_list;
2019 };
2020
2021
2022 /*!
2023  * \since 1.6.3
2024  * \brief Copy the source caller information to the destination caller.
2025  *
2026  * \param dest Destination caller
2027  * \param src Source caller
2028  *
2029  * \return Nothing
2030  */
2031 void ast_party_caller_copy(struct ast_callerid *dest, const struct ast_callerid *src);
2032
2033 /*!
2034  * \since 1.6.3
2035  * \brief Initialize the given connected line structure.
2036  *
2037  * \param init Connected line structure to initialize.
2038  *
2039  * \return Nothing
2040  */
2041 void ast_party_connected_line_init(struct ast_party_connected_line *init);
2042
2043 /*!
2044  * \since 1.6.3
2045  * \brief Copy the source connected line information to the destination connected line.
2046  *
2047  * \param dest Destination connected line
2048  * \param src Source connected line
2049  *
2050  * \return Nothing
2051  */
2052 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
2053
2054 /*!
2055  * \since 1.6.3
2056  * \brief Initialize the given connected line structure using the given
2057  * guide for a set update operation.
2058  *
2059  * \details
2060  * The initialization is needed to allow a set operation to know if a
2061  * value needs to be updated.  Simple integers need the guide's original
2062  * value in case the set operation is not trying to set a new value.
2063  * String values are simply set to NULL pointers if they are not going
2064  * to be updated.
2065  *
2066  * \param init Connected line structure to initialize.
2067  * \param guide Source connected line to use as a guide in initializing.
2068  *
2069  * \return Nothing
2070  */
2071 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
2072
2073 /*!
2074  * \since 1.6.3
2075  * \brief Set the connected line information based on another connected line source
2076  *
2077  * This is similar to ast_party_connected_line_copy, except that NULL values for
2078  * strings in the src parameter indicate not to update the corresponding dest values.
2079  *
2080  * \param src The source connected line to use as a guide to set the dest
2081  * \param dest The connected line one wishes to update
2082  *
2083  * \return Nada
2084  */
2085 void ast_party_connected_line_set(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
2086
2087 /*!
2088  * \since 1.6.3
2089  * \brief Collect the caller party information into a connected line structure.
2090  *
2091  * \param connected Collected caller information for the connected line
2092  * \param cid Caller information.
2093  *
2094  * \return Nothing
2095  *
2096  * \warning This is a shallow copy.
2097  * \warning DO NOT call ast_party_connected_line_free() on the filled in
2098  * connected line structure!
2099  */
2100 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_callerid *cid);
2101
2102 /*!
2103  * \since 1.6.3
2104  * \brief Destroy the connected line information contents
2105  *
2106  * \param doomed The connected line information to destroy.
2107  *
2108  * \return Nothing
2109  */
2110 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
2111
2112 /*!
2113  * \since 1.6.3
2114  * \brief Copy the source redirecting information to the destination redirecting.
2115  *
2116  * \param dest Destination redirecting
2117  * \param src Source redirecting
2118  *
2119  * \return Nothing
2120  */
2121 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
2122
2123 /*!
2124  * \since 1.6.3
2125  * \brief Initialize the given redirecting id structure using the given guide
2126  * for a set update operation.
2127  *
2128  * \details
2129  * The initialization is needed to allow a set operation to know if a
2130  * value needs to be updated.  Simple integers need the guide's original
2131  * value in case the set operation is not trying to set a new value.
2132  * String values are simply set to NULL pointers if they are not going
2133  * to be updated.
2134  *
2135  * \param init Redirecting id structure to initialize.
2136  * \param guide Source redirecting id to use as a guide in initializing.
2137  *
2138  * \return Nothing
2139  */
2140 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
2141
2142 /*!
2143  * \since 1.6.3
2144  * \brief Destroy the redirecting information contents
2145  *
2146  * \param doomed The redirecting information to destroy.
2147  *
2148  * \return Nothing
2149  */
2150 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
2151
2152 /*!
2153  * \since 1.6.3
2154  * \brief Copy the caller information to the connected line information.
2155  *
2156  * \param dest Destination connected line information
2157  * \param src Source caller information
2158  *
2159  * \return Nothing
2160  *
2161  * \note Assumes locks are already acquired
2162  */
2163 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_callerid *src);
2164
2165 /*!
2166  * \since 1.6.3
2167  * \brief Copy the connected line information to the caller information.
2168  *
2169  * \param dest Destination caller information
2170  * \param src Source connected line information
2171  *
2172  * \return Nothing
2173  *
2174  * \note Assumes locks are already acquired
2175  */
2176 void ast_connected_line_copy_to_caller(struct ast_callerid *dest, const struct ast_party_connected_line *src);
2177
2178 /*!
2179  * \since 1.6.3
2180  * \brief Set the connected line information in the Asterisk channel
2181  *
2182  * \param chan Asterisk channel to set connected line information
2183  * \param connected Connected line information
2184  *
2185  * \return Nothing
2186  *
2187  * \note The channel does not need to be locked before calling this function.
2188  */
2189 void ast_channel_set_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected);
2190
2191 /*!
2192  * \since 1.6.3
2193  * \brief Build the connected line information data frame.
2194  *
2195  * \param data Buffer to fill with the frame data
2196  * \param datalen Size of the buffer to fill
2197  * \param connected Connected line information
2198  *
2199  * \retval -1 if error
2200  * \retval Amount of data buffer used
2201  */
2202 int ast_connected_line_build_data(unsigned char *data, size_t datalen, const struct ast_party_connected_line *connected);
2203
2204 /*!
2205  * \since 1.6.3
2206  * \brief Parse connected line indication frame data
2207  *
2208  * \param data Buffer with the frame data to parse
2209  * \param datalen Size of the buffer
2210  * \param connected Extracted connected line information
2211  *
2212  * \retval 0 on success.
2213  * \retval -1 on error.
2214  *
2215  * \note The filled in connected line structure needs to be initialized by
2216  * ast_party_connected_line_set_init() before calling.  If defaults are not
2217  * required use ast_party_connected_line_init().
2218  * \note The filled in connected line structure needs to be destroyed by
2219  * ast_party_connected_line_free() when it is no longer needed.
2220  */
2221 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
2222
2223 /*!
2224  * \since 1.6.3
2225  * \brief Indicate that the connected line information has changed
2226  *
2227  * \param chan Asterisk channel to indicate connected line information
2228  * \param connected Connected line information
2229  *
2230  * \return Nothing
2231  */
2232 void ast_channel_update_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected);
2233
2234 /*!
2235  * \since 1.6.3
2236  * \brief Queue a connected line update frame on a channel
2237  *
2238  * \param chan Asterisk channel to indicate connected line information
2239  * \param connected Connected line information
2240  *
2241  * \return Nothing
2242  */
2243 void ast_channel_queue_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected);
2244
2245 /*!
2246  * \since 1.6.3
2247  * \brief Set the redirecting id information in the Asterisk channel
2248  *
2249  * \param chan Asterisk channel to set redirecting id information
2250  * \param redirecting Redirecting id information
2251  *
2252  * \return Nothing
2253  *
2254  * \note The channel does not need to be locked before calling this function.
2255  */
2256 void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
2257
2258 /*!
2259  * \since 1.6.3
2260  * \brief Build the redirecting id data frame.
2261  *
2262  * \param data Buffer to fill with the frame data
2263  * \param datalen Size of the buffer to fill
2264  * \param redirecting Redirecting id information
2265  *
2266  * \retval -1 if error
2267  * \retval Amount of data buffer used
2268  */
2269 int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting);
2270
2271 /*!
2272  * \since 1.6.3
2273  * \brief Parse redirecting indication frame data
2274  *
2275  * \param data Buffer with the frame data to parse
2276  * \param datalen Size of the buffer
2277  * \param redirecting Extracted redirecting id information
2278  *
2279  * \retval 0 on success.
2280  * \retval -1 on error.
2281  *
2282  * \note The filled in id structure needs to be initialized by
2283  * ast_party_redirecting_set_init() before calling.
2284  * \note The filled in id structure needs to be destroyed by
2285  * ast_party_redirecting_free() when it is no longer needed.
2286  */
2287 int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
2288
2289 /*!
2290  * \since 1.6.3
2291  * \brief Indicate that the redirecting id has changed
2292  *
2293  * \param chan Asterisk channel to indicate redirecting id information
2294  * \param redirecting Redirecting id information
2295  *
2296  * \return Nothing
2297  */
2298 void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
2299
2300 /*!
2301  * \since 1.6.3
2302  * \brief Queue a redirecting update frame on a channel
2303  *
2304  * \param chan Asterisk channel to indicate redirecting id information
2305  * \param redirecting Redirecting id information
2306  *
2307  * \return Nothing
2308  */
2309 void ast_channel_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting);
2310
2311 #if defined(__cplusplus) || defined(c_plusplus)
2312 }
2313 #endif
2314
2315 #endif /* _ASTERISK_CHANNEL_H */