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