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