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