Thu May 14 15:13:15 2009

Asterisk developer's documentation


audiohook.h File Reference

Audiohooks Architecture. More...

#include "asterisk/slinfactory.h"

Go to the source code of 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)
}
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.
ast_frameast_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.
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.
ast_frameast_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.


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 200 of file audiohook.h.

Referenced by ast_audiohook_detach_list(), ast_audiohook_move_by_source(), ast_audiohook_remove(), audio_audiohook_write_list(), channel_spy(), dtmf_audiohook_write_list(), mixmonitor_thread(), and spy_generate().

#define AST_AUDIOHOOK_SYNC_TOLERANCE   100

Definition at line 59 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 205 of file audiohook.h.

Referenced by ast_audiohook_detach_list(), ast_audiohook_move_by_source(), ast_audiohook_remove(), audio_audiohook_write_list(), channel_spy(), dtmf_audiohook_write_list(), mixmonitor_thread(), and spy_generate().


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 72 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 45 of file audiohook.h.

00045                              {
00046    AST_AUDIOHOOK_DIRECTION_READ = 0, /*!< Reading audio in */
00047    AST_AUDIOHOOK_DIRECTION_WRITE,    /*!< Writing audio out */
00048    AST_AUDIOHOOK_DIRECTION_BOTH,     /*!< Both reading audio in and writing audio out */
00049 };

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

Definition at line 51 of file audiohook.h.

00051                          {
00052    AST_AUDIOHOOK_TRIGGER_MODE = (3 << 0),  /*!< When audiohook should be triggered to do something */
00053    AST_AUDIOHOOK_TRIGGER_READ = (1 << 0),  /*!< Audiohook wants to be triggered when reading audio in */
00054    AST_AUDIOHOOK_TRIGGER_WRITE = (2 << 0), /*!< Audiohook wants to be triggered when writing audio out */
00055    AST_AUDIOHOOK_WANTS_DTMF = (1 << 1),    /*!< Audiohook also wants to receive DTMF frames */
00056    AST_AUDIOHOOK_TRIGGER_SYNC = (1 << 2),  /*!< Audiohook wants to be triggered when both sides have combined audio available */
00057 };

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 38 of file audiohook.h.

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

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 32 of file audiohook.h.

00032                         {
00033    AST_AUDIOHOOK_TYPE_SPY = 0,    /*!< Audiohook wants to receive audio */
00034    AST_AUDIOHOOK_TYPE_WHISPER,    /*!< Audiohook wants to provide audio to be mixed with existing audio */
00035    AST_AUDIOHOOK_TYPE_MANIPULATE, /*!< Audiohook wants to manipulate the audio */
00036 };


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 331 of file audiohook.c.

References AST_AUDIOHOOK_STATUS_RUNNING, AST_AUDIOHOOK_TYPE_MANIPULATE, AST_AUDIOHOOK_TYPE_SPY, AST_AUDIOHOOK_TYPE_WHISPER, ast_calloc, ast_channel_lock, ast_channel_unlock, AST_LIST_HEAD_INIT_NOLOCK, AST_LIST_INSERT_TAIL, ast_channel::audiohooks, ast_audiohook_list::manipulate_list, ast_audiohook_list::spy_list, ast_audiohook::status, ast_audiohook::type, and ast_audiohook_list::whisper_list.

Referenced by ast_audiohook_move_by_source(), start_spying(), and startmon().

00332 {
00333    ast_channel_lock(chan);
00334 
00335    if (!chan->audiohooks) {
00336       /* Whoops... allocate a new structure */
00337       if (!(chan->audiohooks = ast_calloc(1, sizeof(*chan->audiohooks)))) {
00338          ast_channel_unlock(chan);
00339          return -1;
00340       }
00341       AST_LIST_HEAD_INIT_NOLOCK(&chan->audiohooks->spy_list);
00342       AST_LIST_HEAD_INIT_NOLOCK(&chan->audiohooks->whisper_list);
00343       AST_LIST_HEAD_INIT_NOLOCK(&chan->audiohooks->manipulate_list);
00344    }
00345 
00346    /* Drop into respective list */
00347    if (audiohook->type == AST_AUDIOHOOK_TYPE_SPY)
00348       AST_LIST_INSERT_TAIL(&chan->audiohooks->spy_list, audiohook, list);
00349    else if (audiohook->type == AST_AUDIOHOOK_TYPE_WHISPER)
00350       AST_LIST_INSERT_TAIL(&chan->audiohooks->whisper_list, audiohook, list);
00351    else if (audiohook->type == AST_AUDIOHOOK_TYPE_MANIPULATE)
00352       AST_LIST_INSERT_TAIL(&chan->audiohooks->manipulate_list, audiohook, list);
00353 
00354    /* Change status over to running since it is now attached */
00355    audiohook->status = AST_AUDIOHOOK_STATUS_RUNNING;
00356 
00357    ast_channel_unlock(chan);
00358 
00359    return 0;
00360 }

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 98 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 channel_spy(), launch_monitor_thread(), and mixmonitor_thread().

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

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 366 of file audiohook.c.

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

Referenced by channel_spy(), and mixmonitor_thread().

00367 {
00368    if (audiohook->status == AST_AUDIOHOOK_STATUS_DONE)
00369       return 0;
00370 
00371    audiohook->status = AST_AUDIOHOOK_STATUS_SHUTDOWN;
00372 
00373    while (audiohook->status != AST_AUDIOHOOK_STATUS_DONE)
00374       ast_audiohook_trigger_wait(audiohook);
00375 
00376    return 0;
00377 }

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 383 of file audiohook.c.

References ast_audiohook_lock, AST_AUDIOHOOK_STATUS_DONE, ast_audiohook_unlock, ast_cond_signal(), ast_free, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_translator_free_path(), ast_audiohook_list::in_translate, ast_audiohook::manipulate_callback, ast_audiohook_list::manipulate_list, ast_audiohook_list::out_translate, ast_audiohook_list::spy_list, ast_audiohook::status, ast_audiohook_translate::trans_pvt, ast_audiohook::trigger, and ast_audiohook_list::whisper_list.

Referenced by ast_hangup().

00384 {
00385    int i = 0;
00386    struct ast_audiohook *audiohook = NULL;
00387 
00388    /* Drop any spies */
00389    AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->spy_list, audiohook, list) {
00390       ast_audiohook_lock(audiohook);
00391       AST_LIST_REMOVE_CURRENT(&audiohook_list->spy_list, list);
00392       audiohook->status = AST_AUDIOHOOK_STATUS_DONE;
00393       ast_cond_signal(&audiohook->trigger);
00394       ast_audiohook_unlock(audiohook);
00395    }
00396    AST_LIST_TRAVERSE_SAFE_END
00397 
00398    /* Drop any whispering sources */
00399    AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->whisper_list, audiohook, list) {
00400       ast_audiohook_lock(audiohook);
00401       AST_LIST_REMOVE_CURRENT(&audiohook_list->whisper_list, list);
00402       audiohook->status = AST_AUDIOHOOK_STATUS_DONE;
00403       ast_cond_signal(&audiohook->trigger);
00404       ast_audiohook_unlock(audiohook);
00405    }
00406    AST_LIST_TRAVERSE_SAFE_END
00407 
00408    /* Drop any manipulaters */
00409    AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->manipulate_list, audiohook, list) {
00410       ast_audiohook_lock(audiohook);
00411       AST_LIST_REMOVE_CURRENT(&audiohook_list->manipulate_list, list);
00412       audiohook->status = AST_AUDIOHOOK_STATUS_DONE;
00413       ast_audiohook_unlock(audiohook);
00414       audiohook->manipulate_callback(audiohook, NULL, NULL, 0);
00415    }
00416    AST_LIST_TRAVERSE_SAFE_END
00417 
00418    /* Drop translation paths if present */
00419    for (i = 0; i < 2; i++) {
00420       if (audiohook_list->in_translate[i].trans_pvt)
00421          ast_translator_free_path(audiohook_list->in_translate[i].trans_pvt);
00422       if (audiohook_list->out_translate[i].trans_pvt)
00423          ast_translator_free_path(audiohook_list->out_translate[i].trans_pvt);
00424    }
00425    
00426    /* Free ourselves */
00427    ast_free(audiohook_list);
00428 
00429    return 0;
00430 }

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

Definition at line 478 of file audiohook.c.

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

Referenced by mixmonitor_cli(), and stop_mixmonitor_exec().

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

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 
source 
Returns:
Returns 0 on success, -1 on failure

Definition at line 67 of file audiohook.c.

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

Referenced by channel_spy(), and launch_monitor_thread().

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

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 454 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().

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

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.

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 296 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(), and audiohook_read_frame_single().

Referenced by mixmonitor_thread(), and spy_generate().

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

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 510 of file audiohook.c.

References ast_audiohook_lock, AST_AUDIOHOOK_STATUS_DONE, AST_AUDIOHOOK_TYPE_MANIPULATE, AST_AUDIOHOOK_TYPE_SPY, AST_AUDIOHOOK_TYPE_WHISPER, ast_audiohook_unlock, ast_channel_lock, ast_channel_unlock, ast_cond_signal(), AST_LIST_REMOVE, ast_channel::audiohooks, ast_audiohook_list::manipulate_list, ast_audiohook_list::spy_list, ast_audiohook::status, ast_audiohook::trigger, ast_audiohook::type, and ast_audiohook_list::whisper_list.

Referenced by ast_audiohook_move_by_source().

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

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 709 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().

00710 {
00711    struct timeval tv;
00712    struct timespec ts;
00713 
00714    tv = ast_tvadd(ast_tvnow(), ast_samp2tv(50000, 1000));
00715    ts.tv_sec = tv.tv_sec;
00716    ts.tv_nsec = tv.tv_usec * 1000;
00717    
00718    ast_cond_timedwait(&audiohook->trigger, &audiohook->lock, &ts);
00719    
00720    return;
00721 }

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 128 of file audiohook.c.

References AST_AUDIOHOOK_DIRECTION_READ, AST_AUDIOHOOK_DIRECTION_WRITE, 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().

00129 {
00130    struct ast_slinfactory *factory = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->read_factory : &audiohook->write_factory);
00131    struct ast_slinfactory *other_factory = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->write_factory : &audiohook->read_factory);
00132    struct timeval *time = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->read_time : &audiohook->write_time), previous_time = *time;
00133    int our_factory_ms;
00134    int other_factory_samples;
00135    int other_factory_ms;
00136 
00137    /* Update last feeding time to be current */
00138    *time = ast_tvnow();
00139 
00140    our_factory_ms = ast_tvdiff_ms(*time, previous_time) + (ast_slinfactory_available(factory) / 8);
00141    other_factory_samples = ast_slinfactory_available(other_factory);
00142    other_factory_ms = other_factory_samples / 8;
00143 
00144    /* If we are using a sync trigger and this factory suddenly got audio fed in after a lapse, then flush both factories to ensure they remain in sync */
00145    if (ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_SYNC) && other_factory_samples && (our_factory_ms - other_factory_ms > AST_AUDIOHOOK_SYNC_TOLERANCE)) {
00146       if (option_debug)
00147          ast_log(LOG_DEBUG, "Flushing audiohook %p so it remains in sync\n", audiohook);
00148       ast_slinfactory_flush(factory);
00149       ast_slinfactory_flush(other_factory);
00150    }
00151 
00152    /* Write frame out to respective factory */
00153    ast_slinfactory_feed(factory, frame);
00154 
00155    /* If we need to notify the respective handler of this audiohook, do so */
00156    if ((ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_MODE) == AST_AUDIOHOOK_TRIGGER_READ) && (direction == AST_AUDIOHOOK_DIRECTION_READ)) {
00157       ast_cond_signal(&audiohook->trigger);
00158    } else if ((ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_MODE) == AST_AUDIOHOOK_TRIGGER_WRITE) && (direction == AST_AUDIOHOOK_DIRECTION_WRITE)) {
00159       ast_cond_signal(&audiohook->trigger);
00160    } else if (ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_SYNC)) {
00161       ast_cond_signal(&audiohook->trigger);
00162    }
00163 
00164    return 0;
00165 }

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.

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 694 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().

00695 {
00696    /* Pass off frame to it's respective list write function */
00697    if (frame->frametype == AST_FRAME_VOICE)
00698       return audio_audiohook_write_list(chan, audiohook_list, direction, frame);
00699    else if (frame->frametype == AST_FRAME_DTMF)
00700       return dtmf_audiohook_write_list(chan, audiohook_list, direction, frame);
00701    else
00702       return frame;
00703 }


Generated on Thu May 14 15:13:15 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7