main/channel.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2006, Digium, Inc.
   5  *
   6  * Mark Spencer <markster@digium.com>
   7  *
   8  * See http://www.asterisk.org for more information about
   9  * the Asterisk project. Please do not directly contact
  10  * any of the maintainers of this project for assistance;
  11  * the project provides a web site, mailing lists and IRC
  12  * channels for your use.
  13  *
  14  * This program is free software, distributed under the terms of
  15  * the GNU General Public License Version 2. See the LICENSE file
  16  * at the top of the source tree.
  17  */
  18
  19 /*! \file
  20  *
  21  * \brief Channel Management
  22  *
  23  * \author Mark Spencer <markster@digium.com>
  24  */
  25
  26 #include "asterisk.h"
  27
  28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <stdarg.h>
  33 #include <string.h>
  34 #include <sys/time.h>
  35 #include <signal.h>
  36 #include <errno.h>
  37 #include <unistd.h>
  38 #include <math.h>
  39
  40 #include "asterisk/zapata.h"
  41
  42 #include "asterisk/pbx.h"
  43 #include "asterisk/frame.h"
  44 #include "asterisk/sched.h"
  45 #include "asterisk/options.h"
  46 #include "asterisk/channel.h"
  47 #include "asterisk/chanspy.h"
  48 #include "asterisk/musiconhold.h"
  49 #include "asterisk/logger.h"
  50 #include "asterisk/say.h"
  51 #include "asterisk/file.h"
  52 #include "asterisk/cli.h"
  53 #include "asterisk/translate.h"
  54 #include "asterisk/manager.h"
  55 #include "asterisk/chanvars.h"
  56 #include "asterisk/linkedlists.h"
  57 #include "asterisk/indications.h"
  58 #include "asterisk/monitor.h"
  59 #include "asterisk/causes.h"
  60 #include "asterisk/callerid.h"
  61 #include "asterisk/utils.h"
  62 #include "asterisk/lock.h"
  63 #include "asterisk/app.h"
  64 #include "asterisk/transcap.h"
  65 #include "asterisk/devicestate.h"
  66 #include "asterisk/sha1.h"
  67 #include "asterisk/threadstorage.h"
  68 #include "asterisk/slinfactory.h"
  69
  70 struct channel_spy_trans {
  71         int last_format;
  72         struct ast_trans_pvt *path;
  73 };
  74
  75 /*! \brief List of SPY structures
  76 */
  77 struct ast_channel_spy_list {
  78         struct channel_spy_trans read_translator;
  79         struct channel_spy_trans write_translator;
  80         AST_LIST_HEAD_NOLOCK(, ast_channel_spy) list;
  81 };
  82
  83 /*! \brief Definition of the Whisper buffer */
  84 struct ast_channel_whisper_buffer {
  85         ast_mutex_t lock;
  86         struct ast_slinfactory sf;
  87         unsigned int original_format;
  88         struct ast_trans_pvt *path;
  89 };
  90
  91 /* uncomment if you have problems with 'monitoring' synchronized files */
  92 #if 0
  93 #define MONITOR_CONSTANT_DELAY
  94 #define MONITOR_DELAY   150 * 8         /*!< 150 ms of MONITORING DELAY */
  95 #endif
  96
  97 /*! \brief Prevent new channel allocation if shutting down. */
  98 static int shutting_down;
  99
 100 static int uniqueint;
 101
 102 unsigned long global_fin, global_fout;
 103
 104 AST_THREADSTORAGE(state2str_threadbuf);
 105 #define STATE2STR_BUFSIZE   32
 106
 107 /*! Default amount of time to use when emulating a digit as a begin and end
 108  *  100ms */
 109 #define AST_DEFAULT_EMULATE_DTMF_DURATION 100
 110
 111 /*! Minimum allowed digit length - 80ms */
 112 #define AST_MIN_DTMF_DURATION 80
 113
 114 /*! Minimum amount of time between the end of the last digit and the beginning
 115  *  of a new one - 45ms */
 116 #define AST_MIN_DTMF_GAP 45
 117
 118 /*! \brief List of channel drivers */
 119 struct chanlist {
 120         const struct ast_channel_tech *tech;
 121         AST_LIST_ENTRY(chanlist) list;
 122 };
 123
 124 /*! \brief the list of registered channel types */
 125 static AST_LIST_HEAD_NOLOCK_STATIC(backends, chanlist);
 126
 127 /*! \brief the list of channels we have. Note that the lock for this list is used for
 128     both the channels list and the backends list.  */
 129 static AST_RWLIST_HEAD_STATIC(channels, ast_channel);
 130
 131 /*! \brief map AST_CAUSE's to readable string representations
 132  *
 133  * \ref causes.h
 134 */
 135 const struct ast_cause {
 136         int cause;
 137         const char *name;
 138         const char *desc;
 139 } causes[] = {
 140         { AST_CAUSE_UNALLOCATED, "UNALLOCATED", "Unallocated (unassigned) number" },
 141         { AST_CAUSE_NO_ROUTE_TRANSIT_NET, "NO_ROUTE_TRANSIT_NET", "No route to specified transmit network" },
 142         { AST_CAUSE_NO_ROUTE_DESTINATION, "NO_ROUTE_DESTINATION", "No route to destination" },
 143         { AST_CAUSE_CHANNEL_UNACCEPTABLE, "CHANNEL_UNACCEPTABLE", "Channel unacceptable" },
 144         { AST_CAUSE_CALL_AWARDED_DELIVERED, "CALL_AWARDED_DELIVERED", "Call awarded and being delivered in an established channel" },
 145         { AST_CAUSE_NORMAL_CLEARING, "NORMAL_CLEARING", "Normal Clearing" },
 146         { AST_CAUSE_USER_BUSY, "USER_BUSY", "User busy" },
 147         { AST_CAUSE_NO_USER_RESPONSE, "NO_USER_RESPONSE", "No user responding" },
 148         { AST_CAUSE_NO_ANSWER, "NO_ANSWER", "User alerting, no answer" },
 149         { AST_CAUSE_CALL_REJECTED, "CALL_REJECTED", "Call Rejected" },
 150         { AST_CAUSE_NUMBER_CHANGED, "NUMBER_CHANGED", "Number changed" },
 151         { AST_CAUSE_DESTINATION_OUT_OF_ORDER, "DESTINATION_OUT_OF_ORDER", "Destination out of order" },
 152         { AST_CAUSE_INVALID_NUMBER_FORMAT, "INVALID_NUMBER_FORMAT", "Invalid number format" },
 153         { AST_CAUSE_FACILITY_REJECTED, "FACILITY_REJECTED", "Facility rejected" },
 154         { AST_CAUSE_RESPONSE_TO_STATUS_ENQUIRY, "RESPONSE_TO_STATUS_ENQUIRY", "Response to STATus ENQuiry" },
 155         { AST_CAUSE_NORMAL_UNSPECIFIED, "NORMAL_UNSPECIFIED", "Normal, unspecified" },
 156         { AST_CAUSE_NORMAL_CIRCUIT_CONGESTION, "NORMAL_CIRCUIT_CONGESTION", "Circuit/channel congestion" },
 157         { AST_CAUSE_NETWORK_OUT_OF_ORDER, "NETWORK_OUT_OF_ORDER", "Network out of order" },
 158         { AST_CAUSE_NORMAL_TEMPORARY_FAILURE, "NORMAL_TEMPORARY_FAILURE", "Temporary failure" },
 159         { AST_CAUSE_SWITCH_CONGESTION, "SWITCH_CONGESTION", "Switching equipment congestion" },
 160         { AST_CAUSE_ACCESS_INFO_DISCARDED, "ACCESS_INFO_DISCARDED", "Access information discarded" },
 161         { AST_CAUSE_REQUESTED_CHAN_UNAVAIL, "REQUESTED_CHAN_UNAVAIL", "Requested channel not available" },
 162         { AST_CAUSE_PRE_EMPTED, "PRE_EMPTED", "Pre-empted" },
 163         { AST_CAUSE_FACILITY_NOT_SUBSCRIBED, "FACILITY_NOT_SUBSCRIBED", "Facility not subscribed" },
 164         { AST_CAUSE_OUTGOING_CALL_BARRED, "OUTGOING_CALL_BARRED", "Outgoing call barred" },
 165         { AST_CAUSE_INCOMING_CALL_BARRED, "INCOMING_CALL_BARRED", "Incoming call barred" },
 166         { AST_CAUSE_BEARERCAPABILITY_NOTAUTH, "BEARERCAPABILITY_NOTAUTH", "Bearer capability not authorized" },
 167         { AST_CAUSE_BEARERCAPABILITY_NOTAVAIL, "BEARERCAPABILITY_NOTAVAIL", "Bearer capability not available" },
 168         { AST_CAUSE_BEARERCAPABILITY_NOTIMPL, "BEARERCAPABILITY_NOTIMPL", "Bearer capability not implemented" },
 169         { AST_CAUSE_CHAN_NOT_IMPLEMENTED, "CHAN_NOT_IMPLEMENTED", "Channel not implemented" },
 170         { AST_CAUSE_FACILITY_NOT_IMPLEMENTED, "FACILITY_NOT_IMPLEMENTED", "Facility not implemented" },
 171         { AST_CAUSE_INVALID_CALL_REFERENCE, "INVALID_CALL_REFERENCE", "Invalid call reference value" },
 172         { AST_CAUSE_INCOMPATIBLE_DESTINATION, "INCOMPATIBLE_DESTINATION", "Incompatible destination" },
 173         { AST_CAUSE_INVALID_MSG_UNSPECIFIED, "INVALID_MSG_UNSPECIFIED", "Invalid message unspecified" },
 174         { AST_CAUSE_MANDATORY_IE_MISSING, "MANDATORY_IE_MISSING", "Mandatory information element is missing" },
 175         { AST_CAUSE_MESSAGE_TYPE_NONEXIST, "MESSAGE_TYPE_NONEXIST", "Message type nonexist." },
 176         { AST_CAUSE_WRONG_MESSAGE, "WRONG_MESSAGE", "Wrong message" },
 177         { AST_CAUSE_IE_NONEXIST, "IE_NONEXIST", "Info. element nonexist or not implemented" },
 178         { AST_CAUSE_INVALID_IE_CONTENTS, "INVALID_IE_CONTENTS", "Invalid information element contents" },
 179         { AST_CAUSE_WRONG_CALL_STATE, "WRONG_CALL_STATE", "Message not compatible with call state" },
 180         { AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE, "RECOVERY_ON_TIMER_EXPIRE", "Recover on timer expiry" },
 181         { AST_CAUSE_MANDATORY_IE_LENGTH_ERROR, "MANDATORY_IE_LENGTH_ERROR", "Mandatory IE length error" },
 182         { AST_CAUSE_PROTOCOL_ERROR, "PROTOCOL_ERROR", "Protocol error, unspecified" },
 183         { AST_CAUSE_INTERWORKING, "INTERWORKING", "Interworking, unspecified" },
 184 };
 185
 186 struct ast_variable *ast_channeltype_list(void)
 187 {
 188         struct chanlist *cl;
 189         struct ast_variable *var=NULL, *prev = NULL;
 190         AST_LIST_TRAVERSE(&backends, cl, list) {
 191                 if (prev)  {
 192                         if ((prev->next = ast_variable_new(cl->tech->type, cl->tech->description)))
 193                                 prev = prev->next;
 194                 } else {
 195                         var = ast_variable_new(cl->tech->type, cl->tech->description);
 196                         prev = var;
 197                 }
 198         }
 199         return var;
 200 }
 201
 202 /*! \brief Show channel types - CLI command */
 203 static int show_channeltypes(int fd, int argc, char *argv[])
 204 {
 205 #define FORMAT  "%-10.10s  %-40.40s %-12.12s %-12.12s %-12.12s\n"
 206         struct chanlist *cl;
 207         int count_chan = 0;
 208
 209         ast_cli(fd, FORMAT, "Type", "Description",       "Devicestate", "Indications", "Transfer");
 210         ast_cli(fd, FORMAT, "----------", "-----------", "-----------", "-----------", "--------");
 211         if (AST_RWLIST_RDLOCK(&channels)) {
 212                 ast_log(LOG_WARNING, "Unable to lock channel list\n");
 213                 return -1;
 214         }
 215         AST_LIST_TRAVERSE(&backends, cl, list) {
 216                 ast_cli(fd, FORMAT, cl->tech->type, cl->tech->description,
 217                         (cl->tech->devicestate) ? "yes" : "no",
 218                         (cl->tech->indicate) ? "yes" : "no",
 219                         (cl->tech->transfer) ? "yes" : "no");
 220                 count_chan++;
 221         }
 222         AST_RWLIST_UNLOCK(&channels);
 223         ast_cli(fd, "----------\n%d channel drivers registered.\n", count_chan);
 224         return RESULT_SUCCESS;
 225
 226 #undef FORMAT
 227
 228 }
 229
 230 /*! \brief Show details about a channel driver - CLI command */
 231 static int show_channeltype(int fd, int argc, char *argv[])
 232 {
 233         struct chanlist *cl = NULL;
 234
 235         if (argc != 4)
 236                 return RESULT_SHOWUSAGE;
 237
 238         if (AST_RWLIST_RDLOCK(&channels)) {
 239                 ast_log(LOG_WARNING, "Unable to lock channel list\n");
 240                 return RESULT_FAILURE;
 241         }
 242
 243         AST_LIST_TRAVERSE(&backends, cl, list) {
 244                 if (!strncasecmp(cl->tech->type, argv[3], strlen(cl->tech->type))) {
 245                         break;
 246                 }
 247         }
 248
 249
 250         if (!cl) {
 251                 ast_cli(fd, "\n%s is not a registered channel driver.\n", argv[3]);
 252                 AST_RWLIST_UNLOCK(&channels);
 253                 return RESULT_FAILURE;
 254         }
 255
 256         ast_cli(fd,
 257                 "-- Info about channel driver: %s --\n"
 258                 "  Device State: %s\n"
 259                 "    Indication: %s\n"
 260                 "     Transfer : %s\n"
 261                 "  Capabilities: %d\n"
 262                 "   Digit Begin: %s\n"
 263                 "     Digit End: %s\n"
 264                 "    Send HTML : %s\n"
 265                 " Image Support: %s\n"
 266                 "  Text Support: %s\n",
 267                 cl->tech->type,
 268                 (cl->tech->devicestate) ? "yes" : "no",
 269                 (cl->tech->indicate) ? "yes" : "no",
 270                 (cl->tech->transfer) ? "yes" : "no",
 271                 (cl->tech->capabilities) ? cl->tech->capabilities : -1,
 272                 (cl->tech->send_digit_begin) ? "yes" : "no",
 273                 (cl->tech->send_digit_end) ? "yes" : "no",
 274                 (cl->tech->send_html) ? "yes" : "no",
 275                 (cl->tech->send_image) ? "yes" : "no",
 276                 (cl->tech->send_text) ? "yes" : "no"
 277
 278         );
 279
 280         AST_RWLIST_UNLOCK(&channels);
 281         return RESULT_SUCCESS;
 282 }
 283
 284 static char *complete_channeltypes(const char *line, const char *word, int pos, int state)
 285 {
 286         struct chanlist *cl;
 287         int which = 0;
 288         int wordlen;
 289         char *ret = NULL;
 290
 291         if (pos != 3)
 292                 return NULL;
 293
 294         wordlen = strlen(word);
 295
 296         AST_LIST_TRAVERSE(&backends, cl, list) {
 297                 if (!strncasecmp(word, cl->tech->type, wordlen) && ++which > state) {
 298                         ret = ast_strdup(cl->tech->type);
 299                         break;
 300                 }
 301         }
 302
 303         return ret;
 304 }
 305
 306 static const char show_channeltypes_usage[] =
 307 "Usage: core show channeltypes\n"
 308 "       Lists available channel types registered in your Asterisk server.\n";
 309
 310 static const char show_channeltype_usage[] =
 311 "Usage: core show channeltype <name>\n"
 312 "       Show details about the specified channel type, <name>.\n";
 313
 314 static struct ast_cli_entry cli_channel[] = {
 315         { { "core", "show", "channeltypes", NULL },
 316         show_channeltypes, "List available channel types",
 317         show_channeltypes_usage },
 318
 319         { { "core", "show", "channeltype", NULL },
 320         show_channeltype, "Give more details on that channel type",
 321         show_channeltype_usage, complete_channeltypes },
 322 };
 323
 324 /*! \brief Checks to see if a channel is needing hang up */
 325 int ast_check_hangup(struct ast_channel *chan)
 326 {
 327         if (chan->_softhangup)          /* yes if soft hangup flag set */
 328                 return 1;
 329         if (!chan->tech_pvt)            /* yes if no technology private data */
 330                 return 1;
 331         if (!chan->whentohangup)        /* no if no hangup scheduled */
 332                 return 0;
 333         if (chan->whentohangup > time(NULL))    /* no if hangup time has not come yet. */
 334                 return 0;
 335         chan->_softhangup |= AST_SOFTHANGUP_TIMEOUT;    /* record event */
 336         return 1;
 337 }
 338
 339 static int ast_check_hangup_locked(struct ast_channel *chan)
 340 {
 341         int res;
 342         ast_channel_lock(chan);
 343         res = ast_check_hangup(chan);
 344         ast_channel_unlock(chan);
 345         return res;
 346 }
 347
 348 /*! \brief Initiate system shutdown */
 349 void ast_begin_shutdown(int hangup)
 350 {
 351         struct ast_channel *c;
 352         shutting_down = 1;
 353         if (hangup) {
 354                 AST_RWLIST_RDLOCK(&channels);
 355                 AST_RWLIST_TRAVERSE(&channels, c, chan_list)
 356                         ast_softhangup(c, AST_SOFTHANGUP_SHUTDOWN);
 357                 AST_RWLIST_UNLOCK(&channels);
 358         }
 359 }
 360
 361 /*! \brief returns number of active/allocated channels */
 362 int ast_active_channels(void)
 363 {
 364         struct ast_channel *c;
 365         int cnt = 0;
 366         AST_RWLIST_RDLOCK(&channels);
 367         AST_RWLIST_TRAVERSE(&channels, c, chan_list)
 368                 cnt++;
 369         AST_RWLIST_UNLOCK(&channels);
 370         return cnt;
 371 }
 372
 373 /*! \brief Cancel a shutdown in progress */
 374 void ast_cancel_shutdown(void)
 375 {
 376         shutting_down = 0;
 377 }
 378
 379 /*! \brief Returns non-zero if Asterisk is being shut down */
 380 int ast_shutting_down(void)
 381 {
 382         return shutting_down;
 383 }
 384
 385 /*! \brief Set when to hangup channel */
 386 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset)
 387 {
 388         chan->whentohangup = offset ? time(NULL) + offset : 0;
 389         ast_queue_frame(chan, &ast_null_frame);
 390         return;
 391 }
 392
 393 /*! \brief Compare a offset with when to hangup channel */
 394 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset)
 395 {
 396         time_t whentohangup;
 397
 398         if (!chan->whentohangup)
 399                 return (offset == 0) ? 0 : -1;
 400
 401         if (!offset) /* XXX why is this special? */
 402                 return 1;
 403
 404         whentohangup = offset + time(NULL);
 405
 406         if (chan->whentohangup < whentohangup)
 407                 return 1;
 408         else if (chan->whentohangup == whentohangup)
 409                 return 0;
 410         else
 411                 return -1;
 412 }
 413
 414 /*! \brief Register a new telephony channel in Asterisk */
 415 int ast_channel_register(const struct ast_channel_tech *tech)
 416 {
 417         struct chanlist *chan;
 418
 419         AST_RWLIST_WRLOCK(&channels);
 420
 421         AST_LIST_TRAVERSE(&backends, chan, list) {
 422                 if (!strcasecmp(tech->type, chan->tech->type)) {
 423                         ast_log(LOG_WARNING, "Already have a handler for type '%s'\n", tech->type);
 424                         AST_RWLIST_UNLOCK(&channels);
 425                         return -1;
 426                 }
 427         }
 428
 429         if (!(chan = ast_calloc(1, sizeof(*chan)))) {
 430                 AST_RWLIST_UNLOCK(&channels);
 431                 return -1;
 432         }
 433         chan->tech = tech;
 434         AST_LIST_INSERT_HEAD(&backends, chan, list);
 435
 436         ast_debug(1, "Registered handler for '%s' (%s)\n", chan->tech->type, chan->tech->description);
 437
 438         if (option_verbose > 1)
 439                 ast_verbose(VERBOSE_PREFIX_2 "Registered channel type '%s' (%s)\n", chan->tech->type,
 440                             chan->tech->description);
 441
 442         AST_RWLIST_UNLOCK(&channels);
 443         return 0;
 444 }
 445
 446 /*! \brief Unregister channel driver */
 447 void ast_channel_unregister(const struct ast_channel_tech *tech)
 448 {
 449         struct chanlist *chan;
 450
 451         ast_debug(1, "Unregistering channel type '%s'\n", tech->type);
 452
 453         AST_RWLIST_WRLOCK(&channels);
 454
 455         AST_LIST_TRAVERSE_SAFE_BEGIN(&backends, chan, list) {
 456                 if (chan->tech == tech) {
 457                         AST_LIST_REMOVE_CURRENT(&backends, list);
 458                         ast_free(chan);
 459                         if (option_verbose > 1)
 460                                 ast_verbose(VERBOSE_PREFIX_2 "Unregistered channel type '%s'\n", tech->type);
 461                         break;
 462                 }
 463         }
 464         AST_LIST_TRAVERSE_SAFE_END
 465
 466         AST_RWLIST_UNLOCK(&channels);
 467 }
 468
 469 /*! \brief Get handle to channel driver based on name */
 470 const struct ast_channel_tech *ast_get_channel_tech(const char *name)
 471 {
 472         struct chanlist *chanls;
 473         const struct ast_channel_tech *ret = NULL;
 474
 475         if (AST_RWLIST_RDLOCK(&channels)) {
 476                 ast_log(LOG_WARNING, "Unable to lock channel tech list\n");
 477                 return NULL;
 478         }
 479
 480         AST_LIST_TRAVERSE(&backends, chanls, list) {
 481                 if (!strcasecmp(name, chanls->tech->type)) {
 482                         ret = chanls->tech;
 483                         break;
 484                 }
 485         }
 486
 487         AST_RWLIST_UNLOCK(&channels);
 488
 489         return ret;
 490 }
 491
 492 /*! \brief Gives the string form of a given hangup cause */
 493 const char *ast_cause2str(int cause)
 494 {
 495         int x;
 496
 497         for (x=0; x < sizeof(causes) / sizeof(causes[0]); x++) {
 498                 if (causes[x].cause == cause)
 499                         return causes[x].desc;
 500         }
 501
 502         return "Unknown";
 503 }
 504
 505 /*! \brief Convert a symbolic hangup cause to number */
 506 int ast_str2cause(const char *name)
 507 {
 508         int x;
 509
 510         for (x = 0; x < sizeof(causes) / sizeof(causes[0]); x++)
 511                 if (strncasecmp(causes[x].name, name, strlen(causes[x].name)) == 0)
 512                         return causes[x].cause;
 513
 514         return -1;
 515 }
 516
 517 /*! \brief Gives the string form of a given channel state.
 518         \note This function is not reentrant.
 519  */
 520 const char *ast_state2str(enum ast_channel_state state)
 521 {
 522         char *buf;
 523
 524         switch (state) {
 525         case AST_STATE_DOWN:
 526                 return "Down";
 527         case AST_STATE_RESERVED:
 528                 return "Rsrvd";
 529         case AST_STATE_OFFHOOK:
 530                 return "OffHook";
 531         case AST_STATE_DIALING:
 532                 return "Dialing";
 533         case AST_STATE_RING:
 534                 return "Ring";
 535         case AST_STATE_RINGING:
 536                 return "Ringing";
 537         case AST_STATE_UP:
 538                 return "Up";
 539         case AST_STATE_BUSY:
 540                 return "Busy";
 541         case AST_STATE_DIALING_OFFHOOK:
 542                 return "Dialing Offhook";
 543         case AST_STATE_PRERING:
 544                 return "Pre-ring";
 545         default:
 546                 if (!(buf = ast_threadstorage_get(&state2str_threadbuf, STATE2STR_BUFSIZE)))
 547                         return "Unknown";
 548                 snprintf(buf, STATE2STR_BUFSIZE, "Unknown (%d)", state);
 549                 return buf;
 550         }
 551 }
 552
 553 /*! \brief Gives the string form of a given transfer capability */
 554 char *ast_transfercapability2str(int transfercapability)
 555 {
 556         switch (transfercapability) {
 557         case AST_TRANS_CAP_SPEECH:
 558                 return "SPEECH";
 559         case AST_TRANS_CAP_DIGITAL:
 560                 return "DIGITAL";
 561         case AST_TRANS_CAP_RESTRICTED_DIGITAL:
 562                 return "RESTRICTED_DIGITAL";
 563         case AST_TRANS_CAP_3_1K_AUDIO:
 564                 return "3K1AUDIO";
 565         case AST_TRANS_CAP_DIGITAL_W_TONES:
 566                 return "DIGITAL_W_TONES";
 567         case AST_TRANS_CAP_VIDEO:
 568                 return "VIDEO";
 569         default:
 570                 return "UNKNOWN";
 571         }
 572 }
 573
 574 /*! \brief Pick the best audio codec */
 575 int ast_best_codec(int fmts)
 576 {
 577         /* This just our opinion, expressed in code.  We are asked to choose
 578            the best codec to use, given no information */
 579         int x;
 580         static const int prefs[] =
 581         {
 582                 /*! Okay, ulaw is used by all telephony equipment, so start with it */
 583                 AST_FORMAT_ULAW,
 584                 /*! Unless of course, you're a silly European, so then prefer ALAW */
 585                 AST_FORMAT_ALAW,
 586                 /*! G.722 is better then all below, but not as common as the above... so give ulaw and alaw priority */
 587                 AST_FORMAT_G722,
 588                 /*! Okay, well, signed linear is easy to translate into other stuff */
 589                 AST_FORMAT_SLINEAR,
 590                 /*! G.726 is standard ADPCM, in RFC3551 packing order */
 591                 AST_FORMAT_G726,
 592                 /*! G.726 is standard ADPCM, in AAL2 packing order */
 593                 AST_FORMAT_G726_AAL2,
 594                 /*! ADPCM has great sound quality and is still pretty easy to translate */
 595                 AST_FORMAT_ADPCM,
 596                 /*! Okay, we're down to vocoders now, so pick GSM because it's small and easier to
 597                     translate and sounds pretty good */
 598                 AST_FORMAT_GSM,
 599                 /*! iLBC is not too bad */
 600                 AST_FORMAT_ILBC,
 601                 /*! Speex is free, but computationally more expensive than GSM */
 602                 AST_FORMAT_SPEEX,
 603                 /*! Ick, LPC10 sounds terrible, but at least we have code for it, if you're tacky enough
 604                     to use it */
 605                 AST_FORMAT_LPC10,
 606                 /*! G.729a is faster than 723 and slightly less expensive */
 607                 AST_FORMAT_G729A,
 608                 /*! Down to G.723.1 which is proprietary but at least designed for voice */
 609                 AST_FORMAT_G723_1,
 610         };
 611
 612         /* Strip out video */
 613         fmts &= AST_FORMAT_AUDIO_MASK;
 614
 615         /* Find the first preferred codec in the format given */
 616         for (x=0; x < (sizeof(prefs) / sizeof(prefs[0]) ); x++)
 617                 if (fmts & prefs[x])
 618                         return prefs[x];
 619         ast_log(LOG_WARNING, "Don't know any of 0x%x formats\n", fmts);
 620         return 0;
 621 }
 622
 623 static const struct ast_channel_tech null_tech = {
 624         .type = "NULL",
 625         .description = "Null channel (should not see this)",
 626 };
 627
 628 /*! \brief Create a new channel structure */
 629 struct ast_channel *ast_channel_alloc(int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const int amaflag, const char *name_fmt, ...)
 630 {
 631         struct ast_channel *tmp;
 632         int x;
 633         int flags;
 634         struct varshead *headp;
 635         va_list ap1, ap2;
 636
 637         /* If shutting down, don't allocate any new channels */
 638         if (shutting_down) {
 639                 ast_log(LOG_WARNING, "Channel allocation failed: Refusing due to active shutdown\n");
 640                 return NULL;
 641         }
 642
 643         if (!(tmp = ast_calloc(1, sizeof(*tmp))))
 644                 return NULL;
 645
 646         if (!(tmp->sched = sched_context_create())) {
 647                 ast_log(LOG_WARNING, "Channel allocation failed: Unable to create schedule context\n");
 648                 ast_free(tmp);
 649                 return NULL;
 650         }
 651
 652         if ((ast_string_field_init(tmp, 128))) {
 653                 sched_context_destroy(tmp->sched);
 654                 ast_free(tmp);
 655                 return NULL;
 656         }
 657
 658         /* Don't bother initializing the last two FD here, because they
 659            will *always* be set just a few lines down (AST_TIMING_FD,
 660            AST_ALERT_FD). */
 661         for (x = 0; x < AST_MAX_FDS - 2; x++)
 662                 tmp->fds[x] = -1;
 663
 664 #ifdef HAVE_ZAPTEL
 665         tmp->timingfd = open("/dev/zap/timer", O_RDWR);
 666         if (tmp->timingfd > -1) {
 667                 /* Check if timing interface supports new
 668                    ping/pong scheme */
 669                 flags = 1;
 670                 if (!ioctl(tmp->timingfd, ZT_TIMERPONG, &flags))
 671                         needqueue = 0;
 672         }
 673 #else
 674         tmp->timingfd = -1;
 675 #endif
 676
 677         if (needqueue) {
 678                 if (pipe(tmp->alertpipe)) {
 679                         ast_log(LOG_WARNING, "Channel allocation failed: Can't create alert pipe!\n");
 680                         ast_string_field_free_pools(tmp);
 681                         ast_free(tmp);
 682                         return NULL;
 683                 } else {
 684                         flags = fcntl(tmp->alertpipe[0], F_GETFL);
 685                         fcntl(tmp->alertpipe[0], F_SETFL, flags | O_NONBLOCK);
 686                         flags = fcntl(tmp->alertpipe[1], F_GETFL);
 687                         fcntl(tmp->alertpipe[1], F_SETFL, flags | O_NONBLOCK);
 688                 }
 689         } else  /* Make sure we've got it done right if they don't */
 690                 tmp->alertpipe[0] = tmp->alertpipe[1] = -1;
 691
 692         /* Always watch the alertpipe */
 693         tmp->fds[AST_ALERT_FD] = tmp->alertpipe[0];
 694         /* And timing pipe */
 695         tmp->fds[AST_TIMING_FD] = tmp->timingfd;
 696         ast_string_field_set(tmp, name, "**Unknown**");
 697
 698         /* Initial state */
 699         tmp->_state = state;
 700
 701         tmp->streamid = -1;
 702
 703         tmp->fin = global_fin;
 704         tmp->fout = global_fout;
 705
 706         if (ast_strlen_zero(ast_config_AST_SYSTEM_NAME)) {
 707                 ast_string_field_build(tmp, uniqueid, "%li.%d", (long) time(NULL),
 708                                        ast_atomic_fetchadd_int(&uniqueint, 1));
 709         } else {
 710                 ast_string_field_build(tmp, uniqueid, "%s-%li.%d", ast_config_AST_SYSTEM_NAME,
 711                                        (long) time(NULL), ast_atomic_fetchadd_int(&uniqueint, 1));
 712         }
 713
 714         tmp->cid.cid_name = ast_strdup(cid_name);
 715         tmp->cid.cid_num = ast_strdup(cid_num);
 716
 717         if (!ast_strlen_zero(name_fmt)) {
 718                 /* Almost every channel is calling this function, and setting the name via the ast_string_field_build() call.
 719                  * And they all use slightly different formats for their name string.
 720                  * This means, to set the name here, we have to accept variable args, and call the string_field_build from here.
 721                  * This means, that the stringfields must have a routine that takes the va_lists directly, and
 722                  * uses them to build the string, instead of forming the va_lists internally from the vararg ... list.
 723                  * This new function was written so this can be accomplished.
 724                  */
 725                 va_start(ap1, name_fmt);
 726                 va_start(ap2, name_fmt);
 727                 ast_string_field_build_va(tmp, name, name_fmt, ap1, ap2);
 728                 va_end(ap1);
 729                 va_end(ap2);
 730
 731                 /* and now, since the channel structure is built, and has its name, let's call the
 732                  * manager event generator with this Newchannel event. This is the proper and correct
 733                  * place to make this call, but you sure do have to pass a lot of data into this func
 734                  * to do it here!
 735                  */
 736                 manager_event(EVENT_FLAG_CALL, "Newchannel",
 737                               "Channel: %s\r\n"
 738                               "State: %s\r\n"
 739                               "CallerIDNum: %s\r\n"
 740                               "CallerIDName: %s\r\n"
 741                               "Uniqueid: %s\r\n",
 742                               tmp->name, ast_state2str(state),
 743                               S_OR(cid_num, "<unknown>"),
 744                               S_OR(cid_name, "<unknown>"),
 745                               tmp->uniqueid);
 746         }
 747
 748         /* Reminder for the future: under what conditions do we NOT want to track cdrs on channels? */
 749
 750         /* These 4 variables need to be set up for the cdr_init() to work right */
 751         if (amaflag)
 752                 tmp->amaflags = amaflag;
 753         else
 754                 tmp->amaflags = ast_default_amaflags;
 755
 756         if (!ast_strlen_zero(acctcode))
 757                 ast_string_field_set(tmp, accountcode, acctcode);
 758         else
 759                 ast_string_field_set(tmp, accountcode, ast_default_accountcode);
 760
 761         if (!ast_strlen_zero(context))
 762                 ast_copy_string(tmp->context, context, sizeof(tmp->context));
 763         else
 764                 strcpy(tmp->context, "default");
 765
 766         if (!ast_strlen_zero(exten))
 767                 ast_copy_string(tmp->exten, exten, sizeof(tmp->exten));
 768         else
 769                 strcpy(tmp->exten, "s");
 770
 771         tmp->priority = 1;
 772
 773         tmp->cdr = ast_cdr_alloc();
 774         ast_cdr_init(tmp->cdr, tmp);
 775         ast_cdr_start(tmp->cdr);
 776
 777         headp = &tmp->varshead;
 778         AST_LIST_HEAD_INIT_NOLOCK(headp);
 779
 780         ast_mutex_init(&tmp->lock);
 781
 782         AST_LIST_HEAD_INIT_NOLOCK(&tmp->datastores);
 783
 784         ast_string_field_set(tmp, language, defaultlanguage);
 785
 786         tmp->tech = &null_tech;
 787
 788         AST_RWLIST_WRLOCK(&channels);
 789         AST_RWLIST_INSERT_HEAD(&channels, tmp, chan_list);
 790         AST_RWLIST_UNLOCK(&channels);
 791
 792         return tmp;
 793 }
 794
 795 /*! \brief Queue an outgoing media frame */
 796 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *fin)
 797 {
 798         struct ast_frame *f;
 799         struct ast_frame *cur;
 800         int blah = 1;
 801         int qlen = 0;
 802
 803         /* Build us a copy and free the original one */
 804         if (!(f = ast_frdup(fin))) {
 805                 ast_log(LOG_WARNING, "Unable to duplicate frame\n");
 806                 return -1;
 807         }
 808         ast_channel_lock(chan);
 809
 810         /* See if the last frame on the queue is a hangup, if so don't queue anything */
 811         if ((cur = AST_LIST_LAST(&chan->readq)) && (cur->frametype == AST_FRAME_CONTROL) && (cur->subclass == AST_CONTROL_HANGUP)) {
 812                 ast_frfree(f);
 813                 ast_channel_unlock(chan);
 814                 return 0;
 815         }
 816
 817         /* Count how many frames exist on the queue */
 818         AST_LIST_TRAVERSE(&chan->readq, cur, frame_list) {
 819                 qlen++;
 820         }
 821
 822         /* Allow up to 96 voice frames outstanding, and up to 128 total frames */
 823         if (((fin->frametype == AST_FRAME_VOICE) && (qlen > 96)) || (qlen  > 128)) {
 824                 if (fin->frametype != AST_FRAME_VOICE) {
 825                         ast_log(LOG_WARNING, "Exceptionally long queue length queuing to %s\n", chan->name);
 826                         CRASH;
 827                 } else {
 828                         ast_debug(1, "Dropping voice to exceptionally long queue on %s\n", chan->name);
 829                         ast_frfree(f);
 830                         ast_channel_unlock(chan);
 831                         return 0;
 832                 }
 833         }
 834         AST_LIST_INSERT_TAIL(&chan->readq, f, frame_list);
 835         if (chan->alertpipe[1] > -1) {
 836                 if (write(chan->alertpipe[1], &blah, sizeof(blah)) != sizeof(blah))
 837                         ast_log(LOG_WARNING, "Unable to write to alert pipe on %s, frametype/subclass %d/%d (qlen = %d): %s!\n",
 838                                 chan->name, f->frametype, f->subclass, qlen, strerror(errno));
 839 #ifdef HAVE_ZAPTEL
 840         } else if (chan->timingfd > -1) {
 841                 ioctl(chan->timingfd, ZT_TIMERPING, &blah);
 842 #endif
 843         } else if (ast_test_flag(chan, AST_FLAG_BLOCKING)) {
 844                 pthread_kill(chan->blocker, SIGURG);
 845         }
 846         ast_channel_unlock(chan);
 847         return 0;
 848 }
 849
 850 /*! \brief Queue a hangup frame for channel */
 851 int ast_queue_hangup(struct ast_channel *chan)
 852 {
 853         struct ast_frame f = { AST_FRAME_CONTROL, AST_CONTROL_HANGUP };
 854         /* Yeah, let's not change a lock-critical value without locking */
 855         if (!ast_channel_trylock(chan)) {
 856                 chan->_softhangup |= AST_SOFTHANGUP_DEV;
 857                 ast_channel_unlock(chan);
 858         }
 859         return ast_queue_frame(chan, &f);
 860 }
 861
 862 /*! \brief Queue a control frame */
 863 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control)
 864 {
 865         struct ast_frame f = { AST_FRAME_CONTROL, };
 866
 867         f.subclass = control;
 868
 869         return ast_queue_frame(chan, &f);
 870 }
 871
 872 /*! \brief Queue a control frame with payload */
 873 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
 874                            const void *data, size_t datalen)
 875 {
 876         struct ast_frame f = { AST_FRAME_CONTROL, };
 877
 878         f.subclass = control;
 879         f.data = (void *) data;
 880         f.datalen = datalen;
 881
 882         return ast_queue_frame(chan, &f);
 883 }
 884
 885 /*! \brief Set defer DTMF flag on channel */
 886 int ast_channel_defer_dtmf(struct ast_channel *chan)
 887 {
 888         int pre = 0;
 889
 890         if (chan) {
 891                 pre = ast_test_flag(chan, AST_FLAG_DEFER_DTMF);
 892                 ast_set_flag(chan, AST_FLAG_DEFER_DTMF);
 893         }
 894         return pre;
 895 }
 896
 897 /*! \brief Unset defer DTMF flag on channel */
 898 void ast_channel_undefer_dtmf(struct ast_channel *chan)
 899 {
 900         if (chan)
 901                 ast_clear_flag(chan, AST_FLAG_DEFER_DTMF);
 902 }
 903
 904 /*!
 905  * \brief Helper function to find channels.
 906  *
 907  * It supports these modes:
 908  *
 909  * prev != NULL : get channel next in list after prev
 910  * name != NULL : get channel with matching name
 911  * name != NULL && namelen != 0 : get channel whose name starts with prefix
 912  * exten != NULL : get channel whose exten or macroexten matches
 913  * context != NULL && exten != NULL : get channel whose context or macrocontext
 914  *
 915  * It returns with the channel's lock held. If getting the individual lock fails,
 916  * unlock and retry quickly up to 10 times, then give up.
 917  *
 918  * \note XXX Note that this code has cost O(N) because of the need to verify
 919  * that the object is still on the global list.
 920  *
 921  * \note XXX also note that accessing fields (e.g. c->name in ast_log())
 922  * can only be done with the lock held or someone could delete the
 923  * object while we work on it. This causes some ugliness in the code.
 924  * Note that removing the first ast_log() may be harmful, as it would
 925  * shorten the retry period and possibly cause failures.
 926  * We should definitely go for a better scheme that is deadlock-free.
 927  */
 928 static struct ast_channel *channel_find_locked(const struct ast_channel *prev,
 929                                                const char *name, const int namelen,
 930                                                const char *context, const char *exten)
 931 {
 932         const char *msg = prev ? "deadlock" : "initial deadlock";
 933         int retries;
 934         struct ast_channel *c;
 935
 936         for (retries = 0; retries < 10; retries++) {
 937                 int done;
 938                 AST_RWLIST_RDLOCK(&channels);
 939                 AST_RWLIST_TRAVERSE(&channels, c, chan_list) {
 940                         if (prev) {     /* look for next item */
 941                                 if (c != prev)  /* not this one */
 942                                         continue;
 943                                 /* found, prepare to return c->next */
 944                                 if ((c = AST_RWLIST_NEXT(c, chan_list)) == NULL) break;
 945                                 /* If prev was the last item on the channel list, then we just
 946                                  * want to return NULL, instead of trying to deref NULL in the
 947                                  * next section.
 948                                  */
 949                                 prev = NULL;
 950                                 /* We want prev to be NULL in case we end up doing more searching through
 951                                  * the channel list to find the channel (ie: name searching). If we didn't
 952                                  * set this to NULL the logic would just blow up
 953                                  */
 954                         }
 955                         if (name) { /* want match by name */
 956                                 if ((!namelen && strcasecmp(c->name, name)) ||
 957                                     (namelen && strncasecmp(c->name, name, namelen)))
 958                                         continue;       /* name match failed */
 959                         } else if (exten) {
 960                                 if (context && strcasecmp(c->context, context) &&
 961                                     strcasecmp(c->macrocontext, context))
 962                                         continue;       /* context match failed */
 963                                 if (strcasecmp(c->exten, exten) &&
 964                                     strcasecmp(c->macroexten, exten))
 965                                         continue;       /* exten match failed */
 966                         }
 967                         /* if we get here, c points to the desired record */
 968                         break;
 969                 }
 970                 /* exit if chan not found or mutex acquired successfully */
 971                 /* this is slightly unsafe, as we _should_ hold the lock to access c->name */
 972                 done = c == NULL || ast_channel_trylock(c) == 0;
 973                 if (!done) {
 974                         ast_debug(1, "Avoiding %s for channel '%p'\n", msg, c);
 975                         if (retries == 9) {
 976                                 /* We are about to fail due to a deadlock, so report this
 977                                  * while we still have the list lock.
 978                                  */
 979                                 ast_debug(1, "Failure, could not lock '%p' after %d retries!\n", c, retries);
 980                                 /* As we have deadlocked, we will skip this channel and
 981                                  * see if there is another match.
 982                                  * NOTE: No point doing this for a full-name match,
 983                                  * as there can be no more matches.
 984                                  */
 985                                 if (!(name && !namelen)) {
 986                                         prev = c;
 987                                         retries = -1;
 988                                 }
 989                         }
 990                 }
 991                 AST_RWLIST_UNLOCK(&channels);
 992                 if (done)
 993                         return c;
 994                 usleep(1);      /* give other threads a chance before retrying */
 995         }
 996
 997         return NULL;
 998 }
 999
1000 /*! \brief Browse channels in use */
1001 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev)
1002 {
1003         return channel_find_locked(prev, NULL, 0, NULL, NULL);
1004 }
1005
1006 /*! \brief Get channel by name and lock it */
1007 struct ast_channel *ast_get_channel_by_name_locked(const char *name)
1008 {
1009         return channel_find_locked(NULL, name, 0, NULL, NULL);
1010 }
1011
1012 /*! \brief Get channel by name prefix and lock it */
1013 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen)
1014 {
1015         return channel_find_locked(NULL, name, namelen, NULL, NULL);
1016 }
1017
1018 /*! \brief Get next channel by name prefix and lock it */
1019 struct ast_channel *ast_walk_channel_by_name_prefix_locked(const struct ast_channel *chan, const char *name,
1020                                                            const int namelen)
1021 {
1022         return channel_find_locked(chan, name, namelen, NULL, NULL);
1023 }
1024
1025 /*! \brief Get channel by exten (and optionally context) and lock it */
1026 struct ast_channel *ast_get_channel_by_exten_locked(const char *exten, const char *context)
1027 {
1028         return channel_find_locked(NULL, NULL, 0, context, exten);
1029 }
1030
1031 /*! \brief Get next channel by exten (and optionally context) and lock it */
1032 struct ast_channel *ast_walk_channel_by_exten_locked(const struct ast_channel *chan, const char *exten,
1033                                                      const char *context)
1034 {
1035         return channel_find_locked(chan, NULL, 0, context, exten);
1036 }
1037
1038 /*! \brief Wait, look for hangups and condition arg */
1039 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data)
1040 {
1041         struct ast_frame *f;
1042
1043         while (ms > 0) {
1044                 if (cond && ((*cond)(data) == 0))
1045                         return 0;
1046                 ms = ast_waitfor(chan, ms);
1047                 if (ms < 0)
1048                         return -1;
1049                 if (ms > 0) {
1050                         f = ast_read(chan);
1051                         if (!f)
1052                                 return -1;
1053                         ast_frfree(f);
1054                 }
1055         }
1056         return 0;
1057 }
1058
1059 /*! \brief Wait, look for hangups */
1060 int ast_safe_sleep(struct ast_channel *chan, int ms)
1061 {
1062         return ast_safe_sleep_conditional(chan, ms, NULL, NULL);
1063 }
1064
1065 static void free_cid(struct ast_callerid *cid)
1066 {
1067         if (cid->cid_dnid)
1068                 ast_free(cid->cid_dnid);
1069         if (cid->cid_num)
1070                 ast_free(cid->cid_num);
1071         if (cid->cid_name)
1072                 ast_free(cid->cid_name);
1073         if (cid->cid_ani)
1074                 ast_free(cid->cid_ani);
1075         if (cid->cid_rdnis)
1076                 ast_free(cid->cid_rdnis);
1077         cid->cid_dnid = cid->cid_num = cid->cid_name = cid->cid_ani = cid->cid_rdnis = NULL;
1078 }
1079
1080 /*! \brief Free a channel structure */
1081 void ast_channel_free(struct ast_channel *chan)
1082 {
1083         int fd;
1084         struct ast_var_t *vardata;
1085         struct ast_frame *f;
1086         struct varshead *headp;
1087         struct ast_datastore *datastore = NULL;
1088         char name[AST_CHANNEL_NAME];
1089
1090         headp=&chan->varshead;
1091
1092         AST_RWLIST_WRLOCK(&channels);
1093         if (!AST_RWLIST_REMOVE(&channels, chan, chan_list)) {
1094                 AST_RWLIST_UNLOCK(&channels);
1095                 ast_log(LOG_ERROR, "Unable to find channel in list to free. Assuming it has already been done.\n");
1096         }
1097         /* Lock and unlock the channel just to be sure nobody
1098            has it locked still */
1099         ast_channel_lock(chan);
1100         ast_channel_unlock(chan);
1101         if (chan->tech_pvt) {
1102                 ast_log(LOG_WARNING, "Channel '%s' may not have been hung up properly\n", chan->name);
1103                 ast_free(chan->tech_pvt);
1104         }
1105
1106         if (chan->sched)
1107                 sched_context_destroy(chan->sched);
1108
1109         ast_copy_string(name, chan->name, sizeof(name));
1110
1111         /* Stop monitoring */
1112         if (chan->monitor)
1113                 chan->monitor->stop( chan, 0 );
1114
1115         /* If there is native format music-on-hold state, free it */
1116         if (chan->music_state)
1117                 ast_moh_cleanup(chan);
1118
1119         /* if someone is whispering on the channel, stop them */
1120         if (chan->whisper)
1121                 ast_channel_whisper_stop(chan);
1122
1123         /* Free translators */
1124         if (chan->readtrans)
1125                 ast_translator_free_path(chan->readtrans);
1126         if (chan->writetrans)
1127                 ast_translator_free_path(chan->writetrans);
1128         if (chan->pbx)
1129                 ast_log(LOG_WARNING, "PBX may not have been terminated properly on '%s'\n", chan->name);
1130         free_cid(&chan->cid);
1131         ast_mutex_destroy(&chan->lock);
1132         /* Close pipes if appropriate */
1133         if ((fd = chan->alertpipe[0]) > -1)
1134                 close(fd);
1135         if ((fd = chan->alertpipe[1]) > -1)
1136                 close(fd);
1137         if ((fd = chan->timingfd) > -1)
1138                 close(fd);
1139         while ((f = AST_LIST_REMOVE_HEAD(&chan->readq, frame_list)))
1140                 ast_frfree(f);
1141
1142         /* Get rid of each of the data stores on the channel */
1143         while ((datastore = AST_LIST_REMOVE_HEAD(&chan->datastores, entry)))
1144                 /* Free the data store */
1145                 ast_channel_datastore_free(datastore);
1146         AST_LIST_HEAD_INIT_NOLOCK(&chan->datastores);
1147
1148         /* loop over the variables list, freeing all data and deleting list items */
1149         /* no need to lock the list, as the channel is already locked */
1150
1151         while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries)))
1152                 ast_var_delete(vardata);
1153
1154         ast_app_group_discard(chan);
1155
1156         /* Destroy the jitterbuffer */
1157         ast_jb_destroy(chan);
1158
1159         ast_string_field_free_pools(chan);
1160         ast_free(chan);
1161         AST_RWLIST_UNLOCK(&channels);
1162
1163         ast_device_state_changed_literal(name);
1164 }
1165
1166 struct ast_datastore *ast_channel_datastore_alloc(const struct ast_datastore_info *info, char *uid)
1167 {
1168         struct ast_datastore *datastore = NULL;
1169
1170         /* Make sure we at least have type so we can identify this */
1171         if (!info) {
1172                 return NULL;
1173         }
1174
1175         /* Allocate memory for datastore and clear it */
1176         datastore = ast_calloc(1, sizeof(*datastore));
1177         if (!datastore) {
1178                 return NULL;
1179         }
1180
1181         datastore->info = info;
1182
1183         datastore->uid = ast_strdup(uid);
1184
1185         return datastore;
1186 }
1187
1188 int ast_channel_datastore_free(struct ast_datastore *datastore)
1189 {
1190         int res = 0;
1191
1192         /* Using the destroy function (if present) destroy the data */
1193         if (datastore->info->destroy != NULL && datastore->data != NULL) {
1194                 datastore->info->destroy(datastore->data);
1195                 datastore->data = NULL;
1196         }
1197
1198         /* Free allocated UID memory */
1199         if (datastore->uid != NULL) {
1200                 ast_free(datastore->uid);
1201                 datastore->uid = NULL;
1202         }
1203
1204         /* Finally free memory used by ourselves */
1205         ast_free(datastore);
1206
1207         return res;
1208 }
1209
1210 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to)
1211 {
1212         struct ast_datastore *datastore = NULL, *datastore2;
1213
1214         AST_LIST_TRAVERSE(&from->datastores, datastore, entry) {
1215                 if (datastore->inheritance > 0) {
1216                         datastore2 = ast_channel_datastore_alloc(datastore->info, datastore->uid);
1217                         if (datastore2) {
1218                                 datastore2->data = datastore->info->duplicate(datastore->data);
1219                                 datastore2->inheritance = datastore->inheritance == DATASTORE_INHERIT_FOREVER ? DATASTORE_INHERIT_FOREVER : datastore->inheritance - 1;
1220                                 AST_LIST_INSERT_TAIL(&to->datastores, datastore2, entry);
1221                         }
1222                 }
1223         }
1224         return 0;
1225 }
1226
1227 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
1228 {
1229         int res = 0;
1230
1231         AST_LIST_INSERT_HEAD(&chan->datastores, datastore, entry);
1232
1233         return res;
1234 }
1235
1236 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore)
1237 {
1238         struct ast_datastore *datastore2 = NULL;
1239         int res = -1;
1240
1241         /* Find our position and remove ourselves */
1242         AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore2, entry) {
1243                 if (datastore2 == datastore) {
1244                         AST_LIST_REMOVE_CURRENT(&chan->datastores, entry);
1245                         res = 0;
1246                         break;
1247                 }
1248         }
1249         AST_LIST_TRAVERSE_SAFE_END
1250
1251         return res;
1252 }
1253
1254 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, char *uid)
1255 {
1256         struct ast_datastore *datastore = NULL;
1257
1258         if (info == NULL)
1259                 return NULL;
1260
1261         AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore, entry) {
1262                 if (datastore->info == info) {
1263                         if (uid != NULL && datastore->uid != NULL) {
1264                                 if (!strcasecmp(uid, datastore->uid)) {
1265                                         /* Matched by type AND uid */
1266                                         break;
1267                                 }
1268                         } else {
1269                                 /* Matched by type at least */
1270                                 break;
1271                         }
1272                 }
1273         }
1274         AST_LIST_TRAVERSE_SAFE_END
1275
1276         return datastore;
1277 }
1278
1279 int ast_channel_spy_add(struct ast_channel *chan, struct ast_channel_spy *spy)
1280 {
1281         /* Link the owner channel to the spy */
1282         spy->chan = chan;
1283
1284         if (!ast_test_flag(spy, CHANSPY_FORMAT_AUDIO)) {
1285                 ast_log(LOG_WARNING, "Could not add channel spy '%s' to channel '%s', only audio format spies are supported.\n",
1286                         spy->type, chan->name);
1287                 return -1;
1288         }
1289
1290         if (ast_test_flag(spy, CHANSPY_READ_VOLADJUST) && (spy->read_queue.format != AST_FORMAT_SLINEAR)) {
1291                 ast_log(LOG_WARNING, "Cannot provide volume adjustment on '%s' format spies\n",
1292                         ast_getformatname(spy->read_queue.format));
1293                 return -1;
1294         }
1295
1296         if (ast_test_flag(spy, CHANSPY_WRITE_VOLADJUST) && (spy->write_queue.format != AST_FORMAT_SLINEAR)) {
1297                 ast_log(LOG_WARNING, "Cannot provide volume adjustment on '%s' format spies\n",
1298                         ast_getformatname(spy->write_queue.format));
1299                 return -1;
1300         }
1301
1302         if (ast_test_flag(spy, CHANSPY_MIXAUDIO) &&
1303             ((spy->read_queue.format != AST_FORMAT_SLINEAR) ||
1304              (spy->write_queue.format != AST_FORMAT_SLINEAR))) {
1305                 ast_log(LOG_WARNING, "Cannot provide audio mixing on '%s'-'%s' format spies\n",
1306                         ast_getformatname(spy->read_queue.format), ast_getformatname(spy->write_queue.format));
1307                 return -1;
1308         }
1309
1310         if (!chan->spies) {
1311                 if (!(chan->spies = ast_calloc(1, sizeof(*chan->spies)))) {
1312                         return -1;
1313                 }
1314
1315                 AST_LIST_HEAD_INIT_NOLOCK(&chan->spies->list);
1316                 AST_LIST_INSERT_HEAD(&chan->spies->list, spy, list);
1317         } else {
1318                 AST_LIST_INSERT_TAIL(&chan->spies->list, spy, list);
1319         }
1320
1321         if (ast_test_flag(spy, CHANSPY_TRIGGER_MODE) != CHANSPY_TRIGGER_NONE) {
1322                 ast_cond_init(&spy->trigger, NULL);
1323                 ast_set_flag(spy, CHANSPY_TRIGGER_READ);
1324                 ast_clear_flag(spy, CHANSPY_TRIGGER_WRITE);
1325         }
1326
1327         ast_debug(1, "Spy %s added to channel %s\n",
1328                 spy->type, chan->name);
1329
1330         return 0;
1331 }
1332
1333 /* Clean up a channel's spy information */
1334 static void spy_cleanup(struct ast_channel *chan)
1335 {
1336         if (!AST_LIST_EMPTY(&chan->spies->list))
1337                 return;
1338         if (chan->spies->read_translator.path)
1339                 ast_translator_free_path(chan->spies->read_translator.path);
1340         if (chan->spies->write_translator.path)
1341                 ast_translator_free_path(chan->spies->write_translator.path);
1342         ast_free(chan->spies);
1343         chan->spies = NULL;
1344         return;
1345 }
1346
1347 /* Detach a spy from it's channel */
1348 static void spy_detach(struct ast_channel_spy *spy, struct ast_channel *chan)
1349 {
1350         ast_mutex_lock(&spy->lock);
1351
1352         /* We only need to poke them if they aren't already done */
1353         if (spy->status != CHANSPY_DONE) {
1354                 /* Indicate to the spy to stop */
1355                 spy->status = CHANSPY_STOP;
1356                 spy->chan = NULL;
1357                 /* Poke the spy if needed */
1358                 if (ast_test_flag(spy, CHANSPY_TRIGGER_MODE) != CHANSPY_TRIGGER_NONE)
1359                         ast_cond_signal(&spy->trigger);
1360         }
1361
1362         /* Print it out while we still have a lock so the structure can't go away (if signalled above) */
1363         ast_debug(1, "Spy %s removed from channel %s\n", spy->type, chan->name);
1364
1365         ast_mutex_unlock(&spy->lock);
1366
1367         return;
1368 }
1369
1370 void ast_channel_spy_stop_by_type(struct ast_channel *chan, const char *type)
1371 {
1372         struct ast_channel_spy *spy = NULL;
1373
1374         if (!chan->spies)
1375                 return;
1376
1377         AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->spies->list, spy, list) {
1378                 ast_mutex_lock(&spy->lock);
1379                 if ((spy->type == type) && (spy->status == CHANSPY_RUNNING)) {
1380                         ast_mutex_unlock(&spy->lock);
1381                         AST_LIST_REMOVE_CURRENT(&chan->spies->list, list);
1382                         spy_detach(spy, chan);
1383                 } else
1384                         ast_mutex_unlock(&spy->lock);
1385         }
1386         AST_LIST_TRAVERSE_SAFE_END
1387         spy_cleanup(chan);
1388 }
1389
1390 void ast_channel_spy_trigger_wait(struct ast_channel_spy *spy)
1391 {
1392         struct timeval tv;
1393         struct timespec ts;
1394
1395         tv = ast_tvadd(ast_tvnow(), ast_samp2tv(50000, 1000));
1396         ts.tv_sec = tv.tv_sec;
1397         ts.tv_nsec = tv.tv_usec * 1000;
1398
1399         ast_cond_timedwait(&spy->trigger, &spy->lock, &ts);
1400 }
1401
1402 void ast_channel_spy_remove(struct ast_channel *chan, struct ast_channel_spy *spy)
1403 {
1404         if (!chan->spies)
1405                 return;
1406
1407         AST_LIST_REMOVE(&chan->spies->list, spy, list);
1408         spy_detach(spy, chan);
1409         spy_cleanup(chan);
1410 }
1411
1412 void ast_channel_spy_free(struct ast_channel_spy *spy)
1413 {
1414         struct ast_frame *f = NULL;
1415
1416         if (spy->status == CHANSPY_DONE)
1417                 return;
1418
1419         /* Switch status to done in case we get called twice */
1420         spy->status = CHANSPY_DONE;
1421
1422         /* Drop any frames in the queue */
1423         while ((f = AST_LIST_REMOVE_HEAD(&spy->write_queue.list, frame_list)))
1424                 ast_frfree(f);
1425         while ((f = AST_LIST_REMOVE_HEAD(&spy->read_queue.list, frame_list)))
1426                 ast_frfree(f);
1427
1428         /* Destroy the condition if in use */
1429         if (ast_test_flag(spy, CHANSPY_TRIGGER_MODE) != CHANSPY_TRIGGER_NONE)
1430                 ast_cond_destroy(&spy->trigger);
1431
1432         /* Destroy our mutex since it is no longer in use */
1433         ast_mutex_destroy(&spy->lock);
1434
1435         return;
1436 }
1437
1438 static void detach_spies(struct ast_channel *chan)
1439 {
1440         struct ast_channel_spy *spy = NULL;
1441
1442         if (!chan->spies)
1443                 return;
1444
1445         AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->spies->list, spy, list) {
1446                 AST_LIST_REMOVE_CURRENT(&chan->spies->list, list);
1447                 spy_detach(spy, chan);
1448         }
1449         AST_LIST_TRAVERSE_SAFE_END
1450
1451         spy_cleanup(chan);
1452 }
1453
1454 /*! \brief Softly hangup a channel, don't lock */
1455 int ast_softhangup_nolock(struct ast_channel *chan, int cause)
1456 {
1457         ast_debug(1, "Soft-Hanging up channel '%s'\n", chan->name);
1458         /* Inform channel driver that we need to be hung up, if it cares */
1459         chan->_softhangup |= cause;
1460         ast_queue_frame(chan, &ast_null_frame);
1461         /* Interrupt any poll call or such */
1462         if (ast_test_flag(chan, AST_FLAG_BLOCKING))
1463                 pthread_kill(chan->blocker, SIGURG);
1464         return 0;
1465 }
1466
1467 /*! \brief Softly hangup a channel, lock */
1468 int ast_softhangup(struct ast_channel *chan, int cause)
1469 {
1470         int res;
1471         ast_channel_lock(chan);
1472         res = ast_softhangup_nolock(chan, cause);
1473         ast_channel_unlock(chan);
1474         return res;
1475 }
1476
1477 enum spy_direction {
1478         SPY_READ,
1479         SPY_WRITE,
1480 };
1481
1482 #define SPY_QUEUE_SAMPLE_LIMIT 4000                     /* half of one second */
1483
1484 static void queue_frame_to_spies(struct ast_channel *chan, struct ast_frame *f, enum spy_direction dir)
1485 {
1486         struct ast_frame *translated_frame = NULL;
1487         struct ast_channel_spy *spy;
1488         struct channel_spy_trans *trans;
1489
1490         trans = (dir == SPY_READ) ? &chan->spies->read_translator : &chan->spies->write_translator;
1491
1492         AST_LIST_TRAVERSE(&chan->spies->list, spy, list) {
1493                 struct ast_channel_spy_queue *queue;
1494                 struct ast_frame *duped_fr;
1495
1496                 ast_mutex_lock(&spy->lock);
1497
1498                 queue = (dir == SPY_READ) ? &spy->read_queue : &spy->write_queue;
1499
1500                 if ((queue->format == AST_FORMAT_SLINEAR) && (f->subclass != AST_FORMAT_SLINEAR)) {
1501                         if (!translated_frame) {
1502                                 if (trans->path && (trans->last_format != f->subclass)) {
1503                                         ast_translator_free_path(trans->path);
1504                                         trans->path = NULL;
1505                                 }
1506                                 if (!trans->path) {
1507                                         ast_debug(1, "Building translator from %s to SLINEAR for spies on channel %s\n",
1508                                                         ast_getformatname(f->subclass), chan->name);
1509                                         if ((trans->path = ast_translator_build_path(AST_FORMAT_SLINEAR, f->subclass)) == NULL) {
1510                                                 ast_log(LOG_WARNING, "Cannot build a path from %s to %s\n",
1511                                                         ast_getformatname(f->subclass), ast_getformatname(AST_FORMAT_SLINEAR));
1512                                                 ast_mutex_unlock(&spy->lock);
1513                                                 continue;
1514                                         } else {
1515                                                 trans->last_format = f->subclass;
1516                                         }
1517                                 }
1518                                 if (!(translated_frame = ast_translate(trans->path, f, 0))) {
1519                                         ast_log(LOG_ERROR, "Translation to %s failed, dropping frame for spies\n",
1520                                                 ast_getformatname(AST_FORMAT_SLINEAR));
1521                                         ast_mutex_unlock(&spy->lock);
1522                                         break;
1523                                 }
1524                         }
1525                         duped_fr = ast_frdup(translated_frame);
1526                 } else if (f->subclass != queue->format) {
1527                         ast_log(LOG_WARNING, "Spy '%s' on channel '%s' wants format '%s', but frame is '%s', dropping\n",
1528                                 spy->type, chan->name,
1529                                 ast_getformatname(queue->format), ast_getformatname(f->subclass));
1530                         ast_mutex_unlock(&spy->lock);
1531                         continue;
1532                 } else
1533                         duped_fr = ast_frdup(f);
1534
1535                 AST_LIST_INSERT_TAIL(&queue->list, duped_fr, frame_list);
1536
1537                 queue->samples += f->samples;
1538
1539                 if (queue->samples > SPY_QUEUE_SAMPLE_LIMIT) {
1540                         if (ast_test_flag(spy, CHANSPY_TRIGGER_MODE) != CHANSPY_TRIGGER_NONE) {
1541                                 switch (ast_test_flag(spy, CHANSPY_TRIGGER_MODE)) {
1542                                 case CHANSPY_TRIGGER_READ:
1543                                         if (dir == SPY_WRITE) {
1544                                                 ast_set_flag(spy, CHANSPY_TRIGGER_WRITE);
1545                                                 ast_clear_flag(spy, CHANSPY_TRIGGER_READ);
1546                                                 ast_debug(1, "Switching spy '%s' on '%s' to write-trigger mode\n",
1547                                                         spy->type, chan->name);
1548                                         }
1549                                         break;
1550                                 case CHANSPY_TRIGGER_WRITE:
1551                                         if (dir == SPY_READ) {
1552                                                 ast_set_flag(spy, CHANSPY_TRIGGER_READ);
1553                                                 ast_clear_flag(spy, CHANSPY_TRIGGER_WRITE);
1554                                                 ast_debug(1, "Switching spy '%s' on '%s' to read-trigger mode\n",
1555                                                         spy->type, chan->name);
1556                                         }
1557                                         break;
1558                                 }
1559                                 ast_debug(1, "Triggering queue flush for spy '%s' on '%s'\n",
1560                                         spy->type, chan->name);
1561                                 ast_set_flag(spy, CHANSPY_TRIGGER_FLUSH);
1562                                 ast_cond_signal(&spy->trigger);
1563                         } else {
1564                                 ast_debug(1, "Spy '%s' on channel '%s' %s queue too long, dropping frames\n",
1565                                         spy->type, chan->name, (dir == SPY_READ) ? "read" : "write");
1566                                 while (queue->samples > SPY_QUEUE_SAMPLE_LIMIT) {
1567                                         struct ast_frame *drop = AST_LIST_REMOVE_HEAD(&queue->list, frame_list);
1568                                         queue->samples -= drop->samples;
1569                                         ast_frfree(drop);
1570                                 }
1571                         }
1572                 } else {
1573                         switch (ast_test_flag(spy, CHANSPY_TRIGGER_MODE)) {
1574                         case CHANSPY_TRIGGER_READ:
1575                                 if (dir == SPY_READ)
1576                                         ast_cond_signal(&spy->trigger);
1577                                 break;
1578                         case CHANSPY_TRIGGER_WRITE:
1579                                 if (dir == SPY_WRITE)
1580                                         ast_cond_signal(&spy->trigger);
1581                                 break;
1582                         }
1583                 }
1584
1585                 ast_mutex_unlock(&spy->lock);
1586         }
1587
1588         if (translated_frame)
1589                 ast_frfree(translated_frame);
1590 }
1591
1592 static void free_translation(struct ast_channel *clone)
1593 {
1594         if (clone->writetrans)
1595                 ast_translator_free_path(clone->writetrans);
1596         if (clone->readtrans)
1597                 ast_translator_free_path(clone->readtrans);
1598         clone->writetrans = NULL;
1599         clone->readtrans = NULL;
1600         clone->rawwriteformat = clone->nativeformats;
1601         clone->rawreadformat = clone->nativeformats;
1602 }
1603
1604 /*! \brief Hangup a channel */
1605 int ast_hangup(struct ast_channel *chan)
1606 {
1607         int res = 0;
1608         struct ast_cdr *cdr = NULL;
1609
1610         /* Don't actually hang up a channel that will masquerade as someone else, or
1611            if someone is going to masquerade as us */
1612         ast_channel_lock(chan);
1613
1614         detach_spies(chan);             /* get rid of spies */
1615
1616         if (chan->masq) {
1617                 if (ast_do_masquerade(chan))
1618                         ast_log(LOG_WARNING, "Failed to perform masquerade\n");
1619         }
1620
1621         if (chan->masq) {
1622                 ast_log(LOG_WARNING, "%s getting hung up, but someone is trying to masq into us?!?\n", chan->name);
1623                 ast_channel_unlock(chan);
1624                 return 0;
1625         }
1626         /* If this channel is one which will be masqueraded into something,
1627            mark it as a zombie already, so we know to free it later */
1628         if (chan->masqr) {
1629                 ast_set_flag(chan, AST_FLAG_ZOMBIE);
1630                 ast_channel_unlock(chan);
1631                 return 0;
1632         }
1633         free_translation(chan);
1634         /* Close audio stream */
1635         if (chan->stream) {
1636                 ast_closestream(chan->stream);
1637                 chan->stream = NULL;
1638         }
1639         /* Close video stream */
1640         if (chan->vstream) {
1641                 ast_closestream(chan->vstream);
1642                 chan->vstream = NULL;
1643         }
1644         if (chan->sched) {
1645                 sched_context_destroy(chan->sched);
1646                 chan->sched = NULL;
1647         }
1648
1649         if (chan->generatordata)        /* Clear any tone stuff remaining */
1650                 if (chan->generator && chan->generator->release)
1651                         chan->generator->release(chan, chan->generatordata);
1652         chan->generatordata = NULL;
1653         chan->generator = NULL;
1654         if (chan->cdr) {                /* End the CDR if it hasn't already */
1655                 ast_cdr_end(chan->cdr);
1656                 cdr = chan->cdr;
1657                 chan->cdr = NULL;
1658         }
1659         if (ast_test_flag(chan, AST_FLAG_BLOCKING)) {
1660                 ast_log(LOG_WARNING, "Hard hangup called by thread %ld on %s, while fd "
1661                                         "is blocked by thread %ld in procedure %s!  Expect a failure\n",
1662                                         (long)pthread_self(), chan->name, (long)chan->blocker, chan->blockproc);
1663                 CRASH;
1664         }
1665         if (!ast_test_flag(chan, AST_FLAG_ZOMBIE)) {
1666                 ast_debug(1, "Hanging up channel '%s'\n", chan->name);
1667                 if (chan->tech->hangup)
1668                         res = chan->tech->hangup(chan);
1669         } else {
1670                 ast_debug(1, "Hanging up zombie '%s'\n", chan->name);
1671         }
1672
1673         ast_channel_unlock(chan);
1674         manager_event(EVENT_FLAG_CALL, "Hangup",
1675                         "Channel: %s\r\n"
1676                         "Uniqueid: %s\r\n"
1677                         "Cause: %d\r\n"
1678                         "Cause-txt: %s\r\n",
1679                         chan->name,
1680                         chan->uniqueid,
1681                         chan->hangupcause,
1682                         ast_cause2str(chan->hangupcause)
1683                         );
1684         ast_channel_free(chan);
1685
1686         if (cdr)
1687                 ast_cdr_detach(cdr);
1688
1689         return res;
1690 }
1691
1692 int __ast_answer(struct ast_channel *chan, unsigned int delay)
1693 {
1694         int res = 0;
1695
1696         ast_channel_lock(chan);
1697
1698         /* You can't answer an outbound call */
1699         if (ast_test_flag(chan, AST_FLAG_OUTGOING)) {
1700                 ast_channel_unlock(chan);
1701                 return 0;
1702         }
1703
1704         /* Stop if we're a zombie or need a soft hangup */
1705         if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
1706                 ast_channel_unlock(chan);
1707                 return -1;
1708         }
1709
1710         switch (chan->_state) {
1711         case AST_STATE_RINGING:
1712         case AST_STATE_RING:
1713                 if (chan->tech->answer)
1714                         res = chan->tech->answer(chan);
1715                 ast_setstate(chan, AST_STATE_UP);
1716                 ast_cdr_answer(chan->cdr);
1717                 ast_channel_unlock(chan);
1718                 if (delay)
1719                         ast_safe_sleep(chan, delay);
1720                 return res;
1721                 break;
1722         case AST_STATE_UP:
1723                 ast_cdr_answer(chan->cdr);
1724                 break;
1725         default:
1726                 break;
1727         }
1728
1729         ast_channel_unlock(chan);
1730
1731         return res;
1732 }
1733
1734 int ast_answer(struct ast_channel *chan)
1735 {
1736         return __ast_answer(chan, 500);
1737 }
1738
1739 void ast_deactivate_generator(struct ast_channel *chan)
1740 {
1741         ast_channel_lock(chan);
1742         if (chan->generatordata) {
1743                 if (chan->generator && chan->generator->release)
1744                         chan->generator->release(chan, chan->generatordata);
1745                 chan->generatordata = NULL;
1746                 chan->generator = NULL;
1747                 chan->fds[AST_GENERATOR_FD] = -1;
1748                 ast_clear_flag(chan, AST_FLAG_WRITE_INT);
1749                 ast_settimeout(chan, 0, NULL, NULL);
1750         }
1751         ast_channel_unlock(chan);
1752 }
1753
1754 static int generator_force(void *data)
1755 {
1756         /* Called if generator doesn't have data */
1757         void *tmp;
1758         int res;
1759         int (*generate)(struct ast_channel *chan, void *tmp, int datalen, int samples);
1760         struct ast_channel *chan = data;
1761         tmp = chan->generatordata;
1762         chan->generatordata = NULL;
1763         generate = chan->generator->generate;
1764         res = generate(chan, tmp, 0, 160);
1765         chan->generatordata = tmp;
1766         if (res) {
1767                 ast_debug(1, "Auto-deactivating generator\n");
1768                 ast_deactivate_generator(chan);
1769         }
1770         return 0;
1771 }
1772
1773 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params)
1774 {
1775         int res = 0;
1776
1777         ast_channel_lock(chan);
1778
1779         if (chan->generatordata) {
1780                 if (chan->generator && chan->generator->release)
1781                         chan->generator->release(chan, chan->generatordata);
1782                 chan->generatordata = NULL;
1783         }
1784
1785         ast_prod(chan);
1786         if (gen->alloc && !(chan->generatordata = gen->alloc(chan, params))) {
1787                 res = -1;
1788         }
1789
1790         if (!res) {
1791                 ast_settimeout(chan, 160, generator_force, chan);
1792                 chan->generator = gen;
1793         }
1794
1795         ast_channel_unlock(chan);
1796
1797         return res;
1798 }
1799
1800 /*! \brief Wait for x amount of time on a file descriptor to have input.  */
1801 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception)
1802 {
1803         int winner = -1;
1804         ast_waitfor_nandfds(NULL, 0, fds, n, exception, &winner, ms);
1805         return winner;
1806 }
1807
1808 /*! \brief Wait for x amount of time on a file descriptor to have input.  */
1809 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **c, int n, int *fds, int nfds,
1810         int *exception, int *outfd, int *ms)
1811 {
1812         struct timeval start = { 0 , 0 };
1813         struct pollfd *pfds;
1814         int res;
1815         long rms;
1816         int x, y, max;
1817         int sz;
1818         time_t now = 0;
1819         long whentohangup = 0, diff;
1820         struct ast_channel *winner = NULL;
1821         struct fdmap {
1822                 int chan;
1823                 int fdno;
1824         } *fdmap;
1825
1826         sz = n * AST_MAX_FDS + nfds;
1827         pfds = alloca(sizeof(*pfds) * sz);
1828         fdmap = alloca(sizeof(*fdmap) * sz);
1829
1830         if (outfd)
1831                 *outfd = -99999;
1832         if (exception)
1833                 *exception = 0;
1834
1835         /* Perform any pending masquerades */
1836         for (x=0; x < n; x++) {
1837                 ast_channel_lock(c[x]);
1838                 if (c[x]->masq) {
1839                         if (ast_do_masquerade(c[x])) {
1840                                 ast_log(LOG_WARNING, "Masquerade failed\n");
1841                                 *ms = -1;
1842                                 ast_channel_unlock(c[x]);
1843                                 return NULL;
1844                         }
1845                 }
1846                 if (c[x]->whentohangup) {
1847                         if (!whentohangup)
1848                                 time(&now);
1849                         diff = c[x]->whentohangup - now;
1850                         if (diff < 1) {
1851                                 /* Should already be hungup */
1852                                 c[x]->_softhangup |= AST_SOFTHANGUP_TIMEOUT;
1853                                 ast_channel_unlock(c[x]);
1854                                 return c[x];
1855                         }
1856                         if (!whentohangup || (diff < whentohangup))
1857                                 whentohangup = diff;
1858                 }
1859                 ast_channel_unlock(c[x]);
1860         }
1861         /* Wait full interval */
1862         rms = *ms;
1863         if (whentohangup) {
1864                 rms = whentohangup * 1000;              /* timeout in milliseconds */
1865                 if (*ms >= 0 && *ms < rms)              /* original *ms still smaller */
1866                         rms =  *ms;
1867         }
1868         /*
1869          * Build the pollfd array, putting the channels' fds first,
1870          * followed by individual fds. Order is important because
1871          * individual fd's must have priority over channel fds.
1872          */
1873         max = 0;
1874         for (x=0; x<n; x++) {
1875                 for (y=0; y<AST_MAX_FDS; y++) {
1876                         fdmap[max].fdno = y;  /* fd y is linked to this pfds */
1877                         fdmap[max].chan = x;  /* channel x is linked to this pfds */
1878                         max += ast_add_fd(&pfds[max], c[x]->fds[y]);
1879                 }
1880                 CHECK_BLOCKING(c[x]);
1881         }
1882         /* Add the individual fds */
1883         for (x=0; x<nfds; x++) {
1884                 fdmap[max].chan = -1;
1885                 max += ast_add_fd(&pfds[max], fds[x]);
1886         }
1887
1888         if (*ms > 0)
1889                 start = ast_tvnow();
1890
1891         if (sizeof(int) == 4) { /* XXX fix timeout > 600000 on linux x86-32 */
1892                 do {
1893                         int kbrms = rms;
1894                         if (kbrms > 600000)
1895                                 kbrms = 600000;
1896                         res = poll(pfds, max, kbrms);
1897                         if (!res)
1898                                 rms -= kbrms;
1899                 } while (!res && (rms > 0));
1900         } else {
1901                 res = poll(pfds, max, rms);
1902         }
1903         for (x=0; x<n; x++)
1904                 ast_clear_flag(c[x], AST_FLAG_BLOCKING);
1905         if (res < 0) { /* Simulate a timeout if we were interrupted */
1906                 if (errno != EINTR)
1907                         *ms = -1;
1908                 return NULL;
1909         }
1910         if (whentohangup) {   /* if we have a timeout, check who expired */
1911                 time(&now);
1912                 for (x=0; x<n; x++) {
1913                         if (c[x]->whentohangup && now >= c[x]->whentohangup) {
1914                                 c[x]->_softhangup |= AST_SOFTHANGUP_TIMEOUT;
1915                                 if (winner == NULL)
1916                                         winner = c[x];
1917                         }
1918                 }
1919         }
1920         if (res == 0) { /* no fd ready, reset timeout and done */
1921                 *ms = 0;        /* XXX use 0 since we may not have an exact timeout. */
1922                 return winner;
1923         }
1924         /*
1925          * Then check if any channel or fd has a pending event.
1926          * Remember to check channels first and fds last, as they
1927          * must have priority on setting 'winner'
1928          */
1929         for (x = 0; x < max; x++) {
1930                 res = pfds[x].revents;
1931                 if (res == 0)
1932                         continue;
1933                 if (fdmap[x].chan >= 0) {       /* this is a channel */
1934                         winner = c[fdmap[x].chan];      /* override previous winners */
1935                         if (res & POLLPRI)
1936                                 ast_set_flag(winner, AST_FLAG_EXCEPTION);
1937                         else
1938                                 ast_clear_flag(winner, AST_FLAG_EXCEPTION);
1939                         winner->fdno = fdmap[x].fdno;
1940                 } else {                        /* this is an fd */
1941                         if (outfd)
1942                                 *outfd = pfds[x].fd;
1943                         if (exception)
1944                                 *exception = (res & POLLPRI) ? -1 : 0;
1945                         winner = NULL;
1946                 }
1947         }
1948         if (*ms > 0) {
1949                 *ms -= ast_tvdiff_ms(ast_tvnow(), start);
1950                 if (*ms < 0)
1951                         *ms = 0;
1952         }
1953         return winner;
1954 }
1955
1956 struct ast_channel *ast_waitfor_n(struct ast_channel **c, int n, int *ms)
1957 {
1958         return ast_waitfor_nandfds(c, n, NULL, 0, NULL, NULL, ms);
1959 }
1960
1961 int ast_waitfor(struct ast_channel *c, int ms)
1962 {
1963         int oldms = ms; /* -1 if no timeout */
1964
1965         ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
1966         if ((ms < 0) && (oldms < 0))
1967                 ms = 0;
1968         return ms;
1969 }
1970
1971 /* XXX never to be called with ms = -1 */
1972 int ast_waitfordigit(struct ast_channel *c, int ms)
1973 {
1974         return ast_waitfordigit_full(c, ms, -1, -1);
1975 }
1976
1977 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(void *data), void *data)
1978 {
1979         int res = -1;
1980 #ifdef HAVE_ZAPTEL
1981         if (c->timingfd > -1) {
1982                 if (!func) {
1983                         samples = 0;
1984                         data = 0;
1985                 }
1986                 ast_debug(1, "Scheduling timer at %d sample intervals\n", samples);
1987                 res = ioctl(c->timingfd, ZT_TIMERCONFIG, &samples);
1988                 c->timingfunc = func;
1989                 c->timingdata = data;
1990         }
1991 #endif
1992         return res;
1993 }
1994
1995 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int cmdfd)
1996 {
1997
1998         /* Stop if we're a zombie or need a soft hangup */
1999         if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
2000                 return -1;
2001         /* Wait for a digit, no more than ms milliseconds total. */
2002         while (ms) {
2003                 struct ast_channel *rchan;
2004                 int outfd;
2005
2006                 errno = 0;
2007                 rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
2008                 if (!rchan && outfd < 0 && ms) {
2009                         if (errno == 0 || errno == EINTR)
2010                                 continue;
2011                         ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
2012                         return -1;
2013                 } else if (outfd > -1) {
2014                         /* The FD we were watching has something waiting */
2015                         return 1;
2016                 } else if (rchan) {
2017                         int res;
2018                         struct ast_frame *f = ast_read(c);
2019                         if (!f)
2020                                 return -1;
2021
2022                         switch (f->frametype) {
2023                         case AST_FRAME_DTMF:
2024                                 res = f->subclass;
2025                                 ast_frfree(f);
2026                                 return res;
2027                         case AST_FRAME_CONTROL:
2028                                 switch (f->subclass) {
2029                                 case AST_CONTROL_HANGUP:
2030                                         ast_frfree(f);
2031                                         return -1;
2032                                 case AST_CONTROL_RINGING:
2033                                 case AST_CONTROL_ANSWER:
2034                                         /* Unimportant */
2035                                         break;
2036                                 default:
2037                                         ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", f->subclass);
2038                                         break;
2039                                 }
2040                                 break;
2041                         case AST_FRAME_VOICE:
2042                                 /* Write audio if appropriate */
2043                                 if (audiofd > -1)
2044                                         write(audiofd, f->data, f->datalen);
2045                         default:
2046                                 /* Ignore */
2047                                 break;
2048                         }
2049                         ast_frfree(f);
2050                 }
2051         }
2052         return 0; /* Time is up */
2053 }
2054
2055 static void send_dtmf_event(const struct ast_channel *chan, const char *direction, const char digit, const char *begin, const char *end)
2056 {
2057         manager_event(EVENT_FLAG_DTMF,
2058                         "DTMF",
2059                         "Channel: %s\r\n"
2060                         "Uniqueid: %s\r\n"
2061                         "Digit: %c\r\n"
2062                         "Direction: %s\r\n"
2063                         "Begin: %s\r\n"
2064                         "End: %s\r\n",
2065                         chan->name, chan->uniqueid, digit, direction, begin, end);
2066 }
2067
2068 static void ast_read_generator_actions(struct ast_channel *chan, struct ast_frame *f)
2069 {
2070         if (chan->generatordata &&  !ast_internal_timing_enabled(chan)) {
2071                 void *tmp = chan->generatordata;
2072                 int res;
2073
2074                 if (chan->timingfunc) {
2075                         if (option_debug > 1)
2076                                 ast_log(LOG_DEBUG, "Generator got voice, switching to phase locked mode\n");
2077                         ast_settimeout(chan, 0, NULL, NULL);
2078                 }
2079
2080                 chan->generatordata = NULL;     /* reset, to let writes go through */
2081                 res = chan->generator->generate(chan, tmp, f->datalen, f->samples);
2082                 chan->generatordata = tmp;
2083                 if (res) {
2084                         if (option_debug > 1)
2085                                 ast_log(LOG_DEBUG, "Auto-deactivating generator\n");
2086                         ast_deactivate_generator(chan);
2087                 }
2088
2089         } else if (f->frametype == AST_FRAME_CNG) {
2090                 if (chan->generator && !chan->timingfunc && (chan->timingfd > -1)) {
2091                         if (option_debug > 1)
2092                                 ast_log(LOG_DEBUG, "Generator got CNG, switching to timed mode\n");
2093                         ast_settimeout(chan, 160, generator_force, chan);
2094                 }
2095         }
2096 }
2097
2098 static struct ast_frame *__ast_read(struct ast_channel *chan, int dropaudio)
2099 {
2100         struct ast_frame *f = NULL;     /* the return value */
2101         int blah;
2102         int prestate;
2103
2104         /* this function is very long so make sure there is only one return
2105          * point at the end (there is only one exception to this).
2106          */
2107         ast_channel_lock(chan);
2108         if (chan->masq) {
2109                 if (ast_do_masquerade(chan))
2110                         ast_log(LOG_WARNING, "Failed to perform masquerade\n");
2111                 else
2112                         f =  &ast_null_frame;
2113                 goto done;
2114         }
2115
2116         /* Stop if we're a zombie or need a soft hangup */
2117         if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
2118                 if (chan->generator)
2119                         ast_deactivate_generator(chan);
2120                 goto done;
2121         }
2122         prestate = chan->_state;
2123
2124         if (!ast_test_flag(chan, AST_FLAG_DEFER_DTMF | AST_FLAG_EMULATE_DTMF | AST_FLAG_IN_DTMF) &&
2125             !ast_strlen_zero(chan->dtmfq) &&
2126                 (ast_tvzero(chan->dtmf_tv) || ast_tvdiff_ms(ast_tvnow(), chan->dtmf_tv) > AST_MIN_DTMF_GAP) ) {
2127                 /* We have DTMF that has been deferred.  Return it now */
2128                 chan->dtmff.subclass = chan->dtmfq[0];
2129                 /* Drop first digit from the buffer */
2130                 memmove(chan->dtmfq, chan->dtmfq + 1, sizeof(chan->dtmfq) - 1);
2131                 f = &chan->dtmff;
2132                 if (ast_test_flag(chan, AST_FLAG_END_DTMF_ONLY))
2133                         chan->dtmff.frametype = AST_FRAME_DTMF_END;
2134                 else {
2135                         chan->dtmff.frametype = AST_FRAME_DTMF_BEGIN;
2136                         ast_set_flag(chan, AST_FLAG_EMULATE_DTMF);
2137                         chan->emulate_dtmf_digit = f->subclass;
2138                         chan->emulate_dtmf_duration = AST_DEFAULT_EMULATE_DTMF_DURATION;
2139                 }
2140                 chan->dtmf_tv = ast_tvnow();
2141                 goto done;
2142         }
2143
2144         /* Read and ignore anything on the alertpipe, but read only
2145            one sizeof(blah) per frame that we send from it */
2146         if (chan->alertpipe[0] > -1)
2147                 read(chan->alertpipe[0], &blah, sizeof(blah));
2148
2149 #ifdef HAVE_ZAPTEL
2150         if (chan->timingfd > -1 && chan->fdno == AST_TIMING_FD && ast_test_flag(chan, AST_FLAG_EXCEPTION)) {
2151                 int res;
2152
2153                 ast_clear_flag(chan, AST_FLAG_EXCEPTION);
2154                 blah = -1;
2155                 /* IF we can't get event, assume it's an expired as-per the old interface */
2156                 res = ioctl(chan->timingfd, ZT_GETEVENT, &blah);
2157                 if (res)
2158                         blah = ZT_EVENT_TIMER_EXPIRED;
2159
2160                 if (blah == ZT_EVENT_TIMER_PING) {
2161                         if (AST_LIST_EMPTY(&chan->readq) || !AST_LIST_NEXT(AST_LIST_FIRST(&chan->readq), frame_list)) {
2162                                 /* Acknowledge PONG unless we need it again */
2163                                 if (ioctl(chan->timingfd, ZT_TIMERPONG, &blah)) {
2164                                         ast_log(LOG_WARNING, "Failed to pong timer on '%s': %s\n", chan->name, strerror(errno));
2165                                 }
2166                         }
2167                 } else if (blah == ZT_EVENT_TIMER_EXPIRED) {
2168                         ioctl(chan->timingfd, ZT_TIMERACK, &blah);
2169                         if (chan->timingfunc) {
2170                                 /* save a copy of func/data before unlocking the channel */
2171                                 int (*func)(void *) = chan->timingfunc;
2172                                 void *data = chan->timingdata;
2173                                 ast_channel_unlock(chan);
2174                                 func(data);
2175                         } else {
2176                                 blah = 0;
2177                                 ioctl(chan->timingfd, ZT_TIMERCONFIG, &blah);
2178                                 chan->timingdata = NULL;
2179                                 ast_channel_unlock(chan);
2180                         }
2181                         /* cannot 'goto done' because the channel is already unlocked */
2182                         return &ast_null_frame;
2183                 } else
2184                         ast_log(LOG_NOTICE, "No/unknown event '%d' on timer for '%s'?\n", blah, chan->name);
2185         } else
2186 #endif
2187         if (chan->fds[AST_GENERATOR_FD] > -1 && chan->fdno == AST_GENERATOR_FD) {
2188                 /* if the AST_GENERATOR_FD is set, call the generator with args
2189                  * set to -1 so it can do whatever it needs to.
2190                  */
2191                 void *tmp = chan->generatordata;
2192                 chan->generatordata = NULL;     /* reset to let ast_write get through */
2193                 chan->generator->generate(chan, tmp, -1, -1);
2194                 chan->generatordata = tmp;
2195                 f = &ast_null_frame;
2196                 goto done;
2197         }
2198
2199         /* Check for pending read queue */
2200         if (!AST_LIST_EMPTY(&chan->readq)) {
2201                 f = AST_LIST_REMOVE_HEAD(&chan->readq, frame_list);
2202                 /* Interpret hangup and return NULL */
2203                 /* XXX why not the same for frames from the channel ? */
2204                 if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP) {
2205                         ast_frfree(f);
2206                         f = NULL;
2207                 }
2208         } else {
2209                 chan->blocker = pthread_self();
2210                 if (ast_test_flag(chan, AST_FLAG_EXCEPTION)) {
2211                         if (chan->tech->exception)
2212                                 f = chan->tech->exception(chan);
2213                         else {
2214                                 ast_log(LOG_WARNING, "Exception flag set on '%s', but no exception handler\n", chan->name);
2215                                 f = &ast_null_frame;
2216                         }
2217                         /* Clear the exception flag */
2218                         ast_clear_flag(chan, AST_FLAG_EXCEPTION);
2219                 } else if (chan->tech->read)
2220                         f = chan->tech->read(chan);
2221                 else
2222                         ast_log(LOG_WARNING, "No read routine on channel %s\n", chan->name);
2223         }
2224
2225         if (f) {
2226                 /* if the channel driver returned more than one frame, stuff the excess
2227                    into the readq for the next ast_read call (note that we can safely assume
2228                    that the readq is empty, because otherwise we would not have called into
2229                    the channel driver and f would be only a single frame)
2230                 */
2231                 if (AST_LIST_NEXT(f, frame_list)) {
2232                         AST_LIST_HEAD_SET_NOLOCK(&chan->readq, AST_LIST_NEXT(f, frame_list));
2233                         AST_LIST_NEXT(f, frame_list) = NULL;
2234                 }
2235
2236                 switch (f->frametype) {
2237                 case AST_FRAME_CONTROL:
2238                         if (f->subclass == AST_CONTROL_ANSWER) {
2239                                 if (!ast_test_flag(chan, AST_FLAG_OUTGOING)) {
2240                                         ast_debug(1, "Ignoring answer on an inbound call!\n");
2241                                         ast_frfree(f);
2242                                         f = &ast_null_frame;
2243                                 } else if (prestate == AST_STATE_UP) {
2244                                         ast_debug(1, "Dropping duplicate answer!\n");
2245                                         ast_frfree(f);
2246                                         f = &ast_null_frame;
2247                                 } else {
2248                                         /* Answer the CDR */
2249                                         ast_setstate(chan, AST_STATE_UP);
2250                                         if (!chan->cdr) { /* up till now, this insertion hasn't been done. Therefore,
2251                                                                                  to keep from throwing off the basic order of the universe,
2252                                                                                  we will try to keep this cdr from getting posted. */
2253                                                 chan->cdr = ast_cdr_alloc();
2254                                                 ast_cdr_init(chan->cdr, chan);
2255                                                 ast_cdr_start(chan->cdr);
2256                                         }
2257
2258                                         ast_cdr_answer(chan->cdr);
2259                                 }
2260                         }
2261                         break;
2262                 case AST_FRAME_DTMF_END:
2263                         send_dtmf_event(chan, "Received", f->subclass, "No", "Yes");
2264                         ast_log(LOG_DTMF, "DTMF end '%c' received on %s, duration %ld ms\n", f->subclass, chan->name, f->len);
2265                         /* Queue it up if DTMF is deffered, or if DTMF emulation is forced.
2266                          * However, only let emulation be forced if the other end cares about BEGIN frames */
2267                         if ( ast_test_flag(chan, AST_FLAG_DEFER_DTMF) ||
2268                                 (ast_test_flag(chan, AST_FLAG_EMULATE_DTMF) && !ast_test_flag(chan, AST_FLAG_END_DTMF_ONLY)) ) {
2269                                 if (strlen(chan->dtmfq) < sizeof(chan->dtmfq) - 2)
2270                                         chan->dtmfq[strlen(chan->dtmfq)] = f->subclass;
2271                                 else
2272                                         ast_log(LOG_WARNING, "Dropping deferred DTMF digits on %s\n", chan->name);
2273                                 ast_frfree(f);
2274                                 f = &ast_null_frame;
2275                         } else if (!ast_test_flag(chan, AST_FLAG_IN_DTMF | AST_FLAG_END_DTMF_ONLY)) {
2276                                 if (!ast_tvzero(chan->dtmf_tv) &&
2277                                     ast_tvdiff_ms(ast_tvnow(), chan->dtmf_tv) < AST_MIN_DTMF_GAP) {
2278                                         /* If it hasn't been long enough, defer this digit */
2279                                         if (strlen(chan->dtmfq) < sizeof(chan->dtmfq) - 2)
2280                                                 chan->dtmfq[strlen(chan->dtmfq)] = f->subclass;
2281                                         else
2282                                                 ast_log(LOG_WARNING, "Dropping deferred DTMF digits on %s\n", chan->name);
2283                                         ast_frfree(f);
2284                                         f = &ast_null_frame;
2285                                 } else {
2286                                         /* There was no begin, turn this into a begin and send the end later */
2287                                         f->frametype = AST_FRAME_DTMF_BEGIN;
2288                                         ast_set_flag(chan, AST_FLAG_EMULATE_DTMF);
2289                                         chan->emulate_dtmf_digit = f->subclass;
2290                                         chan->dtmf_tv = ast_tvnow();
2291                                         if (f->len) {
2292                                                 if (f->len > AST_MIN_DTMF_DURATION)
2293                                                         chan->emulate_dtmf_duration = f->len;
2294                                                 else
2295                                                         chan->emulate_dtmf_duration = AST_MIN_DTMF_DURATION;
2296                                         } else
2297                                                 chan->emulate_dtmf_duration = AST_DEFAULT_EMULATE_DTMF_DURATION;
2298                                 }
2299                         } else {
2300                                 struct timeval now = ast_tvnow();
2301                                 ast_clear_flag(chan, AST_FLAG_IN_DTMF);
2302                                 if (!f->len)
2303                                         f->len = ast_tvdiff_ms(now, chan->dtmf_tv);
2304                                 if (f->len < AST_MIN_DTMF_DURATION) {
2305                                         ast_set_flag(chan, AST_FLAG_EMULATE_DTMF);
2306                                         chan->emulate_dtmf_digit = f->subclass;
2307                                         chan->emulate_dtmf_duration = AST_MIN_DTMF_DURATION - f->len;
2308                                         f = &ast_null_frame;
2309                                 } else
2310                                         chan->dtmf_tv = now;
2311                         }
2312                         break;
2313                 case AST_FRAME_DTMF_BEGIN:
2314                         send_dtmf_event(chan, "Received", f->subclass, "Yes", "No");
2315                         ast_log(LOG_DTMF, "DTMF begin '%c' received on %s\n", f->subclass, chan->name);
2316                         if ( ast_test_flag(chan, AST_FLAG_DEFER_DTMF | AST_FLAG_END_DTMF_ONLY) ||
2317                             (!ast_tvzero(chan->dtmf_tv) &&
2318                               ast_tvdiff_ms(ast_tvnow(), chan->dtmf_tv) < AST_MIN_DTMF_GAP) ) {
2319                                 ast_frfree(f);
2320                                 f = &ast_null_frame;
2321                         } else {
2322                                 ast_set_flag(chan, AST_FLAG_IN_DTMF);
2323                                 chan->dtmf_tv = ast_tvnow();
2324                         }
2325                         break;
2326                 case AST_FRAME_NULL:
2327                         if (ast_test_flag(chan, AST_FLAG_EMULATE_DTMF)) {
2328                                 struct timeval now = ast_tvnow();
2329                                 if (ast_tvdiff_ms(now, chan->dtmf_tv) >= chan->emulate_dtmf_duration) {
2330                                         chan->emulate_dtmf_duration = 0;
2331                                         ast_frfree(f);
2332                                         f = &chan->dtmff;
2333                                         f->frametype = AST_FRAME_DTMF_END;
2334                                         f->subclass = chan->emulate_dtmf_digit;
2335                                         f->len = ast_tvdiff_ms(now, chan->dtmf_tv);
2336                                         chan->dtmf_tv = now;
2337                                         ast_clear_flag(chan, AST_FLAG_EMULATE_DTMF);
2338                                         chan->emulate_dtmf_digit = 0;
2339                                 }
2340                         }
2341                         break;
2342                 case AST_FRAME_VOICE:
2343                         /* The EMULATE_DTMF flag must be cleared here as opposed to when the duration
2344                          * is reached , because we want to make sure we pass at least one
2345                          * voice frame through before starting the next digit, to ensure a gap
2346                          * between DTMF digits. */
2347                         if (ast_test_flag(chan, AST_FLAG_EMULATE_DTMF) && !chan->emulate_dtmf_duration) {
2348                                 ast_clear_flag(chan, AST_FLAG_EMULATE_DTMF);
2349                                 chan->emulate_dtmf_digit = 0;
2350                         }
2351
2352                         if (dropaudio || ast_test_flag(chan, AST_FLAG_IN_DTMF)) {
2353                                 if (dropaudio)
2354                                         ast_read_generator_actions(chan, f);
2355                                 ast_frfree(f);
2356                                 f = &ast_null_frame;
2357                         }
2358
2359                         if (ast_test_flag(chan, AST_FLAG_EMULATE_DTMF) && !ast_test_flag(chan, AST_FLAG_IN_DTMF)) {
2360                                 struct timeval now = ast_tvnow();
2361                                 if (ast_tvdiff_ms(now, chan->dtmf_tv) >= chan->emulate_dtmf_duration) {
2362                                         chan->emulate_dtmf_duration = 0;
2363                                         ast_frfree(f);
2364                                         f = &chan->dtmff;
2365                                         f->frametype = AST_FRAME_DTMF_END;
2366                                         f->subclass = chan->emulate_dtmf_digit;
2367                                         f->len = ast_tvdiff_ms(now, chan->dtmf_tv);
2368                                         chan->dtmf_tv = now;
2369                                 } else {
2370                                         /* Drop voice frames while we're still in the middle of the digit */
2371                                         ast_frfree(f);
2372                                         f = &ast_null_frame;
2373                                 }
2374                         } else if ((f->frametype == AST_FRAME_VOICE) && !(f->subclass & chan->nativeformats)) {
2375                                 /* This frame can't be from the current native formats -- drop it on the
2376                                    floor */
2377                                 ast_log(LOG_NOTICE, "Dropping incompatible voice frame on %s of format %s since our native format has changed to %s\n",
2378                                         chan->name, ast_getformatname(f->subclass), ast_getformatname(chan->nativeformats));
2379                                 ast_frfree(f);
2380                                 f = &ast_null_frame;
2381                         } else if ((f->frametype == AST_FRAME_VOICE)) {
2382                                 if (chan->spies)
2383                                         queue_frame_to_spies(chan, f, SPY_READ);
2384
2385                                 if (chan->monitor && chan->monitor->read_stream ) {
2386                                         /* XXX what does this do ? */
2387 #ifndef MONITOR_CONSTANT_DELAY
2388                                         int jump = chan->outsmpl - chan->insmpl - 4 * f->samples;
2389                                         if (jump >= 0) {
2390                                                 jump = chan->outsmpl - chan->insmpl;
2391                                                 if (ast_seekstream(chan->monitor->read_stream, jump, SEEK_FORCECUR) == -1)
2392                                                         ast_log(LOG_WARNING, "Failed to perform seek in monitoring read stream, synchronization between the files may be broken\n");
2393                                                 chan->insmpl += jump + f->samples;
2394                                         } else
2395                                                 chan->insmpl+= f->samples;
2396 #else
2397                                         int jump = chan->outsmpl - chan->insmpl;
2398                                         if (jump - MONITOR_DELAY >= 0) {
2399                                                 if (ast_seekstream(chan->monitor->read_stream, jump - f->samples, SEEK_FORCECUR) == -1)
2400                                                         ast_log(LOG_WARNING, "Failed to perform seek in monitoring read stream, synchronization between the files may be broken\n");
2401                                                 chan->insmpl += jump;
2402                                         } else
2403                                                 chan->insmpl += f->samples;
2404 #endif
2405                                         if (chan->monitor->state == AST_MONITOR_RUNNING) {
2406                                                 if (ast_writestream(chan->monitor->read_stream, f) < 0)
2407                                                         ast_log(LOG_WARNING, "Failed to write data to channel monitor read stream\n");
2408                                         }
2409                                 }
2410
2411                                 if (chan->readtrans && (f = ast_translate(chan->readtrans, f, 1)) == NULL)
2412                                         f = &ast_null_frame;
2413                                 else
2414                                         /* Run generator sitting on the line if timing device not available
2415                                          * and synchronous generation of outgoing frames is necessary       */
2416                                         ast_read_generator_actions(chan, f);
2417                         }
2418                 default:
2419                         /* Just pass it on! */
2420                         break;
2421                 }
2422         } else {
2423                 /* Make sure we always return NULL in the future */
2424                 chan->_softhangup |= AST_SOFTHANGUP_DEV;
2425                 if (chan->generator)
2426                         ast_deactivate_generator(chan);
2427                 /* End the CDR if appropriate */
2428                 if (chan->cdr)
2429                         ast_cdr_end(chan->cdr);
2430         }
2431
2432         /* High bit prints debugging */
2433         if (chan->fin & DEBUGCHAN_FLAG)
2434                 ast_frame_dump(chan->name, f, "<<");
2435         chan->fin = FRAMECOUNT_INC(chan->fin);
2436
2437 done:
2438         if (chan->music_state && chan->generator && chan->generator->digit && f && f->frametype == AST_FRAME_DTMF_END)
2439                 chan->generator->digit(chan, f->subclass);
2440
2441         ast_channel_unlock(chan);
2442         return f;
2443 }
2444
2445 int ast_internal_timing_enabled(struct ast_channel *chan)
2446 {
2447         int ret = ast_opt_internal_timing && chan->timingfd > -1;
2448         ast_debug(5, "Internal timing is %s (option_internal_timing=%d chan->timingfd=%d)\n", ret? "enabled": "disabled", ast_opt_internal_timing, chan->timingfd);
2449         return ret;
2450 }
2451
2452 struct ast_frame *ast_read(struct ast_channel *chan)
2453 {
2454         return __ast_read(chan, 0);
2455 }
2456
2457 struct ast_frame *ast_read_noaudio(struct ast_channel *chan)
2458 {
2459         return __ast_read(chan, 1);
2460 }
2461
2462 int ast_indicate(struct ast_channel *chan, int condition)
2463 {
2464         return ast_indicate_data(chan, condition, NULL, 0);
2465 }
2466
2467 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen)
2468 {
2469         int res = -1;
2470
2471         ast_channel_lock(chan);
2472         /* Stop if we're a zombie or need a soft hangup */
2473         if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
2474                 ast_channel_unlock(chan);
2475                 return -1;
2476         }
2477         if (chan->tech->indicate)
2478                 res = chan->tech->indicate(chan, condition, data, datalen);
2479         ast_channel_unlock(chan);
2480         if (!chan->tech->indicate || res) {
2481                 /*
2482                  * Device does not support (that) indication, lets fake
2483                  * it by doing our own tone generation. (PM2002)
2484                  */
2485                 if (condition < 0)
2486                         ast_playtones_stop(chan);
2487                 else {
2488                         const struct ind_tone_zone_sound *ts = NULL;
2489                         switch (condition) {
2490                         case AST_CONTROL_RINGING:
2491                                 ts = ast_get_indication_tone(chan->zone, "ring");
2492                                 break;
2493                         case AST_CONTROL_BUSY:
2494                                 ts = ast_get_indication_tone(chan->zone, "busy");
2495                                 break;
2496                         case AST_CONTROL_CONGESTION:
2497                                 ts = ast_get_indication_tone(chan->zone, "congestion");
2498                                 break;
2499                         }
2500                         if (ts && ts->data[0]) {
2501                                 ast_debug(1, "Driver for channel '%s' does not support indication %d, emulating it\n", chan->name, condition);
2502                                 ast_playtones_start(chan,0,ts->data, 1);
2503                                 res = 0;
2504                         } else if (condition == AST_CONTROL_PROGRESS) {
2505                                 /* ast_playtones_stop(chan); */
2506                         } else if (condition == AST_CONTROL_PROCEEDING) {
2507                                 /* Do nothing, really */
2508                         } else if (condition == AST_CONTROL_HOLD) {
2509                                 /* Do nothing.... */
2510                         } else if (condition == AST_CONTROL_UNHOLD) {
2511                                 /* Do nothing.... */
2512                         } else if (condition == AST_CONTROL_VIDUPDATE) {
2513                                 /* Do nothing.... */
2514                         } else {
2515                                 /* not handled */
2516                                 ast_log(LOG_WARNING, "Unable to handle indication %d for '%s'\n", condition, chan->name);
2517                                 res = -1;
2518                         }
2519                 }
2520         }
2521         return res;
2522 }
2523
2524 int ast_recvchar(struct ast_channel *chan, int timeout)
2525 {
2526         int c;
2527         char *buf = ast_recvtext(chan, timeout);
2528         if (buf == NULL)
2529                 return -1;      /* error or timeout */
2530         c = *(unsigned char *)buf;
2531         ast_free(buf);
2532         return c;
2533 }
2534
2535 char *ast_recvtext(struct ast_channel *chan, int timeout)
2536 {
2537         int res, done = 0;
2538         char *buf = NULL;
2539
2540         while (!done) {
2541                 struct ast_frame *f;
2542                 if (ast_check_hangup(chan))
2543                         break;
2544                 res = ast_waitfor(chan, timeout);
2545                 if (res <= 0) /* timeout or error */
2546                         break;
2547                 timeout = res;  /* update timeout */
2548                 f = ast_read(chan);
2549                 if (f == NULL)
2550                         break; /* no frame */
2551                 if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP)
2552                         done = 1;       /* force a break */
2553                 else if (f->frametype == AST_FRAME_TEXT) {              /* what we want */
2554                         buf = ast_strndup((char *) f->data, f->datalen);        /* dup and break */
2555                         done = 1;
2556                 }
2557                 ast_frfree(f);
2558         }
2559         return buf;
2560 }
2561
2562 int ast_sendtext(struct ast_channel *chan, const char *text)
2563 {
2564         int res = 0;
2565         /* Stop if we're a zombie or need a soft hangup */
2566         if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
2567                 return -1;
2568         CHECK_BLOCKING(chan);
2569         if (chan->tech->send_text)
2570                 res = chan->tech->send_text(chan, text);
2571         ast_clear_flag(chan, AST_FLAG_BLOCKING);
2572         return res;
2573 }
2574
2575 int ast_senddigit_begin(struct ast_channel *chan, char digit)
2576 {
2577         /* Device does not support DTMF tones, lets fake
2578          * it by doing our own generation. */
2579         static const char* dtmf_tones[] = {
2580                 "941+1336", /* 0 */
2581                 "697+1209", /* 1 */
2582                 "697+1336", /* 2 */
2583                 "697+1477", /* 3 */
2584                 "770+1209", /* 4 */
2585                 "770+1336", /* 5 */
2586                 "770+1477", /* 6 */
2587                 "852+1209", /* 7 */
2588                 "852+1336", /* 8 */
2589                 "852+1477", /* 9 */
2590                 "697+1633", /* A */
2591                 "770+1633", /* B */
2592                 "852+1633", /* C */
2593                 "941+1633", /* D */
2594                 "941+1209", /* * */
2595                 "941+1477"  /* # */
2596         };
2597
2598         if (!chan->tech->send_digit_begin)
2599                 return 0;
2600
2601         if (!chan->tech->send_digit_begin(chan, digit))
2602                 return 0;
2603
2604         if (digit >= '0' && digit <='9')
2605                 ast_playtones_start(chan, 0, dtmf_tones[digit-'0'], 0);
2606         else if (digit >= 'A' && digit <= 'D')
2607                 ast_playtones_start(chan, 0, dtmf_tones[digit-'A'+10], 0);
2608         else if (digit == '*')
2609                 ast_playtones_start(chan, 0, dtmf_tones[14], 0);
2610         else if (digit == '#')
2611                 ast_playtones_start(chan, 0, dtmf_tones[15], 0);
2612         else {
2613                 /* not handled */
2614                 ast_debug(1, "Unable to generate DTMF tone '%c' for '%s'\n", digit, chan->name);
2615         }
2616
2617         return 0;
2618 }
2619
2620 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration)
2621 {
2622         int res = -1;
2623
2624         if (chan->tech->send_digit_end)
2625                 res = chan->tech->send_digit_end(chan, digit, duration);
2626
2627         if (res && chan->generator)
2628                 ast_playtones_stop(chan);
2629
2630         return 0;
2631 }
2632
2633 int ast_senddigit(struct ast_channel *chan, char digit)
2634 {
2635         if (chan->tech->send_digit_begin) {
2636                 ast_senddigit_begin(chan, digit);
2637                 ast_safe_sleep(chan, 100); /* XXX 100ms ... probably should be configurable */
2638         }
2639
2640         return ast_senddigit_end(chan, digit, 100);
2641 }
2642
2643 int ast_prod(struct ast_channel *chan)
2644 {
2645         struct ast_frame a = { AST_FRAME_VOICE };
2646         char nothing[128];
2647
2648         /* Send an empty audio frame to get things moving */
2649         if (chan->_state != AST_STATE_UP) {
2650                 ast_debug(1, "Prodding channel '%s'\n", chan->name);
2651                 a.subclass = chan->rawwriteformat;
2652                 a.data = nothing + AST_FRIENDLY_OFFSET;
2653                 a.src = "ast_prod";
2654                 if (ast_write(chan, &a))
2655                         ast_log(LOG_WARNING, "Prodding channel '%s' failed\n", chan->name);
2656         }
2657         return 0;
2658 }
2659
2660 int ast_write_video(struct ast_channel *chan, struct ast_frame *fr)
2661 {
2662         int res;
2663         if (!chan->tech->write_video)
2664                 return 0;
2665         res = ast_write(chan, fr);
2666         if (!res)
2667                 res = 1;
2668         return res;
2669 }
2670
2671 int ast_write(struct ast_channel *chan, struct ast_frame *fr)
2672 {
2673         int res = -1;
2674         struct ast_frame *f = NULL;
2675
2676         /* Stop if we're a zombie or need a soft hangup */
2677         ast_channel_lock(chan);
2678         if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
2679                 goto done;
2680
2681         /* Handle any pending masquerades */
2682         if (chan->masq && ast_do_masquerade(chan)) {
2683                 ast_log(LOG_WARNING, "Failed to perform masquerade\n");
2684                 goto done;
2685         }
2686         if (chan->masqr) {
2687                 res = 0;        /* XXX explain, why 0 ? */
2688                 goto done;
2689         }
2690         if (chan->generatordata) {
2691                 if (ast_test_flag(chan, AST_FLAG_WRITE_INT))
2692                         ast_deactivate_generator(chan);
2693                 else {
2694                         if (fr->frametype == AST_FRAME_DTMF_END) {
2695                                 /* There is a generator running while we're in the middle of a digit.
2696                                  * It's probably inband DTMF, so go ahead and pass it so it can
2697                                  * stop the generator */
2698                                 ast_clear_flag(chan, AST_FLAG_BLOCKING);
2699                                 ast_channel_unlock(chan);
2700                                 res = ast_senddigit_end(chan, fr->subclass, fr->len);
2701                                 ast_channel_lock(chan);
2702                                 CHECK_BLOCKING(chan);
2703                         } else if (fr->frametype == AST_FRAME_CONTROL && fr->subclass == AST_CONTROL_UNHOLD) {
2704                                 /* This is a side case where Echo is basically being called and the person put themselves on hold and took themselves off hold */
2705                                 res = (chan->tech->indicate == NULL) ? 0 :
2706                                         chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
2707                         }
2708                         res = 0;        /* XXX explain, why 0 ? */
2709                         goto done;
2710                 }
2711         }
2712         /* High bit prints debugging */
2713         if (chan->fout & DEBUGCHAN_FLAG)
2714                 ast_frame_dump(chan->name, fr, ">>");
2715         CHECK_BLOCKING(chan);
2716         switch (fr->frametype) {
2717         case AST_FRAME_CONTROL:
2718                 res = (chan->tech->indicate == NULL) ? 0 :
2719                         chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
2720                 break;
2721         case AST_FRAME_DTMF_BEGIN:
2722                 send_dtmf_event(chan, "Sent", fr->subclass, "Yes", "No");
2723                 ast_clear_flag(chan, AST_FLAG_BLOCKING);
2724                 ast_channel_unlock(chan);
2725                 res = ast_senddigit_begin(chan, fr->subclass);
2726                 ast_channel_lock(chan);
2727                 CHECK_BLOCKING(chan);
2728                 break;
2729         case AST_FRAME_DTMF_END:
2730                 send_dtmf_event(chan, "Sent", fr->subclass, "No", "Yes");
2731                 ast_clear_flag(chan, AST_FLAG_BLOCKING);
2732                 ast_channel_unlock(chan);
2733                 res = ast_senddigit_end(chan, fr->subclass, fr->len);
2734                 ast_channel_lock(chan);
2735                 CHECK_BLOCKING(chan);
2736                 break;
2737         case AST_FRAME_TEXT:
2738                 if (fr->subclass == AST_FORMAT_T140) {
2739                         res = (chan->tech->write_text == NULL) ? 0 :
2740                                 chan->tech->write_text(chan, fr);
2741                 } else {
2742                         res = (chan->tech->send_text == NULL) ? 0 :
2743                                 chan->tech->send_text(chan, (char *) fr->data);
2744                 }
2745                 break;
2746         case AST_FRAME_HTML:
2747                 res = (chan->tech->send_html == NULL) ? 0 :
2748                         chan->tech->send_html(chan, fr->subclass, (char *) fr->data, fr->datalen);
2749                 break;
2750         case AST_FRAME_VIDEO:
2751                 /* XXX Handle translation of video codecs one day XXX */
2752                 res = (chan->tech->write_video == NULL) ? 0 :
2753                         chan->tech->write_video(chan, fr);
2754                 break;
2755         case AST_FRAME_MODEM:
2756                 res = (chan->tech->write == NULL) ? 0 :
2757                         chan->tech->write(chan, fr);
2758                 break;
2759         case AST_FRAME_VOICE:
2760                 if (chan->tech->write == NULL)
2761                         break;  /*! \todo XXX should return 0 maybe ? */
2762
2763                 /* If someone is whispering on this channel then we must ensure that we are always getting signed linear frames */
2764                 if (ast_test_flag(chan, AST_FLAG_WHISPER)) {
2765                         if (fr->subclass == AST_FORMAT_SLINEAR)
2766                                 f = fr;
2767                         else {
2768                                 ast_mutex_lock(&chan->whisper->lock);
2769                                 if (chan->writeformat != AST_FORMAT_SLINEAR) {
2770                                         /* Rebuild the translation path and set our write format back to signed linear */
2771                                         chan->whisper->original_format = chan->writeformat;
2772                                         ast_set_write_format(chan, AST_FORMAT_SLINEAR);
2773                                         if (chan->whisper->path)
2774                                                 ast_translator_free_path(chan->whisper->path);
2775                                         chan->whisper->path = ast_translator_build_path(AST_FORMAT_SLINEAR, chan->whisper->original_format);
2776                                 }
2777                                 /* Translate frame using the above translation path */
2778                                 f = (chan->whisper->path) ? ast_translate(chan->whisper->path, fr, 0) : fr;
2779                                 ast_mutex_unlock(&chan->whisper->lock);
2780                         }
2781                 } else {
2782                         /* If the frame is in the raw write format, then it's easy... just use the frame - otherwise we will have to translate */
2783                         if (fr->subclass == chan->rawwriteformat)
2784                                 f = fr;
2785                         else
2786                                 f = (chan->writetrans) ? ast_translate(chan->writetrans, fr, 0) : fr;
2787                 }
2788
2789                 /* If we have no frame of audio, then we have to bail out */
2790                 if (f == NULL) {
2791                         res = 0;
2792                         break;
2793                 }
2794
2795                 /* If spies are on the channel then queue the frame out to them */
2796                 if (chan->spies)
2797                         queue_frame_to_spies(chan, f, SPY_WRITE);
2798
2799                 /* If Monitor is running on this channel, then we have to write frames out there too */
2800                 if (chan->monitor && chan->monitor->write_stream) {
2801                         /* XXX must explain this code */
2802 #ifndef MONITOR_CONSTANT_DELAY
2803                         int jump = chan->insmpl - chan->outsmpl - 4 * f->samples;
2804                         if (jump >= 0) {
2805                                 jump = chan->insmpl - chan->outsmpl;
2806                                 if (ast_seekstream(chan->monitor->write_stream, jump, SEEK_FORCECUR) == -1)
2807                                         ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
2808                                 chan->outsmpl += jump + f->samples;
2809                         } else
2810                                 chan->outsmpl += f->samples;
2811 #else
2812                         int jump = chan->insmpl - chan->outsmpl;
2813                         if (jump - MONITOR_DELAY >= 0) {
2814                                 if (ast_seekstream(chan->monitor->write_stream, jump - f->samples, SEEK_FORCECUR) == -1)
2815                                         ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
2816                                 chan->outsmpl += jump;
2817                         } else
2818                                 chan->outsmpl += f->samples;
2819 #endif
2820                         if (chan->monitor->state == AST_MONITOR_RUNNING) {
2821                                 if (ast_writestream(chan->monitor->write_stream, f) < 0)
2822                                         ast_log(LOG_WARNING, "Failed to write data to channel monitor write stream\n");
2823                         }
2824                 }
2825
2826                 /* Finally the good part! Write this out to the channel */
2827                 if (ast_test_flag(chan, AST_FLAG_WHISPER)) {
2828                         /* frame is assumed to be in SLINEAR, since that is
2829                            required for whisper mode */
2830                         ast_frame_adjust_volume(f, -2);
2831                         if (ast_slinfactory_available(&chan->whisper->sf) >= f->samples) {
2832                                 short buf[f->samples];
2833                                 struct ast_frame whisper = {
2834                                         .frametype = AST_FRAME_VOICE,
2835                                         .subclass = AST_FORMAT_SLINEAR,
2836                                         .data = buf,
2837                                         .datalen = sizeof(buf),
2838                                         .samples = f->samples,
2839                                 };
2840
2841                                 ast_mutex_lock(&chan->whisper->lock);
2842                                 if (ast_slinfactory_read(&chan->whisper->sf, buf, f->samples))
2843                                         ast_frame_slinear_sum(f, &whisper);
2844                                 ast_mutex_unlock(&chan->whisper->lock);
2845                         }
2846                         /* and now put it through the regular translator */
2847                         f = (chan->writetrans) ? ast_translate(chan->writetrans, f, 0) : f;
2848                 }
2849                 res = f ? chan->tech->write(chan, f) : 0;
2850                 break;
2851         case AST_FRAME_NULL:
2852         case AST_FRAME_IAX:
2853                 /* Ignore these */
2854                 res = 0;
2855                 break;
2856         default:
2857                 /* At this point, fr is the incoming frame and f is NULL.  Channels do
2858                  * not expect to get NULL as a frame pointer and will segfault.  Hence,
2859                  * we output the original frame passed in. */
2860                 res = chan->tech->write(chan, fr);
2861                 break;
2862         }
2863
2864         if (f && f != fr)
2865                 ast_frfree(f);
2866         ast_clear_flag(chan, AST_FLAG_BLOCKING);
2867         /* Consider a write failure to force a soft hangup */
2868         if (res < 0)
2869                 chan->_softhangup |= AST_SOFTHANGUP_DEV;
2870         else {
2871                 chan->fout = FRAMECOUNT_INC(chan->fout);
2872         }
2873 done:
2874         ast_channel_unlock(chan);
2875         return res;
2876 }
2877
2878 static int set_format(struct ast_channel *chan, int fmt, int *rawformat, int *format,
2879                       struct ast_trans_pvt **trans, const int direction)
2880 {
2881         int native;
2882         int res;
2883
2884         /* Make sure we only consider audio */
2885         fmt &= AST_FORMAT_AUDIO_MASK;
2886
2887         native = chan->nativeformats;
2888         /* Find a translation path from the native format to one of the desired formats */
2889         if (!direction)
2890                 /* reading */
2891                 res = ast_translator_best_choice(&fmt, &native);
2892         else
2893                 /* writing */
2894                 res = ast_translator_best_choice(&native, &fmt);
2895
2896         if (res < 0) {
2897                 ast_log(LOG_WARNING, "Unable to find a codec translation path from %s to %s\n",
2898                         ast_getformatname(native), ast_getformatname(fmt));
2899                 return -1;
2900         }
2901
2902         /* Now we have a good choice for both. */
2903         ast_channel_lock(chan);
2904
2905         if ((*rawformat == native) && (*format == fmt) && ((*rawformat == *format) || (*trans))) {
2906                 /* the channel is already in these formats, so nothing to do */
2907                 ast_channel_unlock(chan);
2908                 return 0;
2909         }
2910
2911         *rawformat = native;
2912         /* User perspective is fmt */
2913         *format = fmt;
2914         /* Free any read translation we have right now */
2915         if (*trans)
2916                 ast_translator_free_path(*trans);
2917         /* Build a translation path from the raw format to the desired format */
2918         if (!direction)
2919                 /* reading */
2920                 *trans = ast_translator_build_path(*format, *rawformat);
2921         else
2922                 /* writing */
2923                 *trans = ast_translator_build_path(*rawformat, *format);
2924         ast_channel_unlock(chan);
2925         ast_debug(1, "Set channel %s to %s format %s\n", chan->name,
2926                 direction ? "write" : "read", ast_getformatname(fmt));
2927         return 0;
2928 }
2929
2930 int ast_set_read_format(struct ast_channel *chan, int fmt)
2931 {
2932         return set_format(chan, fmt, &chan->rawreadformat, &chan->readformat,
2933                           &chan->readtrans, 0);
2934 }
2935
2936 int ast_set_write_format(struct ast_channel *chan, int fmt)
2937 {
2938         return set_format(chan, fmt, &chan->rawwriteformat, &chan->writeformat,
2939                           &chan->writetrans, 1);
2940 }
2941
2942 struct ast_channel *__ast_request_and_dial(const char *type, int format, void *data, int timeout, int *outstate, const char *cid_num, const char *cid_name, struct outgoing_helper *oh)
2943 {
2944         int dummy_outstate;
2945         int cause = 0;
2946         struct ast_channel *chan;
2947         int res = 0;
2948
2949         if (outstate)
2950                 *outstate = 0;
2951         else
2952                 outstate = &dummy_outstate;     /* make outstate always a valid pointer */
2953
2954         chan = ast_request(type, format, data, &cause);
2955         if (!chan) {
2956                 ast_log(LOG_NOTICE, "Unable to request channel %s/%s\n", type, (char *)data);
2957                 /* compute error and return */
2958                 if (cause == AST_CAUSE_BUSY)
2959                         *outstate = AST_CONTROL_BUSY;
2960                 else if (cause == AST_CAUSE_CONGESTION)
2961                         *outstate = AST_CONTROL_CONGESTION;
2962                 return NULL;
2963         }
2964
2965         if (oh) {
2966                 if (oh->vars)
2967                         ast_set_variables(chan, oh->vars);
2968                 /* XXX why is this necessary, for the parent_channel perhaps ? */
2969                 if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name))
2970                         ast_set_callerid(chan, oh->cid_num, oh->cid_name, oh->cid_num);
2971                 if (oh->parent_channel) {
2972                         ast_channel_inherit_variables(oh->parent_channel, chan);
2973                         ast_channel_datastore_inherit(oh->parent_channel, chan);
2974                 }
2975                 if (oh->account)
2976                         ast_cdr_setaccount(chan, oh->account);
2977         }
2978         ast_set_callerid(chan, cid_num, cid_name, cid_num);
2979
2980
2981
2982         if (!chan->cdr) { /* up till now, this insertion hasn't been done. Therefore,
2983                                 to keep from throwing off the basic order of the universe,
2984                                 we will try to keep this cdr from getting posted. */
2985                 chan->cdr = ast_cdr_alloc();
2986                 ast_cdr_init(chan->cdr, chan);
2987                 ast_cdr_start(chan->cdr);
2988         }
2989         if (ast_call(chan, data, 0)) {  /* ast_call failed... */
2990                 ast_log(LOG_NOTICE, "Unable to call channel %s/%s\n", type, (char *)data);
2991         } else {
2992                 res = 1;        /* mark success in case chan->_state is already AST_STATE_UP */
2993                 while (timeout && chan->_state != AST_STATE_UP) {
2994                         struct ast_frame *f;
2995                         res = ast_waitfor(chan, timeout);
2996                         if (res <= 0) /* error, timeout, or done */
2997                                 break;
2998                         if (timeout > -1)
2999                                 timeout = res;
3000                         f = ast_read(chan);
3001                         if (!f) {
3002                                 *outstate = AST_CONTROL_HANGUP;
3003                                 res = 0;
3004                                 break;
3005                         }
3006                         if (f->frametype == AST_FRAME_CONTROL) {
3007                                 switch (f->subclass) {
3008                                 case AST_CONTROL_RINGING:       /* record but keep going */
3009                                         *outstate = f->subclass;
3010                                         break;
3011
3012                                 case AST_CONTROL_BUSY:
3013                                 case AST_CONTROL_CONGESTION:
3014                                 case AST_CONTROL_ANSWER:
3015                                         *outstate = f->subclass;
3016                                         timeout = 0;            /* trick to force exit from the while() */
3017                                         break;
3018
3019                                 /* Ignore these */
3020                                 case AST_CONTROL_PROGRESS:
3021                                 case AST_CONTROL_PROCEEDING:
3022                                 case AST_CONTROL_HOLD:
3023                                 case AST_CONTROL_UNHOLD:
3024                                 case AST_CONTROL_VIDUPDATE:
3025                                 case -1:                        /* Ignore -- just stopping indications */
3026                                         break;
3027
3028                                 default:
3029                                         ast_log(LOG_NOTICE, "Don't know what to do with control frame %d\n", f->subclass);
3030                                 }
3031                         }
3032                         ast_frfree(f);
3033                 }
3034         }
3035
3036         /* Final fixups */
3037         if (oh) {
3038                 if (!ast_strlen_zero(oh->context))
3039                         ast_copy_string(chan->context, oh->context, sizeof(chan->context));
3040                 if (!ast_strlen_zero(oh->exten))
3041                         ast_copy_string(chan->exten, oh->exten, sizeof(chan->exten));
3042                 if (oh->priority)
3043                         chan->priority = oh->priority;
3044         }
3045         if (chan->_state == AST_STATE_UP)
3046                 *outstate = AST_CONTROL_ANSWER;
3047
3048         if (res <= 0) {
3049                 if (!chan->cdr && (chan->cdr = ast_cdr_alloc()))
3050                         ast_cdr_init(chan->cdr, chan);
3051                 if (chan->cdr) {
3052                         char tmp[256];
3053                         snprintf(tmp, sizeof(tmp), "%s/%s", type, (char *)data);
3054                         ast_c