Add ControlPlayback manager action
[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/format_pref.h"
35 #include "asterisk/format.h"
36 #include "asterisk/endian.h"
37 #include "asterisk/linkedlists.h"
38
39 /*!
40  * \page Def_Frame AST Multimedia and signalling frames
41  * \section Def_AstFrame What is an ast_frame ?
42  * A frame of data read used to communicate between 
43  * between channels and applications.
44  * Frames are divided into frame types and subclasses.
45  *
46  * \par Frame types 
47  * \arg \b VOICE:  Voice data, subclass is codec (AST_FORMAT_*)
48  * \arg \b VIDEO:  Video data, subclass is codec (AST_FORMAT_*)
49  * \arg \b DTMF:   A DTMF digit, subclass is the digit
50  * \arg \b IMAGE:  Image transport, mostly used in IAX
51  * \arg \b TEXT:   Text messages and character by character (real time text)
52  * \arg \b HTML:   URL's and web pages
53  * \arg \b MODEM:  Modulated data encodings, such as T.38 and V.150
54  * \arg \b IAX:    Private frame type for the IAX protocol
55  * \arg \b CNG:    Comfort noice frames
56  * \arg \b CONTROL:A control frame, subclass defined as AST_CONTROL_
57  * \arg \b NULL:   Empty, useless frame
58  *
59  * \par Files
60  * \arg frame.h    Definitions
61  * \arg frame.c    Function library
62  * \arg \ref Def_Channel Asterisk channels
63  * \section Def_ControlFrame Control Frames
64  * Control frames send signalling information between channels
65  * and devices. They are prefixed with AST_CONTROL_, like AST_CONTROL_FRAME_HANGUP
66  * \arg \b HANGUP          The other end has hungup
67  * \arg \b RING            Local ring
68  * \arg \b RINGING         The other end is ringing
69  * \arg \b ANSWER          The other end has answered
70  * \arg \b BUSY            Remote end is busy
71  * \arg \b TAKEOFFHOOK     Make it go off hook (what's "it" ? )
72  * \arg \b OFFHOOK         Line is off hook
73  * \arg \b CONGESTION      Congestion (circuit is busy, not available)
74  * \arg \b FLASH           Other end sends flash hook
75  * \arg \b WINK            Other end sends wink
76  * \arg \b OPTION          Send low-level option
77  * \arg \b RADIO_KEY       Key radio (see app_rpt.c)
78  * \arg \b RADIO_UNKEY     Un-key radio (see app_rpt.c)
79  * \arg \b PROGRESS        Other end indicates call progress
80  * \arg \b PROCEEDING      Indicates proceeding
81  * \arg \b HOLD            Call is placed on hold
82  * \arg \b UNHOLD          Call is back from hold
83  * \arg \b VIDUPDATE       Video update requested
84  * \arg \b SRCUPDATE       The source of media has changed (RTP marker bit must change)
85  * \arg \b SRCCHANGE       Media source has changed (RTP marker bit and SSRC must change)
86  * \arg \b CONNECTED_LINE  Connected line has changed
87  * \arg \b REDIRECTING     Call redirecting information has changed.
88  */
89
90 /*!
91  * \brief Frame types 
92  *
93  * \note It is important that the values of each frame type are never changed,
94  *       because it will break backwards compatability with older versions.
95  *       This is because these constants are transmitted directly over IAX2.
96  */
97 enum ast_frame_type {
98         /*! DTMF end event, subclass is the digit */
99         AST_FRAME_DTMF_END = 1,
100         /*! Voice data, subclass is AST_FORMAT_* */
101         AST_FRAME_VOICE,
102         /*! Video frame, maybe?? :) */
103         AST_FRAME_VIDEO,
104         /*! A control frame, subclass is AST_CONTROL_* */
105         AST_FRAME_CONTROL,
106         /*! An empty, useless frame */
107         AST_FRAME_NULL,
108         /*! Inter Asterisk Exchange private frame type */
109         AST_FRAME_IAX,
110         /*! Text messages */
111         AST_FRAME_TEXT,
112         /*! Image Frames */
113         AST_FRAME_IMAGE,
114         /*! HTML Frame */
115         AST_FRAME_HTML,
116         /*! Comfort Noise frame (subclass is level of CNG in -dBov), 
117             body may include zero or more 8-bit quantization coefficients */
118         AST_FRAME_CNG,
119         /*! Modem-over-IP data streams */
120         AST_FRAME_MODEM,        
121         /*! DTMF begin event, subclass is the digit */
122         AST_FRAME_DTMF_BEGIN,
123 };
124 #define AST_FRAME_DTMF AST_FRAME_DTMF_END
125
126 enum {
127         /*! This frame contains valid timing information */
128         AST_FRFLAG_HAS_TIMING_INFO = (1 << 0),
129 };
130
131 union ast_frame_subclass {
132         int integer;
133         struct ast_format format;
134 };
135
136 /*! \brief Data structure associated with a single frame of data
137  */
138 struct ast_frame {
139         /*! Kind of frame */
140         enum ast_frame_type frametype;                          
141         /*! Subclass, frame dependent */
142         union ast_frame_subclass subclass;
143         /*! Length of data */
144         int datalen;                            
145         /*! Number of samples in this frame */
146         int samples;                            
147         /*! Was the data malloc'd?  i.e. should we free it when we discard the frame? */
148         int mallocd;                            
149         /*! The number of bytes allocated for a malloc'd frame header */
150         size_t mallocd_hdr_len;
151         /*! How many bytes exist _before_ "data" that can be used if needed */
152         int offset;                             
153         /*! Optional source of frame for debugging */
154         const char *src;                                
155         /*! Pointer to actual data */
156         union { void *ptr; uint32_t uint32; char pad[8]; } data;
157         /*! Global delivery time */             
158         struct timeval delivery;
159         /*! For placing in a linked list */
160         AST_LIST_ENTRY(ast_frame) frame_list;
161         /*! Misc. frame flags */
162         unsigned int flags;
163         /*! Timestamp in milliseconds */
164         long ts;
165         /*! Length in milliseconds */
166         long len;
167         /*! Sequence number */
168         int seqno;
169 };
170
171 /*!
172  * Set the various field of a frame to point to a buffer.
173  * Typically you set the base address of the buffer, the offset as
174  * AST_FRIENDLY_OFFSET, and the datalen as the amount of bytes queued.
175  * The remaining things (to be done manually) is set the number of
176  * samples, which cannot be derived from the datalen unless you know
177  * the number of bits per sample.
178  */
179 #define AST_FRAME_SET_BUFFER(fr, _base, _ofs, _datalen) \
180         {                                       \
181         (fr)->data.ptr = (char *)_base + (_ofs);        \
182         (fr)->offset = (_ofs);                  \
183         (fr)->datalen = (_datalen);             \
184         }
185
186 /*! Queueing a null frame is fairly common, so we declare a global null frame object
187     for this purpose instead of having to declare one on the stack */
188 extern struct ast_frame ast_null_frame;
189
190 /*! \brief Offset into a frame's data buffer.
191  *
192  * By providing some "empty" space prior to the actual data of an ast_frame,
193  * this gives any consumer of the frame ample space to prepend other necessary
194  * information without having to create a new buffer.
195  *
196  * As an example, RTP can use the data from an ast_frame and simply prepend the
197  * RTP header information into the space provided by AST_FRIENDLY_OFFSET instead
198  * of having to create a new buffer with the necessary space allocated.
199  */
200 #define AST_FRIENDLY_OFFSET     64      
201 #define AST_MIN_OFFSET          32      /*! Make sure we keep at least this much handy */
202
203 /*! Need the header be free'd? */
204 #define AST_MALLOCD_HDR         (1 << 0)
205 /*! Need the data be free'd? */
206 #define AST_MALLOCD_DATA        (1 << 1)
207 /*! Need the source be free'd? (haha!) */
208 #define AST_MALLOCD_SRC         (1 << 2)
209
210 /* MODEM subclasses */
211 /*! T.38 Fax-over-IP */
212 #define AST_MODEM_T38           1
213 /*! V.150 Modem-over-IP */
214 #define AST_MODEM_V150          2
215
216 /* HTML subclasses */
217 /*! Sending a URL */
218 #define AST_HTML_URL            1
219 /*! Data frame */
220 #define AST_HTML_DATA           2
221 /*! Beginning frame */
222 #define AST_HTML_BEGIN          4
223 /*! End frame */
224 #define AST_HTML_END            8
225 /*! Load is complete */
226 #define AST_HTML_LDCOMPLETE     16
227 /*! Peer is unable to support HTML */
228 #define AST_HTML_NOSUPPORT      17
229 /*! Send URL, and track */
230 #define AST_HTML_LINKURL        18
231 /*! No more HTML linkage */
232 #define AST_HTML_UNLINK         19
233 /*! Reject link request */
234 #define AST_HTML_LINKREJECT     20
235
236 enum ast_control_frame_type {
237         AST_CONTROL_HANGUP = 1,                 /*!< Other end has hungup */
238         AST_CONTROL_RING = 2,                   /*!< Local ring */
239         AST_CONTROL_RINGING = 3,                /*!< Remote end is ringing */
240         AST_CONTROL_ANSWER = 4,                 /*!< Remote end has answered */
241         AST_CONTROL_BUSY = 5,                   /*!< Remote end is busy */
242         AST_CONTROL_TAKEOFFHOOK = 6,    /*!< Make it go off hook */
243         AST_CONTROL_OFFHOOK = 7,                /*!< Line is off hook */
244         AST_CONTROL_CONGESTION = 8,             /*!< Congestion (circuits busy) */
245         AST_CONTROL_FLASH = 9,                  /*!< Flash hook */
246         AST_CONTROL_WINK = 10,                  /*!< Wink */
247         AST_CONTROL_OPTION = 11,                /*!< Set a low-level option */
248         AST_CONTROL_RADIO_KEY = 12,             /*!< Key Radio */
249         AST_CONTROL_RADIO_UNKEY = 13,   /*!< Un-Key Radio */
250         AST_CONTROL_PROGRESS = 14,              /*!< Indicate PROGRESS */
251         AST_CONTROL_PROCEEDING = 15,    /*!< Indicate CALL PROCEEDING */
252         AST_CONTROL_HOLD = 16,                  /*!< Indicate call is placed on hold */
253         AST_CONTROL_UNHOLD = 17,                /*!< Indicate call is left from hold */
254         AST_CONTROL_VIDUPDATE = 18,             /*!< Indicate video frame update */
255         _XXX_AST_CONTROL_T38 = 19,              /*!< T38 state change request/notification \deprecated This is no longer supported. Use AST_CONTROL_T38_PARAMETERS instead. */
256         AST_CONTROL_SRCUPDATE = 20,             /*!< Indicate source of media has changed */
257         AST_CONTROL_TRANSFER = 21,              /*!< Indicate status of a transfer request */
258         AST_CONTROL_CONNECTED_LINE = 22,/*!< Indicate connected line has changed */
259         AST_CONTROL_REDIRECTING = 23,   /*!< Indicate redirecting id has changed */
260         AST_CONTROL_T38_PARAMETERS = 24,/*!< T38 state change request/notification with parameters */
261         AST_CONTROL_CC = 25,                    /*!< Indication that Call completion service is possible */
262         AST_CONTROL_SRCCHANGE = 26,             /*!< Media source has changed and requires a new RTP SSRC */
263         AST_CONTROL_READ_ACTION = 27,   /*!< Tell ast_read to take a specific action */
264         AST_CONTROL_AOC = 28,                   /*!< Advice of Charge with encoded generic AOC payload */
265         AST_CONTROL_END_OF_Q = 29,              /*!< Indicate that this position was the end of the channel queue for a softhangup. */
266         AST_CONTROL_INCOMPLETE = 30,    /*!< Indication that the extension dialed is incomplete */
267         AST_CONTROL_MCID = 31,                  /*!< Indicate that the caller is being malicious. */
268         AST_CONTROL_UPDATE_RTP_PEER = 32, /*!< Interrupt the bridge and have it update the peer */
269         AST_CONTROL_PVT_CAUSE_CODE = 33, /*!< Contains an update to the protocol-specific cause-code stored for branching dials */
270
271         /* Control frames used to manipulate a stream on a channel. The values for these
272          * must be greater than the allowed value for a 8-bit char, so that they avoid
273          * conflicts with DTMF values. */
274         AST_CONTROL_STREAM_STOP = 1000,         /*!< Indicate to a channel in playback to stop the stream */
275         AST_CONTROL_STREAM_SUSPEND = 1001,      /*!< Indicate to a channel in playback to suspend the stream */
276         AST_CONTROL_STREAM_RESTART = 1002,      /*!< Indicate to a channel in playback to restart the stream */
277         AST_CONTROL_STREAM_REVERSE = 1003,      /*!< Indicate to a channel in playback to rewind */
278         AST_CONTROL_STREAM_FORWARD = 1004,      /*!< Indicate to a channel in playback to fast forward */
279
280 };
281
282 enum ast_frame_read_action {
283         AST_FRAME_READ_ACTION_CONNECTED_LINE_MACRO,
284 };
285
286 struct ast_control_read_action_payload {
287         /* An indicator to ast_read of what action to
288          * take with the frame;
289          */
290         enum ast_frame_read_action action;
291         /* The size of the frame's payload
292          */
293         size_t payload_size;
294         /* A payload for the frame.
295          */
296         unsigned char payload[0];
297 };
298
299 enum ast_control_t38 {
300         AST_T38_REQUEST_NEGOTIATE = 1,  /*!< Request T38 on a channel (voice to fax) */
301         AST_T38_REQUEST_TERMINATE,      /*!< Terminate T38 on a channel (fax to voice) */
302         AST_T38_NEGOTIATED,             /*!< T38 negotiated (fax mode) */
303         AST_T38_TERMINATED,             /*!< T38 terminated (back to voice) */
304         AST_T38_REFUSED,                /*!< T38 refused for some reason (usually rejected by remote end) */
305         AST_T38_REQUEST_PARMS,          /*!< request far end T.38 parameters for a channel in 'negotiating' state */
306 };
307
308 enum ast_control_t38_rate {
309         AST_T38_RATE_2400 = 0,
310         AST_T38_RATE_4800,
311         AST_T38_RATE_7200,
312         AST_T38_RATE_9600,
313         AST_T38_RATE_12000,
314         AST_T38_RATE_14400,
315 };
316
317 enum ast_control_t38_rate_management {
318         AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF = 0,
319         AST_T38_RATE_MANAGEMENT_LOCAL_TCF,
320 };
321
322 struct ast_control_t38_parameters {
323         enum ast_control_t38 request_response;                  /*!< Request or response of the T38 control frame */
324         unsigned int version;                                   /*!< Supported T.38 version */
325         unsigned int max_ifp;                                   /*!< Maximum IFP size supported */
326         enum ast_control_t38_rate rate;                         /*!< Maximum fax rate supported */
327         enum ast_control_t38_rate_management rate_management;   /*!< Rate management setting */
328         unsigned int fill_bit_removal:1;                        /*!< Set if fill bit removal can be used */
329         unsigned int transcoding_mmr:1;                         /*!< Set if MMR transcoding can be used */
330         unsigned int transcoding_jbig:1;                        /*!< Set if JBIG transcoding can be used */
331 };
332
333 enum ast_control_transfer {
334         AST_TRANSFER_SUCCESS = 0, /*!< Transfer request on the channel worked */
335         AST_TRANSFER_FAILED,      /*!< Transfer request on the channel failed */
336 };
337
338 struct ast_control_pvt_cause_code {
339         char chan_name[AST_CHANNEL_NAME];       /*!< Name of the channel that originated the cause information */
340         unsigned int emulate_sip_cause:1;       /*!< Indicates whether this should be used to emulate SIP_CAUSE support */
341         int ast_cause;                          /*!< Asterisk cause code associated with this message */
342         char code[1];                           /*!< Tech-specific cause code information, beginning with the name of the tech */
343 };
344
345 #define AST_SMOOTHER_FLAG_G729          (1 << 0)
346 #define AST_SMOOTHER_FLAG_BE            (1 << 1)
347
348 /* Option identifiers and flags */
349 #define AST_OPTION_FLAG_REQUEST         0
350 #define AST_OPTION_FLAG_ACCEPT          1
351 #define AST_OPTION_FLAG_REJECT          2
352 #define AST_OPTION_FLAG_QUERY           4
353 #define AST_OPTION_FLAG_ANSWER          5
354 #define AST_OPTION_FLAG_WTF             6
355
356 /*! Verify touchtones by muting audio transmission 
357  * (and reception) and verify the tone is still present
358  * Option data is a single signed char value 0 or 1 */
359 #define AST_OPTION_TONE_VERIFY          1               
360
361 /*! Put a compatible channel into TDD (TTY for the hearing-impared) mode
362  * Option data is a single signed char value 0 or 1 */
363 #define AST_OPTION_TDD                  2
364
365 /*! Relax the parameters for DTMF reception (mainly for radio use)
366  * Option data is a single signed char value 0 or 1 */
367 #define AST_OPTION_RELAXDTMF            3
368
369 /*! Set (or clear) Audio (Not-Clear) Mode
370  * Option data is a single signed char value 0 or 1 */
371 #define AST_OPTION_AUDIO_MODE           4
372
373 /*! Set channel transmit gain 
374  * Option data is a single signed char representing number of decibels (dB)
375  * to set gain to (on top of any gain specified in channel driver) */
376 #define AST_OPTION_TXGAIN               5
377
378 /*! Set channel receive gain
379  * Option data is a single signed char representing number of decibels (dB)
380  * to set gain to (on top of any gain specified in channel driver) */
381 #define AST_OPTION_RXGAIN               6
382
383 /* set channel into "Operator Services" mode 
384  * Option data is a struct oprmode
385  *
386  * \note This option should never be sent over the network */
387 #define AST_OPTION_OPRMODE              7
388
389 /*! Explicitly enable or disable echo cancelation for the given channel
390  * Option data is a single signed char value 0 or 1
391  *
392  * \note This option appears to be unused in the code. It is handled, but never
393  * set or queried. */
394 #define AST_OPTION_ECHOCAN              8
395
396 /*! \brief Handle channel write data
397  * If a channel needs to process the data from a func_channel write operation
398  * after func_channel_write executes, it can define the setoption callback
399  * and process this option. A pointer to an ast_chan_write_info_t will be passed.
400  *
401  * \note This option should never be passed over the network. */
402 #define AST_OPTION_CHANNEL_WRITE 9
403
404 /* !
405  * Read-only. Allows query current status of T38 on the channel.
406  * data: ast_t38state
407  */
408 #define AST_OPTION_T38_STATE            10
409
410 /*! Request that the channel driver deliver frames in a specific format
411  * Option data is a format_t */
412 #define AST_OPTION_FORMAT_READ          11
413
414 /*! Request that the channel driver be prepared to accept frames in a specific format
415  * Option data is a format_t */
416 #define AST_OPTION_FORMAT_WRITE         12
417
418 /*! Request that the channel driver make two channels of the same tech type compatible if possible
419  * Option data is an ast_channel
420  *
421  * \note This option should never be passed over the network */
422 #define AST_OPTION_MAKE_COMPATIBLE      13
423
424 /*! Get or set the digit detection state of the channel
425  * Option data is a single signed char value 0 or 1 */
426 #define AST_OPTION_DIGIT_DETECT         14
427
428 /*! Get or set the fax tone detection state of the channel
429  * Option data is a single signed char value 0 or 1 */
430 #define AST_OPTION_FAX_DETECT           15
431
432 /*! Get the device name from the channel (Read only)
433  * Option data is a character buffer of suitable length */
434 #define AST_OPTION_DEVICE_NAME          16
435
436 /*! Get the CC agent type from the channel (Read only) 
437  * Option data is a character buffer of suitable length */
438 #define AST_OPTION_CC_AGENT_TYPE    17
439
440 /*! Get or set the security options on a channel
441  * Option data is an integer value of 0 or 1 */
442 #define AST_OPTION_SECURE_SIGNALING        18
443 #define AST_OPTION_SECURE_MEDIA            19
444
445 struct oprmode {
446         struct ast_channel *peer;
447         int mode;
448 } ;
449
450 struct ast_option_header {
451         /* Always keep in network byte order */
452 #if __BYTE_ORDER == __BIG_ENDIAN
453         uint16_t flag:3;
454         uint16_t option:13;
455 #else
456 #if __BYTE_ORDER == __LITTLE_ENDIAN
457         uint16_t option:13;
458         uint16_t flag:3;
459 #else
460 #error Byte order not defined
461 #endif
462 #endif
463                 uint8_t data[0];
464 };
465
466 /*! \brief  Requests a frame to be allocated 
467  * 
468  * \param source 
469  * Request a frame be allocated.  source is an optional source of the frame, 
470  * len is the requested length, or "0" if the caller will supply the buffer 
471  */
472 #if 0 /* Unimplemented */
473 struct ast_frame *ast_fralloc(char *source, int len);
474 #endif
475
476 /*!  
477  * \brief Frees a frame or list of frames
478  * 
479  * \param fr Frame to free, or head of list to free
480  * \param cache Whether to consider this frame for frame caching
481  */
482 void ast_frame_free(struct ast_frame *fr, int cache);
483
484 #define ast_frfree(fr) ast_frame_free(fr, 1)
485
486 /*! \brief Makes a frame independent of any static storage
487  * \param fr frame to act upon
488  * Take a frame, and if it's not been malloc'd, make a malloc'd copy
489  * and if the data hasn't been malloced then make the
490  * data malloc'd.  If you need to store frames, say for queueing, then
491  * you should call this function.
492  * \return Returns a frame on success, NULL on error
493  * \note This function may modify the frame passed to it, so you must
494  * not assume the frame will be intact after the isolated frame has
495  * been produced. In other words, calling this function on a frame
496  * should be the last operation you do with that frame before freeing
497  * it (or exiting the block, if the frame is on the stack.)
498  */
499 struct ast_frame *ast_frisolate(struct ast_frame *fr);
500
501 /*! \brief Copies a frame 
502  * \param fr frame to copy
503  * Duplicates a frame -- should only rarely be used, typically frisolate is good enough
504  * \return Returns a frame on success, NULL on error
505  */
506 struct ast_frame *ast_frdup(const struct ast_frame *fr);
507
508 void ast_swapcopy_samples(void *dst, const void *src, int samples);
509
510 /* Helpers for byteswapping native samples to/from 
511    little-endian and big-endian. */
512 #if __BYTE_ORDER == __LITTLE_ENDIAN
513 #define ast_frame_byteswap_le(fr) do { ; } while(0)
514 #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)
515 #else
516 #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)
517 #define ast_frame_byteswap_be(fr) do { ; } while(0)
518 #endif
519
520 /*! \brief Parse an "allow" or "deny" line in a channel or device configuration
521         and update the capabilities and pref if provided.
522         Video codecs are not added to codec preference lists, since we can not transcode
523         \return Returns number of errors encountered during parsing
524  */
525 int ast_parse_allow_disallow(struct ast_codec_pref *pref, struct ast_format_cap *cap, const char *list, int allowing);
526
527 /*! \name AST_Smoother 
528 */
529 /*@{ */
530 /*! \page ast_smooth The AST Frame Smoother
531 The ast_smoother interface was designed specifically
532 to take frames of variant sizes and produce frames of a single expected
533 size, precisely what you want to do.
534
535 The basic interface is:
536
537 - Initialize with ast_smoother_new()
538 - Queue input frames with ast_smoother_feed()
539 - Get output frames with ast_smoother_read()
540 - when you're done, free the structure with ast_smoother_free()
541 - Also see ast_smoother_test_flag(), ast_smoother_set_flags(), ast_smoother_get_flags(), ast_smoother_reset()
542 */
543 struct ast_smoother;
544
545 struct ast_smoother *ast_smoother_new(int bytes);
546 void ast_smoother_set_flags(struct ast_smoother *smoother, int flags);
547 int ast_smoother_get_flags(struct ast_smoother *smoother);
548 int ast_smoother_test_flag(struct ast_smoother *s, int flag);
549 void ast_smoother_free(struct ast_smoother *s);
550 void ast_smoother_reset(struct ast_smoother *s, int bytes);
551
552 /*!
553  * \brief Reconfigure an existing smoother to output a different number of bytes per frame
554  * \param s the smoother to reconfigure
555  * \param bytes the desired number of bytes per output frame
556  * \return nothing
557  *
558  */
559 void ast_smoother_reconfigure(struct ast_smoother *s, int bytes);
560
561 int __ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f, int swap);
562 struct ast_frame *ast_smoother_read(struct ast_smoother *s);
563 #define ast_smoother_feed(s,f) __ast_smoother_feed(s, f, 0)
564 #if __BYTE_ORDER == __LITTLE_ENDIAN
565 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 1)
566 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 0)
567 #else
568 #define ast_smoother_feed_be(s,f) __ast_smoother_feed(s, f, 0)
569 #define ast_smoother_feed_le(s,f) __ast_smoother_feed(s, f, 1)
570 #endif
571 /*@} Doxygen marker */
572
573 void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix);
574
575 /*! \brief Returns the number of samples contained in the frame */
576 int ast_codec_get_samples(struct ast_frame *f);
577
578 /*! \brief Returns the number of bytes for the number of samples of the given format */
579 int ast_codec_get_len(struct ast_format *format, int samples);
580
581 /*! \brief Appends a frame to the end of a list of frames, truncating the maximum length of the list */
582 struct ast_frame *ast_frame_enqueue(struct ast_frame *head, struct ast_frame *f, int maxlen, int dupe);
583
584
585 /*! \brief Gets duration in ms of interpolation frame for a format */
586 static inline int ast_codec_interp_len(struct ast_format *format)
587
588         return (format->id == AST_FORMAT_ILBC) ? 30 : 20;
589 }
590
591 /*!
592   \brief Adjusts the volume of the audio samples contained in a frame.
593   \param f The frame containing the samples (must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR)
594   \param adjustment The number of dB to adjust up or down.
595   \return 0 for success, non-zero for an error
596  */
597 int ast_frame_adjust_volume(struct ast_frame *f, int adjustment);
598
599 /*!
600   \brief Sums two frames of audio samples.
601   \param f1 The first frame (which will contain the result)
602   \param f2 The second frame
603   \return 0 for success, non-zero for an error
604
605   The frames must be AST_FRAME_VOICE and must contain AST_FORMAT_SLINEAR samples,
606   and must contain the same number of samples.
607  */
608 int ast_frame_slinear_sum(struct ast_frame *f1, struct ast_frame *f2);
609
610 /*!
611  * \brief Clear all audio samples from an ast_frame. The frame must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR
612  */
613 int ast_frame_clear(struct ast_frame *frame);
614
615 /*!
616  * \brief Copy the discription of a frame's subclass into the provided string
617  *
618  * \param f The frame to get the information from
619  * \param subclass Buffer to fill with subclass information
620  * \param slen Length of subclass buffer
621  * \param moreinfo Buffer to fill with additional information
622  * \param mlen Length of moreinfo buffer
623  * \since 11
624  */
625 void ast_frame_subclass2str(struct ast_frame *f, char *subclass, size_t slen, char *moreinfo, size_t mlen);
626
627 /*!
628  * \brief Copy the discription of a frame type into the provided string
629  *
630  * \param frame_type The frame type to be described
631  * \param ftype Buffer to fill with frame type description
632  * \param len Length of subclass buffer
633  * \since 11
634  */
635 void ast_frame_type2str(enum ast_frame_type frame_type, char *ftype, size_t len);
636
637 #if defined(__cplusplus) || defined(c_plusplus)
638 }
639 #endif
640
641 #endif /* _ASTERISK_FRAME_H */