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