diff --git a/ChangeLog b/ChangeLog index 66a2dfedc7db8bbe3385945347df7becf04220f1..677f46933c056fd15681ccc32ac3113fdea45a52 100755 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,7 @@ 2005-11-10 Kevin P. Fleming <kpfleming@digium.com> + * include/asterisk/chanspy.h: move spy-related stuff into separate header so chan_h323 can build (issue #5590) + * include/asterisk/linkedlists.h (AST_LIST_HEAD_SET_NOLOCK): properly initialize tail pointer when list head is directly set (issue #5669) * app.c (ast_app_parse_options): ok, so we aren't all perfect... let's make the while loop actually work properly here (issue #5684) diff --git a/apps/app_chanspy.c b/apps/app_chanspy.c index 3ec7b6dfb2e6d762e1d1e74fb7dddd87480c6394..7d9061579d4a58d0b9946abe95a458057988bbb1 100755 --- a/apps/app_chanspy.c +++ b/apps/app_chanspy.c @@ -35,6 +35,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/file.h" #include "asterisk/logger.h" #include "asterisk/channel.h" +#include "asterisk/chanspy.h" #include "asterisk/features.h" #include "asterisk/options.h" #include "asterisk/app.h" diff --git a/apps/app_mixmonitor.c b/apps/app_mixmonitor.c index 6667377171c4ed7be777984ebcab9496081a33b4..ef9ec254dea8de5e30a0c3c54870b28b7820fd91 100755 --- a/apps/app_mixmonitor.c +++ b/apps/app_mixmonitor.c @@ -38,6 +38,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/file.h" #include "asterisk/logger.h" #include "asterisk/channel.h" +#include "asterisk/chanspy.h" #include "asterisk/pbx.h" #include "asterisk/module.h" #include "asterisk/lock.h" diff --git a/channel.c b/channel.c index 91c9fa355c9ec62937f730f714313d1947cd86b5..66560fef06a395c1e26c6776d725b353589f728c 100755 --- a/channel.c +++ b/channel.c @@ -52,6 +52,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/sched.h" #include "asterisk/options.h" #include "asterisk/channel.h" +#include "asterisk/chanspy.h" #include "asterisk/musiconhold.h" #include "asterisk/logger.h" #include "asterisk/say.h" diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h index 61a8a29d757df6916bd47730cae30b740a3a0919..6a4ff373f77bf5eb9babc0c6b5d18b78861cf7e3 100755 --- a/include/asterisk/channel.h +++ b/include/asterisk/channel.h @@ -244,48 +244,6 @@ struct ast_channel_tech { struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge); }; - -enum chanspy_states { - CHANSPY_NEW = 0, - CHANSPY_RUNNING = 1, - CHANSPY_DONE = 2, -}; - -enum chanspy_flags { - CHANSPY_MIXAUDIO = (1 << 0), - CHANSPY_READ_VOLADJUST = (1 << 1), - CHANSPY_WRITE_VOLADJUST = (1 << 2), - CHANSPY_FORMAT_AUDIO = (1 << 3), - CHANSPY_TRIGGER_MODE = (3 << 4), - CHANSPY_TRIGGER_READ = (1 << 4), - CHANSPY_TRIGGER_WRITE = (2 << 4), - CHANSPY_TRIGGER_NONE = (3 << 4), - CHANSPY_TRIGGER_FLUSH = (1 << 6), -}; - -struct ast_channel_spy_queue { - struct ast_frame *head; - unsigned int samples; - unsigned int format; -}; - -struct ast_channel_spy { - ast_mutex_t lock; - ast_cond_t trigger; - struct ast_channel_spy_queue read_queue; - struct ast_channel_spy_queue write_queue; - unsigned int flags; - enum chanspy_states status; - const char *type; - /* The volume adjustment values are very straightforward: - positive values cause the samples to be multiplied by that amount - negative values cause the samples to be divided by the absolute value of that amount - */ - int read_vol_adjustment; - int write_vol_adjustment; - AST_LIST_ENTRY(ast_channel_spy) list; -}; - struct ast_channel_spy_list; /*! Main Channel structure associated with a channel. @@ -1110,68 +1068,6 @@ void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_ */ void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars); -/*! - \brief Adds a spy to a channel, to begin receiving copies of the channel's audio frames. - \param chan The channel to add the spy to. - \param spy A pointer to ast_channel_spy structure describing how the spy is to be used. - \return 0 for success, non-zero for failure - - Note: This function performs no locking; you must hold the channel's lock before - calling this function. - */ -int ast_channel_spy_add(struct ast_channel *chan, struct ast_channel_spy *spy); - -/*! - \brief Remove a spy from a channel. - \param chan The channel to remove the spy from - \param spy The spy to be removed - \return nothing - - Note: This function performs no locking; you must hold the channel's lock before - calling this function. - */ -void ast_channel_spy_remove(struct ast_channel *chan, struct ast_channel_spy *spy); - -/*! - \brief Find all spies of a particular type on a channel and stop them. - \param chan The channel to operate on - \param type A character string identifying the type of spies to be stopped - \return nothing - - Note: This function performs no locking; you must hold the channel's lock before - calling this function. - */ -void ast_channel_spy_stop_by_type(struct ast_channel *chan, const char *type); - -/*! - \brief Read one (or more) frames of audio from a channel being spied upon. - \param spy The spy to operate on - \param samples The number of audio samples to read - \return NULL for failure, one ast_frame pointer, or a chain of ast_frame pointers - - This function can return multiple frames if the spy structure needs to be 'flushed' - due to mismatched queue lengths, or if the spy structure is configured to return - unmixed audio (in which case each call to this function will return a frame of audio - from each side of channel). - - Note: This function performs no locking; you must hold the spy's lock before calling - this function. You must <b>not</b> hold the channel's lock at the same time. - */ -struct ast_frame *ast_channel_spy_read_frame(struct ast_channel_spy *spy, unsigned int samples); - -/*! - \brief Efficiently wait until audio is available for a spy, or an exception occurs. - \param spy The spy to wait on - \return nothing - - Note: The locking rules for this function are non-obvious... first, you must <b>not</b> - hold the channel's lock when calling this function. Second, you must hold the spy's lock - before making the function call; while the function runs the lock will be released, and - when the trigger event occurs, the lock will be re-obtained. This means that when control - returns to your code, you will again hold the spy's lock. - */ -void ast_channel_spy_trigger_wait(struct ast_channel_spy *spy); - /*! \brief An opaque 'object' structure use by silence generators on channels. */ diff --git a/include/asterisk/chanspy.h b/include/asterisk/chanspy.h new file mode 100755 index 0000000000000000000000000000000000000000..4973763b23dd046b3e1aea88c4710eb448f55c58 --- /dev/null +++ b/include/asterisk/chanspy.h @@ -0,0 +1,139 @@ +/* + * Asterisk -- An open source telephony toolkit. + * + * Copyright (C) 1999 - 2005, Digium, Inc. + * + * Mark Spencer <markster@digium.com> + * + * See http://www.asterisk.org for more information about + * the Asterisk project. Please do not directly contact + * any of the maintainers of this project for assistance; + * the project provides a web site, mailing lists and IRC + * channels for your use. + * + * This program is free software, distributed under the terms of + * the GNU General Public License Version 2. See the LICENSE file + * at the top of the source tree. + */ + +/*! \file + * \brief Asterisk PBX channel spy definitions + */ + +#ifndef _ASTERISK_CHANSPY_H +#define _ASTERISK_CHANSPY_H + +#if defined(__cplusplus) || defined(c_plusplus) +extern "C" { +#endif + +#include "asterisk/linkedlists.h" + +enum chanspy_states { + CHANSPY_NEW = 0, + CHANSPY_RUNNING = 1, + CHANSPY_DONE = 2, +}; + +enum chanspy_flags { + CHANSPY_MIXAUDIO = (1 << 0), + CHANSPY_READ_VOLADJUST = (1 << 1), + CHANSPY_WRITE_VOLADJUST = (1 << 2), + CHANSPY_FORMAT_AUDIO = (1 << 3), + CHANSPY_TRIGGER_MODE = (3 << 4), + CHANSPY_TRIGGER_READ = (1 << 4), + CHANSPY_TRIGGER_WRITE = (2 << 4), + CHANSPY_TRIGGER_NONE = (3 << 4), + CHANSPY_TRIGGER_FLUSH = (1 << 6), +}; + +struct ast_channel_spy_queue { + struct ast_frame *head; + unsigned int samples; + unsigned int format; +}; + +struct ast_channel_spy { + AST_LIST_ENTRY(ast_channel_spy) list; + ast_mutex_t lock; + ast_cond_t trigger; + struct ast_channel_spy_queue read_queue; + struct ast_channel_spy_queue write_queue; + unsigned int flags; + enum chanspy_states status; + const char *type; + /* The volume adjustment values are very straightforward: + positive values cause the samples to be multiplied by that amount + negative values cause the samples to be divided by the absolute value of that amount + */ + int read_vol_adjustment; + int write_vol_adjustment; +}; + +/*! + \brief Adds a spy to a channel, to begin receiving copies of the channel's audio frames. + \param chan The channel to add the spy to. + \param spy A pointer to ast_channel_spy structure describing how the spy is to be used. + \return 0 for success, non-zero for failure + + Note: This function performs no locking; you must hold the channel's lock before + calling this function. + */ +int ast_channel_spy_add(struct ast_channel *chan, struct ast_channel_spy *spy); + +/*! + \brief Remove a spy from a channel. + \param chan The channel to remove the spy from + \param spy The spy to be removed + \return nothing + + Note: This function performs no locking; you must hold the channel's lock before + calling this function. + */ +void ast_channel_spy_remove(struct ast_channel *chan, struct ast_channel_spy *spy); + +/*! + \brief Find all spies of a particular type on a channel and stop them. + \param chan The channel to operate on + \param type A character string identifying the type of spies to be stopped + \return nothing + + Note: This function performs no locking; you must hold the channel's lock before + calling this function. + */ +void ast_channel_spy_stop_by_type(struct ast_channel *chan, const char *type); + +/*! + \brief Read one (or more) frames of audio from a channel being spied upon. + \param spy The spy to operate on + \param samples The number of audio samples to read + \return NULL for failure, one ast_frame pointer, or a chain of ast_frame pointers + + This function can return multiple frames if the spy structure needs to be 'flushed' + due to mismatched queue lengths, or if the spy structure is configured to return + unmixed audio (in which case each call to this function will return a frame of audio + from each side of channel). + + Note: This function performs no locking; you must hold the spy's lock before calling + this function. You must <b>not</b> hold the channel's lock at the same time. + */ +struct ast_frame *ast_channel_spy_read_frame(struct ast_channel_spy *spy, unsigned int samples); + +/*! + \brief Efficiently wait until audio is available for a spy, or an exception occurs. + \param spy The spy to wait on + \return nothing + + Note: The locking rules for this function are non-obvious... first, you must <b>not</b> + hold the channel's lock when calling this function. Second, you must hold the spy's lock + before making the function call; while the function runs the lock will be released, and + when the trigger event occurs, the lock will be re-obtained. This means that when control + returns to your code, you will again hold the spy's lock. + */ +void ast_channel_spy_trigger_wait(struct ast_channel_spy *spy); + +#if defined(__cplusplus) || defined(c_plusplus) +} +#endif + +#endif /* _ASTERISK_CHANSPY_H */