include/asterisk/frame.h

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2005, Digium, Inc.
   5  *
   6  * Mark Spencer <markster@digium.com>
   7  *
   8  * See http://www.asterisk.org for more information about
   9  * the Asterisk project. Please do not directly contact
  10  * any of the maintainers of this project for assistance;
  11  * the project provides a web site, mailing lists and IRC
  12  * channels for your use.
  13  *
  14  * This program is free software, distributed under the terms of
  15  * the GNU General Public License Version 2. See the LICENSE file
  16  * at the top of the source tree.
  17  */
  18
  19 /*! \file
  20  * \brief Asterisk internal frame definitions.
  21  * \arg For an explanation of frames, see \ref Def_Frame
  22  * \arg Frames are send of Asterisk channels, see \ref Def_Channel
  23  */
  24
  25 #ifndef _ASTERISK_FRAME_H
  26 #define _ASTERISK_FRAME_H
  27
  28 #if defined(__cplusplus) || defined(c_plusplus)
  29 extern "C" {
  30 #endif
  31
  32 #include <sys/time.h>
  33
  34 #include "asterisk/endian.h"
  35 #include "asterisk/linkedlists.h"
  36
  37 struct ast_codec_pref {
  38         char order[32];
  39         char framing[32];
  40 };
  41
  42 /*! \page Def_Frame AST Multimedia and signalling frames
  43         \section Def_AstFrame What is an ast_frame ?
  44         A frame of data read used to communicate between
  45         between channels and applications.
  46         Frames are divided into frame types and subclasses.
  47
  48         \par Frame types
  49         \arg \b VOICE:  Voice data, subclass is codec (AST_FORMAT_*)
  50         \arg \b VIDEO:  Video data, subclass is codec (AST_FORMAT_*)
  51         \arg \b DTMF:   A DTMF digit, subclass is the digit
  52         \arg \b IMAGE:  Image transport, mostly used in IAX
  53         \arg \b TEXT:   Text messages and character by character (real time text)
  54         \arg \b HTML:   URL's and web pages
  55         \arg \b MODEM:  Modulated data encodings, such as T.38 and V.150
  56         \arg \b IAX:    Private frame type for the IAX protocol
  57         \arg \b CNG:    Comfort noice frames
  58         \arg \b CONTROL:        A control frame, subclass defined as AST_CONTROL_
  59         \arg \b NULL:   Empty, useless frame
  60
  61         \par Files
  62         \arg frame.h    Definitions
  63         \arg frame.c    Function library
  64         \arg \ref Def_Channel Asterisk channels
  65         \section Def_ControlFrame Control Frames
  66         Control frames send signalling information between channels
  67         and devices. They are prefixed with AST_CONTROL_, like AST_CONTROL_FRAME_HANGUP
  68         \arg \b HANGUP  The other end has hungup
  69         \arg \b RING    Local ring
  70         \arg \b RINGING The other end is ringing
  71         \arg \b ANSWER  The other end has answered
  72         \arg \b BUSY    Remote end is busy
  73         \arg \b TAKEOFFHOOK     Make it go off hook (what's "it" ? )
  74         \arg \b OFFHOOK Line is off hook
  75         \arg \b CONGESTION      Congestion (circuit is busy, not available)
  76         \arg \b FLASH   Other end sends flash hook
  77         \arg \b WINK    Other end sends wink
  78         \arg \b OPTION  Send low-level option
  79         \arg \b RADIO_KEY       Key radio (see app_rpt.c)
  80         \arg \b RADIO_UNKEY     Un-key radio (see app_rpt.c)
  81         \arg \b PROGRESS        Other end indicates call progress
  82         \arg \b PROCEEDING      Indicates proceeding
  83         \arg \b HOLD    Call is placed on hold
  84         \arg \b UNHOLD  Call is back from hold
  85         \arg \b VIDUPDATE       Video update requested
  86
  87 */
  88
  89 /*!
  90  * \brief Frame types
  91  *
  92  * \note It is important that the values of each frame type are never changed,
  93  *       because it will break backwards compatability with older versions.
  94  *       This is because these constants are transmitted directly over IAX2.
  95  */
  96 enum ast_frame_type {
  97         /*! DTMF end event, subclass is the digit */
  98         AST_FRAME_DTMF_END = 1,
  99         /*! Voice data, subclass is AST_FORMAT_* */
 100         AST_FRAME_VOICE,
 101         /*! Video frame, maybe?? :) */
 102         AST_FRAME_VIDEO,
 103         /*! A control frame, subclass is AST_CONTROL_* */
 104         AST_FRAME_CONTROL,
 105         /*! An empty, useless frame */
 106         AST_FRAME_NULL,
 107         /*! Inter Asterisk Exchange private frame type */
 108         AST_FRAME_IAX,
 109         /*! Text messages */
 110         AST_FRAME_TEXT,
 111         /*! Image Frames */
 112         AST_FRAME_IMAGE,
 113         /*! HTML Frame */
 114         AST_FRAME_HTML,
 115         /*! Comfort Noise frame (subclass is level of CNG in -dBov),
 116             body may include zero or more 8-bit quantization coefficients */
 117         AST_FRAME_CNG,
 118         /*! Modem-over-IP data streams */
 119         AST_FRAME_MODEM,
 120         /*! DTMF begin event, subclass is the digit */
 121         AST_FRAME_DTMF_BEGIN,
 122 };
 123 #define AST_FRAME_DTMF AST_FRAME_DTMF_END
 124
 125 /*! \brief Data structure associated with a single frame of data
 126  */
 127 struct ast_frame {
 128         /*! Kind of frame */
 129         enum ast_frame_type frametype;
 130         /*! Subclass, frame dependent */
 131         int subclass;
 132         /*! Length of data */
 133         int datalen;
 134         /*! Number of 8khz samples in this frame */
 135         int samples;
 136         /*! Was the data malloc'd?  i.e. should we free it when we discard the frame? */
 137         int mallocd;
 138         /*! The number of bytes allocated for a malloc'd frame header */
 139         size_t mallocd_hdr_len;
 140         /*! How many bytes exist _before_ "data" that can be used if needed */
 141         int offset;
 142         /*! Optional source of frame for debugging */
 143         const char *src;
 144         /*! Pointer to actual data */
 145         void *data;
 146         /*! Global delivery time */
 147         struct timeval delivery;
 148         /*! For placing in a linked list */
 149         AST_LIST_ENTRY(ast_frame) frame_list;
 150         /*! Timing data flag */
 151         int has_timing_info;
 152         /*! Timestamp in milliseconds */
 153         long ts;
 154         /*! Length in milliseconds */
 155         long len;
 156         /*! Sequence number */
 157         int seqno;
 158 };
 159
 160 /*!
 161  * Set the various field of a frame to point to a buffer.
 162  * Typically you set the base address of the buffer, the offset as
 163  * AST_FRIENDLY_OFFSET, and the datalen as the amount of bytes queued.
 164  * The remaining things (to be done manually) is set the number of
 165  * samples, which cannot be derived from the datalen unless you know
 166  * the number of bits per sample.
 167  */
 168 #define AST_FRAME_SET_BUFFER(fr, _base, _ofs, _datalen) \
 169         {                                       \
 170         (fr)->data = (char *)_base + (_ofs);    \
 171         (fr)->offset = (_ofs);                  \
 172         (fr)->datalen = (_datalen);             \
 173         }
 174
 175 /*! Queueing a null frame is fairly common, so we declare a global null frame object
 176     for this purpose instead of having to declare one on the stack */
 177 extern struct ast_frame ast_null_frame;
 178
 179 #define AST_FRIENDLY_OFFSET     64      /*! It's polite for a a new frame to
 180                                           have this number of bytes for additional
 181                                           headers.  */
 182 #define AST_MIN_OFFSET          32      /*! Make sure we keep at least this much handy */
 183
 184 /*! Need the header be free'd? */
 185 #define AST_MALLOCD_HDR         (1 << 0)
 186 /*! Need the data be free'd? */
 187 #define AST_MALLOCD_DATA        (1 << 1)
 188 /*! Need the source be free'd? (haha!) */
 189 #define AST_MALLOCD_SRC         (1 << 2)
 190
 191 /* MODEM subclasses */
 192 /*! T.38 Fax-over-IP */
 193 #define AST_MODEM_T38           1
 194 /*! V.150 Modem-over-IP */
 195 #define AST_MODEM_V150          2
 196
 197 /* HTML subclasses */
 198 /*! Sending a URL */
 199 #define AST_HTML_URL            1
 200 /*! Data frame */
 201 #define AST_HTML_DATA           2
 202 /*! Beginning frame */
 203 #define AST_HTML_BEGIN          4
 204 /*! End frame */
 205 #define AST_HTML_END            8
 206 /*! Load is complete */
 207 #define AST_HTML_LDCOMPLETE     16
 208 /*! Peer is unable to support HTML */
 209 #define AST_HTML_NOSUPPORT      17
 210 /*! Send URL, and track */
 211 #define AST_HTML_LINKURL        18
 212 /*! No more HTML linkage */
 213 #define AST_HTML_UNLINK         19
 214 /*! Reject link request */
 215 #define AST_HTML_LINKREJECT     20
 216
 217 /* Data formats for capabilities and frames alike */
 218 /*! G.723.1 compression */
 219 #define AST_FORMAT_G723_1       (1 << 0)
 220 /*! GSM compression */
 221 #define AST_FORMAT_GSM          (1 << 1)
 222 /*! Raw mu-law data (G.711) */
 223 #define AST_FORMAT_ULAW         (1 << 2)
 224 /*! Raw A-law data (G.711) */
 225 #define AST_FORMAT_ALAW         (1 << 3)
 226 /*! ADPCM (G.726, 32kbps, AAL2 codeword packing) */
 227 #define AST_FORMAT_G726_AAL2    (1 << 4)
 228 /*! ADPCM (IMA) */
 229 #define AST_FORMAT_ADPCM        (1 << 5)
 230 /*! Raw 16-bit Signed Linear (8000 Hz) PCM */
 231 #define AST_FORMAT_SLINEAR      (1 << 6)
 232 /*! LPC10, 180 samples/frame */
 233 #define AST_FORMAT_LPC10        (1 << 7)
 234 /*! G.729A audio */
 235 #define AST_FORMAT_G729A        (1 << 8)
 236 /*! SpeeX Free Compression */
 237 #define AST_FORMAT_SPEEX        (1 << 9)
 238 /*! iLBC Free Compression */
 239 #define AST_FORMAT_ILBC         (1 << 10)
 240 /*! ADPCM (G.726, 32kbps, RFC3551 codeword packing) */
 241 #define AST_FORMAT_G726         (1 << 11)
 242 /*! G.722 */
 243 #define AST_FORMAT_G722         (1 << 12)
 244 /*! Raw 16-bit Signed Linear (16000 Hz) PCM */
 245 #define AST_FORMAT_SLINEAR16    (1 << 15)
 246 /*! Maximum audio mask */
 247 #define AST_FORMAT_AUDIO_MASK   ((1 << 16)-1)
 248 /*! JPEG Images */
 249 #define AST_FORMAT_JPEG         (1 << 16)
 250 /*! PNG Images */
 251 #define AST_FORMAT_PNG          (1 << 17)
 252 /*! H.261 Video */
 253 #define AST_FORMAT_H261         (1 << 18)
 254 /*! H.263 Video */
 255 #define AST_FORMAT_H263         (1 << 19)
 256 /*! H.263+ Video */
 257 #define AST_FORMAT_H263_PLUS    (1 << 20)
 258 /*! H.264 Video */
 259 #define AST_FORMAT_H264         (1 << 21)
 260 /*! MPEG4 Video */
 261 #define AST_FORMAT_MP4_VIDEO    (1 << 22)
 262 #define AST_FORMAT_VIDEO_MASK   (((1 << 25)-1) & ~(AST_FORMAT_AUDIO_MASK))
 263 /*! T.140 Text format - ITU T.140, RFC 4351*/
 264 #define AST_FORMAT_T140         (1 << 25)
 265 #define AST_FORMAT_TEXT_MASK   (((1 << 30)-1) & ~(AST_FORMAT_AUDIO_MASK) & ~(AST_FORMAT_VIDEO_MASK))
 266
 267 enum ast_control_frame_type {
 268         AST_CONTROL_HANGUP = 1,         /*!< Other end has hungup */
 269         AST_CONTROL_RING = 2,           /*!< Local ring */
 270         AST_CONTROL_RINGING = 3,        /*!< Remote end is ringing */
 271         AST_CONTROL_ANSWER = 4,         /*!< Remote end has answered */
 272         AST_CONTROL_BUSY = 5,           /*!< Remote end is busy */
 273         AST_CONTROL_TAKEOFFHOOK = 6,    /*!< Make it go off hook */
 274         AST_CONTROL_OFFHOOK = 7,        /*!< Line is off hook */
 275         AST_CONTROL_CONGESTION = 8,     /*!< Congestion (circuits busy) */
 276         AST_CONTROL_FLASH = 9,          /*!< Flash hook */
 277         AST_CONTROL_WINK = 10,          /*!< Wink */
 278         AST_CONTROL_OPTION = 11,        /*!< Set a low-level option */
 279         AST_CONTROL_RADIO_KEY = 12,     /*!< Key Radio */
 280         AST_CONTROL_RADIO_UNKEY = 13,   /*!< Un-Key Radio */
 281         AST_CONTROL_PROGRESS = 14,      /*!< Indicate PROGRESS */
 282         AST_CONTROL_PROCEEDING = 15,    /*!< Indicate CALL PROCEEDING */
 283         AST_CONTROL_HOLD = 16,          /*!< Indicate call is placed on hold */
 284         AST_CONTROL_UNHOLD = 17,        /*!< Indicate call is left from hold */
 285         AST_CONTROL_VIDUPDATE = 18,     /*!< Indicate video frame update */
 286 };
 287
 288 #define AST_SMOOTHER_FLAG_G729          (1 << 0)
 289 #define AST_SMOOTHER_FLAG_BE            (1 << 1)
 290
 291 /* Option identifiers and flags */
 292 #define AST_OPTION_FLAG_REQUEST         0
 293 #define AST_OPTION_FLAG_ACCEPT          1
 294 #define AST_OPTION_FLAG_REJECT          2
 295 #define AST_OPTION_FLAG_QUERY           4
 296 #define AST_OPTION_FLAG_ANSWER          5
 297 #define AST_OPTION_FLAG_WTF             6
 298
 299 /*! Verify touchtones by muting audio transmission
 300         (and reception) and verify the tone is still present */
 301 #define AST_OPTION_TONE_VERIFY          1
 302
 303 /*! Put a compatible channel into TDD (TTY for the hearing-impared) mode */
 304 #define AST_OPTION_TDD                  2
 305
 306 /*! Relax the parameters for DTMF reception (mainly for radio use) */
 307 #define AST_OPTION_RELAXDTMF            3
 308
 309 /*! Set (or clear) Audio (Not-Clear) Mode */
 310 #define AST_OPTION_AUDIO_MODE           4
 311
 312 /*! Set channel transmit gain
 313  * Option data is a single signed char
 314    representing number of decibels (dB)
 315    to set gain to (on top of any gain
 316    specified in channel driver)
 317 */
 318 #define AST_OPTION_TXGAIN               5
 319
 320 /*! Set channel receive gain
 321  * Option data is a single signed char
 322    representing number of decibels (dB)
 323    to set gain to (on top of any gain
 324    specified in channel driver)
 325 */
 326 #define AST_OPTION_RXGAIN               6
 327
 328 /* set channel into "Operator Services" mode */
 329 #define AST_OPTION_OPRMODE              7
 330
 331 /*! Explicitly enable or disable echo cancelation for the given channel */
 332 #define AST_OPTION_ECHOCAN              8
 333
 334 struct oprmode {
 335         struct ast_channel *peer;
 336         int mode;
 337 } ;
 338
 339 struct ast_option_header {
 340         /* Always keep in network byte order */
 341 #if __BYTE_ORDER == __BIG_ENDIAN
 342         uint16_t flag:3;
 343         uint16_t option:13;
 344 #else
 345 #if __BYTE_ORDER == __LITTLE_ENDIAN
 346         uint16_t option:13;
 347         uint16_t flag:3;
 348 #else
 349 #error Byte order not defined
 350 #endif
 351 #endif
 352                 uint8_t data[0];
 353 };
 354
 355
 356 /*! \brief Definition of supported media formats (codecs) */
 357 struct ast_format_list {
 358         int bits;       /*!< bitmask value */
 359         char *name;     /*!< short name */
 360         int samplespersecond; /*!< Number of samples per second (8000/16000) */
 361         char *desc;     /*!< Description */
 362         int fr_len;     /*!< Single frame length in bytes */
 363         int min_ms;     /*!< Min value */
 364         int max_ms;     /*!< Max value */
 365         int inc_ms;     /*!< Increment */
 366         int def_ms;     /*!< Default value */
 367         unsigned int flags;     /*!< Smoother flags */
 368         int cur_ms;     /*!< Current value */
 369 };
 370
 371
 372 /*! \brief  Requests a frame to be allocated
 373  *
 374  * \param source
 375  * Request a frame be allocated.  source is an optional source of the frame,
 376  * len is the requested length, or "0" if the caller will supply the buffer
 377  */
 378 #if 0 /* Unimplemented */
 379 struct ast_frame *ast_fralloc(char *source, int len);
 380 #endif
 381
 382 /*!
 383  * \brief Frees a frame
 384  *
 385  * \param fr Frame to free
 386  * \param cache Whether to consider this frame for frame caching
 387  */
 388 void ast_frame_free(struct ast_frame *fr, int cache);
 389
 390 #define ast_frfree(fr) ast_frame_free(fr, 1)
 391
 392 /*! \brief Makes a frame independent of any static storage
 393  * \param fr frame to act upon
 394  * Take a frame, and if it's not been malloc'd, make a malloc'd copy
 395  * and if the data hasn't been malloced then make the
 396  * data malloc'd.  If you need to store frames, say for queueing, then
 397  * you should call this function.
 398  * \return Returns a frame on success, NULL on error
 399  */
 400 struct ast_frame *ast_frisolate(struct ast_frame *fr);
 401
 402 /*! \brief Copies a frame
 403  * \param fr frame to copy
 404  * Duplicates a frame -- should only rarely be used, typically frisolate is good enough
 405  * \return Returns a frame on success, NULL on error
 406  */
 407 struct ast_frame *ast_frdup(const struct ast_frame *fr);
 408
 409 void ast_swapcopy_samples(void *dst, const void *src, int samples);
 410
 411 /* Helpers for byteswapping native samples to/from
 412    little-endian and big-endian. */
 413 #if __BYTE_ORDER == __LITTLE_ENDIAN
 414 #define ast_frame_byteswap_le(fr) do { ; } while(0)
 415 #define ast_frame_byteswap_be(fr) do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data, __f->data, __f->samples); } while(0)
 416 #else
 417 #define ast_frame_byteswap_le(fr) do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data, __f->data, __f->samples); } while(0)
 418 #define ast_frame_byteswap_be(fr) do { ; } while(0)
 419 #endif
 420
 421
 422 /*! \brief Get the name of a format
 423  * \param format id of format
 424  * \return A static string containing the name of the format or "UNKN" if unknown.
 425  */
 426 char* ast_getformatname(int format);
 427
 428 /*! \brief Get the names of a set of formats
 429  * \param buf a buffer for the output string
 430  * \param size size of buf (bytes)
 431  * \param format the format (combined IDs of codecs)
 432  * Prints a list of readable codec names corresponding to "format".
 433  * ex: for format=AST_FORMAT_GSM|AST_FORMAT_SPEEX|AST_FORMAT_ILBC it will return "0x602 (GSM|SPEEX|ILBC)"
 434  * \return The return value is buf.
 435  */
 436 char* ast_getformatname_multiple(char *buf, size_t size, int format);
 437
 438 /*!
 439  * \brief Gets a format from a name.
 440  * \param name string of format
 441  * \return This returns the form of the format in binary on success, 0 on error.
 442  */
 443 int ast_getformatbyname(const char *name);
 444
 445 /*! \brief Get a name from a format
 446  * Gets a name from a format
 447  * \param codec codec number (1,2,4,8,16,etc.)
 448  * \return This returns a static string identifying the format on success, 0 on error.
 449  */
 450 char *ast_codec2str(int codec);
 451
 452 /*! \page ast_smooth
 453 The ast_smoother interface was designed specifically
 454 to take frames of variant sizes and produce frames of a single expected
 455 size, precisely what you want to do.
 456
 457 The basic interface is:
 458
 459 - Initialize with ast_smoother_new()
 460 - Queue input frames with ast_smoother_feed()
 461 - Get output frames with ast_smoother_read()
 462 - when you're done, free the structure with ast_smoother_free()
 463 - Also see ast_smoother_test_flag(), ast_smoother_set_flags(), ast_smoother_get_flags(), ast_smoother_reset()
 464 */
 465 struct ast_smoother;
 466
 467 struct ast_format_list *ast_get_format_list_index(int index);
 468 struct ast_format_list *ast_get_format_list(size_t *size);
 469 struct ast_smoother *ast_smoother_new(int bytes);
 470 void ast_smoother_set_flags(struct ast_smoother *smoother, int flags);
 471 int ast_smoother_get_flags(struct ast_smoother *smoother);
 472 int ast_smoother_test_flag(struct ast_smoother *s, int flag);
 473 void ast_smoother_free(struct ast_smoother *s);
 474 void ast_smoother_reset(struct ast_smoother *s, int bytes);
 475 int __ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f, int swap);
 476 struct ast_frame *ast_smoother_read(struct ast_smoother *s);
 477 #define ast_smoother_feed(s,f) __ast_smoother_feed(s, f, 0)
 478 #if __BYTE_ORDER == __LITTLE_ENDIAN
 479 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 1)
 480 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 0)
 481 #else
 482 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 0)
 483 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 1)
 484 #endif
 485
 486 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix);
 487
 488 /*! \page AudioCodecPref Audio Codec Preferences
 489
 490         In order to negotiate audio codecs in the order they are configured
 491         in \<channel\>.conf for a device, we set up codec preference lists
 492         in addition to the codec capabilities setting. The capabilities
 493         setting is a bitmask of audio and video codecs with no internal
 494         order. This will reflect the offer given to the other side, where
 495         the prefered codecs will be added to the top of the list in the
 496         order indicated by the "allow" lines in the device configuration.
 497
 498         Video codecs are not included in the preference lists since they
 499         can't be transcoded and we just have to pick whatever is supported
 500 */
 501
 502 /*!
 503  *\brief Initialize an audio codec preference to "no preference".
 504  * \arg \ref AudioCodecPref
 505 */
 506 void ast_codec_pref_init(struct ast_codec_pref *pref);
 507
 508 /*!
 509  * \brief Codec located at a particular place in the preference index.
 510  * \arg \ref AudioCodecPref
 511 */
 512 int ast_codec_pref_index(struct ast_codec_pref *pref, int index);
 513
 514 /*! \brief Remove audio a codec from a preference list */
 515 void ast_codec_pref_remove(struct ast_codec_pref *pref, int format);
 516
 517 /*! \brief Append a audio codec to a preference list, removing it first if it was already there
 518 */
 519 int ast_codec_pref_append(struct ast_codec_pref *pref, int format);
 520
 521 /*! \brief Select the best audio format according to preference list from supplied options.
 522    If "find_best" is non-zero then if nothing is found, the "Best" format of
 523    the format list is selected, otherwise 0 is returned. */
 524 int ast_codec_choose(struct ast_codec_pref *pref, int formats, int find_best);
 525
 526 /*! \brief Set packet size for codec
 527 */
 528 int ast_codec_pref_setsize(struct ast_codec_pref *pref, int format, int framems);
 529
 530 /*! \brief Get packet size for codec
 531 */
 532 struct ast_format_list ast_codec_pref_getsize(struct ast_codec_pref *pref, int format);
 533
 534 /*! \brief Parse an "allow" or "deny" line in a channel or device configuration
 535         and update the capabilities mask and pref if provided.
 536         Video codecs are not added to codec preference lists, since we can not transcode
 537         \return Returns number of errors encountered during parsing
 538  */
 539 int ast_parse_allow_disallow(struct ast_codec_pref *pref, int *mask, const char *list, int allowing);
 540
 541 /*! \brief Dump audio codec preference list into a string */
 542 int ast_codec_pref_string(struct ast_codec_pref *pref, char *buf, size_t size);
 543
 544 /*! \brief Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string */
 545 void ast_codec_pref_convert(struct ast_codec_pref *pref, char *buf, size_t size, int right);
 546
 547 /*! \brief Returns the number of samples contained in the frame */
 548 int ast_codec_get_samples(struct ast_frame *f);
 549
 550 /*! \brief Returns the number of bytes for the number of samples of the given format */
 551 int ast_codec_get_len(int format, int samples);
 552
 553 /*! \brief Appends a frame to the end of a list of frames, truncating the maximum length of the list */
 554 struct ast_frame *ast_frame_enqueue(struct ast_frame *head, struct ast_frame *f, int maxlen, int dupe);
 555
 556
 557 /*! \brief Gets duration in ms of interpolation frame for a format */
 558 static inline int ast_codec_interp_len(int format)
 559 {
 560         return (format == AST_FORMAT_ILBC) ? 30 : 20;
 561 }
 562
 563 /*!
 564   \brief Adjusts the volume of the audio samples contained in a frame.
 565   \param f The frame containing the samples (must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR)
 566   \param adjustment The number of dB to adjust up or down.
 567   \return 0 for success, non-zero for an error
 568  */
 569 int ast_frame_adjust_volume(struct ast_frame *f, int adjustment);
 570
 571 /*!
 572   \brief Sums two frames of audio samples.
 573   \param f1 The first frame (which will contain the result)
 574   \param f2 The second frame
 575   \return 0 for success, non-zero for an error
 576
 577   The frames must be AST_FRAME_VOICE and must contain AST_FORMAT_SLINEAR samples,
 578   and must contain the same number of samples.
 579  */
 580 int ast_frame_slinear_sum(struct ast_frame *f1, struct ast_frame *f2);
 581
 582 #if defined(__cplusplus) || defined(c_plusplus)
 583 }
 584 #endif
 585
 586 #endif /* _ASTERISK_FRAME_H */