audiohook.h File Reference

Audiohooks Architecture. More...

#include "asterisk/lock.h"
#include "asterisk/linkedlists.h"
#include "asterisk/slinfactory.h"

Include dependency graph for audiohook.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	ast_audiohook
struct	ast_audiohook_options
Defines
#define	ast_audiohook_lock(ah) ast_mutex_lock(&(ah)->lock)
	Lock an audiohook.
#define	AST_AUDIOHOOK_SYNC_TOLERANCE 100
#define	ast_audiohook_unlock(ah) ast_mutex_unlock(&(ah)->lock)
	Unlock an audiohook.
Typedefs
typedef int(*	ast_audiohook_manipulate_callback )(struct ast_audiohook audiohook, struct ast_channel chan, struct ast_frame *frame, enum ast_audiohook_direction direction)
	Callback function for manipulate audiohook type.
Enumerations
enum	ast_audiohook_direction { AST_AUDIOHOOK_DIRECTION_READ = 0, AST_AUDIOHOOK_DIRECTION_WRITE, AST_AUDIOHOOK_DIRECTION_BOTH }
enum	ast_audiohook_flags { AST_AUDIOHOOK_TRIGGER_MODE = (3 << 0), AST_AUDIOHOOK_TRIGGER_READ = (1 << 0), AST_AUDIOHOOK_TRIGGER_WRITE = (2 << 0), AST_AUDIOHOOK_WANTS_DTMF = (1 << 1), AST_AUDIOHOOK_TRIGGER_SYNC = (1 << 2), AST_AUDIOHOOK_SMALL_QUEUE = (1 << 3) }
enum	ast_audiohook_status { AST_AUDIOHOOK_STATUS_NEW = 0, AST_AUDIOHOOK_STATUS_RUNNING, AST_AUDIOHOOK_STATUS_SHUTDOWN, AST_AUDIOHOOK_STATUS_DONE }
enum	ast_audiohook_type { AST_AUDIOHOOK_TYPE_SPY = 0, AST_AUDIOHOOK_TYPE_WHISPER, AST_AUDIOHOOK_TYPE_MANIPULATE }
Functions
int	ast_audiohook_attach (struct ast_channel chan, struct ast_audiohook audiohook)
	Attach audiohook to channel.
int	ast_audiohook_destroy (struct ast_audiohook *audiohook)
	Destroys an audiohook structure.
int	ast_audiohook_detach (struct ast_audiohook *audiohook)
	Detach audiohook from channel.
int	ast_audiohook_detach_list (struct ast_audiohook_list *audiohook_list)
	Detach audiohooks from list and destroy said list.
int	ast_audiohook_detach_source (struct ast_channel chan, const char source)
	Detach specified source audiohook from channel.
int	ast_audiohook_init (struct ast_audiohook audiohook, enum ast_audiohook_type type, const char source)
	Initialize an audiohook structure.
void	ast_audiohook_move_by_source (struct ast_channel old_chan, struct ast_channel new_chan, const char *source)
	Move an audiohook from one channel to a new one.
struct ast_frame *	ast_audiohook_read_frame (struct ast_audiohook *audiohook, size_t samples, enum ast_audiohook_direction direction, int format)
	Reads a frame in from the audiohook structure.
int	ast_audiohook_remove (struct ast_channel chan, struct ast_audiohook audiohook)
	Remove an audiohook from a specified channel.
void	ast_audiohook_trigger_wait (struct ast_audiohook *audiohook)
	Wait for audiohook trigger to be triggered.
void	ast_audiohook_update_status (struct ast_audiohook *audiohook, enum ast_audiohook_status status)
	Update audiohook's status.
int	ast_audiohook_volume_adjust (struct ast_channel *chan, enum ast_audiohook_direction direction, int volume)
	Adjust the volume on frames read from or written to a channel.
int	ast_audiohook_volume_get (struct ast_channel *chan, enum ast_audiohook_direction direction)
	Retrieve the volume adjustment value on frames read from or written to a channel.
int	ast_audiohook_volume_set (struct ast_channel *chan, enum ast_audiohook_direction direction, int volume)
	Adjust the volume on frames read from or written to a channel.
int	ast_audiohook_write_frame (struct ast_audiohook audiohook, enum ast_audiohook_direction direction, struct ast_frame frame)
	Writes a frame into the audiohook structure.
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)
	Pass a frame off to be handled by the audiohook core.
int	ast_channel_audiohook_count_by_source (struct ast_channel chan, const char source, enum ast_audiohook_type type)
	Find out how many audiohooks from a certain source exist on a given channel, regardless of status.
int	ast_channel_audiohook_count_by_source_running (struct ast_channel chan, const char source, enum ast_audiohook_type type)
	Find out how many spies of a certain type exist on a given channel, and are in state running.

Detailed Description

Audiohooks Architecture.

Definition in file audiohook.h.

Define Documentation

#define ast_audiohook_lock ( ah ) ast_mutex_lock(&(ah)->lock)

Lock an audiohook.

Parameters:

ah

Audiohook structure

Definition at line 241 of file audiohook.h.

Referenced by ast_audiohook_move_by_source(), ast_audiohook_update_status(), audio_audiohook_write_list(), channel_spy(), destroy_monitor_audiohook(), dtmf_audiohook_write_list(), mixmonitor_thread(), spy_generate(), and stop_mixmonitor_exec().

#define AST_AUDIOHOOK_SYNC_TOLERANCE 100

Definition at line 67 of file audiohook.h.

Referenced by ast_audiohook_write_frame().

#define ast_audiohook_unlock ( ah ) ast_mutex_unlock(&(ah)->lock)

Unlock an audiohook.

Parameters:

ah

Audiohook structure

Definition at line 246 of file audiohook.h.

Referenced by ast_audiohook_move_by_source(), ast_audiohook_update_status(), audio_audiohook_write_list(), channel_spy(), destroy_monitor_audiohook(), dtmf_audiohook_write_list(), mixmonitor_thread(), spy_generate(), and stop_mixmonitor_exec().

Typedef Documentation

typedef int(* ast_audiohook_manipulate_callback)(struct ast_audiohook *audiohook, struct ast_channel *chan, struct ast_frame *frame, enum ast_audiohook_direction direction)

Callback function for manipulate audiohook type.

Parameters:

	audiohook	Audiohook structure
	chan	Channel
	frame	Frame of audio to manipulate
	direction	Direction frame came from

Returns:: Returns 0 on success, -1 on failure

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 via it's own method. An example would be datastores.

Definition at line 80 of file audiohook.h.

Enumeration Type Documentation

enum ast_audiohook_direction

Enumerator:

AST_AUDIOHOOK_DIRECTION_READ	Reading audio in
AST_AUDIOHOOK_DIRECTION_WRITE	Writing audio out
AST_AUDIOHOOK_DIRECTION_BOTH	Both reading audio in and writing audio out

Definition at line 49 of file audiohook.h.

00049                              {
00050    AST_AUDIOHOOK_DIRECTION_READ = 0, /*!< Reading audio in */
00051    AST_AUDIOHOOK_DIRECTION_WRITE,    /*!< Writing audio out */
00052    AST_AUDIOHOOK_DIRECTION_BOTH,     /*!< Both reading audio in and writing audio out */
00053 };

enum ast_audiohook_flags

Enumerator:

AST_AUDIOHOOK_TRIGGER_MODE	When audiohook should be triggered to do something
AST_AUDIOHOOK_TRIGGER_READ	Audiohook wants to be triggered when reading audio in
AST_AUDIOHOOK_TRIGGER_WRITE	Audiohook wants to be triggered when writing audio out
AST_AUDIOHOOK_WANTS_DTMF	Audiohook also wants to receive DTMF frames
AST_AUDIOHOOK_TRIGGER_SYNC	Audiohook wants to be triggered when both sides have combined audio available
AST_AUDIOHOOK_SMALL_QUEUE	Audiohooks with this flag set will not allow for a large amount of samples to build up on its slinfactories. We will flush the factories if they contain too many samples.

Definition at line 55 of file audiohook.h.

00055                          {
00056    AST_AUDIOHOOK_TRIGGER_MODE = (3 << 0),  /*!< When audiohook should be triggered to do something */
00057    AST_AUDIOHOOK_TRIGGER_READ = (1 << 0),  /*!< Audiohook wants to be triggered when reading audio in */
00058    AST_AUDIOHOOK_TRIGGER_WRITE = (2 << 0), /*!< Audiohook wants to be triggered when writing audio out */
00059    AST_AUDIOHOOK_WANTS_DTMF = (1 << 1),    /*!< Audiohook also wants to receive DTMF frames */
00060    AST_AUDIOHOOK_TRIGGER_SYNC = (1 << 2),  /*!< Audiohook wants to be triggered when both sides have combined audio available */
00061    /*! Audiohooks with this flag set will not allow for a large amount of samples to build up on its
00062     * slinfactories. We will flush the factories if they contain too many samples.
00063     */
00064    AST_AUDIOHOOK_SMALL_QUEUE = (1 << 3),
00065 };

enum ast_audiohook_status

Enumerator:

AST_AUDIOHOOK_STATUS_NEW	Audiohook was just created, not in use yet
AST_AUDIOHOOK_STATUS_RUNNING	Audiohook is running on a channel
AST_AUDIOHOOK_STATUS_SHUTDOWN	Audiohook is being shutdown
AST_AUDIOHOOK_STATUS_DONE	Audiohook has shutdown and is not running on a channel any longer

Definition at line 42 of file audiohook.h.

00042                           {
00043    AST_AUDIOHOOK_STATUS_NEW = 0,  /*!< Audiohook was just created, not in use yet */
00044    AST_AUDIOHOOK_STATUS_RUNNING,  /*!< Audiohook is running on a channel */
00045    AST_AUDIOHOOK_STATUS_SHUTDOWN, /*!< Audiohook is being shutdown */
00046    AST_AUDIOHOOK_STATUS_DONE,     /*!< Audiohook has shutdown and is not running on a channel any longer */
00047 };

enum ast_audiohook_type

Enumerator:

AST_AUDIOHOOK_TYPE_SPY	Audiohook wants to receive audio
AST_AUDIOHOOK_TYPE_WHISPER	Audiohook wants to provide audio to be mixed with existing audio
AST_AUDIOHOOK_TYPE_MANIPULATE	Audiohook wants to manipulate the audio

Definition at line 36 of file audiohook.h.

00036                         {
00037    AST_AUDIOHOOK_TYPE_SPY = 0,    /*!< Audiohook wants to receive audio */
00038    AST_AUDIOHOOK_TYPE_WHISPER,    /*!< Audiohook wants to provide audio to be mixed with existing audio */
00039    AST_AUDIOHOOK_TYPE_MANIPULATE, /*!< Audiohook wants to manipulate the audio */
00040 };

Function Documentation

int ast_audiohook_attach	(	struct ast_channel *	chan,
		struct ast_audiohook *	audiohook
	)

Attach audiohook to channel.

Parameters:

	chan	Channel
	audiohook	Audiohook structure

Returns:: Returns 0 on success, -1 on failure

Definition at line 330 of file audiohook.c.

References AST_AUDIOHOOK_STATUS_RUNNING, AST_AUDIOHOOK_TYPE_MANIPULATE, AST_AUDIOHOOK_TYPE_SPY, AST_AUDIOHOOK_TYPE_WHISPER, ast_audiohook_update_status(), ast_calloc, ast_channel_lock, ast_channel_unlock, AST_LIST_HEAD_INIT_NOLOCK, AST_LIST_INSERT_TAIL, ast_channel::audiohooks, and ast_audiohook::type.

Referenced by ast_audiohook_move_by_source(), audiohook_volume_get(), enable_jack_hook(), speex_write(), start_spying(), startmon(), and volume_write().

00332 00333 00334 00335 00336 00337 00338 00339       } 00340 00341 00342 00343    } 00344 00345 00346 00347 00348 00349 00350 00351 00352 00353 00354 00355 00356 00357 00358 00359 }

class="fragment">00331 { ast_channel_lock(chan); if (!chan->audiohooks) { /* Whoops... allocate a new structure */ if (!(chan->audiohooks = ast_calloc(1, sizeof(*chan->audiohooks)))) { ast_channel_unlock(chan); return -1; AST_LIST_HEAD_INIT_NOLOCK(&chan->audiohooks->spy_list); AST_LIST_HEAD_INIT_NOLOCK(&chan->audiohooks->whisper_list); AST_LIST_HEAD_INIT_NOLOCK(&chan->audiohooks->manipulate_list); /* Drop into respective list */ if (audiohook->type == AST_AUDIOHOOK_TYPE_SPY) AST_LIST_INSERT_TAIL(&chan->audiohooks->spy_list, audiohook, list); else if (audiohook->type == AST_AUDIOHOOK_TYPE_WHISPER) AST_LIST_INSERT_TAIL(&chan->audiohooks->whisper_list, audiohook, list); else if (audiohook->type == AST_AUDIOHOOK_TYPE_MANIPULATE) AST_LIST_INSERT_TAIL(&chan->audiohooks->manipulate_list, audiohook, list); /* Change status over to running since it is now attached */ ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_RUNNING); ast_channel_unlock(chan); return 0;

int ast_audiohook_destroy ( struct ast_audiohook * audiohook )

Destroys an audiohook structure.

Parameters:

audiohook

Audiohook structure

Returns:: Returns 0 on success, -1 on failure

Definition at line 91 of file audiohook.c.

References AST_AUDIOHOOK_TYPE_SPY, AST_AUDIOHOOK_TYPE_WHISPER, ast_cond_destroy(), ast_mutex_destroy(), ast_slinfactory_destroy(), ast_translator_free_path(), ast_audiohook::lock, ast_audiohook::read_factory, ast_audiohook::trans_pvt, ast_audiohook::trigger, ast_audiohook::type, and ast_audiohook::write_factory.

Referenced by audiohook_volume_destroy(), channel_spy(), destroy_callback(), destroy_jack_data(), destroy_monitor_audiohook(), and launch_monitor_thread().

00092 {
00093    /* Drop the factories used by this audiohook type */
00094    switch (audiohook->type) {
00095    case AST_AUDIOHOOK_TYPE_SPY:
00096       ast_slinfactory_destroy(&audiohook->read_factory);
00097    case AST_AUDIOHOOK_TYPE_WHISPER:
00098       ast_slinfactory_destroy(&audiohook->write_factory);
00099       break;
00100    default:
00101       break;
00102    }
00103 
00104    /* Destroy translation path if present */
00105    if (audiohook->trans_pvt)
00106       ast_translator_free_path(audiohook->trans_pvt);
00107 
00108    /* Lock and trigger be gone! */
00109    ast_cond_destroy(&audiohook->trigger);
00110    ast_mutex_destroy(&audiohook->lock);
00111 
00112    return 0;
00113 }

int ast_audiohook_detach ( struct ast_audiohook * audiohook )

Detach audiohook from channel.

Parameters:

audiohook

Audiohook structure

Returns:: Returns 0 on success, -1 on failure

Definition at line 379 of file audiohook.c.

References AST_AUDIOHOOK_STATUS_DONE, AST_AUDIOHOOK_STATUS_NEW, AST_AUDIOHOOK_STATUS_SHUTDOWN, ast_audiohook_trigger_wait(), ast_audiohook_update_status(), and ast_audiohook::status.

Referenced by channel_spy(), destroy_monitor_audiohook(), disable_jack_hook(), and speex_write().

00380 {
00381    if (audiohook->status == AST_AUDIOHOOK_STATUS_NEW || audiohook->status == AST_AUDIOHOOK_STATUS_DONE)
00382       return 0;
00383 
00384    ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_SHUTDOWN);
00385 
00386    while (audiohook->status != AST_AUDIOHOOK_STATUS_DONE)
00387       ast_audiohook_trigger_wait(audiohook);
00388 
00389    return 0;
00390 }

int ast_audiohook_detach_list ( struct ast_audiohook_list * audiohook_list )

Detach audiohooks from list and destroy said list.

Parameters:

audiohook_list

List of audiohooks

Returns:: Returns 0 on success, -1 on failure

Definition at line 396 of file audiohook.c.

References AST_AUDIOHOOK_STATUS_DONE, ast_audiohook_update_status(), ast_free, AST_LIST_REMOVE_HEAD, ast_translator_free_path(), ast_audiohook_list::in_translate, ast_audiohook::manipulate_callback, ast_audiohook_list::out_translate, and ast_audiohook_translate::trans_pvt.

Referenced by ast_hangup().

00397 {
00398    int i = 0;
00399    struct ast_audiohook *audiohook = NULL;
00400 
00401    /* Drop any spies */
00402    while ((audiohook = AST_LIST_REMOVE_HEAD(&audiohook_list->spy_list, list))) {
00403       ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
00404    }
00405 
00406    /* Drop any whispering sources */
00407    while ((audiohook = AST_LIST_REMOVE_HEAD(&audiohook_list->whisper_list, list))) {
00408       ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
00409    }
00410 
00411    /* Drop any manipulaters */
00412    while ((audiohook = AST_LIST_REMOVE_HEAD(&audiohook_list->manipulate_list, list))) {
00413       ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
00414       audiohook->manipulate_callback(audiohook, NULL, NULL, 0);
00415    }
00416 
00417    /* Drop translation paths if present */
00418    for (i = 0; i < 2; i++) {
00419       if (audiohook_list->in_translate[i].trans_pvt)
00420          ast_translator_free_path(audiohook_list->in_translate[i].trans_pvt);
00421       if (audiohook_list->out_translate[i].trans_pvt)
00422          ast_translator_free_path(audiohook_list->out_translate[i].trans_pvt);
00423    }
00424    
00425    /* Free ourselves */
00426    ast_free(audiohook_list);
00427 
00428    return 0;
00429 }

int ast_audiohook_detach_source	(	struct ast_channel *	chan,
		const char *	source
	)

Detach specified source audiohook from channel.

Parameters:

	chan	Channel to detach from
	source	Name of source to detach

Returns:: Returns 0 on success, -1 on failure

Note:: The channel does not need to be locked before calling this function.

Parameters:

	chan	Channel to detach from
	source	Name of source to detach

Returns:: Returns 0 on success, -1 on failure

Definition at line 482 of file audiohook.c.

References AST_AUDIOHOOK_STATUS_DONE, AST_AUDIOHOOK_STATUS_SHUTDOWN, ast_audiohook_update_status(), ast_channel_lock, ast_channel_unlock, ast_channel::audiohooks, find_audiohook_by_source(), and ast_audiohook::status.

Referenced by handle_cli_mixmonitor(), and stop_mixmonitor_exec().

00483 {
00484    struct ast_audiohook *audiohook = NULL;
00485 
00486    ast_channel_lock(chan);
00487 
00488    /* Ensure the channel has audiohooks on it */
00489    if (!chan->audiohooks) {
00490       ast_channel_unlock(chan);
00491       return -1;
00492    }
00493 
00494    audiohook = find_audiohook_by_source(chan->audiohooks, source);
00495 
00496    ast_channel_unlock(chan);
00497 
00498    if (audiohook && audiohook->status != AST_AUDIOHOOK_STATUS_DONE)
00499       ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_SHUTDOWN);
00500 
00501    return (audiohook ? 0 : -1);
00502 }

int ast_audiohook_init	(	struct ast_audiohook *	audiohook,
		enum ast_audiohook_type	type,
		const char *	source
	)

Initialize an audiohook structure.

Parameters:

	audiohook	Audiohook structure
	type	Type of audiohook to initialize this as
	source	Who is initializing this audiohook

Returns:: Returns 0 on success, -1 on failure

Parameters:

	audiohook	Audiohook structure
	type
	source

Returns:: Returns 0 on success, -1 on failure

Definition at line 60 of file audiohook.c.

References AST_AUDIOHOOK_STATUS_NEW, AST_AUDIOHOOK_TYPE_SPY, AST_AUDIOHOOK_TYPE_WHISPER, ast_audiohook_update_status(), ast_cond_init(), ast_mutex_init(), and ast_slinfactory_init().

Referenced by audiohook_volume_get(), channel_spy(), enable_jack_hook(), launch_monitor_thread(), speex_write(), and volume_write().

00061 {
00062    /* Need to keep the type and source */
00063    audiohook->type = type;
00064    audiohook->source = source;
00065 
00066    /* Initialize lock that protects our audiohook */
00067    ast_mutex_init(&audiohook->lock);
00068    ast_cond_init(&audiohook->trigger, NULL);
00069 
00070    /* Setup the factories that are needed for this audiohook type */
00071    switch (type) {
00072    case AST_AUDIOHOOK_TYPE_SPY:
00073       ast_slinfactory_init(&audiohook->read_factory);
00074    case AST_AUDIOHOOK_TYPE_WHISPER:
00075       ast_slinfactory_init(&audiohook->write_factory);
00076       break;
00077    default:
00078       break;
00079    }
00080 
00081    /* Since we are just starting out... this audiohook is new */
00082    ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_NEW);
00083 
00084    return 0;
00085 }

void ast_audiohook_move_by_source	(	struct ast_channel *	old_chan,
		struct ast_channel *	new_chan,
		const char *	source
	)

Move an audiohook from one channel to a new one.

Todo:: Currently only the first audiohook of a specific source found will be moved. We should add the capability to move multiple audiohooks from a single source as well.

Note:: It is required that both old_chan and new_chan are locked prior to calling this function. Besides needing to protect the data within the channels, not locking these channels can lead to a potential deadlock

Parameters:

	old_chan	The source of the audiohook to move
	new_chan	The destination to which we want the audiohook to move
	source	The source of the audiohook we want to move

Definition at line 458 of file audiohook.c.

References ast_audiohook_attach(), ast_audiohook_lock, ast_audiohook_remove(), ast_audiohook_unlock, ast_channel::audiohooks, and find_audiohook_by_source().

Referenced by audiohook_inheritance_fixup().

00459 {
00460    struct ast_audiohook *audiohook;
00461 
00462    if (!old_chan->audiohooks || !(audiohook = find_audiohook_by_source(old_chan->audiohooks, source))) {
00463       return;
00464    }
00465 
00466    /* By locking both channels and the audiohook, we can assure that
00467     * another thread will not have a chance to read the audiohook's status
00468     * as done, even though ast_audiohook_remove signals the trigger
00469     * condition
00470     */
00471    ast_audiohook_lock(audiohook);
00472    ast_audiohook_remove(old_chan, audiohook);
00473    ast_audiohook_attach(new_chan, audiohook);
00474    ast_audiohook_unlock(audiohook);
00475 }

struct ast_frame* ast_audiohook_read_frame	(	struct ast_audiohook *	audiohook,
		size_t	samples,
		enum ast_audiohook_direction	direction,
		int	format
	)			`[read]`

Reads a frame in from the audiohook structure.

Parameters:

	audiohook	Audiohook structure
	samples	Number of samples wanted
	direction	Direction the audio frame came from
	format	Format of frame remote side wants back

Returns:: Returns frame on success, NULL on failure

Definition at line 295 of file audiohook.c.

References AST_AUDIOHOOK_DIRECTION_BOTH, AST_FORMAT_SLINEAR, ast_frfree, ast_translate(), ast_translator_build_path(), ast_translator_free_path(), audiohook_read_frame_both(), audiohook_read_frame_single(), ast_audiohook::format, read_frame(), and ast_audiohook::trans_pvt.

Referenced by mixmonitor_thread(), and spy_generate().

00296 {
00297    struct ast_frame *read_frame = NULL, *final_frame = NULL;
00298 
00299    if (!(read_frame = (direction == AST_AUDIOHOOK_DIRECTION_BOTH ? audiohook_read_frame_both(audiohook, samples) : audiohook_read_frame_single(audiohook, samples, direction))))
00300       return NULL;
00301 
00302    /* If they don't want signed linear back out, we'll have to send it through the translation path */
00303    if (format != AST_FORMAT_SLINEAR) {
00304       /* Rebuild translation path if different format then previously */
00305       if (audiohook->format != format) {
00306          if (audiohook->trans_pvt) {
00307             ast_translator_free_path(audiohook->trans_pvt);
00308             audiohook->trans_pvt = NULL;
00309          }
00310          /* Setup new translation path for this format... if we fail we can't very well return signed linear so free the frame and return nothing */
00311          if (!(audiohook->trans_pvt = ast_translator_build_path(format, AST_FORMAT_SLINEAR))) {
00312             ast_frfree(read_frame);
00313             return NULL;
00314          }
00315       }
00316       /* Convert to requested format, and allow the read in frame to be freed */
00317       final_frame = ast_translate(audiohook->trans_pvt, read_frame, 1);
00318    } else {
00319       final_frame = read_frame;
00320    }
00321 
00322    return final_frame;
00323 }

int ast_audiohook_remove	(	struct ast_channel *	chan,
		struct ast_audiohook *	audiohook
	)

Remove an audiohook from a specified channel.

Parameters:

	chan	Channel to remove from
	audiohook	Audiohook to remove

Returns:: Returns 0 on success, -1 on failure

Note:: The channel does not need to be locked before calling this function

Definition at line 514 of file audiohook.c.

References AST_AUDIOHOOK_STATUS_DONE, AST_AUDIOHOOK_TYPE_MANIPULATE, AST_AUDIOHOOK_TYPE_SPY, AST_AUDIOHOOK_TYPE_WHISPER, ast_audiohook_update_status(), ast_channel_lock, ast_channel_unlock, AST_LIST_REMOVE, ast_channel::audiohooks, and ast_audiohook::type.

Referenced by ast_audiohook_move_by_source(), and speex_write().

00515 {
00516    ast_channel_lock(chan);
00517 
00518    if (!chan->audiohooks) {
00519       ast_channel_unlock(chan);
00520       return -1;
00521    }
00522 
00523    if (audiohook->type == AST_AUDIOHOOK_TYPE_SPY)
00524       AST_LIST_REMOVE(&chan->audiohooks->spy_list, audiohook, list);
00525    else if (audiohook->type == AST_AUDIOHOOK_TYPE_WHISPER)
00526       AST_LIST_REMOVE(&chan->audiohooks->whisper_list, audiohook, list);
00527    else if (audiohook->type == AST_AUDIOHOOK_TYPE_MANIPULATE)
00528       AST_LIST_REMOVE(&chan->audiohooks->manipulate_list, audiohook, list);
00529 
00530    ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
00531 
00532    ast_channel_unlock(chan);
00533 
00534    return 0;
00535 }

void ast_audiohook_trigger_wait ( struct ast_audiohook * audiohook )

Wait for audiohook trigger to be triggered.

Parameters:

audiohook

Audiohook to wait on

Definition at line 716 of file audiohook.c.

References ast_cond_timedwait(), ast_samp2tv(), ast_tvadd(), ast_tvnow(), ast_audiohook::lock, and ast_audiohook::trigger.

Referenced by ast_audiohook_detach(), and mixmonitor_thread().

00717 {
00718    struct timeval wait;
00719    struct timespec ts;
00720 
00721    wait = ast_tvadd(ast_tvnow(), ast_samp2tv(50000, 1000));
00722    ts.tv_sec = wait.tv_sec;
00723    ts.tv_nsec = wait.tv_usec * 1000;
00724    
00725    ast_cond_timedwait(&audiohook->trigger, &audiohook->lock, &ts);
00726    
00727    return;
00728 }

void ast_audiohook_update_status	(	struct ast_audiohook *	audiohook,
		enum ast_audiohook_status	status
	)

Update audiohook's status.

Parameters:

	audiohook	Audiohook structure
	audiohook	status enum
	audiohook	status enum
	audiohook	Audiohook structure

Definition at line 365 of file audiohook.c.

References ast_audiohook_lock, AST_AUDIOHOOK_STATUS_DONE, ast_audiohook_unlock, ast_cond_signal(), ast_audiohook::status, and ast_audiohook::trigger.

Referenced by ast_audiohook_attach(), ast_audiohook_detach(), ast_audiohook_detach_list(), ast_audiohook_detach_source(), ast_audiohook_init(), ast_audiohook_remove(), audio_audiohook_write_list(), and dtmf_audiohook_write_list().

00366 {
00367    ast_audiohook_lock(audiohook);
00368    if (audiohook->status != AST_AUDIOHOOK_STATUS_DONE) {
00369       audiohook->status = status;
00370       ast_cond_signal(&audiohook->trigger);
00371    }
00372    ast_audiohook_unlock(audiohook);
00373 }

int ast_audiohook_volume_adjust	(	struct ast_channel *	chan,
		enum ast_audiohook_direction	direction,
		int	volume
	)

Adjust the volume on frames read from or written to a channel.

Parameters:

	chan	Channel to muck with
	direction	Direction to increase
	volume	Value to adjust the adjustment by

Returns:: Returns 0 on success, -1 on failure

Since:: 1.6.1

Parameters:

	chan	Channel to muck with
	direction	Direction to increase
	volume	Value to adjust the adjustment by

Returns:: Returns 0 on success, -1 on failure

Definition at line 976 of file audiohook.c.

References AST_AUDIOHOOK_DIRECTION_BOTH, AST_AUDIOHOOK_DIRECTION_READ, AST_AUDIOHOOK_DIRECTION_WRITE, audiohook_volume_get(), audiohook_volume::read_adjustment, and audiohook_volume::write_adjustment.

00977 {
00978    struct audiohook_volume *audiohook_volume = NULL;
00979 
00980    /* Attempt to find the audiohook volume information, and create an audiohook if none exists */
00981    if (!(audiohook_volume = audiohook_volume_get(chan, 1))) {
00982       return -1;
00983    }
00984 
00985    /* Based on the direction change the specific adjustment value */
00986    if (direction == AST_AUDIOHOOK_DIRECTION_READ || direction == AST_AUDIOHOOK_DIRECTION_BOTH) {
00987       audiohook_volume->read_adjustment += volume;
00988    }
00989    if (direction == AST_AUDIOHOOK_DIRECTION_WRITE || direction == AST_AUDIOHOOK_DIRECTION_BOTH) {
00990       audiohook_volume->write_adjustment += volume;
00991    }
00992 
00993    return 0;
00994 }

int ast_audiohook_volume_get	(	struct ast_channel *	chan,
		enum ast_audiohook_direction	direction
	)

Retrieve the volume adjustment value on frames read from or written to a channel.

Parameters:

	chan	Channel to retrieve volume adjustment from
	direction	Direction to retrieve

Returns:: Returns adjustment value

Since:: 1.6.1

Parameters:

	chan	Channel to retrieve volume adjustment from
	direction	Direction to retrieve

Returns:: Returns adjustment value

Definition at line 950 of file audiohook.c.

References AST_AUDIOHOOK_DIRECTION_READ, AST_AUDIOHOOK_DIRECTION_WRITE, audiohook_volume_get(), audiohook_volume::read_adjustment, and audiohook_volume::write_adjustment.

00951 {
00952    struct audiohook_volume *audiohook_volume = NULL;
00953    int adjustment = 0;
00954 
00955    /* Attempt to find the audiohook volume information, but do not create it as we only want to look at the values */
00956    if (!(audiohook_volume = audiohook_volume_get(chan, 0))) {
00957       return 0;
00958    }
00959 
00960    /* Grab the adjustment value based on direction given */
00961    if (direction == AST_AUDIOHOOK_DIRECTION_READ) {
00962       adjustment = audiohook_volume->read_adjustment;
00963    } else if (direction == AST_AUDIOHOOK_DIRECTION_WRITE) {
00964       adjustment = audiohook_volume->write_adjustment;
00965    }
00966 
00967    return adjustment;
00968 }

int ast_audiohook_volume_set	(	struct ast_channel *	chan,
		enum ast_audiohook_direction	direction,
		int	volume
	)

Adjust the volume on frames read from or written to a channel.

Parameters:

	chan	Channel to muck with
	direction	Direction to set on
	volume	Value to adjust the volume by

Returns:: Returns 0 on success, -1 on failure

Since:: 1.6.1

Parameters:

	chan	Channel to muck with
	direction	Direction to set on
	volume	Value to adjust the volume by

Returns:: Returns 0 on success, -1 on failure

Definition at line 925 of file audiohook.c.

References AST_AUDIOHOOK_DIRECTION_BOTH, AST_AUDIOHOOK_DIRECTION_READ, AST_AUDIOHOOK_DIRECTION_WRITE, audiohook_volume_get(), audiohook_volume::read_adjustment, and audiohook_volume::write_adjustment.

00926 {
00927    struct audiohook_volume *audiohook_volume = NULL;
00928 
00929    /* Attempt to find the audiohook volume information, but only create it if we are not setting the adjustment value to zero */
00930    if (!(audiohook_volume = audiohook_volume_get(chan, (volume ? 1 : 0)))) {
00931       return -1;
00932    }
00933 
00934    /* Now based on the direction set the proper value */
00935    if (direction == AST_AUDIOHOOK_DIRECTION_READ || direction == AST_AUDIOHOOK_DIRECTION_BOTH) {
00936       audiohook_volume->read_adjustment = volume;
00937    }
00938    if (direction == AST_AUDIOHOOK_DIRECTION_WRITE || direction == AST_AUDIOHOOK_DIRECTION_BOTH) {
00939       audiohook_volume->write_adjustment = volume;
00940    }
00941 
00942    return 0;
00943 }

int ast_audiohook_write_frame	(	struct ast_audiohook *	audiohook,
		enum ast_audiohook_direction	direction,
		struct ast_frame *	frame
	)

Writes a frame into the audiohook structure.

Parameters:

	audiohook	Audiohook structure
	direction	Direction the audio frame came from
	frame	Frame to write in

Returns:: Returns 0 on success, -1 on failure

Definition at line 121 of file audiohook.c.

References AST_AUDIOHOOK_DIRECTION_READ, AST_AUDIOHOOK_DIRECTION_WRITE, AST_AUDIOHOOK_SMALL_QUEUE, AST_AUDIOHOOK_SYNC_TOLERANCE, AST_AUDIOHOOK_TRIGGER_MODE, AST_AUDIOHOOK_TRIGGER_READ, AST_AUDIOHOOK_TRIGGER_SYNC, AST_AUDIOHOOK_TRIGGER_WRITE, ast_cond_signal(), ast_log(), ast_slinfactory_available(), ast_slinfactory_feed(), ast_slinfactory_flush(), ast_test_flag, ast_tvdiff_ms(), ast_tvnow(), LOG_DEBUG, option_debug, ast_audiohook::read_factory, ast_audiohook::read_time, ast_audiohook::trigger, ast_audiohook::write_factory, and ast_audiohook::write_time.

Referenced by audio_audiohook_write_list(), and channel_spy().

00122 {
00123    struct ast_slinfactory *factory = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->read_factory : &audiohook->write_factory);
00124    struct ast_slinfactory *other_factory = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->write_factory : &audiohook->read_factory);
00125    struct timeval *rwtime = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->read_time : &audiohook->write_time), previous_time = *rwtime;
00126    int our_factory_samples;
00127    int our_factory_ms;
00128    int other_factory_samples;
00129    int other_factory_ms;
00130 
00131    /* Update last feeding time to be current */
00132    *rwtime = ast_tvnow();
00133 
00134    our_factory_samples = ast_slinfactory_available(factory);
00135    our_factory_ms = ast_tvdiff_ms(*rwtime, previous_time) + (our_factory_samples / 8);
00136    other_factory_samples = ast_slinfactory_available(other_factory);
00137    other_factory_ms = other_factory_samples / 8;
00138 
00139    if (ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_SYNC) && other_factory_samples && (our_factory_ms - other_factory_ms > AST_AUDIOHOOK_SYNC_TOLERANCE)) {
00140       if (option_debug)
00141          ast_log(LOG_DEBUG, "Flushing audiohook %p so it remains in sync\n", audiohook);
00142       ast_slinfactory_flush(factory);
00143       ast_slinfactory_flush(other_factory);
00144    }
00145 
00146    if (ast_test_flag(audiohook, AST_AUDIOHOOK_SMALL_QUEUE) && (our_factory_samples > 640 || other_factory_samples > 640)) {
00147       if (option_debug) {
00148          ast_log(LOG_DEBUG, "Audiohook %p has stale audio in its factories. Flushing them both\n", audiohook);
00149       }
00150       ast_slinfactory_flush(factory);
00151       ast_slinfactory_flush(other_factory);
00152    }
00153 
00154    /* Write frame out to respective factory */
00155    ast_slinfactory_feed(factory, frame);
00156 
00157    /* If we need to notify the respective handler of this audiohook, do so */
00158    if ((ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_MODE) == AST_AUDIOHOOK_TRIGGER_READ) && (direction == AST_AUDIOHOOK_DIRECTION_READ)) {
00159       ast_cond_signal(&audiohook->trigger);
00160    } else if ((ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_MODE) == AST_AUDIOHOOK_TRIGGER_WRITE) && (direction == AST_AUDIOHOOK_DIRECTION_WRITE)) {
00161       ast_cond_signal(&audiohook->trigger);
00162    } else if (ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_SYNC)) {
00163       ast_cond_signal(&audiohook->trigger);
00164    }
00165 
00166    return 0;
00167 }

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
	)			`[read]`

Pass a frame off to be handled by the audiohook core.

Parameters:

	chan	Channel that the list is coming off of
	audiohook_list	List of audiohooks
	direction	Direction frame is coming in from
	frame	The frame itself

Returns:: Return frame on success, NULL on failure

Definition at line 701 of file audiohook.c.

References AST_FRAME_DTMF, AST_FRAME_VOICE, audio_audiohook_write_list(), dtmf_audiohook_write_list(), and ast_frame::frametype.

Referenced by __ast_read(), and ast_write().

00702 {
00703    /* Pass off frame to it's respective list write function */
00704    if (frame->frametype == AST_FRAME_VOICE)
00705       return audio_audiohook_write_list(chan, audiohook_list, direction, frame);
00706    else if (frame->frametype == AST_FRAME_DTMF)
00707       return dtmf_audiohook_write_list(chan, audiohook_list, direction, frame);
00708    else
00709       return frame;
00710 }

int ast_channel_audiohook_count_by_source	(	struct ast_channel *	chan,
		const char *	source,
		enum ast_audiohook_type	type
	)

Find out how many audiohooks from a certain source exist on a given channel, regardless of status.

Parameters:

	chan	The channel on which to find the spies
	source	The audiohook's source
	type	The type of audiohook

Returns:: Return the number of audiohooks which are from the source specified

Note: Function performs nlocking.

Definition at line 731 of file audiohook.c.

References AST_AUDIOHOOK_TYPE_MANIPULATE, AST_AUDIOHOOK_TYPE_SPY, AST_AUDIOHOOK_TYPE_WHISPER, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_log(), ast_channel::audiohooks, LOG_DEBUG, and ast_audiohook::source.

Referenced by builtin_automixmonitor().

00732 {
00733    int count = 0;
00734    struct ast_audiohook *ah = NULL;
00735 
00736    if (!chan->audiohooks)
00737       return -1;
00738 
00739    switch (type) {
00740       case AST_AUDIOHOOK_TYPE_SPY:
00741          AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->audiohooks->spy_list, ah, list) {
00742             if (!strcmp(ah->source, source)) {
00743                count++;
00744             }
00745          }
00746          AST_LIST_TRAVERSE_SAFE_END;
00747          break;
00748       case AST_AUDIOHOOK_TYPE_WHISPER:
00749          AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->audiohooks->whisper_list, ah, list) {
00750             if (!strcmp(ah->source, source)) {
00751                count++;
00752             }
00753          }
00754          AST_LIST_TRAVERSE_SAFE_END;
00755          break;
00756       case AST_AUDIOHOOK_TYPE_MANIPULATE:
00757          AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->audiohooks->manipulate_list, ah, list) {
00758             if (!strcmp(ah->source, source)) {
00759                count++;
00760             }
00761          }
00762          AST_LIST_TRAVERSE_SAFE_END;
00763          break;
00764       default:
00765          ast_log(LOG_DEBUG, "Invalid audiohook type supplied, (%d)\n", type);
00766          return -1;
00767    }
00768 
00769    return count;
00770 }

int ast_channel_audiohook_count_by_source_running	(	struct ast_channel *	chan,
		const char *	source,
		enum ast_audiohook_type	type
	)

Find out how many spies of a certain type exist on a given channel, and are in state running.

Parameters:

	chan	The channel on which to find the spies
	source	The source of the audiohook
	type	The type of spy to look for

Returns:: Return the number of running audiohooks which are from the source specified

Note: Function performs no locking.

Definition at line 773 of file audiohook.c.

References AST_AUDIOHOOK_STATUS_RUNNING, AST_AUDIOHOOK_TYPE_MANIPULATE, AST_AUDIOHOOK_TYPE_SPY, AST_AUDIOHOOK_TYPE_WHISPER, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_log(), ast_channel::audiohooks, LOG_DEBUG, ast_audiohook::source, and ast_audiohook::status.

Referenced by builtin_automixmonitor().

00774 {
00775    int count = 0;
00776    struct ast_audiohook *ah = NULL;
00777    if (!chan->audiohooks)
00778       return -1;
00779 
00780    switch (type) {
00781       case AST_AUDIOHOOK_TYPE_SPY:
00782          AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->audiohooks->spy_list, ah, list) {
00783             if ((!strcmp(ah->source, source)) && (ah->status == AST_AUDIOHOOK_STATUS_RUNNING))
00784                count++;
00785          }
00786          AST_LIST_TRAVERSE_SAFE_END;
00787          break;
00788       case AST_AUDIOHOOK_TYPE_WHISPER:
00789          AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->audiohooks->whisper_list, ah, list) {
00790             if ((!strcmp(ah->source, source)) && (ah->status == AST_AUDIOHOOK_STATUS_RUNNING))
00791                count++;
00792          }
00793          AST_LIST_TRAVERSE_SAFE_END;
00794          break;
00795       case AST_AUDIOHOOK_TYPE_MANIPULATE:
00796          AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->audiohooks->manipulate_list, ah, list) {
00797             if ((!strcmp(ah->source, source)) && (ah->status == AST_AUDIOHOOK_STATUS_RUNNING))
00798                count++;
00799          }
00800          AST_LIST_TRAVERSE_SAFE_END;
00801          break;
00802       default:
00803          ast_log(LOG_DEBUG, "Invalid audiohook type supplied, (%d)\n", type);
00804          return -1;
00805    }
00806    return count;
00807 }

Asterisk developer's documentation

audiohook.h File Reference

Data Structures

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation