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