fd339d97483cba47232d9cdc04a4cfd0cb070cf9
[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/alertpipe.h"
127 #include "asterisk/abstract_jb.h"
128 #include "asterisk/astobj2.h"
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
138 /*!
139  * Max length of a channel uniqueid reported to the outside world.
140  *
141  * \details
142  * 149 = 127 (max systemname) + "-" + 10 (epoch timestamp)
143  *     + "." + 10 (monotonically incrementing integer).
144  *
145  * \note If this value is ever changed, MAX_CHANNEL_ID should
146  * be updated in rtp_engine.h.
147  */
148 #define AST_MAX_PUBLIC_UNIQUEID 149
149
150 /*!
151  * Maximum size of an internal Asterisk channel unique ID.
152  *
153  * \details
154  * Add two for the Local;2 channel to append a ';2' if needed
155  * plus nul terminator.
156  *
157  * \note If this value is ever changed, MAX_CHANNEL_ID should
158  * be updated in rtp_engine.h.
159  */
160 #define AST_MAX_UNIQUEID        (AST_MAX_PUBLIC_UNIQUEID + 2 + 1)
161
162 #define AST_MAX_ACCOUNT_CODE    80  /*!< Max length of an account code */
163 #define AST_CHANNEL_NAME        80  /*!< Max length of an ast_channel name */
164 #define MAX_LANGUAGE            40  /*!< Max length of the language setting */
165 #define MAX_MUSICCLASS          80  /*!< Max length of the music class setting */
166 #define AST_MAX_USER_FIELD      256 /*!< Max length of the channel user field */
167
168 #include "asterisk/frame.h"
169 #include "asterisk/chanvars.h"
170 #include "asterisk/config.h"
171 #include "asterisk/lock.h"
172 #include "asterisk/cdr.h"
173 #include "asterisk/utils.h"
174 #include "asterisk/linkedlists.h"
175 #include "asterisk/stringfields.h"
176 #include "asterisk/datastore.h"
177 #include "asterisk/data.h"
178 #include "asterisk/channelstate.h"
179 #include "asterisk/ccss.h"
180 #include "asterisk/framehook.h"
181 #include "asterisk/stasis.h"
182 #include "asterisk/endpoints.h"
183
184 #define DATASTORE_INHERIT_FOREVER       INT_MAX
185
186 #define AST_MAX_FDS             11      /*!< original maximum number of file descriptors */
187 #define AST_EXTENDED_FDS        12      /*!< the start of extended file descriptor positions */
188 /*
189  * We have AST_MAX_FDS file descriptors in a channel.
190  * Some of them have a fixed use:
191  */
192 #define AST_ALERT_FD    (AST_MAX_FDS-1)         /*!< used for alertpipe */
193 #define AST_TIMING_FD   (AST_MAX_FDS-2)         /*!< used for timingfd */
194 #define AST_AGENT_FD    (AST_MAX_FDS-3)         /*!< used by agents for pass through */
195 #define AST_GENERATOR_FD        (AST_MAX_FDS-4) /*!< used by generator */
196 #define AST_JITTERBUFFER_FD     (AST_MAX_FDS-5) /*!< used by generator */
197
198 enum ast_bridge_result {
199         AST_BRIDGE_COMPLETE = 0,
200         AST_BRIDGE_FAILED = -1,
201         AST_BRIDGE_FAILED_NOWARN = -2,
202         AST_BRIDGE_RETRY = -3,
203 };
204
205 typedef unsigned long long ast_group_t;
206
207 struct ast_stream_topology;
208
209 /*! \todo Add an explanation of an Asterisk generator
210 */
211 struct ast_generator {
212         void *(*alloc)(struct ast_channel *chan, void *params);
213         /*! Channel is locked during this function callback. */
214         void (*release)(struct ast_channel *chan, void *data);
215         /*! This function gets called with the channel unlocked, but is called in
216          *  the context of the channel thread so we know the channel is not going
217          *  to disappear.  This callback is responsible for locking the channel as
218          *  necessary. */
219         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
220         /*! This gets called when DTMF_END frames are read from the channel */
221         void (*digit)(struct ast_channel *chan, char digit);
222         /*! This gets called when the write format on a channel is changed while
223          * generating. The channel is locked during this callback. */
224         void (*write_format_change)(struct ast_channel *chan, void *data);
225 };
226
227 /*! Party name character set enumeration values (values from Q.SIG) */
228 enum AST_PARTY_CHAR_SET {
229         AST_PARTY_CHAR_SET_UNKNOWN = 0,
230         AST_PARTY_CHAR_SET_ISO8859_1 = 1,
231         AST_PARTY_CHAR_SET_WITHDRAWN = 2,/* ITU withdrew this enum value. */
232         AST_PARTY_CHAR_SET_ISO8859_2 = 3,
233         AST_PARTY_CHAR_SET_ISO8859_3 = 4,
234         AST_PARTY_CHAR_SET_ISO8859_4 = 5,
235         AST_PARTY_CHAR_SET_ISO8859_5 = 6,
236         AST_PARTY_CHAR_SET_ISO8859_7 = 7,
237         AST_PARTY_CHAR_SET_ISO10646_BMPSTRING = 8,
238         AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING = 9,
239 };
240
241 /*!
242  * \since 1.8
243  * \brief Information needed to specify a name in a call.
244  * \note All string fields here are malloc'ed, so they need to be
245  * freed when the structure is deleted.
246  * \note NULL and "" must be considered equivalent.
247  */
248 struct ast_party_name {
249         /*! \brief Subscriber name (Malloced) */
250         char *str;
251         /*!
252          * \brief Character set the name is using.
253          * \see enum AST_PARTY_CHAR_SET
254          * \note
255          * Set to AST_PARTY_CHAR_SET_ISO8859_1 if unsure what to use.
256          * \todo Start using the party name character set value.  Not currently used.
257          */
258         int char_set;
259         /*!
260          * \brief Q.931 encoded presentation-indicator encoded field
261          * \note Must tolerate the Q.931 screening-indicator field values being present.
262          */
263         int presentation;
264         /*! \brief TRUE if the name information is valid/present */
265         unsigned char valid;
266 };
267
268 /*!
269  * \since 1.8
270  * \brief Information needed to specify a number in a call.
271  * \note All string fields here are malloc'ed, so they need to be
272  * freed when the structure is deleted.
273  * \note NULL and "" must be considered equivalent.
274  */
275 struct ast_party_number {
276         /*! \brief Subscriber phone number (Malloced) */
277         char *str;
278         /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
279         int plan;
280         /*! \brief Q.931 presentation-indicator and screening-indicator encoded fields */
281         int presentation;
282         /*! \brief TRUE if the number information is valid/present */
283         unsigned char valid;
284 };
285
286 /*!
287  * \since 1.8
288  * \brief Information needed to specify a subaddress in a call.
289  * \note All string fields here are malloc'ed, so they need to be
290  * freed when the structure is deleted.
291  * \note NULL and "" must be considered equivalent.
292  */
293 struct ast_party_subaddress {
294         /*!
295          * \brief Malloced subaddress string.
296          * \note If the subaddress type is user specified then the subaddress is
297          * a string of ASCII hex because the actual subaddress is likely BCD encoded.
298          */
299         char *str;
300         /*!
301          * \brief Q.931 subaddress type.
302          * \details
303          * nsap(0),
304          * user_specified(2)
305          */
306         int type;
307         /*!
308          * \brief TRUE if odd number of address signals
309          * \note The odd/even indicator is used when the type of subaddress is
310          * user_specified and the coding is BCD.
311          */
312         unsigned char odd_even_indicator;
313         /*! \brief TRUE if the subaddress information is valid/present */
314         unsigned char valid;
315 };
316
317 /*!
318  * \since 1.8
319  * \brief Information needed to identify an endpoint in a call.
320  * \note All string fields here are malloc'ed, so they need to be
321  * freed when the structure is deleted.
322  * \note NULL and "" must be considered equivalent.
323  */
324 struct ast_party_id {
325         /*! \brief Subscriber name */
326         struct ast_party_name name;
327         /*! \brief Subscriber phone number */
328         struct ast_party_number number;
329         /*! \brief Subscriber subaddress. */
330         struct ast_party_subaddress subaddress;
331
332         /*!
333          * \brief User-set "tag"
334          * \details
335          * A user-settable field used to help associate some extrinsic information
336          * about the channel or user of the channel to the party ID.  This information
337          * is normally not transmitted over the wire and so is only useful within an
338          * Asterisk environment.
339          */
340         char *tag;
341 };
342
343 /*!
344  * \since 1.8
345  * \brief Indicate what information in ast_party_id should be set.
346  */
347 struct ast_set_party_id {
348         /*! TRUE if the ast_party_name information should be set. */
349         unsigned char name;
350         /*! TRUE if the ast_party_number information should be set. */
351         unsigned char number;
352         /*! TRUE if the ast_party_subaddress information should be set. */
353         unsigned char subaddress;
354 };
355
356 /*!
357  * \since 1.8
358  * \brief Dialed/Called Party information.
359  * \note Dialed Number Identifier (DNID)
360  * \note All string fields here are malloc'ed, so they need to be
361  * freed when the structure is deleted.
362  * \note NULL and "" must be considered equivalent.
363  */
364 struct ast_party_dialed {
365         /*!
366          * \brief Dialed/Called number
367          * \note Done this way in case we ever really need to use ast_party_number.
368          * We currently do not need all of the ast_party_number fields.
369          */
370         struct {
371                 /*! \brief Subscriber phone number (Malloced) */
372                 char *str;
373                 /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
374                 int plan;
375         } number;
376         /*! \brief Dialed/Called subaddress */
377         struct ast_party_subaddress subaddress;
378         /*!
379          * \brief Transit Network Select
380          * \note Currently this value is just passed around the system.
381          * You can read it and set it but it is never used for anything.
382          */
383         int transit_network_select;
384 };
385
386 /*!
387  * \since 1.8
388  * \brief Caller Party information.
389  * \note All string fields here are malloc'ed, so they need to be
390  * freed when the structure is deleted.
391  * \note NULL and "" must be considered equivalent.
392  *
393  * \note SIP and IAX2 has UTF8 encoded Unicode Caller ID names.
394  * In some cases, we also have an alternative (RPID) E.164 number that can
395  * be used as Caller ID on numeric E.164 phone networks (DAHDI or SIP/IAX2 to
396  * PSTN gateway).
397  *
398  * \todo Implement settings for transliteration between UTF8 Caller ID names in
399  *       to ASCII Caller ID's (DAHDI). Östen Åsklund might be transliterated into
400  *       Osten Asklund or Oesten Aasklund depending upon language and person...
401  *       We need automatic routines for incoming calls and static settings for
402  *       our own accounts.
403  */
404 struct ast_party_caller {
405         /*! \brief Caller party ID */
406         struct ast_party_id id;
407
408         /*!
409          * \brief Automatic Number Identification (ANI)
410          * \note The name subcomponent is only likely to be used by SIP.
411          * \note The subaddress subcomponent is not likely to be used.
412          */
413         struct ast_party_id ani;
414
415         /*! \brief Private caller party ID */
416         struct ast_party_id priv;
417
418         /*! \brief Automatic Number Identification 2 (Info Digits) */
419         int ani2;
420 };
421
422 /*!
423  * \since 1.8
424  * \brief Indicate what information in ast_party_caller should be set.
425  */
426 struct ast_set_party_caller {
427         /*! What caller id information to set. */
428         struct ast_set_party_id id;
429         /*! What ANI id information to set. */
430         struct ast_set_party_id ani;
431         /*! What private caller id information to set. */
432         struct ast_set_party_id priv;
433 };
434
435 /*!
436  * \since 1.8
437  * \brief Connected Line/Party information.
438  * \note All string fields here are malloc'ed, so they need to be
439  * freed when the structure is deleted.
440  * \note NULL and "" must be considered equivalent.
441  */
442 struct ast_party_connected_line {
443         /*! \brief Connected party ID */
444         struct ast_party_id id;
445
446         /*!
447          * \brief Automatic Number Identification (ANI)
448          * \note Not really part of connected line data but needed to
449          * save the corresponding caller id value.
450          */
451         struct ast_party_id ani;
452
453         /*! \brief Private connected party ID */
454         struct ast_party_id priv;
455
456         /*!
457          * \brief Automatic Number Identification 2 (Info Digits)
458          * \note Not really part of connected line data but needed to
459          * save the corresponding caller id value.
460          */
461         int ani2;
462
463         /*!
464          * \brief Information about the source of an update.
465          * \note enum AST_CONNECTED_LINE_UPDATE_SOURCE values
466          * for Normal-Answer and Call-transfer.
467          */
468         int source;
469 };
470
471 /*!
472  * \since 1.8
473  * \brief Indicate what information in ast_party_connected_line should be set.
474  */
475 struct ast_set_party_connected_line {
476         /*! What connected line id information to set. */
477         struct ast_set_party_id id;
478         /*! What ANI id information to set. */
479         struct ast_set_party_id ani;
480         /*! What private connected line id information to set. */
481         struct ast_set_party_id priv;
482 };
483
484 /*!
485  * \brief Redirecting reason information
486  */
487 struct ast_party_redirecting_reason {
488         /*! \brief a string value for the redirecting reason
489          *
490          * Useful for cases where an endpoint has specified a redirecting reason
491          * that does not correspond to an enum AST_REDIRECTING_REASON
492          */
493         char *str;
494
495         /*! \brief enum AST_REDIRECTING_REASON value for redirection */
496         int code;
497 };
498
499 /*!
500  * \since 1.8
501  * \brief Redirecting Line information.
502  * RDNIS (Redirecting Directory Number Information Service)
503  * Where a call diversion or transfer was invoked.
504  * \note All string fields here are malloc'ed, so they need to be
505  * freed when the structure is deleted.
506  * \note NULL and "" must be considered equivalent.
507  */
508 struct ast_party_redirecting {
509         /*! \brief Who originally redirected the call (Sent to the party the call is redirected toward) */
510         struct ast_party_id orig;
511
512         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) */
513         struct ast_party_id from;
514
515         /*! \brief Call is redirecting to a new party (Sent to the caller) */
516         struct ast_party_id to;
517
518         /*! \brief Who originally redirected the call (Sent to the party the call is redirected toward) - private representation */
519         struct ast_party_id priv_orig;
520
521         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) - private representation */
522         struct ast_party_id priv_from;
523
524         /*! \brief Call is redirecting to a new party (Sent to the caller)  - private representation */
525         struct ast_party_id priv_to;
526
527         /*! \brief Reason for the redirection */
528         struct ast_party_redirecting_reason reason;
529
530         /*! \brief Reason for the redirection by the original party */
531         struct ast_party_redirecting_reason orig_reason;
532
533         /*! \brief Number of times the call was redirected */
534         int count;
535 };
536
537 /*!
538  * \since 1.8
539  * \brief Indicate what information in ast_party_redirecting should be set.
540  */
541 struct ast_set_party_redirecting {
542         /*! What redirecting-orig id information to set. */
543         struct ast_set_party_id orig;
544         /*! What redirecting-from id information to set. */
545         struct ast_set_party_id from;
546         /*! What redirecting-to id information to set. */
547         struct ast_set_party_id to;
548         /*! What private redirecting-orig id information to set. */
549         struct ast_set_party_id priv_orig;
550         /*! What private redirecting-from id information to set. */
551         struct ast_set_party_id priv_from;
552         /*! What private redirecting-to id information to set. */
553         struct ast_set_party_id priv_to;
554 };
555
556 /*!
557  * \brief Typedef for a custom read function
558  * \note data should be treated as const char *.
559  */
560 typedef int (*ast_acf_read_fn_t)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
561
562 /*!
563  * \brief Typedef for a custom read2 function
564  * \note data should be treated as const char *.
565  */
566 typedef int (*ast_acf_read2_fn_t)(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **str, ssize_t len);
567
568 /*!
569  * \brief Typedef for a custom write function
570  * \note data should be treated as const char *.
571  */
572 typedef int (*ast_acf_write_fn_t)(struct ast_channel *chan, const char *function, char *data, const char *value);
573
574 /*! \brief Structure to handle passing func_channel_write info to channels via setoption */
575 typedef struct {
576         /*! \brief ast_chan_write_info_t version. Must be incremented if structure is changed */
577         #define AST_CHAN_WRITE_INFO_T_VERSION 1
578         uint32_t version;
579         ast_acf_write_fn_t write_fn;
580         struct ast_channel *chan;
581         const char *function;
582         char *data;
583         const char *value;
584 } ast_chan_write_info_t;
585
586 /*!
587  * \brief Structure to pass both assignedid values to channel drivers
588  * \note The second value is used only by core_unreal (LOCAL)
589  */
590 struct ast_assigned_ids {
591         const char *uniqueid;
592         const char *uniqueid2;
593 };
594
595 /*!
596  * \brief
597  * Structure to describe a channel "technology", ie a channel driver
598  * See for examples:
599  * \arg chan_iax2.c - The Inter-Asterisk exchange protocol
600  * \arg chan_sip.c - The SIP channel driver
601  * \arg chan_dahdi.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
602  *
603  * \details
604  * If you develop your own channel driver, this is where you
605  * tell the PBX at registration of your driver what properties
606  * this driver supports and where different callbacks are
607  * implemented.
608  */
609 struct ast_channel_tech {
610         const char * const type;
611         const char * const description;
612
613         struct ast_format_cap *capabilities;  /*!< format capabilities this channel can handle */
614
615         int properties;         /*!< Technology Properties */
616
617         /*!
618          * \brief Requester - to set up call data structures (pvt's)
619          *
620          * \param type type of channel to request
621          * \param cap Format capabilities for requested channel
622          * \param assignedid Unique ID string to assign to channel
623          * \param requestor channel asking for data
624          * \param addr destination of the call
625          * \param cause Cause of failure
626          *
627          * \details
628          * Request a channel of a given type, with addr as optional information used
629          * by the low level module
630          *
631          * \retval NULL failure
632          * \retval non-NULL channel on success
633          */
634         struct ast_channel *(* const requester)(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, int *cause);
635
636         /*!
637          * \brief Requester - to set up call data structures (pvt's) with stream topology
638          *
639          * \param type type of channel to request
640          * \param topology Stream topology for requested channel
641          * \param assignedid Unique ID string to assign to channel
642          * \param requestor channel asking for data
643          * \param addr destination of the call
644          * \param cause Cause of failure
645          *
646          * \details
647          * Request a channel of a given type, with addr as optional information used
648          * by the low level module
649          *
650          * \retval NULL failure
651          * \retval non-NULL channel on success
652          */
653         struct ast_channel *(* const requester_with_stream_topology)(const char *type, struct ast_stream_topology *topology, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, int *cause);
654
655
656         int (* const devicestate)(const char *device_number);   /*!< Devicestate call back */
657         int (* const presencestate)(const char *presence_provider, char **subtype, char **message); /*!< Presencestate callback */
658
659         /*!
660          * \brief Start sending a literal DTMF digit
661          *
662          * \note The channel is not locked when this function gets called.
663          */
664         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
665
666         /*!
667          * \brief Stop sending a literal DTMF digit
668          *
669          * \note The channel is not locked when this function gets called.
670          */
671         int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
672
673         /*!
674          * \brief Make a call
675          * \note The channel is locked when called.
676          * \param chan which channel to make the call on
677          * \param addr destination of the call
678          * \param timeout time to wait on for connect (Doesn't seem to be used.)
679          * \retval 0 on success
680          * \retval -1 on failure
681          */
682         int (* const call)(struct ast_channel *chan, const char *addr, int timeout);
683
684         /*! \brief Hangup (and possibly destroy) the channel */
685         int (* const hangup)(struct ast_channel *chan);
686
687         /*! \brief Answer the channel */
688         int (* const answer)(struct ast_channel *chan);
689
690         /*!
691          * \brief Read a frame (or chain of frames from the same stream), in standard format (see frame.h)
692          *
693          * \param chan channel to read frames from
694          *
695          * \retval non-NULL on success
696          * \retval NULL on failure
697          *
698          * \note Each media frame from this callback will have the stream_num of it changed to the default
699          *       stream num based on the type of media returned. As a result a multistream capable channel
700          *       should not implement this callback.
701          */
702         struct ast_frame * (* const read)(struct ast_channel *chan);
703
704         /*!
705          * \brief Read a frame (or chain of frames from the same stream), in standard format (see frame.h), with stream num
706          *
707          * \param chan channel to read frames from
708          *
709          * \retval non-NULL on success
710          * \retval NULL on failure
711          *
712          * \note Each media frame from this callback should contain a stream_num value which is set to the
713          *       stream that the media frame originated from.
714          */
715         struct ast_frame * (* const read_stream)(struct ast_channel *chan);
716
717         /*! \brief Write a frame, in standard format (see frame.h) */
718         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
719
720         /*! \brief Write a frame on a specific stream, in standard format (see frame.h) */
721         int (* const write_stream)(struct ast_channel *chan, int stream_num, struct ast_frame *frame);
722
723         /*! \brief Display or transmit text */
724         int (* const send_text)(struct ast_channel *chan, const char *text);
725
726         /*! \brief Display or send an image */
727         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
728
729         /*! \brief Send HTML data */
730         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
731
732         /*! \brief Handle an exception, reading a frame */
733         struct ast_frame * (* const exception)(struct ast_channel *chan);
734
735         /*! \brief Bridge two channels of the same type together (early) */
736         enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
737
738         /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
739         int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
740
741         /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
742         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
743
744         /*! \brief Set a given option. Called with chan locked */
745         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
746
747         /*! \brief Query a given option. Called with chan locked */
748         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
749
750         /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
751         int (* const transfer)(struct ast_channel *chan, const char *newdest);
752
753         /*! \brief Write a frame, in standard format */
754         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
755
756         /*! \brief Write a text frame, in standard format */
757         int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
758
759         /*!
760          * \brief Provide additional read items for CHANNEL() dialplan function
761          * \note data should be treated as a const char *.
762          */
763         int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
764
765         /*!
766          * \brief Provide additional write items for CHANNEL() dialplan function
767          * \note data should be treated as a const char *.
768          */
769         int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
770
771         /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
772         const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
773
774         /*! \brief Call a function with cc parameters as a function parameter
775          *
776          * \details
777          * This is a highly specialized callback that is not likely to be needed in many
778          * channel drivers. When dealing with a busy channel, for instance, most channel
779          * drivers will successfully return a channel to the requester. Once called, the channel
780          * can then queue a busy frame when it receives an appropriate message from the far end.
781          * In such a case, the channel driver has the opportunity to also queue a CC frame.
782          * The parameters for the CC channel can be retrieved from the channel structure.
783          *
784          * For other channel drivers, notably those that deal with "dumb" phones, the channel
785          * driver will not return a channel when one is requested. In such a scenario, there is never
786          * an opportunity for the channel driver to queue a CC frame since the channel is never
787          * called. Furthermore, it is not possible to retrieve the CC configuration parameters
788          * for the desired channel because no channel is ever allocated or returned to the
789          * requester. In such a case, call completion may still be a viable option. What we do is
790          * pass the same string that the requester used originally to request the channel to the
791          * channel driver. The channel driver can then find any potential channels/devices that
792          * match the input and return call the designated callback with the device's call completion
793          * parameters as a parameter.
794          */
795         int (* cc_callback)(struct ast_channel *inbound, const char *dest, ast_cc_callback_fn callback);
796
797         /*!
798          * \brief Execute a Gosub call on the channel in a technology specific way before a call is placed.
799          * \since 11.0
800          *
801          * \param chan Channel to execute Gosub in a tech specific way.
802          * \param sub_args Gosub application parameter string.
803          *
804          * \note The chan is locked before calling.
805          *
806          * \retval 0 on success.
807          * \retval -1 on error.
808          */
809         int (*pre_call)(struct ast_channel *chan, const char *sub_args);
810 };
811
812 /*! Kill the channel channel driver technology descriptor. */
813 extern const struct ast_channel_tech ast_kill_tech;
814
815 struct ast_epoll_data;
816
817 /*!
818  * The high bit of the frame count is used as a debug marker, so
819  * increments of the counters must be done with care.
820  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
821  */
822 #define DEBUGCHAN_FLAG  0x80000000
823
824 /* XXX not ideal to evaluate x twice... */
825 #define FRAMECOUNT_INC(x)       ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
826
827 /*!
828  * The current value of the debug flags is stored in the two
829  * variables global_fin and global_fout (declared in main/channel.c)
830  */
831 extern unsigned long global_fin, global_fout;
832
833 enum ast_channel_adsicpe {
834         AST_ADSI_UNKNOWN,
835         AST_ADSI_AVAILABLE,
836         AST_ADSI_UNAVAILABLE,
837         AST_ADSI_OFFHOOKONLY,
838 };
839
840 /*!
841  * \brief Possible T38 states on channels
842  */
843 enum ast_t38_state {
844         T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
845         T38_STATE_UNKNOWN,      /*!< The channel supports T38 but the current status is unknown */
846         T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
847         T38_STATE_REJECTED,     /*!< Remote side has rejected our offer */
848         T38_STATE_NEGOTIATED,   /*!< T38 established */
849 };
850
851 /*! Hangup handler instance node. */
852 struct ast_hangup_handler {
853         /*! Next hangup handler node. */
854         AST_LIST_ENTRY(ast_hangup_handler) node;
855         /*! Hangup handler arg string passed to the Gosub application */
856         char args[0];
857 };
858
859 AST_LIST_HEAD_NOLOCK(ast_hangup_handler_list, ast_hangup_handler);
860 AST_LIST_HEAD_NOLOCK(ast_datastore_list, ast_datastore);
861 AST_LIST_HEAD_NOLOCK(ast_autochan_list, ast_autochan);
862 AST_LIST_HEAD_NOLOCK(ast_readq_list, ast_frame);
863
864 typedef int(*ast_timing_func_t)(const void *data);
865 /*!
866  * \page AstChannel ast_channel locking and reference tracking
867  *
868  * \par Creating Channels
869  * A channel is allocated using the ast_channel_alloc() function.  When created, it is
870  * automatically inserted into the main channels hash table that keeps track of all
871  * active channels in the system.  The hash key is based on the channel name.  Because
872  * of this, if you want to change the name, you _must_ use ast_change_name(), not change
873  * the name field directly.  When ast_channel_alloc() returns a channel pointer, you now
874  * hold both a reference to that channel and a lock on the channel. Once the channel has
875  * been set up the lock can be released. In most cases the reference is given to ast_pbx_run().
876  *
877  * \par Channel Locking
878  * There is a lock associated with every ast_channel.  It is allocated internally via astobj2.
879  * To lock or unlock a channel, you must use the ast_channel_lock() wrappers.
880  *
881  * Previously, before ast_channel was converted to astobj2, the channel lock was used in some
882  * additional ways that are no longer necessary.  Before, the only way to ensure that a channel
883  * did not disappear out from under you if you were working with a channel outside of the channel
884  * thread that owns it, was to hold the channel lock.  Now, that is no longer necessary.
885  * You simply must hold a reference to the channel to ensure it does not go away.
886  *
887  * The channel must be locked if you need to ensure that data that you reading from the channel
888  * does not change while you access it.  Further, you must hold the channel lock if you are
889  * making a non-atomic change to channel data.
890  *
891  * \par Channel References
892  * There are multiple ways to get a reference to a channel.  The first is that you hold a reference
893  * to a channel after creating it.  The other ways involve using the channel search or the channel
894  * traversal APIs.  These functions are the ast_channel_get_*() functions or ast_channel_iterator_*()
895  * functions.  Once a reference is retrieved by one of these methods, you know that the channel will
896  * not go away.  So, the channel should only get locked as needed for data access or modification.
897  * But, make sure that the reference gets released when you are done with it!
898  *
899  * There are different things you can do when you are done with a reference to a channel.  The first
900  * is to simply release the reference using ast_channel_unref().  The other option is to call
901  * ast_channel_release().  This function is generally used where ast_channel_free() was used in
902  * the past.  The release function releases a reference as well as ensures that the channel is no
903  * longer in the global channels container.  That way, the channel will get destroyed as soon as any
904  * other pending references get released.
905  *
906  * \par Exceptions to the rules
907  * Even though ast_channel is reference counted, there are some places where pointers to an ast_channel
908  * get stored, but the reference count does not reflect it.  The reason is mostly historical.
909  * The only places where this happens should be places where because of how the code works, we
910  * _know_ that the pointer to the channel will get removed before the channel goes away.  The main
911  * example of this is in channel drivers.  Channel drivers generally store a pointer to their owner
912  * ast_channel in their technology specific pvt struct.  In this case, the channel drivers _know_
913  * that this pointer to the channel will be removed in time, because the channel's hangup callback
914  * gets called before the channel goes away.
915  */
916
917 struct ast_channel;
918
919 /*! \brief ast_channel_tech Properties */
920 enum {
921         /*!
922          * \brief Channels have this property if they can accept input with jitter;
923          * i.e. most VoIP channels
924          */
925         AST_CHAN_TP_WANTSJITTER = (1 << 0),
926         /*!
927          * \brief Channels have this property if they can create jitter;
928          * i.e. most VoIP channels
929          */
930         AST_CHAN_TP_CREATESJITTER = (1 << 1),
931         /*!
932          * \brief Channels with this particular technology are an implementation detail of
933          * Asterisk and should generally not be exposed or manipulated by the outside
934          * world
935          */
936         AST_CHAN_TP_INTERNAL = (1 << 2),
937 };
938
939 /*! \brief ast_channel flags */
940 enum {
941         /*! Queue incoming DTMF, to be released when this flag is turned off */
942         AST_FLAG_DEFER_DTMF =    (1 << 1),
943         /*! write should be interrupt generator */
944         AST_FLAG_WRITE_INT =     (1 << 2),
945         /*! a thread is blocking on this channel */
946         AST_FLAG_BLOCKING =      (1 << 3),
947         /*! This is a zombie channel */
948         AST_FLAG_ZOMBIE =        (1 << 4),
949         /*! There is an exception pending */
950         AST_FLAG_EXCEPTION =     (1 << 5),
951         /*! Listening to moh XXX anthm promises me this will disappear XXX */
952         AST_FLAG_MOH =           (1 << 6),
953         /*! This channel is spying on another channel */
954         AST_FLAG_SPYING =        (1 << 7),
955         /*! the channel is in an auto-incrementing dialplan processor,
956          *  so when ->priority is set, it will get incremented before
957          *  finding the next priority to run */
958         AST_FLAG_IN_AUTOLOOP =   (1 << 9),
959         /*! This is an outgoing call */
960         AST_FLAG_OUTGOING =      (1 << 10),
961         /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
962         AST_FLAG_IN_DTMF =       (1 << 12),
963         /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
964          *  currently being emulated */
965         AST_FLAG_EMULATE_DTMF =  (1 << 13),
966         /*! This is set to tell the channel not to generate DTMF begin frames, and
967          *  to instead only generate END frames. */
968         AST_FLAG_END_DTMF_ONLY = (1 << 14),
969         /* OBSOLETED in favor of AST_CAUSE_ANSWERED_ELSEWHERE
970          * Flag to show channels that this call is hangup due to the fact that the call
971          * was indeed answered, but in another channel */
972         /* AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15), */
973         /*! This flag indicates that on a masquerade, an active stream should not
974          *  be carried over */
975         AST_FLAG_MASQ_NOSTREAM = (1 << 16),
976         /*! This flag indicates that the hangup exten was run when the bridge terminated,
977          *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
978          *  level */
979         AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
980         /*! Disable certain workarounds.  This reintroduces certain bugs, but allows
981          *  some non-traditional dialplans (like AGI) to continue to function.
982          */
983         AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
984         /*!
985          * Disable device state event caching.  This allows channel
986          * drivers to selectively prevent device state events from being
987          * cached by certain channels such as anonymous calls which have
988          * no persistent represenatation that can be tracked.
989          */
990         AST_FLAG_DISABLE_DEVSTATE_CACHE = (1 << 21),
991         /*!
992          * This flag indicates that a dual channel redirect is in
993          * progress.  The bridge needs to wait until the flag is cleared
994          * to continue.
995          */
996         AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT = (1 << 22),
997         /*!
998          * This flag indicates that the channel was originated.
999          */
1000         AST_FLAG_ORIGINATED = (1 << 23),
1001         /*!
1002          * The channel is well and truly dead. Once this is set and published, no further
1003          * actions should be taken upon the channel, and no further publications should
1004          * occur.
1005          */
1006         AST_FLAG_DEAD = (1 << 24),
1007         /*!
1008          * Channel snapshot should not be published, it is being staged for an explicit
1009          * publish.
1010          */
1011         AST_FLAG_SNAPSHOT_STAGE = (1 << 25),
1012         /*!
1013          * The data on chan->timingdata is an astobj2 object.
1014          */
1015         AST_FLAG_TIMINGDATA_IS_AO2_OBJ = (1 << 26),
1016         /*!
1017          * The channel is executing a subroutine or macro
1018          */
1019         AST_FLAG_SUBROUTINE_EXEC = (1 << 27),
1020 };
1021
1022 /*! \brief ast_bridge_config flags */
1023 enum {
1024         AST_FEATURE_PLAY_WARNING = (1 << 0),
1025         AST_FEATURE_REDIRECT =     (1 << 1),
1026         AST_FEATURE_DISCONNECT =   (1 << 2),
1027         AST_FEATURE_ATXFER =       (1 << 3),
1028         AST_FEATURE_AUTOMON =      (1 << 4),
1029         AST_FEATURE_PARKCALL =     (1 << 5),
1030         AST_FEATURE_AUTOMIXMON =   (1 << 6),
1031 };
1032
1033 #define AST_FEATURE_DTMF_MASK (AST_FEATURE_REDIRECT | AST_FEATURE_DISCONNECT |\
1034         AST_FEATURE_ATXFER | AST_FEATURE_AUTOMON | AST_FEATURE_PARKCALL | AST_FEATURE_AUTOMIXMON)
1035
1036 /*! \brief bridge configuration */
1037 struct ast_bridge_config {
1038         struct ast_flags features_caller;
1039         struct ast_flags features_callee;
1040         struct timeval start_time;
1041         struct timeval nexteventts;
1042         struct timeval feature_start_time;
1043         long feature_timer;
1044         long timelimit;
1045         long play_warning;
1046         long warning_freq;
1047         const char *warning_sound;
1048         const char *end_sound;
1049         const char *start_sound;
1050         unsigned int flags;
1051         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
1052         void *end_bridge_callback_data;         /*!< Data passed to the callback */
1053         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
1054          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
1055          */
1056         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
1057 };
1058
1059 struct chanmon;
1060
1061 struct outgoing_helper {
1062         const char *context;
1063         const char *exten;
1064         int priority;
1065         int connect_on_early_media;     /* If set, treat session progress as answer */
1066         const char *cid_num;
1067         const char *cid_name;
1068         const char *account;
1069         struct ast_variable *vars;
1070         struct ast_channel *parent_channel;
1071 };
1072
1073 enum {
1074         /*!
1075          * Soft hangup requested by device or other internal reason.
1076          * Actual hangup needed.
1077          */
1078         AST_SOFTHANGUP_DEV =       (1 << 0),
1079         /*!
1080          * Used to break the normal frame flow so an async goto can be
1081          * done instead of actually hanging up.
1082          */
1083         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
1084         /*!
1085          * Soft hangup requested by system shutdown.  Actual hangup
1086          * needed.
1087          */
1088         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
1089         /*!
1090          * Used to break the normal frame flow after a timeout so an
1091          * implicit async goto can be done to the 'T' exten if it exists
1092          * instead of actually hanging up.  If the exten does not exist
1093          * then actually hangup.
1094          */
1095         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
1096         /*!
1097          * Soft hangup requested by application/channel-driver being
1098          * unloaded.  Actual hangup needed.
1099          */
1100         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
1101         /*!
1102          * Soft hangup requested by non-associated party.  Actual hangup
1103          * needed.
1104          */
1105         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
1106         /*!
1107          * Used to indicate that the channel is currently executing hangup
1108          * logic in the dialplan. The channel has been hungup when this is
1109          * set.
1110          */
1111         AST_SOFTHANGUP_HANGUP_EXEC = (1 << 7),
1112         /*!
1113          * \brief All softhangup flags.
1114          *
1115          * This can be used as an argument to ast_channel_clear_softhangup()
1116          * to clear all softhangup flags from a channel.
1117          */
1118         AST_SOFTHANGUP_ALL =       (0xFFFFFFFF)
1119 };
1120
1121
1122 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
1123 enum channelreloadreason {
1124         CHANNEL_MODULE_LOAD,
1125         CHANNEL_MODULE_RELOAD,
1126         CHANNEL_CLI_RELOAD,
1127         CHANNEL_MANAGER_RELOAD,
1128         CHANNEL_ACL_RELOAD,
1129 };
1130
1131 /*!
1132  * \brief Channel AMA Flags
1133  */
1134 enum ama_flags {
1135         AST_AMA_NONE = 0,
1136         AST_AMA_OMIT,
1137         AST_AMA_BILLING,
1138         AST_AMA_DOCUMENTATION,
1139 };
1140
1141 /*!
1142  * \note None of the datastore API calls lock the ast_channel they are using.
1143  *       So, the channel should be locked before calling the functions that
1144  *       take a channel argument.
1145  */
1146
1147 /*!
1148  * \brief Create a channel data store object
1149  * \deprecated You should use the ast_datastore_alloc() generic function instead.
1150  * \version 1.6.1 deprecated
1151  */
1152 struct ast_datastore * attribute_malloc ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
1153         __attribute__((deprecated));
1154
1155 /*!
1156  * \brief Free a channel data store object
1157  * \deprecated You should use the ast_datastore_free() generic function instead.
1158  * \version 1.6.1 deprecated
1159  */
1160 int ast_channel_datastore_free(struct ast_datastore *datastore)
1161         __attribute__((deprecated));
1162
1163 /*! \brief Inherit datastores from a parent to a child. */
1164 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
1165
1166 /*!
1167  * \brief Add a datastore to a channel
1168  *
1169  * \note The channel should be locked before calling this function.
1170  *
1171  * \retval 0 success
1172  * \retval non-zero failure
1173  */
1174 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
1175
1176 /*!
1177  * \brief Remove a datastore from a channel
1178  *
1179  * \note The channel should be locked before calling this function.
1180  *
1181  * \retval 0 success
1182  * \retval non-zero failure
1183  */
1184 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
1185
1186 /*!
1187  * \brief Find a datastore on a channel
1188  *
1189  * \note The channel should be locked before calling this function.
1190  *
1191  * \note The datastore returned from this function must not be used if the
1192  *       reference to the channel is released.
1193  *
1194  * \retval pointer to the datastore if found
1195  * \retval NULL if not found
1196  */
1197 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
1198
1199 /*!
1200  * \brief Create a channel structure
1201  * \since 1.8
1202  *
1203  * \retval NULL failure
1204  * \retval non-NULL successfully allocated channel
1205  *
1206  * \note Absolutely _NO_ channel locks should be held before calling this function.
1207  * \note By default, new channels are set to the "s" extension
1208  *       and "default" context.
1209  * \note Since 12.0.0 this function returns with the newly created channel locked.
1210  */
1211 struct ast_channel * attribute_malloc __attribute__((format(printf, 15, 16)))
1212         __ast_channel_alloc(int needqueue, int state, const char *cid_num,
1213                 const char *cid_name, const char *acctcode,
1214                 const char *exten, const char *context, const struct ast_assigned_ids *assignedids,
1215                 const struct ast_channel *requestor, enum ama_flags amaflag,
1216                 struct ast_endpoint *endpoint,
1217                 const char *file, int line, const char *function,
1218                 const char *name_fmt, ...);
1219
1220 /*!
1221  * \brief Create a channel structure
1222  *
1223  * \retval NULL failure
1224  * \retval non-NULL successfully allocated channel
1225  *
1226  * \note Absolutely _NO_ channel locks should be held before calling this function.
1227  * \note By default, new channels are set to the "s" extension
1228  *       and "default" context.
1229  * \note Since 12.0.0 this function returns with the newly created channel locked.
1230  */
1231 #define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, ...) \
1232         __ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, NULL, \
1233                 __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
1234
1235 #define ast_channel_alloc_with_endpoint(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, endpoint, ...) \
1236         __ast_channel_alloc((needqueue), (state), (cid_num), (cid_name), (acctcode), (exten), (context), (assignedids), (requestor), (amaflag), (endpoint), \
1237                 __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
1238
1239 /*!
1240  * \brief Create a fake channel structure
1241  *
1242  * \retval NULL failure
1243  * \retval non-NULL successfully allocated channel
1244  *
1245  * \note This function should ONLY be used to create a fake channel
1246  *       that can then be populated with data for use in variable
1247  *       substitution when a real channel does not exist.
1248  *
1249  * \note The created dummy channel should be destroyed by
1250  * ast_channel_unref().  Using ast_channel_release() needlessly
1251  * grabs the channel container lock and can cause a deadlock as
1252  * a result.  Also grabbing the channel container lock reduces
1253  * system performance.
1254  */
1255 #define ast_dummy_channel_alloc()       __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
1256 struct ast_channel *__ast_dummy_channel_alloc(const char *file, int line, const char *function);
1257
1258 /*!
1259  * \brief Queue one or more frames to a channel's frame queue
1260  *
1261  * \param chan the channel to queue the frame(s) on
1262  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1263  *        by this function.  It is the responsibility of the caller to handle
1264  *        freeing the memory associated with the frame(s) being passed if
1265  *        necessary.
1266  *
1267  * \retval 0 success
1268  * \retval non-zero failure
1269  */
1270 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
1271
1272 /*!
1273  * \brief Queue one or more frames to the head of a channel's frame queue
1274  *
1275  * \param chan the channel to queue the frame(s) on
1276  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1277  *        by this function.  It is the responsibility of the caller to handle
1278  *        freeing the memory associated with the frame(s) being passed if
1279  *        necessary.
1280  *
1281  * \retval 0 success
1282  * \retval non-zero failure
1283  */
1284 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
1285
1286 /*!
1287  * \brief Queue a hangup frame
1288  *
1289  * \note The channel does not need to be locked before calling this function.
1290  */
1291 int ast_queue_hangup(struct ast_channel *chan);
1292
1293 /*!
1294  * \brief Queue a hangup frame with hangupcause set
1295  *
1296  * \note The channel does not need to be locked before calling this function.
1297  * \param[in] chan channel to queue frame onto
1298  * \param[in] cause the hangup cause
1299  * \return 0 on success, -1 on error
1300  * \since 1.6.1
1301  */
1302 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
1303
1304 /*!
1305  * \brief Queue a hold frame
1306  *
1307  * \param chan channel to queue frame onto
1308  * \param musicclass The suggested musicclass for the other end to use
1309  *
1310  * \note The channel does not need to be locked before calling this function.
1311  *
1312  * \retval zero on success
1313  * \retval non-zero on failure
1314  */
1315 int ast_queue_hold(struct ast_channel *chan, const char *musicclass);
1316
1317 /*!
1318  * \brief Queue an unhold frame
1319  *
1320  * \param chan channel to queue frame onto
1321  *
1322  * \note The channel does not need to be locked before calling this function.
1323  *
1324  * \retval zero on success
1325  * \retval non-zero on failure
1326  */
1327 int ast_queue_unhold(struct ast_channel *chan);
1328
1329 /*!
1330  * \brief Queue a control frame without payload
1331  *
1332  * \param chan channel to queue frame onto
1333  * \param control type of control frame
1334  *
1335  * \note The channel does not need to be locked before calling this function.
1336  *
1337  * \retval zero on success
1338  * \retval non-zero on failure
1339  */
1340 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
1341
1342 /*!
1343  * \brief Queue a control frame with payload
1344  *
1345  * \param chan channel to queue frame onto
1346  * \param control type of control frame
1347  * \param data pointer to payload data to be included in frame
1348  * \param datalen number of bytes of payload data
1349  *
1350  * \retval 0 success
1351  * \retval non-zero failure
1352  *
1353  * \details
1354  * The supplied payload data is copied into the frame, so the caller's copy
1355  * is not modified nor freed, and the resulting frame will retain a copy of
1356  * the data even if the caller frees their local copy.
1357  *
1358  * \note This method should be treated as a 'network transport'; in other
1359  * words, your frames may be transferred across an IAX2 channel to another
1360  * system, which may be a different endianness than yours. Because of this,
1361  * you should ensure that either your frames will never be expected to work
1362  * across systems, or that you always put your payload data into 'network byte
1363  * order' before calling this function.
1364  *
1365  * \note The channel does not need to be locked before calling this function.
1366  */
1367 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
1368                            const void *data, size_t datalen);
1369
1370 /*!
1371  * \brief Change channel name
1372  *
1373  * \pre Absolutely all channels _MUST_ be unlocked before calling this function.
1374  *
1375  * \param chan the channel to change the name of
1376  * \param newname the name to change to
1377  *
1378  * \return nothing
1379  *
1380  * \note this function must _NEVER_ be used when any channels are locked
1381  * regardless if it is the channel who's name is being changed or not because
1382  * it invalidates our channel container locking order... lock container first,
1383  * then the individual channels, never the other way around.
1384  */
1385 void ast_change_name(struct ast_channel *chan, const char *newname);
1386
1387 /*!
1388  * \brief Unlink and release reference to a channel
1389  *
1390  * This function will unlink the channel from the global channels container
1391  * if it is still there and also release the current reference to the channel.
1392  *
1393  * \return NULL, convenient for clearing invalid pointers
1394  * \note Absolutely _NO_ channel locks should be held before calling this function.
1395  *
1396  * \since 1.8
1397  */
1398 struct ast_channel *ast_channel_release(struct ast_channel *chan);
1399
1400 /*!
1401  * \brief Requests a channel
1402  *
1403  * \param type type of channel to request
1404  * \param request_cap Format capabilities for requested channel
1405  * \param assignedids Unique ID to create channel with
1406  * \param requestor channel asking for data
1407  * \param addr destination of the call
1408  * \param cause Cause of failure
1409  *
1410  * \details
1411  * Request a channel of a given type, with addr as optional information used
1412  * by the low level module
1413  *
1414  * \retval NULL failure
1415  * \retval non-NULL channel on success
1416  */
1417 struct ast_channel *ast_request(const char *type, struct ast_format_cap *request_cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, int *cause);
1418
1419 /*!
1420  * \brief Requests a channel (specifying stream topology)
1421  *
1422  * \param type type of channel to request
1423  * \param topology Stream topology for requested channel
1424  * \param assignedids Unique ID to create channel with
1425  * \param requestor channel asking for data
1426  * \param addr destination of the call
1427  * \param cause Cause of failure
1428  *
1429  * \details
1430  * Request a channel of a given type, with addr as optional information used
1431  * by the low level module
1432  *
1433  * \retval NULL failure
1434  * \retval non-NULL channel on success
1435  */
1436 struct ast_channel *ast_request_with_stream_topology(const char *type, struct ast_stream_topology *topology, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, int *cause);
1437
1438 enum ast_channel_requestor_relationship {
1439         /*! The requestor is the future bridge peer of the channel. */
1440         AST_CHANNEL_REQUESTOR_BRIDGE_PEER,
1441         /*! The requestor is to be replaced by the channel. */
1442         AST_CHANNEL_REQUESTOR_REPLACEMENT,
1443 };
1444
1445 /*!
1446  * \brief Setup new channel accountcodes from the requestor channel after ast_request().
1447  * \since 13.0.0
1448  *
1449  * \param chan New channel to get accountcodes setup.
1450  * \param requestor Requesting channel to get accountcodes from.
1451  * \param relationship What the new channel was created for.
1452  *
1453  * \pre The chan and requestor channels are already locked.
1454  *
1455  * \note Pre-existing accountcodes on chan will be overwritten.
1456  *
1457  * \return Nothing
1458  */
1459 void ast_channel_req_accountcodes(struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship);
1460
1461 /*!
1462  * \brief Setup new channel accountcodes from the requestor channel after ast_request().
1463  * \since 13.0.0
1464  *
1465  * \param chan New channel to get accountcodes setup.
1466  * \param requestor Requesting channel to get accountcodes from.
1467  * \param relationship What the new channel was created for.
1468  *
1469  * \pre The chan and requestor channels are already locked.
1470  *
1471  * \note Pre-existing accountcodes on chan will not be overwritten.
1472  *
1473  * \return Nothing
1474  */
1475 void ast_channel_req_accountcodes_precious(struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship);
1476
1477 /*!
1478  * \brief Request a channel of a given type, with data as optional information used
1479  *        by the low level module and attempt to place a call on it
1480  *
1481  * \param type type of channel to request
1482  * \param cap format capabilities for requested channel
1483  * \param assignedids Unique Id to assign to channel
1484  * \param requestor channel asking for data
1485  * \param addr destination of the call
1486  * \param timeout maximum amount of time to wait for an answer
1487  * \param reason why unsuccessful (if unsuccessful)
1488  * \param cid_num Caller-ID Number
1489  * \param cid_name Caller-ID Name (ascii)
1490  *
1491  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1492  * to know if the call was answered or not.
1493  */
1494 struct ast_channel *ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr,
1495         int timeout, int *reason, const char *cid_num, const char *cid_name);
1496
1497 /*!
1498  * \brief Request a channel of a given type, with data as optional information used
1499  * by the low level module and attempt to place a call on it
1500  * \param type type of channel to request
1501  * \param cap format capabilities for requested channel
1502  * \param assignedids Unique Id to assign to channel
1503  * \param requestor channel requesting data
1504  * \param addr destination of the call
1505  * \param timeout maximum amount of time to wait for an answer
1506  * \param reason why unsuccessful (if unsuccessful)
1507  * \param cid_num Caller-ID Number
1508  * \param cid_name Caller-ID Name (ascii)
1509  * \param oh Outgoing helper
1510  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1511  * to know if the call was answered or not.
1512  */
1513 struct ast_channel *__ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr,
1514         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1515
1516 /*!
1517  * \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.
1518  * \param caller in channel that requested orig
1519  * \param orig channel being replaced by the call forward channel
1520  * \param timeout maximum amount of time to wait for setup of new forward channel
1521  * \param cap format capabilities for requested channel
1522  * \param oh outgoing helper used with original channel
1523  * \param outstate reason why unsuccessful (if uncuccessful)
1524  * \return Returns the forwarded call's ast_channel on success or NULL on failure
1525  */
1526 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);
1527
1528 /*!
1529  * \brief Register a channel technology (a new channel driver)
1530  * Called by a channel module to register the kind of channels it supports.
1531  * \param tech Structure defining channel technology or "type"
1532  * \return Returns 0 on success, -1 on failure.
1533  */
1534 int ast_channel_register(const struct ast_channel_tech *tech);
1535
1536 /*!
1537  * \brief Unregister a channel technology
1538  * \param tech Structure defining channel technology or "type" that was previously registered
1539  * \return No return value.
1540  */
1541 void ast_channel_unregister(const struct ast_channel_tech *tech);
1542
1543 /*!
1544  * \brief Get a channel technology structure by name
1545  * \param name name of technology to find
1546  * \return a pointer to the structure, or NULL if no matching technology found
1547  */
1548 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1549
1550 /*!
1551  * \brief Hang up a channel
1552  * \note Absolutely _NO_ channel locks should be held before calling this function.
1553  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
1554  * performs all stream stopping, etc, on the channel that needs to end.
1555  * chan is no longer valid after this call.
1556  * \param chan channel to hang up (NULL tolerant)
1557  * \return Nothing
1558  */
1559 void ast_hangup(struct ast_channel *chan);
1560
1561 /*!
1562  * \brief Soft hangup all active channels.
1563  * \since 13.3.0
1564  *
1565  * \return Nothing
1566  */
1567 void ast_softhangup_all(void);
1568
1569 /*!
1570  * \brief Softly hangup up a channel
1571  *
1572  * \param chan channel to be soft-hung-up
1573  * \param reason an AST_SOFTHANGUP_* reason code
1574  *
1575  * \details
1576  * Call the protocol layer, but don't destroy the channel structure
1577  * (use this if you are trying to
1578  * safely hangup a channel managed by another thread.
1579  *
1580  * \note The channel passed to this function does not need to be locked.
1581  *
1582  * \return Returns 0 regardless
1583  */
1584 int ast_softhangup(struct ast_channel *chan, int reason);
1585
1586 /*!
1587  * \brief Softly hangup up a channel (no channel lock)
1588  * \param chan channel to be soft-hung-up
1589  * \param reason an AST_SOFTHANGUP_* reason code
1590  */
1591 int ast_softhangup_nolock(struct ast_channel *chan, int reason);
1592
1593 /*!
1594  * \brief Clear a set of softhangup flags from a channel
1595  *
1596  * Never clear a softhangup flag from a channel directly.  Instead,
1597  * use this function.  This ensures that all aspects of the softhangup
1598  * process are aborted.
1599  *
1600  * \param chan the channel to clear the flag on
1601  * \param flag the flag or flags to clear
1602  *
1603  * \return Nothing.
1604  */
1605 void ast_channel_clear_softhangup(struct ast_channel *chan, int flag);
1606
1607 /*!
1608  * \brief Set the source of the hangup in this channel and it's bridge
1609  *
1610  * \param chan channel to set the field on
1611  * \param source a string describing the source of the hangup for this channel
1612  * \param force
1613  *
1614  * \note Absolutely _NO_ channel locks should be held before calling this function.
1615  *
1616  * \since 1.8
1617  *
1618  * Hangupsource is generally the channel name that caused the bridge to be
1619  * hung up, but it can also be other things such as "dialplan/agi"
1620  * This can then be logged in the CDR or CEL
1621  */
1622 void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force);
1623
1624 /*! \brief Check to see if a channel is needing hang up
1625  * \param chan channel on which to check for hang up
1626  * This function determines if the channel is being requested to be hung up.
1627  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1628  */
1629 int ast_check_hangup(struct ast_channel *chan);
1630
1631 int ast_check_hangup_locked(struct ast_channel *chan);
1632
1633 /*! \brief This function will check if the bridge needs to be re-evaluated due to
1634  *         external changes.
1635  *
1636  *  \param chan Channel on which to check the unbridge_eval flag
1637  *
1638  *  \return Returns 0 if the flag is down or 1 if the flag is up.
1639  */
1640 int ast_channel_unbridged(struct ast_channel *chan);
1641
1642 /*! \brief ast_channel_unbridged variant. Use this if the channel
1643  *         is already locked prior to calling.
1644  *
1645  *  \param chan Channel on which to check the unbridge flag
1646  *
1647  *  \return Returns 0 if the flag is down or 1 if the flag is up.
1648  */
1649 int ast_channel_unbridged_nolock(struct ast_channel *chan);
1650
1651 /*! \brief Sets the unbridged flag and queues a NULL frame on the channel to trigger
1652  *         a check by bridge_channel_wait
1653  *
1654  *  \param chan Which channel is having its unbridged value set
1655  *  \param value What the unbridge value is being set to
1656  */
1657 void ast_channel_set_unbridged(struct ast_channel *chan, int value);
1658
1659 /*! \brief Variant of ast_channel_set_unbridged. Use this if the channel
1660  *         is already locked prior to calling.
1661  *
1662  *  \param chan Which channel is having its unbridged value set
1663  *  \param value What the unbridge value is being set to
1664  */
1665 void ast_channel_set_unbridged_nolock(struct ast_channel *chan, int value);
1666
1667 /*!
1668  * \brief This function will check if T.38 is active on the channel.
1669  *
1670  * \param chan Channel on which to check the unbridge_eval flag
1671  *
1672  * \return Returns 0 if the flag is down or 1 if the flag is up.
1673  */
1674 int ast_channel_is_t38_active(struct ast_channel *chan);
1675
1676 /*!
1677  * \brief ast_channel_is_t38_active variant. Use this if the channel
1678  *         is already locked prior to calling.
1679  *
1680  * \param chan Channel on which to check the is_t38_active flag
1681  *
1682  * \return Returns 0 if the flag is down or 1 if the flag is up.
1683  */
1684 int ast_channel_is_t38_active_nolock(struct ast_channel *chan);
1685
1686 /*!
1687  * \brief Sets the is_t38_active flag
1688  *
1689  * \param chan Which channel is having its is_t38_active value set
1690  * \param is_t38_active Non-zero if T.38 is active
1691  */
1692 void ast_channel_set_is_t38_active(struct ast_channel *chan, int is_t38_active);
1693
1694 /*!
1695  * \brief Variant of ast_channel_set_is_t38_active. Use this if the channel
1696  *         is already locked prior to calling.
1697  *
1698  * \param chan Which channel is having its is_t38_active value set
1699  * \param is_t38_active Non-zero if T.38 is active
1700  */
1701 void ast_channel_set_is_t38_active_nolock(struct ast_channel *chan, int is_t38_active);
1702
1703 /*!
1704  * \brief Lock the given channel, then request softhangup on the channel with the given causecode
1705  * \param chan channel on which to hang up
1706  * \param causecode cause code to use (Zero if don't use cause code)
1707  * \return Nothing
1708  */
1709 void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int causecode);
1710
1711 /*!
1712  * \brief Compare a offset with the settings of when to hang a channel up
1713  * \param chan channel on which to check for hang up
1714  * \param offset offset in seconds from current time
1715  * \return 1, 0, or -1
1716  * \details
1717  * This function compares a offset from current time with the absolute time
1718  * out on a channel (when to hang up). If the absolute time out on a channel
1719  * is earlier than current time plus the offset, it returns 1, if the two
1720  * time values are equal, it return 0, otherwise, it return -1.
1721  * \sa ast_channel_cmpwhentohangup_tv()
1722  * \version 1.6.1 deprecated function (only had seconds precision)
1723  */
1724 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1725
1726 /*!
1727  * \brief Compare a offset with the settings of when to hang a channel up
1728  * \param chan channel on which to check for hangup
1729  * \param offset offset in seconds and microseconds from current time
1730  * \return 1, 0, or -1
1731  * This function compares a offset from current time with the absolute time
1732  * out on a channel (when to hang up). If the absolute time out on a channel
1733  * is earlier than current time plus the offset, it returns 1, if the two
1734  * time values are equal, it return 0, otherwise, it return -1.
1735  * \since 1.6.1
1736  */
1737 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1738
1739 /*!
1740  * \brief Set when to hang a channel up
1741  *
1742  * \param chan channel on which to check for hang up
1743  * \param offset offset in seconds relative to the current time of when to hang up
1744  *
1745  * \details
1746  * This function sets the absolute time out on a channel (when to hang up).
1747  *
1748  * \pre chan is locked
1749  *
1750  * \return Nothing
1751  * \sa ast_channel_setwhentohangup_tv()
1752  * \version 1.6.1 deprecated function (only had seconds precision)
1753  */
1754 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1755
1756 /*!
1757  * \brief Set when to hang a channel up
1758  *
1759  * \param chan channel on which to check for hang up
1760  * \param offset offset in seconds and useconds relative to the current time of when to hang up
1761  *
1762  * This function sets the absolute time out on a channel (when to hang up).
1763  *
1764  * \pre chan is locked
1765  *
1766  * \return Nothing
1767  * \since 1.6.1
1768  */
1769 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1770
1771 /*!
1772  * \brief Answer a channel
1773  *
1774  * \param chan channel to answer
1775  *
1776  * \details
1777  * This function answers a channel and handles all necessary call
1778  * setup functions.
1779  *
1780  * \note The channel passed does not need to be locked, but is locked
1781  * by the function when needed.
1782  *
1783  * \note This function will wait up to 500 milliseconds for media to
1784  * arrive on the channel before returning to the caller, so that the
1785  * caller can properly assume the channel is 'ready' for media flow.
1786  *
1787  * \retval 0 on success
1788  * \retval non-zero on failure
1789  */
1790 int ast_answer(struct ast_channel *chan);
1791
1792 /*!
1793  * \brief Answer a channel, if it's not already answered.
1794  *
1795  * \param chan channel to answer
1796  *
1797  * \details See ast_answer()
1798  *
1799  * \retval 0 on success
1800  * \retval non-zero on failure
1801  */
1802 int ast_auto_answer(struct ast_channel *chan);
1803
1804 /*!
1805  * \brief Answer a channel
1806  *
1807  * \param chan channel to answer
1808  *
1809  * This function answers a channel and handles all necessary call
1810  * setup functions.
1811  *
1812  * \note The channel passed does not need to be locked, but is locked
1813  * by the function when needed.
1814  *
1815  * \note Unlike ast_answer(), this function will not wait for media
1816  * flow to begin. The caller should be careful before sending media
1817  * to the channel before incoming media arrives, as the outgoing
1818  * media may be lost.
1819  *
1820  * \retval 0 on success
1821  * \retval non-zero on failure
1822  */
1823 int ast_raw_answer(struct ast_channel *chan);
1824
1825 /*!
1826  * \brief Answer a channel, with a selectable delay before returning
1827  *
1828  * \param chan channel to answer
1829  * \param delay maximum amount of time to wait for incoming media
1830  *
1831  * This function answers a channel and handles all necessary call
1832  * setup functions.
1833  *
1834  * \note The channel passed does not need to be locked, but is locked
1835  * by the function when needed.
1836  *
1837  * \note This function will wait up to 'delay' milliseconds for media to
1838  * arrive on the channel before returning to the caller, so that the
1839  * caller can properly assume the channel is 'ready' for media flow. If
1840  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1841  *
1842  * \retval 0 on success
1843  * \retval non-zero on failure
1844  */
1845 int __ast_answer(struct ast_channel *chan, unsigned int delay);
1846
1847 /*!
1848  * \brief Execute a Gosub call on the channel before a call is placed.
1849  * \since 11.0
1850  *
1851  * \details
1852  * This is called between ast_request() and ast_call() to
1853  * execute a predial routine on the newly created channel.
1854  *
1855  * \param chan Channel to execute Gosub.
1856  * \param sub_args Gosub application parameter string.
1857  *
1858  * \note Absolutely _NO_ channel locks should be held before calling this function.
1859  *
1860  * \retval 0 on success.
1861  * \retval -1 on error.
1862  */
1863 int ast_pre_call(struct ast_channel *chan, const char *sub_args);
1864
1865 /*!
1866  * \brief Make a call
1867  * \note Absolutely _NO_ channel locks should be held before calling this function.
1868  * \param chan which channel to make the call on
1869  * \param addr destination of the call
1870  * \param timeout time to wait on for connect (Doesn't seem to be used.)
1871  * \details
1872  * Place a call, take no longer than timeout ms.
1873  * \retval 0 on success
1874  * \retval -1 on failure
1875  */
1876 int ast_call(struct ast_channel *chan, const char *addr, int timeout);
1877
1878 /*!
1879  * \brief Indicates condition of channel
1880  * \note Absolutely _NO_ channel locks should be held before calling this function.
1881  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1882  * \param chan channel to change the indication
1883  * \param condition which condition to indicate on the channel
1884  * \return Returns 0 on success, -1 on failure
1885  */
1886 int ast_indicate(struct ast_channel *chan, int condition);
1887
1888 /*!
1889  * \brief Indicates condition of channel, with payload
1890  * \note Absolutely _NO_ channel locks should be held before calling this function.
1891  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1892  * \param chan channel to change the indication
1893  * \param condition which condition to indicate on the channel
1894  * \param data pointer to payload data
1895  * \param datalen size of payload data
1896  * \return Returns 0 on success, -1 on failure
1897  */
1898 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1899
1900 /* Misc stuff ------------------------------------------------ */
1901
1902 /*!
1903  * \brief Wait for input on a channel
1904  * \param chan channel to wait on
1905  * \param ms length of time to wait on the channel
1906  * \details
1907  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1908  * \retval < 0 on failure
1909  * \retval 0 if nothing ever arrived
1910  * \retval the # of ms remaining otherwise
1911  */
1912 int ast_waitfor(struct ast_channel *chan, int ms);
1913
1914 /*!
1915  * \brief Should we keep this frame for later?
1916  *
1917  * There are functions such as ast_safe_sleep which will
1918  * service a channel to ensure that it does not have a
1919  * large backlog of queued frames. When this happens,
1920  * we want to hold on to specific frame types and just drop
1921  * others. This function will tell if the frame we just
1922  * read should be held onto.
1923  *
1924  * \param frame The frame we just read
1925  * \retval 1 frame should be kept
1926  * \retval 0 frame should be dropped
1927  */
1928 int ast_is_deferrable_frame(const struct ast_frame *frame);
1929
1930 /*!
1931  * \brief Wait for a specified amount of time, looking for hangups
1932  * \param chan channel to wait for
1933  * \param ms length of time in milliseconds to sleep. This should never be less than zero.
1934  * \details
1935  * Waits for a specified amount of time, servicing the channel as required.
1936  * \return returns -1 on hangup, otherwise 0.
1937  */
1938 int ast_safe_sleep(struct ast_channel *chan, int ms);
1939
1940 /*!
1941  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
1942  * \param chan channel to wait for
1943  * \param ms length of time in milliseconds to sleep.
1944  * \param cond a function pointer for testing continue condition
1945  * \param data argument to be passed to the condition test function
1946  * \return returns -1 on hangup, otherwise 0.
1947  * \details
1948  * Waits for a specified amount of time, servicing the channel as required. If cond
1949  * returns 0, this function returns.
1950  */
1951 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1952
1953 /*!
1954  * \brief Waits for activity on a group of channels
1955  * \param chan an array of pointers to channels
1956  * \param n number of channels that are to be waited upon
1957  * \param fds an array of fds to wait upon
1958  * \param nfds the number of fds to wait upon
1959  * \param exception exception flag
1960  * \param outfd fd that had activity on it
1961  * \param ms how long the wait was
1962  * \details
1963  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1964  * file descriptors.
1965  * \return Returns the channel with activity, or NULL on error or if an FD
1966  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1967  * will be -1
1968  */
1969 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1970         int *fds, int nfds, int *exception, int *outfd, int *ms);
1971
1972 /*!
1973  * \brief Waits for input on a group of channels
1974  * Wait for input on an array of channels for a given # of milliseconds.
1975  * \return Return channel with activity, or NULL if none has activity.
1976  * \param chan an array of pointers to channels
1977  * \param n number of channels that are to be waited upon
1978  * \param ms time "ms" is modified in-place, if applicable
1979  */
1980 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1981
1982 /*!
1983  * \brief Waits for input on an fd
1984  * \note This version works on fd's only.  Be careful with it.
1985  */
1986 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1987
1988
1989 /*!
1990  * \brief Reads a frame
1991  *
1992  * \param chan channel to read a frame from
1993  *
1994  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1995  * best just stop reading frames and assume the channel has been
1996  * disconnected.
1997  *
1998  * \note This function will filter frames received from the channel so
1999  *       that only frames from the default stream for each media type
2000  *       are returned. All other media frames from other streams will
2001  *       be absorbed internally and a NULL frame returned instead.
2002  */
2003 struct ast_frame *ast_read(struct ast_channel *chan);
2004
2005 /*!
2006  * \brief Reads a frame, but does not filter to just the default streams
2007  *
2008  * \param chan channel to read a frame from
2009  *
2010  * \return Returns a frame, or NULL on error.  If it returns NULL, you
2011  * best just stop reading frames and assume the channel has been
2012  * disconnected.
2013  *
2014  * \note This function will not perform any filtering and will return
2015  *       media frames from all streams on the channel. To determine which
2016  *       stream a frame originated from the stream_num on it can be
2017  *       examined.
2018  */
2019 struct ast_frame *ast_read_stream(struct ast_channel *chan);
2020
2021 /*!
2022  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
2023  * \param chan channel to read a frame from
2024  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
2025  * best just stop reading frames and assume the channel has been
2026  * disconnected.
2027  * \note Audio is replaced with AST_FRAME_NULL to avoid
2028  * transcode when the resulting audio is not necessary.
2029  */
2030 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
2031
2032 /*!
2033  * \brief Write a frame to a channel
2034  * This function writes the given frame to the indicated channel.
2035  * \param chan destination channel of the frame
2036  * \param frame frame that will be written
2037  * \return It returns 0 on success, -1 on failure.
2038  */
2039 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
2040
2041 /*!
2042  * \brief Write video frame to a channel
2043  * This function writes the given frame to the indicated channel.
2044  * \param chan destination channel of the frame
2045  * \param frame frame that will be written
2046  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
2047  */
2048 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
2049
2050 /*!
2051  * \brief Write text frame to a channel
2052  * This function writes the given frame to the indicated channel.
2053  * \param chan destination channel of the frame
2054  * \param frame frame that will be written
2055  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
2056  */
2057 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
2058
2059 /*!
2060  * \brief Write a frame to a stream
2061  * This function writes the given frame to the indicated stream on the channel.
2062  * \param chan destination channel of the frame
2063  * \param stream_num destination stream on the channel
2064  * \param frame frame that will be written
2065  * \return It returns 0 on success, -1 on failure.
2066  * \note If -1 is provided as the stream number and a media frame is provided the
2067  *       function will write to the default stream of the type of media.
2068  */
2069 int ast_write_stream(struct ast_channel *chan, int stream_num, struct ast_frame *frame);
2070
2071 /*! \brief Send empty audio to prime a channel driver */
2072 int ast_prod(struct ast_channel *chan);
2073
2074 /*!
2075  * \brief Set specific read path on channel.
2076  * \since 13.4.0
2077  *
2078  * \param chan Channel to setup read path.
2079  * \param raw_format Format to expect from the channel driver.
2080  * \param core_format What the core wants to read.
2081  *
2082  * \pre chan is locked
2083  *
2084  * \retval 0 on success.
2085  * \retval -1 on error.
2086  */
2087 int ast_set_read_format_path(struct ast_channel *chan, struct ast_format *raw_format, struct ast_format *core_format);
2088
2089 /*!
2090  * \brief Set specific write path on channel.
2091  * \since 13.13.0
2092  *
2093  * \param chan Channel to setup write path.
2094  * \param core_format What the core wants to write.
2095  * \param raw_format Raw write format.
2096  *
2097  * \pre chan is locked
2098  *
2099  * \retval 0 on success.
2100  * \retval -1 on error.
2101  */
2102 int ast_set_write_format_path(struct ast_channel *chan, struct ast_format *core_format, struct ast_format *raw_format);
2103
2104 /*!
2105  * \brief Sets read format on channel chan from capabilities
2106  * Set read format for channel to whichever component of "format" is best.
2107  * \param chan channel to change
2108  * \param formats new formats to pick from for reading
2109  * \return Returns 0 on success, -1 on failure
2110  */
2111 int ast_set_read_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
2112
2113 /*!
2114  * \brief Sets read format on channel chan
2115  * \param chan channel to change
2116  * \param format format to set for reading
2117  * \return Returns 0 on success, -1 on failure
2118  */
2119 int ast_set_read_format(struct ast_channel *chan, struct ast_format *format);
2120
2121 /*!
2122  * \brief Sets write format on channel chan
2123  * Set write format for channel to whichever component of "format" is best.
2124  * \param chan channel to change
2125  * \param formats new formats to pick from for writing
2126  * \return Returns 0 on success, -1 on failure
2127  */
2128 int ast_set_write_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
2129
2130 /*!
2131  * \brief Sets write format on channel chan
2132  * \param chan channel to change
2133  * \param format format to set for writing
2134  * \return Returns 0 on success, -1 on failure
2135  */
2136 int ast_set_write_format(struct ast_channel *chan, struct ast_format *format);
2137
2138 /*!
2139  * \brief Sets write format for a channel.
2140  * All internal data will than be handled in an interleaved format. (needed by binaural opus)
2141  *
2142  * \param chan channel to change
2143  * \param format format to set for writing
2144  * \return Returns 0 on success, -1 on failure
2145  */
2146 int ast_set_write_format_interleaved_stereo(struct ast_channel *chan, struct ast_format *format);
2147
2148 /*!
2149  * \brief Sends text to a channel
2150  *
2151  * \param chan channel to act upon
2152  * \param text string of text to send on the channel
2153  *
2154  * \details
2155  * Write text to a display on a channel
2156  *
2157  * \note The channel does not need to be locked before calling this function.
2158  *
2159  * \retval 0 on success
2160  * \retval -1 on failure
2161  */
2162 int ast_sendtext(struct ast_channel *chan, const char *text);
2163
2164 /*!
2165  * \brief Receives a text character from a channel
2166  * \param chan channel to act upon
2167  * \param timeout timeout in milliseconds (0 for infinite wait)
2168  * \details
2169  * Read a char of text from a channel
2170  * \return 0 on success, -1 on failure
2171  */
2172 int ast_recvchar(struct ast_channel *chan, int timeout);
2173
2174 /*!
2175  * \brief Send a DTMF digit to a channel.
2176  * \param chan channel to act upon
2177  * \param digit the DTMF digit to send, encoded in ASCII
2178  * \param duration the duration of the digit ending in ms
2179  * \return 0 on success, -1 on failure
2180  */
2181 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
2182
2183 /*!
2184  * \brief Send a DTMF digit to a channel.
2185  * \param chan channel to act upon
2186  * \param digit the DTMF digit to send, encoded in ASCII
2187  * \return 0 on success, -1 on failure
2188  */
2189 int ast_senddigit_begin(struct ast_channel *chan, char digit);
2190
2191 /*!
2192  * \brief Send a DTMF digit to a channel.
2193  * \param chan channel to act upon
2194  * \param digit the DTMF digit to send, encoded in ASCII
2195  * \param duration the duration of the digit ending in ms
2196  * \return Returns 0 on success, -1 on failure
2197  */
2198 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
2199
2200 /*!
2201  * \brief Receives a text string from a channel
2202  * Read a string of text from a channel
2203  * \param chan channel to act upon
2204  * \param timeout timeout in milliseconds (0 for infinite wait)
2205  * \return the received text, or NULL to signify failure.
2206  */
2207 char *ast_recvtext(struct ast_channel *chan, int timeout);
2208
2209 /*!
2210  * \brief Waits for a digit
2211  * \param c channel to wait for a digit on
2212  * \param ms how many milliseconds to wait (<0 for indefinite).
2213  * \return Returns <0 on error, 0 on no entry, and the digit on success.
2214  */
2215 int ast_waitfordigit(struct ast_channel *c, int ms);
2216
2217 /*!
2218  * \brief Wait for a digit
2219  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
2220  * \param c channel to wait for a digit on
2221  * \param ms how many milliseconds to wait (<0 for indefinite).
2222  * \param audiofd audio file descriptor to write to if audio frames are received
2223  * \param ctrlfd control file descriptor to monitor for reading
2224  * \return Returns 1 if ctrlfd becomes available
2225  */
2226 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
2227
2228 /*!
2229  * \brief Reads multiple digits
2230  * \param c channel to read from
2231  * \param s string to read in to.  Must be at least the size of your length
2232  * \param len how many digits to read (maximum)
2233  * \param timeout how long to timeout between digits
2234  * \param rtimeout timeout to wait on the first digit
2235  * \param enders digits to end the string
2236  * \details
2237  * Read in a digit string "s", max length "len", maximum timeout between
2238  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
2239  * for the first digit.
2240  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
2241  * a timeout, any digits that were read before the timeout will still be available in s.
2242  * RETURNS 2 in full version when ctrlfd is available, NOT 1
2243  */
2244 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
2245 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
2246
2247 /*! \brief Report DTMF on channel 0 */
2248 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
2249 /*! \brief Report DTMF on channel 1 */
2250 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
2251
2252
2253 /*!
2254  * \brief Make the frame formats of two channels compatible.
2255  *
2256  * \param chan First channel to make compatible.  Should be the calling party.
2257  * \param peer Other channel to make compatible.  Should be the called party.
2258  *
2259  * \note Absolutely _NO_ channel locks should be held before calling this function.
2260  *
2261  * \details
2262  * Set two channels to compatible frame formats in both
2263  * directions.  The path from peer to chan is made compatible
2264  * first to allow for in-band audio in case the other direction
2265  * cannot be made compatible.
2266  *
2267  * \retval 0 on success.
2268  * \retval -1 on error.
2269  */
2270 int ast_channel_make_compatible(struct ast_channel *chan, struct ast_channel *peer);
2271
2272 /*!
2273  * \brief Bridge two channels together (early)
2274  * \param c0 first channel to bridge
2275  * \param c1 second channel to bridge
2276  * \details
2277  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
2278  * \return Returns 0 on success and -1 if it could not be done
2279  */
2280 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
2281
2282 /*!
2283  * \brief Gives the string form of a given cause code.
2284  *
2285  * \param state cause to get the description of
2286  * \return the text form of the binary cause code given
2287  */
2288 const char *ast_cause2str(int state) attribute_pure;
2289
2290 /*!
2291  * \brief Convert the string form of a cause code to a number
2292  *
2293  * \param name string form of the cause
2294  * \return the cause code
2295  */
2296 int ast_str2cause(const char *name) attribute_pure;
2297
2298 /*!
2299  * \brief Gives the string form of a given channel state
2300  *
2301  * \param ast_channel_state state to get the name of
2302  * \return the text form of the binary state given
2303  */
2304 const char *ast_state2str(enum ast_channel_state);
2305
2306 /*!
2307  * \brief Gives the string form of a given transfer capability
2308  *
2309  * \param transfercapability transfer capability to get the name of
2310  * \return the text form of the binary transfer capability
2311  */
2312 char *ast_transfercapability2str(int transfercapability) attribute_const;
2313
2314 /*
2315  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
2316  * low level channel.  See frame.h for options.  Note that many channel drivers may support
2317  * none or a subset of those features, and you should not count on this if you want your
2318  * asterisk application to be portable.  They're mainly useful for tweaking performance
2319  */
2320
2321 /*!
2322  * \brief Sets an option on a channel
2323  *
2324  * \param channel channel to set options on
2325  * \param option option to change
2326  * \param data data specific to option
2327  * \param datalen length of the data
2328  * \param block blocking or not
2329  * \details
2330  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
2331  * \return 0 on success and -1 on failure
2332  */
2333 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
2334
2335 /*!
2336  * \brief Checks the value of an option
2337  *
2338  * Query the value of an option
2339  * Works similarly to setoption except only reads the options.
2340  */
2341 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
2342
2343 /*!
2344  * \brief Checks for HTML support on a channel
2345  * \return 0 if channel does not support HTML or non-zero if it does
2346  */
2347 int ast_channel_supports_html(struct ast_channel *channel);
2348
2349 /*!
2350  * \brief Sends HTML on given channel
2351  * Send HTML or URL on link.
2352  * \return 0 on success or -1 on failure
2353  */
2354 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
2355
2356 /*!
2357  * \brief Sends a URL on a given link
2358  * Send URL on link.
2359  * \return 0 on success or -1 on failure
2360  */
2361 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
2362
2363 /*!
2364  * \brief Defers DTMF so that you only read things like hangups and audio.
2365  * \return non-zero if channel was already DTMF-deferred or
2366  * 0 if channel is just now being DTMF-deferred
2367  */
2368 int ast_channel_defer_dtmf(struct ast_channel *chan);
2369
2370 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
2371 void ast_channel_undefer_dtmf(struct ast_channel *chan);
2372
2373 /*! \return number of channels available for lookup */
2374 int ast_active_channels(void);
2375
2376 /*! \return the number of channels not yet destroyed */
2377 int ast_undestroyed_channels(void);
2378
2379 /*! Activate a given generator */
2380 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
2381
2382 /*! Deactivate an active generator */
2383 void ast_deactivate_generator(struct ast_channel *chan);
2384
2385 /*!
2386  * \since 12
2387  * \brief Obtain how long the channel since the channel was created
2388  *
2389  * \param chan The channel object
2390  *
2391  * \retval 0 if the time value cannot be computed (or you called this really fast)
2392  * \retval The number of seconds the channel has been up
2393  */
2394 int ast_channel_get_duration(struct ast_channel *chan);
2395
2396 /*!
2397  * \since 12
2398  * \brief Obtain how long it has been since the channel was answered
2399  *
2400  * \param chan The channel object
2401  *
2402  * \retval 0 if the channel isn't answered (or you called this really fast)
2403  * \retval The number of seconds the channel has been up
2404  */
2405 int ast_channel_get_up_time(struct ast_channel *chan);
2406
2407 /*!
2408  * \brief Set caller ID number, name and ANI and generate AMI event.
2409  *
2410  * \note Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.
2411  * \note The channel does not need to be locked before calling this function.
2412  */
2413 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
2414
2415 /*!
2416  * \brief Set the caller id information in the Asterisk channel
2417  * \since 1.8
2418  *
2419  * \param chan Asterisk channel to set caller id information
2420  * \param caller Caller id information
2421  * \param update What caller information to update.  NULL if all.
2422  *
2423  * \return Nothing
2424  *
2425  * \note The channel does not need to be locked before calling this function.
2426  */
2427 void ast_channel_set_caller(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2428
2429 /*!
2430  * \brief Set the caller id information in the Asterisk channel and generate an AMI event
2431  * if the caller id name or number changed.
2432  * \since 1.8
2433  *
2434  * \param chan Asterisk channel to set caller id information
2435  * \param caller Caller id information
2436  * \param update What caller information to update.  NULL if all.
2437  *
2438  * \return Nothing
2439  *
2440  * \note The channel does not need to be locked before calling this function.
2441  */
2442 void ast_channel_set_caller_event(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2443
2444 /*! Set the file descriptor on the channel */
2445 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
2446
2447 /*! Start a tone going */
2448 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2449 /*! Stop a tone from playing */
2450 void ast_tonepair_stop(struct ast_channel *chan);
2451 /*! Play a tone pair for a given amount of time */
2452 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2453
2454 /*!
2455  * \brief Automatically service a channel for us...
2456  *
2457  * \retval 0 success
2458  * \retval -1 failure, or the channel is already being autoserviced
2459  */
2460 int ast_autoservice_start(struct ast_channel *chan);
2461
2462 /*!
2463  * \brief Stop servicing a channel for us...
2464  *
2465  * \note if chan is locked prior to calling ast_autoservice_stop, it
2466  * is likely that there will be a deadlock between the thread that calls
2467  * ast_autoservice_stop and the autoservice thread. It is important
2468  * that chan is not locked prior to this call
2469  *
2470  * \param chan
2471  * \retval 0 success
2472  * \retval -1 error, or the channel has been hungup
2473  */
2474 int ast_autoservice_stop(struct ast_channel *chan);
2475
2476 /*!
2477  * \brief Put chan into autoservice while hanging up peer.
2478  * \since 11.0
2479  *
2480  * \param chan Chan to put into autoservice.
2481  * \param peer Chan to run hangup handlers and hangup.
2482  *
2483  * \return Nothing
2484  */
2485 void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer);
2486
2487 /*!
2488  * \brief Ignore certain frame types
2489  * \note Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames
2490  * while a channel is in autoservice and queue them up when taken out of
2491  * autoservice.  When this is not desireable, this API may be used to
2492  * cause the channel to ignore those frametypes after the channel is put
2493  * into autoservice, but before autoservice is stopped.
2494  * \retval 0 success
2495  * \retval -1 channel is not in autoservice
2496  */
2497 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype);
2498
2499 /*!
2500  * \brief Enable or disable timer ticks for a channel
2501  *
2502  * \param c channel
2503  * \param rate number of timer ticks per second
2504  * \param func callback function
2505  * \param data
2506  *
2507  * \details
2508  * If timers are supported, force a scheduled expiration on the
2509  * timer fd, at which point we call the callback function / data
2510  *
2511  * \note Call this function with a rate of 0 to turn off the timer ticks
2512  *
2513  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
2514  */
2515 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
2516 int ast_settimeout_full(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data, unsigned int is_ao2_obj);
2517
2518 /*!
2519  * \brief Transfer a channel (if supported).
2520  * \retval -1 on error
2521  * \retval 0 if not supported
2522  * \retval 1 if supported and requested
2523  * \param chan current channel
2524  * \param dest destination extension for transfer
2525  */
2526 int ast_transfer(struct ast_channel *chan, char *dest);
2527
2528 /*!
2529  * \brief Inherits channel variable from parent to child channel
2530  * \param parent Parent channel
2531  * \param child Child channel
2532  *
2533  * \details
2534  * Scans all channel variables in the parent channel, looking for those
2535  * that should be copied into the child channel.
2536  * Variables whose names begin with a single '_' are copied into the
2537  * child channel with the prefix removed.
2538  * Variables whose names begin with '__' are copied into the child
2539  * channel with their names unchanged.
2540  */
2541 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
2542
2543 /*!
2544  * \brief adds a list of channel variables to a channel
2545  * \param chan the channel
2546  * \param vars a linked list of variables
2547  *
2548  * \pre chan is locked
2549  *
2550  * \details
2551  * Variable names can be for a regular channel variable or a dialplan function
2552  * that has the ability to be written to.
2553  */
2554 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
2555
2556 /*!
2557  * \brief An opaque 'object' structure use by silence generators on channels.
2558  */
2559 struct ast_silence_generator;
2560
2561 /*!
2562  * \brief Starts a silence generator on the given channel.
2563  * \param chan The channel to generate silence on
2564  * \return An ast_silence_generator pointer, or NULL if an error occurs
2565  *
2566  * \details
2567  * This function will cause SLINEAR silence to be generated on the supplied
2568  * channel until it is disabled; if the channel cannot be put into SLINEAR
2569  * mode then the function will fail.
2570  *
2571  * \note
2572  * The pointer returned by this function must be preserved and passed to
2573  * ast_channel_stop_silence_generator when you wish to stop the silence
2574  * generation.
2575  */
2576 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
2577
2578 /*!
2579  * \brief Stops a previously-started silence generator on the given channel.
2580  * \param chan The channel to operate on
2581  * \param state The ast_silence_generator pointer return by a previous call to
2582  * ast_channel_start_silence_generator.
2583  * \return nothing
2584  *
2585  * \details
2586  * This function will stop the operating silence generator and return the channel
2587  * to its previous write format.
2588  */
2589 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
2590
2591 /*!
2592  * \brief Determine which channel has an older linkedid
2593  * \param a First channel
2594  * \param b Second channel
2595  * \return Returns an ast_channel structure that has oldest linkedid
2596  */
2597 struct ast_channel *ast_channel_internal_oldest_linkedid(struct ast_channel *a, struct ast_channel *b);
2598
2599 /*!
2600  * \brief Copy the full linkedid channel id structure from one channel to another
2601  * \param dest Destination to copy linkedid to
2602  * \param source Source channel to copy linkedid from
2603  * \return void
2604  */
2605 void ast_channel_internal_copy_linkedid(struct ast_channel *dest, struct ast_channel *source);
2606
2607 /*!
2608  * \brief Swap uniqueid and linkedid beteween two channels
2609  * \param a First channel
2610  * \param b Second channel
2611  * \return void
2612  *
2613  * \note
2614  * This is used in masquerade to exchange identities
2615  */
2616 void ast_channel_internal_swap_uniqueid_and_linkedid(struct ast_channel *a, struct ast_channel *b);
2617
2618 /*!
2619  * \brief Swap topics beteween two channels
2620  * \param a First channel
2621  * \param b Second channel
2622  * \return void
2623  *
2624  * \note
2625  * This is used in masquerade to exchange topics for message routing
2626  */
2627 void ast_channel_internal_swap_topics(struct ast_channel *a, struct ast_channel *b);
2628
2629 /*!
2630  * \brief Set uniqueid and linkedid string value only (not time)
2631  * \param chan The channel to set the uniqueid to
2632  * \param uniqueid The uniqueid to set
2633  * \param linkedid The linkedid to set
2634  * \return void
2635  *
2636  * \note
2637  * This is used only by ast_cel_fabricate_channel_from_event()
2638  * to create a temporary fake channel - time values are invalid
2639  */
2640 void ast_channel_internal_set_fake_ids(struct ast_channel *chan, const char *uniqueid, const char *linkedid);
2641
2642 /* Misc. functions below */
2643
2644 /*!
2645  * \brief if fd is a valid descriptor, set *pfd with the descriptor
2646  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
2647  * return value to the index into the array)
2648  */
2649 static inline int ast_add_fd(struct pollfd *pfd, int fd)
2650 {
2651         pfd->fd = fd;
2652         pfd->events = POLLIN | POLLPRI;
2653         return fd >= 0;
2654 }
2655
2656 /*! \brief Helper function for migrating select to poll */
2657 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
2658 {
2659         int x;
2660         int dummy = 0;
2661
2662         if (fd < 0)
2663                 return 0;
2664         if (!start)
2665                 start = &dummy;
2666         for (x = *start; x < maximum; x++)
2667                 if (pfds[x].fd == fd) {
2668                         if (x == *start)
2669                                 (*start)++;
2670                         return pfds[x].revents;
2671                 }
2672         return 0;
2673 }
2674
2675 /*!
2676  * \brief Retrieves the current T38 state of a channel
2677  *
2678  * \note Absolutely _NO_ channel locks should be held before calling this function.
2679  */
2680 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
2681 {
2682         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2683         int datalen = sizeof(state);
2684
2685         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2686
2687         return state;
2688 }
2689
2690 #define CHECK_BLOCKING(c) do {   \
2691         if (ast_test_flag(ast_channel_flags(c), AST_FLAG_BLOCKING)) {\
2692                 ast_debug(1, "Thread %p is blocking '%s', already blocked by thread %p in procedure %s\n", \
2693                         (void *) pthread_self(), ast_channel_name(c), (void *) ast_channel_blocker(c), ast_channel_blockproc(c)); \
2694         } else { \
2695                 ast_channel_blocker_set((c), pthread_self()); \
2696                 ast_channel_blockproc_set((c), __PRETTY_FUNCTION__); \
2697                 ast_set_flag(ast_channel_flags(c), AST_FLAG_BLOCKING); \
2698         } } while (0)
2699
2700 ast_group_t ast_get_group(const char *s);
2701
2702 /*! \brief Print call and pickup groups into buffer */
2703 char *ast_print_group(char *buf, int buflen, ast_group_t group);
2704
2705 /*! \brief Opaque struct holding a namedgroups set, i.e. a set of group names */
2706 struct ast_namedgroups;
2707
2708 /*! \brief Create an ast_namedgroups set with group names from comma separated string */
2709 struct ast_namedgroups *ast_get_namedgroups(const char *s);
2710 struct ast_namedgroups *ast_unref_namedgroups(struct ast_namedgroups *groups);
2711 struct ast_namedgroups *ast_ref_namedgroups(struct ast_namedgroups *groups);
2712 /*! \brief Return TRUE if group a and b contain at least one common groupname */
2713 int ast_namedgroups_intersect(struct ast_namedgroups *a, struct ast_namedgroups *b);
2714
2715 /*! \brief Print named call groups and named pickup groups */
2716 char *ast_print_namedgroups(struct ast_str **buf, struct ast_namedgroups *groups);
2717
2718 /*!
2719  * \brief Convert enum channelreloadreason to text string for manager event
2720  * \param reason The reason for reload (manager, cli, start etc)
2721  */
2722 const char *channelreloadreason2txt(enum channelreloadreason reason);
2723
2724 /*! \brief return an ast_variable list of channeltypes */
2725 struct ast_variable *ast_channeltype_list(void);
2726
2727 /*!
2728  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2729  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
2730  * \return char pointer explaining the code
2731  */
2732 const char *ast_channel_reason2str(int reason);
2733
2734 /*! \brief channel group info */
2735 struct ast_group_info {
2736         struct ast_channel *chan;
2737         char *category;
2738         char *group;
2739         AST_LIST_ENTRY(ast_group_info) group_list;
2740 };
2741
2742 #define ast_channel_lock(chan) ao2_lock(chan)
2743 #define ast_channel_unlock(chan) ao2_unlock(chan)
2744 #define ast_channel_trylock(chan) ao2_trylock(chan)
2745
2746 /*!
2747  * \brief Lock two channels.
2748  */
2749 #define ast_channel_lock_both(chan1, chan2) do { \
2750                 ast_channel_lock(chan1); \
2751                 while (ast_channel_trylock(chan2)) { \
2752                         ast_channel_unlock(chan1); \
2753                         sched_yield(); \
2754                         ast_channel_lock(chan1); \
2755                 } \
2756         } while (0)
2757
2758 /*!
2759  * \brief Increase channel reference count
2760  *
2761  * \param c the channel
2762  *
2763  * \retval c always
2764  *
2765  * \since 1.8
2766  */
2767 #define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
2768
2769 /*!
2770  * \brief Decrease channel reference count
2771  *
2772  * \param c the channel
2773  *
2774  * \retval NULL always
2775  *
2776  * \since 1.8
2777  */
2778 #define ast_channel_unref(c) ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
2779
2780 /*!
2781  * \brief Cleanup a channel reference
2782  *
2783  * \param c the channel (NULL tolerant)
2784  *
2785  * \retval NULL always
2786  *
2787  * \since 12.0.0
2788  */
2789 #define ast_channel_cleanup(c) ({ ao2_cleanup(c); (struct ast_channel *) (NULL); })
2790
2791 /*! Channel Iterating @{ */
2792
2793 /*!
2794  * \brief A channel iterator
2795  *
2796  * This is an opaque type.
2797  */
2798 struct ast_channel_iterator;
2799
2800 /*!
2801  * \brief Destroy a channel iterator
2802  *
2803  * \param i the itereator to destroy
2804  *
2805  * \details
2806  * This function is used to destroy a channel iterator that was retrieved by
2807  * using one of the channel_iterator_xxx_new() functions.
2808  *
2809  * \return NULL, for convenience to clear out the pointer to the iterator that
2810  * was just destroyed.
2811  *
2812  * \since 1.8
2813  */
2814 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
2815
2816 /*!
2817  * \brief Create a new channel iterator based on extension
2818  *
2819  * \param exten The extension that channels must be in
2820  * \param context The context that channels must be in
2821  *
2822  * \details
2823  * After creating an iterator using this function, the ast_channel_iterator_next()
2824  * function can be used to iterate through all channels that are currently
2825  * in the specified context and extension.
2826  *
2827  * \note You must call ast_channel_iterator_destroy() when done.
2828  *
2829  * \retval NULL on failure
2830  * \retval a new channel iterator based on the specified parameters
2831  *
2832  * \since 1.8
2833  */
2834 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context);
2835
2836 /*!
2837  * \brief Create a new channel iterator based on name
2838  *
2839  * \param name channel name or channel uniqueid to match
2840  * \param name_len number of characters in the channel name to match on.  This
2841  *      would be used to match based on name prefix.  If matching on the full
2842  *      channel name is desired, then this parameter should be 0.
2843  *
2844  * \details
2845  * After creating an iterator using this function, the ast_channel_iterator_next()
2846  * function can be used to iterate through all channels that exist that have
2847  * the specified name or name prefix.
2848  *
2849  * \note You must call ast_channel_iterator_destroy() when done.
2850  *
2851  * \retval NULL on failure
2852  * \retval a new channel iterator based on the specified parameters
2853  *
2854  * \since 1.8
2855  */
2856 struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name, size_t name_len);
2857
2858 /*!
2859  * \brief Create a new channel iterator
2860  *
2861  * \details
2862  * After creating an iterator using this function, the ast_channel_iterator_next()
2863  * function can be used to iterate through all channels that exist.
2864  *
2865  * \note You must call ast_channel_iterator_destroy() when done.
2866  *
2867  * \retval NULL on failure
2868  * \retval a new channel iterator
2869  *
2870  * \since 1.8
2871  */
2872 struct ast_channel_iterator *ast_channel_iterator_all_new(void);
2873
2874 /*!
2875  * \brief Get the next channel for a channel iterator
2876  *
2877  * \param i the channel iterator that was created using one of the
2878  *  channel_iterator_xxx_new() functions.
2879  *
2880  * \details
2881  * This function should be used to iterate through all channels that match a
2882  * specified set of parameters that were provided when the iterator was created.
2883  *
2884  * \retval the next channel that matches the parameters used when the iterator
2885  *         was created.
2886  * \retval NULL, if no more channels match the iterator parameters.
2887  *
2888  * \since 1.8
2889  */
2890 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
2891
2892 /*! @} End channel iterator definitions. */
2893
2894 /*!
2895  * \brief Call a function with every active channel
2896  *
2897  * \details
2898  * This function executes a callback one time for each active channel on the
2899  * system.  The channel is provided as an argument to the function.
2900  *
2901  * \note Absolutely _NO_ channel locks should be held before calling this function.
2902  * \since 1.8
2903  */
2904 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
2905                 void *data, int ao2_flags);
2906
2907 /*! @{ Channel search functions */
2908
2909 /*!
2910  * \brief Find a channel by name
2911  *
2912  * \param name the name or uniqueid of the channel to search for
2913  *
2914  * \details
2915  * Find a channel that has the same name as the provided argument.
2916  *
2917  * \retval a channel with the name specified by the argument
2918  * \retval NULL if no channel was found
2919  *
2920  * \since 1.8
2921  */
2922 struct ast_channel *ast_channel_get_by_name(const char *name);
2923
2924 /*!
2925  * \brief Find a channel by a name prefix
2926  *
2927  * \param name The channel name or uniqueid prefix to search for
2928  * \param name_len Only search for up to this many characters from the name
2929  *
2930  * \details
2931  * Find a channel that has the same name prefix as specified by the arguments.
2932  *
2933  * \retval a channel with the name prefix specified by the arguments
2934  * \retval NULL if no channel was found
2935  *
2936  * \since 1.8
2937  */
2938 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
2939
2940 /*!
2941  * \brief Find a channel by extension and context
2942  *
2943  * \param exten the extension to search for
2944  * \param context the context to search for
2945  *
2946  * \details
2947  * Return a channel that is currently at the specified extension and context.
2948  *
2949  * \retval a channel that is at the specified extension and context
2950  * \retval NULL if no channel was found
2951  *
2952  * \since 1.8
2953  */
2954 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
2955
2956 /*! @} End channel search functions. */
2957
2958 /*!
2959  * \brief Initialize the given name structure.
2960  * \since 1.8
2961  *
2962  * \param init Name structure to initialize.
2963  *
2964  * \return Nothing
2965  */
2966 void ast_party_name_init(struct ast_party_name *init);
2967
2968 /*!
2969  * \brief Copy the source party name information to the destination party name.
2970  * \since 1.8
2971  *
2972  * \param dest Destination party name
2973  * \param src Source party name
2974  *
2975  * \return Nothing
2976  */
2977 void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src);
2978
2979 /*!
2980  * \brief Initialize the given party name structure using the given guide
2981  * for a set update operation.
2982  * \since 1.8
2983  *
2984  * \details
2985  * The initialization is needed to allow a set operation to know if a
2986  * value needs to be updated.  Simple integers need the guide's original
2987  * value in case the set operation is not trying to set a new value.
2988  * String values are simply set to NULL pointers if they are not going
2989  * to be updated.
2990  *
2991  * \param init Party name structure to initialize.
2992  * \param guide Source party name to use as a guide in initializing.
2993  *
2994  * \return Nothing
2995  */
2996 void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide);
2997
2998 /*!
2999  * \brief Set the source party name information into the destination party name.
3000  * \since 1.8
3001  *
3002  * \param dest The name one wishes to update
3003  * \param src The new name values to update the dest
3004  *
3005  * \return Nothing
3006  */
3007 void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src);
3008
3009 /*!
3010  * \brief Destroy the party name contents
3011  * \since 1.8
3012  *
3013  * \param doomed The party name to destroy.
3014  *
3015  * \return Nothing
3016  */
3017 void ast_party_name_free(struct ast_party_name *doomed);
3018
3019 /*!
3020  * \brief Initialize the given number structure.
3021  * \since 1.8
3022  *
3023  * \param init Number structure to initialize.
3024  *
3025  * \return Nothing
3026  */
3027 void ast_party_number_init(struct ast_party_number *init);
3028
3029 /*!
3030  * \brief Copy the source party number information to the destination party number.
3031  * \since 1.8
3032  *
3033  * \param dest Destination party number
3034  * \param src Source party number
3035  *
3036  * \return Nothing
3037  */
3038 void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src);
3039
3040 /*!
3041  * \brief Initialize the given party number structure using the given guide
3042  * for a set update operation.
3043  * \since 1.8
3044  *
3045  * \details
3046  * The initialization is needed to allow a set operation to know if a
3047  * value needs to be updated.  Simple integers need the guide's original
3048  * value in case the set operation is not trying to set a new value.
3049  * String values are simply set to NULL pointers if they are not going
3050  * to be updated.
3051  *
3052  * \param init Party number structure to initialize.
3053  * \param guide Source party number to use as a guide in initializing.
3054  *
3055  * \return Nothing
3056  */
3057 void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide);
3058
3059 /*!
3060  * \brief Set the source party number information into the destination party number.
3061  * \since 1.8
3062  *
3063  * \param dest The number one wishes to update
3064  * \param src The new number values to update the dest
3065  *
3066  * \return Nothing
3067  */
3068 void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src);
3069
3070 /*!
3071  * \brief Destroy the party number contents
3072  * \since 1.8
3073  *
3074  * \param doomed The party number to destroy.
3075  *
3076  * \return Nothing
3077  */
3078 void ast_party_number_free(struct ast_party_number *doomed);
3079
3080 /*!
3081  * \since 1.8
3082  * \brief Initialize the given subaddress structure.
3083  *
3084  * \param init Subaddress structure to initialize.
3085  *
3086  * \return Nothing
3087  */
3088 void ast_party_subaddress_init(struct ast_party_subaddress *init);
3089
3090 /*!
3091  * \since 1.8
3092  * \brief Copy the source party subaddress information to the destination party subaddress.
3093  *
3094  * \param dest Destination party subaddress
3095  * \param src Source party subaddress
3096  *
3097  * \return Nothing
3098  */
3099 void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
3100
3101 /*!
3102  * \since 1.8
3103  * \brief Initialize the given party subaddress structure using the given guide
3104  * for a set update operation.
3105  *
3106  * \details
3107  * The initialization is needed to allow a set operation to know if a
3108  * value needs to be updated.  Simple integers need the guide's original
3109  * value in case the set operation is not trying to set a new value.
3110  * String values are simply set to NULL pointers if they are not going
3111  * to be updated.
3112  *
3113  * \param init Party subaddress structure to initialize.
3114  * \param guide Source party subaddress to use as a guide in initializing.
3115  *
3116  * \return Nothing
3117  */
3118 void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide);
3119
3120 /*!
3121  * \since 1.8
3122  * \brief Set the source party subaddress information into the destination party subaddress.
3123  *
3124  * \param dest The subaddress one wishes to update
3125  * \param src The new subaddress values to update the dest
3126  *
3127  * \return Nothing
3128  */
3129 void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
3130
3131 /*!
3132  * \since 1.8
3133  * \brief Destroy the party subaddress contents
3134  *
3135  * \param doomed The party subaddress to destroy.
3136  *
3137  * \return Nothing
3138  */
3139 void ast_party_subaddress_free(struct ast_party_subaddress *doomed);
3140
3141 /*!
3142  * \brief Set the update marker to update all information of a corresponding party id.
3143  * \since 11.0
3144  *
3145  * \param update_id The update marker for a corresponding party id.
3146  *
3147  * \return Nothing
3148  */
3149 void ast_set_party_id_all(struct ast_set_party_id *update_id);
3150
3151 /*!
3152  * \brief Initialize the given party id structure.
3153  * \since 1.8
3154  *
3155  * \param init Party id structure to initialize.
3156  *
3157  * \return Nothing
3158  */
3159 void ast_party_id_init(struct ast_party_id *init);
3160
3161 /*!
3162  * \brief Copy the source party id information to the destination party id.
3163  * \since 1.8
3164  *
3165  * \param dest Destination party id
3166  * \param src Source party id
3167  *
3168  * \return Nothing
3169  */
3170 void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src);
3171
3172 /*!
3173  * \brief Initialize the given party id structure using the given guide
3174  * for a set update operation.
3175  * \since 1.8
3176  *
3177  * \details
3178  * The initialization is needed to allow a set operation to know if a
3179  * value needs to be updated.  Simple integers need the guide's original
3180  * value in case the set operation is not trying to set a new value.
3181  * String values are simply set to NULL pointers if they are not going
3182  * to be updated.
3183  *
3184  * \param init Party id structure to initialize.
3185  * \param guide Source party id to use as a guide in initializing.
3186  *
3187  * \return Nothing
3188  */
3189 void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide);
3190
3191 /*!
3192  * \brief Set the source party id information into the destination party id.
3193  * \since 1.8
3194  *
3195  * \param dest The id one wishes to update
3196  * \param src The new id values to update the dest
3197  * \param update What id information to update.  NULL if all.
3198  *
3199  * \return Nothing
3200  */
3201 void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update);
3202
3203 /*!
3204  * \brief Destroy the party id contents
3205  * \since 1.8
3206  *
3207  * \param doomed The party id to destroy.
3208  *
3209  * \return Nothing
3210  */
3211 void ast_party_id_free(struct ast_party_id *doomed);
3212
3213 /*!
3214  * \brief Determine the overall presentation value for the given party.
3215  * \since 1.8
3216  *
3217  * \param id Party to determine the overall presentation value.
3218  *
3219  * \return Overall presentation value for the given party.
3220  */
3221 int ast_party_id_presentation(const struct ast_party_id *id);
3222
3223 /*!
3224  * \brief Invalidate all components of the given party id.
3225  * \since 11.0
3226  *
3227  * \param id The party id to invalidate.
3228  *
3229  * \return Nothing
3230  */
3231 void ast_party_id_invalidate(struct ast_party_id *id);
3232
3233 /*!
3234  * \brief Destroy and initialize the given party id structure.
3235  * \since 11.0
3236  *
3237  * \param id The party id to reset.
3238  *
3239  * \return Nothing
3240  */
3241 void ast_party_id_reset(struct ast_party_id *id);
3242
3243 /*!
3244  * \brief Merge a given party id into another given party id.
3245  * \since 11.0
3246  *
3247  * \details
3248  * This function will generate an effective party id.
3249  *
3250  * Each party id component of the party id 'base' is overwritten
3251  * by components of the party id 'overlay' if the overlay
3252  * component is marked as valid.  However the component 'tag' of
3253  * the base party id remains untouched.
3254  *
3255  * \param base The party id which is merged.
3256  * \param overlay The party id which is used to merge into.
3257  *
3258  * \return The merged party id as a struct, not as a pointer.
3259  * \note The merged party id returned is a shallow copy and must not be freed.
3260  */
3261 struct ast_party_id ast_party_id_merge(struct ast_party_id *base, struct ast_party_id *overlay);
3262
3263 /*!
3264  * \brief Copy a merge of a given party id into another given party id to a given destination party id.
3265  * \since 11.0
3266  *
3267  * \details
3268  * Each party id component of the party id 'base' is overwritten by components
3269  * of the party id 'overlay' if the 'overlay' component is marked as valid.
3270  * However the component 'tag' of the 'base' party id remains untouched.
3271  * The result is copied into the given party id 'dest'.
3272  *
3273  * \note The resulting merged party id is a real copy and has to be freed.
3274  *
3275  * \param dest The resulting merged party id.
3276  * \param base The party id which is merged.
3277  * \param overlay The party id which is used to merge into.
3278  *
3279  * \return Nothing
3280  */
3281 void ast_party_id_merge_copy(struct ast_party_id *dest, struct ast_party_id *base, struct ast_party_id *overlay);
3282
3283 /*!
3284  * \brief Initialize the given dialed structure.
3285  * \since 1.8
3286  *
3287  * \param init Dialed structure to initialize.
3288  *
3289  * \return Nothing
3290  */
3291 void ast_party_dialed_init(struct ast_party_dialed *init);
3292
3293 /*!
3294  * \brief Copy the source dialed party information to the destination dialed party.
3295  * \since 1.8
3296  *
3297  * \param dest Destination dialed party
3298  * \param src Source dialed party
3299  *
3300  * \return Nothing
3301  */
3302 void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3303
3304 /*!
3305  * \brief Initialize the given dialed structure using the given
3306  * guide for a set update operation.
3307  * \since 1.8
3308  *
3309  * \details
3310  * The initialization is needed to allow a set operation to know if a
3311  * value needs to be updated.  Simple integers need the guide's original
3312  * value in case the set operation is not trying to set a new value.
3313  * String values are simply set to NULL pointers if they are not going
3314  * to be updated.
3315  *
3316  * \param init Caller structure to initialize.
3317  * \param guide Source dialed to use as a guide in initializing.
3318  *
3319  * \return Nothing
3320  */
3321 void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide);
3322
3323 /*!
3324  * \brief Set the dialed information based on another dialed source
3325  * \since 1.8
3326  *
3327  * This is similar to ast_party_dialed_copy, except that NULL values for
3328  * strings in the src parameter indicate not to update the corresponding dest values.
3329  *
3330  * \param dest The dialed one wishes to update
3331  * \param src The new dialed values to update the dest
3332  *
3333  * \return Nada
3334  */
3335 void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3336
3337 /*!
3338  * \brief Destroy the dialed party contents
3339  * \since 1.8
3340  *
3341  * \param doomed The dialed party to destroy.
3342  *
3343  * \return Nothing
3344  */
3345 void ast_party_dialed_free(struct ast_party_dialed *doomed);
3346
3347 /*!
3348  * \since 1.8
3349  * \brief Initialize the given caller structure.
3350  *
3351  * \param init Caller structure to initialize.
3352  *
3353  * \return Nothing
3354  */
3355 void ast_party_caller_init(struct ast_party_caller *init);
3356
3357 /*!
3358  * \since 1.8
3359  * \brief Copy the source caller information to the destination caller.
3360  *
3361  * \param dest Destination caller
3362  * \param src Source caller
3363  *
3364  * \return Nothing
3365  */
3366 void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src);
3367
3368 /*!
3369  * \brief Initialize the given caller structure using the given
3370  * guide for a set update operation.
3371  * \since 1.8
3372  *
3373  * \details
3374  * The initialization is needed to allow a set operation to know if a
3375  * value needs to be updated.  Simple integers need the guide's original
3376  * value in case the set operation is not trying to set a new value.
3377  * String values are simply set to NULL pointers if they are not going
3378  * to be updated.
3379  *
3380  * \param init Caller structure to initialize.
3381  * \param guide Source caller to use as a guide in initializing.
3382  *
3383  * \return Nothing
3384  */
3385 void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide);
3386
3387 /*!
3388  * \brief Set the caller information based on another caller source
3389  * \since 1.8
3390  *
3391  * This is similar to ast_party_caller_copy, except that NULL values for
3392  * strings in the src parameter indicate not to update the corresponding dest values.
3393  *
3394  * \param dest The caller one wishes to update
3395  * \param src The new caller values to update the dest
3396  * \param update What caller information to update.  NULL if all.
3397  *
3398  * \return Nada
3399  */
3400 void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update);
3401
3402 /*!
3403  * \brief Destroy the caller party contents
3404  * \since 1.8
3405  *
3406  * \param doomed The caller party to destroy.
3407  *
3408  * \return Nothing
3409  */
3410 void ast_party_caller_free(struct ast_party_caller *doomed);
3411
3412 /*!
3413  * \since 1.8
3414  * \brief Initialize the given connected line structure.
3415  *
3416  * \param init Connected line structure to initialize.
3417  *
3418  * \return Nothing
3419  */
3420 void ast_party_connected_line_init(struct ast_party_connected_line *init);
3421
3422 /*!
3423  * \since 1.8
3424  * \brief Copy the source connected line information to the destination connected line.
3425  *
3426  * \param dest Destination connected line
3427  * \param src Source connected line
3428  *
3429  * \return Nothing
3430  */
3431 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
3432
3433 /*!
3434  * \since 1.8
3435  * \brief Initialize the given connected line structure using the given
3436  * guide for a set update operation.
3437  *
3438  * \details
3439  * The initialization is needed to allow a set operation to know if a
3440  * value needs to be updated.  Simple integers need the guide's original
3441  * value in case the set operation is not trying to set a new value.
3442  * String values are simply set to NULL pointers if they are not going
3443  * to be updated.
3444  *
3445  * \param init Connected line structure to initialize.
3446  * \param guide Source connected line to use as a guide in initializing.
3447  *
3448  * \return Nothing
3449  */
3450 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
3451
3452 /*!
3453  * \since 1.8
3454  * \brief Set the connected line information based on another connected line source
3455  *
3456  * This is similar to ast_party_connected_line_copy, except that NULL values for
3457  * strings in the src parameter indicate not to update the corresponding dest values.
3458  *
3459  * \param dest The connected line one wishes to update
3460  * \param src The new connected line values to update the dest
3461  * \param update What connected line information to update.  NULL if all.
3462  *
3463  * \return Nothing
3464  */
3465 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);
3466
3467 /*!
3468  * \since 1.8
3469  * \brief Collect the caller party information into a connected line structure.
3470  *
3471  * \param connected Collected caller information for the connected line
3472  * \param caller Caller information.
3473  *
3474  * \return Nothing
3475  *
3476  * \warning This is a shallow copy.
3477  * \warning DO NOT call ast_party_connected_line_free() on the filled in
3478  * connected line structure!
3479  */
3480 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller);
3481
3482 /*!
3483  * \since 1.8
3484  * \brief Destroy the connected line information contents
3485  *
3486  * \param doomed The connected line information to destroy.
3487  *
3488  * \return Nothing
3489  */
3490 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
3491
3492 /*!
3493  * \brief Initialize the given redirecting reason structure
3494  *
3495  * \param init Redirecting reason structure to initialize
3496  *
3497  * \return Nothing
3498  */
3499 void ast_party_redirecting_reason_init(struct ast_party_redirecting_reason *init);
3500
3501 /*!
3502  * \brief Copy the source redirecting reason information to the destination redirecting reason.
3503  *
3504  * \param dest Destination redirecting reason
3505  * \param src Source redirecting reason
3506  *
3507  * \return Nothing
3508  */
3509 void ast_party_redirecting_reason_copy(struct ast_party_redirecting_reason *dest,
3510                 const struct ast_party_redirecting_reason *src);
3511
3512 /*!
3513  * \brief Initialize the given redirecting reason structure using the given guide
3514  * for a set update operation.
3515  *
3516  * \details
3517  * The initialization is needed to allow a set operation to know if a
3518  * value needs to be updated.  Simple integers need the guide's original
3519  * value in case the set operation is not trying to set a new value.
3520  * String values are simply set to NULL pointers if they are not going
3521  * to be updated.
3522  *
3523  * \param init Redirecting reason structure to initialize.
3524  * \param guide Source redirecting reason to use as a guide in initializing.
3525  *
3526  * \return Nothing
3527  */
3528 void ast_party_redirecting_reason_set_init(struct ast_party_redirecting_reason *init,
3529                 const struct ast_party_redirecting_reason *guide);
3530
3531 /*!
3532  * \brief Set the redirecting reason information based on another redirecting reason source
3533  *
3534  * This is similar to ast_party_redirecting_reason_copy, except that NULL values for
3535  * strings in the src parameter indicate not to update the corresponding dest values.
3536  *
3537  * \param dest The redirecting reason one wishes to update
3538  * \param src The new redirecting reason values to update the dest
3539  *
3540  * \return Nothing
3541  */
3542 void ast_party_redirecting_reason_set(struct ast_party_redirecting_reason *dest,
3543                 const struct ast_party_redirecting_reason *src);
3544
3545 /*!
3546  * \brief Destroy the redirecting reason contents
3547  *
3548  * \param doomed The redirecting reason to destroy.
3549  *
3550  * \return Nothing
3551  */
3552 void ast_party_redirecting_reason_free(struct ast_party_redirecting_reason *doomed);
3553
3554 /*!
3555  * \brief Initialize the given redirecting structure.
3556  * \since 1.8
3557  *
3558  * \param init Redirecting structure to initialize.
3559  *
3560  * \return Nothing
3561  */
3562 void ast_party_redirecting_init(struct ast_party_redirecting *init);
3563
3564 /*!
3565  * \since 1.8
3566  * \brief Copy the source redirecting information to the destination redirecting.
3567  *
3568  * \param dest Destination redirecting
3569  * \param src Source redirecting
3570  *
3571  * \return Nothing
3572  */
3573 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
3574
3575 /*!
3576  * \since 1.8
3577  * \brief Initialize the given redirecting id structure using the given guide
3578  * for a set update operation.
3579  *
3580  * \details
3581  * The initialization is needed to allow a set operation to know if a
3582  * value needs to be updated.  Simple integers need the guide's original
3583  * value in case the set operation is not trying to set a new value.
3584  * String values are simply set to NULL pointers if they are not going
3585  * to be updated.
3586  *
3587  * \param init Redirecting id structure to initialize.
3588  * \param guide Source redirecting id to use as a guide in initializing.
3589  *
3590  * \return Nothing
3591  */
3592 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
3593
3594 /*!
3595  * \brief Set the redirecting information based on another redirecting source
3596  * \since 1.8
3597  *
3598  * This is similar to ast_party_redirecting_copy, except that NULL values for
3599  * strings in the src parameter indicate not to update the corresponding dest values.
3600  *
3601  * \param dest The redirecting one wishes to update
3602  * \param src The new redirecting values to update the dest
3603  * \param update What redirecting information to update.  NULL if all.
3604  *
3605  * \return Nothing
3606  */
3607 void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update);
3608
3609 /*!
3610  * \since 1.8
3611  * \brief Destroy the redirecting information contents
3612  *
3613  * \param doomed The redirecting information to destroy.
3614  *
3615  * \return Nothing
3616  */
3617 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
3618
3619 /*!
3620  * \since 1.8
3621  * \brief Copy the caller information to the connected line information.
3622  *
3623  * \param dest Destination connected line information
3624  * \param src Source caller information
3625  *
3626  * \return Nothing
3627  *
3628  * \note Assumes locks are already acquired
3629  */
3630 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src);
3631
3632 /*!
3633  * \since 1.8
3634  * \brief Copy the connected line information to the caller information.
3635  *
3636  * \param dest Destination caller information
3637  * \param src Source connected line information
3638  *
3639  * \return Nothing
3640  *
3641  * \note Assumes locks are already acquired
3642  */
3643 void ast_connected_line_copy_to_caller(struct ast_party_caller *dest, const struct ast_party_connected_line *src);
3644
3645 /*!
3646  * \since 1.8
3647  * \brief Set the connected line information in the Asterisk channel
3648  *
3649  * \param chan Asterisk channel to set connected line information
3650  * \param connected Connected line information
3651  * \param update What connected line information to update.  NULL if all.
3652  *
3653  * \return Nothing
3654  *
3655  * \note The channel does not need to be locked before calling this function.
3656  */
3657 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);
3658
3659 /*!
3660  * \since 1.8
3661  * \brief Build the connected line information data frame.
3662  *
3663  * \param data Buffer to fill with the frame data
3664  * \param datalen Size of the buffer to fill
3665  * \param connected Connected line information
3666  * \param update What connected line information to build.  NULL if all.
3667  *
3668  * \retval -1 if error
3669  * \retval Amount of data buffer used
3670  */
3671 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);
3672
3673 /*!
3674  * \since 1.8
3675  * \brief Parse connected line indication frame data
3676  *
3677  * \param data Buffer with the frame data to parse
3678  * \param datalen Size of the buffer
3679  * \param connected Extracted connected line information
3680  *
3681  * \retval 0 on success.
3682  * \retval -1 on error.
3683  *
3684  * \note The filled in connected line structure needs to be initialized by
3685  * ast_party_connected_line_set_init() before calling.  If defaults are not
3686  * required use ast_party_connected_line_init().
3687  * \note The filled in connected line structure needs to be destroyed by
3688  * ast_party_connected_line_free() when it is no longer needed.
3689  */
3690 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
3691
3692 /*!
3693  * \since 1.8
3694  * \brief Indicate that the connected line information has changed
3695  *
3696  * \param chan Asterisk channel to indicate connected line information
3697  * \param connected Connected line information
3698  * \param update What connected line information to update.  NULL if all.
3699  *
3700  * \return Nothing
3701  */
3702 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);
3703
3704 /*!
3705  * \since 1.8
3706  * \brief Queue a connected line update frame on a channel
3707  *
3708  * \param chan Asterisk channel to indicate connected line information
3709  * \param connected Connected line information
3710  * \param update What connected line information to update.  NULL if all.
3711  *
3712  * \return Nothing
3713  */
3714 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);
3715
3716 /*!
3717  * \since 1.8
3718  * \brief Set the redirecting id information in the Asterisk channel
3719  *
3720  * \param chan Asterisk channel to set redirecting id information
3721  * \param redirecting Redirecting id information
3722  * \param update What redirecting information to update.  NULL if all.
3723  *
3724  * \return Nothing
3725  *
3726  * \note The channel does not need to be locked before calling this function.
3727  */
3728 void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3729
3730 /*!
3731  * \since 1.8
3732  * \brief Build the redirecting id data frame.
3733  *
3734  * \param data Buffer to fill with the frame data
3735  * \param datalen Size of the buffer to fill
3736  * \param redirecting Redirecting id information
3737  * \param update What redirecting information to build.  NULL if all.
3738  *
3739  * \retval -1 if error
3740  * \retval Amount of data buffer used
3741  */
3742 int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3743
3744 /*!
3745  * \since 1.8
3746  * \brief Parse redirecting indication frame data
3747  *
3748  * \param data Buffer with the frame data to parse
3749  * \param datalen Size of the buffer
3750  * \param redirecting Extracted redirecting id information
3751  *
3752  * \retval 0 on success.
3753  * \retval -1 on error.
3754  *
3755  * \note The filled in id structure needs to be initialized by
3756  * ast_party_redirecting_set_init() before calling.
3757  * \note The filled in id structure needs to be destroyed by
3758  * ast_party_redirecting_free() when it is no longer needed.
3759  */
3760 int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
3761
3762 /*!
3763  * \since 1.8
3764  * \brief Indicate that the redirecting id has changed
3765  *
3766  * \param chan Asterisk channel to indicate redirecting id information
3767  * \param redirecting Redirecting id information
3768  * \param update What redirecting information to update.  NULL if all.
3769  *
3770  * \return Nothing
3771  */
3772 void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3773
3774 /*!
3775  * \since 1.8
3776  * \brief Queue a redirecting update frame on a channel
3777  *
3778  * \param chan Asterisk channel to indicate redirecting id information
3779  * \param redirecting Redirecting id information
3780  * \param update What redirecting information to update.  NULL if all.
3781  *
3782  * \return Nothing
3783  */
3784 void ast_channel_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3785
3786 /*!
3787  * \since 1.8
3788  * \brief Run a connected line interception macro and update a channel's connected line
3789  * information
3790  * \deprecated You should use the ast_channel_connected_line_sub() function instead.
3791  *
3792  * Whenever we want to update a channel's connected line information, we may need to run
3793  * a macro so that an administrator can manipulate the information before sending it
3794  * out. This function both runs the macro and sends the update to the channel.
3795  *
3796  * \param autoservice_chan Channel to place into autoservice while the macro is running.
3797  * It is perfectly safe for this to be NULL
3798  * \param macro_chan The channel to run the macro on. Also the channel from which we
3799  * determine which macro we need to run.
3800  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3801  * AST_CONTROL_CONNECTED_LINE
3802  * \param is_caller If true, then run CONNECTED_LINE_CALLER_SEND_MACRO with arguments from
3803  * CONNECTED_LINE_CALLER_SEND_MACRO_ARGS, otherwise run CONNECTED_LINE_CALLEE_SEND_MACRO
3804  * with arguments from CONNECTED_LINE_CALLEE_SEND_MACRO_ARGS
3805  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3806  * ast_party_connected_line pointer.
3807  * \retval 0 Success
3808  * \retval -1 Either the macro does not exist, or there was an error while attempting to
3809  * run the macro
3810  *
3811  * \todo Have multiple return codes based on the MACRO_RESULT
3812  * \todo Make constants so that caller and frame can be more expressive than just '1' and
3813  * '0'
3814  */
3815 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);
3816
3817 /*!
3818  * \since 11
3819  * \brief Run a connected line interception subroutine and update a channel's connected line
3820  * information
3821  *
3822  * Whenever we want to update a channel's connected line information, we may need to run
3823  * a subroutine so that an administrator can manipulate the information before sending it
3824  * out. This function both runs the subroutine specified by CONNECTED_LINE_SEND_SUB and
3825  * sends the update to the channel.
3826  *
3827  * \param autoservice_chan Channel to place into autoservice while the sub is running.
3828  * It is perfectly safe for this to be NULL
3829  * \param sub_chan The channel to run the subroutine on. Also the channel from which we
3830  * determine which subroutine we need to run.
3831  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3832  * AST_CONTROL_CONNECTED_LINE
3833  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3834  * ast_party_connected_line pointer.
3835  * \retval 0 Success
3836  * \retval -1 Either the subroutine does not exist, or there was an error while attempting to
3837  * run the subroutine
3838  */
3839 int ast_channel_connected_line_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *connected_info, int frame);
3840
3841 /*!
3842  * \brief Insert into an astdata tree, the channel structure.
3843  * \param[in] tree The ast data tree.
3844  * \param[in] chan The channel structure to add to tree.
3845  * \param[in] add_bridged Add the bridged channel to the structure.
3846  * \retval <0 on error.
3847  * \retval 0 on success.
3848  */
3849 int ast_channel_data_add_structure(struct ast_data *tree, struct ast_channel *chan, int add_bridged);
3850
3851 /*!
3852  * \brief Compare to channel structures using the data api.
3853  * \param[in] tree The search tree generated by the data api.
3854  * \param[in] chan The channel to compare.
3855  * \param[in] structure_name The name of the node of the channel structure.
3856  * \retval 0 The structure matches.
3857  * \retval 1 The structure doesn't matches.
3858  */
3859 int ast_channel_data_cmp_structure(const struct ast_data_search *tree, struct ast_channel *chan,
3860         const char *structure_name);
3861
3862 /*!
3863  * \since 1.8
3864  * \brief Run a redirecting interception macro and update a channel's redirecting information
3865  * \deprecated You should use the ast_channel_redirecting_sub() function instead.
3866  *
3867  * \details
3868  * Whenever we want to update a channel's redirecting information, we may need to run
3869  * a macro so that an administrator can manipulate the information before sending it
3870  * out. This function both runs the macro and sends the update to the channel.
3871  *
3872  * \param autoservice_chan Channel to place into autoservice while the macro is running.
3873  * It is perfectly safe for this to be NULL
3874  * \param macro_chan The channel to run the macro on. Also the channel from which we
3875  * determine which macro we need to run.
3876  * \param redirecting_info Either an ast_party_redirecting or ast_frame pointer of type
3877  * AST_CONTROL_REDIRECTING
3878  * \param is_caller If true, then run REDIRECTING_CALLER_SEND_MACRO with arguments from
3879  * REDIRECTING_CALLER_SEND_MACRO_ARGS, otherwise run REDIRECTING_CALLEE_SEND_MACRO with
3880  * arguments from REDIRECTING_CALLEE_SEND_MACRO_ARGS
3881  * \param is_frame If true, then redirecting_info is an ast_frame pointer, otherwise it is an
3882  * ast_party_redirecting pointer.
3883  *
3884  * \retval 0 Success
3885  * \retval -1 Either the macro does not exist, or there was an error while attempting to
3886  * run the macro
3887  *
3888  * \todo Have multiple return codes based on the MACRO_RESULT
3889  * \todo Make constants so that caller and frame can be more expressive than just '1' and
3890  * '0'
3891  */
3892 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);
3893
3894 /*!
3895  * \since 11
3896  * \brief Run a redirecting interception subroutine and update a channel's redirecting information
3897  *
3898  * \details
3899  * Whenever we want to update a channel's redirecting information, we may need to run
3900  * a subroutine so that an administrator can manipulate the information before sending it
3901  * out. This function both runs the subroutine specified by REDIRECTING_SEND_SUB and
3902  * sends the update to the channel.
3903  *
3904  * \param autoservice_chan Channel to place into autoservice while the subroutine is running.
3905  * It is perfectly safe for this to be NULL
3906  * \param sub_chan The channel to run the subroutine on. Also the channel from which we
3907  * determine which subroutine we need to run.
3908  * \param redirecting_info Either an ast_party_redirecting or ast_frame pointer of type
3909  * AST_CONTROL_REDIRECTING
3910  * \param is_frame If true, then redirecting_info is an ast_frame pointer, otherwise it is an
3911  * ast_party_redirecting pointer.
3912  *
3913  * \retval 0 Success
3914  * \retval -1 Either the subroutine does not exist, or there was an error while attempting to
3915  * run the subroutine
3916  */
3917 int ast_channel_redirecting_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *redirecting_info, int is_frame);
3918
3919 #include "asterisk/ccss.h"
3920
3921 /*!
3922  * \since 1.8
3923  * \brief Set up datastore with CCSS parameters for a channel
3924  *
3925  * \note
3926  * If base_params is NULL, the channel will get the default
3927  * values for all CCSS parameters.
3928  *
3929  * \details
3930  * This function makes use of datastore operations on the channel, so
3931  * it is important to lock the channel before calling this function.
3932  *
3933  * \param chan The channel to create the datastore on
3934  * \param base_params CCSS parameters we wish to copy into the channel
3935  * \retval 0 Success
3936  * \retval -1 Failure
3937  */
3938 int ast_channel_cc_params_init(struct ast_channel *chan,
3939                 const struct ast_cc_config_params *base_params);
3940
3941 /*!
3942  * \since 1.8
3943  * \brief Get the CCSS parameters from a channel
3944  *
3945  * \details
3946  * This function makes use of datastore operations on the channel, so
3947  * it is important to lock the channel before calling this function.
3948  *
3949  * \param chan Channel to retrieve parameters from
3950  * \retval NULL Failure
3951  * \retval non-NULL The parameters desired
3952  */
3953 struct ast_cc_config_params *ast_channel_get_cc_config_params(struct ast_channel *chan);
3954
3955
3956 /*!
3957  * \since 1.8
3958  * \brief Get a device name given its channel structure
3959  *
3960  * \details
3961  * A common practice in Asterisk is to determine the device being talked
3962  * to by dissecting the channel name. For certain channel types, this is not
3963  * accurate. For instance, an ISDN channel is named based on what B channel is
3964  * used, not the device being communicated with.
3965  *
3966  * This function interfaces with a channel tech's queryoption callback to
3967  * retrieve the name of the device being communicated with. If the channel does not
3968  * implement this specific option, then the traditional method of using the channel
3969  * name is used instead.
3970  *
3971  * \param chan The channel to retrieve the information from
3972  * \param[out] device_name The buffer to place the device's name into
3973  * \param name_buffer_length The allocated space for the device_name
3974  * \return 0 always
3975  */
3976 int ast_channel_get_device_name(struct ast_channel *chan, char *device_name, size_t name_buffer_length);
3977
3978 /*!
3979  * \since 1.8
3980  * \brief Find the appropriate CC agent type to use given a channel
3981  *
3982  * \details
3983  * During call completion, we will need to create a call completion agent structure. To
3984  * figure out the type of agent to construct, we need to ask the channel driver for the
3985  * appropriate type.
3986  *
3987  * Prior to adding this function, the call completion core attempted to figure this
3988  * out for itself by stripping the technology off the channel's name. However, in the
3989  * case of chan_dahdi, there are multiple agent types registered, and so simply searching
3990  * for an agent type called "DAHDI" is not possible. In a case where multiple agent types
3991  * are defined, the channel driver must have a queryoption callback defined in its
3992  * channel_tech, and the queryoption callback must handle AST_OPTION_CC_AGENT_TYPE
3993  *
3994  * If a channel driver does not have a queryoption callback or if the queryoption callback
3995  * does not handle AST_OPTION_CC_AGENT_TYPE, then the old behavior of using the technology
3996  * portion of the channel name is used instead. This is perfectly suitable for channel drivers
3997  * whose channel technologies are a one-to-one match with the agent types defined within.
3998  *
3999  * Note that this function is only called when the agent policy on a given channel is set
4000  * to "native." Generic agents' type can be determined automatically by the core.
4001  *
4002  * \param chan The channel for which we wish to retrieve the agent type
4003  * \param[out] agent_type The type of agent the channel driver wants us to use
4004  * \param size The size of the buffer to write to
4005  */
4006 int ast_channel_get_cc_agent_type(struct ast_channel *chan, char *agent_type, size_t size);
4007 #if defined(__cplusplus) || defined(c_plusplus)
4008 }
4009 #endif
4010
4011 /*!
4012  * \brief Remove a channel from the global channels container
4013  *
4014  * \param chan channel to remove
4015  *
4016  * In a case where it is desired that a channel not be available in any lookups
4017  * in the global channels conatiner, use this function.
4018  */
4019 void ast_channel_unlink(struct ast_channel *chan);
4020
4021 /*!
4022  * \brief Sets the HANGUPCAUSE hash and optionally the SIP_CAUSE hash
4023  * on the given channel
4024  *
4025  * \param chan channel on which to set the cause information
4026  * \param cause_code ast_control_pvt_cause_code structure containing cause information
4027  * \param datalen total length of the structure since it may vary
4028  */
4029 void ast_channel_hangupcause_hash_set(struct ast_channel *chan, const struct ast_control_pvt_cause_code *cause_code, int datalen);
4030
4031 /*!
4032  * \since 12
4033  * \brief Convert a string to a detail record AMA flag
4034  *
4035  * \param flag string form of flag
4036  *
4037  * \retval the enum (integer) form of the flag
4038  */
4039 enum ama_flags ast_channel_string2amaflag(const char *flag);
4040
4041 /*!
4042  * \since 12
4043  * \brief Convert the enum representation of an AMA flag to a string representation
4044  *
4045  * \param flags integer flag
4046  *
4047  * \retval A string representation of the flag
4048  */
4049 const char *ast_channel_amaflags2string(enum ama_flags flags);
4050
4051 enum AST_MONITORING_STATE {
4052         AST_MONITOR_RUNNING,
4053         AST_MONITOR_PAUSED
4054 };
4055
4056 /*! Responsible for channel monitoring data */
4057 struct ast_channel_monitor {
4058         struct ast_filestream *read_stream;
4059         struct ast_filestream *write_stream;
4060         char read_filename[FILENAME_MAX];
4061         char write_filename[FILENAME_MAX];
4062         char filename_base[FILENAME_MAX];
4063         char beep_id[64];
4064         int filename_changed;
4065         char *format;
4066         int joinfiles;
4067         enum AST_MONITORING_STATE state;
4068         int (*stop)(struct ast_channel *chan, int need_lock);
4069 };
4070
4071 /* ACCESSOR FUNTIONS */
4072 /*! \brief Set the channel name */
4073 void ast_channel_name_set(struct ast_channel *chan, const char *na