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