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