00001 /* 00002 * Asterisk -- An open source telephony toolkit. 00003 * 00004 * Copyright (C) 1999 - 2005, 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 Asterisk internal frame definitions. 00021 * \arg For an explanation of frames, see \ref Def_Frame 00022 * \arg Frames are send of Asterisk channels, see \ref Def_Channel 00023 */ 00024 00025 #ifndef _ASTERISK_FRAME_H 00026 #define _ASTERISK_FRAME_H 00027 00028 #if defined(__cplusplus) || defined(c_plusplus) 00029 extern "C" { 00030 #endif 00031 00032 #include <sys/time.h> 00033 00034 #include "asterisk/frame_defs.h" 00035 #include "asterisk/endian.h" 00036 #include "asterisk/linkedlists.h" 00037 00038 struct ast_codec_pref { 00039 char order[sizeof(format_t) * 8]; 00040 int framing[64]; /*!< Magic numbers are bad, but this just needs to be bigger than ARRAY_LEN(AST_FORMAT_LIST) */ 00041 }; 00042 00043 /*! 00044 * \page Def_Frame AST Multimedia and signalling frames 00045 * \section Def_AstFrame What is an ast_frame ? 00046 * A frame of data read used to communicate between 00047 * between channels and applications. 00048 * Frames are divided into frame types and subclasses. 00049 * 00050 * \par Frame types 00051 * \arg \b VOICE: Voice data, subclass is codec (AST_FORMAT_*) 00052 * \arg \b VIDEO: Video data, subclass is codec (AST_FORMAT_*) 00053 * \arg \b DTMF: A DTMF digit, subclass is the digit 00054 * \arg \b IMAGE: Image transport, mostly used in IAX 00055 * \arg \b TEXT: Text messages and character by character (real time text) 00056 * \arg \b HTML: URL's and web pages 00057 * \arg \b MODEM: Modulated data encodings, such as T.38 and V.150 00058 * \arg \b IAX: Private frame type for the IAX protocol 00059 * \arg \b CNG: Comfort noice frames 00060 * \arg \b CONTROL:A control frame, subclass defined as AST_CONTROL_ 00061 * \arg \b NULL: Empty, useless frame 00062 * 00063 * \par Files 00064 * \arg frame.h Definitions 00065 * \arg frame.c Function library 00066 * \arg \ref Def_Channel Asterisk channels 00067 * \section Def_ControlFrame Control Frames 00068 * Control frames send signalling information between channels 00069 * and devices. They are prefixed with AST_CONTROL_, like AST_CONTROL_FRAME_HANGUP 00070 * \arg \b HANGUP The other end has hungup 00071 * \arg \b RING Local ring 00072 * \arg \b RINGING The other end is ringing 00073 * \arg \b ANSWER The other end has answered 00074 * \arg \b BUSY Remote end is busy 00075 * \arg \b TAKEOFFHOOK Make it go off hook (what's "it" ? ) 00076 * \arg \b OFFHOOK Line is off hook 00077 * \arg \b CONGESTION Congestion (circuit is busy, not available) 00078 * \arg \b FLASH Other end sends flash hook 00079 * \arg \b WINK Other end sends wink 00080 * \arg \b OPTION Send low-level option 00081 * \arg \b RADIO_KEY Key radio (see app_rpt.c) 00082 * \arg \b RADIO_UNKEY Un-key radio (see app_rpt.c) 00083 * \arg \b PROGRESS Other end indicates call progress 00084 * \arg \b PROCEEDING Indicates proceeding 00085 * \arg \b HOLD Call is placed on hold 00086 * \arg \b UNHOLD Call is back from hold 00087 * \arg \b VIDUPDATE Video update requested 00088 * \arg \b SRCUPDATE The source of media has changed (RTP marker bit must change) 00089 * \arg \b SRCCHANGE Media source has changed (RTP marker bit and SSRC must change) 00090 * \arg \b CONNECTED_LINE Connected line has changed 00091 * \arg \b REDIRECTING Call redirecting information has changed. 00092 */ 00093 00094 /*! 00095 * \brief Frame types 00096 * 00097 * \note It is important that the values of each frame type are never changed, 00098 * because it will break backwards compatability with older versions. 00099 * This is because these constants are transmitted directly over IAX2. 00100 */ 00101 enum ast_frame_type { 00102 /*! DTMF end event, subclass is the digit */ 00103 AST_FRAME_DTMF_END = 1, 00104 /*! Voice data, subclass is AST_FORMAT_* */ 00105 AST_FRAME_VOICE, 00106 /*! Video frame, maybe?? :) */ 00107 AST_FRAME_VIDEO, 00108 /*! A control frame, subclass is AST_CONTROL_* */ 00109 AST_FRAME_CONTROL, 00110 /*! An empty, useless frame */ 00111 AST_FRAME_NULL, 00112 /*! Inter Asterisk Exchange private frame type */ 00113 AST_FRAME_IAX, 00114 /*! Text messages */ 00115 AST_FRAME_TEXT, 00116 /*! Image Frames */ 00117 AST_FRAME_IMAGE, 00118 /*! HTML Frame */ 00119 AST_FRAME_HTML, 00120 /*! Comfort Noise frame (subclass is level of CNG in -dBov), 00121 body may include zero or more 8-bit quantization coefficients */ 00122 AST_FRAME_CNG, 00123 /*! Modem-over-IP data streams */ 00124 AST_FRAME_MODEM, 00125 /*! DTMF begin event, subclass is the digit */ 00126 AST_FRAME_DTMF_BEGIN, 00127 }; 00128 #define AST_FRAME_DTMF AST_FRAME_DTMF_END 00129 00130 enum { 00131 /*! This frame contains valid timing information */ 00132 AST_FRFLAG_HAS_TIMING_INFO = (1 << 0), 00133 }; 00134 00135 union ast_frame_subclass { 00136 int integer; 00137 format_t codec; 00138 }; 00139 00140 /*! \brief Data structure associated with a single frame of data 00141 */ 00142 struct ast_frame { 00143 /*! Kind of frame */ 00144 enum ast_frame_type frametype; 00145 /*! Subclass, frame dependent */ 00146 union ast_frame_subclass subclass; 00147 /*! Length of data */ 00148 int datalen; 00149 /*! Number of samples in this frame */ 00150 int samples; 00151 /*! Was the data malloc'd? i.e. should we free it when we discard the frame? */ 00152 int mallocd; 00153 /*! The number of bytes allocated for a malloc'd frame header */ 00154 size_t mallocd_hdr_len; 00155 /*! How many bytes exist _before_ "data" that can be used if needed */ 00156 int offset; 00157 /*! Optional source of frame for debugging */ 00158 const char *src; 00159 /*! Pointer to actual data */ 00160 union { void *ptr; uint32_t uint32; char pad[8]; } data; 00161 /*! Global delivery time */ 00162 struct timeval delivery; 00163 /*! For placing in a linked list */ 00164 AST_LIST_ENTRY(ast_frame) frame_list; 00165 /*! Misc. frame flags */ 00166 unsigned int flags; 00167 /*! Timestamp in milliseconds */ 00168 long ts; 00169 /*! Length in milliseconds */ 00170 long len; 00171 /*! Sequence number */ 00172 int seqno; 00173 }; 00174 00175 /*! 00176 * Set the various field of a frame to point to a buffer. 00177 * Typically you set the base address of the buffer, the offset as 00178 * AST_FRIENDLY_OFFSET, and the datalen as the amount of bytes queued. 00179 * The remaining things (to be done manually) is set the number of 00180 * samples, which cannot be derived from the datalen unless you know 00181 * the number of bits per sample. 00182 */ 00183 #define AST_FRAME_SET_BUFFER(fr, _base, _ofs, _datalen) \ 00184 { \ 00185 (fr)->data.ptr = (char *)_base + (_ofs); \ 00186 (fr)->offset = (_ofs); \ 00187 (fr)->datalen = (_datalen); \ 00188 } 00189 00190 /*! Queueing a null frame is fairly common, so we declare a global null frame object 00191 for this purpose instead of having to declare one on the stack */ 00192 extern struct ast_frame ast_null_frame; 00193 00194 /*! \brief Offset into a frame's data buffer. 00195 * 00196 * By providing some "empty" space prior to the actual data of an ast_frame, 00197 * this gives any consumer of the frame ample space to prepend other necessary 00198 * information without having to create a new buffer. 00199 * 00200 * As an example, RTP can use the data from an ast_frame and simply prepend the 00201 * RTP header information into the space provided by AST_FRIENDLY_OFFSET instead 00202 * of having to create a new buffer with the necessary space allocated. 00203 */ 00204 #define AST_FRIENDLY_OFFSET 64 00205 #define AST_MIN_OFFSET 32 /*! Make sure we keep at least this much handy */ 00206 00207 /*! Need the header be free'd? */ 00208 #define AST_MALLOCD_HDR (1 << 0) 00209 /*! Need the data be free'd? */ 00210 #define AST_MALLOCD_DATA (1 << 1) 00211 /*! Need the source be free'd? (haha!) */ 00212 #define AST_MALLOCD_SRC (1 << 2) 00213 00214 /* MODEM subclasses */ 00215 /*! T.38 Fax-over-IP */ 00216 #define AST_MODEM_T38 1 00217 /*! V.150 Modem-over-IP */ 00218 #define AST_MODEM_V150 2 00219 00220 /* HTML subclasses */ 00221 /*! Sending a URL */ 00222 #define AST_HTML_URL 1 00223 /*! Data frame */ 00224 #define AST_HTML_DATA 2 00225 /*! Beginning frame */ 00226 #define AST_HTML_BEGIN 4 00227 /*! End frame */ 00228 #define AST_HTML_END 8 00229 /*! Load is complete */ 00230 #define AST_HTML_LDCOMPLETE 16 00231 /*! Peer is unable to support HTML */ 00232 #define AST_HTML_NOSUPPORT 17 00233 /*! Send URL, and track */ 00234 #define AST_HTML_LINKURL 18 00235 /*! No more HTML linkage */ 00236 #define AST_HTML_UNLINK 19 00237 /*! Reject link request */ 00238 #define AST_HTML_LINKREJECT 20 00239 00240 /* Data formats for capabilities and frames alike */ 00241 /*! G.723.1 compression */ 00242 #define AST_FORMAT_G723_1 (1ULL << 0) 00243 /*! GSM compression */ 00244 #define AST_FORMAT_GSM (1ULL << 1) 00245 /*! Raw mu-law data (G.711) */ 00246 #define AST_FORMAT_ULAW (1ULL << 2) 00247 /*! Raw A-law data (G.711) */ 00248 #define AST_FORMAT_ALAW (1ULL << 3) 00249 /*! ADPCM (G.726, 32kbps, AAL2 codeword packing) */ 00250 #define AST_FORMAT_G726_AAL2 (1ULL << 4) 00251 /*! ADPCM (IMA) */ 00252 #define AST_FORMAT_ADPCM (1ULL << 5) 00253 /*! Raw 16-bit Signed Linear (8000 Hz) PCM */ 00254 #define AST_FORMAT_SLINEAR (1ULL << 6) 00255 /*! LPC10, 180 samples/frame */ 00256 #define AST_FORMAT_LPC10 (1ULL << 7) 00257 /*! G.729A audio */ 00258 #define AST_FORMAT_G729A (1ULL << 8) 00259 /*! SpeeX Free Compression */ 00260 #define AST_FORMAT_SPEEX (1ULL << 9) 00261 /*! iLBC Free Compression */ 00262 #define AST_FORMAT_ILBC (1ULL << 10) 00263 /*! ADPCM (G.726, 32kbps, RFC3551 codeword packing) */ 00264 #define AST_FORMAT_G726 (1ULL << 11) 00265 /*! G.722 */ 00266 #define AST_FORMAT_G722 (1ULL << 12) 00267 /*! G.722.1 (also known as Siren7, 32kbps assumed) */ 00268 #define AST_FORMAT_SIREN7 (1ULL << 13) 00269 /*! G.722.1 Annex C (also known as Siren14, 48kbps assumed) */ 00270 #define AST_FORMAT_SIREN14 (1ULL << 14) 00271 /*! Raw 16-bit Signed Linear (16000 Hz) PCM */ 00272 #define AST_FORMAT_SLINEAR16 (1ULL << 15) 00273 /*! Maximum audio mask */ 00274 #define AST_FORMAT_AUDIO_MASK 0xFFFF0000FFFFULL 00275 /*! JPEG Images */ 00276 #define AST_FORMAT_JPEG (1ULL << 16) 00277 /*! PNG Images */ 00278 #define AST_FORMAT_PNG (1ULL << 17) 00279 /*! H.261 Video */ 00280 #define AST_FORMAT_H261 (1ULL << 18) 00281 #define AST_FORMAT_FIRST_VIDEO_BIT AST_FORMAT_H261 00282 /*! H.263 Video */ 00283 #define AST_FORMAT_H263 (1ULL << 19) 00284 /*! H.263+ Video */ 00285 #define AST_FORMAT_H263_PLUS (1ULL << 20) 00286 /*! H.264 Video */ 00287 #define AST_FORMAT_H264 (1ULL << 21) 00288 /*! MPEG4 Video */ 00289 #define AST_FORMAT_MP4_VIDEO (1ULL << 22) 00290 #define AST_FORMAT_VIDEO_MASK ((((1ULL << 25)-1) & ~(AST_FORMAT_AUDIO_MASK)) | 0x7FFF000000000000ULL) 00291 /*! T.140 RED Text format RFC 4103 */ 00292 #define AST_FORMAT_T140RED (1ULL << 26) 00293 /*! T.140 Text format - ITU T.140, RFC 4103 */ 00294 #define AST_FORMAT_T140 (1ULL << 27) 00295 /*! Maximum text mask */ 00296 #define AST_FORMAT_MAX_TEXT (1ULL << 28) 00297 #define AST_FORMAT_TEXT_MASK (((1ULL << 30)-1) & ~(AST_FORMAT_AUDIO_MASK) & ~(AST_FORMAT_VIDEO_MASK)) 00298 /*! G.719 (64 kbps assumed) */ 00299 #define AST_FORMAT_G719 (1ULL << 32) 00300 /*! SpeeX Wideband (16kHz) Free Compression */ 00301 #define AST_FORMAT_SPEEX16 (1ULL << 33) 00302 /*! Raw mu-law data (G.711) */ 00303 #define AST_FORMAT_TESTLAW (1ULL << 47) 00304 /*! Reserved bit - do not use */ 00305 #define AST_FORMAT_RESERVED (1ULL << 63) 00306 00307 /*! 00308 * \brief Internal control frame subtype field values. 00309 * 00310 * \warning 00311 * IAX2 sends these values out over the wire. To prevent future 00312 * incompatibilities, pick the next value in the enum from whatever 00313 * is on the current trunk. If you lose the merge race you need to 00314 * fix the previous branches to match what is on trunk. In addition 00315 * you need to change chan_iax2 to explicitly allow the control 00316 * frame over the wire if it makes sense for the frame to be passed 00317 * to another Asterisk instance. 00318 */ 00319 enum ast_control_frame_type { 00320 AST_CONTROL_HANGUP = 1, /*!< Other end has hungup */ 00321 AST_CONTROL_RING = 2, /*!< Local ring */ 00322 AST_CONTROL_RINGING = 3, /*!< Remote end is ringing */ 00323 AST_CONTROL_ANSWER = 4, /*!< Remote end has answered */ 00324 AST_CONTROL_BUSY = 5, /*!< Remote end is busy */ 00325 AST_CONTROL_TAKEOFFHOOK = 6, /*!< Make it go off hook */ 00326 AST_CONTROL_OFFHOOK = 7, /*!< Line is off hook */ 00327 AST_CONTROL_CONGESTION = 8, /*!< Congestion (circuits busy) */ 00328 AST_CONTROL_FLASH = 9, /*!< Flash hook */ 00329 AST_CONTROL_WINK = 10, /*!< Wink */ 00330 AST_CONTROL_OPTION = 11, /*!< Set a low-level option */ 00331 AST_CONTROL_RADIO_KEY = 12, /*!< Key Radio */ 00332 AST_CONTROL_RADIO_UNKEY = 13, /*!< Un-Key Radio */ 00333 AST_CONTROL_PROGRESS = 14, /*!< Indicate PROGRESS */ 00334 AST_CONTROL_PROCEEDING = 15, /*!< Indicate CALL PROCEEDING */ 00335 AST_CONTROL_HOLD = 16, /*!< Indicate call is placed on hold */ 00336 AST_CONTROL_UNHOLD = 17, /*!< Indicate call is left from hold */ 00337 AST_CONTROL_VIDUPDATE = 18, /*!< Indicate video frame update */ 00338 _XXX_AST_CONTROL_T38 = 19, /*!< T38 state change request/notification \deprecated This is no longer supported. Use AST_CONTROL_T38_PARAMETERS instead. */ 00339 AST_CONTROL_SRCUPDATE = 20, /*!< Indicate source of media has changed */ 00340 AST_CONTROL_TRANSFER = 21, /*!< Indicate status of a transfer request */ 00341 AST_CONTROL_CONNECTED_LINE = 22,/*!< Indicate connected line has changed */ 00342 AST_CONTROL_REDIRECTING = 23, /*!< Indicate redirecting id has changed */ 00343 AST_CONTROL_T38_PARAMETERS = 24,/*!< T38 state change request/notification with parameters */ 00344 AST_CONTROL_CC = 25, /*!< Indication that Call completion service is possible */ 00345 AST_CONTROL_SRCCHANGE = 26, /*!< Media source has changed and requires a new RTP SSRC */ 00346 AST_CONTROL_READ_ACTION = 27, /*!< Tell ast_read to take a specific action */ 00347 AST_CONTROL_AOC = 28, /*!< Advice of Charge with encoded generic AOC payload */ 00348 AST_CONTROL_END_OF_Q = 29, /*!< Indicate that this position was the end of the channel queue for a softhangup. */ 00349 AST_CONTROL_INCOMPLETE = 30, /*!< Indication that the extension dialed is incomplete */ 00350 AST_CONTROL_UPDATE_RTP_PEER = 32, /*!< Interrupt the bridge and have it update the peer */ 00351 00352 /* 00353 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING 00354 * 00355 * IAX2 sends these values out over the wire. To prevent future 00356 * incompatibilities, pick the next value in the enum from whatever 00357 * is on the current trunk. If you lose the merge race you need to 00358 * fix the previous branches to match what is on trunk. In addition 00359 * you need to change chan_iax2 to explicitly allow the control 00360 * frame over the wire if it makes sense for the frame to be passed 00361 * to another Asterisk instance. 00362 * 00363 * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING 00364 */ 00365 }; 00366 00367 enum ast_frame_read_action { 00368 AST_FRAME_READ_ACTION_CONNECTED_LINE_MACRO, 00369 }; 00370 00371 struct ast_control_read_action_payload { 00372 /* An indicator to ast_read of what action to 00373 * take with the frame; 00374 */ 00375 enum ast_frame_read_action action; 00376 /* The size of the frame's payload 00377 */ 00378 size_t payload_size; 00379 /* A payload for the frame. 00380 */ 00381 unsigned char payload[0]; 00382 }; 00383 00384 enum ast_control_t38 { 00385 AST_T38_REQUEST_NEGOTIATE = 1, /*!< Request T38 on a channel (voice to fax) */ 00386 AST_T38_REQUEST_TERMINATE, /*!< Terminate T38 on a channel (fax to voice) */ 00387 AST_T38_NEGOTIATED, /*!< T38 negotiated (fax mode) */ 00388 AST_T38_TERMINATED, /*!< T38 terminated (back to voice) */ 00389 AST_T38_REFUSED, /*!< T38 refused for some reason (usually rejected by remote end) */ 00390 AST_T38_REQUEST_PARMS, /*!< request far end T.38 parameters for a channel in 'negotiating' state */ 00391 }; 00392 00393 enum ast_control_t38_rate { 00394 AST_T38_RATE_2400 = 1, 00395 AST_T38_RATE_4800, 00396 AST_T38_RATE_7200, 00397 AST_T38_RATE_9600, 00398 AST_T38_RATE_12000, 00399 /* Set to 0 so it's taken as default when unspecified. 00400 * See ITU-T T.38 Implementors' Guide (11 May 2012), 00401 * Table H.2: if the T38MaxBitRate attribute is omitted 00402 * it should use a default of 14400. */ 00403 AST_T38_RATE_14400 = 0, 00404 }; 00405 00406 enum ast_control_t38_rate_management { 00407 AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF = 0, 00408 AST_T38_RATE_MANAGEMENT_LOCAL_TCF, 00409 }; 00410 00411 struct ast_control_t38_parameters { 00412 enum ast_control_t38 request_response; /*!< Request or response of the T38 control frame */ 00413 unsigned int version; /*!< Supported T.38 version */ 00414 unsigned int max_ifp; /*!< Maximum IFP size supported */ 00415 enum ast_control_t38_rate rate; /*!< Maximum fax rate supported */ 00416 enum ast_control_t38_rate_management rate_management; /*!< Rate management setting */ 00417 unsigned int fill_bit_removal:1; /*!< Set if fill bit removal can be used */ 00418 unsigned int transcoding_mmr:1; /*!< Set if MMR transcoding can be used */ 00419 unsigned int transcoding_jbig:1; /*!< Set if JBIG transcoding can be used */ 00420 }; 00421 00422 enum ast_control_transfer { 00423 AST_TRANSFER_SUCCESS = 0, /*!< Transfer request on the channel worked */ 00424 AST_TRANSFER_FAILED, /*!< Transfer request on the channel failed */ 00425 }; 00426 00427 #define AST_SMOOTHER_FLAG_G729 (1 << 0) 00428 #define AST_SMOOTHER_FLAG_BE (1 << 1) 00429 00430 /* Option identifiers and flags */ 00431 #define AST_OPTION_FLAG_REQUEST 0 00432 #define AST_OPTION_FLAG_ACCEPT 1 00433 #define AST_OPTION_FLAG_REJECT 2 00434 #define AST_OPTION_FLAG_QUERY 4 00435 #define AST_OPTION_FLAG_ANSWER 5 00436 #define AST_OPTION_FLAG_WTF 6 00437 00438 /*! Verify touchtones by muting audio transmission 00439 * (and reception) and verify the tone is still present 00440 * Option data is a single signed char value 0 or 1 */ 00441 #define AST_OPTION_TONE_VERIFY 1 00442 00443 /*! Put a compatible channel into TDD (TTY for the hearing-impared) mode 00444 * Option data is a single signed char value 0 or 1 */ 00445 #define AST_OPTION_TDD 2 00446 00447 /*! Relax the parameters for DTMF reception (mainly for radio use) 00448 * Option data is a single signed char value 0 or 1 */ 00449 #define AST_OPTION_RELAXDTMF 3 00450 00451 /*! Set (or clear) Audio (Not-Clear) Mode 00452 * Option data is a single signed char value 0 or 1 */ 00453 #define AST_OPTION_AUDIO_MODE 4 00454 00455 /*! Set channel transmit gain 00456 * Option data is a single signed char representing number of decibels (dB) 00457 * to set gain to (on top of any gain specified in channel driver) */ 00458 #define AST_OPTION_TXGAIN 5 00459 00460 /*! Set channel receive gain 00461 * Option data is a single signed char representing number of decibels (dB) 00462 * to set gain to (on top of any gain specified in channel driver) */ 00463 #define AST_OPTION_RXGAIN 6 00464 00465 /* set channel into "Operator Services" mode 00466 * Option data is a struct oprmode 00467 * 00468 * \note This option should never be sent over the network */ 00469 #define AST_OPTION_OPRMODE 7 00470 00471 /*! Explicitly enable or disable echo cancelation for the given channel 00472 * Option data is a single signed char value 0 or 1 00473 * 00474 * \note This option appears to be unused in the code. It is handled, but never 00475 * set or queried. */ 00476 #define AST_OPTION_ECHOCAN 8 00477 00478 /*! \brief Handle channel write data 00479 * If a channel needs to process the data from a func_channel write operation 00480 * after func_channel_write executes, it can define the setoption callback 00481 * and process this option. A pointer to an ast_chan_write_info_t will be passed. 00482 * 00483 * \note This option should never be passed over the network. */ 00484 #define AST_OPTION_CHANNEL_WRITE 9 00485 00486 /* ! 00487 * Read-only. Allows query current status of T38 on the channel. 00488 * data: ast_t38state 00489 */ 00490 #define AST_OPTION_T38_STATE 10 00491 00492 /*! Request that the channel driver deliver frames in a specific format 00493 * Option data is a format_t */ 00494 #define AST_OPTION_FORMAT_READ 11 00495 00496 /*! Request that the channel driver be prepared to accept frames in a specific format 00497 * Option data is a format_t */ 00498 #define AST_OPTION_FORMAT_WRITE 12 00499 00500 /*! Request that the channel driver make two channels of the same tech type compatible if possible 00501 * Option data is an ast_channel 00502 * 00503 * \note This option should never be passed over the network */ 00504 #define AST_OPTION_MAKE_COMPATIBLE 13 00505 00506 /*! Get or set the digit detection state of the channel 00507 * Option data is a single signed char value 0 or 1 */ 00508 #define AST_OPTION_DIGIT_DETECT 14 00509 00510 /*! Get or set the fax tone detection state of the channel 00511 * Option data is a single signed char value 0 or 1 */ 00512 #define AST_OPTION_FAX_DETECT 15 00513 00514 /*! Get the device name from the channel (Read only) 00515 * Option data is a character buffer of suitable length */ 00516 #define AST_OPTION_DEVICE_NAME 16 00517 00518 /*! Get the CC agent type from the channel (Read only) 00519 * Option data is a character buffer of suitable length */ 00520 #define AST_OPTION_CC_AGENT_TYPE 17 00521 00522 /*! Get or set the security options on a channel 00523 * Option data is an integer value of 0 or 1 */ 00524 #define AST_OPTION_SECURE_SIGNALING 18 00525 #define AST_OPTION_SECURE_MEDIA 19 00526 00527 struct oprmode { 00528 struct ast_channel *peer; 00529 int mode; 00530 } ; 00531 00532 struct ast_option_header { 00533 /* Always keep in network byte order */ 00534 #if __BYTE_ORDER == __BIG_ENDIAN 00535 uint16_t flag:3; 00536 uint16_t option:13; 00537 #else 00538 #if __BYTE_ORDER == __LITTLE_ENDIAN 00539 uint16_t option:13; 00540 uint16_t flag:3; 00541 #else 00542 #error Byte order not defined 00543 #endif 00544 #endif 00545 uint8_t data[0]; 00546 }; 00547 00548 00549 /*! \brief Definition of supported media formats (codecs) */ 00550 struct ast_format_list { 00551 format_t bits; /*!< bitmask value */ 00552 char *name; /*!< short name */ 00553 int samplespersecond; /*!< Number of samples per second (8000/16000) */ 00554 char *desc; /*!< Description */ 00555 int fr_len; /*!< Single frame length in bytes */ 00556 int min_ms; /*!< Min value */ 00557 int max_ms; /*!< Max value */ 00558 int inc_ms; /*!< Increment */ 00559 int def_ms; /*!< Default value */ 00560 unsigned int flags; /*!< Smoother flags */ 00561 int cur_ms; /*!< Current value */ 00562 }; 00563 00564 00565 /*! \brief Requests a frame to be allocated 00566 * 00567 * \param source 00568 * Request a frame be allocated. source is an optional source of the frame, 00569 * len is the requested length, or "0" if the caller will supply the buffer 00570 */ 00571 #if 0 /* Unimplemented */ 00572 struct ast_frame *ast_fralloc(char *source, int len); 00573 #endif 00574 00575 /*! 00576 * \brief Frees a frame or list of frames 00577 * 00578 * \param fr Frame to free, or head of list to free 00579 * \param cache Whether to consider this frame for frame caching 00580 */ 00581 void ast_frame_free(struct ast_frame *fr, int cache); 00582 00583 #define ast_frfree(fr) ast_frame_free(fr, 1) 00584 00585 /*! \brief Makes a frame independent of any static storage 00586 * \param fr frame to act upon 00587 * Take a frame, and if it's not been malloc'd, make a malloc'd copy 00588 * and if the data hasn't been malloced then make the 00589 * data malloc'd. If you need to store frames, say for queueing, then 00590 * you should call this function. 00591 * \return Returns a frame on success, NULL on error 00592 * \note This function may modify the frame passed to it, so you must 00593 * not assume the frame will be intact after the isolated frame has 00594 * been produced. In other words, calling this function on a frame 00595 * should be the last operation you do with that frame before freeing 00596 * it (or exiting the block, if the frame is on the stack.) 00597 */ 00598 struct ast_frame *ast_frisolate(struct ast_frame *fr); 00599 00600 /*! \brief Copies a frame 00601 * \param fr frame to copy 00602 * Duplicates a frame -- should only rarely be used, typically frisolate is good enough 00603 * \return Returns a frame on success, NULL on error 00604 */ 00605 struct ast_frame *ast_frdup(const struct ast_frame *fr); 00606 00607 void ast_swapcopy_samples(void *dst, const void *src, int samples); 00608 00609 /* Helpers for byteswapping native samples to/from 00610 little-endian and big-endian. */ 00611 #if __BYTE_ORDER == __LITTLE_ENDIAN 00612 #define ast_frame_byteswap_le(fr) do { ; } while(0) 00613 #define ast_frame_byteswap_be(fr) do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data.ptr, __f->data.ptr, __f->samples); } while(0) 00614 #else 00615 #define ast_frame_byteswap_le(fr) do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data.ptr, __f->data.ptr, __f->samples); } while(0) 00616 #define ast_frame_byteswap_be(fr) do { ; } while(0) 00617 #endif 00618 00619 00620 /*! \brief Get the name of a format 00621 * \param format id of format 00622 * \return A static string containing the name of the format or "unknown" if unknown. 00623 */ 00624 char* ast_getformatname(format_t format); 00625 00626 /*! \brief Get the names of a set of formats 00627 * \param buf a buffer for the output string 00628 * \param size size of buf (bytes) 00629 * \param format the format (combined IDs of codecs) 00630 * Prints a list of readable codec names corresponding to "format". 00631 * ex: for format=AST_FORMAT_GSM|AST_FORMAT_SPEEX|AST_FORMAT_ILBC it will return "0x602 (GSM|SPEEX|ILBC)" 00632 * \return The return value is buf. 00633 */ 00634 char* ast_getformatname_multiple(char *buf, size_t size, format_t format); 00635 00636 /*! 00637 * \brief Gets a format from a name. 00638 * \param name string of format 00639 * \return This returns the form of the format in binary on success, 0 on error. 00640 */ 00641 format_t ast_getformatbyname(const char *name); 00642 00643 /*! \brief Get a name from a format 00644 * Gets a name from a format 00645 * \param codec codec number (1,2,4,8,16,etc.) 00646 * \return This returns a static string identifying the format on success, 0 on error. 00647 */ 00648 char *ast_codec2str(format_t codec); 00649 00650 /*! \name AST_Smoother 00651 */ 00652 /*@{ */ 00653 /*! \page ast_smooth The AST Frame Smoother 00654 The ast_smoother interface was designed specifically 00655 to take frames of variant sizes and produce frames of a single expected 00656 size, precisely what you want to do. 00657 00658 The basic interface is: 00659 00660 - Initialize with ast_smoother_new() 00661 - Queue input frames with ast_smoother_feed() 00662 - Get output frames with ast_smoother_read() 00663 - when you're done, free the structure with ast_smoother_free() 00664 - Also see ast_smoother_test_flag(), ast_smoother_set_flags(), ast_smoother_get_flags(), ast_smoother_reset() 00665 */ 00666 struct ast_smoother; 00667 00668 struct ast_smoother *ast_smoother_new(int bytes); 00669 void ast_smoother_set_flags(struct ast_smoother *smoother, int flags); 00670 int ast_smoother_get_flags(struct ast_smoother *smoother); 00671 int ast_smoother_test_flag(struct ast_smoother *s, int flag); 00672 void ast_smoother_free(struct ast_smoother *s); 00673 void ast_smoother_reset(struct ast_smoother *s, int bytes); 00674 00675 /*! 00676 * \brief Reconfigure an existing smoother to output a different number of bytes per frame 00677 * \param s the smoother to reconfigure 00678 * \param bytes the desired number of bytes per output frame 00679 * \return nothing 00680 * 00681 */ 00682 void ast_smoother_reconfigure(struct ast_smoother *s, int bytes); 00683 00684 int __ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f, int swap); 00685 struct ast_frame *ast_smoother_read(struct ast_smoother *s); 00686 #define ast_smoother_feed(s,f) __ast_smoother_feed(s, f, 0) 00687 #if __BYTE_ORDER == __LITTLE_ENDIAN 00688 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 1) 00689 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 0) 00690 #else 00691 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 0) 00692 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 1) 00693 #endif 00694 /*@} Doxygen marker */ 00695 00696 const struct ast_format_list *ast_get_format_list_index(int index); 00697 const struct ast_format_list *ast_get_format_list(size_t *size); 00698 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix); 00699 00700 /*! \page AudioCodecPref Audio Codec Preferences 00701 00702 In order to negotiate audio codecs in the order they are configured 00703 in <channel>.conf for a device, we set up codec preference lists 00704 in addition to the codec capabilities setting. The capabilities 00705 setting is a bitmask of audio and video codecs with no internal 00706 order. This will reflect the offer given to the other side, where 00707 the prefered codecs will be added to the top of the list in the 00708 order indicated by the "allow" lines in the device configuration. 00709 00710 Video codecs are not included in the preference lists since they 00711 can't be transcoded and we just have to pick whatever is supported 00712 */ 00713 00714 /*! 00715 *\brief Initialize an audio codec preference to "no preference". 00716 * \arg \ref AudioCodecPref 00717 */ 00718 void ast_codec_pref_init(struct ast_codec_pref *pref); 00719 00720 /*! 00721 * \brief Codec located at a particular place in the preference index. 00722 * \arg \ref AudioCodecPref 00723 */ 00724 format_t ast_codec_pref_index(struct ast_codec_pref *pref, int index); 00725 00726 /*! \brief Remove audio a codec from a preference list */ 00727 void ast_codec_pref_remove(struct ast_codec_pref *pref, format_t format); 00728 00729 /*! \brief Append a audio codec to a preference list, removing it first if it was already there 00730 */ 00731 int ast_codec_pref_append(struct ast_codec_pref *pref, format_t format); 00732 00733 /*! \brief Prepend an audio codec to a preference list, removing it first if it was already there 00734 */ 00735 void ast_codec_pref_prepend(struct ast_codec_pref *pref, format_t format, int only_if_existing); 00736 00737 /*! \brief Select the best audio format according to preference list from supplied options. 00738 If "find_best" is non-zero then if nothing is found, the "Best" format of 00739 the format list is selected, otherwise 0 is returned. */ 00740 format_t ast_codec_choose(struct ast_codec_pref *pref, format_t formats, int find_best); 00741 00742 /*! \brief Set packet size for codec 00743 */ 00744 int ast_codec_pref_setsize(struct ast_codec_pref *pref, format_t format, int framems); 00745 00746 /*! \brief Get packet size for codec 00747 */ 00748 struct ast_format_list ast_codec_pref_getsize(struct ast_codec_pref *pref, format_t format); 00749 00750 /*! \brief Parse an "allow" or "deny" line in a channel or device configuration 00751 and update the capabilities mask and pref if provided. 00752 Video codecs are not added to codec preference lists, since we can not transcode 00753 \return Returns number of errors encountered during parsing 00754 */ 00755 int ast_parse_allow_disallow(struct ast_codec_pref *pref, format_t *mask, const char *list, int allowing); 00756 00757 /*! \brief Dump audio codec preference list into a string */ 00758 int ast_codec_pref_string(struct ast_codec_pref *pref, char *buf, size_t size); 00759 00760 /*! \brief Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string 00761 * \note Due to a misunderstanding in how codec preferences are stored, this 00762 * list starts at 'B', not 'A'. For backwards compatibility reasons, this 00763 * cannot change. 00764 * \param pref A codec preference list structure 00765 * \param buf A string denoting codec preference, appropriate for use in line transmission 00766 * \param size Size of \a buf 00767 * \param right Boolean: if 0, convert from \a buf to \a pref; if 1, convert from \a pref to \a buf. 00768 */ 00769 void ast_codec_pref_convert(struct ast_codec_pref *pref, char *buf, size_t size, int right); 00770 00771 /*! \brief Returns the number of samples contained in the frame */ 00772 int ast_codec_get_samples(struct ast_frame *f); 00773 00774 /*! \brief Returns the number of bytes for the number of samples of the given format */ 00775 int ast_codec_get_len(format_t format, int samples); 00776 00777 /*! \brief Appends a frame to the end of a list of frames, truncating the maximum length of the list */ 00778 struct ast_frame *ast_frame_enqueue(struct ast_frame *head, struct ast_frame *f, int maxlen, int dupe); 00779 00780 00781 /*! \brief Gets duration in ms of interpolation frame for a format */ 00782 static inline int ast_codec_interp_len(format_t format) 00783 { 00784 return (format == AST_FORMAT_ILBC) ? 30 : 20; 00785 } 00786 00787 /*! 00788 \brief Adjusts the volume of the audio samples contained in a frame. 00789 \param f The frame containing the samples (must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR) 00790 \param adjustment The number of dB to adjust up or down. 00791 \return 0 for success, non-zero for an error 00792 */ 00793 int ast_frame_adjust_volume(struct ast_frame *f, int adjustment); 00794 00795 /*! 00796 \brief Sums two frames of audio samples. 00797 \param f1 The first frame (which will contain the result) 00798 \param f2 The second frame 00799 \return 0 for success, non-zero for an error 00800 00801 The frames must be AST_FRAME_VOICE and must contain AST_FORMAT_SLINEAR samples, 00802 and must contain the same number of samples. 00803 */ 00804 int ast_frame_slinear_sum(struct ast_frame *f1, struct ast_frame *f2); 00805 00806 /*! 00807 * \brief Get the sample rate for a given format. 00808 */ 00809 static force_inline int ast_format_rate(format_t format) 00810 { 00811 switch (format) { 00812 case AST_FORMAT_G722: 00813 case AST_FORMAT_SLINEAR16: 00814 case AST_FORMAT_SIREN7: 00815 case AST_FORMAT_SPEEX16: 00816 return 16000; 00817 case AST_FORMAT_SIREN14: 00818 return 32000; 00819 case AST_FORMAT_G719: 00820 return 48000; 00821 default: 00822 return 8000; 00823 } 00824 } 00825 00826 /*! 00827 * \brief Clear all audio samples from an ast_frame. The frame must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR 00828 */ 00829 int ast_frame_clear(struct ast_frame *frame); 00830 00831 #if defined(__cplusplus) || defined(c_plusplus) 00832 } 00833 #endif 00834 00835 #endif /* _ASTERISK_FRAME_H */