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