Add doxygen documentation for slinfactory_destroy(), mainly just noting that
[asterisk/asterisk.git] / include / asterisk / slinfactory.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005, Anthony Minessale II
5  *
6  * Anthony Minessale <anthmct@yahoo.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 A machine to gather up arbitrary frames and convert them
21  * to raw slinear on demand.
22  */
23
24 #ifndef _ASTERISK_SLINFACTORY_H
25 #define _ASTERISK_SLINFACTORY_H
26 #include <stdlib.h>
27 #include <unistd.h>
28 #include <string.h>
29
30 #if defined(__cplusplus) || defined(c_plusplus)
31 extern "C" {
32 #endif
33
34 struct ast_slinfactory {
35         AST_LIST_HEAD_NOLOCK(, ast_frame) queue;
36         struct ast_trans_pvt *trans;
37         short hold[1280];
38         short *offset;
39         size_t holdlen;                 /*!< in samples */
40         unsigned int size;              /*!< in samples */
41         unsigned int format;
42 };
43
44 void ast_slinfactory_init(struct ast_slinfactory *sf);
45
46 /*!
47  * \brief Destroy the contents of a slinfactory
48  *
49  * \arg sf the slinfactory that is no longer needed
50  *
51  * This function will free any memory allocated for the contents of the
52  * slinfactory.  It does not free the slinfactory itself.  If the sf is
53  * malloc'd, then it must be explicitly free'd after calling this function.
54  *
55  * \return nothing
56  */
57 void ast_slinfactory_destroy(struct ast_slinfactory *sf);
58
59 int ast_slinfactory_feed(struct ast_slinfactory *sf, struct ast_frame *f);
60 int ast_slinfactory_read(struct ast_slinfactory *sf, short *buf, size_t samples);
61 unsigned int ast_slinfactory_available(const struct ast_slinfactory *sf);
62 void ast_slinfactory_flush(struct ast_slinfactory *sf);
63
64 #if defined(__cplusplus) || defined(c_plusplus)
65 }
66 #endif
67
68 #endif /* _ASTERISK_SLINFACTORY_H */