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