issue #5590
[asterisk/asterisk.git] / include / asterisk / chanspy.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, 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 Asterisk PBX channel spy definitions
21  */
22
23 #ifndef _ASTERISK_CHANSPY_H
24 #define _ASTERISK_CHANSPY_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 #include "asterisk/linkedlists.h"
31
32 enum chanspy_states {
33         CHANSPY_NEW = 0,
34         CHANSPY_RUNNING = 1,
35         CHANSPY_DONE = 2,
36 };
37
38 enum chanspy_flags {
39         CHANSPY_MIXAUDIO = (1 << 0),
40         CHANSPY_READ_VOLADJUST = (1 << 1),
41         CHANSPY_WRITE_VOLADJUST = (1 << 2),
42         CHANSPY_FORMAT_AUDIO = (1 << 3),
43         CHANSPY_TRIGGER_MODE = (3 << 4),
44         CHANSPY_TRIGGER_READ = (1 << 4),
45         CHANSPY_TRIGGER_WRITE = (2 << 4),
46         CHANSPY_TRIGGER_NONE = (3 << 4),
47         CHANSPY_TRIGGER_FLUSH = (1 << 6),
48 };
49
50 struct ast_channel_spy_queue {
51         struct ast_frame *head;
52         unsigned int samples;
53         unsigned int format;
54 };
55
56 struct ast_channel_spy {
57         AST_LIST_ENTRY(ast_channel_spy) list;
58         ast_mutex_t lock;
59         ast_cond_t trigger;
60         struct ast_channel_spy_queue read_queue;
61         struct ast_channel_spy_queue write_queue;
62         unsigned int flags;
63         enum chanspy_states status;
64         const char *type;
65         /* The volume adjustment values are very straightforward:
66            positive values cause the samples to be multiplied by that amount
67            negative values cause the samples to be divided by the absolute value of that amount
68         */
69         int read_vol_adjustment;
70         int write_vol_adjustment;
71 };
72
73 /*!
74   \brief Adds a spy to a channel, to begin receiving copies of the channel's audio frames.
75   \param chan The channel to add the spy to.
76   \param spy A pointer to ast_channel_spy structure describing how the spy is to be used.
77   \return 0 for success, non-zero for failure
78
79   Note: This function performs no locking; you must hold the channel's lock before
80   calling this function.
81  */
82 int ast_channel_spy_add(struct ast_channel *chan, struct ast_channel_spy *spy);
83
84 /*!
85   \brief Remove a spy from a channel.
86   \param chan The channel to remove the spy from
87   \param spy The spy to be removed
88   \return nothing
89
90   Note: This function performs no locking; you must hold the channel's lock before
91   calling this function.
92  */
93 void ast_channel_spy_remove(struct ast_channel *chan, struct ast_channel_spy *spy);
94
95 /*!
96   \brief Find all spies of a particular type on a channel and stop them.
97   \param chan The channel to operate on
98   \param type A character string identifying the type of spies to be stopped
99   \return nothing
100
101   Note: This function performs no locking; you must hold the channel's lock before
102   calling this function.
103  */
104 void ast_channel_spy_stop_by_type(struct ast_channel *chan, const char *type);
105
106 /*!
107   \brief Read one (or more) frames of audio from a channel being spied upon.
108   \param spy The spy to operate on
109   \param samples The number of audio samples to read
110   \return NULL for failure, one ast_frame pointer, or a chain of ast_frame pointers
111
112   This function can return multiple frames if the spy structure needs to be 'flushed'
113   due to mismatched queue lengths, or if the spy structure is configured to return
114   unmixed audio (in which case each call to this function will return a frame of audio
115   from each side of channel).
116
117   Note: This function performs no locking; you must hold the spy's lock before calling
118   this function. You must <b>not</b> hold the channel's lock at the same time.
119  */
120 struct ast_frame *ast_channel_spy_read_frame(struct ast_channel_spy *spy, unsigned int samples);
121
122 /*!
123   \brief Efficiently wait until audio is available for a spy, or an exception occurs.
124   \param spy The spy to wait on
125   \return nothing
126
127   Note: The locking rules for this function are non-obvious... first, you must <b>not</b>
128   hold the channel's lock when calling this function. Second, you must hold the spy's lock
129   before making the function call; while the function runs the lock will be released, and
130   when the trigger event occurs, the lock will be re-obtained. This means that when control
131   returns to your code, you will again hold the spy's lock.
132  */
133 void ast_channel_spy_trigger_wait(struct ast_channel_spy *spy);
134
135 #if defined(__cplusplus) || defined(c_plusplus)
136 }
137 #endif
138
139 #endif /* _ASTERISK_CHANSPY_H */