Blocked revisions 174644 via svnmerge
[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
27 #if defined(__cplusplus) || defined(c_plusplus)
28 extern "C" {
29 #endif
30
31 #define AST_SLINFACTORY_MAX_HOLD 1280
32
33 struct ast_slinfactory {
34         AST_LIST_HEAD_NOLOCK(, ast_frame) queue; /*!< A list of unaltered frames */
35         struct ast_trans_pvt *trans;             /*!< Translation path that converts fed frames into signed linear */
36         short hold[AST_SLINFACTORY_MAX_HOLD];    /*!< Hold for audio that no longer belongs to a frame (ie: if only some samples were taken from a frame) */
37         short *offset;                           /*!< Offset into the hold where audio begins */
38         size_t holdlen;                          /*!< Number of samples currently in the hold */
39         unsigned int size;                       /*!< Number of samples currently in the factory */
40         unsigned int format;                     /*!< Current format the translation path is converting from */
41 };
42
43 /*!
44  * \brief Initialize an slinfactory
45  *
46  * \param sf The slinfactory to initialize
47  *
48  * \return Nothing
49  */
50 void ast_slinfactory_init(struct ast_slinfactory *sf);
51
52 /*!
53  * \brief Destroy the contents of a slinfactory
54  *
55  * \param sf The slinfactory that is no longer needed
56  *
57  * This function will free any memory allocated for the contents of the
58  * slinfactory.  It does not free the slinfactory itself.  If the sf is
59  * malloc'd, then it must be explicitly free'd after calling this function.
60  *
61  * \return Nothing
62  */
63 void ast_slinfactory_destroy(struct ast_slinfactory *sf);
64
65 /*!
66  * \brief Feed audio into an slinfactory
67  *
68  * \param sf The slinfactory to feed into
69  * \param f Frame containing audio to feed in
70  *
71  * \return Number of frames currently in factory
72  */
73 int ast_slinfactory_feed(struct ast_slinfactory *sf, struct ast_frame *f);
74
75 /*!
76  * \brief Read samples from an slinfactory
77  *
78  * \param sf The slinfactory to read from
79  * \param buf Buffer to put samples into
80  * \param samples Number of samples wanted
81  *
82  * \return Number of samples read
83  */
84 int ast_slinfactory_read(struct ast_slinfactory *sf, short *buf, size_t samples);
85
86 /*!
87  * \brief Retrieve number of samples currently in an slinfactory
88  *
89  * \param sf The slinfactory to peek into
90  *
91  * \return Number of samples in slinfactory
92  */
93 unsigned int ast_slinfactory_available(const struct ast_slinfactory *sf);
94
95 /*!
96  * \brief Flush the contents of an slinfactory
97  *
98  * \param sf The slinfactory to flush
99  *
100  * \return Nothing
101  */
102 void ast_slinfactory_flush(struct ast_slinfactory *sf);
103
104 #if defined(__cplusplus) || defined(c_plusplus)
105 }
106 #endif
107
108 #endif /* _ASTERISK_SLINFACTORY_H */