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