00001 /* 00002 * Asterisk -- An open source telephony toolkit. 00003 * 00004 * Copyright (C) 1999 - 2006, Digium, Inc. 00005 * 00006 * Mark Spencer <markster@digium.com> 00007 * 00008 * See http://www.asterisk.org for more information about 00009 * the Asterisk project. Please do not directly contact 00010 * any of the maintainers of this project for assistance; 00011 * the project provides a web site, mailing lists and IRC 00012 * channels for your use. 00013 * 00014 * This program is free software, distributed under the terms of 00015 * the GNU General Public License Version 2. See the LICENSE file 00016 * at the top of the source tree. 00017 */ 00018 00019 /*! \file 00020 * \brief General Asterisk PBX channel definitions. 00021 * \par See also: 00022 * \arg \ref Def_Channel 00023 * \arg \ref channel_drivers 00024 */ 00025 00026 /*! \page Def_Channel Asterisk Channels 00027 \par What is a Channel? 00028 A phone call through Asterisk consists of an incoming 00029 connection and an outbound connection. Each call comes 00030 in through a channel driver that supports one technology, 00031 like SIP, ZAP, IAX2 etc. 00032 \par 00033 Each channel driver, technology, has it's own private 00034 channel or dialog structure, that is technology-dependent. 00035 Each private structure is "owned" by a generic Asterisk 00036 channel structure, defined in channel.h and handled by 00037 channel.c . 00038 \par Call scenario 00039 This happens when an incoming call arrives to Asterisk 00040 -# Call arrives on a channel driver interface 00041 -# Channel driver creates a PBX channel and starts a 00042 pbx thread on the channel 00043 -# The dial plan is executed 00044 -# At this point at least two things can happen: 00045 -# The call is answered by Asterisk and 00046 Asterisk plays a media stream or reads media 00047 -# The dial plan forces Asterisk to create an outbound 00048 call somewhere with the dial (see \ref app_dial.c) 00049 application 00050 . 00051 00052 \par Bridging channels 00053 If Asterisk dials out this happens: 00054 -# Dial creates an outbound PBX channel and asks one of the 00055 channel drivers to create a call 00056 -# When the call is answered, Asterisk bridges the media streams 00057 so the caller on the first channel can speak with the callee 00058 on the second, outbound channel 00059 -# In some cases where we have the same technology on both 00060 channels and compatible codecs, a native bridge is used. 00061 In a native bridge, the channel driver handles forwarding 00062 of incoming audio to the outbound stream internally, without 00063 sending audio frames through the PBX. 00064 -# In SIP, theres an "external native bridge" where Asterisk 00065 redirects the endpoint, so audio flows directly between the 00066 caller's phone and the callee's phone. Signalling stays in 00067 Asterisk in order to be able to provide a proper CDR record 00068 for the call. 00069 00070 00071 \par Masquerading channels 00072 In some cases, a channel can masquerade itself into another 00073 channel. This happens frequently in call transfers, where 00074 a new channel takes over a channel that is already involved 00075 in a call. The new channel sneaks in and takes over the bridge 00076 and the old channel, now a zombie, is hung up. 00077 00078 \par Reference 00079 \arg channel.c - generic functions 00080 \arg channel.h - declarations of functions, flags and structures 00081 \arg translate.h - Transcoding support functions 00082 \arg \ref channel_drivers - Implemented channel drivers 00083 \arg \ref Def_Frame Asterisk Multimedia Frames 00084 00085 */ 00086 00087 #ifndef _ASTERISK_CHANNEL_H 00088 #define _ASTERISK_CHANNEL_H 00089 00090 #include "asterisk/abstract_jb.h" 00091 00092 #include <unistd.h> 00093 #ifdef POLLCOMPAT 00094 #include "asterisk/poll-compat.h" 00095 #else 00096 #include <sys/poll.h> 00097 #endif 00098 00099 #if defined(__cplusplus) || defined(c_plusplus) 00100 extern "C" { 00101 #endif 00102 00103 #define AST_MAX_EXTENSION 80 /*!< Max length of an extension */ 00104 #define AST_MAX_CONTEXT 80 /*!< Max length of a context */ 00105 #define AST_CHANNEL_NAME 80 /*!< Max length of an ast_channel name */ 00106 #define MAX_LANGUAGE 20 /*!< Max length of the language setting */ 00107 #define MAX_MUSICCLASS 80 /*!< Max length of the music class setting */ 00108 00109 #include "asterisk/compat.h" 00110 #include "asterisk/frame.h" 00111 #include "asterisk/sched.h" 00112 #include "asterisk/chanvars.h" 00113 #include "asterisk/config.h" 00114 #include "asterisk/lock.h" 00115 #include "asterisk/cdr.h" 00116 #include "asterisk/utils.h" 00117 #include "asterisk/linkedlists.h" 00118 #include "asterisk/stringfields.h" 00119 #include "asterisk/compiler.h" 00120 00121 #define DATASTORE_INHERIT_FOREVER INT_MAX 00122 00123 #define AST_MAX_FDS 8 00124 /* 00125 * We have AST_MAX_FDS file descriptors in a channel. 00126 * Some of them have a fixed use: 00127 */ 00128 #define AST_ALERT_FD (AST_MAX_FDS-1) /*!< used for alertpipe */ 00129 #define AST_TIMING_FD (AST_MAX_FDS-2) /*!< used for timingfd */ 00130 #define AST_AGENT_FD (AST_MAX_FDS-3) /*!< used by agents for pass through */ 00131 #define AST_GENERATOR_FD (AST_MAX_FDS-4) /*!< used by generator */ 00132 00133 enum ast_bridge_result { 00134 AST_BRIDGE_COMPLETE = 0, 00135 AST_BRIDGE_FAILED = -1, 00136 AST_BRIDGE_FAILED_NOWARN = -2, 00137 AST_BRIDGE_RETRY = -3, 00138 }; 00139 00140 typedef unsigned long long ast_group_t; 00141 00142 struct ast_generator { 00143 void *(*alloc)(struct ast_channel *chan, void *params); 00144 void (*release)(struct ast_channel *chan, void *data); 00145 /*! This function gets called with the channel unlocked, but is called in 00146 * the context of the channel thread so we know the channel is not going 00147 * to disappear. This callback is responsible for locking the channel as 00148 * necessary. */ 00149 int (*generate)(struct ast_channel *chan, void *data, int len, int samples); 00150 }; 00151 00152 /*! \brief Structure for a data store type */ 00153 struct ast_datastore_info { 00154 const char *type; /*!< Type of data store */ 00155 void *(*duplicate)(void *data); /*!< Duplicate item data (used for inheritance) */ 00156 void (*destroy)(void *data); /*!< Destroy function */ 00157 /*! 00158 * \brief Fix up channel references 00159 * 00160 * \arg data The datastore data 00161 * \arg old_chan The old channel owning the datastore 00162 * \arg new_chan The new channel owning the datastore 00163 * 00164 * This is exactly like the fixup callback of the channel technology interface. 00165 * It allows a datastore to fix any pointers it saved to the owning channel 00166 * in case that the owning channel has changed. Generally, this would happen 00167 * when the datastore is set to be inherited, and a masquerade occurs. 00168 * 00169 * \return nothing. 00170 */ 00171 void (*chan_fixup)(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan); 00172 }; 00173 00174 /*! \brief Structure for a channel data store */ 00175 struct ast_datastore { 00176 char *uid; /*!< Unique data store identifier */ 00177 void *data; /*!< Contained data */ 00178 const struct ast_datastore_info *info; /*!< Data store type information */ 00179 unsigned int inheritance; /*!Number of levels this item will continue to be inherited */ 00180 AST_LIST_ENTRY(ast_datastore) entry; /*!< Used for easy linking */ 00181 }; 00182 00183 /*! \brief Structure for all kinds of caller ID identifications. 00184 * \note All string fields here are malloc'ed, so they need to be 00185 * freed when the structure is deleted. 00186 * Also, NULL and "" must be considered equivalent. 00187 */ 00188 struct ast_callerid { 00189 char *cid_dnid; /*!< Malloc'd Dialed Number Identifier */ 00190 char *cid_num; /*!< Malloc'd Caller Number */ 00191 char *cid_name; /*!< Malloc'd Caller Name */ 00192 char *cid_ani; /*!< Malloc'd ANI */ 00193 char *cid_rdnis; /*!< Malloc'd RDNIS */ 00194 int cid_pres; /*!< Callerid presentation/screening */ 00195 int cid_ani2; /*!< Callerid ANI 2 (Info digits) */ 00196 int cid_ton; /*!< Callerid Type of Number */ 00197 int cid_tns; /*!< Callerid Transit Network Select */ 00198 }; 00199 00200 /*! \brief 00201 Structure to describe a channel "technology", ie a channel driver 00202 See for examples: 00203 \arg chan_iax2.c - The Inter-Asterisk exchange protocol 00204 \arg chan_sip.c - The SIP channel driver 00205 \arg chan_zap.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS) 00206 00207 If you develop your own channel driver, this is where you 00208 tell the PBX at registration of your driver what properties 00209 this driver supports and where different callbacks are 00210 implemented. 00211 */ 00212 struct ast_channel_tech { 00213 const char * const type; 00214 const char * const description; 00215 00216 int capabilities; /*!< Bitmap of formats this channel can handle */ 00217 00218 int properties; /*!< Technology Properties */ 00219 00220 /*! \brief Requester - to set up call data structures (pvt's) */ 00221 struct ast_channel *(* const requester)(const char *type, int format, void *data, int *cause); 00222 00223 int (* const devicestate)(void *data); /*!< Devicestate call back */ 00224 00225 /*! \brief Start sending a literal DTMF digit */ 00226 int (* const send_digit_begin)(struct ast_channel *chan, char digit); 00227 00228 /*! \brief Stop sending a literal DTMF digit */ 00229 int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration); 00230 00231 /*! \brief Call a given phone number (address, etc), but don't 00232 take longer than timeout seconds to do so. */ 00233 int (* const call)(struct ast_channel *chan, char *addr, int timeout); 00234 00235 /*! \brief Hangup (and possibly destroy) the channel */ 00236 int (* const hangup)(struct ast_channel *chan); 00237 00238 /*! \brief Answer the channel */ 00239 int (* const answer)(struct ast_channel *chan); 00240 00241 /*! \brief Read a frame, in standard format (see frame.h) */ 00242 struct ast_frame * (* const read)(struct ast_channel *chan); 00243 00244 /*! \brief Write a frame, in standard format (see frame.h) */ 00245 int (* const write)(struct ast_channel *chan, struct ast_frame *frame); 00246 00247 /*! \brief Display or transmit text */ 00248 int (* const send_text)(struct ast_channel *chan, const char *text); 00249 00250 /*! \brief Display or send an image */ 00251 int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame); 00252 00253 /*! \brief Send HTML data */ 00254 int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len); 00255 00256 /*! \brief Handle an exception, reading a frame */ 00257 struct ast_frame * (* const exception)(struct ast_channel *chan); 00258 00259 /*! \brief Bridge two channels of the same type together */ 00260 enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags, 00261 struct ast_frame **fo, struct ast_channel **rc, int timeoutms); 00262 00263 /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */ 00264 int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen); 00265 00266 /*! \brief Fix up a channel: If a channel is consumed, this is called. Basically update any ->owner links */ 00267 int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan); 00268 00269 /*! \brief Set a given option */ 00270 int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen); 00271 00272 /*! \brief Query a given option */ 00273 int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen); 00274 00275 /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */ 00276 int (* const transfer)(struct ast_channel *chan, const char *newdest); 00277 00278 /*! \brief Write a frame, in standard format */ 00279 int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame); 00280 00281 /*! \brief Find bridged channel */ 00282 struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge); 00283 00284 /*! \brief Provide additional read items for CHANNEL() dialplan function */ 00285 int (* func_channel_read)(struct ast_channel *chan, char *function, char *data, char *buf, size_t len); 00286 00287 /*! \brief Provide additional write items for CHANNEL() dialplan function */ 00288 int (* func_channel_write)(struct ast_channel *chan, char *function, char *data, const char *value); 00289 00290 /*! \brief Retrieve base channel (agent and local) */ 00291 struct ast_channel* (* get_base_channel)(struct ast_channel *chan); 00292 00293 /*! \brief Set base channel (agent and local) */ 00294 int (* set_base_channel)(struct ast_channel *chan, struct ast_channel *base); 00295 }; 00296 00297 #define DEBUGCHAN_FLAG 0x80000000 00298 #define FRAMECOUNT_INC(x) ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) ) 00299 00300 enum ast_channel_adsicpe { 00301 AST_ADSI_UNKNOWN, 00302 AST_ADSI_AVAILABLE, 00303 AST_ADSI_UNAVAILABLE, 00304 AST_ADSI_OFFHOOKONLY, 00305 }; 00306 00307 /*! 00308 * \brief ast_channel states 00309 * 00310 * \note Bits 0-15 of state are reserved for the state (up/down) of the line 00311 * Bits 16-32 of state are reserved for flags 00312 */ 00313 enum ast_channel_state { 00314 /*! Channel is down and available */ 00315 AST_STATE_DOWN, 00316 /*! Channel is down, but reserved */ 00317 AST_STATE_RESERVED, 00318 /*! Channel is off hook */ 00319 AST_STATE_OFFHOOK, 00320 /*! Digits (or equivalent) have been dialed */ 00321 AST_STATE_DIALING, 00322 /*! Line is ringing */ 00323 AST_STATE_RING, 00324 /*! Remote end is ringing */ 00325 AST_STATE_RINGING, 00326 /*! Line is up */ 00327 AST_STATE_UP, 00328 /*! Line is busy */ 00329 AST_STATE_BUSY, 00330 /*! Digits (or equivalent) have been dialed while offhook */ 00331 AST_STATE_DIALING_OFFHOOK, 00332 /*! Channel has detected an incoming call and is waiting for ring */ 00333 AST_STATE_PRERING, 00334 00335 /*! Do not transmit voice data */ 00336 AST_STATE_MUTE = (1 << 16), 00337 }; 00338 00339 /*! \brief Main Channel structure associated with a channel. 00340 * This is the side of it mostly used by the pbx and call management. 00341 * 00342 * \note XXX It is important to remember to increment .cleancount each time 00343 * this structure is changed. XXX 00344 */ 00345 struct ast_channel { 00346 /*! \brief Technology (point to channel driver) */ 00347 const struct ast_channel_tech *tech; 00348 00349 /*! \brief Private data used by the technology driver */ 00350 void *tech_pvt; 00351 00352 AST_DECLARE_STRING_FIELDS( 00353 AST_STRING_FIELD(name); /*!< ASCII unique channel name */ 00354 AST_STRING_FIELD(language); /*!< Language requested for voice prompts */ 00355 AST_STRING_FIELD(musicclass); /*!< Default music class */ 00356 AST_STRING_FIELD(accountcode); /*!< Account code for billing */ 00357 AST_STRING_FIELD(call_forward); /*!< Where to forward to if asked to dial on this interface */ 00358 AST_STRING_FIELD(uniqueid); /*!< Unique Channel Identifier */ 00359 ); 00360 00361 /*! \brief File descriptor for channel -- Drivers will poll on these file descriptors, so at least one must be non -1. */ 00362 int fds[AST_MAX_FDS]; 00363 00364 void *music_state; /*!< Music State*/ 00365 void *generatordata; /*!< Current generator data if there is any */ 00366 struct ast_generator *generator; /*!< Current active data generator */ 00367 00368 /*! \brief Who are we bridged to, if we're bridged. Who is proxying for us, 00369 if we are proxied (i.e. chan_agent). 00370 Do not access directly, use ast_bridged_channel(chan) */ 00371 struct ast_channel *_bridge; 00372 struct ast_channel *masq; /*!< Channel that will masquerade as us */ 00373 struct ast_channel *masqr; /*!< Who we are masquerading as */ 00374 int cdrflags; /*!< Call Detail Record Flags */ 00375 00376 /*! \brief Whether or not we have been hung up... Do not set this value 00377 directly, use ast_softhangup */ 00378 int _softhangup; 00379 time_t whentohangup; /*!< Non-zero, set to actual time when channel is to be hung up */ 00380 pthread_t blocker; /*!< If anyone is blocking, this is them */ 00381 ast_mutex_t lock; /*!< Lock, can be used to lock a channel for some operations */ 00382 const char *blockproc; /*!< Procedure causing blocking */ 00383 00384 const char *appl; /*!< Current application */ 00385 const char *data; /*!< Data passed to current application */ 00386 int fdno; /*!< Which fd had an event detected on */ 00387 struct sched_context *sched; /*!< Schedule context */ 00388 int streamid; /*!< For streaming playback, the schedule ID */ 00389 struct ast_filestream *stream; /*!< Stream itself. */ 00390 int vstreamid; /*!< For streaming video playback, the schedule ID */ 00391 struct ast_filestream *vstream; /*!< Video Stream itself. */ 00392 int oldwriteformat; /*!< Original writer format */ 00393 00394 int timingfd; /*!< Timing fd */ 00395 int (*timingfunc)(const void *data); 00396 void *timingdata; 00397 00398 enum ast_channel_state _state; /*!< State of line -- Don't write directly, use ast_setstate */ 00399 int rings; /*!< Number of rings so far */ 00400 struct ast_callerid cid; /*!< Caller ID, name, presentation etc */ 00401 char unused_old_dtmfq[AST_MAX_EXTENSION]; /*!< The DTMFQ is deprecated. All frames should go to the readq. */ 00402 struct ast_frame dtmff; /*!< DTMF frame */ 00403 00404 char context[AST_MAX_CONTEXT]; /*!< Dialplan: Current extension context */ 00405 char exten[AST_MAX_EXTENSION]; /*!< Dialplan: Current extension number */ 00406 int priority; /*!< Dialplan: Current extension priority */ 00407 char macrocontext[AST_MAX_CONTEXT]; /*!< Macro: Current non-macro context. See app_macro.c */ 00408 char macroexten[AST_MAX_EXTENSION]; /*!< Macro: Current non-macro extension. See app_macro.c */ 00409 int macropriority; /*!< Macro: Current non-macro priority. See app_macro.c */ 00410 char dialcontext[AST_MAX_CONTEXT]; /*!< Dial: Extension context that we were called from */ 00411 00412 struct ast_pbx *pbx; /*!< PBX private structure for this channel */ 00413 int amaflags; /*!< Set BEFORE PBX is started to determine AMA flags */ 00414 struct ast_cdr *cdr; /*!< Call Detail Record */ 00415 enum ast_channel_adsicpe adsicpe; /*!< Whether or not ADSI is detected on CPE */ 00416 00417 struct tone_zone *zone; /*!< Tone zone as set in indications.conf or 00418 in the CHANNEL dialplan function */ 00419 00420 struct ast_channel_monitor *monitor; /*!< Channel monitoring */ 00421 00422 /*! Track the read/written samples for monitor use */ 00423 unsigned long insmpl; 00424 unsigned long outsmpl; 00425 00426 /* Frames in/out counters. The high bit is a debug mask, so 00427 * the counter is only in the remaining bits 00428 */ 00429 unsigned int fin; 00430 unsigned int fout; 00431 int hangupcause; /*!< Why is the channel hanged up. See causes.h */ 00432 struct varshead varshead; /*!< A linked list for channel variables */ 00433 ast_group_t callgroup; /*!< Call group for call pickups */ 00434 ast_group_t pickupgroup; /*!< Pickup group - which calls groups can be picked up? */ 00435 unsigned int flags; /*!< channel flags of AST_FLAG_ type */ 00436 unsigned short transfercapability; /*!< ISDN Transfer Capbility - AST_FLAG_DIGITAL is not enough */ 00437 AST_LIST_HEAD_NOLOCK(, ast_frame) readq; 00438 int alertpipe[2]; 00439 00440 int nativeformats; /*!< Kinds of data this channel can natively handle */ 00441 int readformat; /*!< Requested read format */ 00442 int writeformat; /*!< Requested write format */ 00443 struct ast_trans_pvt *writetrans; /*!< Write translation path */ 00444 struct ast_trans_pvt *readtrans; /*!< Read translation path */ 00445 int rawreadformat; /*!< Raw read format */ 00446 int rawwriteformat; /*!< Raw write format */ 00447 00448 struct ast_audiohook_list *audiohooks; 00449 void *unused; /*! This pointer should stay for Asterisk 1.4. It just keeps the struct size the same 00450 * for the sake of ABI compatability. */ 00451 00452 AST_LIST_ENTRY(ast_channel) chan_list; /*!< For easy linking */ 00453 00454 struct ast_jb jb; /*!< The jitterbuffer state */ 00455 00456 char emulate_dtmf_digit; /*!< Digit being emulated */ 00457 unsigned int emulate_dtmf_duration; /*!< Number of ms left to emulate DTMF for */ 00458 struct timeval dtmf_tv; /*!< The time that an in process digit began, or the last digit ended */ 00459 00460 int visible_indication; /*!< Indication currently playing on the channel */ 00461 00462 /*! \brief Data stores on the channel */ 00463 AST_LIST_HEAD_NOLOCK(datastores, ast_datastore) datastores; 00464 }; 00465 00466 /*! \brief ast_channel_tech Properties */ 00467 enum { 00468 /*! \brief Channels have this property if they can accept input with jitter; 00469 * i.e. most VoIP channels */ 00470 AST_CHAN_TP_WANTSJITTER = (1 << 0), 00471 /*! \brief Channels have this property if they can create jitter; 00472 * i.e. most VoIP channels */ 00473 AST_CHAN_TP_CREATESJITTER = (1 << 1), 00474 }; 00475 00476 /*! \brief ast_channel flags */ 00477 enum { 00478 /*! Queue incoming dtmf, to be released when this flag is turned off */ 00479 AST_FLAG_DEFER_DTMF = (1 << 1), 00480 /*! write should be interrupt generator */ 00481 AST_FLAG_WRITE_INT = (1 << 2), 00482 /*! a thread is blocking on this channel */ 00483 AST_FLAG_BLOCKING = (1 << 3), 00484 /*! This is a zombie channel */ 00485 AST_FLAG_ZOMBIE = (1 << 4), 00486 /*! There is an exception pending */ 00487 AST_FLAG_EXCEPTION = (1 << 5), 00488 /*! Listening to moh XXX anthm promises me this will disappear XXX */ 00489 AST_FLAG_MOH = (1 << 6), 00490 /*! This channel is spying on another channel */ 00491 AST_FLAG_SPYING = (1 << 7), 00492 /*! This channel is in a native bridge */ 00493 AST_FLAG_NBRIDGE = (1 << 8), 00494 /*! the channel is in an auto-incrementing dialplan processor, 00495 * so when ->priority is set, it will get incremented before 00496 * finding the next priority to run */ 00497 AST_FLAG_IN_AUTOLOOP = (1 << 9), 00498 /*! This is an outgoing call */ 00499 AST_FLAG_OUTGOING = (1 << 10), 00500 /*! This channel is being whispered on */ 00501 AST_FLAG_WHISPER = (1 << 11), 00502 /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */ 00503 AST_FLAG_IN_DTMF = (1 << 12), 00504 /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is 00505 * currently being emulated */ 00506 AST_FLAG_EMULATE_DTMF = (1 << 13), 00507 /*! This is set to tell the channel not to generate DTMF begin frames, and 00508 * to instead only generate END frames. */ 00509 AST_FLAG_END_DTMF_ONLY = (1 << 14), 00510 /*! This flag indicates that on a masquerade, an active stream should not 00511 * be carried over */ 00512 AST_FLAG_MASQ_NOSTREAM = (1 << 15), 00513 /*! This flag indicates that the hangup exten was run when the bridge terminated, 00514 * a message aimed at preventing a subsequent hangup exten being run at the pbx_run 00515 * level */ 00516 AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 16), 00517 }; 00518 00519 /*! \brief ast_bridge_config flags */ 00520 enum { 00521 AST_FEATURE_PLAY_WARNING = (1 << 0), 00522 AST_FEATURE_REDIRECT = (1 << 1), 00523 AST_FEATURE_DISCONNECT = (1 << 2), 00524 AST_FEATURE_ATXFER = (1 << 3), 00525 AST_FEATURE_AUTOMON = (1 << 4), 00526 AST_FEATURE_PARKCALL = (1 << 5), 00527 AST_FEATURE_NO_H_EXTEN = (1 << 6), 00528 }; 00529 00530 struct ast_bridge_config { 00531 struct ast_flags features_caller; 00532 struct ast_flags features_callee; 00533 struct timeval start_time; 00534 long feature_timer; 00535 long timelimit; 00536 long play_warning; 00537 long warning_freq; 00538 const char *warning_sound; 00539 const char *end_sound; 00540 const char *start_sound; 00541 int firstpass; 00542 unsigned int flags; 00543 void (* end_bridge_callback)(void *); /*!< A callback that is called after a bridge attempt */ 00544 void *end_bridge_callback_data; /*!< Data passed to the callback */ 00545 /*! If the end_bridge_callback_data refers to a channel which no longer is going to 00546 * exist when the end_bridge_callback is called, then it needs to be fixed up properly 00547 */ 00548 void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator); 00549 }; 00550 00551 struct chanmon; 00552 00553 #define LOAD_OH(oh) { \ 00554 oh.context = context; \ 00555 oh.exten = exten; \ 00556 oh.priority = priority; \ 00557 oh.cid_num = cid_num; \ 00558 oh.cid_name = cid_name; \ 00559 oh.account = account; \ 00560 oh.vars = vars; \ 00561 oh.parent_channel = NULL; \ 00562 } 00563 00564 struct outgoing_helper { 00565 const char *context; 00566 const char *exten; 00567 int priority; 00568 const char *cid_num; 00569 const char *cid_name; 00570 const char *account; 00571 struct ast_variable *vars; 00572 struct ast_channel *parent_channel; 00573 }; 00574 00575 enum { 00576 AST_CDR_TRANSFER = (1 << 0), 00577 AST_CDR_FORWARD = (1 << 1), 00578 AST_CDR_CALLWAIT = (1 << 2), 00579 AST_CDR_CONFERENCE = (1 << 3), 00580 }; 00581 00582 enum { 00583 /*! Soft hangup by device */ 00584 AST_SOFTHANGUP_DEV = (1 << 0), 00585 /*! Soft hangup for async goto */ 00586 AST_SOFTHANGUP_ASYNCGOTO = (1 << 1), 00587 AST_SOFTHANGUP_SHUTDOWN = (1 << 2), 00588 AST_SOFTHANGUP_TIMEOUT = (1 << 3), 00589 AST_SOFTHANGUP_APPUNLOAD = (1 << 4), 00590 AST_SOFTHANGUP_EXPLICIT = (1 << 5), 00591 AST_SOFTHANGUP_UNBRIDGE = (1 << 6), 00592 }; 00593 00594 00595 /*! \brief Channel reload reasons for manager events at load or reload of configuration */ 00596 enum channelreloadreason { 00597 CHANNEL_MODULE_LOAD, 00598 CHANNEL_MODULE_RELOAD, 00599 CHANNEL_CLI_RELOAD, 00600 CHANNEL_MANAGER_RELOAD, 00601 }; 00602 00603 /*! \brief Create a channel datastore structure */ 00604 struct ast_datastore *ast_channel_datastore_alloc(const struct ast_datastore_info *info, char *uid); 00605 00606 /*! \brief Free a channel datastore structure */ 00607 int ast_channel_datastore_free(struct ast_datastore *datastore); 00608 00609 /*! \brief Inherit datastores from a parent to a child. */ 00610 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to); 00611 00612 /*! \brief Add a datastore to a channel */ 00613 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore); 00614 00615 /*! \brief Remove a datastore from a channel */ 00616 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore); 00617 00618 /*! \brief Find a datastore on a channel */ 00619 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, char *uid); 00620 00621 /*! \brief Change the state of a channel */ 00622 int ast_setstate(struct ast_channel *chan, enum ast_channel_state); 00623 00624 /*! \brief Create a channel structure 00625 \return Returns NULL on failure to allocate. 00626 \note New channels are 00627 by default set to the "default" context and 00628 extension "s" 00629 */ 00630 struct ast_channel *ast_channel_alloc(int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const int amaflag, const char *name_fmt, ...) __attribute__((format(printf, 9, 10))); 00631 00632 /*! \brief Queue an outgoing frame */ 00633 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f); 00634 00635 /*! 00636 * \brief Queue an outgoing frame to the head of the frame queue 00637 * 00638 * \param chan the channel to queue the frame on 00639 * \param f the frame to queue. Note that this frame will be duplicated by 00640 * this function. It is the responsibility of the caller to handle 00641 * freeing the memory associated with the frame being passed if 00642 * necessary. 00643 * 00644 * \retval 0 success 00645 * \retval non-zero failure 00646 */ 00647 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f); 00648 00649 /*! \brief Queue a hangup frame */ 00650 int ast_queue_hangup(struct ast_channel *chan); 00651 00652 /*! 00653 \brief Queue a control frame with payload 00654 \param chan channel to queue frame onto 00655 \param control type of control frame 00656 \return zero on success, non-zero on failure 00657 */ 00658 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control); 00659 00660 /*! 00661 \brief Queue a control frame with payload 00662 \param chan channel to queue frame onto 00663 \param control type of control frame 00664 \param data pointer to payload data to be included in frame 00665 \param datalen number of bytes of payload data 00666 \return zero on success, non-zero on failure 00667 00668 The supplied payload data is copied into the frame, so the caller's copy 00669 is not modified nor freed, and the resulting frame will retain a copy of 00670 the data even if the caller frees their local copy. 00671 00672 \note This method should be treated as a 'network transport'; in other 00673 words, your frames may be transferred across an IAX2 channel to another 00674 system, which may be a different endianness than yours. Because of this, 00675 you should ensure that either your frames will never be expected to work 00676 across systems, or that you always put your payload data into 'network byte 00677 order' before calling this function. 00678 */ 00679 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control, 00680 const void *data, size_t datalen); 00681 00682 /*! \brief Change channel name */ 00683 void ast_change_name(struct ast_channel *chan, char *newname); 00684 00685 /*! \brief Free a channel structure */ 00686 void ast_channel_free(struct ast_channel *); 00687 00688 /*! \brief Requests a channel 00689 * \param type type of channel to request 00690 * \param format requested channel format (codec) 00691 * \param data data to pass to the channel requester 00692 * \param status status 00693 * Request a channel of a given type, with data as optional information used 00694 * by the low level module 00695 * \return Returns an ast_channel on success, NULL on failure. 00696 */ 00697 struct ast_channel *ast_request(const char *type, int format, void *data, int *status); 00698 00699 /*! 00700 * \brief Request a channel of a given type, with data as optional information used 00701 * by the low level module and attempt to place a call on it 00702 * \param type type of channel to request 00703 * \param format requested channel format 00704 * \param data data to pass to the channel requester 00705 * \param timeout maximum amount of time to wait for an answer 00706 * \param reason why unsuccessful (if unsuceessful) 00707 * \param cidnum Caller-ID Number 00708 * \param cidname Caller-ID Name 00709 * \return Returns an ast_channel on success or no answer, NULL on failure. Check the value of chan->_state 00710 * to know if the call was answered or not. 00711 */ 00712 struct ast_channel *ast_request_and_dial(const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname); 00713 00714 struct ast_channel *__ast_request_and_dial(const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname, struct outgoing_helper *oh); 00715 00716 /*!\brief Register a channel technology (a new channel driver) 00717 * Called by a channel module to register the kind of channels it supports. 00718 * \param tech Structure defining channel technology or "type" 00719 * \return Returns 0 on success, -1 on failure. 00720 */ 00721 int ast_channel_register(const struct ast_channel_tech *tech); 00722 00723 /*! \brief Unregister a channel technology 00724 * \param tech Structure defining channel technology or "type" that was previously registered 00725 * \return No return value. 00726 */ 00727 void ast_channel_unregister(const struct ast_channel_tech *tech); 00728 00729 /*! \brief Get a channel technology structure by name 00730 * \param name name of technology to find 00731 * \return a pointer to the structure, or NULL if no matching technology found 00732 */ 00733 const struct ast_channel_tech *ast_get_channel_tech(const char *name); 00734 00735 /*! \brief Hang up a channel 00736 * \note This function performs a hard hangup on a channel. Unlike the soft-hangup, this function 00737 * performs all stream stopping, etc, on the channel that needs to end. 00738 * chan is no longer valid after this call. 00739 * \param chan channel to hang up 00740 * \return Returns 0 on success, -1 on failure. 00741 */ 00742 int ast_hangup(struct ast_channel *chan); 00743 00744 /*! \brief Softly hangup up a channel 00745 * \param chan channel to be soft-hung-up 00746 * Call the protocol layer, but don't destroy the channel structure (use this if you are trying to 00747 * safely hangup a channel managed by another thread. 00748 * \param cause Ast hangupcause for hangup 00749 * \return Returns 0 regardless 00750 */ 00751 int ast_softhangup(struct ast_channel *chan, int cause); 00752 00753 /*! \brief Softly hangup up a channel (no channel lock) 00754 * \param chan channel to be soft-hung-up 00755 * \param cause Ast hangupcause for hangup (see cause.h) */ 00756 int ast_softhangup_nolock(struct ast_channel *chan, int cause); 00757 00758 /*! \brief Check to see if a channel is needing hang up 00759 * \param chan channel on which to check for hang up 00760 * This function determines if the channel is being requested to be hung up. 00761 * \return Returns 0 if not, or 1 if hang up is requested (including time-out). 00762 */ 00763 int ast_check_hangup(struct ast_channel *chan); 00764 00765 /*! \brief Compare a offset with the settings of when to hang a channel up 00766 * \param chan channel on which to check for hang up 00767 * \param offset offset in seconds from current time 00768 * \return 1, 0, or -1 00769 * This function compares a offset from current time with the absolute time 00770 * out on a channel (when to hang up). If the absolute time out on a channel 00771 * is earlier than current time plus the offset, it returns 1, if the two 00772 * time values are equal, it return 0, otherwise, it retturn -1. 00773 */ 00774 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset); 00775 00776 /*! \brief Set when to hang a channel up 00777 * \param chan channel on which to check for hang up 00778 * \param offset offset in seconds from current time of when to hang up 00779 * This function sets the absolute time out on a channel (when to hang up). 00780 */ 00781 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset); 00782 00783 /*! \brief Answer a ringing call 00784 * \param chan channel to answer 00785 * This function answers a channel and handles all necessary call 00786 * setup functions. 00787 * \return Returns 0 on success, -1 on failure 00788 */ 00789 int ast_answer(struct ast_channel *chan); 00790 00791 /*! \brief Make a call 00792 * \param chan which channel to make the call on 00793 * \param addr destination of the call 00794 * \param timeout time to wait on for connect 00795 * Place a call, take no longer than timeout ms. 00796 \return Returns -1 on failure, 0 on not enough time 00797 (does not automatically stop ringing), and 00798 the number of seconds the connect took otherwise. 00799 */ 00800 int ast_call(struct ast_channel *chan, char *addr, int timeout); 00801 00802 /*! \brief Indicates condition of channel 00803 * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel 00804 * \param chan channel to change the indication 00805 * \param condition which condition to indicate on the channel 00806 * \return Returns 0 on success, -1 on failure 00807 */ 00808 int ast_indicate(struct ast_channel *chan, int condition); 00809 00810 /*! \brief Indicates condition of channel, with payload 00811 * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel 00812 * \param chan channel to change the indication 00813 * \param condition which condition to indicate on the channel 00814 * \param data pointer to payload data 00815 * \param datalen size of payload data 00816 * \return Returns 0 on success, -1 on failure 00817 */ 00818 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen); 00819 00820 /* Misc stuff ------------------------------------------------ */ 00821 00822 /*! \brief Wait for input on a channel 00823 * \param chan channel to wait on 00824 * \param ms length of time to wait on the channel 00825 * Wait for input on a channel for a given # of milliseconds (<0 for indefinite). 00826 \return Returns < 0 on failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */ 00827 int ast_waitfor(struct ast_channel *chan, int ms); 00828 00829 /*! \brief Wait for a specied amount of time, looking for hangups 00830 * \param chan channel to wait for 00831 * \param ms length of time in milliseconds to sleep 00832 * Waits for a specified amount of time, servicing the channel as required. 00833 * \return returns -1 on hangup, otherwise 0. 00834 */ 00835 int ast_safe_sleep(struct ast_channel *chan, int ms); 00836 00837 /*! \brief Wait for a specied amount of time, looking for hangups and a condition argument 00838 * \param chan channel to wait for 00839 * \param ms length of time in milliseconds to sleep 00840 * \param cond a function pointer for testing continue condition 00841 * \param data argument to be passed to the condition test function 00842 * \return returns -1 on hangup, otherwise 0. 00843 * Waits for a specified amount of time, servicing the channel as required. If cond 00844 * returns 0, this function returns. 00845 */ 00846 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data ); 00847 00848 /*! \brief Waits for activity on a group of channels 00849 * \param chan an array of pointers to channels 00850 * \param n number of channels that are to be waited upon 00851 * \param fds an array of fds to wait upon 00852 * \param nfds the number of fds to wait upon 00853 * \param exception exception flag 00854 * \param outfd fd that had activity on it 00855 * \param ms how long the wait was 00856 * Big momma function here. Wait for activity on any of the n channels, or any of the nfds 00857 file descriptors. 00858 \return Returns the channel with activity, or NULL on error or if an FD 00859 came first. If the FD came first, it will be returned in outfd, otherwise, outfd 00860 will be -1 */ 00861 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n, int *fds, int nfds, int *exception, int *outfd, int *ms); 00862 00863 /*! \brief Waits for input on a group of channels 00864 Wait for input on an array of channels for a given # of milliseconds. 00865 \return Return channel with activity, or NULL if none has activity. 00866 \param chan an array of pointers to channels 00867 \param n number of channels that are to be waited upon 00868 \param ms time "ms" is modified in-place, if applicable */ 00869 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms); 00870 00871 /*! \brief Waits for input on an fd 00872 This version works on fd's only. Be careful with it. */ 00873 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception); 00874 00875 00876 /*! \brief Reads a frame 00877 * \param chan channel to read a frame from 00878 Read a frame. 00879 \return Returns a frame, or NULL on error. If it returns NULL, you 00880 best just stop reading frames and assume the channel has been 00881 disconnected. */ 00882 struct ast_frame *ast_read(struct ast_channel *chan); 00883 00884 /*! \brief Reads a frame, returning AST_FRAME_NULL frame if audio. 00885 * Read a frame. 00886 \param chan channel to read a frame from 00887 \return Returns a frame, or NULL on error. If it returns NULL, you 00888 best just stop reading frames and assume the channel has been 00889 disconnected. 00890 \note Audio is replaced with AST_FRAME_NULL to avoid 00891 transcode when the resulting audio is not necessary. */ 00892 struct ast_frame *ast_read_noaudio(struct ast_channel *chan); 00893 00894 /*! \brief Write a frame to a channel 00895 * This function writes the given frame to the indicated channel. 00896 * \param chan destination channel of the frame 00897 * \param frame frame that will be written 00898 * \return It returns 0 on success, -1 on failure. 00899 */ 00900 int ast_write(struct ast_channel *chan, struct ast_frame *frame); 00901 00902 /*! \brief Write video frame to a channel 00903 * This function writes the given frame to the indicated channel. 00904 * \param chan destination channel of the frame 00905 * \param frame frame that will be written 00906 * \return It returns 1 on success, 0 if not implemented, and -1 on failure. 00907 */ 00908 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame); 00909 00910 /*! \brief Send empty audio to prime a channel driver */ 00911 int ast_prod(struct ast_channel *chan); 00912 00913 /*! \brief Sets read format on channel chan 00914 * Set read format for channel to whichever component of "format" is best. 00915 * \param chan channel to change 00916 * \param format format to change to 00917 * \return Returns 0 on success, -1 on failure 00918 */ 00919 int ast_set_read_format(struct ast_channel *chan, int format); 00920 00921 /*! \brief Sets write format on channel chan 00922 * Set write format for channel to whichever compoent of "format" is best. 00923 * \param chan channel to change 00924 * \param format new format for writing 00925 * \return Returns 0 on success, -1 on failure 00926 */ 00927 int ast_set_write_format(struct ast_channel *chan, int format); 00928 00929 /*! \brief Sends text to a channel 00930 * Write text to a display on a channel 00931 * \param chan channel to act upon 00932 * \param text string of text to send on the channel 00933 * \return Returns 0 on success, -1 on failure 00934 */ 00935 int ast_sendtext(struct ast_channel *chan, const char *text); 00936 00937 /*! \brief Receives a text character from a channel 00938 * \param chan channel to act upon 00939 * \param timeout timeout in milliseconds (0 for infinite wait) 00940 * Read a char of text from a channel 00941 * Returns 0 on success, -1 on failure 00942 */ 00943 int ast_recvchar(struct ast_channel *chan, int timeout); 00944 00945 /*! \brief Send a DTMF digit to a channel 00946 * Send a DTMF digit to a channel. 00947 * \param chan channel to act upon 00948 * \param digit the DTMF digit to send, encoded in ASCII 00949 * \return Returns 0 on success, -1 on failure 00950 */ 00951 int ast_senddigit(struct ast_channel *chan, char digit); 00952 00953 int ast_senddigit_begin(struct ast_channel *chan, char digit); 00954 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration); 00955 00956 /*! \brief Receives a text string from a channel 00957 * Read a string of text from a channel 00958 * \param chan channel to act upon 00959 * \param timeout timeout in milliseconds (0 for infinite wait) 00960 * \return the received text, or NULL to signify failure. 00961 */ 00962 char *ast_recvtext(struct ast_channel *chan, int timeout); 00963 00964 /*! \brief Browse channels in use 00965 * Browse the channels currently in use 00966 * \param prev where you want to start in the channel list 00967 * \return Returns the next channel in the list, NULL on end. 00968 * If it returns a channel, that channel *has been locked*! 00969 */ 00970 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev); 00971 00972 /*! \brief Get channel by name (locks channel) */ 00973 struct ast_channel *ast_get_channel_by_name_locked(const char *chan); 00974 00975 /*! \brief Get channel by name prefix (locks channel) */ 00976 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen); 00977 00978 /*! \brief Get channel by name prefix (locks channel) */ 00979 struct ast_channel *ast_walk_channel_by_name_prefix_locked(const struct ast_channel *chan, const char *name, const int namelen); 00980 00981 /*! \brief Get channel by exten (and optionally context) and lock it */ 00982 struct ast_channel *ast_get_channel_by_exten_locked(const char *exten, const char *context); 00983 00984 /*! \brief Get next channel by exten (and optionally context) and lock it */ 00985 struct ast_channel *ast_walk_channel_by_exten_locked(const struct ast_channel *chan, const char *exten, 00986 const char *context); 00987 00988 /*! ! \brief Waits for a digit 00989 * \param c channel to wait for a digit on 00990 * \param ms how many milliseconds to wait 00991 * \return Returns <0 on error, 0 on no entry, and the digit on success. */ 00992 int ast_waitfordigit(struct ast_channel *c, int ms); 00993 00994 /*! \brief Wait for a digit 00995 Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading. 00996 * \param c channel to wait for a digit on 00997 * \param ms how many milliseconds to wait 00998 * \param audiofd audio file descriptor to write to if audio frames are received 00999 * \param ctrlfd control file descriptor to monitor for reading 01000 * \return Returns 1 if ctrlfd becomes available */ 01001 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd); 01002 01003 /*! Reads multiple digits 01004 * \param c channel to read from 01005 * \param s string to read in to. Must be at least the size of your length 01006 * \param len how many digits to read (maximum) 01007 * \param timeout how long to timeout between digits 01008 * \param rtimeout timeout to wait on the first digit 01009 * \param enders digits to end the string 01010 * Read in a digit string "s", max length "len", maximum timeout between 01011 digits "timeout" (-1 for none), terminated by anything in "enders". Give them rtimeout 01012 for the first digit. Returns 0 on normal return, or 1 on a timeout. In the case of 01013 a timeout, any digits that were read before the timeout will still be available in s. 01014 RETURNS 2 in full version when ctrlfd is available, NOT 1*/ 01015 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders); 01016 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd); 01017 01018 /*! \brief Report DTMF on channel 0 */ 01019 #define AST_BRIDGE_DTMF_CHANNEL_0 (1 << 0) 01020 /*! \brief Report DTMF on channel 1 */ 01021 #define AST_BRIDGE_DTMF_CHANNEL_1 (1 << 1) 01022 /*! \brief Return all voice frames on channel 0 */ 01023 #define AST_BRIDGE_REC_CHANNEL_0 (1 << 2) 01024 /*! \brief Return all voice frames on channel 1 */ 01025 #define AST_BRIDGE_REC_CHANNEL_1 (1 << 3) 01026 /*! \brief Ignore all signal frames except NULL */ 01027 #define AST_BRIDGE_IGNORE_SIGS (1 << 4) 01028 01029 01030 /*! \brief Makes two channel formats compatible 01031 * \param c0 first channel to make compatible 01032 * \param c1 other channel to make compatible 01033 * Set two channels to compatible formats -- call before ast_channel_bridge in general . 01034 * \return Returns 0 on success and -1 if it could not be done */ 01035 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1); 01036 01037 /*! Bridge two channels together 01038 * \param c0 first channel to bridge 01039 * \param c1 second channel to bridge 01040 * \param config config for the channels 01041 * \param fo destination frame(?) 01042 * \param rc destination channel(?) 01043 * Bridge two channels (c0 and c1) together. If an important frame occurs, we return that frame in 01044 *rf (remember, it could be NULL) and which channel (0 or 1) in rc */ 01045 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */ 01046 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc); 01047 01048 /*! \brief Weird function made for call transfers 01049 * \param original channel to make a copy of 01050 * \param clone copy of the original channel 01051 * This is a very strange and freaky function used primarily for transfer. Suppose that 01052 "original" and "clone" are two channels in random situations. This function takes 01053 the guts out of "clone" and puts them into the "original" channel, then alerts the 01054 channel driver of the change, asking it to fixup any private information (like the 01055 p->owner pointer) that is affected by the change. The physical layer of the original 01056 channel is hung up. */ 01057 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone); 01058 01059 /*! Gives the string form of a given cause code */ 01060 /*! 01061 * \param state cause to get the description of 01062 * Give a name to a cause code 01063 * Returns the text form of the binary cause code given 01064 */ 01065 const char *ast_cause2str(int state) attribute_pure; 01066 01067 /*! Convert the string form of a cause code to a number */ 01068 /*! 01069 * \param name string form of the cause 01070 * Returns the cause code 01071 */ 01072 int ast_str2cause(const char *name) attribute_pure; 01073 01074 /*! Gives the string form of a given channel state */ 01075 /*! 01076 * \param ast_channel_state state to get the name of 01077 * Give a name to a state 01078 * Returns the text form of the binary state given 01079 */ 01080 char *ast_state2str(enum ast_channel_state); 01081 01082 /*! Gives the string form of a given transfer capability */ 01083 /*! 01084 * \param transfercapability transfercapabilty to get the name of 01085 * Give a name to a transfercapbility 01086 * See above 01087 * Returns the text form of the binary transfer capbility 01088 */ 01089 char *ast_transfercapability2str(int transfercapability) attribute_const; 01090 01091 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the 01092 low level channel. See frame.h for options. Note that many channel drivers may support 01093 none or a subset of those features, and you should not count on this if you want your 01094 asterisk application to be portable. They're mainly useful for tweaking performance */ 01095 01096 /*! Sets an option on a channel */ 01097 /*! 01098 * \param channel channel to set options on 01099 * \param option option to change 01100 * \param data data specific to option 01101 * \param datalen length of the data 01102 * \param block blocking or not 01103 * Set an option on a channel (see frame.h), optionally blocking awaiting the reply 01104 * Returns 0 on success and -1 on failure 01105 */ 01106 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block); 01107 01108 /*! Pick the best codec */ 01109 /* Choose the best codec... Uhhh... Yah. */ 01110 int ast_best_codec(int fmts); 01111 01112 01113 /*! Checks the value of an option */ 01114 /*! 01115 * Query the value of an option, optionally blocking until a reply is received 01116 * Works similarly to setoption except only reads the options. 01117 */ 01118 struct ast_frame *ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block); 01119 01120 /*! Checks for HTML support on a channel */ 01121 /*! Returns 0 if channel does not support HTML or non-zero if it does */ 01122 int ast_channel_supports_html(struct ast_channel *channel); 01123 01124 /*! Sends HTML on given channel */ 01125 /*! Send HTML or URL on link. Returns 0 on success or -1 on failure */ 01126 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen); 01127 01128 /*! Sends a URL on a given link */ 01129 /*! Send URL on link. Returns 0 on success or -1 on failure */ 01130 int ast_channel_sendurl(struct ast_channel *channel, const char *url); 01131 01132 /*! Defers DTMF */ 01133 /*! Defer DTMF so that you only read things like hangups and audio. Returns 01134 non-zero if channel was already DTMF-deferred or 0 if channel is just now 01135 being DTMF-deferred */ 01136 int ast_channel_defer_dtmf(struct ast_channel *chan); 01137 01138 /*! Undeos a defer */ 01139 /*! Undo defer. ast_read will return any dtmf characters that were queued */ 01140 void ast_channel_undefer_dtmf(struct ast_channel *chan); 01141 01142 /*! Initiate system shutdown -- prevents new channels from being allocated. 01143 If "hangup" is non-zero, all existing channels will receive soft 01144 hangups */ 01145 void ast_begin_shutdown(int hangup); 01146 01147 /*! Cancels an existing shutdown and returns to normal operation */ 01148 void ast_cancel_shutdown(void); 01149 01150 /*! Returns number of active/allocated channels */ 01151 int ast_active_channels(void); 01152 01153 /*! Returns non-zero if Asterisk is being shut down */ 01154 int ast_shutting_down(void); 01155 01156 /*! Activate a given generator */ 01157 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params); 01158 01159 /*! Deactive an active generator */ 01160 void ast_deactivate_generator(struct ast_channel *chan); 01161 01162 /*! 01163 * \note The channel does not need to be locked before calling this function. 01164 */ 01165 void ast_set_callerid(struct ast_channel *chan, const char *cidnum, const char *cidname, const char *ani); 01166 01167 01168 /*! return a mallocd string with the result of sprintf of the fmt and following args */ 01169 char __attribute__((format(printf, 1, 2))) *ast_safe_string_alloc(const char *fmt, ...); 01170 01171 01172 /*! Start a tone going */ 01173 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol); 01174 /*! Stop a tone from playing */ 01175 void ast_tonepair_stop(struct ast_channel *chan); 01176 /*! Play a tone pair for a given amount of time */ 01177 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol); 01178 01179 /*! 01180 * \brief Automatically service a channel for us... 01181 * 01182 * \retval 0 success 01183 * \retval -1 failure, or the channel is already being autoserviced 01184 */ 01185 int ast_autoservice_start(struct ast_channel *chan); 01186 01187 /*! 01188 * \brief Stop servicing a channel for us... 01189 * 01190 * \note if chan is locked prior to calling ast_autoservice_stop, it 01191 * is likely that there will be a deadlock between the thread that calls 01192 * ast_autoservice_stop and the autoservice thread. It is important 01193 * that chan is not locked prior to this call 01194 * 01195 * \retval 0 success 01196 * \retval -1 error, or the channel has been hungup 01197 */ 01198 int ast_autoservice_stop(struct ast_channel *chan); 01199 01200 /* If built with DAHDI optimizations, force a scheduled expiration on the 01201 timer fd, at which point we call the callback function / data */ 01202 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(const void *data), void *data); 01203 01204 /*! \brief Transfer a channel (if supported). Returns -1 on error, 0 if not supported 01205 and 1 if supported and requested 01206 \param chan current channel 01207 \param dest destination extension for transfer 01208 */ 01209 int ast_transfer(struct ast_channel *chan, char *dest); 01210 01211 /*! \brief Start masquerading a channel 01212 XXX This is a seriously wacked out operation. We're essentially putting the guts of 01213 the clone channel into the original channel. Start by killing off the original 01214 channel's backend. I'm not sure we're going to keep this function, because 01215 while the features are nice, the cost is very high in terms of pure nastiness. XXX 01216 \param chan Channel to masquerade 01217 */ 01218 int ast_do_masquerade(struct ast_channel *chan); 01219 01220 /*! \brief Find bridged channel 01221 \param chan Current channel 01222 */ 01223 struct ast_channel *ast_bridged_channel(struct ast_channel *chan); 01224 01225 /*! 01226 \brief Inherits channel variable from parent to child channel 01227 \param parent Parent channel 01228 \param child Child channel 01229 01230 Scans all channel variables in the parent channel, looking for those 01231 that should be copied into the child channel. 01232 Variables whose names begin with a single '_' are copied into the 01233 child channel with the prefix removed. 01234 Variables whose names begin with '__' are copied into the child 01235 channel with their names unchanged. 01236 */ 01237 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child); 01238 01239 /*! 01240 \brief adds a list of channel variables to a channel 01241 \param chan the channel 01242 \param vars a linked list of variables 01243 01244 Variable names can be for a regular channel variable or a dialplan function 01245 that has the ability to be written to. 01246 */ 01247 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars); 01248 01249 /*! 01250 \brief An opaque 'object' structure use by silence generators on channels. 01251 */ 01252 struct ast_silence_generator; 01253 01254 /*! 01255 \brief Starts a silence generator on the given channel. 01256 \param chan The channel to generate silence on 01257 \return An ast_silence_generator pointer, or NULL if an error occurs 01258 01259 This function will cause SLINEAR silence to be generated on the supplied 01260 channel until it is disabled; if the channel cannot be put into SLINEAR 01261 mode then the function will fail. 01262 01263 The pointer returned by this function must be preserved and passed to 01264 ast_channel_stop_silence_generator when you wish to stop the silence 01265 generation. 01266 */ 01267 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan); 01268 01269 /*! 01270 \brief Stops a previously-started silence generator on the given channel. 01271 \param chan The channel to operate on 01272 \param state The ast_silence_generator pointer return by a previous call to 01273 ast_channel_start_silence_generator. 01274 \return nothing 01275 01276 This function will stop the operating silence generator and return the channel 01277 to its previous write format. 01278 */ 01279 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state); 01280 01281 /*! 01282 \brief Check if the channel can run in internal timing mode. 01283 \param chan The channel to check 01284 \return boolean 01285 01286 This function will return 1 if internal timing is enabled and the timing 01287 device is available. 01288 */ 01289 int ast_internal_timing_enabled(struct ast_channel *chan); 01290 01291 /* Misc. functions below */ 01292 01293 /*! \brief if fd is a valid descriptor, set *pfd with the descriptor 01294 * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the 01295 * return value to the index into the array) 01296 */ 01297 static inline int ast_add_fd(struct pollfd *pfd, int fd) 01298 { 01299 pfd->fd = fd; 01300 pfd->events = POLLIN | POLLPRI; 01301 return fd >= 0; 01302 } 01303 01304 /*! \brief Helper function for migrating select to poll */ 01305 static inline int ast_fdisset(struct pollfd *pfds, int fd, int max, int *start) 01306 { 01307 int x; 01308 int dummy=0; 01309 01310 if (fd < 0) 01311 return 0; 01312 if (!start) 01313 start = &dummy; 01314 for (x = *start; x<max; x++) 01315 if (pfds[x].fd == fd) { 01316 if (x == *start) 01317 (*start)++; 01318 return pfds[x].revents; 01319 } 01320 return 0; 01321 } 01322 01323 #ifndef HAVE_TIMERSUB 01324 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff) 01325 { 01326 tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec; 01327 tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec; 01328 if (tvdiff->tv_usec < 0) { 01329 tvdiff->tv_sec --; 01330 tvdiff->tv_usec += 1000000; 01331 } 01332 01333 } 01334 #endif 01335 01336 /*! \brief Waits for activity on a group of channels 01337 * \param nfds the maximum number of file descriptors in the sets 01338 * \param rfds file descriptors to check for read availability 01339 * \param wfds file descriptors to check for write availability 01340 * \param efds file descriptors to check for exceptions (OOB data) 01341 * \param tvp timeout while waiting for events 01342 * This is the same as a standard select(), except it guarantees the 01343 * behaviour where the passed struct timeval is updated with how much 01344 * time was not slept while waiting for the specified events 01345 */ 01346 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp) 01347 { 01348 #ifdef __linux__ 01349 return select(nfds, rfds, wfds, efds, tvp); 01350 #else 01351 if (tvp) { 01352 struct timeval tv, tvstart, tvend, tvlen; 01353 int res; 01354 01355 tv = *tvp; 01356 gettimeofday(&tvstart, NULL); 01357 res = select(nfds, rfds, wfds, efds, tvp); 01358 gettimeofday(&tvend, NULL); 01359 timersub(&tvend, &tvstart, &tvlen); 01360 timersub(&tv, &tvlen, tvp); 01361 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) { 01362 tvp->tv_sec = 0; 01363 tvp->tv_usec = 0; 01364 } 01365 return res; 01366 } 01367 else 01368 return select(nfds, rfds, wfds, efds, NULL); 01369 #endif 01370 } 01371 01372 #define CHECK_BLOCKING(c) do { \ 01373 if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\ 01374 if (option_debug) \ 01375 ast_log(LOG_DEBUG, "Thread %ld Blocking '%s', already blocked by thread %ld in procedure %s\n", (long) pthread_self(), (c)->name, (long) (c)->blocker, (c)->blockproc); \ 01376 } else { \ 01377 (c)->blocker = pthread_self(); \ 01378 (c)->blockproc = __PRETTY_FUNCTION__; \ 01379 ast_set_flag(c, AST_FLAG_BLOCKING); \ 01380 } } while (0) 01381 01382 ast_group_t ast_get_group(const char *s); 01383 01384 /*! \brief print call- and pickup groups into buffer */ 01385 char *ast_print_group(char *buf, int buflen, ast_group_t group); 01386 01387 /*! \brief Convert enum channelreloadreason to text string for manager event 01388 \param reason Enum channelreloadreason - reason for reload (manager, cli, start etc) 01389 */ 01390 const char *channelreloadreason2txt(enum channelreloadreason reason); 01391 01392 /*! \brief return an ast_variable list of channeltypes */ 01393 struct ast_variable *ast_channeltype_list(void); 01394 01395 /*! 01396 \brief Begin 'whispering' onto a channel 01397 \param chan The channel to whisper onto 01398 \return 0 for success, non-zero for failure 01399 01400 This function will add a whisper buffer onto a channel and set a flag 01401 causing writes to the channel to reduce the volume level of the written 01402 audio samples, and then to mix in audio from the whisper buffer if it 01403 is available. 01404 01405 Note: This function performs no locking; you must hold the channel's lock before 01406 calling this function. 01407 */ 01408 int ast_channel_whisper_start(struct ast_channel *chan); 01409 01410 /*! 01411 \brief Feed an audio frame into the whisper buffer on a channel 01412 \param chan The channel to whisper onto 01413 \param f The frame to to whisper onto chan 01414 \return 0 for success, non-zero for failure 01415 */ 01416 int ast_channel_whisper_feed(struct ast_channel *chan, struct ast_frame *f); 01417 01418 /*! 01419 \brief Stop 'whispering' onto a channel 01420 \param chan The channel to whisper onto 01421 \return 0 for success, non-zero for failure 01422 01423 Note: This function performs no locking; you must hold the channel's lock before 01424 calling this function. 01425 */ 01426 void ast_channel_whisper_stop(struct ast_channel *chan); 01427 01428 01429 01430 /*! 01431 \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument 01432 \param reason The integer argument, usually taken from AST_CONTROL_ macros 01433 \return char pointer explaining the code 01434 */ 01435 char *ast_channel_reason2str(int reason); 01436 01437 01438 #if defined(__cplusplus) || defined(c_plusplus) 01439 } 01440 #endif 01441 01442 #endif /* _ASTERISK_CHANNEL_H */