media formats: re-architect handling of media for performance improvements
[asterisk/asterisk.git] / channels / chan_console.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006 - 2008, Digium, Inc.
5  *
6  * Russell Bryant <russell@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 /*! 
20  * \file 
21  * \brief Cross-platform console channel driver 
22  *
23  * \author Russell Bryant <russell@digium.com>
24  *
25  * \note Some of the code in this file came from chan_oss and chan_alsa.
26  *       chan_oss,  Mark Spencer <markster@digium.com>
27  *       chan_oss,  Luigi Rizzo
28  *       chan_alsa, Matthew Fredrickson <creslin@digium.com>
29  * 
30  * \ingroup channel_drivers
31  *
32  * Portaudio http://www.portaudio.com/
33  *
34  * To install portaudio v19 from svn, check it out using the following command:
35  *  - svn co https://www.portaudio.com/repos/portaudio/branches/v19-devel
36  *
37  * \note Since this works with any audio system that libportaudio supports,
38  * including ALSA and OSS, this may someday deprecate chan_alsa and chan_oss.
39  * However, before that can be done, it needs to *at least* have all of the
40  * features that these other channel drivers have.  The features implemented
41  * in at least one of the other console channel drivers that are not yet
42  * implemented here are:
43  *
44  * - Set Auto-answer from the dialplan
45  * - transfer CLI command
46  * - boost CLI command and .conf option
47  * - console_video support
48  */
49
50 /*! \li \ref chan_console.c uses the configuration file \ref console.conf
51  * \addtogroup configuration_file
52  */
53
54 /*! \page console.conf console.conf
55  * \verbinclude console.conf.sample
56  */
57
58 /*** MODULEINFO
59         <depend>portaudio</depend>
60         <support_level>extended</support_level>
61  ***/
62
63 #include "asterisk.h"
64
65 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
66
67 #include <sys/signal.h>  /* SIGURG */
68
69 #include <portaudio.h>
70
71 #include "asterisk/module.h"
72 #include "asterisk/channel.h"
73 #include "asterisk/pbx.h"
74 #include "asterisk/causes.h"
75 #include "asterisk/cli.h"
76 #include "asterisk/musiconhold.h"
77 #include "asterisk/callerid.h"
78 #include "asterisk/astobj2.h"
79 #include "asterisk/stasis_channels.h"
80 #include "asterisk/format_cache.h"
81
82 /*! 
83  * \brief The sample rate to request from PortAudio 
84  *
85  * \todo Make this optional.  If this is only going to talk to 8 kHz endpoints,
86  *       then it makes sense to use 8 kHz natively.
87  */
88 #define SAMPLE_RATE      16000
89
90 /*! 
91  * \brief The number of samples to configure the portaudio stream for
92  *
93  * 320 samples (20 ms) is the most common frame size in Asterisk.  So, the code
94  * in this module reads 320 sample frames from the portaudio stream and queues
95  * them up on the Asterisk channel.  Frames of any size can be written to a
96  * portaudio stream, but the portaudio documentation does say that for high
97  * performance applications, the data should be written to Pa_WriteStream in
98  * the same size as what is used to initialize the stream.
99  */
100 #define NUM_SAMPLES      320
101
102 /*! \brief Mono Input */
103 #define INPUT_CHANNELS   1
104
105 /*! \brief Mono Output */
106 #define OUTPUT_CHANNELS  1
107
108 /*! 
109  * \brief Maximum text message length
110  * \note This should be changed if there is a common definition somewhere
111  *       that defines the maximum length of a text message.
112  */
113 #define TEXT_SIZE       256
114
115 /*! \brief Dance, Kirby, Dance! @{ */
116 #define V_BEGIN " --- <(\"<) --- "
117 #define V_END   " --- (>\")> ---\n"
118 /*! @} */
119
120 static const char config_file[] = "console.conf";
121
122 /*!
123  * \brief Console pvt structure
124  *
125  * Currently, this is a singleton object.  However, multiple instances will be
126  * needed when this module is updated for multiple device support.
127  */
128 static struct console_pvt {
129         AST_DECLARE_STRING_FIELDS(
130                 /*! Name of the device */
131                 AST_STRING_FIELD(name);
132                 AST_STRING_FIELD(input_device);
133                 AST_STRING_FIELD(output_device);
134                 /*! Default context for outgoing calls */
135                 AST_STRING_FIELD(context);
136                 /*! Default extension for outgoing calls */
137                 AST_STRING_FIELD(exten);
138                 /*! Default CallerID number */
139                 AST_STRING_FIELD(cid_num);
140                 /*! Default CallerID name */
141                 AST_STRING_FIELD(cid_name);
142                 /*! Default MOH class to listen to, if:
143                  *    - No MOH class set on the channel
144                  *    - Peer channel putting this device on hold did not suggest a class */
145                 AST_STRING_FIELD(mohinterpret);
146                 /*! Default language */
147                 AST_STRING_FIELD(language);
148                 /*! Default parkinglot */
149                 AST_STRING_FIELD(parkinglot);
150         );
151         /*! Current channel for this device */
152         struct ast_channel *owner;
153         /*! Current PortAudio stream for this device */
154         PaStream *stream;
155         /*! A frame for preparing to queue on to the channel */
156         struct ast_frame fr;
157         /*! Running = 1, Not running = 0 */
158         unsigned int streamstate:1;
159         /*! On-hook = 0, Off-hook = 1 */
160         unsigned int hookstate:1;
161         /*! Unmuted = 0, Muted = 1 */
162         unsigned int muted:1;
163         /*! Automatically answer incoming calls */
164         unsigned int autoanswer:1;
165         /*! Ignore context in the console dial CLI command */
166         unsigned int overridecontext:1;
167         /*! Set during a reload so that we know to destroy this if it is no longer
168          *  in the configuration file. */
169         unsigned int destroy:1;
170         /*! ID for the stream monitor thread */
171         pthread_t thread;
172 } globals;
173
174 AST_MUTEX_DEFINE_STATIC(globals_lock);
175
176 static struct ao2_container *pvts;
177 #define NUM_PVT_BUCKETS 7
178
179 static struct console_pvt *active_pvt;
180 AST_RWLOCK_DEFINE_STATIC(active_lock);
181
182 /*! 
183  * \brief Global jitterbuffer configuration 
184  *
185  * \note Disabled by default.
186  * \note Values shown here match the defaults shown in console.conf.sample
187  */
188 static struct ast_jb_conf default_jbconf = {
189         .flags = 0,
190         .max_size = 200,
191         .resync_threshold = 1000,
192         .impl = "fixed",
193         .target_extra = 40,
194 };
195 static struct ast_jb_conf global_jbconf;
196
197 /*! Channel Technology Callbacks @{ */
198 static struct ast_channel *console_request(const char *type, struct ast_format_cap *cap,
199         const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause);
200 static int console_digit_begin(struct ast_channel *c, char digit);
201 static int console_digit_end(struct ast_channel *c, char digit, unsigned int duration);
202 static int console_text(struct ast_channel *c, const char *text);
203 static int console_hangup(struct ast_channel *c);
204 static int console_answer(struct ast_channel *c);
205 static struct ast_frame *console_read(struct ast_channel *chan);
206 static int console_call(struct ast_channel *c, const char *dest, int timeout);
207 static int console_write(struct ast_channel *chan, struct ast_frame *f);
208 static int console_indicate(struct ast_channel *chan, int cond, 
209         const void *data, size_t datalen);
210 static int console_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
211 /*! @} */
212
213 static struct ast_channel_tech console_tech = {
214         .type = "Console",
215         .description = "Console Channel Driver",
216         .requester = console_request,
217         .send_digit_begin = console_digit_begin,
218         .send_digit_end = console_digit_end,
219         .send_text = console_text,
220         .hangup = console_hangup,
221         .answer = console_answer,
222         .read = console_read,
223         .call = console_call,
224         .write = console_write,
225         .indicate = console_indicate,
226         .fixup = console_fixup,
227 };
228
229 /*! \brief lock a console_pvt struct */
230 #define console_pvt_lock(pvt) ao2_lock(pvt)
231
232 /*! \brief unlock a console_pvt struct */
233 #define console_pvt_unlock(pvt) ao2_unlock(pvt)
234
235 static inline struct console_pvt *ref_pvt(struct console_pvt *pvt)
236 {
237         if (pvt)
238                 ao2_ref(pvt, +1);
239         return pvt;
240 }
241
242 static inline struct console_pvt *unref_pvt(struct console_pvt *pvt)
243 {
244         ao2_ref(pvt, -1);
245         return NULL;
246 }
247
248 static struct console_pvt *find_pvt(const char *name)
249 {
250         struct console_pvt tmp_pvt = {
251                 .name = name,
252         };
253
254         return ao2_find(pvts, &tmp_pvt, OBJ_POINTER);
255 }
256
257 /*!
258  * \brief Stream monitor thread 
259  *
260  * \arg data A pointer to the console_pvt structure that contains the portaudio
261  *      stream that needs to be monitored.
262  *
263  * This function runs in its own thread to monitor data coming in from a
264  * portaudio stream.  When enough data is available, it is queued up to
265  * be read from the Asterisk channel.
266  */
267 static void *stream_monitor(void *data)
268 {
269         struct console_pvt *pvt = data;
270         char buf[NUM_SAMPLES * sizeof(int16_t)];
271         PaError res;
272         struct ast_frame f = {
273                 .frametype = AST_FRAME_VOICE,
274                 .subclass.format = ast_format_slin16,
275                 .src = "console_stream_monitor",
276                 .data.ptr = buf,
277                 .datalen = sizeof(buf),
278                 .samples = sizeof(buf) / sizeof(int16_t),
279         };
280
281         for (;;) {
282                 pthread_testcancel();
283                 res = Pa_ReadStream(pvt->stream, buf, sizeof(buf) / sizeof(int16_t));
284                 pthread_testcancel();
285
286                 if (!pvt->owner) {
287                         return NULL;
288                 }
289
290                 if (res == paNoError)
291                         ast_queue_frame(pvt->owner, &f);
292         }
293
294         return NULL;
295 }
296
297 static int open_stream(struct console_pvt *pvt)
298 {
299         int res = paInternalError;
300
301         if (!strcasecmp(pvt->input_device, "default") && 
302                 !strcasecmp(pvt->output_device, "default")) {
303                 res = Pa_OpenDefaultStream(&pvt->stream, INPUT_CHANNELS, OUTPUT_CHANNELS, 
304                         paInt16, SAMPLE_RATE, NUM_SAMPLES, NULL, NULL);
305         } else {
306                 PaStreamParameters input_params = { 
307                         .channelCount = 1,
308                         .sampleFormat = paInt16,
309                         .suggestedLatency = (1.0 / 50.0), /* 20 ms */
310                         .device = paNoDevice,
311                 };
312                 PaStreamParameters output_params = { 
313                         .channelCount = 1, 
314                         .sampleFormat = paInt16,
315                         .suggestedLatency = (1.0 / 50.0), /* 20 ms */
316                         .device = paNoDevice,
317                 };
318                 PaDeviceIndex idx, num_devices, def_input, def_output;
319
320                 if (!(num_devices = Pa_GetDeviceCount()))
321                         return res;
322
323                 def_input = Pa_GetDefaultInputDevice();
324                 def_output = Pa_GetDefaultOutputDevice();
325
326                 for (idx = 0; 
327                         idx < num_devices && (input_params.device == paNoDevice 
328                                 || output_params.device == paNoDevice); 
329                         idx++) 
330                 {
331                         const PaDeviceInfo *dev = Pa_GetDeviceInfo(idx);
332
333                         if (dev->maxInputChannels) {
334                                 if ( (idx == def_input && !strcasecmp(pvt->input_device, "default")) ||
335                                         !strcasecmp(pvt->input_device, dev->name) )
336                                         input_params.device = idx;
337                         }
338
339                         if (dev->maxOutputChannels) {
340                                 if ( (idx == def_output && !strcasecmp(pvt->output_device, "default")) ||
341                                         !strcasecmp(pvt->output_device, dev->name) )
342                                         output_params.device = idx;
343                         }
344                 }
345
346                 if (input_params.device == paNoDevice)
347                         ast_log(LOG_ERROR, "No input device found for console device '%s'\n", pvt->name);
348                 if (output_params.device == paNoDevice)
349                         ast_log(LOG_ERROR, "No output device found for console device '%s'\n", pvt->name);
350
351                 res = Pa_OpenStream(&pvt->stream, &input_params, &output_params,
352                         SAMPLE_RATE, NUM_SAMPLES, paNoFlag, NULL, NULL);
353         }
354
355         return res;
356 }
357
358 static int start_stream(struct console_pvt *pvt)
359 {
360         PaError res;
361         int ret_val = 0;
362
363         console_pvt_lock(pvt);
364
365         /* It is possible for console_hangup to be called before the
366          * stream is started, if this is the case pvt->owner will be NULL
367          * and start_stream should be aborted. */
368         if (pvt->streamstate || !pvt->owner)
369                 goto return_unlock;
370
371         pvt->streamstate = 1;
372         ast_debug(1, "Starting stream\n");
373
374         res = open_stream(pvt);
375         if (res != paNoError) {
376                 ast_log(LOG_WARNING, "Failed to open stream - (%d) %s\n",
377                         res, Pa_GetErrorText(res));
378                 ret_val = -1;
379                 goto return_unlock;
380         }
381
382         res = Pa_StartStream(pvt->stream);
383         if (res != paNoError) {
384                 ast_log(LOG_WARNING, "Failed to start stream - (%d) %s\n",
385                         res, Pa_GetErrorText(res));
386                 ret_val = -1;
387                 goto return_unlock;
388         }
389
390         if (ast_pthread_create_background(&pvt->thread, NULL, stream_monitor, pvt)) {
391                 ast_log(LOG_ERROR, "Failed to start stream monitor thread\n");
392                 ret_val = -1;
393         }
394
395 return_unlock:
396         console_pvt_unlock(pvt);
397
398         return ret_val;
399 }
400
401 static int stop_stream(struct console_pvt *pvt)
402 {
403         if (!pvt->streamstate || pvt->thread == AST_PTHREADT_NULL)
404                 return 0;
405
406         pthread_cancel(pvt->thread);
407         pthread_kill(pvt->thread, SIGURG);
408         pthread_join(pvt->thread, NULL);
409
410         console_pvt_lock(pvt);
411         Pa_AbortStream(pvt->stream);
412         Pa_CloseStream(pvt->stream);
413         pvt->stream = NULL;
414         pvt->streamstate = 0;
415         console_pvt_unlock(pvt);
416
417         return 0;
418 }
419
420 /*!
421  * \note Called with the pvt struct locked
422  */
423 static struct ast_channel *console_new(struct console_pvt *pvt, const char *ext, const char *ctx, int state, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor)
424 {
425         struct ast_format_cap *caps;
426         struct ast_channel *chan;
427
428         caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
429         if (!caps) {
430                 return NULL;
431         }
432
433         if (!(chan = ast_channel_alloc(1, state, pvt->cid_num, pvt->cid_name, NULL, 
434                 ext, ctx, assignedids, requestor, 0, "Console/%s", pvt->name))) {
435                 ao2_ref(caps, -1);
436                 return NULL;
437         }
438
439         ast_channel_stage_snapshot(chan);
440
441         ast_channel_tech_set(chan, &console_tech);
442         ast_channel_set_readformat(chan, ast_format_slin16);
443         ast_channel_set_writeformat(chan, ast_format_slin16);
444         ast_format_cap_append(caps, ast_format_slin16, 0);
445         ast_channel_nativeformats_set(chan, caps);
446         ao2_ref(caps, -1);
447         ast_channel_tech_pvt_set(chan, ref_pvt(pvt));
448
449         pvt->owner = chan;
450
451         if (!ast_strlen_zero(pvt->language))
452                 ast_channel_language_set(chan, pvt->language);
453
454         ast_jb_configure(chan, &global_jbconf);
455
456         ast_channel_stage_snapshot_done(chan);
457         ast_channel_unlock(chan);
458
459         if (state != AST_STATE_DOWN) {
460                 if (ast_pbx_start(chan)) {
461                         ast_channel_hangupcause_set(chan, AST_CAUSE_SWITCH_CONGESTION);
462                         ast_hangup(chan);
463                         chan = NULL;
464                 } else
465                         start_stream(pvt);
466         }
467
468         return chan;
469 }
470
471 static struct ast_channel *console_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause)
472 {
473         struct ast_channel *chan = NULL;
474         struct console_pvt *pvt;
475
476         if (!(pvt = find_pvt(data))) {
477                 ast_log(LOG_ERROR, "Console device '%s' not found\n", data);
478                 return NULL;
479         }
480
481         if (!(ast_format_cap_iscompatible(cap, console_tech.capabilities))) {
482                 struct ast_str *cap_buf = ast_str_alloca(64);
483                 ast_log(LOG_NOTICE, "Channel requested with unsupported format(s): '%s'\n",
484                         ast_format_cap_get_names(cap, &cap_buf));
485                 goto return_unref;
486         }
487
488         if (pvt->owner) {
489                 ast_log(LOG_NOTICE, "Console channel already active!\n");
490                 *cause = AST_CAUSE_BUSY;
491                 goto return_unref;
492         }
493
494         console_pvt_lock(pvt);
495         chan = console_new(pvt, NULL, NULL, AST_STATE_DOWN, assignedids, requestor);
496         console_pvt_unlock(pvt);
497
498         if (!chan)
499                 ast_log(LOG_WARNING, "Unable to create new Console channel!\n");
500
501 return_unref:
502         unref_pvt(pvt);
503
504         return chan;
505 }
506
507 static int console_digit_begin(struct ast_channel *c, char digit)
508 {
509         ast_verb(1, V_BEGIN "Console Received Beginning of Digit %c" V_END, digit);
510
511         return -1; /* non-zero to request inband audio */
512 }
513
514 static int console_digit_end(struct ast_channel *c, char digit, unsigned int duration)
515 {
516         ast_verb(1, V_BEGIN "Console Received End of Digit %c (duration %u)" V_END, 
517                 digit, duration);
518
519         return -1; /* non-zero to request inband audio */
520 }
521
522 static int console_text(struct ast_channel *c, const char *text)
523 {
524         ast_verb(1, V_BEGIN "Console Received Text '%s'" V_END, text);
525
526         return 0;
527 }
528
529 static int console_hangup(struct ast_channel *c)
530 {
531         struct console_pvt *pvt = ast_channel_tech_pvt(c);
532
533         ast_verb(1, V_BEGIN "Hangup on Console" V_END);
534
535         pvt->hookstate = 0;
536         pvt->owner = NULL;
537         stop_stream(pvt);
538
539         ast_channel_tech_pvt_set(c, unref_pvt(pvt));
540
541         return 0;
542 }
543
544 static int console_answer(struct ast_channel *c)
545 {
546         struct console_pvt *pvt = ast_channel_tech_pvt(c);
547
548         ast_verb(1, V_BEGIN "Call from Console has been Answered" V_END);
549
550         ast_setstate(c, AST_STATE_UP);
551
552         return start_stream(pvt);
553 }
554
555 /*
556  * \brief Implementation of the ast_channel_tech read() callback
557  *
558  * Calling this function is harmless.  However, if it does get called, it
559  * is an indication that something weird happened that really shouldn't
560  * have and is worth looking into.
561  * 
562  * Why should this function not get called?  Well, let me explain.  There are
563  * a couple of ways to pass on audio that has come from this channel.  The way
564  * that this channel driver uses is that once the audio is available, it is
565  * wrapped in an ast_frame and queued onto the channel using ast_queue_frame().
566  *
567  * The other method would be signalling to the core that there is audio waiting,
568  * and that it needs to call the channel's read() callback to get it.  The way
569  * the channel gets signalled is that one or more file descriptors are placed
570  * in the fds array on the ast_channel which the core will poll() on.  When the
571  * fd indicates that input is available, the read() callback is called.  This
572  * is especially useful when there is a dedicated file descriptor where the
573  * audio is read from.  An example would be the socket for an RTP stream.
574  */
575 static struct ast_frame *console_read(struct ast_channel *chan)
576 {
577         ast_debug(1, "I should not be called ...\n");
578
579         return &ast_null_frame;
580 }
581
582 static int console_call(struct ast_channel *c, const char *dest, int timeout)
583 {
584         struct console_pvt *pvt = ast_channel_tech_pvt(c);
585         enum ast_control_frame_type ctrl;
586
587         ast_verb(1, V_BEGIN "Call to device '%s' on console from '%s' <%s>" V_END,
588                 dest,
589                 S_COR(ast_channel_caller(c)->id.name.valid, ast_channel_caller(c)->id.name.str, ""),
590                 S_COR(ast_channel_caller(c)->id.number.valid, ast_channel_caller(c)->id.number.str, ""));
591
592         console_pvt_lock(pvt);
593
594         if (pvt->autoanswer) {
595                 pvt->hookstate = 1;
596                 console_pvt_unlock(pvt);
597                 ast_verb(1, V_BEGIN "Auto-answered" V_END);
598                 ctrl = AST_CONTROL_ANSWER;
599         } else {
600                 console_pvt_unlock(pvt);
601                 ast_verb(1, V_BEGIN "Type 'console answer' to answer, or use the 'autoanswer' option "
602                                 "for future calls" V_END);
603                 ctrl = AST_CONTROL_RINGING;
604                 ast_indicate(c, AST_CONTROL_RINGING);
605         }
606
607         ast_queue_control(c, ctrl);
608
609         return start_stream(pvt);
610 }
611
612 static int console_write(struct ast_channel *chan, struct ast_frame *f)
613 {
614         struct console_pvt *pvt = ast_channel_tech_pvt(chan);
615
616         Pa_WriteStream(pvt->stream, f->data.ptr, f->samples);
617
618         return 0;
619 }
620
621 static int console_indicate(struct ast_channel *chan, int cond, const void *data, size_t datalen)
622 {
623         struct console_pvt *pvt = ast_channel_tech_pvt(chan);
624         int res = 0;
625
626         switch (cond) {
627         case AST_CONTROL_BUSY:
628         case AST_CONTROL_CONGESTION:
629         case AST_CONTROL_RINGING:
630         case AST_CONTROL_INCOMPLETE:
631         case AST_CONTROL_PVT_CAUSE_CODE:
632         case -1:
633                 res = -1;  /* Ask for inband indications */
634                 break;
635         case AST_CONTROL_PROGRESS:
636         case AST_CONTROL_PROCEEDING:
637         case AST_CONTROL_VIDUPDATE:
638         case AST_CONTROL_SRCUPDATE:
639                 break;
640         case AST_CONTROL_HOLD:
641                 ast_verb(1, V_BEGIN "Console Has Been Placed on Hold" V_END);
642                 ast_moh_start(chan, data, pvt->mohinterpret);
643                 break;
644         case AST_CONTROL_UNHOLD:
645                 ast_verb(1, V_BEGIN "Console Has Been Retrieved from Hold" V_END);
646                 ast_moh_stop(chan);
647                 break;
648         default:
649                 ast_log(LOG_WARNING, "Don't know how to display condition %d on %s\n", 
650                         cond, ast_channel_name(chan));
651                 /* The core will play inband indications for us if appropriate */
652                 res = -1;
653         }
654
655         return res;
656 }
657
658 static int console_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
659 {
660         struct console_pvt *pvt = ast_channel_tech_pvt(newchan);
661
662         pvt->owner = newchan;
663
664         return 0;
665 }
666
667 /*!
668  * split a string in extension-context, returns pointers to malloc'ed
669  * strings.
670  * If we do not have 'overridecontext' then the last @ is considered as
671  * a context separator, and the context is overridden.
672  * This is usually not very necessary as you can play with the dialplan,
673  * and it is nice not to need it because you have '@' in SIP addresses.
674  * Return value is the buffer address.
675  *
676  * \note came from chan_oss
677  */
678 static char *ast_ext_ctx(struct console_pvt *pvt, const char *src, char **ext, char **ctx)
679 {
680         if (ext == NULL || ctx == NULL)
681                 return NULL;                    /* error */
682
683         *ext = *ctx = NULL;
684
685         if (src && *src != '\0')
686                 *ext = ast_strdup(src);
687
688         if (*ext == NULL)
689                 return NULL;
690
691         if (!pvt->overridecontext) {
692                 /* parse from the right */
693                 *ctx = strrchr(*ext, '@');
694                 if (*ctx)
695                         *(*ctx)++ = '\0';
696         }
697
698         return *ext;
699 }
700
701 static struct console_pvt *get_active_pvt(void)
702 {
703         struct console_pvt *pvt;
704
705         ast_rwlock_rdlock(&active_lock);
706         pvt = ref_pvt(active_pvt);      
707         ast_rwlock_unlock(&active_lock);
708
709         return pvt;
710 }
711
712 static char *cli_console_autoanswer(struct ast_cli_entry *e, int cmd, 
713         struct ast_cli_args *a)
714 {
715         struct console_pvt *pvt = get_active_pvt();
716         char *res = CLI_SUCCESS;
717
718         switch (cmd) {
719         case CLI_INIT:
720                 e->command = "console {set|show} autoanswer [on|off]";
721                 e->usage =
722                         "Usage: console {set|show} autoanswer [on|off]\n"
723                         "       Enables or disables autoanswer feature.  If used without\n"
724                         "       argument, displays the current on/off status of autoanswer.\n"
725                         "       The default value of autoanswer is in 'oss.conf'.\n";
726                 return NULL;
727
728         case CLI_GENERATE:
729                 return NULL;
730         }
731
732         if (!pvt) {
733                 ast_cli(a->fd, "No console device is set as active.\n");
734                 return CLI_FAILURE;
735         }
736
737         if (a->argc == e->args - 1) {
738                 ast_cli(a->fd, "Auto answer is %s.\n", pvt->autoanswer ? "on" : "off");
739                 unref_pvt(pvt);
740                 return CLI_SUCCESS;
741         }
742
743         if (a->argc != e->args) {
744                 unref_pvt(pvt);
745                 return CLI_SHOWUSAGE;
746         }
747
748         if (!strcasecmp(a->argv[e->args-1], "on"))
749                 pvt->autoanswer = 1;
750         else if (!strcasecmp(a->argv[e->args - 1], "off"))
751                 pvt->autoanswer = 0;
752         else
753                 res = CLI_SHOWUSAGE;
754
755         unref_pvt(pvt);
756
757         return res;
758 }
759
760 static char *cli_console_flash(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
761 {
762         struct console_pvt *pvt = get_active_pvt();
763
764         if (cmd == CLI_INIT) {
765                 e->command = "console flash";
766                 e->usage =
767                         "Usage: console flash\n"
768                         "       Flashes the call currently placed on the console.\n";
769                 return NULL;
770         } else if (cmd == CLI_GENERATE)
771                 return NULL;
772
773         if (!pvt) {
774                 ast_cli(a->fd, "No console device is set as active\n");
775                 return CLI_FAILURE;
776         }
777
778         if (a->argc != e->args)
779                 return CLI_SHOWUSAGE;
780
781         if (!pvt->owner) {
782                 ast_cli(a->fd, "No call to flash\n");
783                 unref_pvt(pvt);
784                 return CLI_FAILURE;
785         }
786
787         pvt->hookstate = 0;
788
789         ast_queue_control(pvt->owner, AST_CONTROL_FLASH);
790
791         unref_pvt(pvt);
792
793         return CLI_SUCCESS;
794 }
795
796 static char *cli_console_dial(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
797 {
798         char *s = NULL;
799         const char *mye = NULL, *myc = NULL; 
800         struct console_pvt *pvt = get_active_pvt();
801
802         if (cmd == CLI_INIT) {
803                 e->command = "console dial";
804                 e->usage =
805                         "Usage: console dial [extension[@context]]\n"
806                         "       Dials a given extension (and context if specified)\n";
807                 return NULL;
808         } else if (cmd == CLI_GENERATE)
809                 return NULL;
810
811         if (!pvt) {
812                 ast_cli(a->fd, "No console device is currently set as active\n");
813                 return CLI_FAILURE;
814         }
815         
816         if (a->argc > e->args + 1)
817                 return CLI_SHOWUSAGE;
818
819         if (pvt->owner) {       /* already in a call */
820                 int i;
821                 struct ast_frame f = { AST_FRAME_DTMF };
822                 const char *s;
823
824                 if (a->argc == e->args) {       /* argument is mandatory here */
825                         ast_cli(a->fd, "Already in a call. You can only dial digits until you hangup.\n");
826                         unref_pvt(pvt);
827                         return CLI_FAILURE;
828                 }
829                 s = a->argv[e->args];
830                 /* send the string one char at a time */
831                 for (i = 0; i < strlen(s); i++) {
832                         f.subclass.integer = s[i];
833                         ast_queue_frame(pvt->owner, &f);
834                 }
835                 unref_pvt(pvt);
836                 return CLI_SUCCESS;
837         }
838
839         /* if we have an argument split it into extension and context */
840         if (a->argc == e->args + 1) {
841                 char *ext = NULL, *con = NULL;
842                 s = ast_ext_ctx(pvt, a->argv[e->args], &ext, &con);
843                 ast_debug(1, "provided '%s', exten '%s' context '%s'\n", 
844                         a->argv[e->args], mye, myc);
845                 mye = ext;
846                 myc = con;
847         }
848
849         /* supply default values if needed */
850         if (ast_strlen_zero(mye))
851                 mye = pvt->exten;
852         if (ast_strlen_zero(myc))
853                 myc = pvt->context;
854
855         if (ast_exists_extension(NULL, myc, mye, 1, NULL)) {
856                 console_pvt_lock(pvt);
857                 pvt->hookstate = 1;
858                 console_new(pvt, mye, myc, AST_STATE_RINGING, NULL, NULL);
859                 console_pvt_unlock(pvt);
860         } else
861                 ast_cli(a->fd, "No such extension '%s' in context '%s'\n", mye, myc);
862
863         free(s);
864
865         unref_pvt(pvt);
866
867         return CLI_SUCCESS;
868 }
869
870 static char *cli_console_hangup(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
871 {
872         struct console_pvt *pvt = get_active_pvt();
873
874         if (cmd == CLI_INIT) {
875                 e->command = "console hangup";
876                 e->usage =
877                         "Usage: console hangup\n"
878                         "       Hangs up any call currently placed on the console.\n";
879                 return NULL;
880         } else if (cmd == CLI_GENERATE)
881                 return NULL;
882
883         if (!pvt) {
884                 ast_cli(a->fd, "No console device is set as active\n");
885                 return CLI_FAILURE;
886         }
887         
888         if (a->argc != e->args)
889                 return CLI_SHOWUSAGE;
890
891         if (!pvt->owner && !pvt->hookstate) {
892                 ast_cli(a->fd, "No call to hang up\n");
893                 unref_pvt(pvt);
894                 return CLI_FAILURE;
895         }
896
897         pvt->hookstate = 0;
898         if (pvt->owner)
899                 ast_queue_hangup(pvt->owner);
900
901         unref_pvt(pvt);
902
903         return CLI_SUCCESS;
904 }
905
906 static char *cli_console_mute(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
907 {
908         const char *s;
909         struct console_pvt *pvt = get_active_pvt();
910         char *res = CLI_SUCCESS;
911
912         if (cmd == CLI_INIT) {
913                 e->command = "console {mute|unmute}";
914                 e->usage =
915                         "Usage: console {mute|unmute}\n"
916                         "       Mute/unmute the microphone.\n";
917                 return NULL;
918         } else if (cmd == CLI_GENERATE)
919                 return NULL;
920
921         if (!pvt) {
922                 ast_cli(a->fd, "No console device is set as active\n");
923                 return CLI_FAILURE;
924         }
925
926         if (a->argc != e->args)
927                 return CLI_SHOWUSAGE;
928
929         s = a->argv[e->args-1];
930         if (!strcasecmp(s, "mute"))
931                 pvt->muted = 1;
932         else if (!strcasecmp(s, "unmute"))
933                 pvt->muted = 0;
934         else
935                 res = CLI_SHOWUSAGE;
936
937         ast_verb(1, V_BEGIN "The Console is now %s" V_END, 
938                 pvt->muted ? "Muted" : "Unmuted");
939
940         unref_pvt(pvt);
941
942         return res;
943 }
944
945 static char *cli_list_available(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
946 {
947         PaDeviceIndex idx, num, def_input, def_output;
948
949         if (cmd == CLI_INIT) {
950                 e->command = "console list available";
951                 e->usage =
952                         "Usage: console list available\n"
953                         "       List all available devices.\n";
954                 return NULL;
955         } else if (cmd == CLI_GENERATE)
956                 return NULL;
957
958         if (a->argc != e->args)
959                 return CLI_SHOWUSAGE;
960
961         ast_cli(a->fd, "\n"
962                     "=============================================================\n"
963                     "=== Available Devices =======================================\n"
964                     "=============================================================\n"
965                     "===\n");
966
967         num = Pa_GetDeviceCount();
968         if (!num) {
969                 ast_cli(a->fd, "(None)\n");
970                 return CLI_SUCCESS;
971         }
972
973         def_input = Pa_GetDefaultInputDevice();
974         def_output = Pa_GetDefaultOutputDevice();
975         for (idx = 0; idx < num; idx++) {
976                 const PaDeviceInfo *dev = Pa_GetDeviceInfo(idx);
977                 if (!dev)
978                         continue;
979                 ast_cli(a->fd, "=== ---------------------------------------------------------\n"
980                                "=== Device Name: %s\n", dev->name);
981                 if (dev->maxInputChannels)
982                         ast_cli(a->fd, "=== ---> %sInput Device\n", (idx == def_input) ? "Default " : "");
983                 if (dev->maxOutputChannels)
984                         ast_cli(a->fd, "=== ---> %sOutput Device\n", (idx == def_output) ? "Default " : "");
985                 ast_cli(a->fd, "=== ---------------------------------------------------------\n===\n");
986         }
987
988         ast_cli(a->fd, "=============================================================\n\n");
989
990         return CLI_SUCCESS;
991 }
992
993 static char *cli_list_devices(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
994 {
995         struct ao2_iterator i;
996         struct console_pvt *pvt;
997
998         if (cmd == CLI_INIT) {
999                 e->command = "console list devices";
1000                 e->usage =
1001                         "Usage: console list devices\n"
1002                         "       List all configured devices.\n";
1003                 return NULL;
1004         } else if (cmd == CLI_GENERATE)
1005                 return NULL;
1006
1007         if (a->argc != e->args)
1008                 return CLI_SHOWUSAGE;
1009
1010         ast_cli(a->fd, "\n"
1011                     "=============================================================\n"
1012                     "=== Configured Devices ======================================\n"
1013                     "=============================================================\n"
1014                     "===\n");
1015
1016         i = ao2_iterator_init(pvts, 0);
1017         while ((pvt = ao2_iterator_next(&i))) {
1018                 console_pvt_lock(pvt);
1019
1020                 ast_cli(a->fd, "=== ---------------------------------------------------------\n"
1021                                "=== Device Name: %s\n"
1022                                "=== ---> Active:           %s\n"
1023                                "=== ---> Input Device:     %s\n"
1024                                "=== ---> Output Device:    %s\n"
1025                                "=== ---> Context:          %s\n"
1026                                "=== ---> Extension:        %s\n"
1027                                "=== ---> CallerID Num:     %s\n"
1028                                "=== ---> CallerID Name:    %s\n"
1029                                "=== ---> MOH Interpret:    %s\n"
1030                                "=== ---> Language:         %s\n"
1031                                "=== ---> Parkinglot:       %s\n"
1032                                "=== ---> Muted:            %s\n"
1033                                "=== ---> Auto-Answer:      %s\n"
1034                                "=== ---> Override Context: %s\n"
1035                                "=== ---------------------------------------------------------\n===\n",
1036                         pvt->name, (pvt == active_pvt) ? "Yes" : "No",
1037                         pvt->input_device, pvt->output_device, pvt->context,
1038                         pvt->exten, pvt->cid_num, pvt->cid_name, pvt->mohinterpret,
1039                         pvt->language, pvt->parkinglot, pvt->muted ? "Yes" : "No", pvt->autoanswer ? "Yes" : "No",
1040                         pvt->overridecontext ? "Yes" : "No");
1041
1042                 console_pvt_unlock(pvt);
1043                 unref_pvt(pvt);
1044         }
1045         ao2_iterator_destroy(&i);
1046
1047         ast_cli(a->fd, "=============================================================\n\n");
1048
1049         return CLI_SUCCESS;
1050 }
1051 /*!
1052  * \brief answer command from the console
1053  */
1054 static char *cli_console_answer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1055 {
1056         struct console_pvt *pvt = get_active_pvt();
1057
1058         switch (cmd) {
1059         case CLI_INIT:
1060                 e->command = "console answer";
1061                 e->usage =
1062                         "Usage: console answer\n"
1063                         "       Answers an incoming call on the console channel.\n";
1064                 return NULL;
1065
1066         case CLI_GENERATE:
1067                 return NULL;    /* no completion */
1068         }
1069
1070         if (!pvt) {
1071                 ast_cli(a->fd, "No console device is set as active\n");
1072                 return CLI_FAILURE;
1073         }
1074
1075         if (a->argc != e->args) {
1076                 unref_pvt(pvt);
1077                 return CLI_SHOWUSAGE;
1078         }
1079
1080         if (!pvt->owner) {
1081                 ast_cli(a->fd, "No one is calling us\n");
1082                 unref_pvt(pvt);
1083                 return CLI_FAILURE;
1084         }
1085
1086         pvt->hookstate = 1;
1087
1088         ast_indicate(pvt->owner, -1);
1089
1090         ast_queue_control(pvt->owner, AST_CONTROL_ANSWER);
1091
1092         unref_pvt(pvt);
1093
1094         return CLI_SUCCESS;
1095 }
1096
1097 /*!
1098  * \brief Console send text CLI command
1099  *
1100  * \note concatenate all arguments into a single string. argv is NULL-terminated
1101  * so we can use it right away
1102  */
1103 static char *cli_console_sendtext(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1104 {
1105         char buf[TEXT_SIZE];
1106         struct console_pvt *pvt = get_active_pvt();
1107         struct ast_frame f = {
1108                 .frametype = AST_FRAME_TEXT,
1109                 .data.ptr = buf,
1110                 .src = "console_send_text",
1111         };
1112         int len;
1113
1114         if (cmd == CLI_INIT) {
1115                 e->command = "console send text";
1116                 e->usage =
1117                         "Usage: console send text <message>\n"
1118                         "       Sends a text message for display on the remote terminal.\n";
1119                 return NULL;
1120         } else if (cmd == CLI_GENERATE)
1121                 return NULL;
1122
1123         if (!pvt) {
1124                 ast_cli(a->fd, "No console device is set as active\n");
1125                 return CLI_FAILURE;
1126         }
1127
1128         if (a->argc < e->args + 1) {
1129                 unref_pvt(pvt);
1130                 return CLI_SHOWUSAGE;
1131         }
1132
1133         if (!pvt->owner) {
1134                 ast_cli(a->fd, "Not in a call\n");
1135                 unref_pvt(pvt);
1136                 return CLI_FAILURE;
1137         }
1138
1139         ast_join(buf, sizeof(buf) - 1, a->argv + e->args);
1140         if (ast_strlen_zero(buf)) {
1141                 unref_pvt(pvt);
1142                 return CLI_SHOWUSAGE;
1143         }
1144
1145         len = strlen(buf);
1146         buf[len] = '\n';
1147         f.datalen = len + 1;
1148
1149         ast_queue_frame(pvt->owner, &f);
1150
1151         unref_pvt(pvt);
1152
1153         return CLI_SUCCESS;
1154 }
1155
1156 static void set_active(struct console_pvt *pvt, const char *value)
1157 {
1158         if (pvt == &globals) {
1159                 ast_log(LOG_ERROR, "active is only valid as a per-device setting\n");
1160                 return;
1161         }
1162
1163         if (!ast_true(value))
1164                 return;
1165
1166         ast_rwlock_wrlock(&active_lock);
1167         if (active_pvt)
1168                 unref_pvt(active_pvt);
1169         active_pvt = ref_pvt(pvt);
1170         ast_rwlock_unlock(&active_lock);
1171 }
1172
1173 static char *cli_console_active(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1174 {
1175         struct console_pvt *pvt;
1176
1177         switch (cmd) {
1178         case CLI_INIT:
1179                 e->command = "console {set|show} active";
1180                 e->usage =
1181                         "Usage: console {set|show} active [<device>]\n"
1182                         "       Set or show the active console device for the Asterisk CLI.\n";
1183                 return NULL;
1184         case CLI_GENERATE:
1185                 if (a->pos == e->args) {
1186                         struct ao2_iterator i;
1187                         int x = 0;
1188                         char *res = NULL;
1189                         i = ao2_iterator_init(pvts, 0);
1190                         while ((pvt = ao2_iterator_next(&i))) {
1191                                 if (++x > a->n && !strncasecmp(pvt->name, a->word, strlen(a->word)))
1192                                         res = ast_strdup(pvt->name);
1193                                 unref_pvt(pvt);
1194                                 if (res) {
1195                                         ao2_iterator_destroy(&i);
1196                                         return res;
1197                                 }
1198                         }
1199                         ao2_iterator_destroy(&i);
1200                 }
1201                 return NULL;
1202         }
1203
1204         if (a->argc < e->args)
1205                 return CLI_SHOWUSAGE;
1206
1207         if (a->argc == 3) {
1208                 pvt = get_active_pvt();
1209
1210                 if (!pvt)
1211                         ast_cli(a->fd, "No device is currently set as the active console device.\n");
1212                 else {
1213                         console_pvt_lock(pvt);
1214                         ast_cli(a->fd, "The active console device is '%s'.\n", pvt->name);
1215                         console_pvt_unlock(pvt);
1216                         pvt = unref_pvt(pvt);
1217                 }
1218
1219                 return CLI_SUCCESS;
1220         }
1221
1222         if (!(pvt = find_pvt(a->argv[e->args - 1]))) {
1223                 ast_cli(a->fd, "Could not find a device called '%s'.\n", a->argv[e->args]);
1224                 return CLI_FAILURE;
1225         }
1226
1227         set_active(pvt, "yes");
1228
1229         console_pvt_lock(pvt);
1230         ast_cli(a->fd, "The active console device has been set to '%s'\n", pvt->name);
1231         console_pvt_unlock(pvt);
1232
1233         unref_pvt(pvt);
1234
1235         return CLI_SUCCESS;
1236 }
1237
1238 static struct ast_cli_entry cli_console[] = {
1239         AST_CLI_DEFINE(cli_console_dial,       "Dial an extension from the console"),
1240         AST_CLI_DEFINE(cli_console_hangup,     "Hangup a call on the console"),
1241         AST_CLI_DEFINE(cli_console_mute,       "Disable/Enable mic input"),
1242         AST_CLI_DEFINE(cli_console_answer,     "Answer an incoming console call"),
1243         AST_CLI_DEFINE(cli_console_sendtext,   "Send text to a connected party"),
1244         AST_CLI_DEFINE(cli_console_flash,      "Send a flash to the connected party"),
1245         AST_CLI_DEFINE(cli_console_autoanswer, "Turn autoanswer on or off"),
1246         AST_CLI_DEFINE(cli_list_available,     "List available devices"),
1247         AST_CLI_DEFINE(cli_list_devices,       "List configured devices"),
1248         AST_CLI_DEFINE(cli_console_active,     "View or Set the active console device"),
1249 };
1250
1251 /*!
1252  * \brief Set default values for a pvt struct
1253  *
1254  * \note This function expects the pvt lock to be held.
1255  */
1256 static void set_pvt_defaults(struct console_pvt *pvt)
1257 {
1258         if (pvt == &globals) {
1259                 ast_string_field_set(pvt, mohinterpret, "default");
1260                 ast_string_field_set(pvt, context, "default");
1261                 ast_string_field_set(pvt, exten, "s");
1262                 ast_string_field_set(pvt, language, "");
1263                 ast_string_field_set(pvt, cid_num, "");
1264                 ast_string_field_set(pvt, cid_name, "");
1265                 ast_string_field_set(pvt, parkinglot, "");
1266         
1267                 pvt->overridecontext = 0;
1268                 pvt->autoanswer = 0;
1269         } else {
1270                 ast_mutex_lock(&globals_lock);
1271
1272                 ast_string_field_set(pvt, mohinterpret, globals.mohinterpret);
1273                 ast_string_field_set(pvt, context, globals.context);
1274                 ast_string_field_set(pvt, exten, globals.exten);
1275                 ast_string_field_set(pvt, language, globals.language);
1276                 ast_string_field_set(pvt, cid_num, globals.cid_num);
1277                 ast_string_field_set(pvt, cid_name, globals.cid_name);
1278                 ast_string_field_set(pvt, parkinglot, globals.parkinglot);
1279
1280                 pvt->overridecontext = globals.overridecontext;
1281                 pvt->autoanswer = globals.autoanswer;
1282
1283                 ast_mutex_unlock(&globals_lock);
1284         }
1285 }
1286
1287 static void store_callerid(struct console_pvt *pvt, const char *value)
1288 {
1289         char cid_name[256];
1290         char cid_num[256];
1291
1292         ast_callerid_split(value, cid_name, sizeof(cid_name), 
1293                 cid_num, sizeof(cid_num));
1294
1295         ast_string_field_set(pvt, cid_name, cid_name);
1296         ast_string_field_set(pvt, cid_num, cid_num);
1297 }
1298
1299 /*!
1300  * \brief Store a configuration parameter in a pvt struct
1301  *
1302  * \note This function expects the pvt lock to be held.
1303  */
1304 static void store_config_core(struct console_pvt *pvt, const char *var, const char *value)
1305 {
1306         if (pvt == &globals && !ast_jb_read_conf(&global_jbconf, var, value))
1307                 return;
1308
1309         CV_START(var, value);
1310
1311         CV_STRFIELD("context", pvt, context);
1312         CV_STRFIELD("extension", pvt, exten);
1313         CV_STRFIELD("mohinterpret", pvt, mohinterpret);
1314         CV_STRFIELD("language", pvt, language);
1315         CV_F("callerid", store_callerid(pvt, value));
1316         CV_BOOL("overridecontext", pvt->overridecontext);
1317         CV_BOOL("autoanswer", pvt->autoanswer);
1318         CV_STRFIELD("parkinglot", pvt, parkinglot);
1319
1320         if (pvt != &globals) {
1321                 CV_F("active", set_active(pvt, value))
1322                 CV_STRFIELD("input_device", pvt, input_device);
1323                 CV_STRFIELD("output_device", pvt, output_device);
1324         }
1325
1326         ast_log(LOG_WARNING, "Unknown option '%s'\n", var);
1327
1328         CV_END;
1329 }
1330
1331 static void pvt_destructor(void *obj)
1332 {
1333         struct console_pvt *pvt = obj;
1334
1335         ast_string_field_free_memory(pvt);
1336 }
1337
1338 static int init_pvt(struct console_pvt *pvt, const char *name)
1339 {
1340         pvt->thread = AST_PTHREADT_NULL;
1341
1342         if (ast_string_field_init(pvt, 32))
1343                 return -1;
1344
1345         ast_string_field_set(pvt, name, S_OR(name, ""));
1346
1347         return 0;
1348 }
1349
1350 static void build_device(struct ast_config *cfg, const char *name)
1351 {
1352         struct ast_variable *v;
1353         struct console_pvt *pvt;
1354         int new = 0;
1355
1356         if ((pvt = find_pvt(name))) {
1357                 console_pvt_lock(pvt);
1358                 set_pvt_defaults(pvt);
1359                 pvt->destroy = 0;
1360         } else {
1361                 if (!(pvt = ao2_alloc(sizeof(*pvt), pvt_destructor)))
1362                         return;
1363                 init_pvt(pvt, name);
1364                 set_pvt_defaults(pvt);
1365                 new = 1;
1366         }
1367
1368         for (v = ast_variable_browse(cfg, name); v; v = v->next)
1369                 store_config_core(pvt, v->name, v->value);
1370
1371         if (new)
1372                 ao2_link(pvts, pvt);
1373         else
1374                 console_pvt_unlock(pvt);
1375         
1376         unref_pvt(pvt);
1377 }
1378
1379 static int pvt_mark_destroy_cb(void *obj, void *arg, int flags)
1380 {
1381         struct console_pvt *pvt = obj;
1382         pvt->destroy = 1;
1383         return 0;
1384 }
1385
1386 static void destroy_pvts(void)
1387 {
1388         struct ao2_iterator i;
1389         struct console_pvt *pvt;
1390
1391         i = ao2_iterator_init(pvts, 0);
1392         while ((pvt = ao2_iterator_next(&i))) {
1393                 if (pvt->destroy) {
1394                         ao2_unlink(pvts, pvt);
1395                         ast_rwlock_wrlock(&active_lock);
1396                         if (active_pvt == pvt)
1397                                 active_pvt = unref_pvt(pvt);
1398                         ast_rwlock_unlock(&active_lock);
1399                 }
1400                 unref_pvt(pvt);
1401         }
1402         ao2_iterator_destroy(&i);
1403 }
1404
1405 /*!
1406  * \brief Load the configuration
1407  * \param reload if this was called due to a reload
1408  * \retval 0 success
1409  * \retval -1 failure
1410  */
1411 static int load_config(int reload)
1412 {
1413         struct ast_config *cfg;
1414         struct ast_variable *v;
1415         struct ast_flags config_flags = { 0 };
1416         char *context = NULL;
1417
1418         /* default values */
1419         memcpy(&global_jbconf, &default_jbconf, sizeof(global_jbconf));
1420         ast_mutex_lock(&globals_lock);
1421         set_pvt_defaults(&globals);
1422         ast_mutex_unlock(&globals_lock);
1423
1424         if (!(cfg = ast_config_load(config_file, config_flags))) {
1425                 ast_log(LOG_NOTICE, "Unable to open configuration file %s!\n", config_file);
1426                 return -1;
1427         } else if (cfg == CONFIG_STATUS_FILEINVALID) {
1428                 ast_log(LOG_NOTICE, "Config file %s has an invalid format\n", config_file);
1429                 return -1;
1430         }
1431         
1432         ao2_callback(pvts, OBJ_NODATA, pvt_mark_destroy_cb, NULL);
1433
1434         ast_mutex_lock(&globals_lock);
1435         for (v = ast_variable_browse(cfg, "general"); v; v = v->next)
1436                 store_config_core(&globals, v->name, v->value);
1437         ast_mutex_unlock(&globals_lock);
1438
1439         while ((context = ast_category_browse(cfg, context))) {
1440                 if (strcasecmp(context, "general"))
1441                         build_device(cfg, context);
1442         }
1443
1444         ast_config_destroy(cfg);
1445
1446         destroy_pvts();
1447
1448         return 0;
1449 }
1450
1451 static int pvt_hash_cb(const void *obj, const int flags)
1452 {
1453         const struct console_pvt *pvt = obj;
1454
1455         return ast_str_case_hash(pvt->name);
1456 }
1457
1458 static int pvt_cmp_cb(void *obj, void *arg, int flags)
1459 {
1460         struct console_pvt *pvt = obj, *pvt2 = arg;
1461
1462         return !strcasecmp(pvt->name, pvt2->name) ? CMP_MATCH | CMP_STOP : 0;
1463 }
1464
1465 static void stop_streams(void)
1466 {
1467         struct console_pvt *pvt;
1468         struct ao2_iterator i;
1469
1470         i = ao2_iterator_init(pvts, 0);
1471         while ((pvt = ao2_iterator_next(&i))) {
1472                 if (pvt->hookstate)
1473                         stop_stream(pvt);
1474                 unref_pvt(pvt);
1475         }
1476         ao2_iterator_destroy(&i);
1477 }
1478
1479 static int unload_module(void)
1480 {
1481         ao2_ref(console_tech.capabilities, -1);
1482         console_tech.capabilities = NULL;
1483         ast_channel_unregister(&console_tech);
1484         ast_cli_unregister_multiple(cli_console, ARRAY_LEN(cli_console));
1485
1486         stop_streams();
1487
1488         Pa_Terminate();
1489
1490         /* Will unref all the pvts so they will get destroyed, too */
1491         ao2_ref(pvts, -1);
1492
1493         pvt_destructor(&globals);
1494
1495         return 0;
1496 }
1497
1498 /*!
1499  * \brief Load the module
1500  *
1501  * Module loading including tests for configuration or dependencies.
1502  * This function can return AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_DECLINE,
1503  * or AST_MODULE_LOAD_SUCCESS. If a dependency or environment variable fails
1504  * tests return AST_MODULE_LOAD_FAILURE. If the module can not load the 
1505  * configuration file or other non-critical problem return 
1506  * AST_MODULE_LOAD_DECLINE. On success return AST_MODULE_LOAD_SUCCESS.
1507  */
1508 static int load_module(void)
1509 {
1510         PaError res;
1511
1512         if (!(console_tech.capabilities = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
1513                 return AST_MODULE_LOAD_DECLINE;
1514         }
1515         ast_format_cap_append(console_tech.capabilities, ast_format_slin16, 0);
1516
1517         init_pvt(&globals, NULL);
1518
1519         if (!(pvts = ao2_container_alloc(NUM_PVT_BUCKETS, pvt_hash_cb, pvt_cmp_cb)))
1520                 goto return_error;
1521
1522         if (load_config(0))
1523                 goto return_error;
1524
1525         res = Pa_Initialize();
1526         if (res != paNoError) {
1527                 ast_log(LOG_WARNING, "Failed to initialize audio system - (%d) %s\n",
1528                         res, Pa_GetErrorText(res));
1529                 goto return_error_pa_init;
1530         }
1531
1532         if (ast_channel_register(&console_tech)) {
1533                 ast_log(LOG_ERROR, "Unable to register channel type 'Console'\n");
1534                 goto return_error_chan_reg;
1535         }
1536
1537         if (ast_cli_register_multiple(cli_console, ARRAY_LEN(cli_console)))
1538                 goto return_error_cli_reg;
1539
1540         return AST_MODULE_LOAD_SUCCESS;
1541
1542 return_error_cli_reg:
1543         ast_cli_unregister_multiple(cli_console, ARRAY_LEN(cli_console));
1544 return_error_chan_reg:
1545         ast_channel_unregister(&console_tech);
1546 return_error_pa_init:
1547         Pa_Terminate();
1548 return_error:
1549         if (pvts)
1550                 ao2_ref(pvts, -1);
1551         pvts = NULL;
1552         ao2_ref(console_tech.capabilities, -1);
1553         console_tech.capabilities = NULL;
1554         pvt_destructor(&globals);
1555
1556         return AST_MODULE_LOAD_DECLINE;
1557 }
1558
1559 static int reload(void)
1560 {
1561         return load_config(1);
1562 }
1563
1564 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Console Channel Driver",
1565                 .load = load_module,
1566                 .unload = unload_module,
1567                 .reload = reload,
1568                 .load_pri = AST_MODPRI_CHANNEL_DRIVER,
1569 );