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