c80ca72f5a20f66e47a893d6869b47b88cd202bd
[asterisk/asterisk.git] / include / asterisk / frame.h
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Asterisk internal frame definitions.
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU Lesser General Public License.  Other components of
12  * Asterisk are distributed under The GNU General Public License
13  * only.
14  */
15
16 #ifndef _ASTERISK_FRAME_H
17 #define _ASTERISK_FRAME_H
18
19 #if defined(__cplusplus) || defined(c_plusplus)
20 extern "C" {
21 #endif
22
23 #include <sys/types.h>
24 #include <sys/time.h>
25         
26 /*
27  * Autodetect system endianess
28  */
29 #ifndef __BYTE_ORDER
30 #ifdef __linux__
31 #include <endian.h>
32 #elif defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__APPLE__)
33 #if defined(__OpenBSD__)
34 #include <machine/types.h>
35 #endif /* __OpenBSD__ */
36 #include <machine/endian.h>
37 #define __BYTE_ORDER BYTE_ORDER
38 #define __LITTLE_ENDIAN LITTLE_ENDIAN
39 #define __BIG_ENDIAN BIG_ENDIAN
40 #else
41 #ifdef __LITTLE_ENDIAN__
42 #define __BYTE_ORDER __LITTLE_ENDIAN
43 #endif /* __LITTLE_ENDIAN */
44
45 #if defined(i386) || defined(__i386__)
46 #define __BYTE_ORDER __LITTLE_ENDIAN
47 #endif /* defined i386 */
48
49 #if defined(sun) && defined(unix) && defined(sparc)
50 #define __BYTE_ORDER __BIG_ENDIAN
51 #endif /* sun unix sparc */
52
53 #endif /* linux */
54
55 #endif /* __BYTE_ORDER */
56
57 #ifndef __BYTE_ORDER
58 #error Need to know endianess
59 #endif /* __BYTE_ORDER */
60
61 //! Data structure associated with a single frame of data
62 /* A frame of data read used to communicate between 
63    between channels and applications */
64 struct ast_frame {
65         /*! Kind of frame */
66         int frametype;                          
67         /*! Subclass, frame dependent */
68         int subclass;                           
69         /*! Length of data */
70         int datalen;                            
71         /*! Number of 8khz samples in this frame */
72         int samples;                            
73         /*! Was the data malloc'd?  i.e. should we free it when we discard the frame? */
74         int mallocd;                            
75         /*! How far into "data" the data really starts */
76         int offset;                             
77         /*! Optional source of frame for debugging */
78         char *src;                              
79         /*! Pointer to actual data */
80         void *data;             
81         /*! Global delivery time */             
82         struct timeval delivery;
83         /*! Next/Prev for linking stand alone frames */
84         struct ast_frame *prev;                 
85         /*! Next/Prev for linking stand alone frames */
86         struct ast_frame *next;                 
87                                                                 /* Unused except if debugging is turned on, but left
88                                                                    in the struct so that it can be turned on without
89                                                                    requiring a recompile of the whole thing */
90 };
91
92 struct ast_frame_chain {
93         /* XXX Should ast_frame chain's be just prt of frames, i.e. should they just link? XXX */
94         struct ast_frame *fr;
95         struct ast_frame_chain *next;
96 };
97
98 #define AST_FRIENDLY_OFFSET     64              /*! It's polite for a a new frame to
99                                                                                 have this number of bytes for additional
100                                                                                         headers.  */
101 #define AST_MIN_OFFSET          32              /*! Make sure we keep at least this much handy */
102
103 /*! Need the header be free'd? */
104 #define AST_MALLOCD_HDR         (1 << 0)
105 /*! Need the data be free'd? */
106 #define AST_MALLOCD_DATA        (1 << 1)
107 /*! Need the source be free'd? (haha!) */
108 #define AST_MALLOCD_SRC         (1 << 2)
109
110 /* Frame types */
111 /*! A DTMF digit, subclass is the digit */
112 #define AST_FRAME_DTMF          1
113 /*! Voice data, subclass is AST_FORMAT_* */
114 #define AST_FRAME_VOICE         2
115 /*! Video frame, maybe?? :) */
116 #define AST_FRAME_VIDEO         3
117 /*! A control frame, subclass is AST_CONTROL_* */
118 #define AST_FRAME_CONTROL       4
119 /*! An empty, useless frame */
120 #define AST_FRAME_NULL          5
121 /*! Inter Asterisk Exchange private frame type */
122 #define AST_FRAME_IAX           6
123 /*! Text messages */
124 #define AST_FRAME_TEXT          7
125 /*! Image Frames */
126 #define AST_FRAME_IMAGE         8
127 /*! HTML Frame */
128 #define AST_FRAME_HTML          9
129 /*! Comfort Noise frame (subclass is level of CNG in -dBov), 
130     body may include zero or more 8-bit quantization coefficients */
131 #define AST_FRAME_CNG           10
132
133 /* HTML subclasses */
134 /*! Sending a URL */
135 #define AST_HTML_URL            1
136 /*! Data frame */
137 #define AST_HTML_DATA           2
138 /*! Beginning frame */
139 #define AST_HTML_BEGIN          4
140 /*! End frame */
141 #define AST_HTML_END            8
142 /*! Load is complete */
143 #define AST_HTML_LDCOMPLETE     16
144 /*! Peer is unable to support HTML */
145 #define AST_HTML_NOSUPPORT      17
146 /*! Send URL, and track */
147 #define AST_HTML_LINKURL        18
148 /*! No more HTML linkage */
149 #define AST_HTML_UNLINK         19
150 /*! Reject link request */
151 #define AST_HTML_LINKREJECT     20
152
153 /* Data formats for capabilities and frames alike */
154 /*! G.723.1 compression */
155 #define AST_FORMAT_G723_1       (1 << 0)
156 /*! GSM compression */
157 #define AST_FORMAT_GSM          (1 << 1)
158 /*! Raw mu-law data (G.711) */
159 #define AST_FORMAT_ULAW         (1 << 2)
160 /*! Raw A-law data (G.711) */
161 #define AST_FORMAT_ALAW         (1 << 3)
162 /*! ADPCM (G.726, 32kbps) */
163 #define AST_FORMAT_G726         (1 << 4)
164 /*! ADPCM (IMA) */
165 #define AST_FORMAT_ADPCM        (1 << 5)
166 /*! Raw 16-bit Signed Linear (8000 Hz) PCM */
167 #define AST_FORMAT_SLINEAR      (1 << 6)
168 /*! LPC10, 180 samples/frame */
169 #define AST_FORMAT_LPC10        (1 << 7)
170 /*! G.729A audio */
171 #define AST_FORMAT_G729A        (1 << 8)
172 /*! SpeeX Free Compression */
173 #define AST_FORMAT_SPEEX        (1 << 9)
174 /*! iLBC Free Compression */
175 #define AST_FORMAT_ILBC         (1 << 10)
176 /*! Maximum audio format */
177 #define AST_FORMAT_MAX_AUDIO    (1 << 15)
178 /*! JPEG Images */
179 #define AST_FORMAT_JPEG         (1 << 16)
180 /*! PNG Images */
181 #define AST_FORMAT_PNG          (1 << 17)
182 /*! H.261 Video */
183 #define AST_FORMAT_H261         (1 << 18)
184 /*! H.263 Video */
185 #define AST_FORMAT_H263         (1 << 19)
186 /*! Max one */
187 #define AST_FORMAT_MAX_VIDEO    (1 << 24)
188
189 /* Control frame types */
190 /*! Other end has hungup */
191 #define AST_CONTROL_HANGUP              1
192 /*! Local ring */
193 #define AST_CONTROL_RING                2
194 /*! Remote end is ringing */
195 #define AST_CONTROL_RINGING             3
196 /*! Remote end has answered */
197 #define AST_CONTROL_ANSWER              4
198 /*! Remote end is busy */
199 #define AST_CONTROL_BUSY                5
200 /*! Make it go off hook */
201 #define AST_CONTROL_TAKEOFFHOOK         6
202 /*! Line is off hook */
203 #define AST_CONTROL_OFFHOOK             7
204 /*! Congestion (circuits busy) */
205 #define AST_CONTROL_CONGESTION          8
206 /*! Flash hook */
207 #define AST_CONTROL_FLASH               9
208 /*! Wink */
209 #define AST_CONTROL_WINK                10
210 /*! Set a low-level option */
211 #define AST_CONTROL_OPTION              11
212 /*! Key Radio */
213 #define AST_CONTROL_RADIO_KEY           12
214 /*! Un-Key Radio */
215 #define AST_CONTROL_RADIO_UNKEY         13
216 /*! Indicate PROGRESS */
217 #define AST_CONTROL_PROGRESS            14
218 /*! Indicate CALL PROCEEDING */
219 #define AST_CONTROL_PROCEEDING          15
220
221 #define AST_SMOOTHER_FLAG_G729          (1 << 0)
222
223 /* Option identifiers and flags */
224 #define AST_OPTION_FLAG_REQUEST         0
225 #define AST_OPTION_FLAG_ACCEPT          1
226 #define AST_OPTION_FLAG_REJECT          2
227 #define AST_OPTION_FLAG_QUERY           4
228 #define AST_OPTION_FLAG_ANSWER          5
229 #define AST_OPTION_FLAG_WTF             6
230
231 /* Verify touchtones by muting audio transmission 
232         (and reception) and verify the tone is still present */
233 #define AST_OPTION_TONE_VERIFY          1               
234
235 /* Put a compatible channel into TDD (TTY for the hearing-impared) mode */
236 #define AST_OPTION_TDD                  2
237
238 /* Relax the parameters for DTMF reception (mainly for radio use) */
239 #define AST_OPTION_RELAXDTMF            3
240
241 /* Set (or clear) Audio (Not-Clear) Mode */
242 #define AST_OPTION_AUDIO_MODE           4
243
244 struct ast_option_header {
245         /* Always keep in network byte order */
246 #if __BYTE_ORDER == __BIG_ENDIAN
247         u_int16_t flag:3;
248         u_int16_t option:13;
249 #else
250 #if __BYTE_ORDER == __LITTLE_ENDIAN
251         u_int16_t option:13;
252         u_int16_t flag:3;
253 #else
254 #error Byte order not defined
255 #endif
256 #endif
257                 u_int8_t data[0];
258 };
259
260 // Requests a frame to be allocated
261 /* 
262  * \param source 
263  * Request a frame be allocated.  source is an optional source of the frame, 
264  * len is the requested length, or "0" if the caller will supply the buffer 
265  */
266 #if 0 /* Unimplemented */
267 struct ast_frame *ast_fralloc(char *source, int len);
268 #endif
269
270 //! Frees a frame
271 /*! 
272  * \param fr Frame to free
273  * Free a frame, and the memory it used if applicable
274  * no return.
275  */
276 void ast_frfree(struct ast_frame *fr);
277
278 //! Copies a frame
279 /*! 
280  * \param fr frame to act upon
281  * Take a frame, and if it's not been malloc'd, make a malloc'd copy
282  * and if the data hasn't been malloced then make the
283  * data malloc'd.  If you need to store frames, say for queueing, then
284  * you should call this function.
285  * Returns a frame on success, NULL on error
286  */
287 struct ast_frame *ast_frisolate(struct ast_frame *fr);
288
289 //! Copies a frame
290 /*! 
291  * \param fr frame to copy
292  * Dupliates a frame -- should only rarely be used, typically frisolate is good enough
293  * Returns a frame on success, NULL on error
294  */
295 struct ast_frame *ast_frdup(struct ast_frame *fr);
296
297 //! Chains a frame -- unimplemented
298 #if 0 /* unimplemented */
299 void ast_frchain(struct ast_frame_chain *fc);
300 #endif
301
302 //! Reads a frame from an fd
303 /*! 
304  * \param fd an opened fd to read from
305  * Read a frame from a stream or packet fd, as written by fd_write
306  * returns a frame on success, NULL on error
307  */
308 struct ast_frame *ast_fr_fdread(int fd);
309
310 //! Writes a frame to an fd
311 /*! 
312  * \param fd Which fd to write to
313  * \param frame frame to write to the fd
314  * Write a frame to an fd
315  * Returns 0 on success, -1 on failure
316  */
317 int ast_fr_fdwrite(int fd, struct ast_frame *frame);
318
319 //! Sends a hangup to an fd
320 /*! 
321  * \param fd fd to write to
322  * Send a hangup (NULL equivalent) on an fd
323  * Returns 0 on success, -1 on failure
324  */
325 int ast_fr_fdhangup(int fd);
326
327 //! Get the name of a format
328 /*!
329  * \param format id of format
330  * \return A static string containing the name of the format or "UNKN" if unknown.
331  */
332 extern char* ast_getformatname(int format);
333
334 //! Get the names of a set of formats
335 /*!
336  * \param buf a buffer for the output string
337  * \param n size of buf (bytes)
338  * \param format the format (combined IDs of codecs)
339  * Prints a list of readable codec names corresponding to "format".
340  * ex: for format=AST_FORMAT_GSM|AST_FORMAT_SPEEX|AST_FORMAT_ILBC it will return "0x602(GSM|SPEEX|ILBC)"
341  * \return The return value is buf.
342  */
343 extern char* ast_getformatname_multiple(char *buf, unsigned n, int format);
344
345
346 /*!
347  * \param name string of format
348  * Gets a format from a name.
349  * This returns the form of the format in binary on success, 0 on error.
350  */
351 extern int ast_getformatbyname(char *name);
352
353 //! Get a name from a format
354 /*!
355  * \param codec codec number (1,2,4,8,16,etc.)
356  * Gets a name from a format
357  * This returns a static string identifying the format on success, 0 on error.
358  */
359 extern char *ast_codec2str(int codec);
360
361 //! Pick the best codec 
362 /* Choose the best codec...  Uhhh...   Yah. */
363 extern int ast_best_codec(int fmts);
364
365 struct ast_smoother;
366
367 extern struct ast_smoother *ast_smoother_new(int bytes);
368 extern void ast_smoother_set_flags(struct ast_smoother *smoother, int flags);
369 extern int ast_smoother_get_flags(struct ast_smoother *smoother);
370 extern void ast_smoother_free(struct ast_smoother *s);
371 extern void ast_smoother_reset(struct ast_smoother *s, int bytes);
372 extern int ast_smoother_feed(struct ast_smoother *s, struct ast_frame *f);
373 extern struct ast_frame *ast_smoother_read(struct ast_smoother *s);
374
375 extern void ast_frame_dump(char *name, struct ast_frame *f, char *prefix);
376
377 #if defined(__cplusplus) || defined(c_plusplus)
378 }
379 #endif
380
381
382 #endif