main/audiohook.c

   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  *
  21  * \brief Audiohooks Architecture
  22  *
  23  * \author Joshua Colp <jcolp@digium.com>
  24  */
  25
  26 /*** MODULEINFO
  27         <support_level>core</support_level>
  28  ***/
  29
  30 #include "asterisk.h"
  31
  32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  33
  34 #include <signal.h>
  35
  36 #include "asterisk/channel.h"
  37 #include "asterisk/utils.h"
  38 #include "asterisk/lock.h"
  39 #include "asterisk/linkedlists.h"
  40 #include "asterisk/audiohook.h"
  41 #include "asterisk/slinfactory.h"
  42 #include "asterisk/frame.h"
  43 #include "asterisk/translate.h"
  44 #include "asterisk/format_cache.h"
  45
  46 #define AST_AUDIOHOOK_SYNC_TOLERANCE 100 /*!< Tolerance in milliseconds for audiohooks synchronization */
  47 #define AST_AUDIOHOOK_SMALL_QUEUE_TOLERANCE 100 /*!< When small queue is enabled, this is the maximum amount of audio that can remain queued at a time. */
  48
  49 struct ast_audiohook_translate {
  50         struct ast_trans_pvt *trans_pvt;
  51         struct ast_format *format;
  52 };
  53
  54 struct ast_audiohook_list {
  55         /* If all the audiohooks in this list are capable
  56          * of processing slinear at any sample rate, this
  57          * variable will be set and the sample rate will
  58          * be preserved during ast_audiohook_write_list()*/
  59         int native_slin_compatible;
  60         int list_internal_samp_rate;/*!< Internal sample rate used when writing to the audiohook list */
  61
  62         struct ast_audiohook_translate in_translate[2];
  63         struct ast_audiohook_translate out_translate[2];
  64         AST_LIST_HEAD_NOLOCK(, ast_audiohook) spy_list;
  65         AST_LIST_HEAD_NOLOCK(, ast_audiohook) whisper_list;
  66         AST_LIST_HEAD_NOLOCK(, ast_audiohook) manipulate_list;
  67 };
  68
  69 static int audiohook_set_internal_rate(struct ast_audiohook *audiohook, int rate, int reset)
  70 {
  71         struct ast_format *slin;
  72
  73         if (audiohook->hook_internal_samp_rate == rate) {
  74                 return 0;
  75         }
  76
  77         audiohook->hook_internal_samp_rate = rate;
  78
  79         slin = ast_format_cache_get_slin_by_rate(rate);
  80
  81         /* Setup the factories that are needed for this audiohook type */
  82         switch (audiohook->type) {
  83         case AST_AUDIOHOOK_TYPE_SPY:
  84         case AST_AUDIOHOOK_TYPE_WHISPER:
  85                 if (reset) {
  86                         ast_slinfactory_destroy(&audiohook->read_factory);
  87                         ast_slinfactory_destroy(&audiohook->write_factory);
  88                 }
  89                 ast_slinfactory_init_with_format(&audiohook->read_factory, slin);
  90                 ast_slinfactory_init_with_format(&audiohook->write_factory, slin);
  91                 break;
  92         default:
  93                 break;
  94         }
  95
  96         return 0;
  97 }
  98
  99 /*! \brief Initialize an audiohook structure
 100  *
 101  * \param audiohook Audiohook structure
 102  * \param type
 103  * \param source, init_flags
 104  *
 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, enum ast_audiohook_init_flags init_flags)
 108 {
 109         /* Need to keep the type and source */
 110         audiohook->type = type;
 111         audiohook->source = source;
 112
 113         /* Initialize lock that protects our audiohook */
 114         ast_mutex_init(&audiohook->lock);
 115         ast_cond_init(&audiohook->trigger, NULL);
 116
 117         audiohook->init_flags = init_flags;
 118
 119         /* initialize internal rate at 8khz, this will adjust if necessary */
 120         audiohook_set_internal_rate(audiohook, 8000, 0);
 121
 122         /* Since we are just starting out... this audiohook is new */
 123         ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_NEW);
 124
 125         return 0;
 126 }
 127
 128 /*! \brief Destroys an audiohook structure
 129  * \param audiohook Audiohook structure
 130  * \return Returns 0 on success, -1 on failure
 131  */
 132 int ast_audiohook_destroy(struct ast_audiohook *audiohook)
 133 {
 134         /* Drop the factories used by this audiohook type */
 135         switch (audiohook->type) {
 136         case AST_AUDIOHOOK_TYPE_SPY:
 137         case AST_AUDIOHOOK_TYPE_WHISPER:
 138                 ast_slinfactory_destroy(&audiohook->read_factory);
 139                 ast_slinfactory_destroy(&audiohook->write_factory);
 140                 break;
 141         default:
 142                 break;
 143         }
 144
 145         /* Destroy translation path if present */
 146         if (audiohook->trans_pvt)
 147                 ast_translator_free_path(audiohook->trans_pvt);
 148
 149         ao2_cleanup(audiohook->format);
 150
 151         /* Lock and trigger be gone! */
 152         ast_cond_destroy(&audiohook->trigger);
 153         ast_mutex_destroy(&audiohook->lock);
 154
 155         return 0;
 156 }
 157
 158 /*! \brief Writes a frame into the audiohook structure
 159  * \param audiohook Audiohook structure
 160  * \param direction Direction the audio frame came from
 161  * \param frame Frame to write in
 162  * \return Returns 0 on success, -1 on failure
 163  */
 164 int ast_audiohook_write_frame(struct ast_audiohook *audiohook, enum ast_audiohook_direction direction, struct ast_frame *frame)
 165 {
 166         struct ast_slinfactory *factory = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->read_factory : &audiohook->write_factory);
 167         struct ast_slinfactory *other_factory = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->write_factory : &audiohook->read_factory);
 168         struct timeval *rwtime = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->read_time : &audiohook->write_time), previous_time = *rwtime;
 169         int our_factory_samples;
 170         int our_factory_ms;
 171         int other_factory_samples;
 172         int other_factory_ms;
 173         int muteme = 0;
 174
 175         /* Update last feeding time to be current */
 176         *rwtime = ast_tvnow();
 177
 178         our_factory_samples = ast_slinfactory_available(factory);
 179         our_factory_ms = ast_tvdiff_ms(*rwtime, previous_time) + (our_factory_samples / (audiohook->hook_internal_samp_rate / 1000));
 180         other_factory_samples = ast_slinfactory_available(other_factory);
 181         other_factory_ms = other_factory_samples / (audiohook->hook_internal_samp_rate / 1000);
 182
 183         if (ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_SYNC) && other_factory_samples && (our_factory_ms - other_factory_ms > AST_AUDIOHOOK_SYNC_TOLERANCE)) {
 184                 ast_debug(1, "Flushing audiohook %p so it remains in sync\n", audiohook);
 185                 ast_slinfactory_flush(factory);
 186                 ast_slinfactory_flush(other_factory);
 187         }
 188
 189         if (ast_test_flag(audiohook, AST_AUDIOHOOK_SMALL_QUEUE) && ((our_factory_ms > AST_AUDIOHOOK_SMALL_QUEUE_TOLERANCE) || (other_factory_ms > AST_AUDIOHOOK_SMALL_QUEUE_TOLERANCE))) {
 190                 ast_debug(1, "Audiohook %p has stale audio in its factories. Flushing them both\n", audiohook);
 191                 ast_slinfactory_flush(factory);
 192                 ast_slinfactory_flush(other_factory);
 193         }
 194
 195         /* swap frame data for zeros if mute is required */
 196         if ((ast_test_flag(audiohook, AST_AUDIOHOOK_MUTE_READ) && (direction == AST_AUDIOHOOK_DIRECTION_READ)) ||
 197                 (ast_test_flag(audiohook, AST_AUDIOHOOK_MUTE_WRITE) && (direction == AST_AUDIOHOOK_DIRECTION_WRITE)) ||
 198                 (ast_test_flag(audiohook, AST_AUDIOHOOK_MUTE_READ | AST_AUDIOHOOK_MUTE_WRITE) == (AST_AUDIOHOOK_MUTE_READ | AST_AUDIOHOOK_MUTE_WRITE))) {
 199                         muteme = 1;
 200         }
 201
 202         if (muteme && frame->datalen > 0) {
 203                 ast_frame_clear(frame);
 204         }
 205
 206         /* Write frame out to respective factory */
 207         ast_slinfactory_feed(factory, frame);
 208
 209         /* If we need to notify the respective handler of this audiohook, do so */
 210         if ((ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_MODE) == AST_AUDIOHOOK_TRIGGER_READ) && (direction == AST_AUDIOHOOK_DIRECTION_READ)) {
 211                 ast_cond_signal(&audiohook->trigger);
 212         } else if ((ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_MODE) == AST_AUDIOHOOK_TRIGGER_WRITE) && (direction == AST_AUDIOHOOK_DIRECTION_WRITE)) {
 213                 ast_cond_signal(&audiohook->trigger);
 214         } else if (ast_test_flag(audiohook, AST_AUDIOHOOK_TRIGGER_SYNC)) {
 215                 ast_cond_signal(&audiohook->trigger);
 216         }
 217
 218         return 0;
 219 }
 220
 221 static struct ast_frame *audiohook_read_frame_single(struct ast_audiohook *audiohook, size_t samples, enum ast_audiohook_direction direction)
 222 {
 223         struct ast_slinfactory *factory = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->read_factory : &audiohook->write_factory);
 224         int vol = (direction == AST_AUDIOHOOK_DIRECTION_READ ? audiohook->options.read_volume : audiohook->options.write_volume);
 225         short buf[samples];
 226         struct ast_frame frame = {
 227                 .frametype = AST_FRAME_VOICE,
 228                 .subclass.format = ast_format_cache_get_slin_by_rate(audiohook->hook_internal_samp_rate),
 229                 .data.ptr = buf,
 230                 .datalen = sizeof(buf),
 231                 .samples = samples,
 232         };
 233
 234         /* Ensure the factory is able to give us the samples we want */
 235         if (samples > ast_slinfactory_available(factory)) {
 236                 return NULL;
 237         }
 238
 239         /* Read data in from factory */
 240         if (!ast_slinfactory_read(factory, buf, samples)) {
 241                 return NULL;
 242         }
 243
 244         /* If a volume adjustment needs to be applied apply it */
 245         if (vol) {
 246                 ast_frame_adjust_volume(&frame, vol);
 247         }
 248
 249         return ast_frdup(&frame);
 250 }
 251
 252 static struct ast_frame *audiohook_read_frame_both(struct ast_audiohook *audiohook, size_t samples, struct ast_frame **read_reference, struct ast_frame **write_reference)
 253 {
 254         int i = 0, usable_read, usable_write;
 255         short buf1[samples], buf2[samples], *read_buf = NULL, *write_buf = NULL, *final_buf = NULL, *data1 = NULL, *data2 = NULL;
 256         struct ast_frame frame = {
 257                 .frametype = AST_FRAME_VOICE,
 258                 .data.ptr = NULL,
 259                 .datalen = sizeof(buf1),
 260                 .samples = samples,
 261         };
 262
 263         /* Make sure both factories have the required samples */
 264         usable_read = (ast_slinfactory_available(&audiohook->read_factory) >= samples ? 1 : 0);
 265         usable_write = (ast_slinfactory_available(&audiohook->write_factory) >= samples ? 1 : 0);
 266
 267         if (!usable_read && !usable_write) {
 268                 /* If both factories are unusable bail out */
 269                 ast_debug(1, "Read factory %p and write factory %p both fail to provide %zu samples\n", &audiohook->read_factory, &audiohook->write_factory, samples);
 270                 return NULL;
 271         }
 272
 273         /* If we want to provide only a read factory make sure we aren't waiting for other audio */
 274         if (usable_read && !usable_write && (ast_tvdiff_ms(ast_tvnow(), audiohook->write_time) < (samples/8)*2)) {
 275                 ast_debug(3, "Write factory %p was pretty quick last time, waiting for them.\n", &audiohook->write_factory);
 276                 return NULL;
 277         }
 278
 279         /* If we want to provide only a write factory make sure we aren't waiting for other audio */
 280         if (usable_write && !usable_read && (ast_tvdiff_ms(ast_tvnow(), audiohook->read_time) < (samples/8)*2)) {
 281                 ast_debug(3, "Read factory %p was pretty quick last time, waiting for them.\n", &audiohook->read_factory);
 282                 return NULL;
 283         }
 284
 285         /* Start with the read factory... if there are enough samples, read them in */
 286         if (usable_read) {
 287                 if (ast_slinfactory_read(&audiohook->read_factory, buf1, samples)) {
 288                         read_buf = buf1;
 289                         /* Adjust read volume if need be */
 290                         if (audiohook->options.read_volume) {
 291                                 int count = 0;
 292                                 short adjust_value = abs(audiohook->options.read_volume);
 293                                 for (count = 0; count < samples; count++) {
 294                                         if (audiohook->options.read_volume > 0) {
 295                                                 ast_slinear_saturated_multiply(&buf1[count], &adjust_value);
 296                                         } else if (audiohook->options.read_volume < 0) {
 297                                                 ast_slinear_saturated_divide(&buf1[count], &adjust_value);
 298                                         }
 299                                 }
 300                         }
 301                 }
 302         } else {
 303                 ast_debug(1, "Failed to get %d samples from read factory %p\n", (int)samples, &audiohook->read_factory);
 304         }
 305
 306         /* Move on to the write factory... if there are enough samples, read them in */
 307         if (usable_write) {
 308                 if (ast_slinfactory_read(&audiohook->write_factory, buf2, samples)) {
 309                         write_buf = buf2;
 310                         /* Adjust write volume if need be */
 311                         if (audiohook->options.write_volume) {
 312                                 int count = 0;
 313                                 short adjust_value = abs(audiohook->options.write_volume);
 314                                 for (count = 0; count < samples; count++) {
 315                                         if (audiohook->options.write_volume > 0) {
 316                                                 ast_slinear_saturated_multiply(&buf2[count], &adjust_value);
 317                                         } else if (audiohook->options.write_volume < 0) {
 318                                                 ast_slinear_saturated_divide(&buf2[count], &adjust_value);
 319                                         }
 320                                 }
 321                         }
 322                 }
 323         } else {
 324                 ast_debug(1, "Failed to get %d samples from write factory %p\n", (int)samples, &audiohook->write_factory);
 325         }
 326
 327         /* Basically we figure out which buffer to use... and if mixing can be done here */
 328         if (read_buf && read_reference) {
 329                 frame.data.ptr = buf1;
 330                 *read_reference = ast_frdup(&frame);
 331         }
 332         if (write_buf && write_reference) {
 333                 frame.data.ptr = buf2;
 334                 *write_reference = ast_frdup(&frame);
 335         }
 336
 337         if (read_buf && write_buf) {
 338                 for (i = 0, data1 = read_buf, data2 = write_buf; i < samples; i++, data1++, data2++) {
 339                         ast_slinear_saturated_add(data1, data2);
 340                 }
 341                 final_buf = buf1;
 342         } else if (read_buf) {
 343                 final_buf = buf1;
 344         } else if (write_buf) {
 345                 final_buf = buf2;
 346         } else {
 347                 return NULL;
 348         }
 349
 350         /* Make the final buffer part of the frame, so it gets duplicated fine */
 351         frame.data.ptr = final_buf;
 352
 353         frame.subclass.format = ast_format_cache_get_slin_by_rate(audiohook->hook_internal_samp_rate);
 354
 355         /* Yahoo, a combined copy of the audio! */
 356         return ast_frdup(&frame);
 357 }
 358
 359 static struct ast_frame *audiohook_read_frame_helper(struct ast_audiohook *audiohook, size_t samples, enum ast_audiohook_direction direction, struct ast_format *format, struct ast_frame **read_reference, struct ast_frame **write_reference)
 360 {
 361         struct ast_frame *read_frame = NULL, *final_frame = NULL;
 362         struct ast_format *slin;
 363         int samples_converted;
 364
 365         /* the number of samples requested is based on the format they are requesting.  Inorder
 366          * to process this correctly samples must be converted to our internal sample rate */
 367         if (audiohook->hook_internal_samp_rate == ast_format_get_sample_rate(format)) {
 368                 samples_converted = samples;
 369         } else if (audiohook->hook_internal_samp_rate > ast_format_get_sample_rate(format)) {
 370                 samples_converted = samples * (audiohook->hook_internal_samp_rate / (float) ast_format_get_sample_rate(format));
 371         } else {
 372                 samples_converted = samples * (ast_format_get_sample_rate(format) / (float) audiohook->hook_internal_samp_rate);
 373         }
 374
 375         if (!(read_frame = (direction == AST_AUDIOHOOK_DIRECTION_BOTH ?
 376                 audiohook_read_frame_both(audiohook, samples_converted, read_reference, write_reference) :
 377                 audiohook_read_frame_single(audiohook, samples_converted, direction)))) {
 378                 return NULL;
 379         }
 380
 381         slin = ast_format_cache_get_slin_by_rate(audiohook->hook_internal_samp_rate);
 382
 383         /* If they don't want signed linear back out, we'll have to send it through the translation path */
 384         if (ast_format_cmp(format, slin) != AST_FORMAT_CMP_EQUAL) {
 385                 /* Rebuild translation path if different format then previously */
 386                 if (ast_format_cmp(format, audiohook->format) == AST_FORMAT_CMP_NOT_EQUAL) {
 387                         if (audiohook->trans_pvt) {
 388                                 ast_translator_free_path(audiohook->trans_pvt);
 389                                 audiohook->trans_pvt = NULL;
 390                         }
 391
 392                         /* 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 */
 393                         if (!(audiohook->trans_pvt = ast_translator_build_path(format, slin))) {
 394                                 ast_frfree(read_frame);
 395                                 return NULL;
 396                         }
 397                         ao2_replace(audiohook->format, format);
 398                 }
 399                 /* Convert to requested format, and allow the read in frame to be freed */
 400                 final_frame = ast_translate(audiohook->trans_pvt, read_frame, 1);
 401         } else {
 402                 final_frame = read_frame;
 403         }
 404
 405         return final_frame;
 406 }
 407
 408 /*! \brief Reads a frame in from the audiohook structure
 409  * \param audiohook Audiohook structure
 410  * \param samples Number of samples wanted in requested output format
 411  * \param direction Direction the audio frame came from
 412  * \param format Format of frame remote side wants back
 413  * \return Returns frame on success, NULL on failure
 414  */
 415 struct ast_frame *ast_audiohook_read_frame(struct ast_audiohook *audiohook, size_t samples, enum ast_audiohook_direction direction, struct ast_format *format)
 416 {
 417         return audiohook_read_frame_helper(audiohook, samples, direction, format, NULL, NULL);
 418 }
 419
 420 /*! \brief Reads a frame in from the audiohook structure
 421  * \param audiohook Audiohook structure
 422  * \param samples Number of samples wanted
 423  * \param direction Direction the audio frame came from
 424  * \param format Format of frame remote side wants back
 425  * \param read_frame frame pointer for copying read frame data
 426  * \param write_frame frame pointer for copying write frame data
 427  * \return Returns frame on success, NULL on failure
 428  */
 429 struct ast_frame *ast_audiohook_read_frame_all(struct ast_audiohook *audiohook, size_t samples, struct ast_format *format, struct ast_frame **read_frame, struct ast_frame **write_frame)
 430 {
 431         return audiohook_read_frame_helper(audiohook, samples, AST_AUDIOHOOK_DIRECTION_BOTH, format, read_frame, write_frame);
 432 }
 433
 434 static void audiohook_list_set_samplerate_compatibility(struct ast_audiohook_list *audiohook_list)
 435 {
 436         struct ast_audiohook *ah = NULL;
 437         audiohook_list->native_slin_compatible = 1;
 438         AST_LIST_TRAVERSE(&audiohook_list->manipulate_list, ah, list) {
 439                 if (!(ah->init_flags & AST_AUDIOHOOK_MANIPULATE_ALL_RATES)) {
 440                         audiohook_list->native_slin_compatible = 0;
 441                         return;
 442                 }
 443         }
 444 }
 445
 446 /*! \brief Attach audiohook to channel
 447  * \param chan Channel
 448  * \param audiohook Audiohook structure
 449  * \return Returns 0 on success, -1 on failure
 450  */
 451 int ast_audiohook_attach(struct ast_channel *chan, struct ast_audiohook *audiohook)
 452 {
 453         ast_channel_lock(chan);
 454
 455         if (!ast_channel_audiohooks(chan)) {
 456                 struct ast_audiohook_list *ahlist;
 457                 /* Whoops... allocate a new structure */
 458                 if (!(ahlist = ast_calloc(1, sizeof(*ahlist)))) {
 459                         ast_channel_unlock(chan);
 460                         return -1;
 461                 }
 462                 ast_channel_audiohooks_set(chan, ahlist);
 463                 AST_LIST_HEAD_INIT_NOLOCK(&ast_channel_audiohooks(chan)->spy_list);
 464                 AST_LIST_HEAD_INIT_NOLOCK(&ast_channel_audiohooks(chan)->whisper_list);
 465                 AST_LIST_HEAD_INIT_NOLOCK(&ast_channel_audiohooks(chan)->manipulate_list);
 466                 /* This sample rate will adjust as necessary when writing to the list. */
 467                 ast_channel_audiohooks(chan)->list_internal_samp_rate = 8000;
 468         }
 469
 470         /* Drop into respective list */
 471         if (audiohook->type == AST_AUDIOHOOK_TYPE_SPY) {
 472                 AST_LIST_INSERT_TAIL(&ast_channel_audiohooks(chan)->spy_list, audiohook, list);
 473         } else if (audiohook->type == AST_AUDIOHOOK_TYPE_WHISPER) {
 474                 AST_LIST_INSERT_TAIL(&ast_channel_audiohooks(chan)->whisper_list, audiohook, list);
 475         } else if (audiohook->type == AST_AUDIOHOOK_TYPE_MANIPULATE) {
 476                 AST_LIST_INSERT_TAIL(&ast_channel_audiohooks(chan)->manipulate_list, audiohook, list);
 477         }
 478
 479
 480         audiohook_set_internal_rate(audiohook, ast_channel_audiohooks(chan)->list_internal_samp_rate, 1);
 481         audiohook_list_set_samplerate_compatibility(ast_channel_audiohooks(chan));
 482
 483         /* Change status over to running since it is now attached */
 484         ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_RUNNING);
 485
 486         ast_channel_unlock(chan);
 487
 488         return 0;
 489 }
 490
 491 /*! \brief Update audiohook's status
 492  * \param audiohook Audiohook structure
 493  * \param status Audiohook status enum
 494  *
 495  * \note once status is updated to DONE, this function can not be used to set the
 496  * status back to any other setting.  Setting DONE effectively locks the status as such.
 497  */
 498
 499 void ast_audiohook_update_status(struct ast_audiohook *audiohook, enum ast_audiohook_status status)
 500 {
 501         ast_audiohook_lock(audiohook);
 502         if (audiohook->status != AST_AUDIOHOOK_STATUS_DONE) {
 503                 audiohook->status = status;
 504                 ast_cond_signal(&audiohook->trigger);
 505         }
 506         ast_audiohook_unlock(audiohook);
 507 }
 508
 509 /*! \brief Detach audiohook from channel
 510  * \param audiohook Audiohook structure
 511  * \return Returns 0 on success, -1 on failure
 512  */
 513 int ast_audiohook_detach(struct ast_audiohook *audiohook)
 514 {
 515         if (audiohook->status == AST_AUDIOHOOK_STATUS_NEW || audiohook->status == AST_AUDIOHOOK_STATUS_DONE) {
 516                 return 0;
 517         }
 518
 519         ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_SHUTDOWN);
 520
 521         while (audiohook->status != AST_AUDIOHOOK_STATUS_DONE) {
 522                 ast_audiohook_trigger_wait(audiohook);
 523         }
 524
 525         return 0;
 526 }
 527
 528 void ast_audiohook_detach_list(struct ast_audiohook_list *audiohook_list)
 529 {
 530         int i;
 531         struct ast_audiohook *audiohook;
 532
 533         if (!audiohook_list) {
 534                 return;
 535         }
 536
 537         /* Drop any spies */
 538         while ((audiohook = AST_LIST_REMOVE_HEAD(&audiohook_list->spy_list, list))) {
 539                 ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
 540         }
 541
 542         /* Drop any whispering sources */
 543         while ((audiohook = AST_LIST_REMOVE_HEAD(&audiohook_list->whisper_list, list))) {
 544                 ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
 545         }
 546
 547         /* Drop any manipulaters */
 548         while ((audiohook = AST_LIST_REMOVE_HEAD(&audiohook_list->manipulate_list, list))) {
 549                 ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
 550                 audiohook->manipulate_callback(audiohook, NULL, NULL, 0);
 551         }
 552
 553         /* Drop translation paths if present */
 554         for (i = 0; i < 2; i++) {
 555                 if (audiohook_list->in_translate[i].trans_pvt) {
 556                         ast_translator_free_path(audiohook_list->in_translate[i].trans_pvt);
 557                 }
 558                 if (audiohook_list->out_translate[i].trans_pvt) {
 559                         ast_translator_free_path(audiohook_list->out_translate[i].trans_pvt);
 560                 }
 561         }
 562
 563         /* Free ourselves */
 564         ast_free(audiohook_list);
 565 }
 566
 567 /*! \brief find an audiohook based on its source
 568  * \param audiohook_list The list of audiohooks to search in
 569  * \param source The source of the audiohook we wish to find
 570  * \return Return the corresponding audiohook or NULL if it cannot be found.
 571  */
 572 static struct ast_audiohook *find_audiohook_by_source(struct ast_audiohook_list *audiohook_list, const char *source)
 573 {
 574         struct ast_audiohook *audiohook = NULL;
 575
 576         AST_LIST_TRAVERSE(&audiohook_list->spy_list, audiohook, list) {
 577                 if (!strcasecmp(audiohook->source, source)) {
 578                         return audiohook;
 579                 }
 580         }
 581
 582         AST_LIST_TRAVERSE(&audiohook_list->whisper_list, audiohook, list) {
 583                 if (!strcasecmp(audiohook->source, source)) {
 584                         return audiohook;
 585                 }
 586         }
 587
 588         AST_LIST_TRAVERSE(&audiohook_list->manipulate_list, audiohook, list) {
 589                 if (!strcasecmp(audiohook->source, source)) {
 590                         return audiohook;
 591                 }
 592         }
 593
 594         return NULL;
 595 }
 596
 597 static void audiohook_move(struct ast_channel *old_chan, struct ast_channel *new_chan, struct ast_audiohook *audiohook)
 598 {
 599         enum ast_audiohook_status oldstatus;
 600
 601         /* By locking both channels and the audiohook, we can assure that
 602          * another thread will not have a chance to read the audiohook's status
 603          * as done, even though ast_audiohook_remove signals the trigger
 604          * condition.
 605          */
 606         ast_audiohook_lock(audiohook);
 607         oldstatus = audiohook->status;
 608
 609         ast_audiohook_remove(old_chan, audiohook);
 610         ast_audiohook_attach(new_chan, audiohook);
 611
 612         audiohook->status = oldstatus;
 613         ast_audiohook_unlock(audiohook);
 614 }
 615
 616 void ast_audiohook_move_by_source(struct ast_channel *old_chan, struct ast_channel *new_chan, const char *source)
 617 {
 618         struct ast_audiohook *audiohook;
 619
 620         if (!ast_channel_audiohooks(old_chan)) {
 621                 return;
 622         }
 623
 624         audiohook = find_audiohook_by_source(ast_channel_audiohooks(old_chan), source);
 625         if (!audiohook) {
 626                 return;
 627         }
 628
 629         audiohook_move(old_chan, new_chan, audiohook);
 630 }
 631
 632 void ast_audiohook_move_all(struct ast_channel *old_chan, struct ast_channel *new_chan)
 633 {
 634         struct ast_audiohook *audiohook;
 635         struct ast_audiohook_list *audiohook_list;
 636
 637         audiohook_list = ast_channel_audiohooks(old_chan);
 638         if (!audiohook_list) {
 639                 return;
 640         }
 641
 642         AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->spy_list, audiohook, list) {
 643                 audiohook_move(old_chan, new_chan, audiohook);
 644         }
 645         AST_LIST_TRAVERSE_SAFE_END;
 646
 647         AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->whisper_list, audiohook, list) {
 648                 audiohook_move(old_chan, new_chan, audiohook);
 649         }
 650         AST_LIST_TRAVERSE_SAFE_END;
 651
 652         AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->manipulate_list, audiohook, list) {
 653                 audiohook_move(old_chan, new_chan, audiohook);
 654         }
 655         AST_LIST_TRAVERSE_SAFE_END;
 656 }
 657
 658 /*! \brief Detach specified source audiohook from channel
 659  * \param chan Channel to detach from
 660  * \param source Name of source to detach
 661  * \return Returns 0 on success, -1 on failure
 662  */
 663 int ast_audiohook_detach_source(struct ast_channel *chan, const char *source)
 664 {
 665         struct ast_audiohook *audiohook = NULL;
 666
 667         ast_channel_lock(chan);
 668
 669         /* Ensure the channel has audiohooks on it */
 670         if (!ast_channel_audiohooks(chan)) {
 671                 ast_channel_unlock(chan);
 672                 return -1;
 673         }
 674
 675         audiohook = find_audiohook_by_source(ast_channel_audiohooks(chan), source);
 676
 677         ast_channel_unlock(chan);
 678
 679         if (audiohook && audiohook->status != AST_AUDIOHOOK_STATUS_DONE) {
 680                 ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_SHUTDOWN);
 681         }
 682
 683         return (audiohook ? 0 : -1);
 684 }
 685
 686 /*!
 687  * \brief Remove an audiohook from a specified channel
 688  *
 689  * \param chan Channel to remove from
 690  * \param audiohook Audiohook to remove
 691  *
 692  * \return Returns 0 on success, -1 on failure
 693  *
 694  * \note The channel does not need to be locked before calling this function
 695  */
 696 int ast_audiohook_remove(struct ast_channel *chan, struct ast_audiohook *audiohook)
 697 {
 698         ast_channel_lock(chan);
 699
 700         if (!ast_channel_audiohooks(chan)) {
 701                 ast_channel_unlock(chan);
 702                 return -1;
 703         }
 704
 705         if (audiohook->type == AST_AUDIOHOOK_TYPE_SPY) {
 706                 AST_LIST_REMOVE(&ast_channel_audiohooks(chan)->spy_list, audiohook, list);
 707         } else if (audiohook->type == AST_AUDIOHOOK_TYPE_WHISPER) {
 708                 AST_LIST_REMOVE(&ast_channel_audiohooks(chan)->whisper_list, audiohook, list);
 709         } else if (audiohook->type == AST_AUDIOHOOK_TYPE_MANIPULATE) {
 710                 AST_LIST_REMOVE(&ast_channel_audiohooks(chan)->manipulate_list, audiohook, list);
 711         }
 712
 713         audiohook_list_set_samplerate_compatibility(ast_channel_audiohooks(chan));
 714         ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
 715
 716         ast_channel_unlock(chan);
 717
 718         return 0;
 719 }
 720
 721 /*! \brief Pass a DTMF frame off to be handled by the audiohook core
 722  * \param chan Channel that the list is coming off of
 723  * \param audiohook_list List of audiohooks
 724  * \param direction Direction frame is coming in from
 725  * \param frame The frame itself
 726  * \return Return frame on success, NULL on failure
 727  */
 728 static struct ast_frame *dtmf_audiohook_write_list(struct ast_channel *chan, struct ast_audiohook_list *audiohook_list, enum ast_audiohook_direction direction, struct ast_frame *frame)
 729 {
 730         struct ast_audiohook *audiohook = NULL;
 731         int removed = 0;
 732
 733         AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->manipulate_list, audiohook, list) {
 734                 ast_audiohook_lock(audiohook);
 735                 if (audiohook->status != AST_AUDIOHOOK_STATUS_RUNNING) {
 736                         AST_LIST_REMOVE_CURRENT(list);
 737                         removed = 1;
 738                         ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
 739                         ast_audiohook_unlock(audiohook);
 740                         audiohook->manipulate_callback(audiohook, NULL, NULL, 0);
 741                         continue;
 742                 }
 743                 if (ast_test_flag(audiohook, AST_AUDIOHOOK_WANTS_DTMF)) {
 744                         audiohook->manipulate_callback(audiohook, chan, frame, direction);
 745                 }
 746                 ast_audiohook_unlock(audiohook);
 747         }
 748         AST_LIST_TRAVERSE_SAFE_END;
 749
 750         /* if an audiohook got removed, reset samplerate compatibility */
 751         if (removed) {
 752                 audiohook_list_set_samplerate_compatibility(audiohook_list);
 753         }
 754         return frame;
 755 }
 756
 757 static struct ast_frame *audiohook_list_translate_to_slin(struct ast_audiohook_list *audiohook_list,
 758         enum ast_audiohook_direction direction, struct ast_frame *frame)
 759 {
 760         struct ast_audiohook_translate *in_translate = (direction == AST_AUDIOHOOK_DIRECTION_READ ?
 761                 &audiohook_list->in_translate[0] : &audiohook_list->in_translate[1]);
 762         struct ast_frame *new_frame = frame;
 763         struct ast_format *slin;
 764
 765         /* If we are capable of maintaining doing samplerates other that 8khz, update
 766          * the internal audiohook_list's rate and higher samplerate audio arrives. By
 767          * updating the list's rate, all the audiohooks in the list will be updated as well
 768          * as the are written and read from. */
 769         if (audiohook_list->native_slin_compatible) {
 770                 audiohook_list->list_internal_samp_rate =
 771                         MAX(ast_format_get_sample_rate(frame->subclass.format), audiohook_list->list_internal_samp_rate);
 772         }
 773
 774         slin = ast_format_cache_get_slin_by_rate(audiohook_list->list_internal_samp_rate);
 775         if (ast_format_cmp(frame->subclass.format, slin) == AST_FORMAT_CMP_EQUAL) {
 776                 return new_frame;
 777         }
 778
 779         if (ast_format_cmp(frame->subclass.format, in_translate->format) == AST_FORMAT_CMP_NOT_EQUAL) {
 780                 if (in_translate->trans_pvt) {
 781                         ast_translator_free_path(in_translate->trans_pvt);
 782                 }
 783                 if (!(in_translate->trans_pvt = ast_translator_build_path(slin, frame->subclass.format))) {
 784                         return NULL;
 785                 }
 786                 ao2_replace(in_translate->format, frame->subclass.format);
 787         }
 788
 789         if (!(new_frame = ast_translate(in_translate->trans_pvt, frame, 0))) {
 790                 return NULL;
 791         }
 792
 793         return new_frame;
 794 }
 795
 796 static struct ast_frame *audiohook_list_translate_to_native(struct ast_audiohook_list *audiohook_list,
 797         enum ast_audiohook_direction direction, struct ast_frame *slin_frame, struct ast_format *outformat)
 798 {
 799         struct ast_audiohook_translate *out_translate = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook_list->out_translate[0] : &audiohook_list->out_translate[1]);
 800         struct ast_frame *outframe = NULL;
 801         if (ast_format_cmp(slin_frame->subclass.format, outformat) == AST_FORMAT_CMP_NOT_EQUAL) {
 802                 /* rebuild translators if necessary */
 803                 if (ast_format_cmp(out_translate->format, outformat) == AST_FORMAT_CMP_NOT_EQUAL) {
 804                         if (out_translate->trans_pvt) {
 805                                 ast_translator_free_path(out_translate->trans_pvt);
 806                         }
 807                         if (!(out_translate->trans_pvt = ast_translator_build_path(outformat, slin_frame->subclass.format))) {
 808                                 return NULL;
 809                         }
 810                         ao2_replace(out_translate->format, outformat);
 811                 }
 812                 /* translate back to the format the frame came in as. */
 813                 if (!(outframe = ast_translate(out_translate->trans_pvt, slin_frame, 0))) {
 814                         return NULL;
 815                 }
 816         }
 817         return outframe;
 818 }
 819
 820 /*!
 821  * \brief Pass an AUDIO frame off to be handled by the audiohook core
 822  *
 823  * \details
 824  * This function has 3 ast_frames and 3 parts to handle each.  At the beginning of this
 825  * function all 3 frames, start_frame, middle_frame, and end_frame point to the initial
 826  * input frame.
 827  *
 828  * Part_1: Translate the start_frame into SLINEAR audio if it is not already in that
 829  *         format.  The result of this part is middle_frame is guaranteed to be in
 830  *         SLINEAR format for Part_2.
 831  * Part_2: Send middle_frame off to spies and manipulators.  At this point middle_frame is
 832  *         either a new frame as result of the translation, or points directly to the start_frame
 833  *         because no translation to SLINEAR audio was required.
 834  * Part_3: Translate end_frame's audio back into the format of start frame if necessary.  This
 835  *         is only necessary if manipulation of middle_frame occurred.
 836  *
 837  * \param chan Channel that the list is coming off of
 838  * \param audiohook_list List of audiohooks
 839  * \param direction Direction frame is coming in from
 840  * \param frame The frame itself
 841  * \return Return frame on success, NULL on failure
 842  */
 843 static struct ast_frame *audio_audiohook_write_list(struct ast_channel *chan, struct ast_audiohook_list *audiohook_list, enum ast_audiohook_direction direction, struct ast_frame *frame)
 844 {
 845         struct ast_frame *start_frame = frame, *middle_frame = frame, *end_frame = frame;
 846         struct ast_audiohook *audiohook = NULL;
 847         int samples;
 848         int middle_frame_manipulated = 0;
 849         int removed = 0;
 850
 851         /* ---Part_1. translate start_frame to SLINEAR if necessary. */
 852         if (!(middle_frame = audiohook_list_translate_to_slin(audiohook_list, direction, start_frame))) {
 853                 return frame;
 854         }
 855         samples = middle_frame->samples;
 856
 857         /* ---Part_2: Send middle_frame to spy and manipulator lists.  middle_frame is guaranteed to be SLINEAR here.*/
 858         /* Queue up signed linear frame to each spy */
 859         AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->spy_list, audiohook, list) {
 860                 ast_audiohook_lock(audiohook);
 861                 if (audiohook->status != AST_AUDIOHOOK_STATUS_RUNNING) {
 862                         AST_LIST_REMOVE_CURRENT(list);
 863                         removed = 1;
 864                         ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
 865                         ast_audiohook_unlock(audiohook);
 866                         continue;
 867                 }
 868                 audiohook_set_internal_rate(audiohook, audiohook_list->list_internal_samp_rate, 1);
 869                 ast_audiohook_write_frame(audiohook, direction, middle_frame);
 870                 ast_audiohook_unlock(audiohook);
 871         }
 872         AST_LIST_TRAVERSE_SAFE_END;
 873
 874         /* If this frame is being written out to the channel then we need to use whisper sources */
 875         if (!AST_LIST_EMPTY(&audiohook_list->whisper_list)) {
 876                 int i = 0;
 877                 short read_buf[samples], combine_buf[samples], *data1 = NULL, *data2 = NULL;
 878                 memset(&combine_buf, 0, sizeof(combine_buf));
 879                 AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->whisper_list, audiohook, list) {
 880                         struct ast_slinfactory *factory = (direction == AST_AUDIOHOOK_DIRECTION_READ ? &audiohook->read_factory : &audiohook->write_factory);
 881                         ast_audiohook_lock(audiohook);
 882                         if (audiohook->status != AST_AUDIOHOOK_STATUS_RUNNING) {
 883                                 AST_LIST_REMOVE_CURRENT(list);
 884                                 removed = 1;
 885                                 ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
 886                                 ast_audiohook_unlock(audiohook);
 887                                 continue;
 888                         }
 889                         audiohook_set_internal_rate(audiohook, audiohook_list->list_internal_samp_rate, 1);
 890                         if (ast_slinfactory_available(factory) >= samples && ast_slinfactory_read(factory, read_buf, samples)) {
 891                                 /* Take audio from this whisper source and combine it into our main buffer */
 892                                 for (i = 0, data1 = combine_buf, data2 = read_buf; i < samples; i++, data1++, data2++) {
 893                                         ast_slinear_saturated_add(data1, data2);
 894                                 }
 895                         }
 896                         ast_audiohook_unlock(audiohook);
 897                 }
 898                 AST_LIST_TRAVERSE_SAFE_END;
 899                 /* We take all of the combined whisper sources and combine them into the audio being written out */
 900                 for (i = 0, data1 = middle_frame->data.ptr, data2 = combine_buf; i < samples; i++, data1++, data2++) {
 901                         ast_slinear_saturated_add(data1, data2);
 902                 }
 903                 middle_frame_manipulated = 1;
 904         }
 905
 906         /* Pass off frame to manipulate audiohooks */
 907         if (!AST_LIST_EMPTY(&audiohook_list->manipulate_list)) {
 908                 AST_LIST_TRAVERSE_SAFE_BEGIN(&audiohook_list->manipulate_list, audiohook, list) {
 909                         ast_audiohook_lock(audiohook);
 910                         if (audiohook->status != AST_AUDIOHOOK_STATUS_RUNNING) {
 911                                 AST_LIST_REMOVE_CURRENT(list);
 912                                 removed = 1;
 913                                 ast_audiohook_update_status(audiohook, AST_AUDIOHOOK_STATUS_DONE);
 914                                 ast_audiohook_unlock(audiohook);
 915                                 /* We basically drop all of our links to the manipulate audiohook and prod it to do it's own destructive things */
 916                                 audiohook->manipulate_callback(audiohook, chan, NULL, direction);
 917                                 continue;
 918                         }
 919                         audiohook_set_internal_rate(audiohook, audiohook_list->list_internal_samp_rate, 1);
 920                         /* Feed in frame to manipulation. */
 921                         if (!audiohook->manipulate_callback(audiohook, chan, middle_frame, direction)) {
 922                                 /* If the manipulation fails then the frame will be returned in its original state.
 923                                  * Since there are potentially more manipulator callbacks in the list, no action should
 924                                  * be taken here to exit early. */
 925                                  middle_frame_manipulated = 1;
 926                         }
 927                         ast_audiohook_unlock(audiohook);
 928                 }
 929                 AST_LIST_TRAVERSE_SAFE_END;
 930         }
 931
 932         /* ---Part_3: Decide what to do with the end_frame (whether to transcode or not) */
 933         if (middle_frame_manipulated) {
 934                 if (!(end_frame = audiohook_list_translate_to_native(audiohook_list, direction, middle_frame, start_frame->subclass.format))) {
 935                         /* translation failed, so just pass back the input frame */
 936                         end_frame = start_frame;
 937                 }
 938         } else {
 939                 end_frame = start_frame;
 940         }
 941         /* clean up our middle_frame if required */
 942         if (middle_frame != end_frame) {
 943                 ast_frfree(middle_frame);
 944                 middle_frame = NULL;
 945         }
 946
 947         /* Before returning, if an audiohook got removed, reset samplerate compatibility */
 948         if (removed) {
 949                 audiohook_list_set_samplerate_compatibility(audiohook_list);
 950         }
 951
 952         return end_frame;
 953 }
 954
 955 int ast_audiohook_write_list_empty(struct ast_audiohook_list *audiohook_list)
 956 {
 957         return !audiohook_list
 958                 || (AST_LIST_EMPTY(&audiohook_list->spy_list)
 959                         && AST_LIST_EMPTY(&audiohook_list->whisper_list)
 960                         && AST_LIST_EMPTY(&audiohook_list->manipulate_list));
 961 }
 962
 963 /*! \brief Pass a frame off to be handled by the audiohook core
 964  * \param chan Channel that the list is coming off of
 965  * \param audiohook_list List of audiohooks
 966  * \param direction Direction frame is coming in from
 967  * \param frame The frame itself
 968  * \return Return frame on success, NULL on failure
 969  */
 970 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)
 971 {
 972         /* Pass off frame to it's respective list write function */
 973         if (frame->frametype == AST_FRAME_VOICE) {
 974                 return audio_audiohook_write_list(chan, audiohook_list, direction, frame);
 975         } else if (frame->frametype == AST_FRAME_DTMF) {
 976                 return dtmf_audiohook_write_list(chan, audiohook_list, direction, frame);
 977         } else {
 978                 return frame;
 979         }
 980 }
 981
 982 /*! \brief Wait for audiohook trigger to be triggered
 983  * \param audiohook Audiohook to wait on
 984  */
 985 void ast_audiohook_trigger_wait(struct ast_audiohook *audiohook)
 986 {
 987         struct timeval wait;
 988         struct timespec ts;
 989
 990         wait = ast_tvadd(ast_tvnow(), ast_samp2tv(50000, 1000));
 991         ts.tv_sec = wait.tv_sec;
 992         ts.tv_nsec = wait.tv_usec * 1000;
 993
 994         ast_cond_timedwait(&audiohook->trigger, &audiohook->lock, &ts);
 995
 996         return;
 997 }
 998
 999 /* Count number of channel audiohooks by type, regardless of type */
1000 int ast_channel_audiohook_count_by_source(struct ast_channel *chan, const char *source, enum ast_audiohook_type type)
1001 {
1002         int count = 0;
1003         struct ast_audiohook *ah = NULL;
1004
1005         if (!ast_channel_audiohooks(chan)) {
1006                 return -1;
1007         }
1008
1009         switch (type) {
1010                 case AST_AUDIOHOOK_TYPE_SPY:
1011                         AST_LIST_TRAVERSE(&ast_channel_audiohooks(chan)->spy_list, ah, list) {
1012                                 if (!strcmp(ah->source, source)) {
1013                                         count++;
1014                                 }
1015                         }
1016                         break;
1017                 case AST_AUDIOHOOK_TYPE_WHISPER:
1018                         AST_LIST_TRAVERSE(&ast_channel_audiohooks(chan)->whisper_list, ah, list) {
1019                                 if (!strcmp(ah->source, source)) {
1020                                         count++;
1021                                 }
1022                         }
1023                         break;
1024                 case AST_AUDIOHOOK_TYPE_MANIPULATE:
1025                         AST_LIST_TRAVERSE(&ast_channel_audiohooks(chan)->manipulate_list, ah, list) {
1026                                 if (!strcmp(ah->source, source)) {
1027                                         count++;
1028                                 }
1029                         }
1030                         break;
1031                 default:
1032                         ast_debug(1, "Invalid audiohook type supplied, (%u)\n", type);
1033                         return -1;
1034         }
1035
1036         return count;
1037 }
1038
1039 /* Count number of channel audiohooks by type that are running */
1040 int ast_channel_audiohook_count_by_source_running(struct ast_channel *chan, const char *source, enum ast_audiohook_type type)
1041 {
1042         int count = 0;
1043         struct ast_audiohook *ah = NULL;
1044         if (!ast_channel_audiohooks(chan))
1045                 return -1;
1046
1047         switch (type) {
1048                 case AST_AUDIOHOOK_TYPE_SPY:
1049                         AST_LIST_TRAVERSE(&ast_channel_audiohooks(chan)->spy_list, ah, list) {
1050                                 if ((!strcmp(ah->source, source)) && (ah->status == AST_AUDIOHOOK_STATUS_RUNNING))
1051                                         count++;
1052                         }
1053                         break;
1054                 case AST_AUDIOHOOK_TYPE_WHISPER:
1055                         AST_LIST_TRAVERSE(&ast_channel_audiohooks(chan)->whisper_list, ah, list) {
1056                                 if ((!strcmp(ah->source, source)) && (ah->status == AST_AUDIOHOOK_STATUS_RUNNING))
1057                                         count++;
1058                         }
1059                         break;
1060                 case AST_AUDIOHOOK_TYPE_MANIPULATE:
1061                         AST_LIST_TRAVERSE(&ast_channel_audiohooks(chan)->manipulate_list, ah, list) {
1062                                 if ((!strcmp(ah->source, source)) && (ah->status == AST_AUDIOHOOK_STATUS_RUNNING))
1063                                         count++;
1064                         }
1065                         break;
1066                 default:
1067                         ast_debug(1, "Invalid audiohook type supplied, (%u)\n", type);
1068                         return -1;
1069         }
1070         return count;
1071 }
1072
1073 /*! \brief Audiohook volume adjustment structure */
1074 struct audiohook_volume {
1075         struct ast_audiohook audiohook; /*!< Audiohook attached to the channel */
1076         int read_adjustment;            /*!< Value to adjust frames read from the channel by */
1077         int write_adjustment;           /*!< Value to adjust frames written to the channel by */
1078 };
1079
1080 /*! \brief Callback used to destroy the audiohook volume datastore
1081  * \param data Volume information structure
1082  * \return Returns nothing
1083  */
1084 static void audiohook_volume_destroy(void *data)
1085 {
1086         struct audiohook_volume *audiohook_volume = data;
1087
1088         /* Destroy the audiohook as it is no longer in use */
1089         ast_audiohook_destroy(&audiohook_volume->audiohook);
1090
1091         /* Finally free ourselves, we are of no more use */
1092         ast_free(audiohook_volume);
1093
1094         return;
1095 }
1096
1097 /*! \brief Datastore used to store audiohook volume information */
1098 static const struct ast_datastore_info audiohook_volume_datastore = {
1099         .type = "Volume",
1100         .destroy = audiohook_volume_destroy,
1101 };
1102
1103 /*! \brief Helper function which actually gets called by audiohooks to perform the adjustment
1104  * \param audiohook Audiohook attached to the channel
1105  * \param chan Channel we are attached to
1106  * \param frame Frame of audio we want to manipulate
1107  * \param direction Direction the audio came in from
1108  * \return Returns 0 on success, -1 on failure
1109  */
1110 static int audiohook_volume_callback(struct ast_audiohook *audiohook, struct ast_channel *chan, struct ast_frame *frame, enum ast_audiohook_direction direction)
1111 {
1112         struct ast_datastore *datastore = NULL;
1113         struct audiohook_volume *audiohook_volume = NULL;
1114         int *gain = NULL;
1115
1116         /* If the audiohook is shutting down don't even bother */
1117         if (audiohook->status == AST_AUDIOHOOK_STATUS_DONE) {
1118                 return 0;
1119         }
1120
1121         /* Try to find the datastore containg adjustment information, if we can't just bail out */
1122         if (!(datastore = ast_channel_datastore_find(chan, &audiohook_volume_datastore, NULL))) {
1123                 return 0;
1124         }
1125
1126         audiohook_volume = datastore->data;
1127
1128         /* Based on direction grab the appropriate adjustment value */
1129         if (direction == AST_AUDIOHOOK_DIRECTION_READ) {
1130                 gain = &audiohook_volume->read_adjustment;
1131         } else if (direction == AST_AUDIOHOOK_DIRECTION_WRITE) {
1132                 gain = &audiohook_volume->write_adjustment;
1133         }
1134
1135         /* If an adjustment value is present modify the frame */
1136         if (gain && *gain) {
1137                 ast_frame_adjust_volume(frame, *gain);
1138         }
1139
1140         return 0;
1141 }
1142
1143 /*! \brief Helper function which finds and optionally creates an audiohook_volume_datastore datastore on a channel
1144  * \param chan Channel to look on
1145  * \param create Whether to create the datastore if not found
1146  * \return Returns audiohook_volume structure on success, NULL on failure
1147  */
1148 static struct audiohook_volume *audiohook_volume_get(struct ast_channel *chan, int create)
1149 {
1150         struct ast_datastore *datastore = NULL;
1151         struct audiohook_volume *audiohook_volume = NULL;
1152
1153         /* If we are able to find the datastore return the contents (which is actually an audiohook_volume structure) */
1154         if ((datastore = ast_channel_datastore_find(chan, &audiohook_volume_datastore, NULL))) {
1155                 return datastore->data;
1156         }
1157
1158         /* If we are not allowed to create a datastore or if we fail to create a datastore, bail out now as we have nothing for them */
1159         if (!create || !(datastore = ast_datastore_alloc(&audiohook_volume_datastore, NULL))) {
1160                 return NULL;
1161         }
1162
1163         /* Create a new audiohook_volume structure to contain our adjustments and audiohook */
1164         if (!(audiohook_volume = ast_calloc(1, sizeof(*audiohook_volume)))) {
1165                 ast_datastore_free(datastore);
1166                 return NULL;
1167         }
1168
1169         /* Setup our audiohook structure so we can manipulate the audio */
1170         ast_audiohook_init(&audiohook_volume->audiohook, AST_AUDIOHOOK_TYPE_MANIPULATE, "Volume", AST_AUDIOHOOK_MANIPULATE_ALL_RATES);
1171         audiohook_volume->audiohook.manipulate_callback = audiohook_volume_callback;
1172
1173         /* Attach the audiohook_volume blob to the datastore and attach to the channel */
1174         datastore->data = audiohook_volume;
1175         ast_channel_datastore_add(chan, datastore);
1176
1177         /* All is well... put the audiohook into motion */
1178         ast_audiohook_attach(chan, &audiohook_volume->audiohook);
1179
1180         return audiohook_volume;
1181 }
1182
1183 /*! \brief Adjust the volume on frames read from or written to a channel
1184  * \param chan Channel to muck with
1185  * \param direction Direction to set on
1186  * \param volume Value to adjust the volume by
1187  * \return Returns 0 on success, -1 on failure
1188  */
1189 int ast_audiohook_volume_set(struct ast_channel *chan, enum ast_audiohook_direction direction, int volume)
1190 {
1191         struct audiohook_volume *audiohook_volume = NULL;
1192
1193         /* Attempt to find the audiohook volume information, but only create it if we are not setting the adjustment value to zero */
1194         if (!(audiohook_volume = audiohook_volume_get(chan, (volume ? 1 : 0)))) {
1195                 return -1;
1196         }
1197
1198         /* Now based on the direction set the proper value */
1199         if (direction == AST_AUDIOHOOK_DIRECTION_READ || direction == AST_AUDIOHOOK_DIRECTION_BOTH) {
1200                 audiohook_volume->read_adjustment = volume;
1201         }
1202         if (direction == AST_AUDIOHOOK_DIRECTION_WRITE || direction == AST_AUDIOHOOK_DIRECTION_BOTH) {
1203                 audiohook_volume->write_adjustment = volume;
1204         }
1205
1206         return 0;
1207 }
1208
1209 /*! \brief Retrieve the volume adjustment value on frames read from or written to a channel
1210  * \param chan Channel to retrieve volume adjustment from
1211  * \param direction Direction to retrieve
1212  * \return Returns adjustment value
1213  */
1214 int ast_audiohook_volume_get(struct ast_channel *chan, enum ast_audiohook_direction direction)
1215 {
1216         struct audiohook_volume *audiohook_volume = NULL;
1217         int adjustment = 0;
1218
1219         /* Attempt to find the audiohook volume information, but do not create it as we only want to look at the values */
1220         if (!(audiohook_volume = audiohook_volume_get(chan, 0))) {
1221                 return 0;
1222         }
1223
1224         /* Grab the adjustment value based on direction given */
1225         if (direction == AST_AUDIOHOOK_DIRECTION_READ) {
1226                 adjustment = audiohook_volume->read_adjustment;
1227         } else if (direction == AST_AUDIOHOOK_DIRECTION_WRITE) {
1228                 adjustment = audiohook_volume->write_adjustment;
1229         }
1230
1231         return adjustment;
1232 }
1233
1234 /*! \brief Adjust the volume on frames read from or written to a channel
1235  * \param chan Channel to muck with
1236  * \param direction Direction to increase
1237  * \param volume Value to adjust the adjustment by
1238  * \return Returns 0 on success, -1 on failure
1239  */
1240 int ast_audiohook_volume_adjust(struct ast_channel *chan, enum ast_audiohook_direction direction, int volume)
1241 {
1242         struct audiohook_volume *audiohook_volume = NULL;
1243
1244         /* Attempt to find the audiohook volume information, and create an audiohook if none exists */
1245         if (!(audiohook_volume = audiohook_volume_get(chan, 1))) {
1246                 return -1;
1247         }
1248
1249         /* Based on the direction change the specific adjustment value */
1250         if (direction == AST_AUDIOHOOK_DIRECTION_READ || direction == AST_AUDIOHOOK_DIRECTION_BOTH) {
1251                 audiohook_volume->read_adjustment += volume;
1252         }
1253         if (direction == AST_AUDIOHOOK_DIRECTION_WRITE || direction == AST_AUDIOHOOK_DIRECTION_BOTH) {
1254                 audiohook_volume->write_adjustment += volume;
1255         }
1256
1257         return 0;
1258 }
1259
1260 /*! \brief Mute frames read from or written to a channel
1261  * \param chan Channel to muck with
1262  * \param source Type of audiohook
1263  * \param flag which flag to set / clear
1264  * \param clear set or clear
1265  * \return Returns 0 on success, -1 on failure
1266  */
1267 int ast_audiohook_set_mute(struct ast_channel *chan, const char *source, enum ast_audiohook_flags flag, int clear)
1268 {
1269         struct ast_audiohook *audiohook = NULL;
1270
1271         ast_channel_lock(chan);
1272
1273         /* Ensure the channel has audiohooks on it */
1274         if (!ast_channel_audiohooks(chan)) {
1275                 ast_channel_unlock(chan);
1276                 return -1;
1277         }
1278
1279         audiohook = find_audiohook_by_source(ast_channel_audiohooks(chan), source);
1280
1281         if (audiohook) {
1282                 if (clear) {
1283                         ast_clear_flag(audiohook, flag);
1284                 } else {
1285                         ast_set_flag(audiohook, flag);
1286                 }
1287         }
1288
1289         ast_channel_unlock(chan);
1290
1291         return (audiohook ? 0 : -1);
1292 }