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