Doxygen improvements
[asterisk/asterisk.git] / include / asterisk / translate.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, 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 Support for translation of data formats.
21  */
22
23 #ifndef _ASTERISK_TRANSLATE_H
24 #define _ASTERISK_TRANSLATE_H
25
26 #define MAX_FORMAT 32
27
28 #if defined(__cplusplus) || defined(c_plusplus)
29 extern "C" {
30 #endif
31
32 #if 1   /* need lots of stuff... */
33 #include "asterisk/frame.h"
34 #include "asterisk/plc.h"
35 #include "asterisk/linkedlists.h"
36 // XXX #include "asterisk/module.h"
37 #endif
38
39 struct ast_trans_pvt;   /* declared below */
40
41 /*! \brief
42  * Descriptor of a translator. Name, callbacks, and various options
43  * related to run-time operation (size of buffers, auxiliary
44  * descriptors, etc).
45  *
46  * A coded registers itself by filling the relevant fields
47  * of a structure and passing it as an argument to
48  * ast_register_translator(). The structure should not be
49  * modified after a successful registration, and its address
50  * must be used as an argument to ast_unregister_translator().
51  *
52  * As a minimum, a translator should supply name, srcfmt and dstfmt,
53  * the required buf_size (in bytes) and buffer_samples (in samples),
54  * and a few callbacks (framein, frameout, sample).
55  * The outbuf is automatically prepended by AST_FRIENDLY_OFFSET
56  * spare bytes so generic routines can place data in there.
57  *
58  * Note, the translator is not supposed to do any memory allocation
59  * or deallocation, nor any locking, because all of this is done in
60  * the generic code.
61  *
62  * Translators using generic plc (packet loss concealment) should
63  * supply a non-zero plc_samples indicating the size (in samples)
64  * of artificially generated frames and incoming data.
65  * Generic plc is only available for dstfmt = SLINEAR
66  */
67 struct ast_translator {
68         const char name[80];            /*!< Name of translator */
69         int srcfmt;                     /*!< Source format (note: bit position,
70                                           converted to index during registration) */
71         int dstfmt;                     /*!< Destination format (note: bit position,
72                                           converted to index during registration) */
73
74         void *(*newpvt)(struct ast_trans_pvt *); /*!< initialize private data 
75                                         associated with the translator */
76
77         int (*framein)(struct ast_trans_pvt *pvt, struct ast_frame *in);
78                                         /*!< Input frame callback. Store 
79                                              (and possibly convert) input frame. */
80
81         struct ast_frame * (*frameout)(struct ast_trans_pvt *pvt);
82                                         /*!< Output frame callback. Generate a frame 
83                                             with outbuf content. */
84
85         void (*destroy)(struct ast_trans_pvt *pvt);
86                                         /*!< cleanup private data, if needed 
87                                                 (often unnecessary). */
88
89         struct ast_frame * (*sample)(void);     /*!< Generate an example frame */
90
91         /*! \brief size of outbuf, in samples. Leave it 0 if you want the framein
92          * callback deal with the frame. Set it appropriately if you
93          * want the code to checks if the incoming frame fits the
94          * outbuf (this is e.g. required for plc).
95          */
96         int buffer_samples;     /*< size of outbuf, in samples */
97
98         /*! \brief size of outbuf, in bytes. Mandatory. The wrapper code will also
99          * allocate an AST_FRIENDLY_OFFSET space before.
100          */
101         int buf_size;
102
103         int desc_size;          /*!< size of private descriptor in pvt->pvt, if any */
104         int plc_samples;        /*!< set to the plc block size if used, 0 otherwise */
105         int useplc;             /*!< current status of plc, changed at runtime */
106
107         void *module;           /*!< opaque reference to the parent module */
108
109         int cost;               /*!< Cost in milliseconds for encoding/decoding 1 second of sound */
110         AST_LIST_ENTRY(ast_translator) list;    /*!< link field */
111 };
112
113 /*! \brief
114  * Default structure for translators, with the basic fields and buffers,
115  * all allocated as part of the same chunk of memory. The buffer is
116  * preceded by AST_FRIENDLY_OFFSET bytes in front of the user portion.
117  * 'buf' points right after this space.
118  *
119  * *_framein() routines operate in two ways:
120  * 1. some convert on the fly and place the data directly in outbuf;
121  *    in this case 'samples' and 'datalen' contain the number of samples
122  *    and number of bytes available in the buffer.
123  *    In this case we can use a generic *_frameout() routine that simply
124  *    takes whatever is there and places it into the output frame.
125  * 2. others simply store the (unconverted) samples into a working
126  *    buffer, and leave the conversion task to *_frameout().
127  *    In this case, the intermediate buffer must be in the private
128  *    descriptor, 'datalen' is left to 0, while 'samples' is still
129  *    updated with the number of samples received.
130  */
131 struct ast_trans_pvt {
132         struct ast_translator *t;
133         struct ast_frame f;     /*!< used in frameout */
134         int samples;            /*!< samples available in outbuf */
135         int datalen;            /*!< actual space used in outbuf */
136         void *pvt;              /*!< more private data, if any */
137         char *outbuf;           /*!< the useful portion of the buffer */
138         plc_state_t *plc;       /*!< optional plc pointer */
139         struct ast_trans_pvt *next;     /*!< next in translator chain */
140         struct timeval nextin;
141         struct timeval nextout;
142 };
143
144 /*! \brief generic frameout function */
145 struct ast_frame *ast_trans_frameout(struct ast_trans_pvt *pvt,
146         int datalen, int samples);
147
148 struct ast_trans_pvt;
149
150 /*!
151  * \brief Register a translator
152  * This registers a codec translator with asterisk
153  * \param t populated ast_translator structure
154  * \param module handle to the module that owns this translator
155  * \return 0 on success, -1 on failure
156  */
157 int ast_register_translator(struct ast_translator *t, void *module);
158
159 /*!
160  * \brief Unregister a translator
161  * Unregisters the given tranlator
162  * \param t translator to unregister
163  * \return 0 on success, -1 on failure
164  */
165 int ast_unregister_translator(struct ast_translator *t);
166
167 /*!
168  * \brief Chooses the best translation path
169  *
170  * Given a list of sources, and a designed destination format, which should
171  * I choose? 
172  * \return Returns 0 on success, -1 if no path could be found.  
173  * \note Modifies dests and srcs in place 
174  */
175 int ast_translator_best_choice(int *dsts, int *srcs);
176
177 /*! 
178  * \brief Builds a translator path
179  * Build a path (possibly NULL) from source to dest 
180  * \param dest destination format
181  * \param source source format
182  * \return ast_trans_pvt on success, NULL on failure
183  * */
184 struct ast_trans_pvt *ast_translator_build_path(int dest, int source);
185
186 /*!
187  * \brief Frees a translator path
188  * Frees the given translator path structure
189  * \param tr translator path to get rid of
190  */
191 void ast_translator_free_path(struct ast_trans_pvt *tr);
192
193 /*!
194  * \brief translates one or more frames
195  * Apply an input frame into the translator and receive zero or one output frames.  Consume
196  * determines whether the original frame should be freed
197  * \param tr translator structure to use for translation
198  * \param f frame to translate
199  * \param consume Whether or not to free the original frame
200  * \return an ast_frame of the new translation format on success, NULL on failure
201  */
202 struct ast_frame *ast_translate(struct ast_trans_pvt *tr, struct ast_frame *f, int consume);
203
204 /*!
205  * \brief Returns the number of steps required to convert from 'src' to 'dest'.
206  * \param dest Destination format
207  * \param src Source format
208  * \return the number of translation steps required, or -1 if no path is available
209  */
210 unsigned int ast_translate_path_steps(unsigned int dest, unsigned int src);
211
212 #if defined(__cplusplus) || defined(c_plusplus)
213 }
214 #endif
215
216 #endif /* _ASTERISK_TRANSLATE_H */