4ebd19e5dfca1a4573ae44747f9949117aa78438
[asterisk/asterisk.git] / include / asterisk / audiohook.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2007, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 Audiohooks Architecture
21  */
22
23 #ifndef _ASTERISK_AUDIOHOOK_H
24 #define _ASTERISK_AUDIOHOOK_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 /* these two are used in struct ast_audiohook */
31 #include "asterisk/lock.h"
32 #include "asterisk/linkedlists.h"
33
34 #include "asterisk/slinfactory.h"
35
36 enum ast_audiohook_type {
37         AST_AUDIOHOOK_TYPE_SPY = 0,    /*!< Audiohook wants to receive audio */
38         AST_AUDIOHOOK_TYPE_WHISPER,    /*!< Audiohook wants to provide audio to be mixed with existing audio */
39         AST_AUDIOHOOK_TYPE_MANIPULATE, /*!< Audiohook wants to manipulate the audio */
40 };
41
42 enum ast_audiohook_status {
43         AST_AUDIOHOOK_STATUS_NEW = 0,  /*!< Audiohook was just created, not in use yet */
44         AST_AUDIOHOOK_STATUS_RUNNING,  /*!< Audiohook is running on a channel */
45         AST_AUDIOHOOK_STATUS_SHUTDOWN, /*!< Audiohook is being shutdown */
46         AST_AUDIOHOOK_STATUS_DONE,     /*!< Audiohook has shutdown and is not running on a channel any longer */
47 };
48
49 enum ast_audiohook_direction {
50         AST_AUDIOHOOK_DIRECTION_READ = 0, /*!< Reading audio in */
51         AST_AUDIOHOOK_DIRECTION_WRITE,    /*!< Writing audio out */
52         AST_AUDIOHOOK_DIRECTION_BOTH,     /*!< Both reading audio in and writing audio out */
53 };
54
55 enum ast_audiohook_flags {
56         AST_AUDIOHOOK_TRIGGER_MODE = (3 << 0),  /*!< When audiohook should be triggered to do something */
57         AST_AUDIOHOOK_TRIGGER_READ = (1 << 0),  /*!< Audiohook wants to be triggered when reading audio in */
58         AST_AUDIOHOOK_TRIGGER_WRITE = (2 << 0), /*!< Audiohook wants to be triggered when writing audio out */
59         AST_AUDIOHOOK_WANTS_DTMF = (1 << 1),    /*!< Audiohook also wants to receive DTMF frames */
60         AST_AUDIOHOOK_TRIGGER_SYNC = (1 << 2),  /*!< Audiohook wants to be triggered when both sides have combined audio available */
61 };
62
63 struct ast_audiohook;
64
65 /*! \brief Callback function for manipulate audiohook type
66  * \param audiohook Audiohook structure
67  * \param chan Channel
68  * \param frame Frame of audio to manipulate
69  * \param direction Direction frame came from
70  * \return Returns 0 on success, -1 on failure
71  * \note An audiohook does not have any reference to a private data structure for manipulate types. It is up to the manipulate callback to store this data
72  *       via it's own method. An example would be datastores.
73  */
74 typedef int (*ast_audiohook_manipulate_callback)(struct ast_audiohook *audiohook, struct ast_channel *chan, struct ast_frame *frame, enum ast_audiohook_direction direction);
75
76 struct ast_audiohook_options {
77         int read_volume;  /*!< Volume adjustment on frames read from the channel the hook is on */
78         int write_volume; /*!< Volume adjustment on frames written to the channel the hook is on */
79 };
80
81 struct ast_audiohook {
82         ast_mutex_t lock;                                      /*!< Lock that protects the audiohook structure */
83         ast_cond_t trigger;                                    /*!< Trigger condition (if enabled) */
84         enum ast_audiohook_type type;                          /*!< Type of audiohook */
85         enum ast_audiohook_status status;                      /*!< Status of the audiohook */
86         const char *source;                                    /*!< Who this audiohook ultimately belongs to */
87         unsigned int flags;                                    /*!< Flags on the audiohook */
88         struct ast_slinfactory read_factory;                   /*!< Factory where frames read from the channel, or read from the whisper source will go through */
89         struct ast_slinfactory write_factory;                  /*!< Factory where frames written to the channel will go through */
90         struct timeval read_time;                              /*!< Last time read factory was fed */
91         struct timeval write_time;                             /*!< Last time write factory was fed */
92         int format;                                            /*!< Format translation path is setup as */
93         struct ast_trans_pvt *trans_pvt;                       /*!< Translation path for reading frames */
94         ast_audiohook_manipulate_callback manipulate_callback; /*!< Manipulation callback */
95         struct ast_audiohook_options options;                  /*!< Applicable options */
96         AST_LIST_ENTRY(ast_audiohook) list;                    /*!< Linked list information */
97 };
98
99 struct ast_audiohook_list;
100
101 /*! \brief Initialize an audiohook structure
102  * \param audiohook Audiohook structure
103  * \param type Type of audiohook to initialize this as
104  * \param source Who is initializing this audiohook
105  * \return Returns 0 on success, -1 on failure
106  */
107 int ast_audiohook_init(struct ast_audiohook *audiohook, enum ast_audiohook_type type, const char *source);
108
109 /*! \brief Destroys an audiohook structure
110  * \param audiohook Audiohook structure
111  * \return Returns 0 on success, -1 on failure
112  */
113 int ast_audiohook_destroy(struct ast_audiohook *audiohook);
114
115 /*! \brief Writes a frame into the audiohook structure
116  * \param audiohook Audiohook structure
117  * \param direction Direction the audio frame came from
118  * \param frame Frame to write in
119  * \return Returns 0 on success, -1 on failure
120  */
121 int ast_audiohook_write_frame(struct ast_audiohook *audiohook, enum ast_audiohook_direction direction, struct ast_frame *frame);
122
123 /*! \brief Reads a frame in from the audiohook structure
124  * \param audiohook Audiohook structure
125  * \param samples Number of samples wanted
126  * \param direction Direction the audio frame came from
127  * \param format Format of frame remote side wants back
128  * \return Returns frame on success, NULL on failure
129  */
130 struct ast_frame *ast_audiohook_read_frame(struct ast_audiohook *audiohook, size_t samples, enum ast_audiohook_direction direction, int format);
131
132 /*! \brief Attach audiohook to channel
133  * \param chan Channel
134  * \param audiohook Audiohook structure
135  * \return Returns 0 on success, -1 on failure
136  */
137 int ast_audiohook_attach(struct ast_channel *chan, struct ast_audiohook *audiohook);
138
139 /*! \brief Detach audiohook from channel
140  * \param audiohook Audiohook structure
141  * \return Returns 0 on success, -1 on failure
142  */
143 int ast_audiohook_detach(struct ast_audiohook *audiohook);
144
145 /*! \brief Detach audiohooks from list and destroy said list
146  * \param audiohook_list List of audiohooks
147  * \return Returns 0 on success, -1 on failure
148  */
149 int ast_audiohook_detach_list(struct ast_audiohook_list *audiohook_list);
150
151 /*! 
152  * \brief Detach specified source audiohook from channel
153  *
154  * \param chan Channel to detach from
155  * \param source Name of source to detach
156  *
157  * \return Returns 0 on success, -1 on failure
158  *
159  * \note The channel does not need to be locked before calling this function.
160  */
161 int ast_audiohook_detach_source(struct ast_channel *chan, const char *source);
162
163 /*! \brief Pass a frame off to be handled by the audiohook core
164  * \param chan Channel that the list is coming off of
165  * \param audiohook_list List of audiohooks
166  * \param direction Direction frame is coming in from
167  * \param frame The frame itself
168  * \return Return frame on success, NULL on failure
169  */
170 struct ast_frame *ast_audiohook_write_list(struct ast_channel *chan, struct ast_audiohook_list *audiohook_list, enum ast_audiohook_direction direction, struct ast_frame *frame);
171
172 /*! \brief Wait for audiohook trigger to be triggered
173  * \param audiohook Audiohook to wait on
174  */
175 void ast_audiohook_trigger_wait(struct ast_audiohook *audiohook);
176
177 /*!
178   \brief Find out how many audiohooks from  a certain source exist on a given channel, regardless of status.
179   \param chan The channel on which to find the spies 
180   \param source The audiohook's source
181   \param type The type of audiohook 
182   \return Return the number of audiohooks which are from the source specified
183
184   Note: Function performs nlocking.
185 */
186 int ast_channel_audiohook_count_by_source(struct ast_channel *chan, const char *source, enum ast_audiohook_type type);
187
188 /*!
189   \brief Find out how many spies of a certain type exist on a given channel, and are in state running.
190   \param chan The channel on which to find the spies
191   \param source The source of the audiohook
192   \param type The type of spy to look for
193   \return Return the number of running audiohooks which are from the source specified
194
195   Note: Function performs no locking.
196 */
197 int ast_channel_audiohook_count_by_source_running(struct ast_channel *chan, const char *source, enum ast_audiohook_type type);
198
199 /*! \brief Lock an audiohook
200  * \param ah Audiohook structure
201  */
202 #define ast_audiohook_lock(ah) ast_mutex_lock(&(ah)->lock)
203
204 /*! \brief Unlock an audiohook
205  * \param ah Audiohook structure
206  */
207 #define ast_audiohook_unlock(ah) ast_mutex_unlock(&(ah)->lock)
208
209 /*! \brief Adjust the volume on frames read from or written to a channel
210  * \param chan Channel to muck with
211  * \param direction Direction to set on
212  * \param volume Value to adjust the volume by
213  * \return Returns 0 on success, -1 on failure
214  */
215 int ast_audiohook_volume_set(struct ast_channel *chan, enum ast_audiohook_direction direction, int volume);
216
217 /*! \brief Retrieve the volume adjustment value on frames read from or written to a channel
218  * \param chan Channel to retrieve volume adjustment from
219  * \param direction Direction to retrieve
220  * \return Returns adjustment value
221  */
222 int ast_audiohook_volume_get(struct ast_channel *chan, enum ast_audiohook_direction direction);
223
224 /*! \brief Adjust the volume on frames read from or written to a channel
225  * \param chan Channel to muck with
226  * \param direction Direction to increase
227  * \param volume Value to adjust the adjustment by
228  * \return Returns 0 on success, -1 on failure
229  */
230 int ast_audiohook_volume_adjust(struct ast_channel *chan, enum ast_audiohook_direction direction, int volume);
231
232 #if defined(__cplusplus) || defined(c_plusplus)
233 }
234 #endif
235
236 #endif /* _ASTERISK_AUDIOHOOK_H */