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