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/endian.h" 00035 #include "asterisk/linkedlists.h" 00036 00037 struct ast_codec_pref { 00038 char order[32]; 00039 char framing[32]; 00040 }; 00041 00042 /*! \page Def_Frame AST Multimedia and signalling frames 00043 \section Def_AstFrame What is an ast_frame ? 00044 A frame of data read used to communicate between 00045 between channels and applications. 00046 Frames are divided into frame types and subclasses. 00047 00048 \par Frame types 00049 \arg \b VOICE: Voice data, subclass is codec (AST_FORMAT_*) 00050 \arg \b VIDEO: Video data, subclass is codec (AST_FORMAT_*) 00051 \arg \b DTMF: A DTMF digit, subclass is the digit 00052 \arg \b IMAGE: Image transport, mostly used in IAX 00053 \arg \b TEXT: Text messages and character by character (real time text) 00054 \arg \b HTML: URL's and web pages 00055 \arg \b MODEM: Modulated data encodings, such as T.38 and V.150 00056 \arg \b IAX: Private frame type for the IAX protocol 00057 \arg \b CNG: Comfort noice frames 00058 \arg \b CONTROL: A control frame, subclass defined as AST_CONTROL_ 00059 \arg \b NULL: Empty, useless frame 00060 00061 \par Files 00062 \arg frame.h Definitions 00063 \arg frame.c Function library 00064 \arg \ref Def_Channel Asterisk channels 00065 \section Def_ControlFrame Control Frames 00066 Control frames send signalling information between channels 00067 and devices. They are prefixed with AST_CONTROL_, like AST_CONTROL_FRAME_HANGUP 00068 \arg \b HANGUP The other end has hungup 00069 \arg \b RING Local ring 00070 \arg \b RINGING The other end is ringing 00071 \arg \b ANSWER The other end has answered 00072 \arg \b BUSY Remote end is busy 00073 \arg \b TAKEOFFHOOK Make it go off hook (what's "it" ? ) 00074 \arg \b OFFHOOK Line is off hook 00075 \arg \b CONGESTION Congestion (circuit is busy, not available) 00076 \arg \b FLASH Other end sends flash hook 00077 \arg \b WINK Other end sends wink 00078 \arg \b OPTION Send low-level option 00079 \arg \b RADIO_KEY Key radio (see app_rpt.c) 00080 \arg \b RADIO_UNKEY Un-key radio (see app_rpt.c) 00081 \arg \b PROGRESS Other end indicates call progress 00082 \arg \b PROCEEDING Indicates proceeding 00083 \arg \b HOLD Call is placed on hold 00084 \arg \b UNHOLD Call is back from hold 00085 \arg \b VIDUPDATE Video update requested 00086 \arg \b SRCUPDATE The source of media has changed (RTP marker bit must change) 00087 \arg \b SRCCHANGE Media source has changed (RTP marker bit and SSRC must change) 00088 00089 */ 00090 00091 /*! 00092 * \brief Frame types 00093 * 00094 * \note It is important that the values of each frame type are never changed, 00095 * because it will break backwards compatability with older versions. 00096 * This is because these constants are transmitted directly over IAX2. 00097 */ 00098 enum ast_frame_type { 00099 /*! DTMF end event, subclass is the digit */ 00100 AST_FRAME_DTMF_END = 1, 00101 /*! Voice data, subclass is AST_FORMAT_* */ 00102 AST_FRAME_VOICE, 00103 /*! Video frame, maybe?? :) */ 00104 AST_FRAME_VIDEO, 00105 /*! A control frame, subclass is AST_CONTROL_* */ 00106 AST_FRAME_CONTROL, 00107 /*! An empty, useless frame */ 00108 AST_FRAME_NULL, 00109 /*! Inter Asterisk Exchange private frame type */ 00110 AST_FRAME_IAX, 00111 /*! Text messages */ 00112 AST_FRAME_TEXT, 00113 /*! Image Frames */ 00114 AST_FRAME_IMAGE, 00115 /*! HTML Frame */ 00116 AST_FRAME_HTML, 00117 /*! Comfort Noise frame (subclass is level of CNG in -dBov), 00118 body may include zero or more 8-bit quantization coefficients */ 00119 AST_FRAME_CNG, 00120 /*! Modem-over-IP data streams */ 00121 AST_FRAME_MODEM, 00122 /*! DTMF begin event, subclass is the digit */ 00123 AST_FRAME_DTMF_BEGIN, 00124 }; 00125 #define AST_FRAME_DTMF AST_FRAME_DTMF_END 00126 00127 enum { 00128 /*! This frame contains valid timing information */ 00129 AST_FRFLAG_HAS_TIMING_INFO = (1 << 0), 00130 /*! This frame came from a translator and is still the original frame. 00131 * The translator can not be free'd if the frame inside of it still has 00132 * this flag set. */ 00133 AST_FRFLAG_FROM_TRANSLATOR = (1 << 1), 00134 /*! This frame came from a dsp and is still the original frame. 00135 * The dsp cannot be free'd if the frame inside of it still has 00136 * this flag set. */ 00137 AST_FRFLAG_FROM_DSP = (1 << 2), 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 int 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 (1 << 0) 00243 /*! GSM compression */ 00244 #define AST_FORMAT_GSM (1 << 1) 00245 /*! Raw mu-law data (G.711) */ 00246 #define AST_FORMAT_ULAW (1 << 2) 00247 /*! Raw A-law data (G.711) */ 00248 #define AST_FORMAT_ALAW (1 << 3) 00249 /*! ADPCM (G.726, 32kbps, AAL2 codeword packing) */ 00250 #define AST_FORMAT_G726_AAL2 (1 << 4) 00251 /*! ADPCM (IMA) */ 00252 #define AST_FORMAT_ADPCM (1 << 5) 00253 /*! Raw 16-bit Signed Linear (8000 Hz) PCM */ 00254 #define AST_FORMAT_SLINEAR (1 << 6) 00255 /*! LPC10, 180 samples/frame */ 00256 #define AST_FORMAT_LPC10 (1 << 7) 00257 /*! G.729A audio */ 00258 #define AST_FORMAT_G729A (1 << 8) 00259 /*! SpeeX Free Compression */ 00260 #define AST_FORMAT_SPEEX (1 << 9) 00261 /*! iLBC Free Compression */ 00262 #define AST_FORMAT_ILBC (1 << 10) 00263 /*! ADPCM (G.726, 32kbps, RFC3551 codeword packing) */ 00264 #define AST_FORMAT_G726 (1 << 11) 00265 /*! G.722 */ 00266 #define AST_FORMAT_G722 (1 << 12) 00267 /*! G.722.1 (also known as Siren7, 32kbps assumed) */ 00268 #define AST_FORMAT_SIREN7 (1 << 13) 00269 /*! G.722.1 Annex C (also known as Siren14, 48kbps assumed) */ 00270 #define AST_FORMAT_SIREN14 (1 << 14) 00271 /*! Raw 16-bit Signed Linear (16000 Hz) PCM */ 00272 #define AST_FORMAT_SLINEAR16 (1 << 15) 00273 /*! Maximum audio mask */ 00274 #define AST_FORMAT_AUDIO_MASK ((1 << 16)-1) 00275 /*! JPEG Images */ 00276 #define AST_FORMAT_JPEG (1 << 16) 00277 /*! PNG Images */ 00278 #define AST_FORMAT_PNG (1 << 17) 00279 /*! H.261 Video */ 00280 #define AST_FORMAT_H261 (1 << 18) 00281 /*! H.263 Video */ 00282 #define AST_FORMAT_H263 (1 << 19) 00283 /*! H.263+ Video */ 00284 #define AST_FORMAT_H263_PLUS (1 << 20) 00285 /*! H.264 Video */ 00286 #define AST_FORMAT_H264 (1 << 21) 00287 /*! MPEG4 Video */ 00288 #define AST_FORMAT_MP4_VIDEO (1 << 22) 00289 #define AST_FORMAT_VIDEO_MASK (((1 << 25)-1) & ~(AST_FORMAT_AUDIO_MASK)) 00290 /*! T.140 RED Text format RFC 4103 */ 00291 #define AST_FORMAT_T140RED (1 << 26) 00292 /*! T.140 Text format - ITU T.140, RFC 4103 */ 00293 #define AST_FORMAT_T140 (1 << 27) 00294 /*! Maximum text mask */ 00295 #define AST_FORMAT_MAX_TEXT (1 << 28)) 00296 #define AST_FORMAT_TEXT_MASK (((1 << 30)-1) & ~(AST_FORMAT_AUDIO_MASK) & ~(AST_FORMAT_VIDEO_MASK)) 00297 00298 enum ast_control_frame_type { 00299 AST_CONTROL_HANGUP = 1, /*!< Other end has hungup */ 00300 AST_CONTROL_RING = 2, /*!< Local ring */ 00301 AST_CONTROL_RINGING = 3, /*!< Remote end is ringing */ 00302 AST_CONTROL_ANSWER = 4, /*!< Remote end has answered */ 00303 AST_CONTROL_BUSY = 5, /*!< Remote end is busy */ 00304 AST_CONTROL_TAKEOFFHOOK = 6, /*!< Make it go off hook */ 00305 AST_CONTROL_OFFHOOK = 7, /*!< Line is off hook */ 00306 AST_CONTROL_CONGESTION = 8, /*!< Congestion (circuits busy) */ 00307 AST_CONTROL_FLASH = 9, /*!< Flash hook */ 00308 AST_CONTROL_WINK = 10, /*!< Wink */ 00309 AST_CONTROL_OPTION = 11, /*!< Set a low-level option */ 00310 AST_CONTROL_RADIO_KEY = 12, /*!< Key Radio */ 00311 AST_CONTROL_RADIO_UNKEY = 13, /*!< Un-Key Radio */ 00312 AST_CONTROL_PROGRESS = 14, /*!< Indicate PROGRESS */ 00313 AST_CONTROL_PROCEEDING = 15, /*!< Indicate CALL PROCEEDING */ 00314 AST_CONTROL_HOLD = 16, /*!< Indicate call is placed on hold */ 00315 AST_CONTROL_UNHOLD = 17, /*!< Indicate call is left from hold */ 00316 AST_CONTROL_VIDUPDATE = 18, /*!< Indicate video frame update */ 00317 _XXX_AST_CONTROL_T38 = 19, /*!< T38 state change request/notification \deprecated This is no longer supported. Use AST_CONTROL_T38_PARAMETERS instead. */ 00318 AST_CONTROL_SRCUPDATE = 20, /*!< Indicate source of media has changed */ 00319 AST_CONTROL_T38_PARAMETERS = 24, /*!< T38 state change request/notification with parameters */ 00320 AST_CONTROL_SRCCHANGE = 25, /*!< Media source has changed and requires a new RTP SSRC */ 00321 AST_CONTROL_END_OF_Q = 29, /*!< Indicate that this position was the end of the channel queue for a softhangup. */ 00322 }; 00323 00324 enum ast_control_t38 { 00325 AST_T38_REQUEST_NEGOTIATE = 1, /*!< Request T38 on a channel (voice to fax) */ 00326 AST_T38_REQUEST_TERMINATE, /*!< Terminate T38 on a channel (fax to voice) */ 00327 AST_T38_NEGOTIATED, /*!< T38 negotiated (fax mode) */ 00328 AST_T38_TERMINATED, /*!< T38 terminated (back to voice) */ 00329 AST_T38_REFUSED, /*!< T38 refused for some reason (usually rejected by remote end) */ 00330 AST_T38_REQUEST_PARMS, /*!< request far end T.38 parameters for a channel in 'negotiating' state */ 00331 }; 00332 00333 enum ast_control_t38_rate { 00334 AST_T38_RATE_2400 = 0, 00335 AST_T38_RATE_4800, 00336 AST_T38_RATE_7200, 00337 AST_T38_RATE_9600, 00338 AST_T38_RATE_12000, 00339 AST_T38_RATE_14400, 00340 }; 00341 00342 enum ast_control_t38_rate_management { 00343 AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF = 0, 00344 AST_T38_RATE_MANAGEMENT_LOCAL_TCF, 00345 }; 00346 00347 struct ast_control_t38_parameters { 00348 enum ast_control_t38 request_response; /*!< Request or response of the T38 control frame */ 00349 unsigned int version; /*!< Supported T.38 version */ 00350 unsigned int max_ifp; /*!< Maximum IFP size supported */ 00351 enum ast_control_t38_rate rate; /*!< Maximum fax rate supported */ 00352 enum ast_control_t38_rate_management rate_management; /*!< Rate management setting */ 00353 unsigned int fill_bit_removal:1; /*!< Set if fill bit removal can be used */ 00354 unsigned int transcoding_mmr:1; /*!< Set if MMR transcoding can be used */ 00355 unsigned int transcoding_jbig:1; /*!< Set if JBIG transcoding can be used */ 00356 }; 00357 00358 #define AST_SMOOTHER_FLAG_G729 (1 << 0) 00359 #define AST_SMOOTHER_FLAG_BE (1 << 1) 00360 00361 /* Option identifiers and flags */ 00362 #define AST_OPTION_FLAG_REQUEST 0 00363 #define AST_OPTION_FLAG_ACCEPT 1 00364 #define AST_OPTION_FLAG_REJECT 2 00365 #define AST_OPTION_FLAG_QUERY 4 00366 #define AST_OPTION_FLAG_ANSWER 5 00367 #define AST_OPTION_FLAG_WTF 6 00368 00369 /*! Verify touchtones by muting audio transmission 00370 (and reception) and verify the tone is still present */ 00371 #define AST_OPTION_TONE_VERIFY 1 00372 00373 /*! Put a compatible channel into TDD (TTY for the hearing-impared) mode */ 00374 #define AST_OPTION_TDD 2 00375 00376 /*! Relax the parameters for DTMF reception (mainly for radio use) */ 00377 #define AST_OPTION_RELAXDTMF 3 00378 00379 /*! Set (or clear) Audio (Not-Clear) Mode */ 00380 #define AST_OPTION_AUDIO_MODE 4 00381 00382 /*! Set channel transmit gain 00383 * Option data is a single signed char 00384 representing number of decibels (dB) 00385 to set gain to (on top of any gain 00386 specified in channel driver) 00387 */ 00388 #define AST_OPTION_TXGAIN 5 00389 00390 /*! Set channel receive gain 00391 * Option data is a single signed char 00392 representing number of decibels (dB) 00393 to set gain to (on top of any gain 00394 specified in channel driver) 00395 */ 00396 #define AST_OPTION_RXGAIN 6 00397 00398 /* set channel into "Operator Services" mode */ 00399 #define AST_OPTION_OPRMODE 7 00400 00401 /*! Explicitly enable or disable echo cancelation for the given channel */ 00402 #define AST_OPTION_ECHOCAN 8 00403 00404 /*! \brief Handle channel write data 00405 * If a channel needs to process the data from a func_channel write operation 00406 * after func_channel_write executes, it can define the setoption callback 00407 * and process this option. A pointer to an ast_chan_write_info_t will be passed. 00408 * */ 00409 #define AST_OPTION_CHANNEL_WRITE 9 00410 00411 /* ! 00412 * Read-only. Allows query current status of T38 on the channel. 00413 * data: ast_t38state 00414 */ 00415 #define AST_OPTION_T38_STATE 10 00416 00417 struct oprmode { 00418 struct ast_channel *peer; 00419 int mode; 00420 } ; 00421 00422 struct ast_option_header { 00423 /* Always keep in network byte order */ 00424 #if __BYTE_ORDER == __BIG_ENDIAN 00425 uint16_t flag:3; 00426 uint16_t option:13; 00427 #else 00428 #if __BYTE_ORDER == __LITTLE_ENDIAN 00429 uint16_t option:13; 00430 uint16_t flag:3; 00431 #else 00432 #error Byte order not defined 00433 #endif 00434 #endif 00435 uint8_t data[0]; 00436 }; 00437 00438 00439 /*! \brief Definition of supported media formats (codecs) */ 00440 struct ast_format_list { 00441 int bits; /*!< bitmask value */ 00442 char *name; /*!< short name */ 00443 int samplespersecond; /*!< Number of samples per second (8000/16000) */ 00444 char *desc; /*!< Description */ 00445 int fr_len; /*!< Single frame length in bytes */ 00446 int min_ms; /*!< Min value */ 00447 int max_ms; /*!< Max value */ 00448 int inc_ms; /*!< Increment */ 00449 int def_ms; /*!< Default value */ 00450 unsigned int flags; /*!< Smoother flags */ 00451 int cur_ms; /*!< Current value */ 00452 }; 00453 00454 00455 /*! \brief Requests a frame to be allocated 00456 * 00457 * \param source 00458 * Request a frame be allocated. source is an optional source of the frame, 00459 * len is the requested length, or "0" if the caller will supply the buffer 00460 */ 00461 #if 0 /* Unimplemented */ 00462 struct ast_frame *ast_fralloc(char *source, int len); 00463 #endif 00464 00465 /*! 00466 * \brief Frees a frame or list of frames 00467 * 00468 * \param fr Frame to free, or head of list to free 00469 * \param cache Whether to consider this frame for frame caching 00470 */ 00471 void ast_frame_free(struct ast_frame *fr, int cache); 00472 00473 #define ast_frfree(fr) ast_frame_free(fr, 1) 00474 00475 /*! \brief Makes a frame independent of any static storage 00476 * \param fr frame to act upon 00477 * Take a frame, and if it's not been malloc'd, make a malloc'd copy 00478 * and if the data hasn't been malloced then make the 00479 * data malloc'd. If you need to store frames, say for queueing, then 00480 * you should call this function. 00481 * \return Returns a frame on success, NULL on error 00482 * \note This function may modify the frame passed to it, so you must 00483 * not assume the frame will be intact after the isolated frame has 00484 * been produced. In other words, calling this function on a frame 00485 * should be the last operation you do with that frame before freeing 00486 * it (or exiting the block, if the frame is on the stack.) 00487 */ 00488 struct ast_frame *ast_frisolate(struct ast_frame *fr); 00489 00490 /*! \brief Copies a frame 00491 * \param fr frame to copy 00492 * Duplicates a frame -- should only rarely be used, typically frisolate is good enough 00493 * \return Returns a frame on success, NULL on error 00494 */ 00495 struct ast_frame *ast_frdup(const struct ast_frame *fr); 00496 00497 void ast_swapcopy_samples(void *dst, const void *src, int samples); 00498 00499 /* Helpers for byteswapping native samples to/from 00500 little-endian and big-endian. */ 00501 #if __BYTE_ORDER == __LITTLE_ENDIAN 00502 #define ast_frame_byteswap_le(fr) do { ; } while(0) 00503 #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) 00504 #else 00505 #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) 00506 #define ast_frame_byteswap_be(fr) do { ; } while(0) 00507 #endif 00508 00509 00510 /*! \brief Get the name of a format 00511 * \param format id of format 00512 * \return A static string containing the name of the format or "unknown" if unknown. 00513 */ 00514 char* ast_getformatname(int format); 00515 00516 /*! \brief Get the names of a set of formats 00517 * \param buf a buffer for the output string 00518 * \param size size of buf (bytes) 00519 * \param format the format (combined IDs of codecs) 00520 * Prints a list of readable codec names corresponding to "format". 00521 * ex: for format=AST_FORMAT_GSM|AST_FORMAT_SPEEX|AST_FORMAT_ILBC it will return "0x602 (GSM|SPEEX|ILBC)" 00522 * \return The return value is buf. 00523 */ 00524 char* ast_getformatname_multiple(char *buf, size_t size, int format); 00525 00526 /*! 00527 * \brief Gets a format from a name. 00528 * \param name string of format 00529 * \return This returns the form of the format in binary on success, 0 on error. 00530 */ 00531 int ast_getformatbyname(const char *name); 00532 00533 /*! \brief Get a name from a format 00534 * Gets a name from a format 00535 * \param codec codec number (1,2,4,8,16,etc.) 00536 * \return This returns a static string identifying the format on success, 0 on error. 00537 */ 00538 char *ast_codec2str(int codec); 00539 00540 /*! \name AST_Smoother 00541 */ 00542 /*@{ */ 00543 /*! \page ast_smooth The AST Frame Smoother 00544 The ast_smoother interface was designed specifically 00545 to take frames of variant sizes and produce frames of a single expected 00546 size, precisely what you want to do. 00547 00548 The basic interface is: 00549 00550 - Initialize with ast_smoother_new() 00551 - Queue input frames with ast_smoother_feed() 00552 - Get output frames with ast_smoother_read() 00553 - when you're done, free the structure with ast_smoother_free() 00554 - Also see ast_smoother_test_flag(), ast_smoother_set_flags(), ast_smoother_get_flags(), ast_smoother_reset() 00555 */ 00556 struct ast_smoother; 00557 00558 struct ast_smoother *ast_smoother_new(int bytes); 00559 void ast_smoother_set_flags(struct ast_smoother *smoother, int flags); 00560 int ast_smoother_get_flags(struct ast_smoother *smoother); 00561 int ast_smoother_test_flag(struct ast_smoother *s, int flag); 00562 void ast_smoother_free(struct ast_smoother *s); 00563 void ast_smoother_reset(struct ast_smoother *s, int bytes); 00564 00565 /*! 00566 * \brief Reconfigure an existing smoother to output a different number of bytes per frame 00567 * \param s the smoother to reconfigure 00568 * \param bytes the desired number of bytes per output frame 00569 * \return nothing 00570 * 00571 */ 00572 void ast_smoother_reconfigure(struct ast_smoother *s, int bytes); 00573 00574 int __ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f, int swap); 00575 struct ast_frame *ast_smoother_read(struct ast_smoother *s); 00576 #define ast_smoother_feed(s,f) __ast_smoother_feed(s, f, 0) 00577 #if __BYTE_ORDER == __LITTLE_ENDIAN 00578 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 1) 00579 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 0) 00580 #else 00581 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 0) 00582 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 1) 00583 #endif 00584 /*@} Doxygen marker */ 00585 00586 const struct ast_format_list *ast_get_format_list_index(int index); 00587 const struct ast_format_list *ast_get_format_list(size_t *size); 00588 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix); 00589 00590 /*! \page AudioCodecPref Audio Codec Preferences 00591 00592 In order to negotiate audio codecs in the order they are configured 00593 in <channel>.conf for a device, we set up codec preference lists 00594 in addition to the codec capabilities setting. The capabilities 00595 setting is a bitmask of audio and video codecs with no internal 00596 order. This will reflect the offer given to the other side, where 00597 the prefered codecs will be added to the top of the list in the 00598 order indicated by the "allow" lines in the device configuration. 00599 00600 Video codecs are not included in the preference lists since they 00601 can't be transcoded and we just have to pick whatever is supported 00602 */ 00603 00604 /*! 00605 *\brief Initialize an audio codec preference to "no preference". 00606 * \arg \ref AudioCodecPref 00607 */ 00608 void ast_codec_pref_init(struct ast_codec_pref *pref); 00609 00610 /*! 00611 * \brief Codec located at a particular place in the preference index. 00612 * \arg \ref AudioCodecPref 00613 */ 00614 int ast_codec_pref_index(struct ast_codec_pref *pref, int index); 00615 00616 /*! \brief Remove audio a codec from a preference list */ 00617 void ast_codec_pref_remove(struct ast_codec_pref *pref, int format); 00618 00619 /*! \brief Append a audio codec to a preference list, removing it first if it was already there 00620 */ 00621 int ast_codec_pref_append(struct ast_codec_pref *pref, int format); 00622 00623 /*! \brief Prepend an audio codec to a preference list, removing it first if it was already there 00624 */ 00625 void ast_codec_pref_prepend(struct ast_codec_pref *pref, int format, int only_if_existing); 00626 00627 /*! \brief Select the best audio format according to preference list from supplied options. 00628 If "find_best" is non-zero then if nothing is found, the "Best" format of 00629 the format list is selected, otherwise 0 is returned. */ 00630 int ast_codec_choose(struct ast_codec_pref *pref, int formats, int find_best); 00631 00632 /*! \brief Set packet size for codec 00633 */ 00634 int ast_codec_pref_setsize(struct ast_codec_pref *pref, int format, int framems); 00635 00636 /*! \brief Get packet size for codec 00637 */ 00638 struct ast_format_list ast_codec_pref_getsize(struct ast_codec_pref *pref, int format); 00639 00640 /*! \brief Parse an "allow" or "deny" line in a channel or device configuration 00641 and update the capabilities mask and pref if provided. 00642 Video codecs are not added to codec preference lists, since we can not transcode 00643 \return Returns number of errors encountered during parsing 00644 */ 00645 int ast_parse_allow_disallow(struct ast_codec_pref *pref, int *mask, const char *list, int allowing); 00646 00647 /*! \brief Dump audio codec preference list into a string */ 00648 int ast_codec_pref_string(struct ast_codec_pref *pref, char *buf, size_t size); 00649 00650 /*! \brief Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string 00651 * \note Due to a misunderstanding in how codec preferences are stored, this 00652 * list starts at 'B', not 'A'. For backwards compatibility reasons, this 00653 * cannot change. 00654 * \param pref A codec preference list structure 00655 * \param buf A string denoting codec preference, appropriate for use in line transmission 00656 * \param size Size of \a buf 00657 * \param right Boolean: if 0, convert from \a buf to \a pref; if 1, convert from \a pref to \a buf. 00658 */ 00659 void ast_codec_pref_convert(struct ast_codec_pref *pref, char *buf, size_t size, int right); 00660 00661 /*! \brief Returns the number of samples contained in the frame */ 00662 int ast_codec_get_samples(struct ast_frame *f); 00663 00664 /*! \brief Returns the number of bytes for the number of samples of the given format */ 00665 int ast_codec_get_len(int format, int samples); 00666 00667 /*! \brief Appends a frame to the end of a list of frames, truncating the maximum length of the list */ 00668 struct ast_frame *ast_frame_enqueue(struct ast_frame *head, struct ast_frame *f, int maxlen, int dupe); 00669 00670 00671 /*! \brief Gets duration in ms of interpolation frame for a format */ 00672 static inline int ast_codec_interp_len(int format) 00673 { 00674 return (format == AST_FORMAT_ILBC) ? 30 : 20; 00675 } 00676 00677 /*! 00678 \brief Adjusts the volume of the audio samples contained in a frame. 00679 \param f The frame containing the samples (must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR) 00680 \param adjustment The number of dB to adjust up or down. 00681 \return 0 for success, non-zero for an error 00682 */ 00683 int ast_frame_adjust_volume(struct ast_frame *f, int adjustment); 00684 00685 /*! 00686 \brief Sums two frames of audio samples. 00687 \param f1 The first frame (which will contain the result) 00688 \param f2 The second frame 00689 \return 0 for success, non-zero for an error 00690 00691 The frames must be AST_FRAME_VOICE and must contain AST_FORMAT_SLINEAR samples, 00692 and must contain the same number of samples. 00693 */ 00694 int ast_frame_slinear_sum(struct ast_frame *f1, struct ast_frame *f2); 00695 00696 /*! 00697 * \brief Get the sample rate for a given format. 00698 */ 00699 static force_inline int ast_format_rate(int format) 00700 { 00701 switch (format) { 00702 case AST_FORMAT_G722: 00703 case AST_FORMAT_SLINEAR16: 00704 case AST_FORMAT_SIREN7: 00705 return 16000; 00706 case AST_FORMAT_SIREN14: 00707 return 32000; 00708 default: 00709 return 8000; 00710 } 00711 } 00712 00713 #if defined(__cplusplus) || defined(c_plusplus) 00714 } 00715 #endif 00716 00717 #endif /* _ASTERISK_FRAME_H */