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