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