Thu Jul 9 13:40:34 2009

Asterisk developer's documentation


frame.h

Go to the documentation of this file.
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
00087 
00088 */
00089 
00090 /*!
00091  * \brief Frame types 
00092  *
00093  * \note It is important that the values of each frame type are never changed,
00094  *       because it will break backwards compatability with older versions.
00095  *       This is because these constants are transmitted directly over IAX2.
00096  */
00097 enum ast_frame_type {
00098    /*! DTMF end event, subclass is the digit */
00099    AST_FRAME_DTMF_END = 1,
00100    /*! Voice data, subclass is AST_FORMAT_* */
00101    AST_FRAME_VOICE,
00102    /*! Video frame, maybe?? :) */
00103    AST_FRAME_VIDEO,
00104    /*! A control frame, subclass is AST_CONTROL_* */
00105    AST_FRAME_CONTROL,
00106    /*! An empty, useless frame */
00107    AST_FRAME_NULL,
00108    /*! Inter Asterisk Exchange private frame type */
00109    AST_FRAME_IAX,
00110    /*! Text messages */
00111    AST_FRAME_TEXT,
00112    /*! Image Frames */
00113    AST_FRAME_IMAGE,
00114    /*! HTML Frame */
00115    AST_FRAME_HTML,
00116    /*! Comfort Noise frame (subclass is level of CNG in -dBov), 
00117        body may include zero or more 8-bit quantization coefficients */
00118    AST_FRAME_CNG,
00119    /*! Modem-over-IP data streams */
00120    AST_FRAME_MODEM,  
00121    /*! DTMF begin event, subclass is the digit */
00122    AST_FRAME_DTMF_BEGIN,
00123 };
00124 #define AST_FRAME_DTMF AST_FRAME_DTMF_END
00125 
00126 enum {
00127    /*! This frame contains valid timing information */
00128    AST_FRFLAG_HAS_TIMING_INFO = (1 << 0),
00129    /*! This frame came from a translator and is still the original frame.
00130     *  The translator can not be free'd if the frame inside of it still has
00131     *  this flag set. */
00132    AST_FRFLAG_FROM_TRANSLATOR = (1 << 1),
00133    /*! This frame came from a dsp and is still the original frame.
00134     *  The dsp cannot be free'd if the frame inside of it still has
00135     *  this flag set. */
00136    AST_FRFLAG_FROM_DSP = (1 << 2),
00137    /*! This frame came from a filestream and is still the original frame.
00138     *  The filestream cannot be free'd if the frame inside of it still has
00139     *  this flag set. */
00140    AST_FRFLAG_FROM_FILESTREAM = (1 << 3),
00141 };
00142 
00143 /*! \brief Data structure associated with a single frame of data
00144  */
00145 struct ast_frame {
00146    /*! Kind of frame */
00147    enum ast_frame_type frametype;            
00148    /*! Subclass, frame dependent */
00149    int subclass;           
00150    /*! Length of data */
00151    int datalen;            
00152    /*! Number of 8khz samples in this frame */
00153    int samples;            
00154    /*! Was the data malloc'd?  i.e. should we free it when we discard the frame? */
00155    int mallocd;            
00156    /*! The number of bytes allocated for a malloc'd frame header */
00157    size_t mallocd_hdr_len;
00158    /*! How many bytes exist _before_ "data" that can be used if needed */
00159    int offset;          
00160    /*! Optional source of frame for debugging */
00161    const char *src;           
00162    /*! Pointer to actual data */
00163    void *data;    
00164    /*! Global delivery time */      
00165    struct timeval delivery;
00166    /*! For placing in a linked list */
00167    AST_LIST_ENTRY(ast_frame) frame_list;
00168    /*! Misc. frame flags */
00169    unsigned int flags;
00170    /*! Timestamp in milliseconds */
00171    long ts;
00172    /*! Length in milliseconds */
00173    long len;
00174    /*! Sequence number */
00175    int seqno;
00176 };
00177 
00178 /*!
00179  * Set the various field of a frame to point to a buffer.
00180  * Typically you set the base address of the buffer, the offset as
00181  * AST_FRIENDLY_OFFSET, and the datalen as the amount of bytes queued.
00182  * The remaining things (to be done manually) is set the number of
00183  * samples, which cannot be derived from the datalen unless you know
00184  * the number of bits per sample.
00185  */
00186 #define  AST_FRAME_SET_BUFFER(fr, _base, _ofs, _datalen) \
00187    {              \
00188    (fr)->data = (char *)_base + (_ofs);   \
00189    (fr)->offset = (_ofs);        \
00190    (fr)->datalen = (_datalen);      \
00191    }
00192 
00193 /*! Queueing a null frame is fairly common, so we declare a global null frame object
00194     for this purpose instead of having to declare one on the stack */
00195 extern struct ast_frame ast_null_frame;
00196 
00197 /*! \brief Offset into a frame's data buffer.
00198  *
00199  * By providing some "empty" space prior to the actual data of an ast_frame,
00200  * this gives any consumer of the frame ample space to prepend other necessary
00201  * information without having to create a new buffer.
00202  *
00203  * As an example, RTP can use the data from an ast_frame and simply prepend the
00204  * RTP header information into the space provided by AST_FRIENDLY_OFFSET instead
00205  * of having to create a new buffer with the necessary space allocated.
00206  */
00207 #define AST_FRIENDLY_OFFSET   64 
00208 #define AST_MIN_OFFSET     32 /*! Make sure we keep at least this much handy */
00209 
00210 /*! Need the header be free'd? */
00211 #define AST_MALLOCD_HDR    (1 << 0)
00212 /*! Need the data be free'd? */
00213 #define AST_MALLOCD_DATA   (1 << 1)
00214 /*! Need the source be free'd? (haha!) */
00215 #define AST_MALLOCD_SRC    (1 << 2)
00216 
00217 /* MODEM subclasses */
00218 /*! T.38 Fax-over-IP */
00219 #define AST_MODEM_T38      1
00220 /*! V.150 Modem-over-IP */
00221 #define AST_MODEM_V150     2
00222 
00223 /* HTML subclasses */
00224 /*! Sending a URL */
00225 #define AST_HTML_URL    1
00226 /*! Data frame */
00227 #define AST_HTML_DATA      2
00228 /*! Beginning frame */
00229 #define AST_HTML_BEGIN     4
00230 /*! End frame */
00231 #define AST_HTML_END    8
00232 /*! Load is complete */
00233 #define AST_HTML_LDCOMPLETE   16
00234 /*! Peer is unable to support HTML */
00235 #define AST_HTML_NOSUPPORT 17
00236 /*! Send URL, and track */
00237 #define AST_HTML_LINKURL   18
00238 /*! No more HTML linkage */
00239 #define AST_HTML_UNLINK    19
00240 /*! Reject link request */
00241 #define AST_HTML_LINKREJECT   20
00242 
00243 /* Data formats for capabilities and frames alike */
00244 /*! G.723.1 compression */
00245 #define AST_FORMAT_G723_1  (1 << 0)
00246 /*! GSM compression */
00247 #define AST_FORMAT_GSM     (1 << 1)
00248 /*! Raw mu-law data (G.711) */
00249 #define AST_FORMAT_ULAW    (1 << 2)
00250 /*! Raw A-law data (G.711) */
00251 #define AST_FORMAT_ALAW    (1 << 3)
00252 /*! ADPCM (G.726, 32kbps, AAL2 codeword packing) */
00253 #define AST_FORMAT_G726_AAL2  (1 << 4)
00254 /*! ADPCM (IMA) */
00255 #define AST_FORMAT_ADPCM   (1 << 5)
00256 /*! Raw 16-bit Signed Linear (8000 Hz) PCM */
00257 #define AST_FORMAT_SLINEAR (1 << 6)
00258 /*! LPC10, 180 samples/frame */
00259 #define AST_FORMAT_LPC10   (1 << 7)
00260 /*! G.729A audio */
00261 #define AST_FORMAT_G729A   (1 << 8)
00262 /*! SpeeX Free Compression */
00263 #define AST_FORMAT_SPEEX   (1 << 9)
00264 /*! iLBC Free Compression */
00265 #define AST_FORMAT_ILBC    (1 << 10)
00266 /*! ADPCM (G.726, 32kbps, RFC3551 codeword packing) */
00267 #define AST_FORMAT_G726    (1 << 11)
00268 /*! G.722 */
00269 #define AST_FORMAT_G722    (1 << 12)
00270 /*! Unsupported audio bits */
00271 #define AST_FORMAT_AUDIO_UNDEFINED  ((1 << 13) | (1 << 14))
00272 /*! Raw 16-bit Signed Linear (16000 Hz) PCM */
00273 #define AST_FORMAT_SLINEAR16  (1 << 15)
00274 /*! Maximum audio mask */
00275 #define AST_FORMAT_AUDIO_MASK   ((1 << 16)-1)
00276 /*! JPEG Images */
00277 #define AST_FORMAT_JPEG    (1 << 16)
00278 /*! PNG Images */
00279 #define AST_FORMAT_PNG     (1 << 17)
00280 /*! H.261 Video */
00281 #define AST_FORMAT_H261    (1 << 18)
00282 /*! H.263 Video */
00283 #define AST_FORMAT_H263    (1 << 19)
00284 /*! H.263+ Video */
00285 #define AST_FORMAT_H263_PLUS  (1 << 20)
00286 /*! H.264 Video */
00287 #define AST_FORMAT_H264    (1 << 21)
00288 /*! MPEG4 Video */
00289 #define AST_FORMAT_MP4_VIDEO  (1 << 22)
00290 #define AST_FORMAT_VIDEO_MASK   (((1 << 25)-1) & ~(AST_FORMAT_AUDIO_MASK))
00291 /*! T.140 Text format - ITU T.140, RFC 4351*/
00292 #define AST_FORMAT_T140    (1 << 25)
00293 #define AST_FORMAT_TEXT_MASK   (((1 << 30)-1) & ~(AST_FORMAT_AUDIO_MASK) & ~(AST_FORMAT_VIDEO_MASK))
00294 
00295 enum ast_control_frame_type {
00296    AST_CONTROL_HANGUP = 1,    /*!< Other end has hungup */
00297    AST_CONTROL_RING = 2,      /*!< Local ring */
00298    AST_CONTROL_RINGING = 3,   /*!< Remote end is ringing */
00299    AST_CONTROL_ANSWER = 4,    /*!< Remote end has answered */
00300    AST_CONTROL_BUSY = 5,      /*!< Remote end is busy */
00301    AST_CONTROL_TAKEOFFHOOK = 6,  /*!< Make it go off hook */
00302    AST_CONTROL_OFFHOOK = 7,   /*!< Line is off hook */
00303    AST_CONTROL_CONGESTION = 8,   /*!< Congestion (circuits busy) */
00304    AST_CONTROL_FLASH = 9,     /*!< Flash hook */
00305    AST_CONTROL_WINK = 10,     /*!< Wink */
00306    AST_CONTROL_OPTION = 11,   /*!< Set a low-level option */
00307    AST_CONTROL_RADIO_KEY = 12,   /*!< Key Radio */
00308    AST_CONTROL_RADIO_UNKEY = 13, /*!< Un-Key Radio */
00309    AST_CONTROL_PROGRESS = 14, /*!< Indicate PROGRESS */
00310    AST_CONTROL_PROCEEDING = 15,  /*!< Indicate CALL PROCEEDING */
00311    AST_CONTROL_HOLD = 16,     /*!< Indicate call is placed on hold */
00312    AST_CONTROL_UNHOLD = 17,   /*!< Indicate call is left from hold */
00313    AST_CONTROL_VIDUPDATE = 18,   /*!< Indicate video frame update */
00314    AST_CONTROL_T38 = 19,      /*!< T38 state change request/notification */
00315    AST_CONTROL_SRCUPDATE = 20,     /*!< Indicate source of media has changed */
00316 };
00317 
00318 enum ast_control_t38 {
00319    AST_T38_REQUEST_NEGOTIATE = 1,   /*!< Request T38 on a channel (voice to fax) */
00320    AST_T38_REQUEST_TERMINATE, /*!< Terminate T38 on a channel (fax to voice) */
00321    AST_T38_NEGOTIATED,     /*!< T38 negotiated (fax mode) */
00322    AST_T38_TERMINATED,     /*!< T38 terminated (back to voice) */
00323    AST_T38_REFUSED         /*!< T38 refused for some reason (usually rejected by remote end) */
00324 };
00325 
00326 #define AST_SMOOTHER_FLAG_G729      (1 << 0)
00327 #define AST_SMOOTHER_FLAG_BE     (1 << 1)
00328 
00329 /* Option identifiers and flags */
00330 #define AST_OPTION_FLAG_REQUEST     0
00331 #define AST_OPTION_FLAG_ACCEPT      1
00332 #define AST_OPTION_FLAG_REJECT      2
00333 #define AST_OPTION_FLAG_QUERY    4
00334 #define AST_OPTION_FLAG_ANSWER      5
00335 #define AST_OPTION_FLAG_WTF      6
00336 
00337 /*! Verify touchtones by muting audio transmission 
00338    (and reception) and verify the tone is still present */
00339 #define AST_OPTION_TONE_VERIFY      1     
00340 
00341 /*! Put a compatible channel into TDD (TTY for the hearing-impared) mode */
00342 #define  AST_OPTION_TDD       2
00343 
00344 /*! Relax the parameters for DTMF reception (mainly for radio use) */
00345 #define  AST_OPTION_RELAXDTMF    3
00346 
00347 /*! Set (or clear) Audio (Not-Clear) Mode */
00348 #define  AST_OPTION_AUDIO_MODE      4
00349 
00350 /*! Set channel transmit gain 
00351  * Option data is a single signed char
00352    representing number of decibels (dB)
00353    to set gain to (on top of any gain
00354    specified in channel driver)
00355 */
00356 #define AST_OPTION_TXGAIN     5
00357 
00358 /*! Set channel receive gain
00359  * Option data is a single signed char
00360    representing number of decibels (dB)
00361    to set gain to (on top of any gain
00362    specified in channel driver)
00363 */
00364 #define AST_OPTION_RXGAIN     6
00365 
00366 /* set channel into "Operator Services" mode */
00367 #define  AST_OPTION_OPRMODE      7
00368 
00369 /*! Explicitly enable or disable echo cancelation for the given channel */
00370 #define  AST_OPTION_ECHOCAN      8
00371 
00372 /* !
00373  * Read-only. Allows query current status of T38 on the channel.
00374  * data: ast_t38state
00375  */
00376 #define AST_OPTION_T38_STATE     10
00377 
00378 struct oprmode {
00379    struct ast_channel *peer;
00380    int mode;
00381 } ;
00382 
00383 struct ast_option_header {
00384    /* Always keep in network byte order */
00385 #if __BYTE_ORDER == __BIG_ENDIAN
00386         uint16_t flag:3;
00387         uint16_t option:13;
00388 #else
00389 #if __BYTE_ORDER == __LITTLE_ENDIAN
00390         uint16_t option:13;
00391         uint16_t flag:3;
00392 #else
00393 #error Byte order not defined
00394 #endif
00395 #endif
00396       uint8_t data[0];
00397 };
00398 
00399 
00400 /*! \brief Definition of supported media formats (codecs) */
00401 struct ast_format_list {
00402    int bits;   /*!< bitmask value */
00403    char *name; /*!< short name */
00404    int samplespersecond; /*!< Number of samples per second (8000/16000) */
00405    char *desc; /*!< Description */
00406    int fr_len; /*!< Single frame length in bytes */
00407    int min_ms; /*!< Min value */
00408    int max_ms; /*!< Max value */
00409    int inc_ms; /*!< Increment */
00410    int def_ms; /*!< Default value */
00411    unsigned int flags;  /*!< Smoother flags */
00412    int cur_ms; /*!< Current value */
00413 };
00414 
00415 
00416 /*! \brief  Requests a frame to be allocated 
00417  * 
00418  * \param source 
00419  * Request a frame be allocated.  source is an optional source of the frame, 
00420  * len is the requested length, or "0" if the caller will supply the buffer 
00421  */
00422 #if 0 /* Unimplemented */
00423 struct ast_frame *ast_fralloc(char *source, int len);
00424 #endif
00425 
00426 /*!  
00427  * \brief Frees a frame or list of frames
00428  * 
00429  * \param fr Frame to free, or head of list to free
00430  * \param cache Whether to consider this frame for frame caching
00431  */
00432 void ast_frame_free(struct ast_frame *fr, int cache);
00433 
00434 #define ast_frfree(fr) ast_frame_free(fr, 1)
00435 
00436 /*! \brief Makes a frame independent of any static storage
00437  * \param fr frame to act upon
00438  * Take a frame, and if it's not been malloc'd, make a malloc'd copy
00439  * and if the data hasn't been malloced then make the
00440  * data malloc'd.  If you need to store frames, say for queueing, then
00441  * you should call this function.
00442  * \return Returns a frame on success, NULL on error
00443  * \note This function may modify the frame passed to it, so you must
00444  * not assume the frame will be intact after the isolated frame has
00445  * been produced. In other words, calling this function on a frame
00446  * should be the last operation you do with that frame before freeing
00447  * it (or exiting the block, if the frame is on the stack.)
00448  */
00449 struct ast_frame *ast_frisolate(struct ast_frame *fr);
00450 
00451 /*! \brief Copies a frame 
00452  * \param fr frame to copy
00453  * Duplicates a frame -- should only rarely be used, typically frisolate is good enough
00454  * \return Returns a frame on success, NULL on error
00455  */
00456 struct ast_frame *ast_frdup(const struct ast_frame *fr);
00457 
00458 void ast_swapcopy_samples(void *dst, const void *src, int samples);
00459 
00460 /* Helpers for byteswapping native samples to/from 
00461    little-endian and big-endian. */
00462 #if __BYTE_ORDER == __LITTLE_ENDIAN
00463 #define ast_frame_byteswap_le(fr) do { ; } while(0)
00464 #define ast_frame_byteswap_be(fr) do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data, __f->data, __f->samples); } while(0)
00465 #else
00466 #define ast_frame_byteswap_le(fr) do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data, __f->data, __f->samples); } while(0)
00467 #define ast_frame_byteswap_be(fr) do { ; } while(0)
00468 #endif
00469 
00470 
00471 /*! \brief Get the name of a format
00472  * \param format id of format
00473  * \return A static string containing the name of the format or "unknown" if unknown.
00474  */
00475 char* ast_getformatname(int format);
00476 
00477 /*! \brief Get the names of a set of formats
00478  * \param buf a buffer for the output string
00479  * \param size size of buf (bytes)
00480  * \param format the format (combined IDs of codecs)
00481  * Prints a list of readable codec names corresponding to "format".
00482  * ex: for format=AST_FORMAT_GSM|AST_FORMAT_SPEEX|AST_FORMAT_ILBC it will return "0x602 (GSM|SPEEX|ILBC)"
00483  * \return The return value is buf.
00484  */
00485 char* ast_getformatname_multiple(char *buf, size_t size, int format);
00486 
00487 /*!
00488  * \brief Gets a format from a name.
00489  * \param name string of format
00490  * \return This returns the form of the format in binary on success, 0 on error.
00491  */
00492 int ast_getformatbyname(const char *name);
00493 
00494 /*! \brief Get a name from a format 
00495  * Gets a name from a format
00496  * \param codec codec number (1,2,4,8,16,etc.)
00497  * \return This returns a static string identifying the format on success, 0 on error.
00498  */
00499 char *ast_codec2str(int codec);
00500 
00501 /*! \name AST_Smoother 
00502 */
00503 /*@{ */
00504 /*! \page ast_smooth The AST Frame Smoother
00505 The ast_smoother interface was designed specifically
00506 to take frames of variant sizes and produce frames of a single expected
00507 size, precisely what you want to do.
00508 
00509 The basic interface is:
00510 
00511 - Initialize with ast_smoother_new()
00512 - Queue input frames with ast_smoother_feed()
00513 - Get output frames with ast_smoother_read()
00514 - when you're done, free the structure with ast_smoother_free()
00515 - Also see ast_smoother_test_flag(), ast_smoother_set_flags(), ast_smoother_get_flags(), ast_smoother_reset()
00516 */
00517 struct ast_smoother;
00518 
00519 struct ast_smoother *ast_smoother_new(int bytes);
00520 void ast_smoother_set_flags(struct ast_smoother *smoother, int flags);
00521 int ast_smoother_get_flags(struct ast_smoother *smoother);
00522 int ast_smoother_test_flag(struct ast_smoother *s, int flag);
00523 void ast_smoother_free(struct ast_smoother *s);
00524 void ast_smoother_reset(struct ast_smoother *s, int bytes);
00525 
00526 /*!
00527  * \brief Reconfigure an existing smoother to output a different number of bytes per frame
00528  * \param s the smoother to reconfigure
00529  * \param bytes the desired number of bytes per output frame
00530  * \return nothing
00531  *
00532  */
00533 void ast_smoother_reconfigure(struct ast_smoother *s, int bytes);
00534 
00535 int __ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f, int swap);
00536 struct ast_frame *ast_smoother_read(struct ast_smoother *s);
00537 #define ast_smoother_feed(s,f) __ast_smoother_feed(s, f, 0)
00538 #if __BYTE_ORDER == __LITTLE_ENDIAN
00539 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 1)
00540 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 0)
00541 #else
00542 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 0)
00543 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 1)
00544 #endif
00545 /*@} Doxygen marker */
00546 
00547 struct ast_format_list *ast_get_format_list_index(int index);
00548 struct ast_format_list *ast_get_format_list(size_t *size);
00549 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix);
00550 
00551 /*! \page AudioCodecPref Audio Codec Preferences
00552 
00553    In order to negotiate audio codecs in the order they are configured
00554    in <channel>.conf for a device, we set up codec preference lists
00555    in addition to the codec capabilities setting. The capabilities
00556    setting is a bitmask of audio and video codecs with no internal
00557    order. This will reflect the offer given to the other side, where
00558    the prefered codecs will be added to the top of the list in the
00559    order indicated by the "allow" lines in the device configuration.
00560    
00561    Video codecs are not included in the preference lists since they
00562    can't be transcoded and we just have to pick whatever is supported
00563 */
00564 
00565 /*! 
00566  *\brief Initialize an audio codec preference to "no preference".
00567  * \arg \ref AudioCodecPref 
00568 */
00569 void ast_codec_pref_init(struct ast_codec_pref *pref);
00570 
00571 /*! 
00572  * \brief Codec located at a particular place in the preference index.
00573  * \arg \ref AudioCodecPref 
00574 */
00575 int ast_codec_pref_index(struct ast_codec_pref *pref, int index);
00576 
00577 /*! \brief Remove audio a codec from a preference list */
00578 void ast_codec_pref_remove(struct ast_codec_pref *pref, int format);
00579 
00580 /*! \brief Append a audio codec to a preference list, removing it first if it was already there 
00581 */
00582 int ast_codec_pref_append(struct ast_codec_pref *pref, int format);
00583 
00584 /*! \brief Prepend an audio codec to a preference list, removing it first if it was already there 
00585 */
00586 void ast_codec_pref_prepend(struct ast_codec_pref *pref, int format, int only_if_existing);
00587 
00588 /*! \brief Select the best audio format according to preference list from supplied options. 
00589    If "find_best" is non-zero then if nothing is found, the "Best" format of 
00590    the format list is selected, otherwise 0 is returned. */
00591 int ast_codec_choose(struct ast_codec_pref *pref, int formats, int find_best);
00592 
00593 /*! \brief Set packet size for codec
00594 */
00595 int ast_codec_pref_setsize(struct ast_codec_pref *pref, int format, int framems);
00596 
00597 /*! \brief Get packet size for codec
00598 */
00599 struct ast_format_list ast_codec_pref_getsize(struct ast_codec_pref *pref, int format);
00600 
00601 /*! \brief Parse an "allow" or "deny" line in a channel or device configuration 
00602         and update the capabilities mask and pref if provided.
00603    Video codecs are not added to codec preference lists, since we can not transcode
00604    \return Returns number of errors encountered during parsing
00605  */
00606 int ast_parse_allow_disallow(struct ast_codec_pref *pref, int *mask, const char *list, int allowing);
00607 
00608 /*! \brief Dump audio codec preference list into a string */
00609 int ast_codec_pref_string(struct ast_codec_pref *pref, char *buf, size_t size);
00610 
00611 /*! \brief Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string */
00612 void ast_codec_pref_convert(struct ast_codec_pref *pref, char *buf, size_t size, int right);
00613 
00614 /*! \brief Returns the number of samples contained in the frame */
00615 int ast_codec_get_samples(struct ast_frame *f);
00616 
00617 /*! \brief Returns the number of bytes for the number of samples of the given format */
00618 int ast_codec_get_len(int format, int samples);
00619 
00620 /*! \brief Appends a frame to the end of a list of frames, truncating the maximum length of the list */
00621 struct ast_frame *ast_frame_enqueue(struct ast_frame *head, struct ast_frame *f, int maxlen, int dupe);
00622 
00623 
00624 /*! \brief Gets duration in ms of interpolation frame for a format */
00625 static inline int ast_codec_interp_len(int format) 
00626 { 
00627    return (format == AST_FORMAT_ILBC) ? 30 : 20;
00628 }
00629 
00630 /*!
00631   \brief Adjusts the volume of the audio samples contained in a frame.
00632   \param f The frame containing the samples (must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR)
00633   \param adjustment The number of dB to adjust up or down.
00634   \return 0 for success, non-zero for an error
00635  */
00636 int ast_frame_adjust_volume(struct ast_frame *f, int adjustment);
00637 
00638 /*!
00639   \brief Sums two frames of audio samples.
00640   \param f1 The first frame (which will contain the result)
00641   \param f2 The second frame
00642   \return 0 for success, non-zero for an error
00643 
00644   The frames must be AST_FRAME_VOICE and must contain AST_FORMAT_SLINEAR samples,
00645   and must contain the same number of samples.
00646  */
00647 int ast_frame_slinear_sum(struct ast_frame *f1, struct ast_frame *f2);
00648 
00649 /*!
00650  * \brief Get the sample rate for a given format.
00651  */
00652 static force_inline int ast_format_rate(int format)
00653 {
00654    if (format == AST_FORMAT_G722 || format == AST_FORMAT_SLINEAR16)
00655       return 16000;
00656 
00657    return 8000;
00658 }
00659 
00660 #if defined(__cplusplus) || defined(c_plusplus)
00661 }
00662 #endif
00663 
00664 #endif /* _ASTERISK_FRAME_H */

Generated on Thu Jul 9 13:40:34 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7