cbe8cfd07b236d8211162343e53e6cac78a14ce4
[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 /*! Raw mu-law data (G.711) */
300 #define AST_FORMAT_TESTLAW       (1ULL << 47)
301 /*! Reserved bit - do not use */
302 #define AST_FORMAT_RESERVED   (1ULL << 63)
303
304 enum ast_control_frame_type {
305         AST_CONTROL_HANGUP = 1,         /*!< Other end has hungup */
306         AST_CONTROL_RING = 2,           /*!< Local ring */
307         AST_CONTROL_RINGING = 3,        /*!< Remote end is ringing */
308         AST_CONTROL_ANSWER = 4,         /*!< Remote end has answered */
309         AST_CONTROL_BUSY = 5,           /*!< Remote end is busy */
310         AST_CONTROL_TAKEOFFHOOK = 6,    /*!< Make it go off hook */
311         AST_CONTROL_OFFHOOK = 7,        /*!< Line is off hook */
312         AST_CONTROL_CONGESTION = 8,     /*!< Congestion (circuits busy) */
313         AST_CONTROL_FLASH = 9,          /*!< Flash hook */
314         AST_CONTROL_WINK = 10,          /*!< Wink */
315         AST_CONTROL_OPTION = 11,        /*!< Set a low-level option */
316         AST_CONTROL_RADIO_KEY = 12,     /*!< Key Radio */
317         AST_CONTROL_RADIO_UNKEY = 13,   /*!< Un-Key Radio */
318         AST_CONTROL_PROGRESS = 14,      /*!< Indicate PROGRESS */
319         AST_CONTROL_PROCEEDING = 15,    /*!< Indicate CALL PROCEEDING */
320         AST_CONTROL_HOLD = 16,          /*!< Indicate call is placed on hold */
321         AST_CONTROL_UNHOLD = 17,        /*!< Indicate call is left from hold */
322         AST_CONTROL_VIDUPDATE = 18,     /*!< Indicate video frame update */
323         _XXX_AST_CONTROL_T38 = 19,      /*!< T38 state change request/notification \deprecated This is no longer supported. Use AST_CONTROL_T38_PARAMETERS instead. */
324         AST_CONTROL_SRCUPDATE = 20,     /*!< Indicate source of media has changed */
325         AST_CONTROL_TRANSFER = 21,      /*!< Indicate status of a transfer request */
326         AST_CONTROL_CONNECTED_LINE = 22,/*!< Indicate connected line has changed */
327         AST_CONTROL_REDIRECTING = 23,    /*!< Indicate redirecting id has changed */
328         AST_CONTROL_T38_PARAMETERS = 24, /*! T38 state change request/notification with parameters */
329         AST_CONTROL_CC = 25, /*!< Indication that Call completion service is possible */
330         AST_CONTROL_SRCCHANGE = 26,  /*!< Media source has changed and requires a new RTP SSRC */
331         AST_CONTROL_READ_ACTION = 27, /*!< Tell ast_read to take a specific action */
332         AST_CONTROL_AOC = 28,           /*!< Advice of Charge with encoded generic AOC payload */
333 };
334
335 enum ast_frame_read_action {
336         AST_FRAME_READ_ACTION_CONNECTED_LINE_MACRO,
337 };
338
339 struct ast_control_read_action_payload {
340         /* An indicator to ast_read of what action to
341          * take with the frame;
342          */
343         enum ast_frame_read_action action;
344         /* The size of the frame's payload
345          */
346         size_t payload_size;
347         /* A payload for the frame.
348          */
349         unsigned char payload[0];
350 };
351
352 enum ast_control_t38 {
353         AST_T38_REQUEST_NEGOTIATE = 1,  /*!< Request T38 on a channel (voice to fax) */
354         AST_T38_REQUEST_TERMINATE,      /*!< Terminate T38 on a channel (fax to voice) */
355         AST_T38_NEGOTIATED,             /*!< T38 negotiated (fax mode) */
356         AST_T38_TERMINATED,             /*!< T38 terminated (back to voice) */
357         AST_T38_REFUSED,                /*!< T38 refused for some reason (usually rejected by remote end) */
358         AST_T38_REQUEST_PARMS,          /*!< request far end T.38 parameters for a channel in 'negotiating' state */
359 };
360
361 enum ast_control_t38_rate {
362         AST_T38_RATE_2400 = 0,
363         AST_T38_RATE_4800,
364         AST_T38_RATE_7200,
365         AST_T38_RATE_9600,
366         AST_T38_RATE_12000,
367         AST_T38_RATE_14400,
368 };
369
370 enum ast_control_t38_rate_management {
371         AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF = 0,
372         AST_T38_RATE_MANAGEMENT_LOCAL_TCF,
373 };
374
375 struct ast_control_t38_parameters {
376         enum ast_control_t38 request_response;                  /*!< Request or response of the T38 control frame */
377         unsigned int version;                                   /*!< Supported T.38 version */
378         unsigned int max_ifp;                                   /*!< Maximum IFP size supported */
379         enum ast_control_t38_rate rate;                         /*!< Maximum fax rate supported */
380         enum ast_control_t38_rate_management rate_management;   /*!< Rate management setting */
381         unsigned int fill_bit_removal:1;                        /*!< Set if fill bit removal can be used */
382         unsigned int transcoding_mmr:1;                         /*!< Set if MMR transcoding can be used */
383         unsigned int transcoding_jbig:1;                        /*!< Set if JBIG transcoding can be used */
384 };
385
386 enum ast_control_transfer {
387         AST_TRANSFER_SUCCESS = 0, /*!< Transfer request on the channel worked */
388         AST_TRANSFER_FAILED,      /*!< Transfer request on the channel failed */
389 };
390
391 #define AST_SMOOTHER_FLAG_G729          (1 << 0)
392 #define AST_SMOOTHER_FLAG_BE            (1 << 1)
393
394 /* Option identifiers and flags */
395 #define AST_OPTION_FLAG_REQUEST         0
396 #define AST_OPTION_FLAG_ACCEPT          1
397 #define AST_OPTION_FLAG_REJECT          2
398 #define AST_OPTION_FLAG_QUERY           4
399 #define AST_OPTION_FLAG_ANSWER          5
400 #define AST_OPTION_FLAG_WTF             6
401
402 /*! Verify touchtones by muting audio transmission 
403         (and reception) and verify the tone is still present */
404 #define AST_OPTION_TONE_VERIFY          1               
405
406 /*! Put a compatible channel into TDD (TTY for the hearing-impared) mode */
407 #define AST_OPTION_TDD                  2
408
409 /*! Relax the parameters for DTMF reception (mainly for radio use) */
410 #define AST_OPTION_RELAXDTMF            3
411
412 /*! Set (or clear) Audio (Not-Clear) Mode */
413 #define AST_OPTION_AUDIO_MODE           4
414
415 /*! Set channel transmit gain 
416  * Option data is a single signed char
417    representing number of decibels (dB)
418    to set gain to (on top of any gain
419    specified in channel driver)
420 */
421 #define AST_OPTION_TXGAIN               5
422
423 /*! Set channel receive gain
424  * Option data is a single signed char
425    representing number of decibels (dB)
426    to set gain to (on top of any gain
427    specified in channel driver)
428 */
429 #define AST_OPTION_RXGAIN               6
430
431 /* set channel into "Operator Services" mode */
432 #define AST_OPTION_OPRMODE              7
433
434 /*! Explicitly enable or disable echo cancelation for the given channel */
435 #define AST_OPTION_ECHOCAN              8
436
437 /* !
438  * Read-only. Allows query current status of T38 on the channel.
439  * data: ast_t38state
440  */
441 #define AST_OPTION_T38_STATE            10
442
443 /*! Request that the channel driver deliver frames in a specific format */
444 #define AST_OPTION_FORMAT_READ          11
445
446 /*! Request that the channel driver be prepared to accept frames in a specific format */
447 #define AST_OPTION_FORMAT_WRITE         12
448
449 /*! Request that the channel driver make two channels of the same tech type compatible if possible */
450 #define AST_OPTION_MAKE_COMPATIBLE      13
451
452 /*! Get or set the digit detection state of the channel */
453 #define AST_OPTION_DIGIT_DETECT         14
454
455 /*! Get or set the fax tone detection state of the channel */
456 #define AST_OPTION_FAX_DETECT           15
457
458 /*! Get the device name from the channel */
459 #define AST_OPTION_DEVICE_NAME          16
460
461 /*! Get the CC agent type from the channel */
462 #define AST_OPTION_CC_AGENT_TYPE    17
463
464 /*! Get or set the security options on a channel */
465 #define AST_OPTION_SECURE_SIGNALING        18
466 #define AST_OPTION_SECURE_MEDIA            19
467
468 struct oprmode {
469         struct ast_channel *peer;
470         int mode;
471 } ;
472
473 struct ast_option_header {
474         /* Always keep in network byte order */
475 #if __BYTE_ORDER == __BIG_ENDIAN
476         uint16_t flag:3;
477         uint16_t option:13;
478 #else
479 #if __BYTE_ORDER == __LITTLE_ENDIAN
480         uint16_t option:13;
481         uint16_t flag:3;
482 #else
483 #error Byte order not defined
484 #endif
485 #endif
486                 uint8_t data[0];
487 };
488
489
490 /*! \brief Definition of supported media formats (codecs) */
491 struct ast_format_list {
492         format_t bits;  /*!< bitmask value */
493         char *name;     /*!< short name */
494         int samplespersecond; /*!< Number of samples per second (8000/16000) */
495         char *desc;     /*!< Description */
496         int fr_len;     /*!< Single frame length in bytes */
497         int min_ms;     /*!< Min value */
498         int max_ms;     /*!< Max value */
499         int inc_ms;     /*!< Increment */
500         int def_ms;     /*!< Default value */
501         unsigned int flags;     /*!< Smoother flags */
502         int cur_ms;     /*!< Current value */
503 };
504
505
506 /*! \brief  Requests a frame to be allocated 
507  * 
508  * \param source 
509  * Request a frame be allocated.  source is an optional source of the frame, 
510  * len is the requested length, or "0" if the caller will supply the buffer 
511  */
512 #if 0 /* Unimplemented */
513 struct ast_frame *ast_fralloc(char *source, int len);
514 #endif
515
516 /*!  
517  * \brief Frees a frame or list of frames
518  * 
519  * \param fr Frame to free, or head of list to free
520  * \param cache Whether to consider this frame for frame caching
521  */
522 void ast_frame_free(struct ast_frame *fr, int cache);
523
524 #define ast_frfree(fr) ast_frame_free(fr, 1)
525
526 /*! \brief Makes a frame independent of any static storage
527  * \param fr frame to act upon
528  * Take a frame, and if it's not been malloc'd, make a malloc'd copy
529  * and if the data hasn't been malloced then make the
530  * data malloc'd.  If you need to store frames, say for queueing, then
531  * you should call this function.
532  * \return Returns a frame on success, NULL on error
533  * \note This function may modify the frame passed to it, so you must
534  * not assume the frame will be intact after the isolated frame has
535  * been produced. In other words, calling this function on a frame
536  * should be the last operation you do with that frame before freeing
537  * it (or exiting the block, if the frame is on the stack.)
538  */
539 struct ast_frame *ast_frisolate(struct ast_frame *fr);
540
541 /*! \brief Copies a frame 
542  * \param fr frame to copy
543  * Duplicates a frame -- should only rarely be used, typically frisolate is good enough
544  * \return Returns a frame on success, NULL on error
545  */
546 struct ast_frame *ast_frdup(const struct ast_frame *fr);
547
548 void ast_swapcopy_samples(void *dst, const void *src, int samples);
549
550 /* Helpers for byteswapping native samples to/from 
551    little-endian and big-endian. */
552 #if __BYTE_ORDER == __LITTLE_ENDIAN
553 #define ast_frame_byteswap_le(fr) do { ; } while(0)
554 #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)
555 #else
556 #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)
557 #define ast_frame_byteswap_be(fr) do { ; } while(0)
558 #endif
559
560
561 /*! \brief Get the name of a format
562  * \param format id of format
563  * \return A static string containing the name of the format or "unknown" if unknown.
564  */
565 char* ast_getformatname(format_t format);
566
567 /*! \brief Get the names of a set of formats
568  * \param buf a buffer for the output string
569  * \param size size of buf (bytes)
570  * \param format the format (combined IDs of codecs)
571  * Prints a list of readable codec names corresponding to "format".
572  * ex: for format=AST_FORMAT_GSM|AST_FORMAT_SPEEX|AST_FORMAT_ILBC it will return "0x602 (GSM|SPEEX|ILBC)"
573  * \return The return value is buf.
574  */
575 char* ast_getformatname_multiple(char *buf, size_t size, format_t format);
576
577 /*!
578  * \brief Gets a format from a name.
579  * \param name string of format
580  * \return This returns the form of the format in binary on success, 0 on error.
581  */
582 format_t ast_getformatbyname(const char *name);
583
584 /*! \brief Get a name from a format 
585  * Gets a name from a format
586  * \param codec codec number (1,2,4,8,16,etc.)
587  * \return This returns a static string identifying the format on success, 0 on error.
588  */
589 char *ast_codec2str(format_t codec);
590
591 /*! \name AST_Smoother 
592 */
593 /*@{ */
594 /*! \page ast_smooth The AST Frame Smoother
595 The ast_smoother interface was designed specifically
596 to take frames of variant sizes and produce frames of a single expected
597 size, precisely what you want to do.
598
599 The basic interface is:
600
601 - Initialize with ast_smoother_new()
602 - Queue input frames with ast_smoother_feed()
603 - Get output frames with ast_smoother_read()
604 - when you're done, free the structure with ast_smoother_free()
605 - Also see ast_smoother_test_flag(), ast_smoother_set_flags(), ast_smoother_get_flags(), ast_smoother_reset()
606 */
607 struct ast_smoother;
608
609 struct ast_smoother *ast_smoother_new(int bytes);
610 void ast_smoother_set_flags(struct ast_smoother *smoother, int flags);
611 int ast_smoother_get_flags(struct ast_smoother *smoother);
612 int ast_smoother_test_flag(struct ast_smoother *s, int flag);
613 void ast_smoother_free(struct ast_smoother *s);
614 void ast_smoother_reset(struct ast_smoother *s, int bytes);
615
616 /*!
617  * \brief Reconfigure an existing smoother to output a different number of bytes per frame
618  * \param s the smoother to reconfigure
619  * \param bytes the desired number of bytes per output frame
620  * \return nothing
621  *
622  */
623 void ast_smoother_reconfigure(struct ast_smoother *s, int bytes);
624
625 int __ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f, int swap);
626 struct ast_frame *ast_smoother_read(struct ast_smoother *s);
627 #define ast_smoother_feed(s,f) __ast_smoother_feed(s, f, 0)
628 #if __BYTE_ORDER == __LITTLE_ENDIAN
629 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 1)
630 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 0)
631 #else
632 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 0)
633 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 1)
634 #endif
635 /*@} Doxygen marker */
636
637 const struct ast_format_list *ast_get_format_list_index(int index);
638 const struct ast_format_list *ast_get_format_list(size_t *size);
639 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix);
640
641 /*! \page AudioCodecPref Audio Codec Preferences
642
643         In order to negotiate audio codecs in the order they are configured
644         in \<channel\>.conf for a device, we set up codec preference lists
645         in addition to the codec capabilities setting. The capabilities
646         setting is a bitmask of audio and video codecs with no internal
647         order. This will reflect the offer given to the other side, where
648         the prefered codecs will be added to the top of the list in the
649         order indicated by the "allow" lines in the device configuration.
650         
651         Video codecs are not included in the preference lists since they
652         can't be transcoded and we just have to pick whatever is supported
653 */
654
655 /*! 
656  *\brief Initialize an audio codec preference to "no preference".
657  * \arg \ref AudioCodecPref 
658 */
659 void ast_codec_pref_init(struct ast_codec_pref *pref);
660
661 /*! 
662  * \brief Codec located at a particular place in the preference index.
663  * \arg \ref AudioCodecPref 
664 */
665 format_t ast_codec_pref_index(struct ast_codec_pref *pref, int index);
666
667 /*! \brief Remove audio a codec from a preference list */
668 void ast_codec_pref_remove(struct ast_codec_pref *pref, format_t format);
669
670 /*! \brief Append a audio codec to a preference list, removing it first if it was already there 
671 */
672 int ast_codec_pref_append(struct ast_codec_pref *pref, format_t format);
673
674 /*! \brief Prepend an audio codec to a preference list, removing it first if it was already there 
675 */
676 void ast_codec_pref_prepend(struct ast_codec_pref *pref, format_t format, int only_if_existing);
677
678 /*! \brief Select the best audio format according to preference list from supplied options. 
679    If "find_best" is non-zero then if nothing is found, the "Best" format of 
680    the format list is selected, otherwise 0 is returned. */
681 format_t ast_codec_choose(struct ast_codec_pref *pref, format_t formats, int find_best);
682
683 /*! \brief Set packet size for codec
684 */
685 int ast_codec_pref_setsize(struct ast_codec_pref *pref, format_t format, int framems);
686
687 /*! \brief Get packet size for codec
688 */
689 struct ast_format_list ast_codec_pref_getsize(struct ast_codec_pref *pref, format_t format);
690
691 /*! \brief Parse an "allow" or "deny" line in a channel or device configuration 
692         and update the capabilities mask and pref if provided.
693         Video codecs are not added to codec preference lists, since we can not transcode
694         \return Returns number of errors encountered during parsing
695  */
696 int ast_parse_allow_disallow(struct ast_codec_pref *pref, format_t *mask, const char *list, int allowing);
697
698 /*! \brief Dump audio codec preference list into a string */
699 int ast_codec_pref_string(struct ast_codec_pref *pref, char *buf, size_t size);
700
701 /*! \brief Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string */
702 void ast_codec_pref_convert(struct ast_codec_pref *pref, char *buf, size_t size, int right);
703
704 /*! \brief Returns the number of samples contained in the frame */
705 int ast_codec_get_samples(struct ast_frame *f);
706
707 /*! \brief Returns the number of bytes for the number of samples of the given format */
708 int ast_codec_get_len(format_t format, int samples);
709
710 /*! \brief Appends a frame to the end of a list of frames, truncating the maximum length of the list */
711 struct ast_frame *ast_frame_enqueue(struct ast_frame *head, struct ast_frame *f, int maxlen, int dupe);
712
713
714 /*! \brief Gets duration in ms of interpolation frame for a format */
715 static inline int ast_codec_interp_len(format_t format) 
716
717         return (format == AST_FORMAT_ILBC) ? 30 : 20;
718 }
719
720 /*!
721   \brief Adjusts the volume of the audio samples contained in a frame.
722   \param f The frame containing the samples (must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR)
723   \param adjustment The number of dB to adjust up or down.
724   \return 0 for success, non-zero for an error
725  */
726 int ast_frame_adjust_volume(struct ast_frame *f, int adjustment);
727
728 /*!
729   \brief Sums two frames of audio samples.
730   \param f1 The first frame (which will contain the result)
731   \param f2 The second frame
732   \return 0 for success, non-zero for an error
733
734   The frames must be AST_FRAME_VOICE and must contain AST_FORMAT_SLINEAR samples,
735   and must contain the same number of samples.
736  */
737 int ast_frame_slinear_sum(struct ast_frame *f1, struct ast_frame *f2);
738
739 /*!
740  * \brief Get the sample rate for a given format.
741  */
742 static force_inline int ast_format_rate(format_t format)
743 {
744         switch (format) {
745         case AST_FORMAT_G722:
746         case AST_FORMAT_SLINEAR16:
747         case AST_FORMAT_SIREN7:
748                 return 16000;
749         case AST_FORMAT_SIREN14:
750                 return 32000;
751         case AST_FORMAT_G719:
752                 return 48000;
753         default:
754                 return 8000;
755         }
756 }
757
758 /*!
759  * \brief Clear all audio samples from an ast_frame. The frame must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR 
760  */
761 int ast_frame_clear(struct ast_frame *frame);
762
763 #if defined(__cplusplus) || defined(c_plusplus)
764 }
765 #endif
766
767 #endif /* _ASTERISK_FRAME_H */