Fix memory leak in error paths for action_originate().
[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 #include "asterisk/astobj2.h"
128
129 #include "asterisk/poll-compat.h"
130
131 #if defined(__cplusplus) || defined(c_plusplus)
132 extern "C" {
133 #endif
134
135 #define AST_MAX_EXTENSION       80      /*!< Max length of an extension */
136 #define AST_MAX_CONTEXT         80      /*!< Max length of a context */
137 #define AST_CHANNEL_NAME        80      /*!< Max length of an ast_channel name */
138 #define MAX_LANGUAGE            40      /*!< Max length of the language setting */
139 #define MAX_MUSICCLASS          80      /*!< Max length of the music class setting */
140
141 #include "asterisk/frame.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 #include "asterisk/data.h"
151 #include "asterisk/channelstate.h"
152 #include "asterisk/ccss.h"
153 #include "asterisk/framehook.h"
154
155 #define DATASTORE_INHERIT_FOREVER       INT_MAX
156
157 #define AST_MAX_FDS             11
158 /*
159  * We have AST_MAX_FDS file descriptors in a channel.
160  * Some of them have a fixed use:
161  */
162 #define AST_ALERT_FD    (AST_MAX_FDS-1)         /*!< used for alertpipe */
163 #define AST_TIMING_FD   (AST_MAX_FDS-2)         /*!< used for timingfd */
164 #define AST_AGENT_FD    (AST_MAX_FDS-3)         /*!< used by agents for pass through */
165 #define AST_GENERATOR_FD        (AST_MAX_FDS-4) /*!< used by generator */
166 #define AST_JITTERBUFFER_FD     (AST_MAX_FDS-5) /*!< used by generator */
167
168 enum ast_bridge_result {
169         AST_BRIDGE_COMPLETE = 0,
170         AST_BRIDGE_FAILED = -1,
171         AST_BRIDGE_FAILED_NOWARN = -2,
172         AST_BRIDGE_RETRY = -3,
173 };
174
175 typedef unsigned long long ast_group_t;
176
177 /*! \todo Add an explanation of an Asterisk generator
178 */
179 struct ast_generator {
180         void *(*alloc)(struct ast_channel *chan, void *params);
181         /*! Channel is locked during this function callback. */
182         void (*release)(struct ast_channel *chan, void *data);
183         /*! This function gets called with the channel unlocked, but is called in
184          *  the context of the channel thread so we know the channel is not going
185          *  to disappear.  This callback is responsible for locking the channel as
186          *  necessary. */
187         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
188         /*! This gets called when DTMF_END frames are read from the channel */
189         void (*digit)(struct ast_channel *chan, char digit);
190         /*! This gets called when the write format on a channel is changed while
191          * generating. The channel is locked during this callback. */
192         void (*write_format_change)(struct ast_channel *chan, void *data);
193 };
194
195 /*! Party name character set enumeration values (values from Q.SIG) */
196 enum AST_PARTY_CHAR_SET {
197         AST_PARTY_CHAR_SET_UNKNOWN = 0,
198         AST_PARTY_CHAR_SET_ISO8859_1 = 1,
199         AST_PARTY_CHAR_SET_WITHDRAWN = 2,/* ITU withdrew this enum value. */
200         AST_PARTY_CHAR_SET_ISO8859_2 = 3,
201         AST_PARTY_CHAR_SET_ISO8859_3 = 4,
202         AST_PARTY_CHAR_SET_ISO8859_4 = 5,
203         AST_PARTY_CHAR_SET_ISO8859_5 = 6,
204         AST_PARTY_CHAR_SET_ISO8859_7 = 7,
205         AST_PARTY_CHAR_SET_ISO10646_BMPSTRING = 8,
206         AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING = 9,
207 };
208
209 /*!
210  * \since 1.8
211  * \brief Information needed to specify a name in a call.
212  * \note All string fields here are malloc'ed, so they need to be
213  * freed when the structure is deleted.
214  * \note NULL and "" must be considered equivalent.
215  */
216 struct ast_party_name {
217         /*! \brief Subscriber name (Malloced) */
218         char *str;
219         /*!
220          * \brief Character set the name is using.
221          * \see enum AST_PARTY_CHAR_SET
222          * \note
223          * Set to AST_PARTY_CHAR_SET_ISO8859_1 if unsure what to use.
224          * \todo Start using the party name character set value.  Not currently used.
225          */
226         int char_set;
227         /*!
228          * \brief Q.931 encoded presentation-indicator encoded field
229          * \note Must tolerate the Q.931 screening-indicator field values being present.
230          */
231         int presentation;
232         /*! \brief TRUE if the name information is valid/present */
233         unsigned char valid;
234 };
235
236 /*!
237  * \since 1.8
238  * \brief Information needed to specify a number in a call.
239  * \note All string fields here are malloc'ed, so they need to be
240  * freed when the structure is deleted.
241  * \note NULL and "" must be considered equivalent.
242  */
243 struct ast_party_number {
244         /*! \brief Subscriber phone number (Malloced) */
245         char *str;
246         /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
247         int plan;
248         /*! \brief Q.931 presentation-indicator and screening-indicator encoded fields */
249         int presentation;
250         /*! \brief TRUE if the number information is valid/present */
251         unsigned char valid;
252 };
253
254 /*!
255  * \since 1.8
256  * \brief Information needed to specify a subaddress in a call.
257  * \note All string fields here are malloc'ed, so they need to be
258  * freed when the structure is deleted.
259  * \note NULL and "" must be considered equivalent.
260  */
261 struct ast_party_subaddress {
262         /*!
263          * \brief Malloced subaddress string.
264          * \note If the subaddress type is user specified then the subaddress is
265          * a string of ASCII hex because the actual subaddress is likely BCD encoded.
266          */
267         char *str;
268         /*!
269          * \brief Q.931 subaddress type.
270          * \details
271          * nsap(0),
272          * user_specified(2)
273          */
274         int type;
275         /*!
276          * \brief TRUE if odd number of address signals
277          * \note The odd/even indicator is used when the type of subaddress is
278          * user_specified and the coding is BCD.
279          */
280         unsigned char odd_even_indicator;
281         /*! \brief TRUE if the subaddress information is valid/present */
282         unsigned char valid;
283 };
284
285 /*!
286  * \since 1.8
287  * \brief Information needed to identify an endpoint in a call.
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_id {
293         /*! \brief Subscriber name */
294         struct ast_party_name name;
295         /*! \brief Subscriber phone number */
296         struct ast_party_number number;
297         /*! \brief Subscriber subaddress. */
298         struct ast_party_subaddress subaddress;
299
300         /*!
301          * \brief User-set "tag"
302          * \details
303          * A user-settable field used to help associate some extrinsic information
304          * about the channel or user of the channel to the party ID.  This information
305          * is normally not transmitted over the wire and so is only useful within an
306          * Asterisk environment.
307          */
308         char *tag;
309 };
310
311 /*!
312  * \since 1.8
313  * \brief Indicate what information in ast_party_id should be set.
314  */
315 struct ast_set_party_id {
316         /*! TRUE if the ast_party_name information should be set. */
317         unsigned char name;
318         /*! TRUE if the ast_party_number information should be set. */
319         unsigned char number;
320         /*! TRUE if the ast_party_subaddress information should be set. */
321         unsigned char subaddress;
322 };
323
324 /*!
325  * \since 1.8
326  * \brief Dialed/Called Party information.
327  * \note Dialed Number Identifier (DNID)
328  * \note All string fields here are malloc'ed, so they need to be
329  * freed when the structure is deleted.
330  * \note NULL and "" must be considered equivalent.
331  */
332 struct ast_party_dialed {
333         /*!
334          * \brief Dialed/Called number
335          * \note Done this way in case we ever really need to use ast_party_number.
336          * We currently do not need all of the ast_party_number fields.
337          */
338         struct {
339                 /*! \brief Subscriber phone number (Malloced) */
340                 char *str;
341                 /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
342                 int plan;
343         } number;
344         /*! \brief Dialed/Called subaddress */
345         struct ast_party_subaddress subaddress;
346         /*!
347          * \brief Transit Network Select
348          * \note Currently this value is just passed around the system.
349          * You can read it and set it but it is never used for anything.
350          */
351         int transit_network_select;
352 };
353
354 /*!
355  * \since 1.8
356  * \brief Caller Party information.
357  * \note All string fields here are malloc'ed, so they need to be
358  * freed when the structure is deleted.
359  * \note NULL and "" must be considered equivalent.
360  *
361  * \note SIP and IAX2 has UTF8 encoded Unicode Caller ID names.
362  * In some cases, we also have an alternative (RPID) E.164 number that can
363  * be used as Caller ID on numeric E.164 phone networks (DAHDI or SIP/IAX2 to
364  * PSTN gateway).
365  *
366  * \todo Implement settings for transliteration between UTF8 Caller ID names in
367  *       to ASCII Caller ID's (DAHDI). Östen Åsklund might be transliterated into
368  *       Osten Asklund or Oesten Aasklund depending upon language and person...
369  *       We need automatic routines for incoming calls and static settings for
370  *       our own accounts.
371  */
372 struct ast_party_caller {
373         /*! \brief Caller party ID */
374         struct ast_party_id id;
375
376         /*!
377          * \brief Automatic Number Identification (ANI)
378          * \note The name subcomponent is only likely to be used by SIP.
379          * \note The subaddress subcomponent is not likely to be used.
380          */
381         struct ast_party_id ani;
382
383         /*! \brief Automatic Number Identification 2 (Info Digits) */
384         int ani2;
385 };
386
387 /*!
388  * \since 1.8
389  * \brief Indicate what information in ast_party_caller should be set.
390  */
391 struct ast_set_party_caller {
392         /*! What caller id information to set. */
393         struct ast_set_party_id id;
394         /*! What ANI id information to set. */
395         struct ast_set_party_id ani;
396 };
397
398 /*!
399  * \since 1.8
400  * \brief Connected Line/Party information.
401  * \note All string fields here are malloc'ed, so they need to be
402  * freed when the structure is deleted.
403  * \note NULL and "" must be considered equivalent.
404  */
405 struct ast_party_connected_line {
406         /*! \brief Connected party ID */
407         struct ast_party_id id;
408
409         /*!
410          * \brief Automatic Number Identification (ANI)
411          * \note Not really part of connected line data but needed to
412          * save the corresponding caller id value.
413          */
414         struct ast_party_id ani;
415
416         /*!
417          * \brief Automatic Number Identification 2 (Info Digits)
418          * \note Not really part of connected line data but needed to
419          * save the corresponding caller id value.
420          */
421         int ani2;
422
423         /*!
424          * \brief Information about the source of an update.
425          * \note enum AST_CONNECTED_LINE_UPDATE_SOURCE values
426          * for Normal-Answer and Call-transfer.
427          */
428         int source;
429 };
430
431 /*!
432  * \since 1.8
433  * \brief Indicate what information in ast_party_connected_line should be set.
434  */
435 struct ast_set_party_connected_line {
436         /*! What connected line id information to set. */
437         struct ast_set_party_id id;
438         /*! What ANI id information to set. */
439         struct ast_set_party_id ani;
440 };
441
442 /*!
443  * \since 1.8
444  * \brief Redirecting Line information.
445  * RDNIS (Redirecting Directory Number Information Service)
446  * Where a call diversion or transfer was invoked.
447  * \note All string fields here are malloc'ed, so they need to be
448  * freed when the structure is deleted.
449  * \note NULL and "" must be considered equivalent.
450  */
451 struct ast_party_redirecting {
452         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) */
453         struct ast_party_id from;
454
455         /*! \brief Call is redirecting to a new party (Sent to the caller) */
456         struct ast_party_id to;
457
458         /*! \brief Number of times the call was redirected */
459         int count;
460
461         /*! \brief enum AST_REDIRECTING_REASON value for redirection */
462         int reason;
463 };
464
465 /*!
466  * \since 1.8
467  * \brief Indicate what information in ast_party_redirecting should be set.
468  */
469 struct ast_set_party_redirecting {
470         /*! What redirecting-from id information to set. */
471         struct ast_set_party_id from;
472         /*! What redirecting-to id information to set. */
473         struct ast_set_party_id to;
474 };
475
476 /*! \brief Typedef for a custom read function */
477 typedef int (*ast_acf_read_fn_t)(struct ast_channel *, const char *, char *, char *, size_t);
478
479 /*! \brief Typedef for a custom read2 function */
480 typedef int (*ast_acf_read2_fn_t)(struct ast_channel *, const char *, char *, struct ast_str **, ssize_t);
481
482 /*! \brief Typedef for a custom write function */
483 typedef int (*ast_acf_write_fn_t)(struct ast_channel *, const char *, char *, const char *);
484
485 /*! \brief Structure to handle passing func_channel_write info to channels via setoption */
486 typedef struct {
487         /*! \brief ast_chan_write_info_t version. Must be incremented if structure is changed */
488         #define AST_CHAN_WRITE_INFO_T_VERSION 1
489         uint32_t version;
490         ast_acf_write_fn_t write_fn;
491         struct ast_channel *chan;
492         const char *function;
493         char *data;
494         const char *value;
495 } ast_chan_write_info_t;
496
497 /*!
498  * \brief
499  * Structure to describe a channel "technology", ie a channel driver
500  * See for examples:
501  * \arg chan_iax2.c - The Inter-Asterisk exchange protocol
502  * \arg chan_sip.c - The SIP channel driver
503  * \arg chan_dahdi.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
504  *
505  * \details
506  * If you develop your own channel driver, this is where you
507  * tell the PBX at registration of your driver what properties
508  * this driver supports and where different callbacks are
509  * implemented.
510  */
511 struct ast_channel_tech {
512         const char * const type;
513         const char * const description;
514
515         struct ast_format_cap *capabilities;  /*!< format capabilities this channel can handle */
516
517         int properties;         /*!< Technology Properties */
518
519         /*!
520          * \brief Requester - to set up call data structures (pvt's)
521          * \note data should be treated as const char *.
522          */
523         struct ast_channel *(* const requester)(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, void *data, int *cause);
524
525         int (* const devicestate)(void *data);  /*!< Devicestate call back */
526
527         /*!
528          * \brief Start sending a literal DTMF digit
529          *
530          * \note The channel is not locked when this function gets called.
531          */
532         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
533
534         /*!
535          * \brief Stop sending a literal DTMF digit
536          *
537          * \note The channel is not locked when this function gets called.
538          */
539         int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
540
541         /*!
542          * \brief Call a given phone number (address, etc), but don't
543          * take longer than timeout seconds to do so.
544          * \note addr should be treated as const char *.
545          */
546         int (* const call)(struct ast_channel *chan, char *addr, int timeout);
547
548         /*! \brief Hangup (and possibly destroy) the channel */
549         int (* const hangup)(struct ast_channel *chan);
550
551         /*! \brief Answer the channel */
552         int (* const answer)(struct ast_channel *chan);
553
554         /*! \brief Read a frame, in standard format (see frame.h) */
555         struct ast_frame * (* const read)(struct ast_channel *chan);
556
557         /*! \brief Write a frame, in standard format (see frame.h) */
558         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
559
560         /*! \brief Display or transmit text */
561         int (* const send_text)(struct ast_channel *chan, const char *text);
562
563         /*! \brief Display or send an image */
564         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
565
566         /*! \brief Send HTML data */
567         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
568
569         /*! \brief Handle an exception, reading a frame */
570         struct ast_frame * (* const exception)(struct ast_channel *chan);
571
572         /*! \brief Bridge two channels of the same type together */
573         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
574                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
575
576         /*! \brief Bridge two channels of the same type together (early) */
577         enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
578
579         /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
580         int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
581
582         /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
583         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
584
585         /*! \brief Set a given option. Called with chan locked */
586         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
587
588         /*! \brief Query a given option. Called with chan locked */
589         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
590
591         /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
592         int (* const transfer)(struct ast_channel *chan, const char *newdest);
593
594         /*! \brief Write a frame, in standard format */
595         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
596
597         /*! \brief Write a text frame, in standard format */
598         int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
599
600         /*! \brief Find bridged channel */
601         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
602
603         /*! \brief Provide additional read items for CHANNEL() dialplan function */
604         int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
605
606         /*! \brief Provide additional write items for CHANNEL() dialplan function */
607         int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
608
609         /*! \brief Retrieve base channel (agent and local) */
610         struct ast_channel* (* get_base_channel)(struct ast_channel *chan);
611
612         /*! \brief Set base channel (agent and local) */
613         int (* set_base_channel)(struct ast_channel *chan, struct ast_channel *base);
614
615         /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
616         const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
617
618         /*! \brief Call a function with cc parameters as a function parameter
619          *
620          * \details
621          * This is a highly specialized callback that is not likely to be needed in many
622          * channel drivers. When dealing with a busy channel, for instance, most channel
623          * drivers will successfully return a channel to the requester. Once called, the channel
624          * can then queue a busy frame when it receives an appropriate message from the far end.
625          * In such a case, the channel driver has the opportunity to also queue a CC frame.
626          * The parameters for the CC channel can be retrieved from the channel structure.
627          *
628          * For other channel drivers, notably those that deal with "dumb" phones, the channel
629          * driver will not return a channel when one is requested. In such a scenario, there is never
630          * an opportunity for the channel driver to queue a CC frame since the channel is never
631          * called. Furthermore, it is not possible to retrieve the CC configuration parameters
632          * for the desired channel because no channel is ever allocated or returned to the
633          * requester. In such a case, call completion may still be a viable option. What we do is
634          * pass the same string that the requester used originally to request the channel to the
635          * channel driver. The channel driver can then find any potential channels/devices that
636          * match the input and return call the designated callback with the device's call completion
637          * parameters as a parameter.
638          */
639         int (* cc_callback)(struct ast_channel *inbound, const char *dest, ast_cc_callback_fn callback);
640 };
641
642 /*! Kill the channel channel driver technology descriptor. */
643 extern const struct ast_channel_tech ast_kill_tech;
644
645 struct ast_epoll_data;
646
647 /*!
648  * The high bit of the frame count is used as a debug marker, so
649  * increments of the counters must be done with care.
650  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
651  */
652 #define DEBUGCHAN_FLAG  0x80000000
653
654 /* XXX not ideal to evaluate x twice... */
655 #define FRAMECOUNT_INC(x)       ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
656
657 /*!
658  * The current value of the debug flags is stored in the two
659  * variables global_fin and global_fout (declared in main/channel.c)
660  */
661 extern unsigned long global_fin, global_fout;
662
663 enum ast_channel_adsicpe {
664         AST_ADSI_UNKNOWN,
665         AST_ADSI_AVAILABLE,
666         AST_ADSI_UNAVAILABLE,
667         AST_ADSI_OFFHOOKONLY,
668 };
669
670 /*!
671  * \brief Possible T38 states on channels
672  */
673 enum ast_t38_state {
674         T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
675         T38_STATE_UNKNOWN,      /*!< The channel supports T38 but the current status is unknown */
676         T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
677         T38_STATE_REJECTED,     /*!< Remote side has rejected our offer */
678         T38_STATE_NEGOTIATED,   /*!< T38 established */
679 };
680
681 /*!
682  * \page AstChannel ast_channel locking and reference tracking
683  *
684  * \par Creating Channels
685  * A channel is allocated using the ast_channel_alloc() function.  When created, it is
686  * automatically inserted into the main channels hash table that keeps track of all
687  * active channels in the system.  The hash key is based on the channel name.  Because
688  * of this, if you want to change the name, you _must_ use ast_change_name(), not change
689  * the name field directly.  When ast_channel_alloc() returns a channel pointer, you now
690  * hold a reference to that channel.  In most cases this reference is given to ast_pbx_run().
691  *
692  * \par Channel Locking
693  * There is a lock associated with every ast_channel.  It is allocated internally via astobj2.
694  * To lock or unlock a channel, you must use the ast_channel_lock() wrappers.
695  *
696  * Previously, before ast_channel was converted to astobj2, the channel lock was used in some
697  * additional ways that are no longer necessary.  Before, the only way to ensure that a channel
698  * did not disappear out from under you if you were working with a channel outside of the channel
699  * thread that owns it, was to hold the channel lock.  Now, that is no longer necessary.
700  * You simply must hold a reference to the channel to ensure it does not go away.
701  *
702  * The channel must be locked if you need to ensure that data that you reading from the channel
703  * does not change while you access it.  Further, you must hold the channel lock if you are
704  * making a non-atomic change to channel data.
705  *
706  * \par Channel References
707  * There are multiple ways to get a reference to a channel.  The first is that you hold a reference
708  * to a channel after creating it.  The other ways involve using the channel search or the channel
709  * traversal APIs.  These functions are the ast_channel_get_*() functions or ast_channel_iterator_*()
710  * functions.  Once a reference is retrieved by one of these methods, you know that the channel will
711  * not go away.  So, the channel should only get locked as needed for data access or modification.
712  * But, make sure that the reference gets released when you are done with it!
713  *
714  * There are different things you can do when you are done with a reference to a channel.  The first
715  * is to simply release the reference using ast_channel_unref().  The other option is to call
716  * ast_channel_release().  This function is generally used where ast_channel_free() was used in
717  * the past.  The release function releases a reference as well as ensures that the channel is no
718  * longer in the global channels container.  That way, the channel will get destroyed as soon as any
719  * other pending references get released.
720  *
721  * \par Exceptions to the rules
722  * Even though ast_channel is reference counted, there are some places where pointers to an ast_channel
723  * get stored, but the reference count does not reflect it.  The reason is mostly historical.
724  * The only places where this happens should be places where because of how the code works, we
725  * _know_ that the pointer to the channel will get removed before the channel goes away.  The main
726  * example of this is in channel drivers.  Channel drivers generally store a pointer to their owner
727  * ast_channel in their technology specific pvt struct.  In this case, the channel drivers _know_
728  * that this pointer to the channel will be removed in time, because the channel's hangup callback
729  * gets called before the channel goes away.
730  */
731
732 /*!
733  * \brief Main Channel structure associated with a channel.
734  *
735  * \note XXX It is important to remember to increment .cleancount each time
736  *       this structure is changed. XXX
737  *
738  * \note When adding fields to this structure, it is important to add the field
739  *       'in position' with like-aligned fields, so as to keep the compiler from
740  *       having to add padding to align fields. The structure's fields are sorted
741  *       in this order: pointers, structures, long, int/enum, short, char. This
742  *       is especially important on 64-bit architectures, where mixing 4-byte
743  *       and 8-byte fields causes 4 bytes of padding to be added before many
744  *       8-byte fields.
745  */
746 struct ast_channel {
747         const struct ast_channel_tech *tech;            /*!< Technology (point to channel driver) */
748         void *tech_pvt;                                 /*!< Private data used by the technology driver */
749         void *music_state;                              /*!< Music State*/
750         void *generatordata;                            /*!< Current generator data if there is any */
751         struct ast_generator *generator;                /*!< Current active data generator */
752         struct ast_channel *_bridge;                    /*!< Who are we bridged to, if we're bridged.
753                                                          *   Who is proxying for us, if we are proxied (i.e. chan_agent).
754                                                          *   Do not access directly, use ast_bridged_channel(chan) */
755         struct ast_channel *masq;                       /*!< Channel that will masquerade as us */
756         struct ast_channel *masqr;                      /*!< Who we are masquerading as */
757         const char *blockproc;                          /*!< Procedure causing blocking */
758         const char *appl;                               /*!< Current application */
759         const char *data;                               /*!< Data passed to current application */
760         struct ast_sched_context *sched;                /*!< Schedule context */
761         struct ast_filestream *stream;                  /*!< Stream itself. */
762         struct ast_filestream *vstream;                 /*!< Video Stream itself. */
763         int (*timingfunc)(const void *data);
764         void *timingdata;
765         struct ast_pbx *pbx;                            /*!< PBX private structure for this channel */
766         struct ast_trans_pvt *writetrans;               /*!< Write translation path */
767         struct ast_trans_pvt *readtrans;                /*!< Read translation path */
768         struct ast_audiohook_list *audiohooks;
769         struct ast_framehook_list *framehooks;
770         struct ast_cdr *cdr;                            /*!< Call Detail Record */
771         struct ast_tone_zone *zone;                     /*!< Tone zone as set in indications.conf or
772                                                          *   in the CHANNEL dialplan function */
773         struct ast_channel_monitor *monitor;            /*!< Channel monitoring */
774 #ifdef HAVE_EPOLL
775         struct ast_epoll_data *epfd_data[AST_MAX_FDS];
776 #endif
777
778         AST_DECLARE_STRING_FIELDS(
779                 AST_STRING_FIELD(__do_not_use_name);         /*!< ASCII unique channel name */
780                 AST_STRING_FIELD(__do_not_use_language);     /*!< Language requested for voice prompts */
781                 AST_STRING_FIELD(__do_not_use_musicclass);   /*!< Default music class */
782                 AST_STRING_FIELD(__do_not_use_accountcode);  /*!< Account code for billing */
783                 AST_STRING_FIELD(__do_not_use_peeraccount);  /*!< Peer account code for billing */
784                 AST_STRING_FIELD(__do_not_use_userfield);    /*!< Userfield for CEL billing */
785                 AST_STRING_FIELD(__do_not_use_call_forward); /*!< Where to forward to if asked to dial on this interface */
786                 AST_STRING_FIELD(__do_not_use_uniqueid);     /*!< Unique Channel Identifier */
787                 AST_STRING_FIELD(__do_not_use_linkedid);     /*!< Linked Channel Identifier -- gets propagated by linkage */
788                 AST_STRING_FIELD(__do_not_use_parkinglot);   /*! Default parking lot, if empty, default parking lot  */
789                 AST_STRING_FIELD(__do_not_use_hangupsource); /*! Who is responsible for hanging up this channel */
790                 AST_STRING_FIELD(__do_not_use_dialcontext);  /*!< Dial: Extension context that we were called from */
791         );
792
793         struct timeval whentohangup;                    /*!< Non-zero, set to actual time when channel is to be hung up */
794         pthread_t blocker;                              /*!< If anyone is blocking, this is them */
795
796         /*!
797          * \brief Dialed/Called information.
798          * \note Set on incoming channels to indicate the originally dialed party.
799          * \note Dialed Number Identifier (DNID)
800          */
801         struct ast_party_dialed dialed;
802
803         /*!
804          * \brief Channel Caller ID information.
805          * \note The caller id information is the caller id of this
806          * channel when it is used to initiate a call.
807          */
808         struct ast_party_caller caller;
809
810         /*!
811          * \brief Channel Connected Line ID information.
812          * \note The connected line information identifies the channel
813          * connected/bridged to this channel.
814          */
815         struct ast_party_connected_line connected;
816
817         /*! \brief Redirecting/Diversion information */
818         struct ast_party_redirecting redirecting;
819
820         struct ast_frame dtmff;                         /*!< DTMF frame */
821         struct varshead varshead;                       /*!< A linked list for channel variables. See \ref AstChanVar */
822         ast_group_t callgroup;                          /*!< Call group for call pickups */
823         ast_group_t pickupgroup;                        /*!< Pickup group - which calls groups can be picked up? */
824         AST_LIST_HEAD_NOLOCK(, ast_frame) readq;
825         struct ast_jb jb;                               /*!< The jitterbuffer state */
826         struct timeval dtmf_tv;                         /*!< The time that an in process digit began, or the last digit ended */
827         AST_LIST_HEAD_NOLOCK(datastores, ast_datastore) datastores; /*!< Data stores on the channel */
828         AST_LIST_HEAD_NOLOCK(autochans, ast_autochan) autochans; /*!< Autochans on the channel */
829
830         unsigned long insmpl;                           /*!< Track the read/written samples for monitor use */
831         unsigned long outsmpl;                          /*!< Track the read/written samples for monitor use */
832
833         int fds[AST_MAX_FDS];                           /*!< File descriptors for channel -- Drivers will poll on
834                                                          *   these file descriptors, so at least one must be non -1.
835                                                          *   See \arg \ref AstFileDesc */
836         int _softhangup;                                /*!< Whether or not we have been hung up...  Do not set this value
837                                                          *   directly, use ast_softhangup() */
838         int fdno;                                       /*!< Which fd had an event detected on */
839         int streamid;                                   /*!< For streaming playback, the schedule ID */
840         int vstreamid;                                  /*!< For streaming video playback, the schedule ID */
841         struct ast_format oldwriteformat;  /*!< Original writer format */
842         int timingfd;                                   /*!< Timing fd */
843         enum ast_channel_state _state;                  /*!< State of line -- Don't write directly, use ast_setstate() */
844         int rings;                                      /*!< Number of rings so far */
845         int priority;                                   /*!< Dialplan: Current extension priority */
846         int macropriority;                              /*!< Macro: Current non-macro priority. See app_macro.c */
847         int amaflags;                                   /*!< Set BEFORE PBX is started to determine AMA flags */
848         enum ast_channel_adsicpe adsicpe;               /*!< Whether or not ADSI is detected on CPE */
849         unsigned int fin;                               /*!< Frames in counters. The high bit is a debug mask, so
850                                                          *   the counter is only in the remaining bits */
851         unsigned int fout;                              /*!< Frames out counters. The high bit is a debug mask, so
852                                                          *   the counter is only in the remaining bits */
853         int hangupcause;                                /*!< Why is the channel hanged up. See causes.h */
854         unsigned int flags;                             /*!< channel flags of AST_FLAG_ type */
855         int alertpipe[2];
856         struct ast_format_cap *nativeformats;         /*!< Kinds of data this channel can natively handle */
857         struct ast_format readformat;            /*!< Requested read format (after translation) */
858         struct ast_format writeformat;           /*!< Requested write format (after translation) */
859         struct ast_format rawreadformat;         /*!< Raw read format (before translation) */
860         struct ast_format rawwriteformat;        /*!< Raw write format (before translation) */
861         unsigned int emulate_dtmf_duration;             /*!< Number of ms left to emulate DTMF for */
862 #ifdef HAVE_EPOLL
863         int epfd;
864 #endif
865         int visible_indication;                         /*!< Indication currently playing on the channel */
866
867         unsigned short transfercapability;              /*!< ISDN Transfer Capability - AST_FLAG_DIGITAL is not enough */
868
869         struct ast_bridge *bridge;                      /*!< Bridge this channel is participating in */
870         struct ast_timer *timer;                        /*!< timer object that provided timingfd */
871
872         char context[AST_MAX_CONTEXT];                  /*!< Dialplan: Current extension context */
873         char exten[AST_MAX_EXTENSION];                  /*!< Dialplan: Current extension number */
874         char macrocontext[AST_MAX_CONTEXT];             /*!< Macro: Current non-macro context. See app_macro.c */
875         char macroexten[AST_MAX_EXTENSION];             /*!< Macro: Current non-macro extension. See app_macro.c */
876         char emulate_dtmf_digit;                        /*!< Digit being emulated */
877 };
878
879 /*! \brief ast_channel_tech Properties */
880 enum {
881         /*!
882      * \brief Channels have this property if they can accept input with jitter;
883          * i.e. most VoIP channels
884          */
885         AST_CHAN_TP_WANTSJITTER = (1 << 0),
886         /*!
887      * \brief Channels have this property if they can create jitter;
888          * i.e. most VoIP channels
889          */
890         AST_CHAN_TP_CREATESJITTER = (1 << 1),
891 };
892
893 /*! \brief ast_channel flags */
894 enum {
895         /*! Queue incoming DTMF, to be released when this flag is turned off */
896         AST_FLAG_DEFER_DTMF =    (1 << 1),
897         /*! write should be interrupt generator */
898         AST_FLAG_WRITE_INT =     (1 << 2),
899         /*! a thread is blocking on this channel */
900         AST_FLAG_BLOCKING =      (1 << 3),
901         /*! This is a zombie channel */
902         AST_FLAG_ZOMBIE =        (1 << 4),
903         /*! There is an exception pending */
904         AST_FLAG_EXCEPTION =     (1 << 5),
905         /*! Listening to moh XXX anthm promises me this will disappear XXX */
906         AST_FLAG_MOH =           (1 << 6),
907         /*! This channel is spying on another channel */
908         AST_FLAG_SPYING =        (1 << 7),
909         /*! This channel is in a native bridge */
910         AST_FLAG_NBRIDGE =       (1 << 8),
911         /*! the channel is in an auto-incrementing dialplan processor,
912          *  so when ->priority is set, it will get incremented before
913          *  finding the next priority to run */
914         AST_FLAG_IN_AUTOLOOP =   (1 << 9),
915         /*! This is an outgoing call */
916         AST_FLAG_OUTGOING =      (1 << 10),
917         /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
918         AST_FLAG_IN_DTMF =       (1 << 12),
919         /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
920          *  currently being emulated */
921         AST_FLAG_EMULATE_DTMF =  (1 << 13),
922         /*! This is set to tell the channel not to generate DTMF begin frames, and
923          *  to instead only generate END frames. */
924         AST_FLAG_END_DTMF_ONLY = (1 << 14),
925         /*! Flag to show channels that this call is hangup due to the fact that the call
926             was indeed answered, but in another channel */
927         AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15),
928         /*! This flag indicates that on a masquerade, an active stream should not
929          *  be carried over */
930         AST_FLAG_MASQ_NOSTREAM = (1 << 16),
931         /*! This flag indicates that the hangup exten was run when the bridge terminated,
932          *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
933          *  level */
934         AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
935         /*! This flag indicates that the hangup exten should NOT be run when the
936          *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
937          *  */
938         AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
939         /*! Disable certain workarounds.  This reintroduces certain bugs, but allows
940          *  some non-traditional dialplans (like AGI) to continue to function.
941          */
942         AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
943 };
944
945 /*! \brief ast_bridge_config flags */
946 enum {
947         AST_FEATURE_PLAY_WARNING = (1 << 0),
948         AST_FEATURE_REDIRECT =     (1 << 1),
949         AST_FEATURE_DISCONNECT =   (1 << 2),
950         AST_FEATURE_ATXFER =       (1 << 3),
951         AST_FEATURE_AUTOMON =      (1 << 4),
952         AST_FEATURE_PARKCALL =     (1 << 5),
953         AST_FEATURE_AUTOMIXMON =   (1 << 6),
954         AST_FEATURE_NO_H_EXTEN =   (1 << 7),
955         AST_FEATURE_WARNING_ACTIVE = (1 << 8),
956 };
957
958 /*! \brief bridge configuration */
959 struct ast_bridge_config {
960         struct ast_flags features_caller;
961         struct ast_flags features_callee;
962         struct timeval start_time;
963         struct timeval nexteventts;
964         struct timeval feature_start_time;
965         long feature_timer;
966         long timelimit;
967         long play_warning;
968         long warning_freq;
969         const char *warning_sound;
970         const char *end_sound;
971         const char *start_sound;
972         unsigned int flags;
973         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
974         void *end_bridge_callback_data;         /*!< Data passed to the callback */
975         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
976          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
977          */
978         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
979 };
980
981 struct chanmon;
982
983 struct outgoing_helper {
984         const char *context;
985         const char *exten;
986         int priority;
987         const char *cid_num;
988         const char *cid_name;
989         const char *account;
990         struct ast_variable *vars;
991         struct ast_channel *parent_channel;
992 };
993
994 enum {
995         /*!
996          * Soft hangup requested by device or other internal reason.
997          * Actual hangup needed.
998          */
999         AST_SOFTHANGUP_DEV =       (1 << 0),
1000         /*!
1001          * Used to break the normal frame flow so an async goto can be
1002          * done instead of actually hanging up.
1003          */
1004         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
1005         /*!
1006          * Soft hangup requested by system shutdown.  Actual hangup
1007          * needed.
1008          */
1009         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
1010         /*!
1011          * Used to break the normal frame flow after a timeout so an
1012          * implicit async goto can be done to the 'T' exten if it exists
1013          * instead of actually hanging up.  If the exten does not exist
1014          * then actually hangup.
1015          */
1016         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
1017         /*!
1018          * Soft hangup requested by application/channel-driver being
1019          * unloaded.  Actual hangup needed.
1020          */
1021         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
1022         /*!
1023          * Soft hangup requested by non-associated party.  Actual hangup
1024          * needed.
1025          */
1026         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
1027         /*!
1028          * Used to break a bridge so the channel can be spied upon
1029          * instead of actually hanging up.
1030          */
1031         AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
1032
1033
1034         /*!
1035          * \brief All softhangup flags.
1036          *
1037          * This can be used as an argument to ast_channel_clear_softhangup()
1038          * to clear all softhangup flags from a channel.
1039          */
1040         AST_SOFTHANGUP_ALL =       (0xFFFFFFFF)
1041 };
1042
1043
1044 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
1045 enum channelreloadreason {
1046         CHANNEL_MODULE_LOAD,
1047         CHANNEL_MODULE_RELOAD,
1048         CHANNEL_CLI_RELOAD,
1049         CHANNEL_MANAGER_RELOAD,
1050 };
1051
1052 /*!
1053  * \note None of the datastore API calls lock the ast_channel they are using.
1054  *       So, the channel should be locked before calling the functions that
1055  *       take a channel argument.
1056  */
1057
1058 /*!
1059  * \brief Create a channel data store object
1060  * \deprecated You should use the ast_datastore_alloc() generic function instead.
1061  * \version 1.6.1 deprecated
1062  */
1063 struct ast_datastore * attribute_malloc ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
1064         __attribute__((deprecated));
1065
1066 /*!
1067  * \brief Free a channel data store object
1068  * \deprecated You should use the ast_datastore_free() generic function instead.
1069  * \version 1.6.1 deprecated
1070  */
1071 int ast_channel_datastore_free(struct ast_datastore *datastore)
1072         __attribute__((deprecated));
1073
1074 /*! \brief Inherit datastores from a parent to a child. */
1075 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
1076
1077 /*!
1078  * \brief Add a datastore to a channel
1079  *
1080  * \note The channel should be locked before calling this function.
1081  *
1082  * \retval 0 success
1083  * \retval non-zero failure
1084  */
1085 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
1086
1087 /*!
1088  * \brief Remove a datastore from a channel
1089  *
1090  * \note The channel should be locked before calling this function.
1091  *
1092  * \retval 0 success
1093  * \retval non-zero failure
1094  */
1095 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
1096
1097 /*!
1098  * \brief Find a datastore on a channel
1099  *
1100  * \note The channel should be locked before calling this function.
1101  *
1102  * \note The datastore returned from this function must not be used if the
1103  *       reference to the channel is released.
1104  *
1105  * \retval pointer to the datastore if found
1106  * \retval NULL if not found
1107  */
1108 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
1109
1110 /*!
1111  * \brief Create a channel structure
1112  * \since 1.8
1113  *
1114  * \retval NULL failure
1115  * \retval non-NULL successfully allocated channel
1116  *
1117  * \note Absolutely _NO_ channel locks should be held before calling this function.
1118  * \note By default, new channels are set to the "s" extension
1119  *       and "default" context.
1120  */
1121 struct ast_channel * attribute_malloc __attribute__((format(printf, 13, 14)))
1122         __ast_channel_alloc(int needqueue, int state, const char *cid_num,
1123                             const char *cid_name, const char *acctcode,
1124                             const char *exten, const char *context,
1125                             const char *linkedid, const int amaflag,
1126                             const char *file, int line, const char *function,
1127                             const char *name_fmt, ...);
1128
1129 /*!
1130  * \brief Create a channel structure
1131  *
1132  * \retval NULL failure
1133  * \retval non-NULL successfully allocated channel
1134  *
1135  * \note Absolutely _NO_ channel locks should be held before calling this function.
1136  * \note By default, new channels are set to the "s" extension
1137  *       and "default" context.
1138  */
1139 #define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, ...) \
1140         __ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, \
1141                             __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
1142
1143 #if defined(REF_DEBUG) || defined(__AST_DEBUG_MALLOC)
1144 /*!
1145  * \brief Create a fake channel structure
1146  *
1147  * \retval NULL failure
1148  * \retval non-NULL successfully allocated channel
1149  *
1150  * \note This function should ONLY be used to create a fake channel
1151  *       that can then be populated with data for use in variable
1152  *       substitution when a real channel does not exist.
1153  *
1154  * \note The created dummy channel should be destroyed by
1155  * ast_channel_unref().  Using ast_channel_release() needlessly
1156  * grabs the channel container lock and can cause a deadlock as
1157  * a result.  Also grabbing the channel container lock reduces
1158  * system performance.
1159  */
1160 #define ast_dummy_channel_alloc()       __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
1161 struct ast_channel *__ast_dummy_channel_alloc(const char *file, int line, const char *function);
1162 #else
1163 /*!
1164  * \brief Create a fake channel structure
1165  *
1166  * \retval NULL failure
1167  * \retval non-NULL successfully allocated channel
1168  *
1169  * \note This function should ONLY be used to create a fake channel
1170  *       that can then be populated with data for use in variable
1171  *       substitution when a real channel does not exist.
1172  *
1173  * \note The created dummy channel should be destroyed by
1174  * ast_channel_unref().  Using ast_channel_release() needlessly
1175  * grabs the channel container lock and can cause a deadlock as
1176  * a result.  Also grabbing the channel container lock reduces
1177  * system performance.
1178  */
1179 struct ast_channel *ast_dummy_channel_alloc(void);
1180 #endif
1181
1182 /*!
1183  * \brief Queue one or more frames to a channel's frame queue
1184  *
1185  * \param chan the channel to queue the frame(s) on
1186  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1187  *        by this function.  It is the responsibility of the caller to handle
1188  *        freeing the memory associated with the frame(s) being passed if
1189  *        necessary.
1190  *
1191  * \retval 0 success
1192  * \retval non-zero failure
1193  */
1194 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
1195
1196 /*!
1197  * \brief Queue one or more frames to the head of a channel's frame queue
1198  *
1199  * \param chan the channel to queue the frame(s) on
1200  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1201  *        by this function.  It is the responsibility of the caller to handle
1202  *        freeing the memory associated with the frame(s) being passed if
1203  *        necessary.
1204  *
1205  * \retval 0 success
1206  * \retval non-zero failure
1207  */
1208 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
1209
1210 /*!
1211  * \brief Queue a hangup frame
1212  *
1213  * \note The channel does not need to be locked before calling this function.
1214  */
1215 int ast_queue_hangup(struct ast_channel *chan);
1216
1217 /*!
1218  * \brief Queue a hangup frame with hangupcause set
1219  *
1220  * \note The channel does not need to be locked before calling this function.
1221  * \param[in] chan channel to queue frame onto
1222  * \param[in] cause the hangup cause
1223  * \return 0 on success, -1 on error
1224  * \since 1.6.1
1225  */
1226 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
1227
1228 /*!
1229  * \brief Queue a control frame with payload
1230  *
1231  * \param chan channel to queue frame onto
1232  * \param control type of control frame
1233  *
1234  * \note The channel does not need to be locked before calling this function.
1235  *
1236  * \retval zero on success
1237  * \retval non-zero on failure
1238  */
1239 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
1240
1241 /*!
1242  * \brief Queue a control frame with payload
1243  *
1244  * \param chan channel to queue frame onto
1245  * \param control type of control frame
1246  * \param data pointer to payload data to be included in frame
1247  * \param datalen number of bytes of payload data
1248  *
1249  * \retval 0 success
1250  * \retval non-zero failure
1251  *
1252  * \details
1253  * The supplied payload data is copied into the frame, so the caller's copy
1254  * is not modified nor freed, and the resulting frame will retain a copy of
1255  * the data even if the caller frees their local copy.
1256  *
1257  * \note This method should be treated as a 'network transport'; in other
1258  * words, your frames may be transferred across an IAX2 channel to another
1259  * system, which may be a different endianness than yours. Because of this,
1260  * you should ensure that either your frames will never be expected to work
1261  * across systems, or that you always put your payload data into 'network byte
1262  * order' before calling this function.
1263  *
1264  * \note The channel does not need to be locked before calling this function.
1265  */
1266 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
1267                            const void *data, size_t datalen);
1268
1269 /*!
1270  * \brief Change channel name
1271  *
1272  * \pre Absolutely all channels _MUST_ be unlocked before calling this function.
1273  *
1274  * \param chan the channel to change the name of
1275  * \param newname the name to change to
1276  *
1277  * \return nothing
1278  *
1279  * \note this function must _NEVER_ be used when any channels are locked
1280  * regardless if it is the channel who's name is being changed or not because
1281  * it invalidates our channel container locking order... lock container first,
1282  * then the individual channels, never the other way around.
1283  */
1284 void ast_change_name(struct ast_channel *chan, const char *newname);
1285
1286 /*!
1287  * \brief Unlink and release reference to a channel
1288  *
1289  * This function will unlink the channel from the global channels container
1290  * if it is still there and also release the current reference to the channel.
1291  *
1292  * \return NULL, convenient for clearing invalid pointers
1293  * \note Absolutely _NO_ channel locks should be held before calling this function.
1294  *
1295  * \since 1.8
1296  */
1297 struct ast_channel *ast_channel_release(struct ast_channel *chan);
1298
1299 /*!
1300  * \brief Requests a channel
1301  *
1302  * \param type type of channel to request
1303  * \param format capabilities for requested channel
1304  * \param requestor channel asking for data
1305  * \param data data to pass to the channel requester (Should be treated as const char *)
1306  * \param status status
1307  *
1308  * \details
1309  * Request a channel of a given type, with data as optional information used
1310  * by the low level module
1311  *
1312  * \retval NULL failure
1313  * \retval non-NULL channel on success
1314  */
1315 struct ast_channel *ast_request(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, void *data, int *status);
1316
1317 /*!
1318  * \brief Request a channel of a given type, with data as optional information used
1319  *        by the low level module and attempt to place a call on it
1320  *
1321  * \param type type of channel to request
1322  * \param format capabilities for requested channel
1323  * \param requestor channel asking for data
1324  * \param data data to pass to the channel requester
1325  * \param timeout maximum amount of time to wait for an answer
1326  * \param reason why unsuccessful (if unsuccessful)
1327  * \param cid_num Caller-ID Number
1328  * \param cid_name Caller-ID Name (ascii)
1329  *
1330  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1331  * to know if the call was answered or not.
1332  */
1333 struct ast_channel *ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, void *data,
1334         int timeout, int *reason, const char *cid_num, const char *cid_name);
1335
1336 /*!
1337  * \brief Request a channel of a given type, with data as optional information used
1338  * by the low level module and attempt to place a call on it
1339  * \param type type of channel to request
1340  * \param format capabilities for requested channel
1341  * \param requestor channel requesting data
1342  * \param data data to pass to the channel requester
1343  * \param timeout maximum amount of time to wait for an answer
1344  * \param reason why unsuccessful (if unsuccessful)
1345  * \param cid_num Caller-ID Number
1346  * \param cid_name Caller-ID Name (ascii)
1347  * \param oh Outgoing helper
1348  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1349  * to know if the call was answered or not.
1350  */
1351 struct ast_channel *__ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, void *data,
1352         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1353
1354 /*!
1355  * \brief Forwards a call to a new channel specified by the original channel's call_forward str.  If possible, the new forwarded channel is created and returned while the original one is terminated.
1356  * \param caller in channel that requested orig
1357  * \param orig channel being replaced by the call forward channel
1358  * \param timeout maximum amount of time to wait for setup of new forward channel
1359  * \param format capabilities for requested channel
1360  * \param oh outgoing helper used with original channel
1361  * \param outstate reason why unsuccessful (if uncuccessful)
1362  * \return Returns the forwarded call's ast_channel on success or NULL on failure
1363  */
1364 struct ast_channel *ast_call_forward(struct ast_channel *caller, struct ast_channel *orig, int *timeout, struct ast_format_cap *cap, struct outgoing_helper *oh, int *outstate);
1365
1366 /*!
1367  * \brief Register a channel technology (a new channel driver)
1368  * Called by a channel module to register the kind of channels it supports.
1369  * \param tech Structure defining channel technology or "type"
1370  * \return Returns 0 on success, -1 on failure.
1371  */
1372 int ast_channel_register(const struct ast_channel_tech *tech);
1373
1374 /*!
1375  * \brief Unregister a channel technology
1376  * \param tech Structure defining channel technology or "type" that was previously registered
1377  * \return No return value.
1378  */
1379 void ast_channel_unregister(const struct ast_channel_tech *tech);
1380
1381 /*!
1382  * \brief Get a channel technology structure by name
1383  * \param name name of technology to find
1384  * \return a pointer to the structure, or NULL if no matching technology found
1385  */
1386 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1387
1388 #ifdef CHANNEL_TRACE
1389 /*!
1390  * \brief Update the context backtrace if tracing is enabled
1391  * \return Returns 0 on success, -1 on failure
1392  */
1393 int ast_channel_trace_update(struct ast_channel *chan);
1394
1395 /*!
1396  * \brief Enable context tracing in the channel
1397  * \return Returns 0 on success, -1 on failure
1398  */
1399 int ast_channel_trace_enable(struct ast_channel *chan);
1400
1401 /*!
1402  * \brief Disable context tracing in the channel.
1403  * \note Does not remove current trace entries
1404  * \return Returns 0 on success, -1 on failure
1405  */
1406 int ast_channel_trace_disable(struct ast_channel *chan);
1407
1408 /*!
1409  * \brief Whether or not context tracing is enabled
1410  * \return Returns -1 when the trace is enabled. 0 if not.
1411  */
1412 int ast_channel_trace_is_enabled(struct ast_channel *chan);
1413
1414 /*!
1415  * \brief Put the channel backtrace in a string
1416  * \return Returns the amount of lines in the backtrace. -1 on error.
1417  */
1418 int ast_channel_trace_serialize(struct ast_channel *chan, struct ast_str **out);
1419 #endif
1420
1421 /*!
1422  * \brief Hang up a channel
1423  * \note Absolutely _NO_ channel locks should be held before calling this function.
1424  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
1425  * performs all stream stopping, etc, on the channel that needs to end.
1426  * chan is no longer valid after this call.
1427  * \param chan channel to hang up
1428  * \return Returns 0 on success, -1 on failure.
1429  */
1430 int ast_hangup(struct ast_channel *chan);
1431
1432 /*!
1433  * \brief Softly hangup up a channel
1434  *
1435  * \param chan channel to be soft-hung-up
1436  * \param reason an AST_SOFTHANGUP_* reason code
1437  *
1438  * \details
1439  * Call the protocol layer, but don't destroy the channel structure
1440  * (use this if you are trying to
1441  * safely hangup a channel managed by another thread.
1442  *
1443  * \note The channel passed to this function does not need to be locked.
1444  *
1445  * \return Returns 0 regardless
1446  */
1447 int ast_softhangup(struct ast_channel *chan, int reason);
1448
1449 /*!
1450  * \brief Softly hangup up a channel (no channel lock)
1451  * \param chan channel to be soft-hung-up
1452  * \param reason an AST_SOFTHANGUP_* reason code
1453  */
1454 int ast_softhangup_nolock(struct ast_channel *chan, int reason);
1455
1456 /*!
1457  * \brief Clear a set of softhangup flags from a channel
1458  *
1459  * Never clear a softhangup flag from a channel directly.  Instead,
1460  * use this function.  This ensures that all aspects of the softhangup
1461  * process are aborted.
1462  *
1463  * \param chan the channel to clear the flag on
1464  * \param flag the flag or flags to clear
1465  *
1466  * \return Nothing.
1467  */
1468 void ast_channel_clear_softhangup(struct ast_channel *chan, int flag);
1469
1470 /*!
1471  * \brief Set the source of the hangup in this channel and it's bridge
1472  *
1473  * \param chan channel to set the field on
1474  * \param source a string describing the source of the hangup for this channel
1475  * \param force
1476  *
1477  * \since 1.8
1478  *
1479  * Hangupsource is generally the channel name that caused the bridge to be
1480  * hung up, but it can also be other things such as "dialplan/agi"
1481  * This can then be logged in the CDR or CEL
1482  */
1483 void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force);
1484
1485 /*! \brief Check to see if a channel is needing hang up
1486  * \param chan channel on which to check for hang up
1487  * This function determines if the channel is being requested to be hung up.
1488  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1489  */
1490 int ast_check_hangup(struct ast_channel *chan);
1491
1492 int ast_check_hangup_locked(struct ast_channel *chan);
1493
1494 /*!
1495  * \brief Compare a offset with the settings of when to hang a channel up
1496  * \param chan channel on which to check for hang up
1497  * \param offset offset in seconds from current time
1498  * \return 1, 0, or -1
1499  * \details
1500  * This function compares a offset from current time with the absolute time
1501  * out on a channel (when to hang up). If the absolute time out on a channel
1502  * is earlier than current time plus the offset, it returns 1, if the two
1503  * time values are equal, it return 0, otherwise, it return -1.
1504  * \sa ast_channel_cmpwhentohangup_tv()
1505  * \version 1.6.1 deprecated function (only had seconds precision)
1506  */
1507 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1508
1509 /*!
1510  * \brief Compare a offset with the settings of when to hang a channel up
1511  * \param chan channel on which to check for hangup
1512  * \param offset offset in seconds and microseconds from current time
1513  * \return 1, 0, or -1
1514  * This function compares a offset from current time with the absolute time
1515  * out on a channel (when to hang up). If the absolute time out on a channel
1516  * is earlier than current time plus the offset, it returns 1, if the two
1517  * time values are equal, it return 0, otherwise, it return -1.
1518  * \since 1.6.1
1519  */
1520 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1521
1522 /*!
1523  * \brief Set when to hang a channel up
1524  *
1525  * \param chan channel on which to check for hang up
1526  * \param offset offset in seconds relative to the current time of when to hang up
1527  *
1528  * \details
1529  * This function sets the absolute time out on a channel (when to hang up).
1530  *
1531  * \note This function does not require that the channel is locked before
1532  *       calling it.
1533  *
1534  * \return Nothing
1535  * \sa ast_channel_setwhentohangup_tv()
1536  * \version 1.6.1 deprecated function (only had seconds precision)
1537  */
1538 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1539
1540 /*!
1541  * \brief Set when to hang a channel up
1542  *
1543  * \param chan channel on which to check for hang up
1544  * \param offset offset in seconds and useconds relative to the current time of when to hang up
1545  *
1546  * This function sets the absolute time out on a channel (when to hang up).
1547  *
1548  * \note This function does not require that the channel is locked before
1549  * calling it.
1550  *
1551  * \return Nothing
1552  * \since 1.6.1
1553  */
1554 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1555
1556 /*!
1557  * \brief Answer a channel
1558  *
1559  * \param chan channel to answer
1560  *
1561  * \details
1562  * This function answers a channel and handles all necessary call
1563  * setup functions.
1564  *
1565  * \note The channel passed does not need to be locked, but is locked
1566  * by the function when needed.
1567  *
1568  * \note This function will wait up to 500 milliseconds for media to
1569  * arrive on the channel before returning to the caller, so that the
1570  * caller can properly assume the channel is 'ready' for media flow.
1571  *
1572  * \retval 0 on success
1573  * \retval non-zero on failure
1574  */
1575 int ast_answer(struct ast_channel *chan);
1576
1577 /*!
1578  * \brief Answer a channel
1579  *
1580  * \param chan channel to answer
1581  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1582  *
1583  * This function answers a channel and handles all necessary call
1584  * setup functions.
1585  *
1586  * \note The channel passed does not need to be locked, but is locked
1587  * by the function when needed.
1588  *
1589  * \note Unlike ast_answer(), this function will not wait for media
1590  * flow to begin. The caller should be careful before sending media
1591  * to the channel before incoming media arrives, as the outgoing
1592  * media may be lost.
1593  *
1594  * \retval 0 on success
1595  * \retval non-zero on failure
1596  */
1597 int ast_raw_answer(struct ast_channel *chan, int cdr_answer);
1598
1599 /*!
1600  * \brief Answer a channel, with a selectable delay before returning
1601  *
1602  * \param chan channel to answer
1603  * \param delay maximum amount of time to wait for incoming media
1604  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1605  *
1606  * This function answers a channel and handles all necessary call
1607  * setup functions.
1608  *
1609  * \note The channel passed does not need to be locked, but is locked
1610  * by the function when needed.
1611  *
1612  * \note This function will wait up to 'delay' milliseconds for media to
1613  * arrive on the channel before returning to the caller, so that the
1614  * caller can properly assume the channel is 'ready' for media flow. If
1615  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1616  *
1617  * \retval 0 on success
1618  * \retval non-zero on failure
1619  */
1620 int __ast_answer(struct ast_channel *chan, unsigned int delay, int cdr_answer);
1621
1622 /*!
1623  * \brief Make a call
1624  * \note Absolutely _NO_ channel locks should be held before calling this function.
1625  * \param chan which channel to make the call on
1626  * \param addr destination of the call (Should be treated as const char *)
1627  * \param timeout time to wait on for connect
1628  * \details
1629  * Place a call, take no longer than timeout ms.
1630  * \return -1 on failure, 0 on not enough time
1631  * (does not automatically stop ringing), and
1632  * the number of seconds the connect took otherwise.
1633  */
1634 int ast_call(struct ast_channel *chan, char *addr, int timeout);
1635
1636 /*!
1637  * \brief Indicates condition of channel
1638  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1639  * \param chan channel to change the indication
1640  * \param condition which condition to indicate on the channel
1641  * \return Returns 0 on success, -1 on failure
1642  */
1643 int ast_indicate(struct ast_channel *chan, int condition);
1644
1645 /*!
1646  * \brief Indicates condition of channel, with payload
1647  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1648  * \param chan channel to change the indication
1649  * \param condition which condition to indicate on the channel
1650  * \param data pointer to payload data
1651  * \param datalen size of payload data
1652  * \return Returns 0 on success, -1 on failure
1653  */
1654 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1655
1656 /* Misc stuff ------------------------------------------------ */
1657
1658 /*!
1659  * \brief Wait for input on a channel
1660  * \param chan channel to wait on
1661  * \param ms length of time to wait on the channel
1662  * \details
1663  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1664  * \retval < 0 on failure
1665  * \retval 0 if nothing ever arrived
1666  * \retval the # of ms remaining otherwise
1667  */
1668 int ast_waitfor(struct ast_channel *chan, int ms);
1669
1670 /*!
1671  * \brief Should we keep this frame for later?
1672  *
1673  * There are functions such as ast_safe_sleep which will
1674  * service a channel to ensure that it does not have a
1675  * large backlog of queued frames. When this happens,
1676  * we want to hold on to specific frame types and just drop
1677  * others. This function will tell if the frame we just
1678  * read should be held onto.
1679  *
1680  * \param frame The frame we just read
1681  * \retval 1 frame should be kept
1682  * \retval 0 frame should be dropped
1683  */
1684 int ast_is_deferrable_frame(const struct ast_frame *frame);
1685
1686 /*!
1687  * \brief Wait for a specified amount of time, looking for hangups
1688  * \param chan channel to wait for
1689  * \param ms length of time in milliseconds to sleep
1690  * \details
1691  * Waits for a specified amount of time, servicing the channel as required.
1692  * \return returns -1 on hangup, otherwise 0.
1693  */
1694 int ast_safe_sleep(struct ast_channel *chan, int ms);
1695
1696 /*!
1697  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
1698  * \param chan channel to wait for
1699  * \param ms length of time in milliseconds to sleep
1700  * \param cond a function pointer for testing continue condition
1701  * \param data argument to be passed to the condition test function
1702  * \return returns -1 on hangup, otherwise 0.
1703  * \details
1704  * Waits for a specified amount of time, servicing the channel as required. If cond
1705  * returns 0, this function returns.
1706  */
1707 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1708
1709 /*!
1710  * \brief Waits for activity on a group of channels
1711  * \param chan an array of pointers to channels
1712  * \param n number of channels that are to be waited upon
1713  * \param fds an array of fds to wait upon
1714  * \param nfds the number of fds to wait upon
1715  * \param exception exception flag
1716  * \param outfd fd that had activity on it
1717  * \param ms how long the wait was
1718  * \details
1719  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1720  * file descriptors.
1721  * \return Returns the channel with activity, or NULL on error or if an FD
1722  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1723  * will be -1
1724  */
1725 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1726         int *fds, int nfds, int *exception, int *outfd, int *ms);
1727
1728 /*!
1729  * \brief Waits for input on a group of channels
1730  * Wait for input on an array of channels for a given # of milliseconds.
1731  * \return Return channel with activity, or NULL if none has activity.
1732  * \param chan an array of pointers to channels
1733  * \param n number of channels that are to be waited upon
1734  * \param ms time "ms" is modified in-place, if applicable
1735  */
1736 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1737
1738 /*!
1739  * \brief Waits for input on an fd
1740  * \note This version works on fd's only.  Be careful with it.
1741  */
1742 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1743
1744
1745 /*!
1746  * \brief Reads a frame
1747  * \param chan channel to read a frame from
1748  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1749  * best just stop reading frames and assume the channel has been
1750  * disconnected.
1751  */
1752 struct ast_frame *ast_read(struct ast_channel *chan);
1753
1754 /*!
1755  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
1756  * \param chan channel to read a frame from
1757  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
1758  * best just stop reading frames and assume the channel has been
1759  * disconnected.
1760  * \note Audio is replaced with AST_FRAME_NULL to avoid
1761  * transcode when the resulting audio is not necessary.
1762  */
1763 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1764
1765 /*!
1766  * \brief Write a frame to a channel
1767  * This function writes the given frame to the indicated channel.
1768  * \param chan destination channel of the frame
1769  * \param frame frame that will be written
1770  * \return It returns 0 on success, -1 on failure.
1771  */
1772 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1773
1774 /*!
1775  * \brief Write video frame to a channel
1776  * This function writes the given frame to the indicated channel.
1777  * \param chan destination channel of the frame
1778  * \param frame frame that will be written
1779  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1780  */
1781 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1782
1783 /*!
1784  * \brief Write text frame to a channel
1785  * This function writes the given frame to the indicated channel.
1786  * \param chan destination channel of the frame
1787  * \param frame frame that will be written
1788  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1789  */
1790 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1791
1792 /*! \brief Send empty audio to prime a channel driver */
1793 int ast_prod(struct ast_channel *chan);
1794
1795 /*!
1796  * \brief Sets read format on channel chan from capabilities
1797  * Set read format for channel to whichever component of "format" is best.
1798  * \param chan channel to change
1799  * \param formats new formats to pick from for reading
1800  * \return Returns 0 on success, -1 on failure
1801  */
1802 int ast_set_read_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1803
1804 /*!
1805  * \brief Sets read format on channel chan
1806  * \param chan channel to change
1807  * \param formats, format to set for reading
1808  * \return Returns 0 on success, -1 on failure
1809  */
1810 int ast_set_read_format(struct ast_channel *chan, struct ast_format *format);
1811
1812 /*!
1813  * \brief Sets read format on channel chan by id
1814  * \param chan channel to change
1815  * \param format id to set for reading, only used for formats without attributes
1816  * \return Returns 0 on success, -1 on failure
1817  */
1818 int ast_set_read_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1819
1820 /*!
1821  * \brief Sets write format on channel chan
1822  * Set write format for channel to whichever component of "format" is best.
1823  * \param chan channel to change
1824  * \param formats new formats to pick from for writing
1825  * \return Returns 0 on success, -1 on failure
1826  */
1827 int ast_set_write_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1828
1829 /*!
1830  * \brief Sets write format on channel chan
1831  * \param chan channel to change
1832  * \param formats, format to set for writing
1833  * \return Returns 0 on success, -1 on failure
1834  */
1835 int ast_set_write_format(struct ast_channel *chan, struct ast_format *format);
1836
1837 /*!
1838  * \brief Sets write format on channel chan
1839  * \param chan channel to change
1840  * \param format id to set for writing, only used for formats without attributes
1841  * \return Returns 0 on success, -1 on failure
1842  */
1843 int ast_set_write_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1844
1845 /*!
1846  * \brief Sends text to a channel
1847  *
1848  * \param chan channel to act upon
1849  * \param text string of text to send on the channel
1850  *
1851  * \details
1852  * Write text to a display on a channel
1853  *
1854  * \note The channel does not need to be locked before calling this function.
1855  *
1856  * \retval 0 on success
1857  * \retval -1 on failure
1858  */
1859 int ast_sendtext(struct ast_channel *chan, const char *text);
1860
1861 /*!
1862  * \brief Receives a text character from a channel
1863  * \param chan channel to act upon
1864  * \param timeout timeout in milliseconds (0 for infinite wait)
1865  * \details
1866  * Read a char of text from a channel
1867  * \return 0 on success, -1 on failure
1868  */
1869 int ast_recvchar(struct ast_channel *chan, int timeout);
1870
1871 /*!
1872  * \brief Send a DTMF digit to a channel.
1873  * \param chan channel to act upon
1874  * \param digit the DTMF digit to send, encoded in ASCII
1875  * \param duration the duration of the digit ending in ms
1876  * \return 0 on success, -1 on failure
1877  */
1878 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
1879
1880 /*!
1881  * \brief Send a DTMF digit to a channel.
1882  * \param chan channel to act upon
1883  * \param digit the DTMF digit to send, encoded in ASCII
1884  * \return 0 on success, -1 on failure
1885  */
1886 int ast_senddigit_begin(struct ast_channel *chan, char digit);
1887
1888 /*!
1889  * \brief Send a DTMF digit to a channel.
1890  * \param chan channel to act upon
1891  * \param digit the DTMF digit to send, encoded in ASCII
1892  * \param duration the duration of the digit ending in ms
1893  * \return Returns 0 on success, -1 on failure
1894  */
1895 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
1896
1897 /*!
1898  * \brief Receives a text string from a channel
1899  * Read a string of text from a channel
1900  * \param chan channel to act upon
1901  * \param timeout timeout in milliseconds (0 for infinite wait)
1902  * \return the received text, or NULL to signify failure.
1903  */
1904 char *ast_recvtext(struct ast_channel *chan, int timeout);
1905
1906 /*!
1907  * \brief Waits for a digit
1908  * \param c channel to wait for a digit on
1909  * \param ms how many milliseconds to wait
1910  * \return Returns <0 on error, 0 on no entry, and the digit on success.
1911  */
1912 int ast_waitfordigit(struct ast_channel *c, int ms);
1913
1914 /*!
1915  * \brief Wait for a digit
1916  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
1917  * \param c channel to wait for a digit on
1918  * \param ms how many milliseconds to wait
1919  * \param audiofd audio file descriptor to write to if audio frames are received
1920  * \param ctrlfd control file descriptor to monitor for reading
1921  * \return Returns 1 if ctrlfd becomes available
1922  */
1923 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
1924
1925 /*!
1926  * \brief Reads multiple digits
1927  * \param c channel to read from
1928  * \param s string to read in to.  Must be at least the size of your length
1929  * \param len how many digits to read (maximum)
1930  * \param timeout how long to timeout between digits
1931  * \param rtimeout timeout to wait on the first digit
1932  * \param enders digits to end the string
1933  * \details
1934  * Read in a digit string "s", max length "len", maximum timeout between
1935  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
1936  * for the first digit.
1937  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
1938  * a timeout, any digits that were read before the timeout will still be available in s.
1939  * RETURNS 2 in full version when ctrlfd is available, NOT 1
1940  */
1941 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
1942 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
1943
1944 /*! \brief Report DTMF on channel 0 */
1945 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
1946 /*! \brief Report DTMF on channel 1 */
1947 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
1948 /*! \brief Return all voice frames on channel 0 */
1949 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)
1950 /*! \brief Return all voice frames on channel 1 */
1951 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)
1952 /*! \brief Ignore all signal frames except NULL */
1953 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)
1954
1955
1956 /*!
1957  * \brief Makes two channel formats compatible
1958  * \param c0 first channel to make compatible
1959  * \param c1 other channel to make compatible
1960  * \details
1961  * Set two channels to compatible formats -- call before ast_channel_bridge in general.
1962  * \return Returns 0 on success and -1 if it could not be done
1963  */
1964 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
1965
1966 /*!
1967  * \brief Bridge two channels together (early)
1968  * \param c0 first channel to bridge
1969  * \param c1 second channel to bridge
1970  * \details
1971  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
1972  * \return Returns 0 on success and -1 if it could not be done
1973  */
1974 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1975
1976 /*!
1977  * \brief Bridge two channels together
1978  * \param c0 first channel to bridge
1979  * \param c1 second channel to bridge
1980  * \param config config for the channels
1981  * \param fo destination frame(?)
1982  * \param rc destination channel(?)
1983  * \details
1984  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
1985  * *rf (remember, it could be NULL) and which channel (0 or 1) in rc
1986  */
1987 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
1988 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,
1989         struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
1990
1991 /*!
1992  * \brief Weird function made for call transfers
1993  *
1994  * \param original channel to make a copy of
1995  * \param clone copy of the original channel
1996  *
1997  * \details
1998  * This is a very strange and freaky function used primarily for transfer.  Suppose that
1999  * "original" and "clone" are two channels in random situations.  This function takes
2000  * the guts out of "clone" and puts them into the "original" channel, then alerts the
2001  * channel driver of the change, asking it to fixup any private information (like the
2002  * p->owner pointer) that is affected by the change.  The physical layer of the original
2003  * channel is hung up.
2004  *
2005  * \note Neither channel passed here should be locked before
2006  * calling this function.  This function performs deadlock
2007  * avoidance involving these two channels.
2008  */
2009 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
2010
2011 /*!
2012  * \brief Setup a masquerade to transfer a call.
2013  * \since 1.8
2014  *
2015  * \param target_chan Target of the call transfer.  (Masquerade original channel)
2016  * \param target_id New connected line information for the target channel.
2017  * \param target_held TRUE if the target call is on hold.
2018  * \param transferee_chan Transferee of the call transfer. (Masquerade clone channel)
2019  * \param transferee_id New connected line information for the transferee channel.
2020  * \param transferee_held TRUE if the transferee call is on hold.
2021  *
2022  * \details
2023  * Party A - Transferee
2024  * Party B - Transferer
2025  * Party C - Target of transfer
2026  *
2027  * Party B transfers A to C.
2028  *
2029  * Party A is connected to bridged channel B1.
2030  * Party B is connected to channels C1 and C2.
2031  * Party C is connected to bridged channel B2.
2032  *
2033  * Party B -- C1 == B1 -- Party A
2034  *               __/
2035  *              /
2036  * Party B -- C2 == B2 -- Party C
2037  *
2038  * Bridged channel B1 is masqueraded into channel C2.  Where B1
2039  * is the masquerade clone channel and C2 is the masquerade
2040  * original channel.
2041  *
2042  * \see ast_channel_masquerade()
2043  *
2044  * \note Has the same locking requirements as ast_channel_masquerade().
2045  *
2046  * \retval 0 on success.
2047  * \retval -1 on error.
2048  */
2049 int ast_channel_transfer_masquerade(
2050         struct ast_channel *target_chan,
2051         const struct ast_party_connected_line *target_id,
2052         int target_held,
2053         struct ast_channel *transferee_chan,
2054         const struct ast_party_connected_line *transferee_id,
2055         int transferee_held);
2056
2057 /*!
2058  * \brief Gives the string form of a given cause code.
2059  *
2060  * \param state cause to get the description of
2061  * \return the text form of the binary cause code given
2062  */
2063 const char *ast_cause2str(int state) attribute_pure;
2064
2065 /*!
2066  * \brief Convert the string form of a cause code to a number
2067  *
2068  * \param name string form of the cause
2069  * \return the cause code
2070  */
2071 int ast_str2cause(const char *name) attribute_pure;
2072
2073 /*!
2074  * \brief Gives the string form of a given channel state
2075  *
2076  * \param ast_channel_state state to get the name of
2077  * \return the text form of the binary state given
2078  */
2079 const char *ast_state2str(enum ast_channel_state);
2080
2081 /*!
2082  * \brief Gives the string form of a given transfer capability
2083  *
2084  * \param transfercapability transfer capability to get the name of
2085  * \return the text form of the binary transfer capability
2086  */
2087 char *ast_transfercapability2str(int transfercapability) attribute_const;
2088
2089 /*
2090  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
2091  * low level channel.  See frame.h for options.  Note that many channel drivers may support
2092  * none or a subset of those features, and you should not count on this if you want your
2093  * asterisk application to be portable.  They're mainly useful for tweaking performance
2094  */
2095
2096 /*!
2097  * \brief Sets an option on a channel
2098  *
2099  * \param channel channel to set options on
2100  * \param option option to change
2101  * \param data data specific to option
2102  * \param datalen length of the data
2103  * \param block blocking or not
2104  * \details
2105  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
2106  * \return 0 on success and -1 on failure
2107  */
2108 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
2109
2110 /*!
2111  * \brief Pick the best codec
2112  *
2113  * \param capabilities to pick best codec out of
2114  * \param result stucture to store the best codec in.
2115  * \retval on success, pointer to result structure 
2116  * \retval on failure, NULL
2117  */
2118 struct ast_format *ast_best_codec(struct ast_format_cap *cap, struct ast_format *result);
2119
2120
2121 /*!
2122  * \brief Checks the value of an option
2123  *
2124  * Query the value of an option
2125  * Works similarly to setoption except only reads the options.
2126  */
2127 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
2128
2129 /*!
2130  * \brief Checks for HTML support on a channel
2131  * \return 0 if channel does not support HTML or non-zero if it does
2132  */
2133 int ast_channel_supports_html(struct ast_channel *channel);
2134
2135 /*!
2136  * \brief Sends HTML on given channel
2137  * Send HTML or URL on link.
2138  * \return 0 on success or -1 on failure
2139  */
2140 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
2141
2142 /*!
2143  * \brief Sends a URL on a given link
2144  * Send URL on link.
2145  * \return 0 on success or -1 on failure
2146  */
2147 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
2148
2149 /*!
2150  * \brief Defers DTMF so that you only read things like hangups and audio.
2151  * \return non-zero if channel was already DTMF-deferred or
2152  * 0 if channel is just now being DTMF-deferred
2153  */
2154 int ast_channel_defer_dtmf(struct ast_channel *chan);
2155
2156 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
2157 void ast_channel_undefer_dtmf(struct ast_channel *chan);
2158
2159 /*! Initiate system shutdown -- prevents new channels from being allocated.
2160  * \param hangup  If "hangup" is non-zero, all existing channels will receive soft
2161  *  hangups */
2162 void ast_begin_shutdown(int hangup);
2163
2164 /*! Cancels an existing shutdown and returns to normal operation */
2165 void ast_cancel_shutdown(void);
2166
2167 /*! \return number of active/allocated channels */
2168 int ast_active_channels(void);
2169
2170 /*! \return non-zero if Asterisk is being shut down */
2171 int ast_shutting_down(void);
2172
2173 /*! Activate a given generator */
2174 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
2175
2176 /*! Deactivate an active generator */
2177 void ast_deactivate_generator(struct ast_channel *chan);
2178
2179 /*!
2180  * \brief Set caller ID number, name and ANI and generate AMI event.
2181  *
2182  * \note Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.
2183  * \note The channel does not need to be locked before calling this function.
2184  */
2185 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
2186
2187 /*!
2188  * \brief Set the caller id information in the Asterisk channel
2189  * \since 1.8
2190  *
2191  * \param chan Asterisk channel to set caller id information
2192  * \param caller Caller id information
2193  * \param update What caller information to update.  NULL if all.
2194  *
2195  * \return Nothing
2196  *
2197  * \note The channel does not need to be locked before calling this function.
2198  */
2199 void ast_channel_set_caller(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2200
2201 /*!
2202  * \brief Set the caller id information in the Asterisk channel and generate an AMI event
2203  * if the caller id name or number changed.
2204  * \since 1.8
2205  *
2206  * \param chan Asterisk channel to set caller id information
2207  * \param caller Caller id information
2208  * \param update What caller information to update.  NULL if all.
2209  *
2210  * \return Nothing
2211  *
2212  * \note The channel does not need to be locked before calling this function.
2213  */
2214 void ast_channel_set_caller_event(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2215
2216 /*! Set the file descriptor on the channel */
2217 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
2218
2219 /*! Add a channel to an optimized waitfor */
2220 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
2221
2222 /*! Delete a channel from an optimized waitfor */
2223 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
2224
2225 /*! Start a tone going */
2226 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2227 /*! Stop a tone from playing */
2228 void ast_tonepair_stop(struct ast_channel *chan);
2229 /*! Play a tone pair for a given amount of time */
2230 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2231
2232 /*!
2233  * \brief Automatically service a channel for us...
2234  *
2235  * \retval 0 success
2236  * \retval -1 failure, or the channel is already being autoserviced
2237  */
2238 int ast_autoservice_start(struct ast_channel *chan);
2239
2240 /*!
2241  * \brief Stop servicing a channel for us...
2242  *
2243  * \note if chan is locked prior to calling ast_autoservice_stop, it
2244  * is likely that there will be a deadlock between the thread that calls
2245  * ast_autoservice_stop and the autoservice thread. It is important
2246  * that chan is not locked prior to this call
2247  *
2248  * \param chan
2249  * \retval 0 success
2250  * \retval -1 error, or the channel has been hungup
2251  */
2252 int ast_autoservice_stop(struct ast_channel *chan);
2253
2254 /*!
2255  * \brief Ignore certain frame types
2256  * \note Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames
2257  * while a channel is in autoservice and queue them up when taken out of
2258  * autoservice.  When this is not desireable, this API may be used to
2259  * cause the channel to ignore those frametypes after the channel is put
2260  * into autoservice, but before autoservice is stopped.
2261  * \retval 0 success
2262  * \retval -1 channel is not in autoservice
2263  */
2264 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype);
2265
2266 /*!
2267  * \brief Enable or disable timer ticks for a channel
2268  *
2269  * \param c channel
2270  * \param rate number of timer ticks per second
2271  * \param func callback function
2272  * \param data
2273  *
2274  * \details
2275  * If timers are supported, force a scheduled expiration on the
2276  * timer fd, at which point we call the callback function / data
2277  *
2278  * \note Call this function with a rate of 0 to turn off the timer ticks
2279  *
2280  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
2281  */
2282 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
2283
2284 /*!
2285  * \brief Transfer a channel (if supported).
2286  * \retval -1 on error
2287  * \retval 0 if not supported
2288  * \retval 1 if supported and requested
2289  * \param chan current channel
2290  * \param dest destination extension for transfer
2291  */
2292 int ast_transfer(struct ast_channel *chan, char *dest);
2293
2294 /*!
2295  * \brief Start masquerading a channel
2296  * \note absolutely _NO_ channel locks should be held before calling this function.
2297  * \details
2298  * XXX This is a seriously whacked out operation.  We're essentially putting the guts of
2299  *     the clone channel into the original channel.  Start by killing off the original
2300  *     channel's backend.   I'm not sure we're going to keep this function, because
2301  *     while the features are nice, the cost is very high in terms of pure nastiness. XXX
2302  * \param chan Channel to masquerade
2303  */
2304 int ast_do_masquerade(struct ast_channel *chan);
2305
2306 /*!
2307  * \brief Find bridged channel
2308  *
2309  * \note This function does _not_ return a reference to the bridged channel.
2310  * The reason for this is mostly historical.  It _should_ return a reference,
2311  * but it will take a lot of work to make the code base account for that.
2312  * So, for now, the old rules still apply for how to handle this function.
2313  * If this function is being used from the channel thread that owns the channel,
2314  * then a reference is already held, and channel locking is not required to
2315  * guarantee that the channel will stay around.  If this function is used
2316  * outside of the associated channel thread, the channel parameter 'chan'
2317  * MUST be locked before calling this function.  Also, 'chan' must remain locked
2318  * for the entire time that the result of this function is being used.
2319  *
2320  * \param chan Current channel
2321  *
2322  * \return A pointer to the bridged channel
2323 */
2324 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
2325
2326 /*!
2327  * \brief Inherits channel variable from parent to child channel
2328  * \param parent Parent channel
2329  * \param child Child channel
2330  *
2331  * \details
2332  * Scans all channel variables in the parent channel, looking for those
2333  * that should be copied into the child channel.
2334  * Variables whose names begin with a single '_' are copied into the
2335  * child channel with the prefix removed.
2336  * Variables whose names begin with '__' are copied into the child
2337  * channel with their names unchanged.
2338  */
2339 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
2340
2341 /*!
2342  * \brief adds a list of channel variables to a channel
2343  * \param chan the channel
2344  * \param vars a linked list of variables
2345  *
2346  * \details
2347  * Variable names can be for a regular channel variable or a dialplan function
2348  * that has the ability to be written to.
2349  */
2350 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
2351
2352 /*!
2353  * \brief An opaque 'object' structure use by silence generators on channels.
2354  */
2355 struct ast_silence_generator;
2356
2357 /*!
2358  * \brief Starts a silence generator on the given channel.
2359  * \param chan The channel to generate silence on
2360  * \return An ast_silence_generator pointer, or NULL if an error occurs
2361  *
2362  * \details
2363  * This function will cause SLINEAR silence to be generated on the supplied
2364  * channel until it is disabled; if the channel cannot be put into SLINEAR
2365  * mode then the function will fail.
2366  *
2367  * \note
2368  * The pointer returned by this function must be preserved and passed to
2369  * ast_channel_stop_silence_generator when you wish to stop the silence
2370  * generation.
2371  */
2372 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
2373
2374 /*!
2375  * \brief Stops a previously-started silence generator on the given channel.
2376  * \param chan The channel to operate on
2377  * \param state The ast_silence_generator pointer return by a previous call to
2378  * ast_channel_start_silence_generator.
2379  * \return nothing
2380  *
2381  * \details
2382  * This function will stop the operating silence generator and return the channel
2383  * to its previous write format.
2384  */
2385 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
2386
2387 /*!
2388  * \brief Check if the channel can run in internal timing mode.
2389  * \param chan The channel to check
2390  * \return boolean
2391  *
2392  * \details
2393  * This function will return 1 if internal timing is enabled and the timing
2394  * device is available.
2395  */
2396 int ast_internal_timing_enabled(struct ast_channel *chan);
2397
2398 /* Misc. functions below */
2399
2400 /*!
2401  * \brief if fd is a valid descriptor, set *pfd with the descriptor
2402  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
2403  * return value to the index into the array)
2404  */
2405 static inline int ast_add_fd(struct pollfd *pfd, int fd)
2406 {
2407         pfd->fd = fd;
2408         pfd->events = POLLIN | POLLPRI;
2409         return fd >= 0;
2410 }
2411
2412 /*! \brief Helper function for migrating select to poll */
2413 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
2414 {
2415         int x;
2416         int dummy = 0;
2417
2418         if (fd < 0)
2419                 return 0;
2420         if (!start)
2421                 start = &dummy;
2422         for (x = *start; x < maximum; x++)
2423                 if (pfds[x].fd == fd) {
2424                         if (x == *start)
2425                                 (*start)++;
2426                         return pfds[x].revents;
2427                 }
2428         return 0;
2429 }
2430
2431 /*! \brief Retrieves the current T38 state of a channel */
2432 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
2433 {
2434         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2435         int datalen = sizeof(state);
2436
2437         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2438
2439         return state;
2440 }
2441
2442 #define CHECK_BLOCKING(c) do {   \
2443         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
2444                 ast_debug(1, "Thread %ld Blocking '%s', already blocked by thread %ld in procedure %s\n", (long) pthread_self(), ast_channel_name(c), (long) (c)->blocker, (c)->blockproc); \
2445         } else { \
2446                 (c)->blocker = pthread_self(); \
2447                 (c)->blockproc = __PRETTY_FUNCTION__; \
2448                 ast_set_flag(c, AST_FLAG_BLOCKING); \
2449         } } while (0)
2450
2451 ast_group_t ast_get_group(const char *s);
2452
2453 /*! \brief print call- and pickup groups into buffer */
2454 char *ast_print_group(char *buf, int buflen, ast_group_t group);
2455
2456 /*!
2457  * \brief Convert enum channelreloadreason to text string for manager event
2458  * \param reason The reason for reload (manager, cli, start etc)
2459  */
2460 const char *channelreloadreason2txt(enum channelreloadreason reason);
2461
2462 /*! \brief return an ast_variable list of channeltypes */
2463 struct ast_variable *ast_channeltype_list(void);
2464
2465 /*!
2466  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2467  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
2468  * \return char pointer explaining the code
2469  */
2470 const char *ast_channel_reason2str(int reason);
2471
2472 /*! \brief channel group info */
2473 struct ast_group_info {
2474         struct ast_channel *chan;
2475         char *category;
2476         char *group;
2477         AST_LIST_ENTRY(ast_group_info) group_list;
2478 };
2479
2480 #define ast_channel_lock(chan) ao2_lock(chan)
2481 #define ast_channel_unlock(chan) ao2_unlock(chan)
2482 #define ast_channel_trylock(chan) ao2_trylock(chan)
2483
2484 /*!
2485  * \brief Lock two channels.
2486  */
2487 #define ast_channel_lock_both(chan1, chan2) do { \
2488                 ast_channel_lock(chan1); \
2489                 while (ast_channel_trylock(chan2)) { \
2490                         ast_channel_unlock(chan1); \
2491                         sched_yield(); \
2492                         ast_channel_lock(chan1); \
2493                 } \
2494         } while (0)
2495
2496 /*!
2497  * \brief Increase channel reference count
2498  *
2499  * \param c the channel
2500  *
2501  * \retval c always
2502  *
2503  * \since 1.8
2504  */
2505 #define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
2506
2507 /*!
2508  * \brief Decrease channel reference count
2509  *
2510  * \param c the channel
2511  *
2512  * \retval NULL always
2513  *
2514  * \since 1.8
2515  */
2516 #define ast_channel_unref(c) ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
2517
2518 /*! Channel Iterating @{ */
2519
2520 /*!
2521  * \brief A channel iterator
2522  *
2523  * This is an opaque type.
2524  */
2525 struct ast_channel_iterator;
2526
2527 /*!
2528  * \brief Destroy a channel iterator
2529  *
2530  * \arg i the itereator to destroy
2531  *
2532  * This function is used to destroy a channel iterator that was retrieved by
2533  * using one of the channel_iterator_new() functions.
2534  *
2535  * \return NULL, for convenience to clear out the pointer to the iterator that
2536  * was just destroyed.
2537  *
2538  * \since 1.8
2539  */
2540 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
2541
2542 /*!
2543  * \brief Create a new channel iterator based on extension
2544  *
2545  * \arg exten The extension that channels must be in
2546  * \arg context The context that channels must be in (optional)
2547  *
2548  * After creating an iterator using this function, the ast_channel_iterator_next()
2549  * function can be used to iterate through all channels that are currently
2550  * in the specified context and extension.
2551  *
2552  * \retval NULL on failure
2553  * \retval a new channel iterator based on the specified parameters
2554  *
2555  * \since 1.8
2556  */
2557 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context);
2558
2559 /*!
2560  * \brief Create a new channel iterator based on name
2561  *
2562  * \arg name channel name or channel uniqueid to match
2563  * \arg name_len number of characters in the channel name to match on.  This
2564  *      would be used to match based on name prefix.  If matching on the full
2565  *      channel name is desired, then this parameter should be 0.
2566  *
2567  * After creating an iterator using this function, the ast_channel_iterator_next()
2568  * function can be used to iterate through all channels that exist that have
2569  * the specified name or name prefix.
2570  *
2571  * \retval NULL on failure
2572  * \retval a new channel iterator based on the specified parameters
2573  *
2574  * \since 1.8
2575  */
2576 struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name, size_t name_len);
2577
2578 /*!
2579  * \brief Create a new channel iterator
2580  *
2581  * After creating an iterator using this function, the ast_channel_iterator_next()
2582  * function can be used to iterate through all channels that exist.
2583  *
2584  * \retval NULL on failure
2585  * \retval a new channel iterator
2586  *
2587  * \since 1.8
2588  */
2589 struct ast_channel_iterator *ast_channel_iterator_all_new(void);
2590
2591 /*!
2592  * \brief Get the next channel for a channel iterator
2593  *
2594  * \arg i the channel iterator that was created using one of the
2595  *  channel_iterator_new() functions.
2596  *
2597  * This function should be used to iterate through all channels that match a
2598  * specified set of parameters that were provided when the iterator was created.
2599  *
2600  * \retval the next channel that matches the parameters used when the iterator
2601  *         was created.
2602  * \retval NULL, if no more channels match the iterator parameters.
2603  *
2604  * \since 1.8
2605  */
2606 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
2607
2608 /*! @} End channel iterator definitions. */
2609
2610 /*!
2611  * \brief Call a function with every active channel
2612  *
2613  * This function executes a callback one time for each active channel on the
2614  * system.  The channel is provided as an argument to the function.
2615  *
2616  * \note Absolutely _NO_ channel locks should be held before calling this function.
2617  * \since 1.8
2618  */
2619 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
2620                 void *data, int ao2_flags);
2621
2622 /*! @{ Channel search functions */
2623
2624 /*!
2625  * \brief Find a channel by name
2626  *
2627  * \arg name the name or uniqueid of the channel to search for
2628  *
2629  * Find a channel that has the same name as the provided argument.
2630  *
2631  * \retval a channel with the name specified by the argument
2632  * \retval NULL if no channel was found
2633  *
2634  * \since 1.8
2635  */
2636 struct ast_channel *ast_channel_get_by_name(const char *name);
2637
2638 /*!
2639  * \brief Find a channel by a name prefix
2640  *
2641  * \arg name The channel name or uniqueid prefix to search for
2642  * \arg name_len Only search for up to this many characters from the name
2643  *
2644  * Find a channel that has the same name prefix as specified by the arguments.
2645  *
2646  * \retval a channel with the name prefix specified by the arguments
2647  * \retval NULL if no channel was found
2648  *
2649  * \since 1.8
2650  */
2651 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
2652
2653 /*!
2654  * \brief Find a channel by extension and context
2655  *
2656  * \arg exten the extension to search for
2657  * \arg context the context to search for (optional)
2658  *
2659  * Return a channel that is currently at the specified extension and context.
2660  *
2661  * \retval a channel that is at the specified extension and context
2662  * \retval NULL if no channel was found
2663  *
2664  * \since 1.8
2665  */
2666 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
2667
2668 /*! @} End channel search functions. */
2669
2670 /*!
2671   \brief propagate the linked id between chan and peer
2672  */
2673 void ast_channel_set_linkgroup(struct ast_channel *chan, struct ast_channel *peer);
2674
2675
2676 /*!
2677  * \brief Initialize the given name structure.
2678  * \since 1.8
2679  *
2680  * \param init Name structure to initialize.
2681  *
2682  * \return Nothing
2683  */
2684 void ast_party_name_init(struct ast_party_name *init);
2685
2686 /*!
2687  * \brief Copy the source party name information to the destination party name.
2688  * \since 1.8
2689  *
2690  * \param dest Destination party name
2691  * \param src Source party name
2692  *
2693  * \return Nothing
2694  */
2695 void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src);
2696
2697 /*!
2698  * \brief Initialize the given party name structure using the given guide
2699  * for a set update operation.
2700  * \since 1.8
2701  *
2702  * \details
2703  * The initialization is needed to allow a set operation to know if a
2704  * value needs to be updated.  Simple integers need the guide's original
2705  * value in case the set operation is not trying to set a new value.
2706  * String values are simply set to NULL pointers if they are not going
2707  * to be updated.
2708  *
2709  * \param init Party name structure to initialize.
2710  * \param guide Source party name to use as a guide in initializing.
2711  *
2712  * \return Nothing
2713  */
2714 void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide);
2715
2716 /*!
2717  * \brief Set the source party name information into the destination party name.
2718  * \since 1.8
2719  *
2720  * \param dest The name one wishes to update
2721  * \param src The new name values to update the dest
2722  *
2723  * \return Nothing
2724  */
2725 void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src);
2726
2727 /*!
2728  * \brief Destroy the party name contents
2729  * \since 1.8
2730  *
2731  * \param doomed The party name to destroy.
2732  *
2733  * \return Nothing
2734  */
2735 void ast_party_name_free(struct ast_party_name *doomed);
2736
2737 /*!
2738  * \brief Initialize the given number structure.
2739  * \since 1.8
2740  *
2741  * \param init Number structure to initialize.
2742  *
2743  * \return Nothing
2744  */
2745 void ast_party_number_init(struct ast_party_number *init);
2746
2747 /*!
2748  * \brief Copy the source party number information to the destination party number.
2749  * \since 1.8
2750  *
2751  * \param dest Destination party number
2752  * \param src Source party number
2753  *
2754  * \return Nothing
2755  */
2756 void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src);
2757
2758 /*!
2759  * \brief Initialize the given party number structure using the given guide
2760  * for a set update operation.
2761  * \since 1.8
2762  *
2763  * \details
2764  * The initialization is needed to allow a set operation to know if a
2765  * value needs to be updated.  Simple integers need the guide's original
2766  * value in case the set operation is not trying to set a new value.
2767  * String values are simply set to NULL pointers if they are not going
2768  * to be updated.
2769  *
2770  * \param init Party number structure to initialize.
2771  * \param guide Source party number to use as a guide in initializing.
2772  *
2773  * \return Nothing
2774  */
2775 void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide);
2776
2777 /*!
2778  * \brief Set the source party number information into the destination party number.
2779  * \since 1.8
2780  *
2781  * \param dest The number one wishes to update
2782  * \param src The new number values to update the dest
2783  *
2784  * \return Nothing
2785  */
2786 void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src);
2787
2788 /*!
2789  * \brief Destroy the party number contents
2790  * \since 1.8
2791  *
2792  * \param doomed The party number to destroy.
2793  *
2794  * \return Nothing
2795  */
2796 void ast_party_number_free(struct ast_party_number *doomed);
2797
2798 /*!
2799  * \since 1.8
2800  * \brief Initialize the given subaddress structure.
2801  *
2802  * \param init Subaddress structure to initialize.
2803  *
2804  * \return Nothing
2805  */
2806 void ast_party_subaddress_init(struct ast_party_subaddress *init);
2807
2808 /*!
2809  * \since 1.8
2810  * \brief Copy the source party subaddress information to the destination party subaddress.
2811  *
2812  * \param dest Destination party subaddress
2813  * \param src Source party subaddress
2814  *
2815  * \return Nothing
2816  */
2817 void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2818
2819 /*!
2820  * \since 1.8
2821  * \brief Initialize the given party subaddress structure using the given guide
2822  * for a set update operation.
2823  *
2824  * \details
2825  * The initialization is needed to allow a set operation to know if a
2826  * value needs to be updated.  Simple integers need the guide's original
2827  * value in case the set operation is not trying to set a new value.
2828  * String values are simply set to NULL pointers if they are not going
2829  * to be updated.
2830  *
2831  * \param init Party subaddress structure to initialize.
2832  * \param guide Source party subaddress to use as a guide in initializing.
2833  *
2834  * \return Nothing
2835  */
2836 void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide);
2837
2838 /*!
2839  * \since 1.8
2840  * \brief Set the source party subaddress information into the destination party subaddress.
2841  *
2842  * \param dest The subaddress one wishes to update
2843  * \param src The new subaddress values to update the dest
2844  *
2845  * \return Nothing
2846  */
2847 void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2848
2849 /*!
2850  * \since 1.8
2851  * \brief Destroy the party subaddress contents
2852  *
2853  * \param doomed The party subaddress to destroy.
2854  *
2855  * \return Nothing
2856  */
2857 void ast_party_subaddress_free(struct ast_party_subaddress *doomed);
2858
2859 /*!
2860  * \brief Initialize the given party id structure.
2861  * \since 1.8
2862  *
2863  * \param init Party id structure to initialize.
2864  *
2865  * \return Nothing
2866  */
2867 void ast_party_id_init(struct ast_party_id *init);
2868
2869 /*!
2870  * \brief Copy the source party id information to the destination party id.
2871  * \since 1.8
2872  *
2873  * \param dest Destination party id
2874  * \param src Source party id
2875  *
2876  * \return Nothing
2877  */
2878 void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src);
2879
2880 /*!
2881  * \brief Initialize the given party id structure using the given guide
2882  * for a set update operation.
2883  * \since 1.8
2884  *
2885  * \details
2886  * The initialization is needed to allow a set operation to know if a
2887  * value needs to be updated.  Simple integers need the guide's original
2888  * value in case the set operation is not trying to set a new value.
2889  * String values are simply set to NULL pointers if they are not going
2890  * to be updated.
2891  *
2892  * \param init Party id structure to initialize.
2893  * \param guide Source party id to use as a guide in initializing.
2894  *
2895  * \return Nothing
2896  */
2897 void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide);
2898
2899 /*!
2900  * \brief Set the source party id information into the destination party id.
2901  * \since 1.8
2902  *
2903  * \param dest The id one wishes to update
2904  * \param src The new id values to update the dest
2905  * \param update What id information to update.  NULL if all.
2906  *
2907  * \return Nothing
2908  */
2909 void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update);
2910
2911 /*!
2912  * \brief Destroy the party id contents
2913  * \since 1.8
2914  *
2915  * \param doomed The party id to destroy.
2916  *
2917  * \return Nothing
2918  */
2919 void ast_party_id_free(struct ast_party_id *doomed);
2920
2921 /*!
2922  * \brief Determine the overall presentation value for the given party.
2923  * \since 1.8
2924  *
2925  * \param id Party to determine the overall presentation value.
2926  *
2927  * \return Overall presentation value for the given party.
2928  */
2929 int ast_party_id_presentation(const struct ast_party_id *id);
2930
2931 /*!
2932  * \brief Initialize the given dialed structure.
2933  * \since 1.8
2934  *
2935  * \param init Dialed structure to initialize.
2936  *
2937  * \return Nothing
2938  */
2939 void ast_party_dialed_init(struct ast_party_dialed *init);
2940
2941 /*!
2942  * \brief Copy the source dialed party information to the destination dialed party.
2943  * \since 1.8
2944  *
2945  * \param dest Destination dialed party
2946  * \param src Source dialed party
2947  *
2948  * \return Nothing
2949  */
2950 void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
2951
2952 /*!
2953  * \brief Initialize the given dialed structure using the given
2954  * guide for a set update operation.
2955  * \since 1.8
2956  *
2957  * \details
2958  * The initialization is needed to allow a set operation to know if a
2959  * value needs to be updated.  Simple integers need the guide's original
2960  * value in case the set operation is not trying to set a new value.
2961  * String values are simply set to NULL pointers if they are not going
2962  * to be updated.
2963  *
2964  * \param init Caller structure to initialize.
2965  * \param guide Source dialed to use as a guide in initializing.
2966  *
2967  * \return Nothing
2968  */
2969 void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide);
2970
2971 /*!
2972  * \brief Set the dialed information based on another dialed source
2973  * \since 1.8
2974  *
2975  * This is similar to ast_party_dialed_copy, except that NULL values for
2976  * strings in the src parameter indicate not to update the corresponding dest values.
2977  *
2978  * \param dest The dialed one wishes to update
2979  * \param src The new dialed values to update the dest
2980  *
2981  * \return Nada
2982  */
2983 void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
2984
2985 /*!
2986  * \brief Destroy the dialed party contents
2987  * \since 1.8
2988  *
2989  * \param doomed The dialed party to destroy.
2990  *
2991  * \return Nothing
2992  */
2993 void ast_party_dialed_free(struct ast_party_dialed *doomed);
2994
2995 /*!
2996  * \since 1.8
2997  * \brief Initialize the given caller structure.
2998  *
2999  * \param init Caller structure to initialize.
3000  *
3001  * \return Nothing
3002  */
3003 void ast_party_caller_init(struct ast_party_caller *init);
3004
3005 /*!
3006  * \since 1.8
3007  * \brief Copy the source caller information to the destination caller.
3008  *
3009  * \param dest Destination caller
3010  * \param src Source caller
3011  *
3012  * \return Nothing
3013  */
3014 void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src);
3015
3016 /*!
3017  * \brief Initialize the given caller structure using the given
3018  * guide for a set update operation.
3019  * \since 1.8
3020  *
3021  * \details
3022  * The initialization is needed to allow a set operation to know if a
3023  * value needs to be updated.  Simple integers need the guide's original
3024  * value in case the set operation is not trying to set a new value.
3025  * String values are simply set to NULL pointers if they are not going
3026  * to be updated.
3027  *
3028  * \param init Caller structure to initialize.
3029  * \param guide Source caller to use as a guide in initializing.
3030  *
3031  * \return Nothing
3032  */
3033 void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide);
3034
3035 /*!
3036  * \brief Set the caller information based on another caller source
3037  * \since 1.8
3038  *
3039  * This is similar to ast_party_caller_copy, except that NULL values for
3040  * strings in the src parameter indicate not to update the corresponding dest values.
3041  *
3042  * \param dest The caller one wishes to update
3043  * \param src The new caller values to update the dest
3044  * \param update What caller information to update.  NULL if all.
3045  *
3046  * \return Nada
3047  */
3048 void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update);
3049
3050 /*!
3051  * \brief Destroy the caller party contents
3052  * \since 1.8
3053  *
3054  * \param doomed The caller party to destroy.
3055  *
3056  * \return Nothing
3057  */
3058 void ast_party_caller_free(struct ast_party_caller *doomed);
3059
3060 /*!
3061  * \since 1.8
3062  * \brief Initialize the given connected line structure.
3063  *
3064  * \param init Connected line structure to initialize.
3065  *
3066  * \return Nothing
3067  */
3068 void ast_party_connected_line_init(struct ast_party_connected_line *init);
3069
3070 /*!
3071  * \since 1.8
3072  * \brief Copy the source connected line information to the destination connected line.
3073  *
3074  * \param dest Destination connected line
3075  * \param src Source connected line
3076  *
3077  * \return Nothing
3078  */
3079 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
3080
3081 /*!
3082  * \since 1.8
3083  * \brief Initialize the given connected line structure using the given
3084  * guide for a set update operation.
3085  *
3086  * \details
3087  * The initialization is needed to allow a set operation to know if a
3088  * value needs to be updated.  Simple integers need the guide's original
3089  * value in case the set operation is not trying to set a new value.
3090  * String values are simply set to NULL pointers if they are not going
3091  * to be updated.
3092  *
3093  * \param init Connected line structure to initialize.
3094  * \param guide Source connected line to use as a guide in initializing.
3095  *
3096  * \return Nothing
3097  */
3098 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
3099
3100 /*!
3101  * \since 1.8
3102  * \brief Set the connected line information based on another connected line source
3103  *
3104  * This is similar to ast_party_connected_line_copy, except that NULL values for
3105  * strings in the src parameter indicate not to update the corresponding dest values.
3106  *
3107  * \param dest The connected line one wishes to update
3108  * \param src The new connected line values to update the dest
3109  * \param update What connected line information to update.  NULL if all.
3110  *
3111  * \return Nothing
3112  */
3113 void ast_party_connected_line_set(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src, const struct ast_set_party_connected_line *update);
3114
3115 /*!
3116  * \since 1.8
3117  * \brief Collect the caller party information into a connected line structure.
3118  *
3119  * \param connected Collected caller information for the connected line
3120  * \param caller Caller information.
3121  *
3122  * \return Nothing
3123  *
3124  * \warning This is a shallow copy.
3125  * \warning DO NOT call ast_party_connected_line_free() on the filled in
3126  * connected line structure!
3127  */
3128 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller);
3129
3130 /*!
3131  * \since 1.8
3132  * \brief Destroy the connected line information contents
3133  *
3134  * \param doomed The connected line information to destroy.
3135  *
3136  * \return Nothing
3137  */
3138 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
3139
3140 /*!
3141  * \brief Initialize the given redirecting structure.
3142  * \since 1.8
3143  *
3144  * \param init Redirecting structure to initialize.
3145  *
3146  * \return Nothing
3147  */
3148 void ast_party_redirecting_init(struct ast_party_redirecting *init);
3149
3150 /*!
3151  * \since 1.8
3152  * \brief Copy the source redirecting information to the destination redirecting.
3153  *
3154  * \param dest Destination redirecting
3155  * \param src Source redirecting
3156  *
3157  * \return Nothing
3158  */
3159 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
3160
3161 /*!
3162  * \since 1.8
3163  * \brief Initialize the given redirecting id structure using the given guide
3164  * for a set update operation.
3165  *
3166  * \details
3167  * The initialization is needed to allow a set operation to know if a
3168  * value needs to be updated.  Simple integers need the guide's original
3169  * value in case the set operation is not trying to set a new value.
3170  * String values are simply set to NULL pointers if they are not going
3171  * to be updated.
3172  *
3173  * \param init Redirecting id structure to initialize.
3174  * \param guide Source redirecting id to use as a guide in initializing.
3175  *
3176  * \return Nothing
3177  */
3178 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
3179
3180 /*!
3181  * \brief Set the redirecting information based on another redirecting source
3182  * \since 1.8
3183  *
3184  * This is similar to ast_party_redirecting_copy, except that NULL values for
3185  * strings in the src parameter indicate not to update the corresponding dest values.
3186  *
3187  * \param dest The redirecting one wishes to update
3188  * \param src The new redirecting values to update the dest
3189  * \param update What redirecting information to update.  NULL if all.
3190  *
3191  * \return Nothing
3192  */
3193 void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update);
3194
3195 /*!
3196  * \since 1.8
3197  * \brief Destroy the redirecting information contents
3198  *
3199  * \param doomed The redirecting information to destroy.
3200  *
3201  * \return Nothing
3202  */
3203 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
3204
3205 /*!
3206  * \since 1.8
3207  * \brief Copy the caller information to the connected line information.
3208  *
3209  * \param dest Destination connected line information
3210  * \param src Source caller information
3211  *
3212  * \return Nothing
3213  *
3214  * \note Assumes locks are already acquired
3215  */
3216 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src);
3217
3218 /*!
3219  * \since 1.8
3220  * \brief Copy the connected line information to the caller information.
3221  *
3222  * \param dest Destination caller information
3223  * \param src Source connected line information
3224  *
3225  * \return Nothing
3226  *
3227  * \note Assumes locks are already acquired
3228  */
3229 void ast_connected_line_copy_to_caller(struct ast_party_caller *dest, const struct ast_party_connected_line *src);
3230
3231 /*!
3232  * \since 1.8
3233  * \brief Set the connected line information in the Asterisk channel
3234  *
3235  * \param chan Asterisk channel to set connected line information
3236  * \param connected Connected line information
3237  * \param update What connected line information to update.  NULL if all.
3238  *
3239  * \return Nothing
3240  *
3241  * \note The channel does not need to be locked before calling this function.
3242  */
3243 void ast_channel_set_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3244
3245 /*!
3246  * \since 1.8
3247  * \brief Build the connected line information data frame.
3248  *
3249  * \param data Buffer to fill with the frame data
3250  * \param datalen Size of the buffer to fill
3251  * \param connected Connected line information
3252  * \param update What connected line information to build.  NULL if all.
3253  *
3254  * \retval -1 if error
3255  * \retval Amount of data buffer used
3256  */
3257 int ast_connected_line_build_data(unsigned char *data, size_t datalen, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3258
3259 /*!
3260  * \since 1.8
3261  * \brief Parse connected line indication frame data
3262  *
3263  * \param data Buffer with the frame data to parse
3264  * \param datalen Size of the buffer
3265  * \param connected Extracted connected line information
3266  *
3267  * \retval 0 on success.
3268  * \retval -1 on error.
3269  *
3270  * \note The filled in connected line structure needs to be initialized by
3271  * ast_party_connected_line_set_init() before calling.  If defaults are not
3272  * required use ast_party_connected_line_init().
3273  * \note The filled in connected line structure needs to be destroyed by
3274  * ast_party_connected_line_free() when it is no longer needed.
3275  */
3276 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
3277
3278 /*!
3279  * \since 1.8
3280  * \brief Indicate that the connected line information has changed
3281  *
3282  * \param chan Asterisk channel to indicate connected line information
3283  * \param connected Connected line information
3284  * \param update What connected line information to update.  NULL if all.
3285  *
3286  * \return Nothing
3287  */
3288 void ast_channel_update_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3289
3290 /*!
3291  * \since 1.8
3292  * \brief Queue a connected line update frame on a channel
3293  *
3294  * \param chan Asterisk channel to indicate connected line information
3295  * \param connected Connected line information
3296  * \param update What connected line information to update.  NULL if all.
3297  *
3298  * \return Nothing
3299  */
3300 void ast_channel_queue_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3301
3302 /*!
3303  * \since 1.8
3304  * \brief Set the redirecting id information in the Asterisk channel
3305  *
3306  * \param chan Asterisk channel to set redirecting id information
3307  * \param redirecting Redirecting id information
3308  * \param update What redirecting information to update.  NULL if all.
3309  *
3310  * \return Nothing
3311  *
3312  * \note The channel does not need to be locked before calling this function.
3313  */
3314 void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3315
3316 /*!
3317  * \since 1.8
3318  * \brief Build the redirecting id data frame.
3319  *
3320  * \param data Buffer to fill with the frame data
3321  * \param datalen Size of the buffer to fill
3322  * \param redirecting Redirecting id information
3323  * \param update What redirecting information to build.  NULL if all.
3324  *
3325  * \retval -1 if error
3326  * \retval Amount of data buffer used
3327  */
3328 int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3329
3330 /*!
3331  * \since 1.8
3332  * \brief Parse redirecting indication frame data
3333  *
3334  * \param data Buffer with the frame data to parse
3335  * \param datalen Size of the buffer
3336  * \param redirecting Extracted redirecting id information
3337  *
3338  * \retval 0 on success.
3339  * \retval -1 on error.
3340  *
3341  * \note The filled in id structure needs to be initialized by
3342  * ast_party_redirecting_set_init() before calling.
3343  * \note The filled in id structure needs to be destroyed by
3344  * ast_party_redirecting_free() when it is no longer needed.
3345  */
3346 int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
3347
3348 /*!
3349  * \since 1.8
3350  * \brief Indicate that the redirecting id has changed
3351  *
3352  * \param chan Asterisk channel to indicate redirecting id information
3353  * \param redirecting Redirecting id information
3354  * \param update What redirecting information to update.  NULL if all.
3355  *
3356  * \return Nothing
3357  */
3358 void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3359
3360 /*!
3361  * \since 1.8
3362  * \brief Queue a redirecting update frame on a channel
3363  *
3364  * \param chan Asterisk channel to indicate redirecting id information
3365  * \param redirecting Redirecting id information
3366  * \param update What redirecting information to update.  NULL if all.
3367  *
3368  * \return Nothing
3369  */
3370 void ast_channel_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3371
3372 /*!
3373  * \since 1.8
3374  * \brief Run a connected line interception macro and update a channel's connected line
3375  * information
3376  *
3377  * Whenever we want to update a channel's connected line information, we may need to run
3378  * a macro so that an administrator can manipulate the information before sending it
3379  * out. This function both runs the macro and sends the update to the channel.
3380  *
3381  * \param autoservice_chan Channel to place into autoservice while the macro is running.
3382  *      It is perfectly safe for this to be NULL
3383  * \param macro_chan The channel to run the macro on. Also the channel from which we
3384  *      determine which macro we need to run.
3385  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3386  *      AST_CONTROL_CONNECTED_LINE
3387  * \param caller If true, then run CONNECTED_LINE_CALLER_SEND_MACRO, otherwise run
3388  *      CONNECTED_LINE_CALLEE_SEND_MACRO
3389  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3390  *      ast_party_connected_line pointer.
3391  * \retval 0 Success
3392  * \retval -1 Either the macro does not exist, or there was an error while attempting to
3393  *      run the macro
3394  *
3395  * \todo Have multiple return codes based on the MACRO_RESULT
3396  * \todo Make constants so that caller and frame can be more expressive than just '1' and
3397  *      '0'
3398  */
3399 int ast_channel_connected_line_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *connected_info, int caller, int frame);
3400
3401 /*!
3402  * \brief Insert into an astdata tree, the channel structure.
3403  * \param[in] tree The ast data tree.
3404  * \param[in] chan The channel structure to add to tree.
3405  * \param[in] add_bridged Add the bridged channel to the structure.