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