67e4178a2512d85b4b2a307e86f5a8f36aeb3254
[asterisk/asterisk.git] / include / asterisk / format.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, Digium, Inc.
5  *
6  * David Vossel <dvossel@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 /*!
20  * \file
21  * \brief Format API
22  *
23  * \author David Vossel <dvossel@digium.com>
24  */
25
26 #ifndef _AST_FORMAT_H_
27 #define _AST_FORMAT_H_
28
29 #include "asterisk/astobj2.h"
30 #include "asterisk/silk.h"
31 #define AST_FORMAT_ATTR_SIZE 128
32 #define AST_FORMAT_INC 100000
33
34 /*! This is the value that ends a var list of format attribute
35  * key value pairs. */
36 #define AST_FORMAT_ATTR_END -1
37
38 /* \brief Format Categories*/
39 enum ast_format_type {
40         AST_FORMAT_TYPE_AUDIO = 1 * AST_FORMAT_INC,
41         AST_FORMAT_TYPE_VIDEO = 2 * AST_FORMAT_INC,
42         AST_FORMAT_TYPE_IMAGE = 3 * AST_FORMAT_INC,
43         AST_FORMAT_TYPE_TEXT  = 4 * AST_FORMAT_INC,
44 };
45
46 enum ast_format_id {
47         /*! G.723.1 compression */
48         AST_FORMAT_G723_1           = 1 + AST_FORMAT_TYPE_AUDIO,
49         /*! GSM compression */
50         AST_FORMAT_GSM              = 2 + AST_FORMAT_TYPE_AUDIO,
51         /*! Raw mu-law data (G.711) */
52         AST_FORMAT_ULAW             = 3 + AST_FORMAT_TYPE_AUDIO,
53         /*! Raw A-law data (G.711) */
54         AST_FORMAT_ALAW             = 4 + AST_FORMAT_TYPE_AUDIO,
55         /*! ADPCM (G.726, 32kbps, AAL2 codeword packing) */
56         AST_FORMAT_G726_AAL2        = 5 + AST_FORMAT_TYPE_AUDIO,
57         /*! ADPCM (IMA) */
58         AST_FORMAT_ADPCM            = 6 + AST_FORMAT_TYPE_AUDIO,
59         /*! LPC10, 180 samples/frame */
60         AST_FORMAT_LPC10            = 7 + AST_FORMAT_TYPE_AUDIO,
61         /*! G.729A audio */
62         AST_FORMAT_G729A            = 8 + AST_FORMAT_TYPE_AUDIO,
63         /*! SpeeX Free Compression */
64         AST_FORMAT_SPEEX            = 9 + AST_FORMAT_TYPE_AUDIO,
65         /*! iLBC Free Compression */
66         AST_FORMAT_ILBC             = 10 + AST_FORMAT_TYPE_AUDIO,
67         /*! ADPCM (G.726, 32kbps, RFC3551 codeword packing) */
68         AST_FORMAT_G726             = 11 + AST_FORMAT_TYPE_AUDIO,
69         /*! G.722 */
70         AST_FORMAT_G722             = 12 + AST_FORMAT_TYPE_AUDIO,
71         /*! G.722.1 (also known as Siren7, 32kbps assumed) */
72         AST_FORMAT_SIREN7           = 13 + AST_FORMAT_TYPE_AUDIO,
73         /*! G.722.1 Annex C (also known as Siren14, 48kbps assumed) */
74         AST_FORMAT_SIREN14          = 14 + AST_FORMAT_TYPE_AUDIO,
75         /*! G.719 (64 kbps assumed) */
76         AST_FORMAT_G719             = 15 + AST_FORMAT_TYPE_AUDIO,
77         /*! SpeeX Wideband (16kHz) Free Compression */
78         AST_FORMAT_SPEEX16          = 16 + AST_FORMAT_TYPE_AUDIO,
79         /*! Raw mu-law data (G.711) */
80         AST_FORMAT_TESTLAW          = 17 + AST_FORMAT_TYPE_AUDIO,
81         /*! SILK format */
82         AST_FORMAT_SILK             = 18 + AST_FORMAT_TYPE_AUDIO,
83         /*! Raw 16-bit Signed Linear (8000 Hz) PCM */
84         AST_FORMAT_SLINEAR          = 19 + AST_FORMAT_TYPE_AUDIO,
85         /*! Raw 16-bit Signed Linear (12000 Hz) PCM */
86         AST_FORMAT_SLINEAR12        = 20 + AST_FORMAT_TYPE_AUDIO,
87         /*! Raw 16-bit Signed Linear (16000 Hz) PCM */
88         AST_FORMAT_SLINEAR16        = 21 + AST_FORMAT_TYPE_AUDIO,
89         /*! Raw 16-bit Signed Linear (24000 Hz) PCM */
90         AST_FORMAT_SLINEAR24        = 22 + AST_FORMAT_TYPE_AUDIO,
91         /*! Raw 16-bit Signed Linear (32000 Hz) PCM */
92         AST_FORMAT_SLINEAR32        = 23 + AST_FORMAT_TYPE_AUDIO,
93         /*! Raw 16-bit Signed Linear (44100 Hz) PCM just because we can. */
94         AST_FORMAT_SLINEAR44        = 24 + AST_FORMAT_TYPE_AUDIO,
95         /*! Raw 16-bit Signed Linear (48000 Hz) PCM */
96         AST_FORMAT_SLINEAR48        = 25 + AST_FORMAT_TYPE_AUDIO,
97         /*! Raw 16-bit Signed Linear (96000 Hz) PCM */
98         AST_FORMAT_SLINEAR96        = 26 + AST_FORMAT_TYPE_AUDIO,
99         /*! Raw 16-bit Signed Linear (192000 Hz) PCM.  maybe we're taking this too far. */
100         AST_FORMAT_SLINEAR192       = 27 + AST_FORMAT_TYPE_AUDIO,
101         AST_FORMAT_SPEEX32          = 28 + AST_FORMAT_TYPE_AUDIO,
102
103         /*! H.261 Video */
104         AST_FORMAT_H261             = 1 + AST_FORMAT_TYPE_VIDEO,
105         /*! H.263 Video */
106         AST_FORMAT_H263             = 2 + AST_FORMAT_TYPE_VIDEO,
107         /*! H.263+ Video */
108         AST_FORMAT_H263_PLUS        = 3 + AST_FORMAT_TYPE_VIDEO,
109         /*! H.264 Video */
110         AST_FORMAT_H264             = 4 + AST_FORMAT_TYPE_VIDEO,
111         /*! MPEG4 Video */
112         AST_FORMAT_MP4_VIDEO        = 5 + AST_FORMAT_TYPE_VIDEO,
113
114         /*! JPEG Images */
115         AST_FORMAT_JPEG             = 1 + AST_FORMAT_TYPE_IMAGE,
116         /*! PNG Images */
117         AST_FORMAT_PNG              = 2 + AST_FORMAT_TYPE_IMAGE,
118
119         /*! T.140 RED Text format RFC 4103 */
120         AST_FORMAT_T140RED          = 1 + AST_FORMAT_TYPE_TEXT,
121         /*! T.140 Text format - ITU T.140, RFC 4103 */
122         AST_FORMAT_T140             = 2 + AST_FORMAT_TYPE_TEXT,
123 };
124
125 /*! Determine what type of media a ast_format_id is. */
126 #define AST_FORMAT_GET_TYPE(id) (((int) (id / AST_FORMAT_INC)) * AST_FORMAT_INC)
127
128
129 /*! \brief This structure contains the buffer used for format attributes */
130 struct ast_format_attr {
131         /*! The buffer formats can use to represent attributes */
132         uint8_t format_attr[AST_FORMAT_ATTR_SIZE];
133         /*! If a format's payload needs to pass through that a new marker is required
134          * for RTP, this variable will be set. */
135         uint8_t rtp_marker_bit;
136 };
137
138 /*! \brief Represents a media format within Asterisk. */
139 struct ast_format {
140         /*! The unique id representing this format from all the other formats. */
141         enum ast_format_id id;
142         /*!  Attribute structure used to associate attributes with a format. */
143         struct ast_format_attr fattr;
144 };
145
146 enum ast_format_cmp_res {
147         /*! structure 1 is identical to structure 2. */
148         AST_FORMAT_CMP_EQUAL = 0,
149         /*! structure 1 contains elements not in structure 2. */
150         AST_FORMAT_CMP_NOT_EQUAL,
151         /*! structure 1 is a proper subset of the elements in structure 2.*/
152         AST_FORMAT_CMP_SUBSET,
153 };
154
155 /*! \brief Definition of supported media formats (codecs) */
156 struct ast_format_list {
157         struct ast_format format; /*!< The unique format. */
158         char name[64];  /*!< short name */
159         unsigned int samplespersecond; /*!< Number of samples per second (8000/16000) */
160         char desc[128]; /*!< Description */
161         int fr_len;     /*!< Single frame length in bytes */
162         int min_ms;     /*!< Min value */
163         int max_ms;     /*!< Max value */
164         int inc_ms;     /*!< Increment */
165         int def_ms;     /*!< Default value */
166         unsigned int flags;     /*!< Smoother flags */
167         int cur_ms;     /*!< Current value */
168         int custom_entry;
169 };
170
171 /*! \brief A format must register an attribute interface if it requires the use of the format attributes void pointer */
172 struct ast_format_attr_interface {
173         /*! format type */
174         enum ast_format_id id;
175
176         /*! \brief Determine if format_attr 1 is a subset of format_attr 2.
177          *
178          * \retval ast_format_cmp_res representing the result of comparing fattr1 and fattr2.
179          */
180         enum ast_format_cmp_res (* const format_attr_cmp)(const struct ast_format_attr *fattr1, const struct ast_format_attr *fattr2);
181
182         /*! \brief Get joint attributes of same format type if they exist.
183          *
184          * \retval 0 if joint attributes exist
185          * \retval -1 if no joint attributes are present
186          */
187         int (* const format_attr_get_joint)(const struct ast_format_attr *fattr1, const struct ast_format_attr *fattr2, struct ast_format_attr *result);
188
189         /*! \brief Set format capabilities from a list of key value pairs ending with AST_FORMAT_ATTR_END.
190          * \note This function does not need to call va_end of the va_list. */
191         void (* const format_attr_set)(struct ast_format_attr *format_attr, va_list ap);
192
193         /*!
194          * \brief Find out if format capabilities in va_list are in format.
195          * \note This function does not need to call va_end of the va_list.
196          *
197          * \note This function is optional.  In many cases the format_attr_cmp
198          * function can be used to derive these results.  If it is possible
199          * that some format attributes have no bearing on the equality of two formats, this
200          * function must exist.
201          *
202          * \retval 0 if all attributes exist
203          * \retval -1 if any of the attributes not present
204          */
205         int (* const format_attr_isset)(const struct ast_format_attr *format_attr, va_list ap);
206
207         /*
208          * \brief Return a value for a specific format key.   Return that value in the void pointer.
209          *
210          * \note It is not expected that all key value pairs can be returned, but those that can should
211          * be documented as such.
212          *
213          * \note This function is optional if key value pairs are not allowed to be accessed.  This
214          * will result in -1 always being returned.
215          *
216          * \retval 0 Success, value was found and copied into void pointer.
217          * \retval -1 failure, Value was either not found, or not allowed to be accessed.
218          */
219         int (* const format_attr_get_val)(const struct ast_format_attr *format_attr, int key, void *val);
220 };
221
222 /*!
223  * \brief This function is used to set an ast_format object to represent a media format
224  * with optional format attributes represented by format specific key value pairs.
225  *
226  * \param format to set
227  * \param id, format id to set on format
228  * \param set_attributes, are there attributes to set on this format. 0 == false, 1 == True.
229  * \param var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END;
230  *
231  * \details Example usage.
232  * ast_format_set(format, AST_FORMAT_ULAW, 0); // no capability attributes are needed for ULAW
233  *
234  * ast_format_set(format, AST_FORMAT_SILK, 1, // SILK has capability attributes.
235  *        AST_FORMAT_SILK_ATTR_RATE, 24000,
236  *        AST_FORMAT_SILK_ATTR_RATE, 16000,
237  *        AST_FORMAT_SILK_ATTR_RATE, 12000,
238  *        AST_FORMAT_SILK_ATTR_RATE, 8000,
239  *        AST_FORMAT_ATTR_END);
240  *
241  * \note This function will initialize the ast_format structure.
242  *
243  * \return Pointer to ast_format object, same pointer that is passed in
244  * by the first argument.
245  */
246 struct ast_format *ast_format_set(struct ast_format *format, enum ast_format_id id, int set_attributes, ... );
247
248 /*!
249  * \brief After ast_format_set has been used on a function, this function can be used to
250  * set additional format attributes to the structure.
251  *
252  * \param format to set
253  * \param var list of attribute key value pairs, must end with AST_FORMAT_ATTR_END;
254  *
255  * \details Example usage.
256  * ast_format_set(format, AST_FORMAT_SILK, 0);
257  * ast_format_append(format, // SILK has capability attributes.
258  *        AST_FORMAT_SILK_ATTR_RATE, 24000,
259  *        AST_FORMAT_SILK_ATTR_RATE, 16000,
260  *        AST_FORMAT_SILK_ATTR_RATE, 12000,
261  *        AST_FORMAT_SILK_ATTR_RATE, 8000,
262  *        AST_FORMAT_ATTR_END);
263  *
264  * \return Pointer to ast_format object, same pointer that is passed in
265  * by the first argument.
266  */
267 struct ast_format *ast_format_append(struct ast_format *format, ... );
268
269 /*!
270  * \brief Clears the format stucture.
271  */
272 void ast_format_clear(struct ast_format *format);
273
274 /*!
275  * \brief This function is used to set an ast_format object to represent a media format
276  * with optional capability attributes represented by format specific key value pairs.
277  *
278  * \details Example usage. Is this SILK format capable of 8khz
279  * is_8khz = ast_format_isset(format, AST_FORMAT_SILK_CAP_RATE, 8000);
280  *
281  * \return 0, The format key value pairs are within the capabilities defined in this structure.
282  * \return -1, The format key value pairs are _NOT_ within the capabilities of this structure.
283  */
284 int ast_format_isset(const struct ast_format *format, ... );
285
286 /*!
287  * \brief Get a value from a format containing attributes.
288  * \note The key represents the format attribute to be retrieved, and the void pointer
289  * is to the structure that value will be stored in.  It must be known what structure a
290  * key represents.
291  *
292  * \retval 0, success
293  * \retval -1, failure
294  */
295 int ast_format_get_value(const struct ast_format *format, int key, void *value);
296
297 /*!
298  * \brief Compare ast_formats structures
299  *
300  * \retval ast_format_cmp_res representing the result of comparing format1 and format2.
301  */
302 enum ast_format_cmp_res ast_format_cmp(const struct ast_format *format1, const struct ast_format *format2);
303
304 /*!
305  * \brief Find joint format attributes of two ast_format
306  * structures containing the same uid and return the intersection in the
307  * result structure.
308  *
309  * retval 0, joint attribute capabilities exist.
310  * retval -1, no joint attribute capabilities exist.
311  */
312 int ast_format_joint(const struct ast_format *format1, const struct ast_format *format2, struct ast_format *result);
313
314 /*!
315  * \brief copy format src into format dst.
316  */
317 void ast_format_copy(struct ast_format *dst, const struct ast_format *src);
318
319 /*!
320  * \brief Set the rtp mark value on the format to indicate to the interface
321  * writing this format's payload that a new RTP marker is necessary.
322  */
323 void ast_format_set_video_mark(struct ast_format *format);
324
325 /*!
326  * \brief Determine of the marker bit is set or not on this format.
327  *
328  * \retval 1, true
329  * \retval 0, false
330  */
331 int ast_format_get_video_mark(const struct ast_format *format);
332
333 /*!
334  * \brief ast_format to old bitfield format represenatation
335  *
336  * \note This is only to be used for IAX2 compatibility 
337  *
338  * \retval iax2 representation of ast_format
339  * \retval 0, if no representation existis for iax2
340  */
341 uint64_t ast_format_to_old_bitfield(const struct ast_format *format);
342
343 /*!
344  * \brief ast_format_id to old bitfield format represenatation
345  *
346  */
347 uint64_t ast_format_id_to_old_bitfield(enum ast_format_id id);
348
349 /*!
350  * \brief convert old bitfield format to ast_format represenatation
351  * \note This is only to be used for IAX2 compatibility 
352  *
353  * \retval on success, pointer to the dst format in the input parameters
354  * \retval on failure, NULL
355  */
356 struct ast_format *ast_format_from_old_bitfield(struct ast_format *dst, uint64_t src);
357
358 /*!
359  * \brief convert old bitfield format to ast_format_id value
360  */
361 enum ast_format_id ast_format_id_from_old_bitfield(uint64_t src);
362
363 /*!
364  * \brief Retrieve the global format list in a read only array.
365  * \note ast_format_list_destroy must be called on every format
366  * list retrieved from this function.
367  */
368 const struct ast_format_list *ast_format_list_get(size_t *size);
369
370 /*!
371  * \brief Destroy an ast_format_list gotten from ast_format_list_get()
372  */
373 const struct ast_format_list *ast_format_list_destroy(const struct ast_format_list *list);
374
375 /*! \brief Get the name of a format
376  * \param format id of format
377  * \return A static string containing the name of the format or "unknown" if unknown.
378  */
379 const char* ast_getformatname(const struct ast_format *format);
380
381 /*! \brief Returns a string containing all formats pertaining to an format id.
382  * \param buf a buffer for the output string
383  * \param size size of buf (bytes)
384  * \param format id.
385  * \return The return value is buf.
386  */
387 char* ast_getformatname_multiple_byid(char *buf, size_t size, enum ast_format_id id);
388
389 /*!
390  * \brief Gets a format from a name.
391  * \param name string of format
392  * \param format structure to return the format in.
393  * \return This returns the format pointer given to it on success and NULL on failure
394  */
395 struct ast_format *ast_getformatbyname(const char *name, struct ast_format *format);
396
397 /*!
398  * \brief Get a name from a format 
399  * \param format to get name of
400  * \return This returns a static string identifying the format on success, 0 on error.
401  */
402 const char *ast_codec2str(struct ast_format *format);
403
404 /*!
405  * \brief Get the sample rate for a given format.
406  */
407 int ast_format_rate(const struct ast_format *format);
408
409 /*!
410  * \brief register ast_format_attr_interface with core.
411  *
412  * \retval 0 success
413  * \retval -1 failure
414  */
415 int ast_format_attr_reg_interface(const struct ast_format_attr_interface *interface);
416
417 /*!
418  * \brief unregister format_attr interface with core.
419  *
420  * \retval 0 success
421  * \retval -1 failure
422  */
423 int ast_format_attr_unreg_interface(const struct ast_format_attr_interface *interface);
424
425 /*!
426  * \brief Determine if a format is 16bit signed linear of any sample rate. 
427  */
428 int ast_format_is_slinear(const struct ast_format *format);
429
430 /*!
431  * \brief Get the best slinear format id for a given sample rate
432  */
433 enum ast_format_id ast_format_slin_by_rate(unsigned int rate);
434 #endif /* _AST_FORMAT_H */