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